delegate_matcher 0.1 → 0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 70876c332f24b6734e75025e90814f096a922405
-  data.tar.gz: e7ba6dd00b072b61cfdd84d6be52015f4a974ddf
+  metadata.gz: d9489b0d0927d6b2af4766edaf7edc2d4788867e
+  data.tar.gz: d27938e9a9fe51eeb68dbfccdc807caf07883d0a
 SHA512:
-  metadata.gz: 88355c0fecfc0e24710bc03e37f66a52ac70c72968427cc912577d30548981eae932af200b0e8d47a326dae4405de47f19fc74fce95107c97d85999ffd0d652b
-  data.tar.gz: cbb8a022a4701b3a1d06d674ed6fd2298313a87c59b78e76618bf37d86ead5e5fb38f52c894fb34a1099851dc174d31d5b473d3707632b3e8630d975b05b8c8a
+  metadata.gz: ea5fb6b338a5f50a1ef0b1f07d5b3c3d54e54a054b406c6cd7536213509cf04e2a1925da61707311e55a8016405150e5f32c27dedcca19d1ae75021daef464e9
+  data.tar.gz: 9ebfe282eb0fd612c71cf5ba18618c6ff51a5025f7ecac20795a788d8de5c5acef7b3a9fcfc88ab174050964ccf945703159a20ab8f0068bf8b1b7c290724409

data/Gemfile.lock

@@ -1,7 +1,8 @@
 PATH
   remote: .
   specs:
-    delegate_matcher (0.1)
+    delegate_matcher (0.2)
+      proc_extensions (~> 0.1)
 
 GEM
   remote: https://rubygems.org/
@@ -29,6 +30,8 @@ GEM
     domain_name (0.5.25)
       unf (>= 0.0.5, < 1.0.0)
     ffi (1.9.10)
+    file-tail (1.1.0)
+      tins (~> 1.0)
     formatador (0.2.5)
     guard (2.13.0)
       formatador (>= 0.2.4)
@@ -63,6 +66,8 @@ GEM
     parser (2.2.3.0)
       ast (>= 1.1, < 3.0)
     powerpack (0.1.1)
+    proc_extensions (0.1.2)
+      sourcify (~> 0.5)
     pry (0.10.3)
       coderay (~> 1.1.0)
       method_source (~> 0.8.1)
@@ -103,6 +108,12 @@ GEM
       ruby-progressbar (~> 1.7)
       tins (<= 1.6.0)
     ruby-progressbar (1.7.5)
+    ruby2ruby (2.2.0)
+      ruby_parser (~> 3.1)
+      sexp_processor (~> 4.0)
+    ruby_parser (3.7.2)
+      sexp_processor (~> 4.1)
+    sexp_processor (4.6.0)
     shellany (0.0.1)
     simplecov (0.10.0)
       docile (~> 1.1.0)
@@ -110,6 +121,11 @@ GEM
       simplecov-html (~> 0.10.0)
     simplecov-html (0.10.0)
     slop (3.6.0)
+    sourcify (0.5.0)
+      file-tail (>= 1.0.5)
+      ruby2ruby (>= 1.2.5)
+      ruby_parser (>= 2.0.5)
+      sexp_processor (>= 3.0.5)
     term-ansicolor (1.3.2)
       tins (~> 1.0)
     thor (0.19.1)

data/README.md

@@ -67,7 +67,7 @@ describe Post do
 end
 ```
 
-**Note**: if you are delegating to an  object then you must provide an expicit prefix to `with_prefix`:
+**Note**: if you are delegating to an object (i.e. `to` is not a string or symbol) then a prefix of `''` will be used :
 
 ```ruby
 describe Post do
@@ -116,16 +116,27 @@ end
 
 ### Blocks
 You can check that a block passed is in turn passed to the delegate via the `with_block` method.
