Forgot to actually add the whiny nil

git-svn-id: http://svn-commit.rubyonrails.org/rails/trunk@1455 5ecf4fe2-1ee6-0310-87b1-e25e094e27de
This commit is contained in:
David Heinemeier Hansson 2005-06-20 11:15:46 +00:00
parent 2533799e81
commit 9113aa2744
2 changed files with 83 additions and 0 deletions

View File

@ -0,0 +1,43 @@
# Extensions to nil which allow for more helpful error messages for
# people who are new to rails.
#
# The aim is to ensure that when users pass nil to methods where that isn't
# appropriate, instead of NoMethodError and the name of some method used
# by the framework users will see a message explaining what type of object
# was expected.
class NilClass
WHINERS = [ ActiveRecord::Base, Array ]
@@method_class_map = Hash.new
WHINERS.each do |klass|
methods = klass.public_instance_methods - public_instance_methods
methods.each do |method|
@@method_class_map[method.to_sym] = klass
end
end
private
def method_missing(method, *args, &block)
if @@method_class_map.include?(method)
raise_nil_warning_for @@method_class_map[method]
else
super
end
end
def raise_nil_warning_for(klass)
raise NoMethodError, NIL_WARNING_MESSAGE % klass
end
NIL_WARNING_MESSAGE = <<-end_message unless const_defined?(:NIL_WARNING_MESSAGE)
WARNING: You have a nil object when you probably didn't expect it! Odds are you
want an instance of %s instead.
Look in the callstack to see where you're working with an object that could be nil.
Investigate your methods and make sure the object is what you expect!
end_message
end

View File

@ -0,0 +1,40 @@
require 'test/unit'
## mock to enable testing without activerecord
module ActiveRecord
class Base
def save!
end
end
end
require 'active_support/whiny_nil'
class WhinyNilTest < Test::Unit::TestCase
def test_unchanged
begin
nil.method_thats_not_in_whiners
rescue NoMethodError => nme
assert_match(/nil:NilClass/, nme.message)
end
end
def test_active_record
begin
nil.save!
rescue NoMethodError => nme
assert(!(nme.message =~ /nil:NilClass/))
end
end
def test_array
begin
nil.each
rescue NoMethodError => nme
assert(!(nme.message =~ /nil:NilClass/))
end
end
end