mocha 1.10.2 → 1.13.0

data/lib/mocha/state_machine.rb

@@ -2,46 +2,32 @@ module Mocha
   # A state machine that is used to constrain the order of invocations.
   # An invocation can be constrained to occur when a state {#is}, or {#is_not}, active.
   class StateMachine
-    # Provides a mechanism to change the state of a {StateMachine} at some point in the future.
-    class State
+    # Provides the ability to determine whether a {StateMachine} is in a specified state at some point in the future.
+    class StatePredicate
       # @private
-      def initialize(state_machine, state)
+      def initialize(state_machine, state, description, &active_check)
         @state_machine = state_machine
         @state = state
-      end
-
-      # @private
-      def activate
-        @state_machine.current_state = @state
+        @description = description
+        @active_check = active_check
       end
 
       # @private
       def active?
-        @state_machine.current_state == @state
+        @active_check.call(@state_machine.current_state, @state)
       end
 
       # @private
       def mocha_inspect
-        "#{@state_machine.name} is #{@state.mocha_inspect}"
+        "#{@state_machine.name} #{@description} #{@state.mocha_inspect}"
       end
     end
 
-    # Provides the ability to determine whether a {StateMachine} is in a specified state at some point in the future.
-    class StatePredicate
-      # @private
-      def initialize(state_machine, state)
-        @state_machine = state_machine
-        @state = state
-      end
-
-      # @private
-      def active?
-        @state_machine.current_state != @state
-      end
-
+    # Provides a mechanism to change the state of a {StateMachine} at some point in the future.
+    class State < StatePredicate
       # @private
-      def mocha_inspect
-        "#{@state_machine.name} is not #{@state.mocha_inspect}"
+      def activate
+        @state_machine.current_state = @state
       end
     end
 
@@ -73,30 +59,35 @@ module Mocha
       @current_state = next_state_name
     end
 
-    # Provides a mechanism to change the {StateMachine} into the state specified by +state_name+ at some point in the future.
+    # Provides mechanisms to (a) determine whether the {StateMachine} is in a given state; or (b) to change the {StateMachine} into the given state.
     #
-    # Or provides a mechanism to determine whether the {StateMachine} is in the state specified by +state_name+ at some point in the future.
+    # @param [String] state_name name of expected/desired state.
+    # @return [StatePredicate,State] (a) state predicate which, when queried, will indicate whether the {StateMachine} is in the given state; or (b) state which, when activated, will change the {StateMachine} into the given state.
     #
-    # @param [String] state_name name of new state
-    # @return [State] state which, when activated, will change the {StateMachine} into the state with the specified +state_name+.
+    # @overload def is(expected_state_name)
+    #   Provides a mechanism to determine whether the {StateMachine} is in the state specified by +expected_state_name+ at some point in the future
+    #   @param [String] expected_state_name name of expected state.
+    #   @return [StatePredicate] state predicate which, when queried, will indicate whether the {StateMachine} is in the state specified by +expected_state_name+
+    #
+    # @overload def is(desired_state_name)
+    #   Provides a mechanism to change the {StateMachine} into the state specified by +desired_state_name+ at some point in the future.
+    #   @param [String] desired_state_name name of desired new state.
+    #   @return [State] state which, when activated, will change the {StateMachine} into the state with the specified +desired_state_name+.
     def is(state_name)
-      State.new(self, state_name)
+      State.new(self, state_name, 'is') { |current, given| current == given }
     end
 
-    # Provides a mechanism to determine whether the {StateMachine} is not in the state specified by +state_name+ at some point in the future.
-    # rubocop:disable Naming/PredicateName
-    def is_not(state_name)
-      StatePredicate.new(self, state_name)
+    # Provides a mechanism to determine whether the {StateMachine} is *not* in the state specified by +unexpected_state_name+ at some point in the future.
+    #
+    # @param [String] unexpected_state_name name of unexpected state.
+    # @return [StatePredicate] state predicate which, when queried, will indicate whether the {StateMachine} is *not* in the state specified by +unexpected_state_name+.
+    def is_not(unexpected_state_name) # rubocop:disable Naming/PredicateName
+      StatePredicate.new(self, unexpected_state_name, 'is not') { |current, given| current != given }
     end
-    # rubocop:enable Naming/PredicateName
 
     # @private
     def mocha_inspect
