delegate_matcher 0.0.3 → 0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: a2fc3381de7601d9699de188f3f24cfa11066f60
-  data.tar.gz: 8fd2cd2811125dd7f82966141071776b64b155c9
+  metadata.gz: 70876c332f24b6734e75025e90814f096a922405
+  data.tar.gz: e7ba6dd00b072b61cfdd84d6be52015f4a974ddf
 SHA512:
-  metadata.gz: 67f45287b58103aae009169440ef82e9fe3c7e042997072080b3ff27424aefbfb3644461fb9a4b7497af2d57abb9a7d1ca7d7b1c33c4a7d750a8e52961f6c9b5
-  data.tar.gz: 8b32722dc5dd7698333045fe7ebc26331dad2f5f2491c48c3626faa6540195f0f00d8fc467a245245a555d55ab857ef0c774730b2a71e9fe846da7b55871cf7d
+  metadata.gz: 88355c0fecfc0e24710bc03e37f66a52ac70c72968427cc912577d30548981eae932af200b0e8d47a326dae4405de47f19fc74fce95107c97d85999ffd0d652b
+  data.tar.gz: cbb8a022a4701b3a1d06d674ed6fd2298313a87c59b78e76618bf37d86ead5e5fb38f52c894fb34a1099851dc174d31d5b473d3707632b3e8630d975b05b8c8a

data/.bundle/config

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

data/.gitignore

@@ -1,3 +1,5 @@
 /.idea/
 /coverage/
-/pkg/
+/pkg/
+/tmp/
+/Gemfile.lock/

data/.rubocop.yml

@@ -21,3 +21,11 @@ Style/Semicolon:
 
 Lint/Eval:
   Enabled: false
+
+AllCops:
+  Exclude:
+    - 'tmp/**/*'
+    - 'vendor/**/*'
+
+Metrics/AbcSize:
+  Max: 20

data/.travis.yml

@@ -1,7 +1,12 @@
 language: ruby
 rvm:
   - 1.9.3
-  - 2.0.0
+  - 2.0
   - 2.1
   - 2.2
-  - ruby-head
+
+before_install: bundle
+
+branches:
+  only:
+    - master

data/Gemfile.lock

@@ -1,12 +1,12 @@
 PATH
   remote: .
   specs:
-    delegate_matcher (0.0.3)
+    delegate_matcher (0.1)
 
 GEM
   remote: https://rubygems.org/
   specs:
-    activesupport (4.2.3)
+    activesupport (4.2.5)
       i18n (~> 0.7)
       json (~> 1.7, >= 1.7.7)
       minitest (~> 5.1)
@@ -15,61 +15,111 @@ GEM
     ast (2.1.0)
     astrolabe (1.3.1)
       parser (~> 2.2)
-    coveralls (0.7.2)
-      multi_json (~> 1.3)
-      rest-client (= 1.6.7)
-      simplecov (>= 0.7)
-      term-ansicolor (= 1.2.2)
-      thor (= 0.18.1)
+    byebug (8.2.0)
+    coderay (1.1.0)
+    coveralls (0.8.9)
+      json (~> 1.8)
+      rest-client (>= 1.6.8, < 2)
+      simplecov (~> 0.10.0)
+      term-ansicolor (~> 1.3)
+      thor (~> 0.19.1)
+      tins (~> 1.6.0)
     diff-lcs (1.2.5)
     docile (1.1.5)
+    domain_name (0.5.25)
+      unf (>= 0.0.5, < 1.0.0)
+    ffi (1.9.10)
+    formatador (0.2.5)
+    guard (2.13.0)
+      formatador (>= 0.2.4)
+      listen (>= 2.7, <= 4.0)
+      lumberjack (~> 1.0)
+      nenv (~> 0.1)
+      notiffany (~> 0.0)
+      pry (>= 0.9.12)
+      shellany (~> 0.0)
+      thor (>= 0.18.1)
+    guard-compat (1.2.1)
+    guard-rspec (4.6.4)
+      guard (~> 2.1)
+      guard-compat (~> 1.1)
+      rspec (>= 2.99.0, < 4.0)
+    http-cookie (1.0.2)
+      domain_name (~> 0.5)
     i18n (0.7.0)
     json (1.8.3)
