delegate_matcher 0.3 → 0.4

data/spec/to_an_instance_method_spec.rb

@@ -0,0 +1,39 @@
+require 'spec_helper'
+
+module RSpec
+  module Matchers
+    module DelegateMatcher
+      describe 'delegation to an instance method' do
+        let(:klass) do
+          Class.new do
+            include PostMethods
+
+            def initialize
+              @authors = [author]
+            end
+
+            def author
+              @author ||= Author.new
+            end
+
+            def name
+              author.name
+            end
+
+            def name_allow_nil
+              author.name if author
+            end
+          end
+        end
+
+        subject { klass.new }
+
+        let(:receiver) { :author }
+
+        it_behaves_like 'a basic delegator'
+        it_behaves_like 'a delegator without a nil check'
+        it_behaves_like 'a delegator with a nil check'
+      end
+    end
+  end
+end

data/spec/to_an_instance_variable_spec.rb

@@ -0,0 +1,35 @@
+require 'spec_helper'
+
+module RSpec
+  module Matchers
+    module DelegateMatcher
+      describe 'delegation to an instance variable' do
+        let(:klass) do
+          Class.new do
+            include PostMethods
+
+            def initialize
+              @author = Author.new
+            end
+
+            def name
+              @author.name
+            end
+
+            def name_allow_nil
+              @author.name if @author
+            end
+          end
+        end
+
+        subject { klass.new }
+
+        let(:receiver) { :@author }
+
+        it_behaves_like 'a basic delegator'
+        it_behaves_like 'a delegator without a nil check'
+        it_behaves_like 'a delegator with a nil check'
+      end
+    end
+  end
+end

data/spec/to_an_object_spec.rb

@@ -0,0 +1,45 @@
+require 'spec_helper'
+
+module RSpec
+  module Matchers
+    module DelegateMatcher
+      describe 'delegation to an object' do
+        let(:klass) do
+          Class.new do
+            include PostMethods
+
+            def initialize(author)
+              @author = author
+            end
+
+            def name
+              @author.name
+            end
+          end
+        end
+
+        subject { klass.new(author) }
+
+        let(:author)   { Author.new }
+        let(:receiver) { author     }
+
+        it_behaves_like 'a basic delegator'
+
+        it do
+          expect { should delegate(:name).to(author).allow_nil }.to \
+            raise_error RuntimeError, 'cannot verify "allow_nil" expectations when delegating to an object'
+        end
+
+        it do
+          expect { should delegate(:name).to(author).allow_nil(true) }.to \
+            raise_error RuntimeError, 'cannot verify "allow_nil" expectations when delegating to an object'
+        end
+
+        it do
+          expect { should delegate(:name).to(author).allow_nil(false) }.to \
+            raise_error RuntimeError, 'cannot verify "allow_nil" expectations when delegating to an object'
+        end
+      end
+    end
+  end
+end

data/spec/to_multiple_targets_spec.rb

@@ -0,0 +1,34 @@
+require 'spec_helper'
+
+module RSpec
+  module Matchers
+    module DelegateMatcher
+      module Composite
+        describe 'delegation to multiple targets' do
+          class Post
+            include PostMethods
+
+            attr_accessor :authors, :catherine_asaro, :isaac_asimov
+
+            def initialize
+              self.catherine_asaro = Author.new('Catherine Asaro')
+              self.isaac_asimov    = Author.new('Isaac Asimov')
+              self.authors         = [catherine_asaro, isaac_asimov]
+            end
+
+            def name
+              authors.map(&:name)
+            end
+          end
+
+          subject { Post.new }
+
+          it { should delegate(:name).to(*subject.authors) }
+          it { should delegate(:name).to(subject.catherine_asaro, subject.isaac_asimov) }
+          it { should delegate(:name).to(:catherine_asaro, :isaac_asimov) }
+          it { should delegate(:name).to(:@catherine_asaro, :@isaac_asimov) }
+        end
+      end
+    end
+  end
+end

data/spec/with_args_spec.rb