-      if @current_state
-        "#{@name} is #{@current_state.mocha_inspect}"
-      else
-        "#{@name} has no current state"
-      end
+      %(#{@name} #{@current_state ? "is #{@current_state.mocha_inspect}" : 'has no current state'})
     end
   end
 end

data/lib/mocha/stubbed_method.rb

@@ -74,7 +74,7 @@ module Mocha
     def restore_original_method
       return if use_prepended_module_for_stub_method?
       if stub_method_overwrites_original_method?
-        original_method_owner.send(:define_method, method_name, method_body(original_method))
+        original_method_owner.send(:define_method, method_name, method_body(@original_method))
       end
       retain_original_visibility(original_method_owner)
     end
@@ -93,18 +93,16 @@ module Mocha
     private
 
     def retain_original_visibility(method_owner)
-      return unless original_visibility
-      Module.instance_method(original_visibility).bind(method_owner).call(method_name)
+      return unless @original_visibility
+      Module.instance_method(@original_visibility).bind(method_owner).call(method_name)
     end
 
-    attr_reader :original_method, :original_visibility
-
     def store_original_method_visibility
       @original_visibility = original_method_owner.__method_visibility__(method_name)
     end
 
     def stub_method_overwrites_original_method?
-      original_method && original_method.owner == original_method_owner
+      @original_method && @original_method.owner == original_method_owner
     end
 
     def remove_original_method_from_stubbee

data/lib/mocha/version.rb

@@ -1,3 +1,3 @@
 module Mocha
-  VERSION = '1.10.2'.freeze
+  VERSION = '1.13.0'.freeze
 end

data/lib/mocha/yield_parameters.rb

@@ -1,7 +1,3 @@
-require 'mocha/no_yields'
-require 'mocha/single_yield'
-require 'mocha/multiple_yields'
-
 module Mocha
   class YieldParameters
     def initialize
@@ -10,18 +6,16 @@ module Mocha
 
     def next_invocation
       case @parameter_groups.length
-      when 0 then NoYields.new
+      when 0 then []
       when 1 then @parameter_groups.first
       else @parameter_groups.shift
       end
     end
 
-    def add(*parameters)
-      @parameter_groups << SingleYield.new(*parameters)
-    end
-
-    def multiple_add(*parameter_groups)
-      @parameter_groups << MultipleYields.new(*parameter_groups)
+    def add(*parameter_groups)
+      @parameter_groups << parameter_groups.map do |pg|
+        pg.is_a?(Array) ? pg : [pg]
+      end
     end
   end
 end

data/mocha.gemspec

@@ -12,8 +12,10 @@ Gem::Specification.new do |s| # rubocop:disable Metrics/BlockLength
   s.description = 'Mocking and stubbing library with JMock/SchMock syntax, which allows mocking and stubbing of methods on real (non-mock) classes.'
   s.email = 'mocha-developer@googlegroups.com'
 
-  s.files = `git ls-files`.split("\n")
-  s.files.delete('.travis.yml')
+  s.files = Dir.chdir(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(docs|test)/}) }
+  end
+  s.files.delete('.circleci/config.yml')
   s.files.delete('.gitignore')
 
   s.homepage = 'https://mocha.jamesmead.org'
@@ -28,18 +30,22 @@ Gem::Specification.new do |s| # rubocop:disable Metrics/BlockLength
     end
   end
 
-  if RUBY_VERSION >= '1.9.3'
-    s.add_development_dependency('rake')
+  if RUBY_VERSION < '1.9.3'
+    s.add_development_dependency 'rake', '~> 10.0'
+  elsif RUBY_VERSION < '2'
+    s.add_development_dependency 'rake', '~> 12.2.1'
+  elsif RUBY_VERSION < '2.2'
+    s.add_development_dependency 'rake', '~> 12.3.3'
   else
-    # Rake >= v11 does not support Ruby < v1.9.3 so use
-    s.add_development_dependency('rake', '~> 10.0')
+    s.add_development_dependency 'rake'
   end
+
   s.add_development_dependency('introspection', '~> 0.0.1')
   if RUBY_VERSION >= '2.2.0'
     # No test libraries in standard library
     s.add_development_dependency('minitest')
   end
-  if RUBY_VERSION >= '1.9.2'
+  if RUBY_VERSION >= '2.2.0'
     s.add_development_dependency('rubocop', '<= 0.58.2')
   end
   if ENV['MOCHA_GENERATE_DOCS']

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: mocha
 version: !ruby/object:Gem::Version
-  version: 1.10.2
+  version: 1.13.0
 platform: ruby
 authors:
 - James Mead
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2019-12-12 00:00:00.000000000 Z
+date: 2021-06-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -74,6 +74,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".gemtest"
+- ".github/FUNDING.yml"
 - ".rubocop.yml"
 - ".rubocop_todo.yml"
 - ".yardopts"
