minitest-stub-const 0.4 → 0.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 00edc8c44dd6ae8caa0d4b850178007b01eaf551
-  data.tar.gz: d77cedce7ae177bd65776fb0fef492f122239d0a
+  metadata.gz: 3c368abae48ce6602249a2ab7e84151f0c0791bc
+  data.tar.gz: 604721ca05230092a7d3908d062c3643c6a9f41c
 SHA512:
-  metadata.gz: d1db5135aa279908a48a6ead0189ba8396e708b772f52936786cd476f20d61d440f7e86e7e8db44f3005241921a50c0326c20ccb6ad14c4836e8cd704a824b09
-  data.tar.gz: f96293b488c0b9eba62d420869119e2c3e586def491532983782fc57862c923f7d66984c49a6dacef01f71c6f1fed6cc31a82d017de110b24516cf06d3c6bafe
+  metadata.gz: f6096aee46275edcd51e6675c35c80ac223ca6d6062dd4fd91304a6e736a189a2d103fb84d7a61de9414a1fe1c51a6957129e92c2a05477ad3599c58248c6eba
+  data.tar.gz: 1b1e4d2376d0bbb965ff4b1b0b7809775a975070f81cec2ed350aa0893ad18c023580a5c150aa4227fac449d572e9376096be0fd0f85f6aabebc6c7a26eedc33

data/README.md

@@ -7,20 +7,55 @@ Like RSpec's [stub_const] [rspec], but boring and non-magical.
 
 
 ## Example
+Stub a constant for the duration of a block:
 
 ```ruby
-it "calls a Thing.add when add_thing is called" do
-  m = MiniTest::Mock.new
-  m.expect(:add, nil)
-  
-  MyLib.stub_const(:Thing, m) do
-    @subject.add_thing
-  end
+module Foo
+  BAR = :original
+end
 
-  m.verify
+Foo.stub_const(:BAR, :stubbed) do
+  Foo::BAR
 end
+# => :stubbed
+
+Foo::BAR
+# => :original
 ```
 
+This is especially useful when testing that the expected class methods
+are being called on a `Module` or `Class` instance:
+
+```ruby
+module SomeLib
+  class Thing
+    def self.add
+      fail NotImplementedError
+    end
+  end
+end
+
+class ThingAdder
+  def add_thing
+    SomeLib::Thing.add
+  end
+end
+
+describe ThingAdder do
+  describe '#add_thing' do
+    it 'should call Thing.add' do
+      adder = ThingAdder.new
+      mock = Minitest::Mock.new
+      mock.expect(:add, nil)
+
+      SomeLib.stub_const(:Thing, mock) do
+        adder.add_thing
+      end
+      assert mock.verify
+    end
+  end
+end
+```
 
 ## Installation
 

data/lib/minitest/stub_const.rb

@@ -1,51 +1,57 @@
 class Object
-
-  #
-  # Replace the +value+ of constant +name+ for the duration of a +block+. This
-  # is useful when testing that the expected class methods are being called on
-  # a Module or Class instance.
+  # Replace the +value+ of constant +name+ for the duration of a
+  # +block+. This is especially useful when testing that the expected
+  # class methods are being called on a Module or Class instance.
   #
   # Example:
   #
-  #   m = MiniTest::Mock.new
-  #   m.expect(:register, nil, [:whatever])
-  #
-  #   MyLib.stub_const(:Thing, m) do
-  #     @subject.add_thing(:whatever)
+  #   module Foo
+  #     BAR = :original
   #   end
-  #
-  #   m.verify
-  #
+  #   
+  #   Foo.stub_const(:BAR, :stubbed) do
+  #     Foo::BAR
+  #   end
+  #   # => :stubbed
+  #   
+  #   Foo::BAR
+  #   # => :original
   def stub_const(name, val, &block)
-    orig = const_get(name)
-
-    silence_warnings do
-      const_set(name, val)
-    end
-
+    defined = const_defined?(name)
+    orig = const_get(name) if defined
+    silence_warnings { const_set(name, val) }
     yield
   ensure
-    silence_warnings do
-      const_set(name, orig)
+    if defined
+      silence_warnings { const_set(name, orig) }
+    else
+      remove_const(name)
     end
   end
 
   # Remove the constant +name+ for the duration of a block. This is
   # useful when testing code that checks whether a constant is defined
-  # or not.
+  # or not. Simply yields to the passed block if the constant is not
+  # currently defined.
   #
   # Example:
   #
   #   Object.stub_remove_const(:File) do
-  #     "Look ma, no File!" unless defined(File)
+  #     "Look ma, no File!" unless defined?(File)
   #   end
   #   # => "Look ma, no File!"
   def stub_remove_const(name)
-    orig = const_get(name)
-    remove_const(name)
-    yield
-  ensure
-    const_set(name, orig)
+    if const_defined?(name)
+      begin
+        orig = const_get(name)
+        remove_const(name)
+        yield
+      ensure
+        const_set(name, orig)
+      end
+    else
+      yield
+    end
   end
 
   # Add a minimal implementation of ActiveSupport's silence_warnings if it

data/test/test_stub_const.rb

@@ -1,4 +1,5 @@
 require File.expand_path('../../lib/minitest/stub_const', __FILE__)
+require 'minitest/autorun'
 require 'minitest/mock'
 
 module A
@@ -20,6 +21,7 @@ describe 'Object' do
       A.stub_const(:B, @mock) do
         assert_equal :new, A::B.what
       end
+      @mock.verify
     end
 
     it 'restores the original value after the block' do
@@ -30,6 +32,15 @@ describe 'Object' do
     it 'does not raise any warnings' do
       assert_silent { A.stub_const(:B, @mock) { } }
     end
+
+    it 'should stub undefined constants' do
+      refute defined?(A::X)
+      A.stub_const(:X, @mock) do
+        assert_equal :new, A::X.what
+      end
+      refute defined?(A::X)
+      @mock.verify
+    end
   end
 
   describe '#stub_remove_const' do
@@ -47,5 +58,11 @@ describe 'Object' do
     it 'does not raise any warnings' do
       assert_silent { A.stub_remove_const(:B) { } }
     end
+
+    it 'leaves undefined constants undefined' do
+      refute defined?(A::X)
+      A.stub_remove_const(:X) { }
+      refute defined?(A::X)
+    end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: minitest-stub-const
 version: !ruby/object:Gem::Version
-  version: '0.4'
+  version: '0.5'
 platform: ruby
 authors:
 - Adam Mckaig
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-03-23 00:00:00.000000000 Z
+date: 2015-09-17 00:00:00.000000000 Z
 dependencies: []
 description: 
 email: