RubyGems - mocha - Versions diffs - 0.10.5 → 0.11.0 - Mend

mocha 0.10.5 → 0.11.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (229) hide show

data/COPYING.rdoc +1 -1
data/README.rdoc +6 -4
data/RELEASE.rdoc +12 -0
data/Rakefile +29 -60
data/doc/Mocha.html +112 -0
data/doc/Mocha/API.html +898 -0
data/doc/Mocha/ClassMethods.html +246 -0
data/doc/Mocha/Configuration.html +471 -0
data/doc/Mocha/Expectation.html +2570 -0
data/doc/Mocha/Mock.html +830 -0
data/doc/Mocha/ObjectMethods.html +668 -0
data/doc/Mocha/ParameterMatchers.html +2715 -0
data/doc/Mocha/ParameterMatchers/AllOf.html +137 -0
data/doc/Mocha/ParameterMatchers/AnyOf.html +137 -0
data/doc/Mocha/ParameterMatchers/AnyParameters.html +136 -0
data/doc/Mocha/ParameterMatchers/Anything.html +136 -0
data/doc/Mocha/ParameterMatchers/Base.html +419 -0
data/doc/Mocha/ParameterMatchers/Equals.html +137 -0
data/doc/Mocha/ParameterMatchers/HasEntries.html +137 -0
data/doc/Mocha/ParameterMatchers/HasEntry.html +137 -0
data/doc/Mocha/ParameterMatchers/HasKey.html +137 -0
data/doc/Mocha/ParameterMatchers/HasValue.html +137 -0
data/doc/Mocha/ParameterMatchers/Includes.html +137 -0
data/doc/Mocha/ParameterMatchers/InstanceOf.html +137 -0
data/doc/Mocha/ParameterMatchers/IsA.html +136 -0
data/doc/Mocha/ParameterMatchers/KindOf.html +137 -0
data/doc/Mocha/ParameterMatchers/Not.html +137 -0
data/doc/Mocha/ParameterMatchers/Optionally.html +136 -0
data/doc/Mocha/ParameterMatchers/QueryStringMatches.html +136 -0
data/doc/Mocha/ParameterMatchers/RegexpMatches.html +137 -0
data/doc/Mocha/ParameterMatchers/RespondsWith.html +137 -0
data/doc/Mocha/ParameterMatchers/YamlEquivalent.html +137 -0
data/doc/Mocha/Sequence.html +133 -0
data/doc/Mocha/StateMachine.html +510 -0
data/doc/Mocha/StateMachine/State.html +125 -0
data/doc/Mocha/StateMachine/StatePredicate.html +125 -0
data/doc/Mocha/StubbingError.html +134 -0
data/doc/Mocha/UnexpectedInvocation.html +124 -0
data/doc/_index.html +481 -0
data/doc/class_list.html +47 -0
data/doc/css/common.css +1 -0
data/doc/css/full_list.css +55 -0
data/doc/css/style.css +322 -0
data/doc/file.COPYING.html +72 -0
data/doc/file.MIT-LICENSE.html +86 -0
data/doc/file.README.html +153 -0
data/doc/file.RELEASE.html +933 -0
data/doc/file.misc.html +108 -0
data/doc/file.mocha.html +90 -0
data/doc/file.stubba.html +129 -0
data/doc/file_list.html +67 -0
data/doc/frames.html +13 -0
data/doc/index.html +153 -0
data/doc/js/app.js +205 -0
data/doc/js/full_list.js +173 -0
data/doc/js/jquery.js +16 -0
data/doc/method_list.html +510 -0
data/doc/top-level-namespace.html +105 -0
data/lib/mocha/any_instance_method.rb +16 -11
data/lib/mocha/api.rb +120 -106
data/lib/mocha/argument_iterator.rb +6 -6
data/lib/mocha/backtrace_filter.rb +1 -1
data/lib/mocha/cardinality.rb +21 -21
data/lib/mocha/central.rb +8 -8
data/lib/mocha/change_state_side_effect.rb +5 -5
data/lib/mocha/class_method.rb +14 -19
data/lib/mocha/configuration.rb +47 -37
data/lib/mocha/deprecation.rb +8 -8
data/lib/mocha/exception_raiser.rb +7 -7
data/lib/mocha/expectation.rb +173 -77
data/lib/mocha/expectation_error.rb +2 -2
data/lib/mocha/expectation_list.rb +11 -11
data/lib/mocha/in_state_ordering_constraint.rb +5 -5
data/lib/mocha/inspect.rb +8 -8
data/lib/mocha/instance_method.rb +1 -17
data/lib/mocha/integration.rb +9 -9
data/lib/mocha/integration/mini_test/assertion_counter.rb +9 -9
data/lib/mocha/integration/mini_test/exception_translation.rb +6 -6
data/lib/mocha/integration/mini_test/version_13.rb +6 -6
data/lib/mocha/integration/mini_test/version_140.rb +6 -6
data/lib/mocha/integration/mini_test/version_141.rb +6 -6
data/lib/mocha/integration/mini_test/version_142_to_172.rb +7 -7
data/lib/mocha/integration/mini_test/version_200.rb +7 -7
data/lib/mocha/integration/test_unit/assertion_counter.rb +10 -10
data/lib/mocha/integration/test_unit/gem_version_200.rb +6 -6
data/lib/mocha/integration/test_unit/gem_version_201_to_202.rb +6 -6
data/lib/mocha/integration/test_unit/ruby_version_185_and_below.rb +6 -6
data/lib/mocha/integration/test_unit/ruby_version_186_and_above.rb +6 -6
data/lib/mocha/is_a.rb +1 -1
data/lib/mocha/logger.rb +6 -6
data/lib/mocha/method_matcher.rb +7 -7
data/lib/mocha/mock.rb +85 -48
data/lib/mocha/mockery.rb +47 -33
data/lib/mocha/module_method.rb +2 -2
data/lib/mocha/multiple_yields.rb +9 -9
data/lib/mocha/names.rb +18 -18
data/lib/mocha/no_yields.rb +7 -7
data/lib/mocha/object.rb +104 -75
data/lib/mocha/parameter_matchers.rb +3 -3
data/lib/mocha/parameter_matchers/all_of.rb +22 -12
data/lib/mocha/parameter_matchers/any_of.rb +23 -12
data/lib/mocha/parameter_matchers/any_parameters.rb +15 -8
data/lib/mocha/parameter_matchers/anything.rb +20 -11
data/lib/mocha/parameter_matchers/base.rb +35 -27
data/lib/mocha/parameter_matchers/equals.rb +23 -12
data/lib/mocha/parameter_matchers/has_entries.rb +22 -12
data/lib/mocha/parameter_matchers/has_entry.rb +31 -13
data/lib/mocha/parameter_matchers/has_key.rb +21 -11
data/lib/mocha/parameter_matchers/has_value.rb +21 -11
data/lib/mocha/parameter_matchers/includes.rb +15 -5
data/lib/mocha/parameter_matchers/instance_of.rb +23 -12
data/lib/mocha/parameter_matchers/is_a.rb +23 -12
data/lib/mocha/parameter_matchers/kind_of.rb +23 -12
data/lib/mocha/parameter_matchers/not.rb +22 -12
data/lib/mocha/parameter_matchers/object.rb +5 -3
data/lib/mocha/parameter_matchers/optionally.rb +24 -12
data/lib/mocha/parameter_matchers/query_string.rb +14 -3
data/lib/mocha/parameter_matchers/regexp_matches.rb +21 -11
data/lib/mocha/parameter_matchers/responds_with.rb +17 -6
data/lib/mocha/parameter_matchers/yaml_equivalent.rb +16 -6
data/lib/mocha/parameters_matcher.rb +8 -8
data/lib/mocha/pretty_parameters.rb +7 -7
data/lib/mocha/return_values.rb +11 -11
data/lib/mocha/sequence.rb +23 -14
data/lib/mocha/single_return_value.rb +7 -7
data/lib/mocha/single_yield.rb +9 -9
data/lib/mocha/standalone.rb +1 -1
data/lib/mocha/state_machine.rb +61 -46
data/lib/mocha/stubbing_error.rb +8 -5
data/lib/mocha/thrower.rb +2 -2
data/lib/mocha/unexpected_invocation.rb +9 -6
data/lib/mocha/version.rb +1 -1
data/lib/mocha/yield_parameters.rb +10 -10
data/lib/mocha_standalone.rb +1 -1
data/mocha.gemspec +4 -7
data/test/acceptance/acceptance_test_helper.rb +10 -10
data/test/acceptance/api_test.rb +20 -20
data/test/acceptance/bug_18914_test.rb +12 -12
data/test/acceptance/bug_21465_test.rb +6 -6
data/test/acceptance/bug_21563_test.rb +5 -5
data/test/acceptance/exception_rescue_test.rb +1 -1
data/test/acceptance/expected_invocation_count_test.rb +17 -17
data/test/acceptance/failure_messages_test.rb +13 -13
data/test/acceptance/minitest_test.rb +39 -39
data/test/acceptance/mocha_example_test.rb +26 -26
data/test/acceptance/mocha_test_result_test.rb +13 -13
data/test/acceptance/mock_test.rb +5 -5
data/test/acceptance/mock_with_initializer_block_test.rb +5 -5
data/test/acceptance/mocked_methods_dispatch_test.rb +4 -4
data/test/acceptance/multiple_expectations_failure_message_test.rb +2 -2
data/test/acceptance/optional_parameters_test.rb +5 -5
data/test/acceptance/parameter_matcher_test.rb +18 -18
data/test/acceptance/partial_mocks_test.rb +9 -9
data/test/acceptance/raise_exception_test.rb +1 -1
data/test/acceptance/return_value_test.rb +5 -5
data/test/acceptance/sequence_test.rb +29 -29
data/test/acceptance/states_test.rb +17 -17
data/test/acceptance/stub_any_instance_method_test.rb +13 -13
data/test/acceptance/stub_class_method_defined_on_active_record_association_proxy_test.rb +7 -7
data/test/acceptance/stub_everything_test.rb +5 -5
data/test/acceptance/stub_instance_method_defined_on_singleton_class_test.rb +1 -1
data/test/acceptance/stub_module_method_test.rb +17 -17
data/test/acceptance/stub_test.rb +5 -5
data/test/acceptance/stubba_example_test.rb +24 -24
data/test/acceptance/stubba_test_result_test.rb +11 -11
data/test/acceptance/stubbing_error_backtrace_test.rb +6 -6
data/test/acceptance/stubbing_frozen_object_test.rb +88 -0
data/test/acceptance/stubbing_method_unnecessarily_test.rb +9 -9
data/test/acceptance/stubbing_nil_test.rb +59 -0
data/test/acceptance/stubbing_non_existent_any_instance_method_test.rb +13 -13
data/test/acceptance/stubbing_non_existent_class_method_test.rb +15 -15
data/test/acceptance/stubbing_non_existent_instance_method_test.rb +14 -14
data/test/acceptance/stubbing_non_public_any_instance_method_test.rb +13 -13
data/test/acceptance/stubbing_non_public_class_method_test.rb +12 -12
data/test/acceptance/stubbing_non_public_instance_method_test.rb +12 -12
data/test/acceptance/stubbing_on_non_mock_object_test.rb +9 -9
data/test/acceptance/stubbing_same_class_method_on_parent_and_child_classes_test.rb +35 -0
data/test/acceptance/throw_test.rb +1 -1
data/test/deprecation_disabler.rb +1 -1
data/test/execution_point.rb +7 -7
data/test/method_definer.rb +1 -1
data/test/mini_test_result.rb +21 -21
data/test/simple_counter.rb +5 -5
data/test/test_helper.rb +1 -1
data/test/test_runner.rb +22 -24
data/test/test_unit_result.rb +20 -0
data/test/unit/any_instance_method_test.rb +28 -32
data/test/unit/array_inspect_test.rb +3 -3
data/test/unit/backtrace_filter_test.rb +3 -3
data/test/unit/cardinality_test.rb +12 -12
data/test/unit/central_test.rb +18 -18
data/test/unit/change_state_side_effect_test.rb +12 -12
data/test/unit/class_method_test.rb +33 -91
data/test/unit/date_time_inspect_test.rb +4 -4
data/test/unit/exception_raiser_test.rb +5 -5
data/test/unit/expectation_list_test.rb +7 -7
data/test/unit/expectation_test.rb +66 -66
data/test/unit/hash_inspect_test.rb +4 -4
data/test/unit/in_state_ordering_constraint_test.rb +13 -13
data/test/unit/method_matcher_test.rb +3 -3
data/test/unit/mock_test.rb +40 -40
data/test/unit/mockery_test.rb +25 -25
data/test/unit/multiple_yields_test.rb +2 -2
data/test/unit/no_yields_test.rb +2 -2
data/test/unit/object_inspect_test.rb +4 -4
data/test/unit/object_test.rb +15 -15
data/test/unit/parameter_matchers/all_of_test.rb +6 -6
data/test/unit/parameter_matchers/any_of_test.rb +6 -6
data/test/unit/parameter_matchers/anything_test.rb +5 -5
data/test/unit/parameter_matchers/has_entries_test.rb +10 -10
data/test/unit/parameter_matchers/has_entry_test.rb +13 -13
data/test/unit/parameter_matchers/has_key_test.rb +11 -11
data/test/unit/parameter_matchers/has_value_test.rb +12 -12
data/test/unit/parameter_matchers/includes_test.rb +4 -4
data/test/unit/parameter_matchers/not_test.rb +6 -6
data/test/unit/parameter_matchers/regexp_matches_test.rb +9 -9
data/test/unit/parameter_matchers/responds_with_test.rb +6 -6
data/test/unit/parameter_matchers/stub_matcher.rb +4 -4
data/test/unit/parameter_matchers/yaml_equivalent_test.rb +6 -6
data/test/unit/parameters_matcher_test.rb +16 -16
data/test/unit/return_values_test.rb +5 -5
data/test/unit/sequence_test.rb +10 -10
data/test/unit/single_return_value_test.rb +3 -3
data/test/unit/single_yield_test.rb +2 -2
data/test/unit/state_machine_test.rb +19 -19
data/test/unit/string_inspect_test.rb +2 -2
data/test/unit/thrower_test.rb +1 -1
data/test/unit/yield_parameters_test.rb +11 -11
metadata +113 -101