@@ -84,80 +85,7 @@ files:
 - README.md
 - RELEASE.md
 - Rakefile
-- bin/build-matrix
-- docs/CNAME
-- docs/Mocha.html
-- docs/Mocha/API.html
-- docs/Mocha/ClassMethods.html
-- docs/Mocha/Configuration.html
-- docs/Mocha/Expectation.html
-- docs/Mocha/ExpectationError.html
-- docs/Mocha/ExpectationErrorFactory.html
-- docs/Mocha/Hooks.html
-- docs/Mocha/Integration.html
-- docs/Mocha/Integration/MiniTest.html
-- docs/Mocha/Integration/MiniTest/Adapter.html
-- docs/Mocha/Integration/TestUnit.html
-- docs/Mocha/Integration/TestUnit/Adapter.html
-- docs/Mocha/Mock.html
-- docs/Mocha/ObjectMethods.html
-- docs/Mocha/ParameterMatchers.html
-- docs/Mocha/ParameterMatchers/AllOf.html
-- docs/Mocha/ParameterMatchers/AnyOf.html
-- docs/Mocha/ParameterMatchers/AnyParameters.html
-- docs/Mocha/ParameterMatchers/Anything.html
-- docs/Mocha/ParameterMatchers/Base.html
-- docs/Mocha/ParameterMatchers/Equals.html
-- docs/Mocha/ParameterMatchers/EquivalentUri.html
-- docs/Mocha/ParameterMatchers/HasEntries.html
-- docs/Mocha/ParameterMatchers/HasEntry.html
-- docs/Mocha/ParameterMatchers/HasKey.html
-- docs/Mocha/ParameterMatchers/HasValue.html
-- docs/Mocha/ParameterMatchers/Includes.html
-- docs/Mocha/ParameterMatchers/InstanceOf.html
-- docs/Mocha/ParameterMatchers/IsA.html
-- docs/Mocha/ParameterMatchers/KindOf.html
-- docs/Mocha/ParameterMatchers/Not.html
-- docs/Mocha/ParameterMatchers/Optionally.html
-- docs/Mocha/ParameterMatchers/RegexpMatches.html
-- docs/Mocha/ParameterMatchers/RespondsWith.html
-- docs/Mocha/ParameterMatchers/YamlEquivalent.html
-- docs/Mocha/Sequence.html
-- docs/Mocha/StateMachine.html
-- docs/Mocha/StateMachine/State.html
-- docs/Mocha/StateMachine/StatePredicate.html
-- docs/Mocha/StubbingError.html
-- docs/_index.html
-- docs/class_list.html
-- docs/css/common.css
-- docs/css/full_list.css
-- docs/css/style.css
-- docs/file.COPYING.html
-- docs/file.MIT-LICENSE.html
-- docs/file.README.html
-- docs/file.RELEASE.html
-- docs/file_list.html
-- docs/frames.html
-- docs/index.html
-- docs/js/app.js
-- docs/js/full_list.js
-- docs/js/jquery.js
-- docs/method_list.html
-- docs/top-level-namespace.html
-- gemfiles/Gemfile.minitest.1.3.0
-- gemfiles/Gemfile.minitest.1.4.0
-- gemfiles/Gemfile.minitest.1.4.1
-- gemfiles/Gemfile.minitest.1.4.2
-- gemfiles/Gemfile.minitest.2.0.0
-- gemfiles/Gemfile.minitest.2.0.1
-- gemfiles/Gemfile.minitest.2.11.0
-- gemfiles/Gemfile.minitest.2.11.2
-- gemfiles/Gemfile.minitest.2.3.0
-- gemfiles/Gemfile.minitest.5.11.3
 - gemfiles/Gemfile.minitest.latest
-- gemfiles/Gemfile.test-unit.2.0.0
-- gemfiles/Gemfile.test-unit.2.0.1
-- gemfiles/Gemfile.test-unit.2.0.3
 - gemfiles/Gemfile.test-unit.latest
 - init.rb
 - lib/mocha.rb
@@ -165,6 +93,7 @@ files:
 - lib/mocha/api.rb
 - lib/mocha/argument_iterator.rb
 - lib/mocha/backtrace_filter.rb
+- lib/mocha/block_matcher.rb
 - lib/mocha/cardinality.rb
 - lib/mocha/central.rb
 - lib/mocha/change_state_side_effect.rb
@@ -217,9 +146,7 @@ files:
 - lib/mocha/minitest.rb
 - lib/mocha/mock.rb
 - lib/mocha/mockery.rb
