rr 0.7.1 → 0.8.0

data/CHANGES

@@ -1,3 +1,9 @@
+- Fixed compatability issues with Ruby 1.9
+- Aliased any_number_of_times with any_times
+- Better error messages for have_received and assert_received matchers (Patch by Joe Ferris)
+- Better documentation on RR wilcard matchers (Patch by Phil Arnowsky)
+
+* 0.7.1
 - Performance improvements
 
 * 0.7.0

data/README.rdoc

@@ -301,6 +301,10 @@ In RR, you would do:
   mock(object).foobar(satisfy {|arg| arg.length == 2})
   object.foobar("xy")
 
+==== Writing your own Argument Matchers
+Writing a custom argument wildcard matcher is not difficult.  See
+RR::WildcardMatchers for details.
+
 === Invocation Amount Wildcard Matchers
 ==== any_times
   mock(object).method_name(anything).times(any_times) {return_value}
@@ -308,6 +312,7 @@ In RR, you would do:
 == Special Thanks To
 With any development effort, there are countless people who have contributed
 to making it possible. We all are standing on the shoulders of giants.
+* Andreas Haller for patches
 * Aslak Hellesoy for Developing Rspec
 * Dan North for syntax ideas
 * Dave Astels for some BDD inspiration
@@ -325,5 +330,6 @@ to making it possible. We all are standing on the shoulders of giants.
 * Nick Kallen for documentation suggestions, bug reports, and patches
 * Nathan Sobo for various ideas and inspiration for cleaner and more expressive code
 * Parker Thompson for pairing with me
+* Phil Arnowsky for patches
 * Pivotal Labs for sponsoring RR development
 * Stephen Baker for Developing Rspec

data/Rakefile

@@ -1,5 +1,4 @@
 require "rake"
-require 'rake/gempackagetask'
 require 'rake/contrib/rubyforgepublisher'
 require 'rake/clean'
 require 'rake/testtask'
@@ -15,56 +14,36 @@ task(:spec) do
   run_suite
 end
 
-desc "Copies the trunk to a tag with the name of the current release"
-task(:tag_release) do
-  tag_release
-end
-
 def run_suite
   dir = File.dirname(__FILE__)
   system("ruby #{dir}/spec/spec_suite.rb") || raise("Spec Suite failed")
 end
 
-PKG_NAME = "rr"
-PKG_VERSION = "0.7.1"
-PKG_FILES = FileList[
-  '[A-Z]*',
-  '*.rb',
-  'lib/**/*.rb',
-  'spec/**/*.rb'
-]
-
-spec = Gem::Specification.new do |s|
-  s.name = PKG_NAME
-  s.version = PKG_VERSION
-  s.summary = "RR (Double Ruby) is a double framework that features a rich " <<
-              "selection of double techniques and a terse syntax. " <<
-              "http://xunitpatterns.com/Test%20Double.html"
-  s.test_files = "spec/spec_suite.rb"
-  s.description = s.summary
-
-  s.files = PKG_FILES.to_a
-  s.require_path = 'lib'
-
-  s.has_rdoc = true
-  s.extra_rdoc_files = [ "README.rdoc", "CHANGES" ]
-  s.rdoc_options = ["--main", "README.rdoc", "--inline-source", "--line-numbers"]
-
-  s.test_files = Dir.glob('spec/*_spec.rb')
-  s.require_path = 'lib'
-  s.author = "Brian Takita"
-  s.email = "brian@pivotallabs.com"
-  s.homepage = "http://pivotallabs.com"
-  s.rubyforge_project = "pivotalrb"
-end
-
-Rake::GemPackageTask.new(spec) do |pkg|
-  pkg.need_zip = true
-  pkg.need_tar = true
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |s|
+    s.name = "rr"
+    s.summary = "RR (Double Ruby) is a double framework that features a rich " <<
+                "selection of double techniques and a terse syntax. " <<
+                "http://xunitpatterns.com/Test%20Double.html"
+    s.email = "brian@pivotallabs.com"
+    s.homepage = "http://pivotallabs.com"
+    s.description = "RR (Double Ruby) is a double framework that features a rich " <<
+                    "selection of double techniques and a terse syntax. " <<
+                    "http://xunitpatterns.com/Test%20Double.html"
+    s.authors = ["Brian Takita"]
+    s.files = FileList[
+      '[A-Z]*',
+      '*.rb',
+      'lib/**/*.rb',
+      'spec/**/*.rb'
+    ].to_a
+    s.test_files = Dir.glob('spec/*_spec.rb')
+    s.has_rdoc = true
+    s.extra_rdoc_files = [ "README.rdoc", "CHANGES" ]
+    s.rdoc_options = ["--main", "README.rdoc", "--inline-source", "--line-numbers"]
+    s.rubyforge_project = "pivotalrb"
+  end
+rescue LoadError
+  puts "Jeweler not available. Install it with: sudo gem install technicalpickles-jeweler -s http://gems.github.com"
 end