data/doc/top-level-namespace.html ADDED

@@ -0,0 +1,105 @@
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
+  "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
+  <head>
+    <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
+<title>
+  Top Level Namespace
+    &mdash; Mocha 0.11.0
+</title>
+  <link rel="stylesheet" href="css/style.css" type="text/css" media="screen" charset="utf-8" />
+  <link rel="stylesheet" href="css/common.css" type="text/css" media="screen" charset="utf-8" />
+<script type="text/javascript" charset="utf-8">
+  relpath = '';
+  if (relpath != '') relpath += '/';
+</script>
+  <script type="text/javascript" charset="utf-8" src="js/jquery.js"></script>
+  <script type="text/javascript" charset="utf-8" src="js/app.js"></script>
+  </head>
+  <body>
+    <script type="text/javascript" charset="utf-8">
+      if (window.top.frames.main) document.body.className = 'frames';
+    </script>
+    <div id="header">
+      <div id="menu">
+    <a href="_index.html">Index</a> &raquo;
+    <span class="title">Top Level Namespace</span>
+  <div class="noframes"><span class="title">(</span><a href="." target="_top">no frames</a><span class="title">)</span></div>
+</div>
+      <div id="search">
+    <a id="class_list_link" href="#">Class List</a>
+    <a id="method_list_link" href="#">Method List</a>
+    <a id="file_list_link" href="#">File List</a>
+</div>
+      <div class="clear"></div>
+    </div>
+    <iframe id="search_frame"></iframe>
+    <div id="content"><h1>Top Level Namespace
+</h1>
+<dl class="box">
+</dl>
+<div class="clear"></div>
+<h2>Defined Under Namespace</h2>
+<p class="children">
+      <strong class="modules">Modules:</strong> <span class='object_link'><a href="Mocha.html" title="Mocha (module)">Mocha</a></span>
+</p>
+</div>
+    <div id="footer">
+  Generated on Thu Apr 19 10:54:34 2012 by
+  <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
+  0.7.5 (ruby-1.9.3).
+</div>
+  </body>
+</html>