-    mime-types (2.4.3)
-    minitest (5.7.0)
-    multi_json (1.10.1)
-    parser (2.2.2.6)
+    listen (3.0.5)
+      rb-fsevent (>= 0.9.3)
+      rb-inotify (>= 0.9)
+    lumberjack (1.0.9)
+    method_source (0.8.2)
+    mime-types (2.99)
+    minitest (5.8.3)
+    nenv (0.2.0)
+    netrc (0.11.0)
+    notiffany (0.0.8)
+      nenv (~> 0.1)
+      shellany (~> 0.0)
+    parser (2.2.3.0)
       ast (>= 1.1, < 3.0)
     powerpack (0.1.1)
+    pry (0.10.3)
+      coderay (~> 1.1.0)
+      method_source (~> 0.8.1)
+      slop (~> 3.4)
+    pry-byebug (3.3.0)
+      byebug (~> 8.0)
+      pry (~> 0.10)
     rainbow (2.0.0)
     rake (10.4.2)
-    rest-client (1.6.7)
-      mime-types (>= 1.16)
-    rspec (3.3.0)
-      rspec-core (~> 3.3.0)
-      rspec-expectations (~> 3.3.0)
-      rspec-mocks (~> 3.3.0)
-    rspec-core (3.3.2)
-      rspec-support (~> 3.3.0)
-    rspec-expectations (3.3.1)
+    rb-fsevent (0.9.6)
+    rb-inotify (0.9.5)
+      ffi (>= 0.5.0)
+    rest-client (1.8.0)
+      http-cookie (>= 1.0.2, < 2.0)
+      mime-types (>= 1.16, < 3.0)
+      netrc (~> 0.7)
+    rspec (3.4.0)
+      rspec-core (~> 3.4.0)
+      rspec-expectations (~> 3.4.0)
+      rspec-mocks (~> 3.4.0)
+    rspec-core (3.4.1)
+      rspec-support (~> 3.4.0)
+    rspec-expectations (3.4.0)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.3.0)
-    rspec-its (1.1.0)
+      rspec-support (~> 3.4.0)
+    rspec-its (1.2.0)
       rspec-core (>= 3.0.0)
       rspec-expectations (>= 3.0.0)
-    rspec-mocks (3.3.2)
+    rspec-mocks (3.4.0)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.3.0)
-    rspec-support (3.3.0)
-    rubocop (0.33.0)
+      rspec-support (~> 3.4.0)
+    rspec-support (3.4.1)
+    rubocop (0.35.1)
       astrolabe (~> 1.3)
-      parser (>= 2.2.2.5, < 3.0)
+      parser (>= 2.2.3.0, < 3.0)
       powerpack (~> 0.1)
       rainbow (>= 1.99.1, < 3.0)
-      ruby-progressbar (~> 1.4)
+      ruby-progressbar (~> 1.7)
+      tins (<= 1.6.0)
     ruby-progressbar (1.7.5)
-    simplecov (0.9.1)
+    shellany (0.0.1)
+    simplecov (0.10.0)
       docile (~> 1.1.0)
-      multi_json (~> 1.0)
-      simplecov-html (~> 0.8.0)
-    simplecov-html (0.8.0)
-    term-ansicolor (1.2.2)
-      tins (~> 0.8)
-    thor (0.18.1)
+      json (~> 1.8)
+      simplecov-html (~> 0.10.0)
+    simplecov-html (0.10.0)
+    slop (3.6.0)
+    term-ansicolor (1.3.2)
+      tins (~> 1.0)
+    thor (0.19.1)
     thread_safe (0.3.5)
-    tins (0.13.2)
+    tins (1.6.0)
     tzinfo (1.2.2)
       thread_safe (~> 0.1)
+    unf (0.1.4)
+      unf_ext
+    unf_ext (0.0.7.1)
 
 PLATFORMS
   ruby
@@ -79,6 +129,9 @@ DEPENDENCIES
   bundler (~> 1.7)
   coveralls (~> 0.7)
   delegate_matcher!
+  guard (~> 2.13)
+  guard-rspec (~> 4.6)
+  pry-byebug (~> 3.3)
   rake (~> 10.0)
   rspec (~> 3.0)
   rspec-its (~> 1.1)