@@ -0,0 +1,151 @@
+require 'spec_helper'
+require 'active_support/core_ext/module'
+
+module RSpec
+  module Matchers
+    # rubocop:disable Metrics/ModuleLength
+    module DelegateMatcher
+      shared_examples 'a delegator with empty args' do
+        let(:matcher) { delegate(:name).with.to(:@author) }
+
+        it { should matcher }
+        it { expect(matcher.description).to eq 'delegate name() to "@author"' }
+
+        it { should matcher.with }
+        it { expect(matcher.with.description).to eq 'delegate name() to "@author"' }
+
+        it { should matcher.with(no_args) }
+        it { expect(matcher.with(no_args).description).to eq 'delegate name() to "@author".name(no args)' }
+
+        it { expect(matcher.failure_message_when_negated).to match(/was called with ()/) }
+      end
+
+      shared_examples 'a delegator with no_args' do
+        let(:matcher) { delegate(:name).with(no_args).to(:@author) }
+
+        it { should matcher }
+        it { expect(matcher.description).to eq 'delegate name(no args) to "@author"' }
+
+        it { should matcher.with }
+        it { expect(matcher.with.description).to eq 'delegate name(no args) to "@author".name()' }
+
+        it { should matcher.with(no_args) }
+        it { expect(matcher.with(no_args).description).to eq 'delegate name(no args) to "@author"' }
+
+        it { expect(matcher.failure_message_when_negated).to match(/was called with ()/) }
+      end
+
+      shared_examples 'a delegator with same args' do |*args|
+        let(:args_description) { args.map(&:inspect).join(', ') }
+        let(:matcher) { delegate(:name).with(*args).to(:@author) }
+
+        it { should matcher }
+        it { expect(matcher.description).to eq %(delegate name(#{args_description}) to "@author") }
+
+        it { should matcher.with(*args) }
+        it { expect(matcher.with(*args).description).to eq %(delegate name(#{args_description}) to "@author") }
+      end
+
+      shared_examples 'a delegator with any args' do |*args|
+        let(:matcher) { delegate(:name).with(*args).to(:@author).with(any_args) }
+
+        it { should matcher }
+        it { expect(matcher.description).to eq %(delegate name(#{args.map(&:inspect).join(', ')}) to "@author".name(*(any args))) }
+      end
+
+      shared_examples 'a delegator with anything' do |*args|
+        let(:matcher) { delegate(:name).with(*args).to(:@author).with(anything) }
+
+        it { should matcher }
+        it { expect(matcher.description).to eq %(delegate name(#{args.map(&:inspect).join(', ')}) to "@author".name(anything)) }
+      end
+
+      describe 'argument matching' do
+        include_context 'Post delegation'
+
+        context <<-END.gsub(/^\s{6}/, '') do
+          # With no parameters
+          def name
+            @author.name
+          end
+        END
+          it_behaves_like 'a delegator with empty args'
+          it_behaves_like 'a delegator with no_args'
+          it_behaves_like 'a delegator with same args'
+          it_behaves_like 'a delegator with any args'
+
+          it { should_not delegate(:name).with.to(:@author).with(anything) }
+        end
+
+        context <<-END.gsub(/^\s{6}/, '') do
+          # With optional parameters
+          def name(*args)
+            @author.name(*args)
+          end
+        END
+
+          it_behaves_like 'a delegator with empty args'
+          it_behaves_like 'a delegator with no_args'
+          it_behaves_like 'a delegator with same args', 'Ms.'
+          it_behaves_like 'a delegator with anything',  'Ms.'
+          it_behaves_like 'a delegator with any args'
+          it_behaves_like 'a delegator with any args',  'Ms.'
+          it_behaves_like 'a delegator with any args',  'Ms.', 'Mrs.'
+
+          it { should_not delegate(:name).with('Ms.').to(:@author).with(no_args) }
+        end
+
+        context <<-END.gsub(/^\s{6}/, '') do
+          # With a required parameter
+          def name(title)
+            @author.name(title)
+          end
+        END
+
+          it_behaves_like 'a delegator with same args', 'Ms.'
+          it_behaves_like 'a delegator with any args',  'Ms.'
+          it_behaves_like 'a delegator with anything',  'Ms.'
+
+          let(:matcher) { delegate(:name).to(:@author).with('Ms.') }
+
+          it { should matcher }
+          it { expect(matcher.description).to eq 'delegate name("Ms.") to "@author"' }
+          it { expect(matcher.failure_message_when_negated).to match(/was called with \("Ms."\)/) }
+          it { should_not delegate(:name).with('Ms.').to(:@author).with(no_args) }
+        end
+
+        context <<-END.gsub(/^\s{6}/, '') do
+          # With an optional parameter
+          def name(title = 'Ms.')
+            @author.name(title)
+          end
+          END
+
+          it_behaves_like 'a delegator with same args', 'Ms.'
+          it_behaves_like 'a delegator with any args',  'Ms.'
+          it_behaves_like 'a delegator with anything',  'Ms.'
+
+          let(:matcher) { delegate(:name).to(:@author).with('Ms.') }
+
+          it { should matcher }
+          it { expect(matcher.description).to eq 'delegate name("Ms.") to "@author"' }
+          it { expect(matcher.failure_message_when_negated).to match(/was called with \("Ms."\)/) }
+        end
+
+        context <<-END.gsub(/^\s{6}/, '') do
+          # With arguments changed
+          def name(title)
+            @author.name(title.downcase)
+          end
+          END
+
+          let(:matcher) { delegate(:name).with('Ms.').to(:@author).with('ms.') }
+
+          it { should matcher }
+          it { expect(matcher.description).to eq 'delegate name("Ms.") to "@author".name("ms.")' }
+          it { expect(matcher.failure_message_when_negated).to match(/was called with \("ms."\)/) }
+        end
+      end
+    end
+  end
+end

data/spec/with_as_spec.rb

@@ -0,0 +1,25 @@
+require 'spec_helper'
+
+module RSpec
+  module Matchers
+    module DelegateMatcher
+      describe 'as matching' do
+        include_context 'Post delegation'
+
+        context <<-END.gsub(/^\s{6}/, '') do
+          # With a block
+          def name
+            @author.other_name
+          end
+          END
+
+          let(:matcher) { delegate(:name).to(:@author).as(:other_name) }
+
+          it { expect(matcher.description).to match(/to "@author".other_name/) }
+          it { expect(matcher.failure_message_when_negated).to match(/to "@author".other_name/) }
+          it { expect(matcher.as('bad_name').failure_message).to match(/to "@author".bad_name/) }
+        end
+      end
+    end
+  end
+end

data/spec/with_block_spec.rb

@@ -0,0 +1,75 @@
+require 'spec_helper'
+
+module RSpec
+  module Matchers
+    module DelegateMatcher
+      describe 'block matching' do
+        include_context 'Post delegation'
+
+        context <<-END.gsub(/^\s{6}/, '') do
+          # With a block
+          def name(&block)
+            @author.name(&block)
+          end
+          END
+
+          it { should matcher.with_block }
+          it { should matcher.with_a_block }
+          it { expect(matcher.with_block.description).to match(/with a block/) }
+          it { expect(matcher.with_block.failure_message_when_negated).to match(/a block was passed/) }
+
+          it { should_not matcher.without_block }
+          it { expect(matcher.without_block.failure_message).to match(/a block .* was passed/) }
+        end
+
+        context <<-END.gsub(/^\s{6}/, '') do
+          # Without a block
+          def name(&block)
+            @author.name
+          end
+          END
+
+          it { should matcher.without_block }
+          it { should matcher.without_a_block }
+          it { expect(matcher.without_block.description).to match(/without a block/) }
+          it { expect(matcher.without_block.failure_message_when_negated).to match(/a block was not passed/) }
+
+          it { should_not matcher.with_block }
+          it { expect(matcher.with_block.failure_message).to match(/a block was not passed/) }
+        end
+
+        context <<-END.gsub(/^\s{6}/, '') do
+          # With a custom block
+          def name(&block)
+            @author.name { 'yo' }
+          end
+          END
+
+          # To extract the proc source it must not eval'd so we redefine the method here
+          before do
+            klass.class_eval do
+              def name
+                @author.name { 'yo' }
+              end
+            end
+          end
+
+          # To extract the proc source it must be the only proc defined on the same line
+          let(:prc) do
+            proc { 'yo' }
+          end
+
+          let(:matcher) { delegate(:name).to(:@author).with_block(&prc) }
+
+          it { should matcher }
+
+          it { expect(matcher.description).to match(/with block "proc { "yo" }"/) }
+          it { expect(matcher.failure_message_when_negated).to match(/with block "proc { "yo" }"/) }
+
+          it { should_not matcher.without_block }
+          it { expect(matcher.without_block.failure_message).to match(/a block .* was passed/) }
+        end
+      end
+    end
+  end
+end

data/spec/with_prefix_spec.rb

@@ -0,0 +1,37 @@
+require 'spec_helper'
+
+module RSpec
+  module Matchers
+    module DelegateMatcher
+      describe 'prefix matching' do
+        include_context 'Post delegation'
+
+        context <<-END.gsub(/^\s{6}/, '') do
+          # With a default prefix
+          def author_name
+            @author.name
+          end
+          END
+
+          let(:matcher) { delegate(:name).to(:@author).with_prefix }
+
+          it { expect(matcher.description).to match(/author_name to "@author".name/) }
+          it { expect(matcher.failure_message_when_negated).to match(/author_name to "@author".name/) }
+        end
+
+        context <<-END.gsub(/^\s{6}/, '') do
+          # With a default prefix
+          def writer_name
+            @author.name
+          end
+          END
+
+          let(:matcher) { delegate(:name).to(:@author).with_prefix('writer') }
+
+          it { expect(matcher.description).to match(/writer_name to "@author".name/) }
+          it { expect(matcher.failure_message_when_negated).to match(/writer_name to "@author".name/) }
+        end
+      end
+    end
+  end
+end

data/spec/with_return_value_spec.rb

@@ -0,0 +1,46 @@
+require 'spec_helper'
+
+module RSpec
+  module Matchers
+    module DelegateMatcher
+      describe 'return value matching' do
+        include_context 'Post delegation'
+
+        context <<-END.gsub(/^\s{6}/, '') do
+          # With a different return value
+          def name
+            @author.name
+            'Ann Rand'
+          end
+          END
+
+          it { should_not matcher }
+          it { expect(matcher.failure_message).to match(/a value of \"Ann Rand\" was returned instead of/) }
+
+          describe 'without_return' do
+            let(:matcher) { delegate(:name).to(:@author).without_return }
+
+            it { should matcher }
+            it { expect(matcher.description).to match(/ without using delegate return value/) }
+            it { expect(matcher.failure_message_when_negated).to match(/ without using delegate return value/) }
+          end
+
+          describe 'and_return' do
+            let(:matcher) { delegate(:name).to(:@author).and_return('Ann Rand') }
+
+            it { should matcher }
+            it { expect(matcher.description).to match(/ and return "Ann Rand"/) }
+            it { expect(matcher.failure_message_when_negated).to match(/ and return "Ann Rand"/) }
+          end
+
+          describe 'and_return incorrect value' do
+            let(:matcher) { delegate(:name).to(:@author).and_return('Isaac Asimov') }
+
+            it { should_not matcher }
+            it { expect(matcher.failure_message).to match(/a value of "Ann Rand" was returned instead of "Isaac Asimov"/) }
+          end
+        end
+      end
+    end
+  end
+end

data/spec/with_to_spec.rb

@@ -0,0 +1,53 @@
+require 'spec_helper'
+
+module RSpec
+  module Matchers
+    module DelegateMatcher
+      describe 'to' do
+        let(:klass) do
+          Class.new do
+            include PostMethods
+
+            def initialize
+              @author = Author.new
+            end
+
+            def name
+              @author.name
+            end
+
+            def name_allow_nil
+              @author.name if @author
+            end
+          end
+        end
+
+        subject { klass.new }
+
+        it 'should require a "to"' do
+          expect { should delegate(:name) }.to raise_error do |error|
+            expect(error.message).to match(/need to provide a "to"/)
+          end
+        end
+
+        it 'should raise if the "to" method is invalid' do
+          expect { should delegate(:name).to(:does_not_exist) }.to raise_error do |error|
+            expect(error.message).to match(/undefined local variable or method .*does_not_exist/)
+          end
+        end
+
+        it 'should raise if "to" constant is invalid' do
+          expect { should delegate(:name).to(:DOES_NOT_EXIST) }.to raise_error do |error|
+            expect(error.message).to match(/uninitialized constant .*DOES_NOT_EXIST/)
+          end
+        end
+
+        it 'should raise if "to" instance variable is nil' do
+          expect { should delegate(:name).to(:@does_not_exist) }.to raise_error do |error|
+            expect(error.message).to match(/undefined method `name' for nil:NilClass/)
+          end
+        end
+      end
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: delegate_matcher
 version: !ruby/object:Gem::Version
-  version: '0.3'
+  version: '0.4'
 platform: ruby
 authors:
 - Declan Whelan
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-12-16 00:00:00.000000000 Z
+date: 2015-12-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: proc_extensions
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.1'
+        version: '0.2'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.1'
+        version: '0.2'
 - !ruby/object:Gem::Dependency
   name: activesupport
   requirement: !ruby/object:Gem::Requirement
@@ -185,7 +185,6 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- ".bundle/config"
 - ".gitignore"
 - ".rubocop.yml"
 - ".travis.yml"
@@ -194,6 +193,7 @@ files:
 - Guardfile
 - LICENSE.txt
 - README.md
+- README.md.erb
 - Rakefile
 - delegate_matcher.gemspec
 - lib/delegate_matcher.rb
@@ -206,26 +206,27 @@ files:
 - lib/delegate_matcher/nil_delegate.rb
 - lib/delegate_matcher/stub_delegate.rb
 - 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/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
-- spec/lib/shared/author.rb
-- spec/lib/shared/block.rb
-- spec/lib/shared/different_method_name.rb
-- spec/lib/shared/different_return_value.rb
-- spec/lib/shared/nil_check.rb
-- spec/lib/shared/prefix.rb
+- spec/examples/active_support_delegation_spec.rb
+- spec/examples/forwardable_delegation_spec.rb
+- spec/shared/author.rb
+- spec/shared/basic.rb
+- spec/shared/nil_check.rb
+- spec/shared/post_delegation.rb
+- spec/shared/post_methods.rb
 - spec/spec_helper.rb
+- spec/to_a_class_method_spec.rb
+- spec/to_a_class_variable_spec.rb
+- spec/to_a_constant_spec.rb
+- spec/to_an_instance_method_spec.rb
+- spec/to_an_instance_variable_spec.rb
+- spec/to_an_object_spec.rb
+- spec/to_multiple_targets_spec.rb
+- spec/with_args_spec.rb
+- spec/with_as_spec.rb
+- spec/with_block_spec.rb
+- spec/with_prefix_spec.rb
+- spec/with_return_value_spec.rb
+- spec/with_to_spec.rb
 homepage: https://github.com/dwhelan/delegate_matcher
 licenses:
 - MIT
@@ -251,23 +252,24 @@ 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/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
-- spec/lib/shared/author.rb
-- spec/lib/shared/block.rb
-- spec/lib/shared/different_method_name.rb
-- spec/lib/shared/different_return_value.rb
-- spec/lib/shared/nil_check.rb
-- spec/lib/shared/prefix.rb
+- spec/examples/active_support_delegation_spec.rb
+- spec/examples/forwardable_delegation_spec.rb
+- spec/shared/author.rb
+- spec/shared/basic.rb
+- spec/shared/nil_check.rb
+- spec/shared/post_delegation.rb
+- spec/shared/post_methods.rb
 - spec/spec_helper.rb
+- spec/to_a_class_method_spec.rb
+- spec/to_a_class_variable_spec.rb
+- spec/to_a_constant_spec.rb
+- spec/to_an_instance_method_spec.rb
+- spec/to_an_instance_variable_spec.rb
+- spec/to_an_object_spec.rb
+- spec/to_multiple_targets_spec.rb
+- spec/with_args_spec.rb
+- spec/with_as_spec.rb
+- spec/with_block_spec.rb
+- spec/with_prefix_spec.rb
+- spec/with_return_value_spec.rb
+- spec/with_to_spec.rb

data/.bundle/config

@@ -1,3 +0,0 @@
----
-BUNDLE_RETRY: '3'
-BUNDLE_JOBS: '3'