data/lib/mocha/any_instance_method.rb CHANGED

@@ -3,7 +3,7 @@ require 'mocha/class_method'
 module Mocha
   class AnyInstanceMethod < ClassMethod
     def mock
       stubbee.any_instance.mocha
     end
@@ -15,7 +15,16 @@ module Mocha
     def hide_original_method
       if method_exists?(method)
         begin
-          stubbee.send(:alias_method, hidden_method, method)
+          @original_method = stubbee.instance_method(method)
+          if @original_method && @original_method.owner == stubbee
+            @original_visibility = :public
+            if stubbee.protected_instance_methods.include?(method)
+              @original_visibility = :protected
+            elsif stubbee.private_instance_methods.include?(method)
+              @original_visibility = :private
+            end
+            stubbee.send(:remove_method, method)
+          end
         rescue NameError
           # deal with nasties like ActiveRecord::Associations::AssociationProxy
         end
@@ -35,13 +44,9 @@ module Mocha
     end
     def restore_original_method
-      if method_exists?(hidden_method)
-        begin
-          stubbee.send(:alias_method, method, hidden_method)
-          stubbee.send(:remove_method, hidden_method)
-        rescue NameError
-          # deal with nasties like ActiveRecord::Associations::AssociationProxy
-        end
+      if @original_method && @original_method.owner == stubbee
+        stubbee.send(:define_method, method, @original_method)
+        stubbee.send(@original_visibility, method)
       end
     end
