crispy 0.3.3 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: c3f5cac13b6c7c9ab3d1a02c14d7c4aab8d49a37
-  data.tar.gz: 0d3a8f30a788ca7b6f65656e2d754500edfed384
+  metadata.gz: 145162d93fda035a4ce64022d92508d71fdab5c2
+  data.tar.gz: 0ec0fc67bb6b51810e38da470b8a582b5496ee00
 SHA512:
-  metadata.gz: 18e6deacab79ac272ae87429c086e1f087209f237c428c1fd5f4a5e23fe58b02d583df118d8534692d79d03a167024f0559f266d8f4851cab6bbe25377d956f2
-  data.tar.gz: 831d33b2b1878255f2396b2f2d14175569e5a6e5ad17d8d81a97864f27b93d69e8cadf7ce58b90ac070bfd973170ce5556bbc028a8679a4a22c3911d4e208e27
+  metadata.gz: 921b924827c9327a2343a3175e4cb7236704154af50e9fdda5836897e306031313a35763cee6ed38c338032ca7fb202b87ba224b2c985af43802142b7139f632
+  data.tar.gz: cc5ef58c6123edf2043ad0501051107b6c4e8a7c5823fa8722ed0a62151eb5d8fa86d944189af85988f3a38cbf091db98dc9a47db24521a1f11a942b73993fc2

data/.travis.yml

@@ -4,8 +4,8 @@ install:
   - CODECLIMATE_REPO_TOKEN=fe75ea4329c1e131ef79de66f8ba2f605fa2fd352bbbd61fed5024cb6eaaba73 bundle
 rvm:
   - ruby-head
-  - 2.2.0
-  - 2.1.5
+  - 2.2.2
+  - 2.1.6
   - 2.0.0
 script:
   - CODECLIMATE_REPO_TOKEN=fe75ea4329c1e131ef79de66f8ba2f605fa2fd352bbbd61fed5024cb6eaaba73 bundle exec rubydoctest README.md

data/ChangeLog.md

