rspec-fire 1.0.0 → 1.1.0

data/HISTORY

@@ -28,3 +28,6 @@
 1.0.0 - 9 July 2012
   * RSpec 2.11 compatibility, no longer compatible with earlier versions.
   * Removed `stub_const`, it is now in `rspec-mocks`.
+
+1.1.0 - 10 July 2012
+  * Add `verify_constant_names` option.

data/README.md

@@ -173,6 +173,22 @@ Particularly handy for `ActiveRecord` finders. Use `fire_class_double`. If you
 dig into the code, you'll find you can create subclasses of `FireDouble` to
 check for *any* set of methods.
 
+### Preventing Typo'd Constant Names
+
+`fire_double("MyClas")` will not verify any mocked methods, even when
+`MyClass` is loaded, because of the typo in the constant name. There's
+an option to help prevent these sorts of fat-finger errors:
+
+    RSpec::Fire.configure do |config|
+      config.verify_constant_names = true
+    end
+
+When this is set to true, rspec-fire will raise an error when given
+the name of an undefined constant. You probably only want to set this
+when running your entire test suite, with all production code loaded.
+Setting this for an isolated unit test will prevent you from being
+able to isolate it!
+
 ### Mocking Done Right (tm)
 
 * Only mock methods on collaborators, _not_ the class under test.

data/lib/rspec/fire.rb

@@ -4,6 +4,26 @@ require 'delegate'
 
 module RSpec
   module Fire
+    class Configuration
+      attr_accessor :verify_constant_names
+      alias verify_constant_names? verify_constant_names
+
+      def initialize
+        self.verify_constant_names = false
+      end
+    end
+
+    def self.configuration
+      @configuration ||= Configuration.new
+    end
+
+    def self.configure
+      yield configuration
+    end
+
+    Error = Class.new(StandardError)
+    UndefinedConstantError = Class.new(Error)
+
     class SupportArityMatcher
       def initialize(arity)
         @arity = arity
@@ -179,11 +199,18 @@ module RSpec
               methods.sort.map {|x|
                 "  #{x}"
               }.join("\n")
+
             ]
             raise RSpec::Expectations::ExpectationNotMetError, msg
           end
         end
       end
+
+      def verify_constant_name
+        return if recursive_const_defined?(@__doubled_class_name)
+
+        raise UndefinedConstantError, "#{@__doubled_class_name} is not a defined constant."
+      end
     end
 
     class FireObjectDouble < RSpec::Mocks::Mock
@@ -193,6 +220,7 @@ module RSpec
         args << {} unless Hash === args.last
 
         @__doubled_class_name = doubled_class
+        verify_constant_name if RSpec::Fire.configuration.verify_constant_names?
 
         # __declared_as copied from rspec/mocks definition of `double`
         args.last[:__declared_as] = 'FireDouble'
@@ -213,6 +241,8 @@ module RSpec
           @__checked_methods = :public_methods
           @__method_finder   = :method
 
+          verify_constant_name if RSpec::Fire.configuration.verify_constant_names?
+
           # TestDouble was added after rspec 2.9.0, and allows proper mocking
           # of public methods that have clashing private methods. See spec for
           # details.

data/rspec-fire.gemspec

@@ -1,6 +1,6 @@
 Gem::Specification.new do |s|
   s.name     = 'rspec-fire'
-  s.version  = '1.0.0'
+  s.version  = '1.1.0'
   s.summary  = 'More resilient test doubles for RSpec.'
   s.platform = Gem::Platform::RUBY
   s.authors  = ["Xavier Shay"]

data/spec/fire_double_spec.rb

@@ -29,6 +29,31 @@ class TestClass
   end
 end
 
+shared_examples_for "verifying named constants" do |double_method|
+  def clear_config
+    RSpec::Fire.instance_variable_set(:@configuration, nil)
+  end
+
+  before(:each) { clear_config }
+  after(:all)   { clear_config }
+
+  it "allows mispelled constants by default" do
+    double = send(double_method, "TestClas")
+    double.should_receive(:undefined_method)
+    double.undefined_method
+  end
+
+  it "raises an error when constants are mispelled and the appropriate config option is set" do
+    RSpec::Fire.configure do |c|
+      c.verify_constant_names = true
+    end
+
+    expect {
+      send(double_method, "TestClas")
+    }.to raise_error(/TestClas is not a defined constant/)
+  end
+end
+
 shared_examples_for 'a fire-enhanced double method' do
   describe 'doubled class is not loaded' do
     let(:doubled_object) { fire_double("UnloadedObject") }
@@ -159,6 +184,7 @@ describe '#fire_double' do
   let(:doubled_object) { fire_double("TestObject") }
 
   it_should_behave_like 'a fire-enhanced double'
+  it_should_behave_like "verifying named constants", :fire_double
 
   it 'allows stubs to be passed as a hash' do
     double = fire_double("TestObject", :defined_method => 17)
@@ -170,6 +196,7 @@ describe '#fire_class_double' do
   let(:doubled_object) { fire_class_double("TestClass") }
 
   it_should_behave_like 'a fire-enhanced double'
+  it_should_behave_like "verifying named constants", :fire_class_double
 
   it 'uses a module for the doubled object so that it supports nested constants like a real class' do
     doubled_object.should be_a(Module)

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rspec-fire
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.1.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-07-09 00:00:00.000000000 Z
+date: 2012-07-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &2156163500 !ruby/object:Gem::Requirement
+  requirement: &2152390460 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -21,10 +21,10 @@ dependencies:
         version: '2.11'
   type: :runtime
   prerelease: false
-  version_requirements: *2156163500
+  version_requirements: *2152390460
 - !ruby/object:Gem::Dependency
   name: rake
-  requirement: &2156162900 !ruby/object:Gem::Requirement
+  requirement: &2152389940 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -32,7 +32,7 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *2156162900
+  version_requirements: *2152389940
 description: 
 email:
 - hello@xaviershay.com