@@ -51,7 +56,7 @@ module Mocha
       return true if stubbee.private_instance_methods(false).include?(method)
       return false
     end
   end
 end

data/lib/mocha/api.rb CHANGED

@@ -2,41 +2,41 @@ require 'mocha/parameter_matchers'
 require 'mocha/mockery'
 require 'mocha/sequence'
-module Mocha # :nodoc:
-  # Methods added to Test::Unit::TestCase or equivalent.
+module Mocha
+  # Methods added to +Test::Unit::TestCase+ or equivalent.
   module API
     include ParameterMatchers
-    # :call-seq: mock(name, &block) -> mock object
-    #            mock(expected_methods = {}, &block) -> mock object
-    #            mock(name, expected_methods = {}, &block) -> mock object
-    #
-    # Creates a mock object.
-    #
-    # +name+ is a +String+ identifier for the mock object.
-    #
-    # +expected_methods+ is a +Hash+ with expected method name symbols as keys and corresponding return values as values.
-    #
-    # Note that (contrary to expectations set up by #stub) these expectations <b>must</b> be fulfilled during the test.
-    #   def test_product
-    #     product = mock('ipod_product', :manufacturer => 'ipod', :price => 100)
-    #     assert_equal 'ipod', product.manufacturer
-    #     assert_equal 100, product.price
-    #     # an error will be raised unless both Product#manufacturer and Product#price have been called
-    #   end
-    #
-    # +block+ is an optional block to be evaluated against the mock object instance, giving an alernative way to set up expectations & stubs.
-    #   def test_product
-    #     product = mock('ipod_product') do
-    #       expects(:manufacturer).returns('ipod')
-    #       expects(:price).returns(100)
+    # Builds a new mock object
+    #
+    # @param [String] name identifies mock object in error messages.
+    # @param [Hash] expected_methods_vs_return_values expected method name symbols as keys and corresponding return values as values - these expectations are setup as if {Mock#expects} were called multiple times.
+    # @yield optional block to be evaluated against the mock object instance, giving an alternative way to setup expectations.
+    # @return [Mock] a new mock object
+    #
+    # @overload def mock(name, &block)
+    # @overload def mock(expected_methods_vs_return_values = {}, &block)
+    # @overload def mock(name, expected_methods_vs_return_values = {}, &block)
+    #
+    # @example Using expected_methods_vs_return_values Hash to setup expectations.
+    #   def test_motor_starts_and_stops
+    #     motor = mock('motor', :start => true, :stop => true)
+    #     assert motor.start
+    #     assert motor.stop
+    #     # an error will be raised unless both Motor#start and Motor#stop have been called
+    #   end
+    # @example Using the optional block to setup expectations & stubbed methods.
+    #   def test_motor_starts_and_stops
+    #     motor = mock('motor') do
+    #       expects(:start).with(100.rpm).returns(true)
+    #       stubs(:stop).returns(true)
     #     end