@@ -1,3 +1,12 @@
+# 0.4.0 (2015.4.29)
+
+- New Feature: Spy blacklist [\#37](https://github.com/igrep/crispy/pull/37).
+    - **Important**: Adding this feature changes the keyword arguments of Crispy.spy_into into `except` optional argument instead of stubbed methods.  
+      If you specify stubbed methods, use `stub` methods of a spy as [the README](https://github.com/igrep/crispy#stub-methods-of-a-spy) describes.
+- Fix Bug: Spy spy-methods of double unintentionally [\#30](https://github.com/igrep/crispy/issues/30), [\#37](https://github.com/igrep/crispy/pull/37).
+- Minor Enhancement: Update Ruby versions to test on Travis CI [\#36](https://github.com/igrep/crispy/pull/36).
+- Minor Enhancement: Specify minimum rubydoctest version. [da3ddaa](https://github.com/igrep/crispy/commit/da3ddaa37d912b81aa3a23f366765cc9fd47c387)
+
 # 0.3.3 (2015.3.27)
 
 - Fix Bug: Causes a crash when some of `@spies_to_reset` gets GCed just before `reinitialize`. [3a1ce2d](https://github.com/igrep/crispy/commit/3a1ce2dfc25ba48d07505b6ed1d7125f393e9579)

data/README.md

@@ -268,6 +268,25 @@ Specify the **fully qualified name of the constant** instead of the constant its
 => "more cool value!"
 ```
 
+### Configure Methods which Spy Should NOT Log
+
+Sometimes, you may want to make a spy ignore some methods.
+
+```ruby
+>> x = YourCoolClass.new
+>> spy_into x, except: [:method_to_ignore1, :method_to_ignore2]
+>> x.method_to_ignore1
+>> x.method_to_ignore2
+>> x.your_cool_method
+
+>> spy(x).received? :method_to_ignore1
+=> false
+>> spy(x).received? :method_to_ignore2
+=> false
+>> spy(x).received? :your_cool_method
+=> true
+```
+
 ### Embedding Crispy into your Testing Framework
 
 Remember to reset all the changes made by Crispy, call `CrispyWorld.reset`.

data/crispy.gemspec

@@ -23,7 +23,8 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "bundler", "~> 1.7"
   spec.add_development_dependency "rake"
   spec.add_development_dependency "minitest", "~> 5"
-  spec.add_development_dependency "rubydoctest"
+  spec.add_development_dependency "rubydoctest", ">= 1.1.5"
+  spec.add_development_dependency "github_changelog_generator"
 
   spec.required_ruby_version = '>= 2.0'
 end

data/lib/crispy.rb

@@ -9,8 +9,8 @@ module Crispy
   module_function
 
   # Returns a Spy object to wrap all methods of the object.
-  def spy_into object, stubs_map = {}
-    ::Crispy::CrispyInternal::Spy.new object, stubs_map
+  def spy_into object, except: []
+    ::Crispy::CrispyInternal::Spy.new object, except: except
   end
 
   def double name_or_stubs_map = nil, stubs_map = {}
@@ -18,8 +18,8 @@ module Crispy
   end
 
   # Make and returns a Crispy::ClassSpy's instance to spy all instances of a class.
-  def spy_into_instances klass, stubs_map = {}
-    ::Crispy::CrispyInternal::ClassSpy.new klass, stubs_map
+  def spy_into_instances klass, except: []
+    ::Crispy::CrispyInternal::ClassSpy.new klass, except: except
   end
 
   def spy object

data/lib/crispy/crispy_internal/class_spy.rb

@@ -7,7 +7,7 @@ module Crispy
 
       @registry = {}
 
-      def initialize klass, stubs_map = {}
+      def initialize klass, except: []
         @received_messages_with_receiver = []
 
         super

data/lib/crispy/crispy_internal/double.rb

@@ -2,13 +2,15 @@ module Crispy
   module CrispyInternal
     class Double
 
+      SPY_METHODS = %i[received_messages stub] + SpyBase::COMMON_RECEIVED_MESSAGE_METHODS_DEFINITION.keys
+
       def initialize name_or_stubs_map = nil, stubs_map = {}
         if name_or_stubs_map.is_a? ::Hash
           @name = ''.freeze
-          @spy = ::Crispy.spy_into(self, name_or_stubs_map)
+          spy_into_self_as_double(name_or_stubs_map)
         else
           @name = name_or_stubs_map
-          @spy = ::Crispy.spy_into(self, stubs_map)
+          spy_into_self_as_double(stubs_map)
         end
       end
 
@@ -28,6 +30,11 @@ module Crispy
         END
       end
 
+      def spy_into_self_as_double stubs_map
+        @spy = ::Crispy.spy_into(self, except: SPY_METHODS).stub(stubs_map)
+      end
+      private :spy_into_self_as_double
+
     end
   end
 end

data/lib/crispy/crispy_internal/spy.rb

@@ -11,7 +11,7 @@ module Crispy
 
       attr_reader :received_messages
 
-      def initialize target, stubs_map = {}
+      def initialize target, except: []
         spy = self
         module_eval do
           define_method(:__CRISPY_SPY__) { spy }

data/lib/crispy/crispy_internal/spy_base.rb

@@ -10,18 +10,24 @@ module Crispy
         :__CRISPY_SPY__,
       ]
 
-      def initialize target, stubs_map = {}
+      def initialize target, except: []
+        @exceptions = Array(except).map(&:to_sym)
+
         prepend_features target_to_class(target)
 
         @stubbed_methods = []
-        stub stubs_map
 
         @spying = true
       end
 
-      def self.new target, stubs_map = {}
+      def self.new target, except: []
         spy = self.of_target(target)
-        spy ? spy.reinitialize(stubs_map) : super
+        if spy
+          spy.update_exceptions(target, except)
+          spy.reinitialize
+        else
+          super
+        end
       end
 
       def self.of_target target
@@ -44,13 +50,27 @@ module Crispy
         raise NotImplementedError
       end
 
-      def reinitialize stubs_map = {}
+      def reinitialize
         restart
         erase_log
-        reinitialize_stubber stubs_map
+        reinitialize_stubber
         self
       end
 
+      def update_exceptions target, exceptions
+        return if exceptions.empty?
+
+        given_exceptions = Array(exceptions).map(&:to_sym)
+
+        new_exceptions = given_exceptions - @exceptions
+        remove_method(*new_exceptions)
+
+        old_exceptions = @exceptions - given_exceptions
+        redefine_wrappers target_to_class(target), old_exceptions
+
+        @exceptions.replace given_exceptions
+      end
+
       def stop
         @spying = false
       end
@@ -124,31 +144,44 @@ module Crispy
         self
       end
 
-      def reinitialize_stubber stubs_map = {}
+      def reinitialize_stubber
         remove_method(*@stubbed_methods)
         @stubbed_methods.each {|stubbed_method| define_wrapper stubbed_method }
         @stubbed_methods.clear
-        stub stubs_map
+      end
+
+      %w[only except].each do|inclusion|
+        not_sign = inclusion == 'except'.freeze ? '!'.freeze : ''.freeze
+        %w[public protected private].each do|visibility|
+          binding.eval(<<-END, __FILE__, (__LINE__ + 1))
+            def define_#{visibility}_wrappers_#{inclusion} klass, targets
+              klass.#{visibility}_instance_methods.each do|method_name|
+                #{visibility} define_wrapper(method_name) if method_name != :__CRISPY_SPY__ && #{not_sign}targets.include?(method_name)
+              end
+            end
+          END
+        end
       end
 
       def prepend_features klass
         super
 
         self.module_eval do
-          klass.public_instance_methods.each do|method_name|
-            next if method_name == :__CRISPY_SPY__
-            define_wrapper(method_name)
-          end
-          klass.protected_instance_methods.each do|method_name|
-            protected define_wrapper(method_name)
-          end
-          klass.private_instance_methods.each do|method_name|
-            private define_wrapper(method_name)
-          end
+          define_public_wrappers_except(klass, @exceptions)
+          define_protected_wrappers_except(klass, @exceptions)
+          define_private_wrappers_except(klass, @exceptions)
         end
       end
       private :prepend_features
 
+      def redefine_wrappers klass, method_names
+        self.module_eval do
+          define_public_wrappers_only(klass, method_names)
+          define_protected_wrappers_only(klass, method_names)
+          define_private_wrappers_only(klass, method_names)
+        end
+      end
+
       def assert_symbol! maybe_symbol
         unless maybe_symbol.respond_to?(:to_sym) && maybe_symbol.to_sym.instance_of?(::Symbol)
           raise TypeError, "TypeError: no implicit conversion from #{maybe_symbol.inspect} to symbol"

data/lib/crispy/version.rb

@@ -1,3 +1,3 @@
 module Crispy
-  VERSION = "0.3.3"
+  VERSION = "0.4.0"
 end

data/test/doctest-fixtures/your_cool_class.rb

@@ -10,6 +10,10 @@ class YourCoolClass
   end
   def your_finalizer *args
   end
+  def method_to_ignore1
+  end
+  def method_to_ignore2
+  end
 
   class Again < self
     def your_another_method *args

data/test/test_crispy.rb

@@ -62,6 +62,11 @@ class TestCrispy < MiniTest::Test
       123
     end
 
+    def self.non_spied1
+    end
+    def self.non_spied2
+    end
+
     def self.stubbed_method1
       'before stubbed 1'
     end
@@ -132,9 +137,8 @@ class TestCrispy < MiniTest::Test
     def setup
       @object = ObjectClass.new
 
-      @returned_spy = spy_into(
-        @object, method_to_stub1: :stubbed1, method_to_stub2: :stubbed2
-      )
+      @returned_spy = spy_into(@object)
+      @returned_spy.stub(method_to_stub1: :stubbed1, method_to_stub2: :stubbed2)
 
       @object.hoge 1, 2, 3
       @object.foo
@@ -213,11 +217,12 @@ class TestCrispy < MiniTest::Test
   class TestCrispySpyIntoClass < TestCrispy
 
     def setup
-      spy_into ObjectClass, stubbed_method1: 1, stubbed_method2: 2
+      spy_into(ObjectClass, except: :non_spied1).stub(stubbed_method1: 1, stubbed_method2: 2)
 
       ObjectClass.hoge 1, 2, 3
       ObjectClass.foo
       ObjectClass.hoge 3, 4, 5
+      ObjectClass.non_spied1
 
       @subject = spy(ObjectClass)
     end
@@ -238,7 +243,7 @@ class TestCrispy < MiniTest::Test
     end
 
     def test_spy_overrides_stubbed_methods
-      spy_into ObjectClass, stubbed_method2: 'xx', stubbed_method3: 'xxx'
+      spy_into(ObjectClass).stub(stubbed_method2: 'xx', stubbed_method3: 'xxx')
 
       assert_equal 'before stubbed 1', ObjectClass.stubbed_method1
       assert_equal 'xx'              , ObjectClass.stubbed_method2
@@ -267,6 +272,22 @@ class TestCrispy < MiniTest::Test
       assert_raises(::Crispy::CrispyError){ spy_of_instances(Class.new) }
     end
 
+    def test_spy_ignores_exceptions
+      assert not(spy(ObjectClass).received? :non_spied1)
+    end
+
+    def test_spy_overwrites_exceptions_by_spy_into_again
+      assert not(spy(ObjectClass).received? :non_spied1)
+
+      spy_into(ObjectClass, except: :non_spied2)
+
+      ObjectClass.non_spied1
+      ObjectClass.non_spied2
+
+      assert spy(ObjectClass).received? :non_spied1
+      assert not(spy(ObjectClass).received? :non_spied2)
+    end
+
   end
 
   class TestCrispySpyIntoInstances < TestCrispy
@@ -276,9 +297,8 @@ class TestCrispy < MiniTest::Test
     end
 
     def setup
-      @returned_spy = spy_into_instances(
-        object_class, method_to_stub1: :stubbed_instance_method1, method_to_stub2: :stubbed_instance_method2
-      )
+      @returned_spy = spy_into_instances(object_class)
+      @returned_spy.stub(method_to_stub1: :stubbed_instance_method1, method_to_stub2: :stubbed_instance_method2)
 
       @subject = spy_of_instances(object_class)
       @object_instances = Array.new(3){ object_class.new }
@@ -306,7 +326,7 @@ class TestCrispy < MiniTest::Test
       end
 
       def test_spy_overrides_stubbed_methods
-        spy_into_instances object_class, method_to_stub2: 'xx', method_to_stub3: 'xxx'
+        spy_into_instances(object_class).stub(method_to_stub2: 'xx', method_to_stub3: 'xxx')
 
         @object_instances.each do|object|
           assert_equal 'method to stub 1 (before stubbed)', object.method_to_stub1
@@ -633,7 +653,7 @@ class TestCrispy < MiniTest::Test
       assert_same @expected_baz, @actual_baz
     end
 
-    def test_double_can_be_spied
+    def test_double_is_spied
       assert spied? @double
 
       assert_same @double.received_messages, spy(@double).received_messages
@@ -659,6 +679,23 @@ class TestCrispy < MiniTest::Test
       assert_equal 0, @double.count_received(:non_used_method)
     end
 
+    def test_double_doesnt_spy_spy_methods
+      @double.stub(a: 0)
+      @double.received? :hoge
+      @double.received_once? :hoge
+      @double.count_received :hoge
+
+      should_not_logged = %i[
+        received? received_once? count_received
+        stub received_messages
+      ]
+
+      assert_empty(
+        @double.received_messages.select {|received_messages| should_not_logged.include? received_messages.method_name }
+      )
+
+    end
+
   end
 
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: crispy
 version: !ruby/object:Gem::Version
-  version: 0.3.3
+  version: 0.4.0
 platform: ruby
 authors:
 - Yuji Yamamoto
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-03-26 00:00:00.000000000 Z
+date: 2015-04-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -54,6 +54,20 @@ dependencies:
         version: '5'
 - !ruby/object:Gem::Dependency
   name: rubydoctest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.1.5
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.1.5
+- !ruby/object:Gem::Dependency
+  name: github_changelog_generator
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="