data/Guardfile

@@ -0,0 +1,4 @@
+guard :rspec, cmd: 'bundle exec rspec' do
+  watch(%r{^lib/(.+)\.rb$})  { 'spec' }
+  watch(%r{^spec/(.+)\.rb$}) { 'spec' }
+end

data/README.md

@@ -1,13 +1,14 @@
+[![Gem Version](https://badge.fury.io/rb/delegate_matcher.png)](http://badge.fury.io/rb/delegate_matcher)
 [![Build Status](https://travis-ci.org/dwhelan/delegate_matcher.png?branch=master)](https://travis-ci.org/dwhelan/delegate_matcher)
+[![Code Climate](https://codeclimate.com/github/dwhelan/delegate_matcher/badges/gpa.svg)](https://codeclimate.com/github/dwhelan/delegate_matcher)
+[![Coverage Status](https://coveralls.io/repos/dwhelan/delegate_matcher/badge.svg?branch=master&service=github)](https://coveralls.io/github/dwhelan/delegate_matcher?branch=master)
 
 # Delegate Matcher
-
 An RSpec matcher for validating delegation. This matcher works with delegation based on the [Forwardable](http://ruby-doc.org/stdlib-2.0.0/libdoc/forwardable/rdoc/Forwardable.html) module,
 the [delegate](http://api.rubyonrails.org/classes/Module.html#method-i-delegate) method in the Active Support gem or with
 simple custom delegation.
 
 ## Installation
-
 Add this line to your application's Gemfile:
 
 ```ruby
@@ -26,14 +27,13 @@ Or install it yourself as:
 $ gem install delegate_matcher
 ```
 
-Then add the following to your ```spec_helper.rb``` file:
+Then add the following to your `spec_helper.rb` file:
 
 ```ruby
 require 'delegate_matcher'
 ```
 
 ## Usage
-
 This matcher allows you to validate delegation to:
 * instance methods
 * class methods
@@ -45,7 +45,7 @@ This matcher allows you to validate delegation to:
 ```ruby
 describe Post do
   it { should delegate(:name).to(:author)   } # name  => author().name    instance method
-  it { should delegate(:name).to(:class))   } # name  => self.class.name  class method
+  it { should delegate(:name).to(:class)    } # name  => self.class.name  class method
   it { should delegate(:name).to(:@author)  } # name  => @author.name     instance variable
   it { should delegate(:name).to(:@@author) } # name  => @@author.name    class variable
   it { should delegate(:first).to(:GENRES)  } # first => GENRES.first     constant
@@ -56,21 +56,29 @@ end
 ### Delegate Method Name
 
 If the name of the method being invoked on the delegate is different from the method being called you
-can check this using the ```with_prefix``` method (based on Active Support ```delegate``` method) or the
-```as``` method.
+can check this using the `with_prefix` method (based on Active Support `delegate` method) or the
+`as` method.
+
+```ruby
+describe Post do
+  it { should delegate(:name).to(:author).with_prefix }          # author_name  => author.name
+  it { should delegate(:name).to(:author).with_prefix(:writer) } # writer_name  => author.name
+  it { should delegate(:writer).to(:author).as(:name) }          # writer       => author.name
+end
+```
+
+**Note**: if you are delegating to an  object then you must provide an expicit prefix to `with_prefix`:
 
 ```ruby
 describe Post do
-  it { should delegate(:name).to(author).with_prefix }          # author_name  => author.name
+  it { should delegate(:name).to(author).with_prefix }          # an error will be raised
   it { should delegate(:name).to(author).with_prefix(:writer) } # writer_name  => author.name
-  it { should delegate(:writer).to(author).as(:name) }          # writer       => author.name
 end
 ```
 
 ### Handling Nil Delegates
-
-If you expect the delegate to return ```nil``` when the delegate is ```nil``` rather than raising an error
-then you can check this using the ```allow_nil``` method.
+If you expect the delegate to return `nil` when the delegate is `nil` rather than raising an error
+then you can check this using the `allow_nil` method.
 
 ```ruby
 describe Post do
@@ -80,153 +88,154 @@ describe Post do
 end
 ```
 
-Nil handling is only checked if ```allow_nil``` is specified.
+Nil handling is only checked if `allow_nil` is specified.
 
-Note that matcher will raise an error if you use this when checking delegation to a constant or an
-object since the matcher cannot validate ```nil``` handling in these cases.
+Note that the matcher will raise an error if you use this when checking delegation to an
+object since the matcher cannot validate `nil` handling as it cannot gain access to the subject
+reference to the object to set it `nil`.
 
 ### Arguments
-
-If the method being delegated takes arguments you can supply them with the ```with``` method. The matcher
+If the method being delegated takes arguments you can supply them with the `with` method. The matcher
 will check that the provided arguments are in turn passed to the delegate.
 
 ```ruby
 describe Post do
-  it { should delegate(:name).with('Ms.')to(:author) }  # name('Ms.')  => author.name('Ms.')
+  it { should delegate(:name).with('Ms.').to(:author) }  # name('Ms.')  => author.name('Ms.')
 end
 ```
 
 Also, in some cases the delegator might make minor changes to the arguments. While this is arguably no
-longer true delegation you can still check that arguments are correctly passed by using a second ```with```
+longer true delegation you can still check that arguments are correctly passed by using a second `with`
 method to specify the arguments expected by the delegate.
 
 ```ruby
 describe Post do
-  it { should delegate(:name).with('Ms.')to(author).with('Miss') }  # name('Ms.')  => author.name('Miss')
+  it { should delegate(:name).with('Ms.')to(:author).with('Miss') }  # name('Ms.')  => author.name('Miss')
 end
 ```
 
 ### Blocks
-
-You can check that a block passed is in turn passed to the delegate via the ```with_block``` method.
+You can check that a block passed is in turn passed to the delegate via the `with_block` method.
 
 ```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
 ```
 
-By default, block delegation is only checked if ```with_a_block``` or ```without_a_block``` is specified.
+### Return Value
+Normally the matcher will check that the value return is the same as the value
+returned from the delegate. You can skip this check by using `without_return`.
 
-### Active Support
+```ruby
+describe Post do
+  it { should delegate(:name).to(:author).without_return }
+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.
 
 ```ruby
-class Post
-  attr_accessor :author
-
-  class_variable_set(:@@authors, ['Ann Rand', 'Catherine Asaro'])
-  GENRES ||= ['Fiction', 'Science Fiction']
-
-  delegate :name,                to: :author
-  delegate :name,                to: :author, prefix: true
-  delegate :name,                to: :author, prefix: :writer
-  delegate :name_with_nil_check, to: :author, allow_nil: true
-  delegate :name_with_arg,       to: :author
-  delegate :name_with_block,     to: :author
-  delegate :count,               to: :@@authors
-  delegate :first,               to: :GENRES
-  delegate :name,                to: :class, prefix: true
-end
-
-class Author
-  def name
-    'Catherine Asaro'
+  class Post
+    attr_accessor :author
+
+    @@authors = ['Ann Rand', 'Catherine Asaro']
+    GENRES    = ['Fiction',  'Science Fiction']
+
+    delegate :name,  to: :author, allow_nil: true
+    delegate :name,  to: :author, prefix: true
+    delegate :name,  to: :author, prefix: :writer
+    delegate :name,  to: :class,  prefix: true
+    delegate :count, to: :@@authors
+    delegate :first, to: :GENRES
+
+    def initialize
+      @author = Author.new
+    end
   end
 
-  def name_with_nil_check
-    name
+  class Author
+    def name
+      'Catherine Asaro'
+    end
   end
 
-  def name_with_arg(arg)
-    "#{arg} #{name}"
-  end
+  describe Post do
+    let(:author) { subject.author }
 
-  def name_with_block(&block)
-    "#{block.call} #{name}"
-  end
-end
+    it { expect(subject.name).to eq 'Catherine Asaro' }
 
-describe Post do
-  it { should delegate(:name).to(:author) }
-  it { should delegate(:name).to(:@author) }
-  it { should delegate(:name_with_nil_check).to(:author).allow_nil }
-  it { should delegate(:name).to(:author).with_prefix }
-  it { should delegate(:name).to(:author).with_prefix(:writer) }
-
-  it { should delegate(:name_with_arg).to(:author).with('Ms.') }
-  it { should delegate(:name_with_block).to(:author).with_block }
-  it { should delegate(:count).to(:@@authors)   }
-  it { should delegate(:first).to(:GENRES)   }
-  it { should delegate(:name).to(:class).with_prefix   }
-end
+    it { should delegate(:name).to(author) }
+    it { should delegate(:name).to(:@author) }
+    it { should delegate(:name).to(:author) }
+    it { should delegate(:name).to(:author).allow_nil }
+    it { should delegate(:name).to(:author).with_prefix }
+    it { should delegate(:name).to(:author).with_prefix(:writer) }
+    it { should delegate(:name).to(:author).with_block }
+    it { should delegate(:name).to(:author).with('Ms.') }
+
+    it { should delegate(:name).to(:class).with_prefix   }
+    it { should delegate(:count).to(:@@authors)   }
+    it { should delegate(:first).to(:GENRES)   }
+  end
 ```
 However, don't use the following features as they are not supported by the delegate method:
 * delegation to objects
 * different arguments passed to delegate
 
 ### Forwardable Module
-
 You can test delegation based on the [Forwardable](http://ruby-doc.org/stdlib-2.0.0/libdoc/forwardable/rdoc/Forwardable.html) module.
 
 ```ruby
-class Post
-  extend Forwardable
+  class Post
+    extend Forwardable
 
-  attr_accessor :author
+    attr_accessor :author
 
-  def_delegator :author, :name
-  def_delegator :author, :name, :writer
-  def_delegator :author, :name_with_arg
-  def_delegator :author, :name_with_block
-end
+    def initialize
+      @author = Author.new
+    end
 
-class Author
-  def name
-    'Catherine Asaro'
+    def_delegator :author, :name
+    def_delegator :author, :name, :author_name
+    def_delegator :author, :name, :writer
   end
 
-  def name_with_arg(arg)
-    "#{arg} #{name}"
+  class Author
+    def name
+      'Catherine Asaro'
+    end
   end
 
-  def name_with_block(&block)
-    "#{block.call} #{name}"
-  end
-end
+  describe Post do
+    let(:author) { subject.author }
 
-describe Post do
-  it { should delegate(:name).to(:author) }
-  it { should delegate(:name).to(:@author) }
-  it { should delegate(:writer).to(:author).as(:name) }
-  it { should delegate(:name_with_arg).to(:author).with('Ms.') }
-  it { should delegate(:name_with_block).to(:author).with_block }
-end
+    it { expect(subject.name).to eq 'Catherine Asaro' }
+
+    it { should delegate(:name).to(author) }
+    it { should delegate(:name).to(:@author) }
+    it { should delegate(:name).to(:author) }
+    it { should delegate(:name).to(:author).with('Ms.') }
+    it { should delegate(:name).to(:author).with_block }
+    it { should delegate(:name).to(:author).with_prefix }
+    it { should delegate(:writer).to(:author).as(:name) }
+  end
 ```
 However, don't use the following features as they are not supported by the Forwardable module:
-* allow_nil
+* `allow_nil`
 * delegation to class variables
 * delegation to constants
 * delegation to objects
 * different arguments passed to delegate
 
 ## Contributing
-
 1. Fork it ( https://github.com/dwhelan/delegate_matcher/fork )
 2. Create your feature branch (`git checkout -b my-new-feature`)
 3. Commit your changes (`git commit -am 'Add some feature'`)
@@ -234,5 +243,4 @@ However, don't use the following features as they are not supported by the Forwa
 5. Create a new Pull Request
 
 ## Notes
-
 This matcher was inspired by [Alan Winograd](https://github.com/awinograd) via the gist https://gist.github.com/awinograd/6158961

data/Rakefile

@@ -3,6 +3,8 @@ require 'rspec/core/rake_task'
 require 'rubocop/rake_task'
 
 RSpec::Core::RakeTask.new(:spec)
-RuboCop::RakeTask.new
+RuboCop::RakeTask.new do |task|
+  task.options << '--display-cop-names'
+end
 
 task default: [:spec, :rubocop, :build]

data/delegate_matcher.gemspec

@@ -19,12 +19,21 @@ 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 '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 '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'
+  else
+    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'
 end