-    #     assert_equal 'ipod', product.manufacturer
-    #     assert_equal 100, product.price
-    #     # an error will be raised unless both Product#manufacturer and Product#price have been called
-    #   end
+    #     assert motor.start(100.rpm)
+    #     assert motor.stop
+    #     # an error will only be raised if Motor#start(100.rpm) has not been called
+    #   end
     def mock(*arguments, &block)
       name = arguments.shift if arguments.first.is_a?(String)
       expectations = arguments.shift || {}
@@ -44,33 +44,35 @@ module Mocha # :nodoc:
       mock.expects(expectations)
       mock
     end
-    # :call-seq: stub(name, &block) -> mock object
-    #            stub(stubbed_methods = {}, &block) -> mock object
-    #            stub(name, stubbed_methods = {}, &block) -> mock object
-    #
-    # Creates a mock object.
-    #
-    # +name+ is a +String+ identifier for the mock object.
-    #
-    # +stubbed_methods+ is a +Hash+ with stubbed method name symbols as keys and corresponding return values as values.
-    # Note that (contrary to expectations set up by #mock) these expectations <b>need not</b> be fulfilled during the test.
-    #   def test_product
-    #     product = stub('ipod_product', :manufacturer => 'ipod', :price => 100)
-    #     assert_equal 'ipod', product.manufacturer
-    #     assert_equal 100, product.price
-    #     # an error will not be raised even if Product#manufacturer and Product#price have not been called
+    # Builds a new mock object
+    #
+    # @param [String] name identifies mock object in error messages.
+    # @param [Hash] stubbed_methods_vs_return_values stubbed method name symbols as keys and corresponding return values as values - these stubbed methods are setup as if {Mock#stubs} were called multiple times.
+    # @yield optional block to be evaluated against the mock object instance, giving an alternative way to setup stubbed methods.
+    # @return [Mock] a new mock object
+    #
+    # @overload def stub(name, &block)
+    # @overload def stub(stubbed_methods_vs_return_values = {}, &block)
+    # @overload def stub(name, stubbed_methods_vs_return_values = {}, &block)
+    #
+    # @example Using stubbed_methods_vs_return_values Hash to setup stubbed methods.
+    #   def test_motor_starts_and_stops
+    #     motor = mock('motor', :start => true, :stop => true)
+    #     assert motor.start
+    #     assert motor.stop
+    #     # an error will not be raised even if either Motor#start or Motor#stop has not been called
     #   end
     #