-
-def tag_release
-  dashed_version = PKG_VERSION.gsub('.', '-')
-  svn_user = "#{ENV["SVN_USER"]}@" || ""
-  `svn cp svn+ssh://#{svn_user}rubyforge.org/var/svn/pivotalrb/rr/trunk svn+ssh://#{svn_user}rubyforge.org/var/svn/pivotalrb/rr/tags/REL-#{dashed_version} -m 'Version #{PKG_VERSION}'`
-end

data/VERSION.yml

@@ -0,0 +1,4 @@
+--- 
+:major: 0
+:minor: 8
+:patch: 0

data/lib/rr/adapters/rspec.rb

@@ -32,7 +32,12 @@ module RR
 
         def matches?(subject)
           @verification.subject = subject
-          RR::Space.instance.recorded_calls.match_error(@verification) ? false : true
+          if error = RR::Space.instance.recorded_calls.match_error(@verification)
+            @failure_message = error.message
+            false
+          else
+            true
+          end
         end
 
         def nil?

data/lib/rr/double_definitions/double_definition.rb

@@ -160,6 +160,7 @@ module RR
           install_method_callback return_value_block
           self
         end
+        alias_method :any_times, :any_number_of_times
 
         # Double#times creates an TimesCalledExpectation of the passed
         # in number.
@@ -251,7 +252,7 @@ module RR
           if implementation
             implemented_by implementation
           else
-            implemented_by lambda {value}
+            implemented_by proc {value}
           end
           self
         end

data/lib/rr/wildcard_matchers.rb