-- lib/mocha/multiple_yields.rb
 - lib/mocha/names.rb
-- lib/mocha/no_yields.rb
 - lib/mocha/not_initialized_error.rb
 - lib/mocha/object_methods.rb
 - lib/mocha/parameter_matchers.rb
@@ -233,6 +160,7 @@ files:
 - lib/mocha/parameter_matchers/has_entries.rb
 - lib/mocha/parameter_matchers/has_entry.rb
 - lib/mocha/parameter_matchers/has_key.rb
+- lib/mocha/parameter_matchers/has_keys.rb
 - lib/mocha/parameter_matchers/has_value.rb
 - lib/mocha/parameter_matchers/includes.rb
 - lib/mocha/parameter_matchers/instance_methods.rb
@@ -245,7 +173,6 @@ files:
 - lib/mocha/parameter_matchers/responds_with.rb
 - lib/mocha/parameter_matchers/yaml_equivalent.rb
 - lib/mocha/parameters_matcher.rb
-- lib/mocha/pretty_parameters.rb
 - lib/mocha/raised_exception.rb
 - lib/mocha/receivers.rb
 - lib/mocha/return_values.rb
@@ -253,7 +180,6 @@ files:
 - lib/mocha/sequence.rb
 - lib/mocha/setup.rb
 - lib/mocha/single_return_value.rb
-- lib/mocha/single_yield.rb
 - lib/mocha/singleton_class.rb
 - lib/mocha/state_machine.rb
 - lib/mocha/stubbed_method.rb
@@ -264,134 +190,6 @@ files:
 - lib/mocha/version.rb
 - lib/mocha/yield_parameters.rb
 - mocha.gemspec
