mocha 0.9.8 → 0.9.9

data/COPYING.rdoc

@@ -0,0 +1,3 @@
+Copyright Revieworld Ltd. 2006
+
+You may use, copy and redistribute this library under the same terms as {Ruby itself}[http://www.ruby-lang.org/en/LICENSE.txt] or under the {MIT license}[http://mocha.rubyforge.org/files/MIT-LICENSE.html].

data/{README → README.rdoc}

@@ -1,12 +1,12 @@
 = Mocha
 
-Mocha is a library for mocking and stubbing using a syntax like that of JMock[http://www.jmock.org].
+Mocha is a library for mocking and stubbing using a syntax like that of {JMock}[http://www.jmock.org].
 
-It can be used with many testing frameworks e.g. Test::Unit[http://www.ruby-doc.org/core/classes/Test/Unit.html], RSpec[http://rspec.info/], test/spec[http://chneukirchen.org/repos/testspec/README], expectations[http://expectations.rubyforge.org/], Dust[http://dust.rubyforge.org/], MiniTest[http://rubyforge.org/projects/bfts] and even JtestR[http://jtestr.codehaus.org/].
+It can be used with many testing frameworks e.g. {Test::Unit}[http://www.ruby-doc.org/core/classes/Test/Unit.html], {RSpec}[http://rspec.info/], {test/spec}[http://chneukirchen.org/repos/testspec/README], {expectations}[http://expectations.rubyforge.org/], {Dust}[http://dust.rubyforge.org/], {MiniTest}[http://rubyforge.org/projects/bfts] and even {JtestR}[http://jtestr.codehaus.org/].
 
 Mocha provides a unified, simple and readable syntax for both traditional mocking and partial mocking.
 
-Mocha was harvested from projects at Reevoo[http://www.reevoo.com] by me (James[http://blog.floehopper.org]) and my (then) colleagues Ben[http://www.techbelly.com/], Chris[http://chrisroos.co.uk] and Paul[http://po-ru.com].
+Mocha was harvested from projects at {Reevoo}[http://www.reevoo.com] by me ({James}[http://blog.floehopper.org]) and my (then) colleagues {Ben}[http://www.techbelly.com/], {Chris}[http://chrisroos.co.uk] and {Paul}[http://po-ru.com].
 
 == Download and Installation
 
@@ -14,7 +14,7 @@ Install the gem with the following command...
 
   $ gem install mocha
 
-Or install the Rails[http://www.rubyonrails.org] plugin...
+Or install the {Rails}[http://www.rubyonrails.org] plugin...
 
   $ script/plugin install git://github.com/floehopper/mocha.git
 

data/{RELEASE → RELEASE.rdoc}

@@ -1,3 +1,21 @@
+= 0.9.9 (ee3a79db4d52c3339e8acf07505e01236a2b4810)
+* Avoid loading bits of the test-unit gem by accident. This is an attempt at a fix for the problem that James Adam reported [1]. By using 'load' instead of 'require' to detect the version of Test::Unit, we can avoid rubygems trying to load bits of the test-unit gem when it's not wanted. [1] http://floehopper.lighthouseapp.com/projects/22289-mocha/tickets/50#ticket-50-13
+* Fix exception when running rake without test-unit gem. When test-unit gem >=v2.0.0 was installed but the "use_test_unit_gem" MOCHA_OPTIONS was not specified, a "comparison of Fixnum with Hash failed" exception was being raised when running the performance tests. This was because bits of the test-unit gem were being loaded accidentally and a Hash was being incorrectly supplied to the TestRunner.run method.
+* Explicitly require rubygems for running tests via rake using test-unit gem.
+* Handle newer versions of test-unit gem (v2.0.2 to v2.0.9)
+* Handle newer versions of minitest gem (v1.4.0 to v1.6.0)
+* Added warnings about monkey-patching test-unit and minitest to aid debugging. These are enabled by including "debug" in the MOCHA_OPTIONS environment variable. This is now a comma-separated list, so that we can specify multiple options e.g. MOCHA_OPTIONS=debug,use_test_unit_gem
+* Eloy Duran (alloy) made the unit tests run on 1.9.2dev r25249.
+* Eloy Duran (alloy) also improved some MiniTest TestResult code I'd written and got the acceptance tests running on Ruby 1.9 HEAD. There are still 4 failures because for some reason the backtrace line numbers are off by one. And the minitest_test test case does not run when the whole suite is run with MiniTest. These issues still need investigation.
+* Fixed some acceptance tests to run in Ruby 1.9.2 - it's no longer possible to subvert the protection of a method by calling it via Object#send.
+* Fixed "test:performance" rake task so it runs in Ruby 1.9.2.
+* Fix test incorrectly failing under Rubinius 1.0. This test imposed too many constraints. It appears that Object#inspect legitimately calls Object#object_id in Rubinius. But we're only interested in what 'id' methods Mocha::ObjectMethods#mocha_inspect calls. By stubbing Object#inspect we can relax the constraints imposed by the test.
+* Luke Redpath (lukeredpath) added new shorthand "any" and "all" composite parameter matchers using "&" and "|". This provides an alternative syntax for expecting any or all matchers to pass, e.g. foo.expects(:bar).with(equals(1) | equals(2)).
+* Improved documentation for Expectation#raises. A number of people have suggested an extension to the API to cope with custom exceptions that have extra constructor parameters. However, since the arguments supplied to Expectation#raises are just passed on to Kernel#raise, it's possible to pass in an instance of an exception. Thus no change to the API is required, but it does seem worthwhile pointing this out in the docs.
+* Corrected RDoc example for Expectation#never thanks to Red David (reddavis).
+* Improved RDoc including a change suggested by Rohit Arondekar (rohit).
+* Updated gemspec as requested by Sam Woodard (shwoodard).
+
 = 0.9.8 (645024765b2d92018efc511652e1174163844e39)
 * Fixed bug "NameError raised when using Mocha as a Rails plug-in" - http://floehopper.lighthouseapp.com/projects/22289/tickets/53. Since 0.9.6 the Rails plugin has been broken. See bug report for details. You will need to explicitly load Mocha *after* the test framework has been loaded, e.g. by adding "require 'mocha'" at the bottom of test/test_helper.rb.
 * Make Mocha::ParameterMatchers#regexp_matches, #includes, #has_value, #has_key more robust. Thanks to Sander Hartlage.

data/Rakefile

@@ -3,7 +3,7 @@ require 'rake/gempackagetask'
 require 'rake/testtask'
 
 module Mocha
-  VERSION = "0.9.8"
+  VERSION = "0.9.9"
 end
 
 desc "Run all tests"
@@ -42,8 +42,8 @@ namespace 'test' do
 
   desc "Run performance tests"
   task 'performance' do
-    require 'test/acceptance/stubba_example_test'
-    require 'test/acceptance/mocha_example_test'
+    require File.join(File.dirname(__FILE__), 'test', 'acceptance', 'stubba_example_test')
+    require File.join(File.dirname(__FILE__), 'test', 'acceptance', 'mocha_example_test')
     iterations = 1000
     puts "\nBenchmarking with #{iterations} iterations..."
     [MochaExampleTest, StubbaExampleTest].each do |test_case|
@@ -55,19 +55,21 @@ end
 
 def benchmark_test_case(klass, iterations)
   require 'benchmark'
-  require 'test/unit/ui/console/testrunner'
-  begin
-    require 'test/unit/ui/console/outputlevel'
-    silent_option = { :output_level => Test::Unit::UI::Console::OutputLevel::SILENT }
-  rescue LoadError
-    silent_option = Test::Unit::UI::SILENT
+  load 'test/unit/ui/console/testrunner.rb' unless defined?(Test::Unit::UI::Console::TestRunner)
+  unless $silent_option
+    begin
+      load 'test/unit/ui/console/outputlevel.rb' unless defined?(Test::Unit::UI::Console::OutputLevel::SILENT)
+      $silent_option = { :output_level => Test::Unit::UI::Console::OutputLevel::SILENT }
+    rescue LoadError
+      $silent_option = Test::Unit::UI::SILENT
+    end
   end
-  time = Benchmark.realtime { iterations.times { Test::Unit::UI::Console::TestRunner.run(klass, silent_option) } }
+  time = Benchmark.realtime { iterations.times { Test::Unit::UI::Console::TestRunner.run(klass, $silent_option) } }
 end
 
 desc 'Generate RDoc'
 Rake::RDocTask.new('rdoc') do |task|
-  task.main = 'README'
+  task.main = 'README.rdoc'
   task.title = "Mocha #{Mocha::VERSION}"
   task.rdoc_dir = 'doc'
   template = File.expand_path(File.join(File.dirname(__FILE__), "templates", "html_with_google_analytics.rb"))
@@ -76,10 +78,10 @@ Rake::RDocTask.new('rdoc') do |task|
     task.template = template
   end
   task.rdoc_files.include(
-    'README',
-    'RELEASE',
-    'COPYING',
-    'MIT-LICENSE',
+    'README.rdoc',
+    'RELEASE.rdoc',
+    'COPYING.rdoc',
+    'MIT-LICENSE.rdoc',
     'agiledox.txt',
     'lib/mocha/api.rb',
     'lib/mocha/mock.rb',
@@ -156,8 +158,8 @@ def build_specification(version = Mocha::VERSION)
     s.rubyforge_project = 'mocha'
 
     s.has_rdoc = true
-    s.extra_rdoc_files = ['README', 'COPYING']
-    s.rdoc_options << '--title' << 'Mocha' << '--main' << 'README' << '--line-numbers'
+    s.extra_rdoc_files = ['README.rdoc', 'COPYING.rdoc']
+    s.rdoc_options << '--title' << 'Mocha' << '--main' << 'README.rdoc' << '--line-numbers'
 
     s.add_dependency('rake')
     s.files = FileList['{lib,test,examples}/**/*.rb', '[A-Z]*'].exclude('TODO').to_a

data/lib/mocha.rb

@@ -1,3 +1,4 @@
+require 'mocha/options'
 require 'mocha_standalone'
 require 'mocha/configuration'
 require 'mocha/integration'

data/lib/mocha/expectation.rb

@@ -10,10 +10,10 @@ require 'mocha/change_state_side_effect'
 require 'mocha/cardinality'
 
 module Mocha # :nodoc:
-  
+
   # Methods on expectations returned from Mock#expects, Mock#stubs, Object#expects and Object#stubs.
   class Expectation
-  
+
     # :call-seq: times(range) -> expectation
     #
     # Modifies expectation so that the number of calls to the expected method must be within a specific +range+.
@@ -42,7 +42,7 @@ module Mocha # :nodoc:
       @cardinality = Cardinality.times(range)
       self
     end
-  
+
     # :call-seq: twice() -> expectation
     #
     # Modifies expectation so that the expected method must be called exactly twice.
@@ -67,7 +67,7 @@ module Mocha # :nodoc:
       @cardinality = Cardinality.exactly(2)
       self
     end
-  
+
     # :call-seq: once() -> expectation
     #
     # Modifies expectation so that the expected method must be called exactly once.
@@ -90,7 +90,7 @@ module Mocha # :nodoc:
       @cardinality = Cardinality.exactly(1)
       self
     end
-  
+
     # :call-seq: never() -> expectation
     #
     # Modifies expectation so that the expected method must never be called.
@@ -101,13 +101,12 @@ module Mocha # :nodoc:
     #
     #   object = mock()
     #   object.expects(:expected_method).never
-    #   object.expected_method
     #   # => verify succeeds
     def never
       @cardinality = Cardinality.exactly(0)
       self
     end
-  
+
     # :call-seq: at_least(minimum_number_of_times) -> expectation
     #
     # Modifies expectation so that the expected method must be called at least a +minimum_number_of_times+.
@@ -124,7 +123,7 @@ module Mocha # :nodoc:
       @cardinality = Cardinality.at_least(minimum_number_of_times)
       self
     end
-  
+
     # :call-seq: at_least_once() -> expectation
     #
     # Modifies expectation so that the expected method must be called at least once.
@@ -140,7 +139,7 @@ module Mocha # :nodoc:
       at_least(1)
       self
     end
-  
+
     # :call-seq: at_most(maximum_number_of_times) -> expectation
     #
     # Modifies expectation so that the expected method must be called at most a +maximum_number_of_times+.
@@ -157,7 +156,7 @@ module Mocha # :nodoc:
       @cardinality = Cardinality.at_most(maximum_number_of_times)
       self
     end
-  
+
     # :call-seq: at_most_once() -> expectation
     #
     # Modifies expectation so that the expected method must be called at most once.
@@ -174,7 +173,7 @@ module Mocha # :nodoc:
       at_most(1)
       self
     end
-  
+
     # :call-seq: with(*expected_parameters, &matching_block) -> expectation
     #
     # Modifies expectation so that the expected method must be called with +expected_parameters+.
@@ -204,7 +203,7 @@ module Mocha # :nodoc:
       @parameters_matcher = ParametersMatcher.new(expected_parameters, &matching_block)
       self
     end
-  
+
     # :call-seq: yields(*parameters) -> expectation
     #
     # Modifies expectation so that when the expected method is called, it yields with the specified +parameters+.
@@ -226,7 +225,7 @@ module Mocha # :nodoc:
       @yield_parameters.add(*parameters)
       self
     end
-    
+
     # :call-seq: multiple_yields(*parameter_groups) -> expectation
     #
     # Modifies expectation so that when the expected method is called, it yields multiple times per invocation with the specified +parameter_groups+.
@@ -248,7 +247,7 @@ module Mocha # :nodoc:
       @yield_parameters.multiple_add(*parameter_groups)
       self
     end
-    
+
     # :call-seq: returns(value) -> expectation
     #            returns(*values) -> expectation
     #
@@ -284,13 +283,17 @@ module Mocha # :nodoc:
       @return_values += ReturnValues.build(*values)
       self
     end
-  
+
     # :call-seq: raises(exception = RuntimeError, message = nil) -> expectation
     #
-    # Modifies expectation so that when the expected method is called, it raises the specified +exception+ with the specified +message+.
+    # Modifies expectation so that when the expected method is called, it raises the specified +exception+ with the specified +message+ i.e. calls Kernel#raise(exception, message).
     #   object = mock()
     #   object.expects(:expected_method).raises(Exception, 'message')
     #   object.expected_method # => raises exception of class Exception and with message 'message'
+    # Note that if you have a custom exception class with extra constructor parameters, you can pass in an instance of the exception (just as you can for Kernel#raise).
+    #   object = mock()
+    #   object.expects(:expected_method).raises(MyException.new('message', 1, 2, 3))
+    #   object.expected_method # => raises the specified instance of MyException
     # May be called multiple times on the same expectation. Also see Expectation#then.
     #   object = mock()
     #   object.stubs(:expected_method).raises(Exception1).then.raises(Exception2)
@@ -337,7 +340,7 @@ module Mocha # :nodoc:
       end
       self
     end
-    
+
     # :call-seq: when(state_machine.is(state)) -> exception
     #
     # Constrains the expectation to occur only when the +state_machine+ is in the named +state+.
@@ -356,7 +359,7 @@ module Mocha # :nodoc:
       add_ordering_constraint(InStateOrderingConstraint.new(state_predicate))
       self
     end
-    
+
     # :call-seq: in_sequence(*sequences) -> expectation
     #
     # Constrains this expectation so that it must be invoked at the current point in the sequence.
@@ -378,9 +381,9 @@ module Mocha # :nodoc:
       sequences.each { |sequence| add_in_sequence_ordering_constraint(sequence) }
       self
     end
-    
+
     # :stopdoc:
-    
+
     attr_reader :backtrace
 
     def initialize(mock, expected_method_name, backtrace = nil)
@@ -394,35 +397,35 @@ module Mocha # :nodoc:
       @yield_parameters = YieldParameters.new
       @backtrace = backtrace || caller
     end
-    
+
     def add_ordering_constraint(ordering_constraint)
       @ordering_constraints << ordering_constraint
     end
-    
+
     def add_in_sequence_ordering_constraint(sequence)
       sequence.constrain_as_next_in_sequence(self)
     end
-    
+
     def add_side_effect(side_effect)
       @side_effects << side_effect
     end
-    
+
     def perform_side_effects
       @side_effects.each { |side_effect| side_effect.perform }
     end
-    
+
     def in_correct_order?
       @ordering_constraints.all? { |ordering_constraint| ordering_constraint.allows_invocation_now? }
     end
-    
+
     def matches_method?(method_name)
       @method_matcher.match?(method_name)
     end
-    
+
     def match?(actual_method_name, *actual_parameters)
       @method_matcher.match?(actual_method_name) && @parameters_matcher.match?(actual_parameters) && in_correct_order?
     end
-    
+
     def invocations_allowed?
       @cardinality.invocations_allowed?(@invocation_count)
     end
@@ -430,7 +433,7 @@ module Mocha # :nodoc:
     def satisfied?
       @cardinality.satisfied?(@invocation_count)
     end
-  
+
     def invoke
       @invocation_count += 1
       perform_side_effects()
@@ -446,11 +449,11 @@ module Mocha # :nodoc:
       assertion_counter.increment if assertion_counter && @cardinality.needs_verifying?
       @cardinality.verified?(@invocation_count)
     end
-    
+
     def used?
       @cardinality.used?(@invocation_count)
     end
-    
+
     def mocha_inspect
       message = "#{@cardinality.mocha_inspect}, "
       message << case @invocation_count
@@ -464,13 +467,13 @@ module Mocha # :nodoc:
       message << "; #{@ordering_constraints.map { |oc| oc.mocha_inspect }.join("; ")}" unless @ordering_constraints.empty?
       message
     end
-    
+
     def method_signature
       "#{@mock.mocha_inspect}.#{@method_matcher.mocha_inspect}#{@parameters_matcher.mocha_inspect}"
     end
-      
+
     # :startdoc:
-    
+
   end
 
 end

data/lib/mocha/integration/mini_test.rb

@@ -2,7 +2,11 @@ require 'mocha/api'
 
 if !MiniTest::Unit::TestCase.ancestors.include?(Mocha::API)
   
-  require 'mocha/integration/mini_test/version_131_and_above'
+  require 'mocha/integration/mini_test/exception_translation'
+  require 'mocha/integration/mini_test/version_13'
+  require 'mocha/integration/mini_test/version_140'
+  require 'mocha/integration/mini_test/version_141'
+  require 'mocha/integration/mini_test/version_142_and_above'
   
   module MiniTest
     class Unit
@@ -13,7 +17,28 @@ if !MiniTest::Unit::TestCase.ancestors.include?(Mocha::API)
         alias_method :run_before_mocha, :run
         remove_method :run
         
-        include Mocha::Integration::MiniTest::Version131AndAbove
+        mini_test_version = begin
+          MiniTest::Unit::VERSION
+        rescue LoadError
+          'unknown'
+        end
+        
+        $stderr.puts "Detected MiniTest version: #{mini_test_version}" if $options['debug']
+        
+        if (mini_test_version >= '1.3.0') && (mini_test_version <= '1.3.1')
+          include Mocha::Integration::MiniTest::Version13
+        elsif (mini_test_version == '1.4.0')
+          include Mocha::Integration::MiniTest::Version140
+        elsif (mini_test_version == '1.4.1')
+          include Mocha::Integration::MiniTest::Version141
+        elsif (mini_test_version >= '1.4.2') && (mini_test_version <= '1.6.0')
+          include Mocha::Integration::MiniTest::Version142AndAbove
+        elsif (mini_test_version > '1.6.0')
+          $stderr.puts "*** MiniTest integration has not been verified but patching anyway ***" if $options['debug']
+          include Mocha::Integration::MiniTest::Version142AndAbove
+        else
+          $stderr.puts "*** No Mocha integration for MiniTest version ***" if $options['debug']
+        end
         
       end
     end

data/lib/mocha/integration/mini_test/exception_translation.rb

@@ -0,0 +1,20 @@
+require 'mocha/expectation_error'
+
+module Mocha
+  
+  module Integration
+    
+    module MiniTest
+      
+      def self.translate(exception)
+        return exception unless exception.kind_of?(::Mocha::ExpectationError)
+        translated_exception = ::MiniTest::Assertion.new(exception.message)
+        translated_exception.set_backtrace(exception.backtrace)
+        translated_exception
+      end
+      
+    end
+    
+  end
+  
+end

data/lib/mocha/integration/mini_test/version_13.rb

@@ -0,0 +1,44 @@
+require 'mocha/integration/mini_test/assertion_counter'
+
+module Mocha
+  
+  module Integration
+    
+    module MiniTest
+      
+      module Version13
+        def self.included(mod)
+          $stderr.puts "Monkey patching MiniTest v1.3" if $options['debug']
+        end
+        def run runner
+          assertion_counter = AssertionCounter.new(self)
+          result = '.'
+          begin
+            begin
+              @passed = nil
+              self.setup
+              self.__send__ self.name
+              mocha_verify(assertion_counter)
+              @passed = true
+            rescue Exception => e
+              @passed = false
+              result = runner.puke(self.class, self.name, Mocha::Integration::MiniTest.translate(e))
+            ensure
+              begin
+                self.teardown
+              rescue Exception => e
+                result = runner.puke(self.class, self.name, Mocha::Integration::MiniTest.translate(e))
+              end
+            end
+          ensure
+            mocha_teardown
+          end
+          result
+        end
+      end
+      
+    end
+    
+  end
+  
+end