@@ -0,0 +1,158 @@
+=begin rdoc
+
+= Writing your own custom wildcard matchers.
+Writing new wildcard matchers is not too difficult.  If you've ever written
+a custom expectation in RSpec, the implementation is very similar.
+
+As an example, let's say that you want a matcher that will match any number
+divisible by a certain integer.  In use, it might look like this:
+
+  # Will pass if BananaGrabber#bunch_bananas is called with an integer
+  # divisible by 5.
+
+  mock(BananaGrabber).bunch_bananas(divisible_by(5))
+
+To implement this, we need a class RR::WildcardMatchers::DivisibleBy with 
+these instance methods:
+
+* ==(other)
+* eql?(other) (usually aliased to #==)
+* inspect
+* wildcard_match?(other)
+
+and optionally, a sensible initialize method.  Let's look at each of these.
+
+=== .initialize
+
+Most custom wildcard matchers will want to define initialize to store
+some information about just what should be matched.  DivisibleBy#initialize
+might look like this:
+
+  class RR::WildcardMatchers::DivisibleBy
+    def initialize(divisor)
+      @expected_divisor = divisor
+    end
+  end
+
+=== #==(other)
+DivisibleBy#==(other) should return true if other is a wildcard matcher that
+matches the same things as self, so a natural way to write DivisibleBy#== is:
+
+  
+  class RR::WildcardMatchers::DivisibleBy
+    def ==(other)
+      # Ensure that other is actually a DivisibleBy
+      return false unless other.is_a?(self.class)
+
+      # Does other expect to match the same divisor we do?
+      self.expected_divisor = other.expected_divisor
+    end
+  end
+
+Note that this implementation of #== assumes that we've also declared
+  attr_reader :expected_divisor
+
+=== #inspect
+
+Technically we don't have to declare DivisibleBy#inspect, since inspect is
+defined for every object already.  But putting a helpful message in inspect
+will make test failures much clearer, and it only takes about two seconds to
+write it, so let's be nice and do so:
+
+  class RR::WildcardMatchers::DivisibleBy
+    def inspect
+      "integer divisible by #{expected.divisor}"
+    end
+  end
+
+Now if we run the example from above:
+
+  mock(BananaGrabber).bunch_bananas(divisible_by(5))
+
+and it fails, we get a helpful message saying
+
+  bunch_bananas(integer divisible by 5)
+  Called 0 times.
+  Expected 1 times.
+
+=== #wildcard_matches?(other)
+
+wildcard_matches? is the method that actually checks the argument against the
+expectation.  It should return true if other is considered to match,
+false otherwise.  In the case of DivisibleBy, wildcard_matches? reads:
+
+  class RR::WildcardMatchers::DivisibleBy
+    def wildcard_matches?(other)
+      # If other isn't a number, how can it be divisible by anything?
+      return false unless other.is_a?(Numeric)
+
+      # If other is in fact divisible by expected_divisor, then 
+      # other modulo expected_divisor should be 0.
+
+      other % expected_divisor == 0
+    end
+  end
+
+=== A finishing touch: wrapping it neatly
+
+We could stop here if we were willing to resign ourselves to using
+DivisibleBy this way:
+
+  mock(BananaGrabber).bunch_bananas(DivisibleBy.new(5))
+
+But that's less expressive than the original:
+
+  mock(BananaGrabber).bunch_bananas(divisible_by(5))
+
+To be able to use the convenient divisible_by matcher rather than the uglier
+DivisibleBy.new version, re-open the module RR::Adapters::RRMethods and
+define divisible_by there as a simple wrapper around DivisibleBy.new:
+
+  module RR::Adapters::RRMethods
+    def divisible_by(expected_divisor)
+      RR::WildcardMatchers::DivisibleBy.new(expected_divisor)
+    end
+  end
+
+== Recap
+
+Here's all the code for DivisibleBy in one place for easy reference:
+
+  class RR::WildcardMatchers::DivisibleBy
+    def initialize(divisor)
+      @expected_divisor = divisor
+    end
+
+    def ==(other)
+      # Ensure that other is actually a DivisibleBy
+      return false unless other.is_a?(self.class)
+
+      # Does other expect to match the same divisor we do?
+      self.expected_divisor = other.expected_divisor
+    end
+
+    def inspect
+      "integer divisible by #{expected.divisor}"
+    end
+  
+    def wildcard_matches?(other)
+      # If other isn't a number, how can it be divisible by anything?
+      return false unless other.is_a?(Numeric)
+
+      # If other is in fact divisible by expected_divisor, then 
+      # other modulo expected_divisor should be 0.
+
+      other % expected_divisor == 0
+    end
+  end
+  
+  module RR::Adapters::RRMethods
+    def divisible_by(expected_divisor)
+      RR::WildcardMatchers::DivisibleBy.new(expected_divisor)
+    end
+  end
+
+=end
+
+module RR::WildcardMatchers
+end

data/spec/rr/rspec/invocation_matcher_spec.rb

@@ -253,6 +253,26 @@ module RR
             @result.should be
           end
         end
+
+        describe "that does not match" do
+          before do
+            @error = Object.new
+            @message = 'Verification error message'
+            stub(RR::Space.instance.recorded_calls).match_error { @error }
+            stub(@error).message { @message }
+
+            @matcher = InvocationMatcher.new(:foobar)
+            @result = @matcher.matches?(Object.new)
+          end
+
+          it "returns false when matching" do
+            @result.should_not be
+          end
+
+          it "returns a failure messsage" do
+            @matcher.failure_message.should == @message
+          end
+        end
       end
     end
   end

data/spec/rr/test_unit/test_unit_backtrace_test.rb

@@ -15,6 +15,7 @@ class TestUnitBacktraceTest < Test::Unit::TestCase
   end
 
   def test_backtrace_tweaking
+    skip "Skipped, because there is no Test::Unit::TestResult in this Test::Unit. Don't worry, this is totally fine." unless defined?(Test::Unit::TestResult)
     old_result = @_result
     result = Test::Unit::TestResult.new
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: rr
 version: !ruby/object:Gem::Version 
-  version: 0.7.1
+  version: 0.8.0
 platform: ruby
 authors: 
 - Brian Takita
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-01-16 00:00:00 -05:00
+date: 2009-03-29 00:00:00 -07:00
 default_executable: 
 dependencies: []
 
@@ -23,6 +23,7 @@ extra_rdoc_files:
 - README.rdoc
 - CHANGES
 files: 
+- VERSION.yml
 - README.rdoc
 - Rakefile
 - CHANGES
@@ -68,6 +69,7 @@ files:
 - lib/rr/expectations/argument_equality_expectation.rb
 - lib/rr/expectations/any_argument_expectation.rb
 - lib/rr/expectations/times_called_expectation.rb
+- lib/rr/wildcard_matchers.rb
 - lib/rr/double_definitions/strategies/implementation/strongly_typed_reimplementation.rb
 - lib/rr/double_definitions/strategies/implementation/reimplementation.rb
 - lib/rr/double_definitions/strategies/implementation/proxy.rb
@@ -160,6 +162,8 @@ rdoc_options:
 - README.rdoc
 - --inline-source
 - --line-numbers
+- --inline-source
+- --charset=UTF-8
 require_paths: 
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement