fakes-rspec 1.0.3 → 1.0.4

data/.gitignore

@@ -0,0 +1,8 @@
+blah.rb
+*.gem
+.bundle
+Gemfile.lock
+pkg/*
+.rvmrc
+.ruby-version
+.ruby-gemset

data/Gemfile

@@ -0,0 +1,3 @@
+source "http://rubygems.org"
+
+gemspec

data/Guardfile

@@ -0,0 +1,5 @@
+guard 'rspec' do
+  watch(%r{^spec/.+_spec\.rb$})
+  watch(%r{^lib/(.+)\.rb$})     { |m| "spec/lib/#{m[1]}_spec.rb" }
+  watch('spec/spec_helper.rb')  { "spec" }
+end

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2012 Jean-Paul S. Boodhoo
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,167 @@
+#fakes-rspec
+
+This is a library to aid in the usage of [fakes](http://github.com/developwithpassion/fakes) when using [RSpec](https://github.com/rspec/rspec). It adds a bunch of convienience methods and matchers to aid in the usage of the heavily AAA style isolation library.
+
+##Installation
+```bash
+gem install fakes-rspec
+```
+Or (preferably using bundler), in your gemfile:
+
+```ruby
+source "http://rubygems.org"
+gem 'fakes-rspec'
+```
+
+When you install the gem it will install the rspec gem also, so you will be immediately ready to go.
+
+##Usage
+
+##Creating a fake
+
+###Using a let block
+```ruby
+describe "Some Feature" do
+  let(:my_fake){fake}
+end
+```
+
+###Inline
+```ruby
+describe "Some Feature" do
+  it "should be able to create a fake" do
+    item = fake
+  end
+end
+```
+##Configuring a fake with return values for calls
+
+###Irrespective of arguments:
+```ruby
+it "should be able to setup a fakes return values" do
+  the_fake = fake
+  fake.stub(:hello).and_return("World")
+
+  fake.hello.should == "World"
+  fake.hello("There").should == "World"
+end
+```
+
+###Caring about arguments:
+```ruby
+it "should be able to setup a fakes return values" do
+  the_fake = fake
+  fake.stub(:hello).with("There").and_return("World")
+  fake.stub(:hello).with("You").and_return("Again")
+
+  fake.stub(:hello).and_return("Does Not Matter") # when you use the catch_all, make sure that it is the last step used for a particular method (as above)
+
+  fake.hello("There").should == "World"
+  fake.hello("You").should == "Again"
+  fake.hello.should == "Does Not Matter"
+end
+```
+
+##Determining whether a call was made
+
+One of the big strengths of this library compared to some of the other ruby isolation libraries is the ability to let you make assertions against the fake after the [subject] has run its code. The following examples demonstrate some typical usage scenarios:
+
+###Irrespective of arguments:
+```ruby
+it "should be able to determine if a call was made on a fake" do
+  the_fake = fake
+  fake.hello("World")
+
+  fake.should have_received(:hello) #true
+end
+```
+###With a specific set of arguments:
+```ruby
+it "should be able to determine if a call was made on a fake" do
+  the_fake = fake
+  fake.hello("World")
+
+  fake.should have_received(:hello,"World") #true
+  fake.should have_received(:hello,"Other") #false
+end
+```
+Remember, that because it is just a matcher, to negate the matcher you can use the should_not qualifier to do the opposite:
+
+###Determine whether a call was not made with a specific set of arguments:
+```ruby
+it "should be able to determine if a call was not made on a fake" do
+  the_fake = fake
+  fake.hello("World")
+
+  fake.should_not have_received(:hello,"Other") #true
+end
+```
+
+##Determining that a call was made a certain number of times
+
+###Irrespective of arguments:
+```ruby
+it "should be able to determine if a call was made on a fake" do
+  the_fake = fake
+  fake.hello("World")
+
+  fake.should have_received(:hello).once #true
+end
+```
+
+###Caring about arguments:
+```ruby
+it "should be able to determine if a call was made on a fake" do
+  the_fake = fake
+  fake.hello("World")
+
+  fake.should have_received(:hello,"World").once #true
+  fake.should have_received(:hello,"Earth").once #false
+end
+```
+
+Remember, that because it is just a matcher, to negate the matcher you can use the should_not qualifier to do the opposite:
+
+###Determine whether a call was not made a specific number of times with a specific set of arguments:
+```ruby
+it "should be able to determine if a call was made on a fake" do
+  the_fake = fake
+  fake.hello("World")
+
+  fake.should_not have_received(:hello,"World").twice #true
+  fake.should_not have_received(:hello).twice #true
+end
+```
+
+After calling have_received, you can specify occurences using one of the following methods:
+
+* once
+* twice
+* at_least_once
+* at_least_twice
+* at_most_once
+* at_most_twice
+* at_least(times)
+* at_most(times)
+* exactly(times)
+* occurs(match_block) - Where match_block is a proc/lambda that matches the signature lambda{|number| bool}
+
+An example of using the occurs method would be as follows:
+
+###Determine whether a call was made between a certain number of times
+```ruby
+it "should be able to determine if a call was made on a fake" do
+  the_fake = fake
+  fake.hello("World")
+  fake.hello("Again")
+
+  fake.should have_received(,:hello).occurs(lamdba{|number| (1..3) === number}) #true
+end
+```
+
+##Contributing
+
+Feel free to fork this codebase and submit any pull requests you think would be useful. When you submit a pull request, make sure to include an accompanying test for the feature.
+
+
+[Develop With Passion®](http://www.developwithpassion.com)

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/fakes-rspec.gemspec

@@ -0,0 +1,26 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib",__FILE__)
+require "fakes_rspec/version"
+
+Gem::Specification.new do |s|
+  s.name        = "fakes-rspec"
+  s.version     = Fakes::RSpec::VERSION
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = ["Develop With Passion®"]
+  s.email       = ["open_source@developwithpassion.com"]
+  s.homepage    = "http://www.developwithpassion.com"
+  s.summary     = %q{Utility functions for develowithpassion_fakes when working with rSpec}
+  s.description = %q{Faking library that allows inspection of received calls after they have been made. Also supports tracking calls with multiple argument sets.}
+  s.rubyforge_project = "fakes-rspec"
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.require_paths = ["lib"]
+
+  s.add_development_dependency "rake"
+  s.add_development_dependency "rspec"
+  s.add_development_dependency "guard"
+  s.add_development_dependency "guard-rspec"
+  s.add_runtime_dependency "fakes"
+  s.add_runtime_dependency "rspec"
+end

data/lib/fakes-rspec.rb

@@ -0,0 +1,16 @@
+require 'fakes'
+require 'rspec'
+require 'singleton'
+
+require 'fakes_rspec/block_criteria'
+require 'fakes_rspec/matcher'
+require 'fakes_rspec/nullo_specification'
+require 'fakes_rspec/occurances'
+require 'fakes_rspec/received_occurances_criteria'
+require 'fakes_rspec/received_criteria'
+
+RSpec.configure do |config|
+  config.after(:each) do
+    reset_fake_classes
+  end
+end

data/lib/fakes_rspec/block_criteria.rb

@@ -0,0 +1,12 @@
+module Fakes
+  module RSpec
+    class BlockCriteria
+      def initialize(condition_block)
+        @condition_block = condition_block
+      end
+      def is_satisfied_by(item)
+        return @condition_block.call(item)
+      end
+    end
+  end
+end

data/lib/fakes_rspec/matcher.rb

@@ -0,0 +1,46 @@
+module RSpec
+  def self.create_received_criteria_from(the_call)
+    return Fakes::RSpec::ReceivedCriteria.new(the_call)
+  end
+  def self.create_received_occurences_criteria_from(the_call,occurence)
+    return Fakes::RSpec::ReceivedOccurencesCriteria.new(create_received_criteria_from(the_call),the_call,occurence)
+  end
+
+  Matchers.define :have_received do|symbol,*args|
+    @occurence_spec = Fakes::RSpec::NulloSpecification.instance
+
+    chain :once do
+      @occurence_spec = Fakes::RSpec::Occurances.exact(1)
+    end
+    chain :twice do
+      @occurence_spec = Fakes::RSpec::Occurances.exact(2)
+    end
+    chain :at_least_once do
+      @occurence_spec = Fakes::RSpec::Occurances.at_least(1)
+    end
+    chain :at_least_twice do
+      @occurence_spec = Fakes::RSpec::Occurances.at_least(2)
+    end
+    chain :at_most_once do
+      @occurence_spec = Fakes::RSpec::Occurances.at_most(1)
+    end
+    chain :at_most_twice do
+      @occurence_spec = Fakes::RSpec::Occurances.at_most(2)
+    end
+    chain :at_least do|times|
+      @occurence_spec =  Fakes::RSpec::Occurances.at_least(times)
+    end
+    chain :at_most do|times|
+      @occurence_spec =  Fakes::RSpec::Occurances.at_most(times)
+    end
+    chain :exactly do|times|
+      @occurence_spec = Fakes::RSpec::Occurances.exact(times)
+    end
+    chain :occurs do|the_proc|
+      @occurence_spec = Fakes::RSpec::Occurances.from_block(the_proc)
+    end
+    match do|the_fake|
+      RSpec.create_received_occurences_criteria_from(the_fake.received(symbol),@occurence_spec).is_satisfied_by(*args)
+    end
+  end
+end

data/lib/fakes_rspec/nullo_specification.rb

@@ -0,0 +1,10 @@
+module Fakes
+  module RSpec
+    class NulloSpecification
+      include Singleton
+      def is_satisfied_by(item)
+        return true
+      end
+    end
+  end
+end

data/lib/fakes_rspec/occurances.rb

@@ -0,0 +1,20 @@
+module Fakes
+  module RSpec
+    class Occurances
+      class << self
+        def from_block(the_block)
+          return BlockCriteria.new(the_block)
+        end
+        def exact(times)
+          return from_block(lambda{|occurances| return occurances == times})
+        end
+        def at_least(times)
+          return from_block(lambda { |occurences| return occurences >= times})
+        end
+        def at_most(times)
+          return from_block(lambda { |occurences| return occurences <= times})
+        end
+      end
+    end
+  end
+end

data/lib/fakes_rspec/received_criteria.rb

@@ -0,0 +1,14 @@
+module Fakes
+  module RSpec
+    class ReceivedCriteria
+      def initialize(the_call)
+        @the_call = the_call
+      end
+
+      def is_satisfied_by(*args)
+        return false if @the_call == nil
+        return args.count == 0 ? true : @the_call.called_with(*args) != nil
+      end
+    end
+  end
+end

data/lib/fakes_rspec/received_occurances_criteria.rb

@@ -0,0 +1,16 @@
+module Fakes
+  module RSpec
+    class ReceivedOccurencesCriteria
+      def initialize(received_criteria,the_call,occurence)
+        @received_criteria = received_criteria
+        @the_call = the_call
+        @occurence = occurence
+      end
+
+      def is_satisfied_by(*args)
+        return @received_criteria.is_satisfied_by(*args) &&
+          @occurence.is_satisfied_by((args.count == 0 ? @the_call.total_times_called : @the_call.called_with(*args).times_called))
+      end
+    end
+  end
+end

data/lib/fakes_rspec/version.rb

@@ -0,0 +1,5 @@
+module Fakes
+  module RSpec
+    VERSION = "1.0.4"
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: fakes-rspec
 version: !ruby/object:Gem::Version
-  version: 1.0.3
+  version: 1.0.4
   prerelease: 
 platform: ruby
 authors:
@@ -115,6 +115,21 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- .gitignore
+- Gemfile
+- Guardfile
+- LICENSE
+- README.md
+- Rakefile
+- fakes-rspec.gemspec
+- lib/fakes-rspec.rb
+- lib/fakes_rspec/block_criteria.rb
+- lib/fakes_rspec/matcher.rb
+- lib/fakes_rspec/nullo_specification.rb
+- lib/fakes_rspec/occurances.rb
+- lib/fakes_rspec/received_criteria.rb
+- lib/fakes_rspec/received_occurances_criteria.rb
+- lib/fakes_rspec/version.rb
 - spec/spec_helper.rb
 - spec/specs/block_criteria_spec.rb
 - spec/specs/nullo_specification_spec.rb
@@ -136,7 +151,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -2011778260648523438
+      hash: -3560833146225028214
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -145,7 +160,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -2011778260648523438
+      hash: -3560833146225028214
 requirements: []
 rubyforge_project: fakes-rspec
 rubygems_version: 1.8.25