-    # +block+ is an optional block to be evaluated against the mock object instance, giving an alernative way to set up expectations & stubs.
-    #   def test_product
-    #     product = stub('ipod_product') do
-    #       stubs(:manufacturer).returns('ipod')
-    #       stubs(:price).returns(100)
+    # @example Using the optional block to setup expectations & stubbed methods.
+    #   def test_motor_starts_and_stops
+    #     motor = mock('motor') do
+    #       expects(:start).with(100.rpm).returns(true)
+    #       stubs(:stop).returns(true)
     #     end
-    #     assert_equal 'ipod', product.manufacturer
-    #     assert_equal 100, product.price
-    #     # an error will not be raised even if Product#manufacturer and Product#price have not been called
+    #     assert motor.start(100.rpm)
+    #     assert motor.stop
+    #     # an error will only be raised if Motor#start(100.rpm) has not been called
     #   end
     def stub(*arguments, &block)
       name = arguments.shift if arguments.first.is_a?(String)
@@ -79,23 +81,24 @@ module Mocha # :nodoc:
       stub.stubs(expectations)
       stub
     end
-    # :call-seq: stub_everything(name, &block) -> mock object
-    #            stub_everything(stubbed_methods = {}, &block) -> mock object
-    #            stub_everything(name, stubbed_methods = {}, &block) -> mock object
-    #
-    # Creates a mock object that accepts calls to any method.
-    #
-    # By default it will return +nil+ for any method call.
-    #
-    # +block+ is a block to be evaluated against the mock object instance, giving an alernative way to set up expectations & stubs.
-    #
-    # +name+ and +stubbed_methods+ work in the same way as for #stub.
-    #   def test_product
-    #     product = stub_everything('ipod_product', :price => 100)
-    #     assert_nil product.manufacturer
-    #     assert_nil product.any_old_method
-    #     assert_equal 100, product.price
+    # Builds a mock object that accepts calls to any method. By default it will return +nil+ for any method call.
+    #
+    # @param [String] name identifies mock object in error messages.
+    # @param [Hash] stubbed_methods_vs_return_values stubbed method name symbols as keys and corresponding return values as values - these stubbed methods are setup as if {Mock#stubs} were called multiple times.
+    # @yield optional block to be evaluated against the mock object instance, giving an alternative way to setup stubbed methods.
+    # @return [Mock] a new mock object
+    #
+    # @overload def stub_everything(name, &block)
+    # @overload def stub_everything(stubbed_methods_vs_return_values = {}, &block)
+    # @overload def stub_everything(name, stubbed_methods_vs_return_values = {}, &block)
+    #
+    # @example Ignore invocations of irrelevant methods.
+    #   def test_motor_stops
+    #     motor = stub_everything('motor', :stop => true)
+    #     assert_nil motor.irrelevant_method_1 # => no error raised
+    #     assert_nil motor.irrelevant_method_2 # => no error raised
+    #     assert motor.stop
     #   end
     def stub_everything(*arguments, &block)
       name = arguments.shift if arguments.first.is_a?(String)
