mocha 0.5.6 → 0.9.0

data/README

@@ -1,12 +1,12 @@
 = Mocha
 
-Mocha is a library for mocking and stubbing using a syntax like that of JMock[http://www.jmock.org], and SchMock[http://rubyforge.org/projects/schmock]. Most commonly Mocha is used in conjunction with Test::Unit[http://www.ruby-doc.org/core/classes/Test/Unit.html], but it can be used in other contexts.
+Mocha is a library for mocking and stubbing using a syntax like that of JMock[http://www.jmock.org].
 
-One of its main advantages is that it allows you to mock and stub methods on _real_ (non-mock) classes and instances. You can for example stub ActiveRecord[http://api.rubyonrails.com/classes/ActiveRecord/Base.html] instance methods like +create+, +save+, +destroy+ and even class methods like +find+ to avoid hitting the database in unit tests.
+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/] and even JtestR[http://jtestr.codehaus.org/].
 
-Mocha provides a unified, simple and readable syntax for both traditional mocking and for mocking with _real_ objects.
+Mocha provides a unified, simple and readable syntax for both traditional mocking and partial mocking.
 
-Mocha has been harvested from projects at Reevoo[http://www.reevoo.com] by me (James[http://blog.floehopper.org]) and my colleagues Ben[http://www.reevoo.com/blogs/bengriffiths], Chris[http://blog.seagul.co.uk] and Paul[http://po-ru.com]. Mocha is in use on real-world Rails[http://www.rubyonrails.org] projects.
+Mocha was harvested from projects at Reevoo[http://www.reevoo.com] by me (James[http://blog.floehopper.org]) and my colleagues Ben[http://www.techbelly.com/], Chris[http://blog.seagul.co.uk] and Paul[http://po-ru.com].
 
 == Download and Installation
 

data/RELEASE

@@ -1,3 +1,48 @@
+= 0.9.0
+
+* Configurable warnings or errors
+  * when a method on a non-public method is stubbed
+  * when a method on a non-existent method is stubbed
+  * when a method on a non-mock object is stubbed
+  * when a method is stubbed unnecessarily (i.e. the stubbed method is not called during the test)
+  
+* Improved error messages
+  * User-friendly list of unsatisfied expectations, satisfied expectations and state machines.
+  * Improved readability of cardinality description.
+  * Display sensible failure message for any_instance expectations e.g. "#<AnyInstance:Foo>.bar - expected calls: 1, actual calls: 0"
+
+* Parameter matchers
+  * New to this release
+    * optionally (allows matching of optional parameters if available)
+    * yaml_equivalent (allows matching of YAML that represents the specified object)
+    * responds_with (tests the quack not the duck)
+  * Nesting of parameter matchers is now supported.
+
+* Optional block passed into mock initializer is evaluated in the context of the new mock instance and can be used as a shortcut to set up expectations.
+
+* Added JMock-style sequences for constraining the order of expected invocations. See Standalone#sequence and Expectation#in_sequence.
+
+* Added JMock-style states for constraining the order of expected invocations. See Standalone#states, Expectation#then, Expectation#when and StateMachine.
+
+* Compatibility with versions of Ruby
+  * Compatibility with Ruby v1.9. All test errors and warnings fixed.
+  * Nasty fix so that TestCaseAdaptor works consistently with earlier versions of Test::Unit as well as more recent versions.
+  * Added platform to gem specification to avoid bug in rubygems 0.9.5 - see http://www.dcmanges.com/blog/rubygems-0-9-5-platform-bug and http://rubygems.org/read/chapter/20#platform.
+  * Make ExpectationRaiser deal with subclasses of Interrupt which seem to need a message supplied in the raise statement in Ruby 1.8.6 (but not 1.8.4 or 1.9). Not sure this is really Mocha's responsibility.
+
+* Added deprecation warning in stubba.rb which is no longer needed and will be removed.
+
+* Supply positioning information to evals to improve any error messages. See http://ola-bini.blogspot.com/2008/01/ruby-antipattern-using-eval-without.html
+
+* Bug fixes
+  * 18914 in revision 296 - http://rubyforge.org/tracker/index.php?func=detail&aid=18914&group_id=1917&atid=7477
+  * 18917 in revision 295 - http://rubyforge.org/tracker/index.php?func=detail&aid=18917&group_id=1917&atid=7477
+  * 18336 in revision 287 - http://rubyforge.org/tracker/index.php?func=detail&aid=18336&group_id=1917&atid=7477
+  * 17835 in revision 255 - http://rubyforge.org/tracker/index.php?func=detail&aid=17835&group_id=1917&atid=7477
+  * 17412 in revision 242 - http://rubyforge.org/tracker/index.php?func=detail&aid=17412&group_id=1917&atid=7477
+  * 15977 in revision 198 - http://rubyforge.org/tracker/index.php?func=detail&aid=15977&group_id=1917&atid=7477
+  * 11885 in revision 156 - http://rubyforge.org/tracker/index.php?func=detail&aid=11885&group_id=1917&atid=7477
+
 = 0.5.5 (r167)
 
 - Renamed Matches parameter matcher to RegexpMatches for clarity.

data/Rakefile

@@ -5,50 +5,72 @@ require 'rake/testtask'
 require 'rake/contrib/sshpublisher'
 
 module Mocha
-  VERSION = "0.5.6"
+  VERSION = "0.9.0"
 end
 
 desc "Run all tests"
-task :default => :test_all
-
-task :test_all => [:test_unit, :test_integration, :test_acceptance]
-
-desc "Run unit tests"
-Rake::TestTask.new(:test_unit) do |t|
-  t.libs << 'test'
-  t.test_files = FileList['test/unit/**/*_test.rb']
-  t.verbose = true
-  t.warning = true
-end
+task 'default' => ['test:units', 'test:acceptance']
+
+namespace 'test' do
+  
+  unit_tests = FileList['test/unit/**/*_test.rb']
+  acceptance_tests = FileList['test/acceptance/*_test.rb']
+
+  desc "Run unit tests"
+  Rake::TestTask.new('units') do |t|
+    t.libs << 'test'
+    t.test_files = unit_tests
+    t.verbose = true
+    t.warning = true
+  end
 
-desc "Run integration tests"
-Rake::TestTask.new(:test_integration) do |t|
-  t.libs << 'test'
-  t.test_files = FileList['test/integration/*_test.rb']
-  t.verbose = true
-  t.warning = true
-end
+  desc "Run acceptance tests"
+  Rake::TestTask.new('acceptance') do |t|
+    t.libs << 'test'
+    t.test_files = acceptance_tests
+    t.verbose = true
+    t.warning = true
+  end
+  
+  # require 'rcov/rcovtask'
+  # Rcov::RcovTask.new('coverage') do |t|
+  #   t.libs << 'test'
+  #   t.test_files = unit_tests + acceptance_tests
+  #   t.verbose = true
+  #   t.warning = true
+  #   t.rcov_opts << '--sort coverage'
+  #   t.rcov_opts << '--xref'
+  # end
 
-desc "Run acceptance tests"
-Rake::TestTask.new(:test_acceptance) do |t|
-  t.libs << 'test'
-  t.test_files = FileList['test/acceptance/*_test.rb']
-  t.verbose = true
-  t.warning = true
 end
 
 desc 'Generate RDoc'
-Rake::RDocTask.new do |task|
+Rake::RDocTask.new('rdoc') do |task|
   task.main = 'README'
   task.title = "Mocha #{Mocha::VERSION}"
   task.rdoc_dir = 'doc'
   task.template = File.expand_path(File.join(File.dirname(__FILE__), "templates", "html_with_google_analytics"))
-  task.rdoc_files.include('README', 'RELEASE', 'COPYING', 'MIT-LICENSE', 'agiledox.txt', 'lib/mocha/auto_verify.rb', 'lib/mocha/mock.rb', 'lib/mocha/expectation.rb', 'lib/mocha/object.rb', 'lib/mocha/parameter_matchers.rb', 'lib/mocha/parameter_matchers')
+  task.rdoc_files.include(
+    'README',
+    'RELEASE',
+    'COPYING',
+    'MIT-LICENSE',
+    'agiledox.txt',
+    'lib/mocha/standalone.rb',
+    'lib/mocha/mock.rb',
+    'lib/mocha/expectation.rb',
+    'lib/mocha/object.rb',
+    'lib/mocha/parameter_matchers.rb',
+    'lib/mocha/parameter_matchers',
+    'lib/mocha/state_machine.rb',
+    'lib/mocha/configuration.rb',
+    'lib/mocha/stubbing_error.rb'
+  )
 end
-task :rdoc => :examples
+task 'rdoc' => 'examples'
 
 desc "Upload RDoc to RubyForge"
-task :publish_rdoc => [:rdoc, :examples] do
+task 'publish_rdoc' => ['rdoc', 'examples'] do
   Rake::SshDirPublisher.new("jamesmead@rubyforge.org", "/var/www/gforge-projects/mocha", "doc").upload
 end
 
@@ -69,7 +91,7 @@ file 'agiledox.txt' do
 end
 
 desc "Convert example ruby files to syntax-highlighted html"
-task :examples do
+task 'examples' do
   $:.unshift File.expand_path(File.join(File.dirname(__FILE__), "vendor", "coderay-0.7.4.215", "lib"))
   require 'coderay'
   mkdir_p 'doc/examples'
@@ -119,16 +141,16 @@ Rake::GemPackageTask.new(specification) do |package|
    package.need_tar = true
 end
 
-task :verify_user do
+task 'verify_user' do
   raise "RUBYFORGE_USER environment variable not set!" unless ENV['RUBYFORGE_USER']
 end
 
-task :verify_password do
+task 'verify_password' do
   raise "RUBYFORGE_PASSWORD environment variable not set!" unless ENV['RUBYFORGE_PASSWORD']
 end
 
 desc "Publish package files on RubyForge."
-task :publish_packages => [:verify_user, :verify_password, :package] do
+task 'publish_packages' => ['verify_user', 'verify_password', 'package'] do
   $:.unshift File.expand_path(File.join(File.dirname(__FILE__), "vendor", "meta_project-0.4.15", "lib"))
   require 'meta_project'
   require 'rake/contrib/xforge'

data/lib/mocha.rb

@@ -1,5 +1,6 @@
 require 'mocha_standalone'
 require 'mocha/test_case_adapter'
+require 'mocha/configuration'
 
 require 'test/unit/testcase'
 

data/lib/mocha/any_instance_method.rb

@@ -15,21 +15,41 @@ module Mocha
     end
    
     def hide_original_method
-      stubbee.class_eval "alias_method :#{hidden_method}, :#{method}" if stubbee.method_defined?(method)
+      if method_exists?(method)
+        begin
+          stubbee.class_eval("alias_method :#{hidden_method}, :#{method}", __FILE__, __LINE__)
+        rescue NameError
+          # deal with nasties like ActiveRecord::Associations::AssociationProxy
+        end
+      end
     end
 
     def define_new_method
-      stubbee.class_eval "def #{method}(*args, &block); self.class.any_instance.mocha.method_missing(:#{method}, *args, &block); end"
+      stubbee.class_eval("def #{method}(*args, &block); self.class.any_instance.mocha.method_missing(:#{method}, *args, &block); end", __FILE__, __LINE__)
     end
 
     def remove_new_method
-      stubbee.class_eval "remove_method :#{method}"
+      stubbee.class_eval("remove_method :#{method}", __FILE__, __LINE__)
     end
 
     def restore_original_method
-      stubbee.class_eval "alias_method :#{method}, :#{hidden_method}; remove_method :#{hidden_method}" if stubbee.method_defined?(hidden_method)
+      if method_exists?(hidden_method)
+        begin
+          stubbee.class_eval("alias_method :#{method}, :#{hidden_method}; remove_method :#{hidden_method}", __FILE__, __LINE__)
+        rescue NameError
+          # deal with nasties like ActiveRecord::Associations::AssociationProxy
+        end
+      end
     end
 
+    def method_exists?(method)
+      existing_methods = []
+      existing_methods += stubbee.public_instance_methods(false)
+      existing_methods += stubbee.protected_instance_methods(false)
+      existing_methods += stubbee.private_instance_methods(false)
+      existing_methods.any? { |m| m.to_s == method.to_s }
+    end
+    
   end
   
 end

data/lib/mocha/backtrace_filter.rb

@@ -0,0 +1,17 @@
+module Mocha
+
+  class BacktraceFilter
+  
+    LIB_DIRECTORY = File.expand_path(File.join(File.dirname(__FILE__), "..")) + File::SEPARATOR
+
+    def initialize(lib_directory = LIB_DIRECTORY)
+      @lib_directory = lib_directory
+    end
+
+    def filtered(backtrace)
+      backtrace.reject { |location| Regexp.new(@lib_directory).match(File.expand_path(location)) }
+    end
+
+  end
+
+end

data/lib/mocha/cardinality.rb

@@ -0,0 +1,92 @@
+module Mocha
+
+  class Cardinality
+    
+    INFINITY = 1 / 0.0
+    
+    class << self
+      
+      def exactly(count)
+        new(count, count)
+      end
+      
+      def at_least(count)
+        new(count, INFINITY)
+      end
+      
+      def at_most(count)
+        new(0, count)
+      end
+      
+      def times(range_or_count)
+        case range_or_count
+        when Range
+          new(range_or_count.first, range_or_count.last)
+        else
+          new(range_or_count, range_or_count)
+        end
+      end
+      
+    end
+    
+    def initialize(required, maximum)
+      @required, @maximum = required, maximum
+    end
+    
+    def invocations_allowed?(invocation_count)
+      invocation_count < maximum
+    end
+    
+    def satisfied?(invocations_so_far)
+      invocations_so_far >= required
+    end
+    
+    def needs_verifying?
+      !allowed_any_number_of_times?
+    end
+    
+    def verified?(invocation_count)
+      (invocation_count >= required) && (invocation_count <= maximum)
+    end
+    
+    def allowed_any_number_of_times?
+      required == 0 && infinite?(maximum)
+    end
+    
+    def used?(invocation_count)
+      (invocation_count > 0) || (maximum == 0)
+    end
+    
+    def mocha_inspect
+      if allowed_any_number_of_times?
+        "allowed any number of times"
+      else
+        if required == 0 && maximum == 0
+          "expected never"
+        elsif required == maximum
+          "expected exactly #{times(required)}"
+        elsif infinite?(maximum)
+          "expected at least #{times(required)}"
+        elsif required == 0
+          "expected at most #{times(maximum)}"
+        else
+          "expected between #{required} and #{times(maximum)}"
+        end
+      end
+    end
+    
+    protected
+    
+    attr_reader :required, :maximum
+    
+    def times(number)
+      number == 1 ? "once" : "#{number} times"
+    end
+    
+    def infinite?(number)
+      number.respond_to?(:infinite?) && number.infinite?
+    end
+    
+  end
+  
+end

data/lib/mocha/central.rb

@@ -11,18 +11,10 @@ module Mocha
     def stub(method)
       unless stubba_methods.include?(method)
         method.stub 
-        stubba_methods.push method
+        stubba_methods.push(method)
       end
     end
     
-    def verify_all(&block)
-      unique_mocks.each { |mock| mock.verify(&block) }
-    end
-    
-    def unique_mocks
-      stubba_methods.inject({}) { |mocks, method| mocks[method.mock.__id__] = method.mock; mocks }.values
-    end
-  
     def unstub_all
       while stubba_methods.length > 0
         method = stubba_methods.pop

data/lib/mocha/change_state_side_effect.rb

@@ -0,0 +1,19 @@
+module Mocha
+
+  class ChangeStateSideEffect
+  
+    def initialize(state)
+      @state = state
+    end
+  
+    def perform
+      @state.activate
+    end
+  
+    def mocha_inspect
+      "then #{@state.mocha_inspect}"
+    end
+  
+  end
+
+end

data/lib/mocha/class_method.rb

@@ -26,19 +26,31 @@ module Mocha
     end
   
     def hide_original_method
-      stubbee.__metaclass__.class_eval "alias_method :#{hidden_method}, :#{method}" if stubbee.__metaclass__.method_defined?(method)
+      if method_exists?(method)
+        begin
+          stubbee.__metaclass__.class_eval("alias_method :#{hidden_method}, :#{method}", __FILE__, __LINE__)
+        rescue NameError
+          # deal with nasties like ActiveRecord::Associations::AssociationProxy
+        end
+      end
     end
   
     def define_new_method
-      stubbee.__metaclass__.class_eval "def #{method}(*args, &block); mocha.method_missing(:#{method}, *args, &block); end"
+      stubbee.__metaclass__.class_eval("def #{method}(*args, &block); mocha.method_missing(:#{method}, *args, &block); end", __FILE__, __LINE__)
     end
   
     def remove_new_method
-      stubbee.__metaclass__.class_eval "remove_method :#{method}"
+      stubbee.__metaclass__.class_eval("remove_method :#{method}", __FILE__, __LINE__)
     end
   
     def restore_original_method
-      stubbee.__metaclass__.class_eval "alias_method :#{method}, :#{hidden_method}; remove_method :#{hidden_method}" if stubbee.__metaclass__.method_defined?(hidden_method)
+      if method_exists?(hidden_method)
+        begin
+          stubbee.__metaclass__.class_eval("alias_method :#{method}, :#{hidden_method}; remove_method :#{hidden_method}", __FILE__, __LINE__)
+        rescue NameError
+          # deal with nasties like ActiveRecord::Associations::AssociationProxy
+        end
+      end
     end
   
     def hidden_method
@@ -52,7 +64,7 @@ module Mocha
   
     def eql?(other)
       return false unless (other.class == self.class)
-      (stubbee == other.stubbee) and (method == other.method)
+      (stubbee.object_id == other.stubbee.object_id) and (method == other.method)
     end
   
     alias_method :==, :eql?
@@ -60,6 +72,14 @@ module Mocha
     def to_s
       "#{stubbee}.#{method}"
     end
+    
+    def method_exists?(method)
+      existing_methods = []
+      existing_methods += stubbee.public_methods(true) - stubbee.superclass.public_methods(true)
+      existing_methods += stubbee.protected_methods(true) - stubbee.superclass.protected_methods(true)
+      existing_methods += stubbee.private_methods(true) - stubbee.superclass.private_methods(true)
+      existing_methods.any? { |m| m.to_s == method.to_s }
+    end
 
   end