-- test/acceptance/acceptance_test_helper.rb
-- test/acceptance/bug_18914_test.rb
-- test/acceptance/bug_21465_test.rb
-- test/acceptance/bug_21563_test.rb
-- test/acceptance/display_matching_invocations_alongside_expectations_test.rb
-- test/acceptance/exception_rescue_test.rb
-- test/acceptance/expectations_on_multiple_methods_test.rb
-- test/acceptance/expected_invocation_count_test.rb
-- test/acceptance/failure_messages_test.rb
-- test/acceptance/issue_272_test.rb
-- test/acceptance/issue_65_test.rb
-- test/acceptance/issue_70_test.rb
-- test/acceptance/mocha_example_test.rb
-- test/acceptance/mocha_test_result_test.rb
-- test/acceptance/mock_built_with_first_argument_type_being_string_test.rb
-- test/acceptance/mock_test.rb
-- test/acceptance/mocked_methods_dispatch_test.rb
-- test/acceptance/multiple_expectations_failure_message_test.rb
-- test/acceptance/optional_parameters_test.rb
-- test/acceptance/parameter_matcher_test.rb
-- test/acceptance/partial_mocks_test.rb
-- test/acceptance/prepend_test.rb
-- test/acceptance/prevent_use_of_mocha_outside_test_test.rb
-- test/acceptance/raise_exception_test.rb
-- test/acceptance/return_value_test.rb
-- test/acceptance/sequence_test.rb
-- test/acceptance/states_test.rb
-- test/acceptance/stub_any_instance_method_defined_on_superclass_test.rb
-- test/acceptance/stub_any_instance_method_test.rb
-- test/acceptance/stub_class_method_defined_on_active_record_association_proxy_test.rb
-- test/acceptance/stub_class_method_defined_on_class_test.rb
-- test/acceptance/stub_class_method_defined_on_module_test.rb
-- test/acceptance/stub_class_method_defined_on_superclass_test.rb
-- test/acceptance/stub_everything_test.rb
-- test/acceptance/stub_instance_method_defined_on_active_record_association_proxy_test.rb
-- test/acceptance/stub_instance_method_defined_on_class_and_aliased_test.rb
-- test/acceptance/stub_instance_method_defined_on_class_test.rb
-- test/acceptance/stub_instance_method_defined_on_kernel_module_test.rb
-- test/acceptance/stub_instance_method_defined_on_module_test.rb
-- test/acceptance/stub_instance_method_defined_on_object_class_test.rb
-- test/acceptance/stub_instance_method_defined_on_singleton_class_test.rb
-- test/acceptance/stub_instance_method_defined_on_superclass_test.rb
-- test/acceptance/stub_method_defined_on_module_and_aliased_test.rb
-- test/acceptance/stub_module_method_test.rb
-- test/acceptance/stub_test.rb
-- test/acceptance/stubba_example_test.rb
-- test/acceptance/stubba_test_result_test.rb
-- test/acceptance/stubbing_error_backtrace_test.rb
-- test/acceptance/stubbing_frozen_object_test.rb
-- test/acceptance/stubbing_method_accepting_block_parameter_test.rb
-- test/acceptance/stubbing_method_unnecessarily_test.rb
-- test/acceptance/stubbing_nil_test.rb
-- test/acceptance/stubbing_non_existent_any_instance_method_test.rb
-- test/acceptance/stubbing_non_existent_class_method_test.rb
-- test/acceptance/stubbing_non_existent_instance_method_test.rb
-- test/acceptance/stubbing_non_public_any_instance_method_test.rb
-- test/acceptance/stubbing_non_public_class_method_test.rb
-- test/acceptance/stubbing_non_public_instance_method_test.rb
-- test/acceptance/stubbing_on_non_mock_object_test.rb
-- test/acceptance/stubbing_same_class_method_on_parent_and_child_classes_test.rb
-- test/acceptance/throw_test.rb
-- test/acceptance/unexpected_invocation_test.rb
-- test/acceptance/unstubbing_test.rb
-- test/assertions.rb
-- test/deprecation_disabler.rb
-- test/execution_point.rb
-- test/integration/mini_test_test.rb
-- test/integration/shared_tests.rb
-- test/integration/test_unit_test.rb
-- test/method_definer.rb
-- test/mini_test_result.rb
-- test/minitest_result.rb
-- test/simple_counter.rb
-- test/test_helper.rb
-- test/test_runner.rb
-- test/test_unit_result.rb
-- test/unit/any_instance_method_test.rb
-- test/unit/array_inspect_test.rb
-- test/unit/backtrace_filter_test.rb
-- test/unit/cardinality_test.rb
-- test/unit/central_test.rb
-- test/unit/change_state_side_effect_test.rb
-- test/unit/class_methods_test.rb
-- test/unit/configuration_test.rb
-- test/unit/date_time_inspect_test.rb
-- test/unit/exception_raiser_test.rb
-- test/unit/expectation_list_test.rb
-- test/unit/expectation_test.rb
-- test/unit/hash_inspect_test.rb
-- test/unit/hooks_test.rb
-- test/unit/in_state_ordering_constraint_test.rb
-- test/unit/instance_method_test.rb
-- test/unit/method_matcher_test.rb
-- test/unit/mock_test.rb
-- test/unit/mockery_test.rb
-- test/unit/module_methods_test.rb
-- test/unit/multiple_yields_test.rb
-- test/unit/no_yields_test.rb
-- test/unit/object_inspect_test.rb
-- test/unit/object_methods_test.rb
-- test/unit/parameter_matchers/all_of_test.rb
-- test/unit/parameter_matchers/any_of_test.rb
-- test/unit/parameter_matchers/anything_test.rb
-- test/unit/parameter_matchers/equals_test.rb
-- test/unit/parameter_matchers/equivalent_uri_test.rb
-- test/unit/parameter_matchers/has_entries_test.rb
-- test/unit/parameter_matchers/has_entry_test.rb
-- test/unit/parameter_matchers/has_key_test.rb
-- test/unit/parameter_matchers/has_value_test.rb
-- test/unit/parameter_matchers/includes_test.rb
-- test/unit/parameter_matchers/instance_of_test.rb
-- test/unit/parameter_matchers/is_a_test.rb
-- test/unit/parameter_matchers/kind_of_test.rb
-- test/unit/parameter_matchers/not_test.rb
-- test/unit/parameter_matchers/regexp_matches_test.rb
-- test/unit/parameter_matchers/responds_with_test.rb
-- test/unit/parameter_matchers/stub_matcher.rb
-- test/unit/parameter_matchers/yaml_equivalent_test.rb
-- test/unit/parameters_matcher_test.rb
-- test/unit/receivers_test.rb
-- test/unit/return_values_test.rb
-- test/unit/sequence_test.rb
-- test/unit/single_return_value_test.rb
-- test/unit/single_yield_test.rb
-- test/unit/state_machine_test.rb
-- test/unit/string_inspect_test.rb
-- test/unit/thrower_test.rb
-- test/unit/yield_parameters_test.rb
 - yard-templates/default/layout/html/google_analytics.erb
 - yard-templates/default/layout/html/setup.rb
 homepage: https://mocha.jamesmead.org
@@ -399,7 +197,7 @@ licenses:
 - MIT
 - BSD-2-Clause
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -415,7 +213,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubygems_version: 3.0.3
-signing_key: 
+signing_key:
 specification_version: 4
 summary: Mocking and stubbing library
 test_files: []