@@ -105,69 +108,80 @@ module Mocha # :nodoc:
       stub.stubs(expectations)
       stub
     end
-    # :call-seq: sequence(name) -> sequence
+    # Builds a new sequence which can be used to constrain the order in which expectations can occur.
+    #
+    # Specify that an expected invocation must occur within a named {Sequence} by using {Expectation#in_sequence}.
     #
-    # Returns a new sequence that is used to constrain the order in which expectations can occur.
+    # @return [Sequence] a new sequence
     #
-    # Specify that an expected invocation must occur in within a named +sequence+ by using Expectation#in_sequence.
+    # @see Expectation#in_sequence
     #
-    # See also Expectation#in_sequence.
+    # @example Ensure methods on egg are invoked in correct order.
     #   breakfast = sequence('breakfast')
     #
-    #   egg = mock('egg')
-    #   egg.expects(:crack).in_sequence(breakfast)
-    #   egg.expects(:fry).in_sequence(breakfast)
-    #   egg.expects(:eat).in_sequence(breakfast)
+    #   egg = mock('egg') do
+    #     expects(:crack).in_sequence(breakfast)
+    #     expects(:fry).in_sequence(breakfast)
+    #     expects(:eat).in_sequence(breakfast)
+    #   end
     def sequence(name)
       Sequence.new(name)
     end