+By default, block delegation is only checked if `with_a_block` or `without_a_block` is specified.
 
 ```ruby
 describe Post do
-  it { should delegate(:name).to(author).with_a_block }    # name(&block) => author().name(&block)
-  it { should delegate(:name).to(author).with_block }      # name(&block) => author().name(&block) # alias for with_a_block
+  it { should delegate(:name).to(author).with_a_block }    # name(&block) => author.name(&block)
+  it { should delegate(:name).to(author).with_block }      # name(&block) => author.name(&block) # alias for with_a_block
 
-  it { should delegate(:name).to(author).without_a_block } # name(&block) => author().name
-  it { should delegate(:name).to(author).without_block }   # name(&block) => author().name         # alias for without_a_block
+  it { should delegate(:name).to(author).without_a_block } # name(&block) => author.name
+  it { should delegate(:name).to(author).without_block }   # name(&block) => author.name         # alias for without_a_block
 end
 ```
+You can also pass an explicit block in which case the block passed will be compared against
+the block received by the delegate. The comparison is based on having equivalent source for the blocks.
+
+```ruby
+describe Post do
+  it { should delegate(:tainted?).to(authors).as(:all?).with_block { |a| a.tainted? } } # tainted? => authors.all? { |a| a.tainted? }
+end
+```
+
+See [proc_extensions](https://github.com/dwhelan/proc_extensions/) for more details on how the source for procs is compared.
 
 ### Return Value
 Normally the matcher will check that the value return is the same as the value
@@ -137,8 +148,6 @@ describe Post do
 end
 ```
 
-By default, block delegation is only checked if `with_a_block` or `without_a_block` is specified.
-
 ### Active Support
 You can test delegation based on the [delegate](http://api.rubyonrails.org/classes/Module.html#method-i-delegate) method in the Active Support gem.
 

data/delegate_matcher.gemspec

@@ -19,21 +19,23 @@ Gem::Specification.new do |gem|
   gem.test_files    = gem.files.grep(%r{^spec/})
   gem.require_paths = ['lib']
 
-  gem.add_development_dependency 'activesupport',  '~>  4.2'
-  gem.add_development_dependency 'bundler',        '~>  1.7'
-  gem.add_development_dependency 'coveralls',      '~>  0.7'
-  gem.add_development_dependency 'guard',          '~>  2.13'
-  gem.add_development_dependency 'guard-rspec',    '~>  4.6'
+  gem.add_runtime_dependency 'proc_extensions', '~>  0.1'
+
+  gem.add_development_dependency 'activesupport',   '~>  4.2'
+  gem.add_development_dependency 'bundler',         '~>  1.7'
+  gem.add_development_dependency 'coveralls',       '~>  0.7'
+  gem.add_development_dependency 'guard',           '~>  2.13'
+  gem.add_development_dependency 'guard-rspec',     '~>  4.6'
 
   if RUBY_VERSION =~ /2/
-    gem.add_development_dependency 'pry-byebug',   '~>  3.3'
+    gem.add_development_dependency 'pry-byebug',    '~>  3.3'
   else
-    gem.add_development_dependency 'pry-debugger', '~>  0.2'
+    gem.add_development_dependency 'pry-debugger',  '~>  0.2'
   end
 
-  gem.add_development_dependency 'rake',           '~> 10.0'
-  gem.add_development_dependency 'rspec',          '~>  3.0'
-  gem.add_development_dependency 'rspec-its',      '~>  1.1'
-  gem.add_development_dependency 'rubocop',        '~>  0.30'
-  gem.add_development_dependency 'simplecov',      '~>  0.9'
+  gem.add_development_dependency 'rake',            '~> 10.0'
+  gem.add_development_dependency 'rspec',           '~>  3.0'
+  gem.add_development_dependency 'rspec-its',       '~>  1.1'
+  gem.add_development_dependency 'rubocop',         '~>  0.30'
+  gem.add_development_dependency 'simplecov',       '~>  0.9'
 end

data/lib/delegate_matcher/block.rb

@@ -0,0 +1,13 @@
+module RSpec
+  module Matchers
+    module DelegateMatcher
+      module Block
+        attr_accessor :block
+
+        def block_source
+          ProcSource.new(block)
+        end
+      end
+    end
+  end
+end

data/lib/delegate_matcher/delegate.rb

@@ -2,9 +2,11 @@ module RSpec
   module Matchers
     module DelegateMatcher
       class Delegate
+        include Block
+
         RSpec::Mocks::Syntax.enable_expect(self)
 
-        attr_reader :received, :args, :block
+        attr_reader :received, :args
 
         def initialize(expected)
           self.expected = expected

data/lib/delegate_matcher/delegate_matcher.rb

@@ -24,7 +24,7 @@ module RSpec
       chain(:allow_nil)       { |allow_nil = true| expected.allow_nil    = allow_nil }
       chain(:with_prefix)     { |prefix = nil|     expected.prefix       = prefix }
       chain(:with)            { |*args|            expected.args         = args }
-      chain(:with_a_block)    {                    expected.block        = true  }
+      chain(:with_a_block)    { |&block|           expected.block        = block || true  }
       chain(:without_a_block) {                    expected.block        = false }
       chain(:without_return)  {                    expected.check_return = false }
 
@@ -53,5 +53,4 @@ module RSpec
   end
 end
 
-# TODO: Handle delegation to a class method?
-# TODO: How to handle delegation if delegate_double is called with something else
+# TODO: Handle nested delegation strings "a.b.c"

data/lib/delegate_matcher/delegation.rb

@@ -1,4 +1,5 @@
 require 'rspec/matchers'
+require 'proc_extensions'
 
 module RSpec
   module Matchers
@@ -40,14 +41,17 @@ module RSpec
           expected.as_args.nil? || delegate.args.eql?(expected.as_args)
         end
 
+        # rubocop:disable Metrics/AbcSize
         def block_ok?
           case
           when expected.block.nil?
             true
-          when expected.block
+          when expected.block == false
+            delegate.block.nil?
+          when expected.block == true
             delegate.block == dispatcher.block
           else
-            delegate.block.nil?
+            delegate.block_source == expected.block_source
           end
         end
 
@@ -56,6 +60,9 @@ module RSpec
         end
 
         def failure_message(negated)
+          # TODO: Should include the line below
+          # return nil if negated == delegate.received
+
           message = [
             argument_failure_message(negated),
             block_failure_message(negated),
@@ -81,7 +88,7 @@ module RSpec
           when negated
             "a block was #{expected.block ? '' : 'not '}passed"
           when expected.block
-            delegate.block.nil? ? 'a block was not passed' : "a different block #{delegate.block} was passed"
+            delegate.block.nil? ? 'a block was not passed' : "a different block '#{ProcSource.new(delegate.block)}' was passed"
           else
             'a block was passed'
           end

data/lib/delegate_matcher/dispatcher.rb

@@ -13,7 +13,7 @@ module RSpec
         end
 
         def block
-          @block ||= proc {}
+          @block ||= expected.block.is_a?(Proc) ? expected.block : proc {}
         end
 
         private

data/lib/delegate_matcher/expected.rb

@@ -2,7 +2,9 @@ module RSpec
   module Matchers
     module DelegateMatcher
       class Expected
-        attr_accessor :subject, :to, :method_name, :block, :as, :allow_nil, :check_return
+        include Block
+
+        attr_accessor :subject, :to, :method_name, :as, :allow_nil, :check_return
         attr_reader   :args
 
         def initialize
@@ -92,10 +94,12 @@ module RSpec
           case
           when block.nil?
             ''
-          when block
+          when block == true
             ' with a block'
-          else
+          when block == false
             ' without a block'
+          else
+            " with block '#{block_source}'"
           end
         end
 

data/lib/delegate_matcher/stub_delegate.rb

@@ -13,10 +13,12 @@ module RSpec
         private
 
         def stub_receiver
+          # binding.pry
           allow(receiver).to receive(expected.as) do |*args, &block|
             self.args     = args
             self.block    = block
             self.received = true
+            # binding.pry
             return_value
           end
         end

data/lib/delegate_matcher/version.rb

@@ -1,3 +1,3 @@
 module DelegateMatcher
-  VERSION ||= '0.1'.freeze
+  VERSION ||= '0.2'.freeze
 end

data/lib/delegate_matcher.rb

@@ -1,6 +1,7 @@
 require 'forwardable'
 
 require 'delegate_matcher/version'
+require 'delegate_matcher/block'
 require 'delegate_matcher/expected'
 require 'delegate_matcher/dispatcher'
 require 'delegate_matcher/delegate'

data/spec/lib/class_method_spec.rb

@@ -0,0 +1,84 @@
+require 'spec_helper'
+
+module RSpec
+  module Matchers
+    module DelegateMatcher
+      module ToMethod
+        describe 'delegation to a method' do
+          class Post
+            def self.author
+              @author ||= Author.new
+            end
+          end
+
+          subject { Post }
+
+          let(:receiver) { :author }
+
+          it_behaves_like 'a simple delegator' do
+            before do
+              class Post
+                def self.name
+                  author.name
+                end
+              end
+            end
+            include_examples 'a delegator without a nil check'
+          end
+
+          it_behaves_like 'a delegator with a nil check' do
+            before do
+              class Post
+                def self.name
+                  author.name if author
+                end
+              end
+            end
+          end
+
+          it_behaves_like 'a delegator with args and a block' do
+            before do
+              class Post
+                def self.name(*args, &block)
+                  author.name(*args, &block)
+                end
+              end
+            end
+          end
+
+          it_behaves_like 'a delegator with a different method name', :other_name do
+            before do
+              class Post
+                def self.name
+                  author.other_name
+                end
+              end
+            end
+          end
+
+          it_behaves_like 'a delegator with a prefix', 'author' do
+            before do
+              class Post
+                def self.author_name
+                  author.name
+                end
+              end
+            end
+            it { should delegate(:name).to(:author).with_prefix  }
+          end
+
+          it_behaves_like 'a delegator with a different return value', 'Ann Rand' do
+            before do
+              class Post
+                def self.name
+                  author.name
+                  'Ann Rand'
+                end
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/spec/lib/{delegate_to_class_variable_spec.rb → class_variable_spec.rb}

@@ -36,7 +36,7 @@ module RSpec
               end
             end
 
-            it_behaves_like 'a delegator with args and a block', :arg1 do
+            it_behaves_like 'a delegator with args and a block' do
               before do
                 class Post
                   def name(*args, &block)

data/spec/lib/{delegate_to_constant_spec.rb → constant_spec.rb}

@@ -37,7 +37,7 @@ module RSpec
               end
             end
 
-            it_behaves_like 'a delegator with args and a block', :arg1 do
+            it_behaves_like 'a delegator with args and a block' do
               before do
                 class Post
                   def name(*args, &block)

data/spec/lib/{delegate_to_method_spec.rb → instance_method_spec.rb}

@@ -36,7 +36,7 @@ module RSpec
             end
           end
 
-          it_behaves_like 'a delegator with args and a block', :arg1 do
+          it_behaves_like 'a delegator with args and a block' do
             before do
               class Post
                 def name(*args, &block)

data/spec/lib/{delegate_to_instance_variable_spec.rb → instance_variable_spec.rb}

@@ -8,6 +8,11 @@ module RSpec
           class Post
             def initialize
               @author = Author.new
+              @authors ||= [@author]
+            end
+
+            def inspect
+              'post'
             end
           end
 
@@ -37,7 +42,7 @@ module RSpec
               end
             end
 
-            it_behaves_like 'a delegator with args and a block', :arg1 do
+            it_behaves_like 'a delegator with args and a block' do
               before do
                 class Post
                   def name(*args, &block)
@@ -47,6 +52,17 @@ module RSpec
               end
             end
 
+            it_behaves_like 'a delegator with its own block' do
+              before do
+                class Post
+                  # rubocop:disable Style/SymbolProc
+                  def tainted?
+                    @authors.all? { |a| a.tainted? }
+                  end
+                end
+              end
+            end
+
             it_behaves_like 'a delegator with a different method name', :other_name do
               before do
                 class Post

data/spec/lib/shared/block.rb

@@ -14,7 +14,7 @@ shared_examples 'a delegator with a block' do
       it { expect(matcher.failure_message_when_negated).to match(/a block was passed/) }
     end
 
-    context 'without  a block' do
+    context 'without a block' do
       let(:matcher) { delegate(:name).to(receiver).without_a_block }
       it { expect(matcher.description).to eq "delegate name to #{receiver} without a block" }
       it { expect(matcher.failure_message).to match(/a block was passed/) }
@@ -22,6 +22,32 @@ shared_examples 'a delegator with a block' do
   end
 end
 
+shared_examples 'a delegator with its own block' do
+  # rubocop:disable Style/SymbolProc
+  it { should     delegate(:tainted?).to(:@authors).as(:all?).with_block { |a| a.tainted? } }
+  it { should_not delegate(:tainted?).to(:@authors).as(:all?).with_block { |a| a.to_s } }
+
+  describe 'description' do
+    before { matcher.matches? subject }
+
+    context 'with a block' do
+      let(:matcher) { delegate(:tainted?).to(:@authors).as(:all?).with_block { |a| a.tainted? } }
+      it { expect(matcher.description).to eq "delegate tainted? to @authors.all? with block 'proc { |a| a.tainted? }'" }
+      it { expect(matcher.failure_message_when_negated).to match(/a block was passed/) }
+    end
+
+    context 'with a different block' do
+      let(:matcher) { delegate(:tainted?).to(:@authors).as(:all?).with_block { |a| a.to_s } }
+      it { expect(matcher.failure_message).to match(/a different block 'proc { |a| a.tainted? }' was passed/) }
+    end
+
+    context 'without a block' do
+      let(:matcher) { delegate(:tainted?).to(:@authors).as(:all?).without_block }
+      it { expect(matcher.failure_message).to match(/a block was passed/) }
+    end
+  end
+end
+
 shared_examples 'a delegator without a block' do
   it { should delegate(:name).to(receiver).without_block  }
   it { should delegate(:name).to(receiver).without_a_block  }

metadata

@@ -1,15 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: delegate_matcher
 version: !ruby/object:Gem::Version
-  version: '0.1'
+  version: '0.2'
 platform: ruby
 authors:
 - Declan Whelan
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-12-13 00:00:00.000000000 Z
+date: 2015-12-15 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: proc_extensions
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.1'
 - !ruby/object:Gem::Dependency
   name: activesupport
   requirement: !ruby/object:Gem::Requirement
@@ -183,6 +197,7 @@ files:
 - Rakefile
 - delegate_matcher.gemspec
 - lib/delegate_matcher.rb
+- lib/delegate_matcher/block.rb
 - lib/delegate_matcher/delegate.rb
 - lib/delegate_matcher/delegate_matcher.rb
 - lib/delegate_matcher/delegation.rb
@@ -193,13 +208,14 @@ files:
 - lib/delegate_matcher/version.rb
 - spec/lib/active_support_delegation_spec.rb
 - spec/lib/aggregate_delegate_matcher_spec.rb
+- spec/lib/class_method_spec.rb
+- spec/lib/class_variable_spec.rb
+- spec/lib/constant_spec.rb
 - spec/lib/delegate_spec.rb
-- spec/lib/delegate_to_class_variable_spec.rb
-- spec/lib/delegate_to_constant_spec.rb
-- spec/lib/delegate_to_instance_variable_spec.rb
-- spec/lib/delegate_to_method_spec.rb
-- spec/lib/delegate_to_object_spec.rb
 - spec/lib/forwardable_delegation_spec.rb
+- spec/lib/instance_method_spec.rb
+- spec/lib/instance_variable_spec.rb
+- spec/lib/object_spec.rb
 - spec/lib/shared/a_simple_delegator.rb
 - spec/lib/shared/args.rb
 - spec/lib/shared/args_and_a_block.rb
@@ -230,20 +246,21 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.6
+rubygems_version: 2.4.5.1
 signing_key: 
 specification_version: 4
 summary: A matcher for testing ruby delegation.
 test_files:
 - spec/lib/active_support_delegation_spec.rb
 - spec/lib/aggregate_delegate_matcher_spec.rb
+- spec/lib/class_method_spec.rb
+- spec/lib/class_variable_spec.rb
+- spec/lib/constant_spec.rb
 - spec/lib/delegate_spec.rb
-- spec/lib/delegate_to_class_variable_spec.rb
-- spec/lib/delegate_to_constant_spec.rb
-- spec/lib/delegate_to_instance_variable_spec.rb
-- spec/lib/delegate_to_method_spec.rb
-- spec/lib/delegate_to_object_spec.rb
 - spec/lib/forwardable_delegation_spec.rb
+- spec/lib/instance_method_spec.rb
+- spec/lib/instance_variable_spec.rb
+- spec/lib/object_spec.rb
 - spec/lib/shared/a_simple_delegator.rb
 - spec/lib/shared/args.rb
 - spec/lib/shared/args_and_a_block.rb