-    # :call-seq: states(name) -> state_machine
+    # Builds a new state machine which can be used to constrain the order in which expectations can occur.
     #
-    # Returns a new +state_machine+ that is used to constrain the order in which expectations can occur.
+    # Specify the initial state of the state machine by using {StateMachine#starts_as}.
     #
-    # Specify the initial +state+ of the +state_machine+ by using StateMachine#starts_as.
+    # Specify that an expected invocation should change the state of the state machine by using {Expectation#then}.
     #
-    # Specify that an expected invocation should change the +state+ of the +state_machine+ by using Expectation#then.
+    # Specify that an expected invocation should be constrained to occur within a particular +state+ by using {Expectation#when}.
     #
-    # Specify that an expected invocation should be constrained to occur within a particular +state+ by using Expectation#when.
+    # A test can contain multiple state machines.
     #
-    # A test can contain multiple +state_machines+.
+    # @return [StateMachine] a new state machine
     #
-    # See also Expectation#then, Expectation#when and StateMachine.
+    # @see Expectation#then
+    # @see Expectation#when
+    # @see StateMachine
+    # @example Constrain expected invocations to occur in particular states.
     #   power = states('power').starts_as('off')
     #
-    #   radio = mock('radio')
-    #   radio.expects(:switch_on).then(power.is('on'))
-    #   radio.expects(:select_channel).with('BBC Radio 4').when(power.is('on'))
-    #   radio.expects(:adjust_volume).with(+5).when(power.is('on'))
-    #   radio.expects(:select_channel).with('BBC World Service').when(power.is('on'))
-    #   radio.expects(:adjust_volume).with(-5).when(power.is('on'))
-    #   radio.expects(:switch_off).then(power.is('off'))
+    #   radio = mock('radio') do
+    #     expects(:switch_on).then(power.is('on'))
+    #     expects(:select_channel).with('BBC Radio 4').when(power.is('on'))
+    #     expects(:adjust_volume).with(+5).when(power.is('on'))
+    #     expects(:select_channel).with('BBC World Service').when(power.is('on'))
+    #     expects(:adjust_volume).with(-5).when(power.is('on'))
+    #     expects(:switch_off).then(power.is('off'))
+    #   end
     def states(name)
       Mockery.instance.new_state_machine(name)
     end
-    def mocha_setup # :nodoc:
+    # @private
+    def mocha_setup
     end
-    def mocha_verify(assertion_counter = nil) # :nodoc:
+    # @private
+    def mocha_verify(assertion_counter = nil)
       Mockery.instance.verify(assertion_counter)
     end
-    def mocha_teardown # :nodoc:
+    # @private
+    def mocha_teardown
       Mockery.instance.teardown
       Mockery.reset_instance
     end
   end
+  # @private
   def self.const_missing(name)
     return super unless name == :Standalone
     require 'mocha/deprecation'
     Deprecation.warning "Mocha::Standalone has been renamed to Mocha::API"
     return API
   end
 end

data/lib/mocha/argument_iterator.rb CHANGED

@@ -1,11 +1,11 @@
 module Mocha
   class ArgumentIterator
     def initialize(argument)
       @argument = argument
     end
     def each(&block)
       if @argument.is_a?(Hash) then
         @argument.each do |method_name, return_value|
@@ -15,7 +15,7 @@ module Mocha
         block.call(@argument)
       end
     end
   end
-end
+end