mocha 2.8.2 → 3.0.0.pre.rc.1

data/lib/mocha/parameter_matchers/equals.rb

@@ -1,38 +1,35 @@
+# frozen_string_literal: true
+
 require 'mocha/parameter_matchers/base'
-require 'mocha/parameter_matchers/deprecations'
 
 module Mocha
   module ParameterMatchers
-    module Methods
-      # Matches any +Object+ equalling +value+.
-      #
-      # @param [Object] value expected value.
-      # @return [Equals] parameter matcher.
-      #
-      # @see Expectation#with
-      # @see Object#==
-      #
-      # @example Actual parameter equals expected parameter.
-      #   object = mock()
-      #   object.expects(:method_1).with(equals(2))
-      #   object.method_1(2)
-      #   # no error raised
-      #
-      # @example Actual parameter does not equal expected parameter.
-      #   object = mock()
-      #   object.expects(:method_1).with(equals(2))
-      #   object.method_1(3)
-      #   # error raised, because method_1 was not called with an +Object+ that equals 2
-      def equals(value)
-        Equals.new(value)
-      end
+    # Matches any +Object+ equalling +value+.
+    #
+    # @param [Object] value expected value.
+    # @return [Equals] parameter matcher.
+    #
+    # @see Expectation#with
+    # @see Object#==
+    #
+    # @example Actual parameter equals expected parameter.
+    #   object = mock()
+    #   object.expects(:method_1).with(equals(2))
+    #   object.method_1(2)
+    #   # no error raised
+    #
+    # @example Actual parameter does not equal expected parameter.
+    #   object = mock()
+    #   object.expects(:method_1).with(equals(2))
+    #   object.method_1(3)
+    #   # error raised, because method_1 was not called with an +Object+ that equals 2
+    def equals(value)
+      Equals.new(value)
     end
 
-    define_deprecated_matcher_method(:equals)
-
     # Parameter matcher which matches when actual parameter equals expected value.
     class Equals
-      include BaseMethods
+      include Base
 
       # @private
       def initialize(value)
@@ -50,7 +47,5 @@ module Mocha
         @value.mocha_inspect
       end
     end
-
-    provide_deprecated_access_to(:Equals)
   end
 end

data/lib/mocha/parameter_matchers/equivalent_uri.rb

@@ -1,39 +1,36 @@
+# frozen_string_literal: true
+
 require 'mocha/parameter_matchers/base'
-require 'mocha/parameter_matchers/deprecations'
 require 'uri'
 require 'cgi'
 
 module Mocha
   module ParameterMatchers
-    module Methods
-      # Matches a URI without regard to the ordering of parameters in the query string.
-      #
-      # @param [String] uri URI to match.
-      # @return [EquivalentUri] parameter matcher.
-      #
-      # @see Expectation#with
-      #
-      # @example Actual URI is equivalent.
-      #   object = mock()
-      #   object.expects(:method_1).with(equivalent_uri('http://example.com/foo?a=1&b=2))
-      #   object.method_1('http://example.com/foo?b=2&a=1')
-      #   # no error raised
-      #
-      # @example Actual URI is not equivalent.
-      #   object = mock()
-      #   object.expects(:method_1).with(equivalent_uri('http://example.com/foo?a=1&b=2))
-      #   object.method_1('http://example.com/foo?a=1&b=3')
-      #   # error raised, because the query parameters were different
-      def equivalent_uri(uri)
-        EquivalentUri.new(uri)
-      end
+    # Matches a URI without regard to the ordering of parameters in the query string.
+    #
+    # @param [String] uri URI to match.
+    # @return [EquivalentUri] parameter matcher.
+    #
+    # @see Expectation#with
+    #
+    # @example Actual URI is equivalent.
+    #   object = mock()
+    #   object.expects(:method_1).with(equivalent_uri('http://example.com/foo?a=1&b=2))
+    #   object.method_1('http://example.com/foo?b=2&a=1')
+    #   # no error raised
+    #
+    # @example Actual URI is not equivalent.
+    #   object = mock()
+    #   object.expects(:method_1).with(equivalent_uri('http://example.com/foo?a=1&b=2))
+    #   object.method_1('http://example.com/foo?a=1&b=3')
+    #   # error raised, because the query parameters were different
+    def equivalent_uri(uri)
+      EquivalentUri.new(uri)
     end
 
-    define_deprecated_matcher_method(:equivalent_uri)
-
     # Parameter matcher which matches URIs with equivalent query strings.
     class EquivalentUri
-      include BaseMethods
+      include Base
 
       # @private
       def initialize(uri)
@@ -60,7 +57,5 @@ module Mocha
         URI::Generic::COMPONENT.inject({}) { |h, k| h.merge(k => uri.__send__(k)) }.merge(query: query_hash)
       end
     end
-
-    provide_deprecated_access_to(:EquivalentUri)
   end
 end

data/lib/mocha/parameter_matchers/has_entries.rb

@@ -1,40 +1,37 @@
+# frozen_string_literal: true
+
 require 'mocha/parameter_matchers/base'
 require 'mocha/parameter_matchers/all_of'
 require 'mocha/parameter_matchers/has_entry'
-require 'mocha/parameter_matchers/deprecations'
 
 module Mocha
   module ParameterMatchers
-    module Methods
-      # Matches +Hash+ containing all +entries+.
-      #
-      # @param [Hash] entries expected +Hash+ entries.
-      # @return [HasEntries] parameter matcher.
-      #
-      # @see Expectation#with
-      #
-      # @example Actual parameter contains all expected entries.
-      #   object = mock()
-      #   object.expects(:method_1).with(has_entries('key_1' => 1, 'key_2' => 2))
-      #   object.method_1('key_1' => 1, 'key_2' => 2, 'key_3' => 3)
-      #   # no error raised
-      #
-      # @example Actual parameter does not contain all expected entries.
-      #   object = mock()
-      #   object.expects(:method_1).with(has_entries('key_1' => 1, 'key_2' => 2))
-      #   object.method_1('key_1' => 1, 'key_2' => 99)
-      #   # error raised, because method_1 was not called with Hash containing entries: 'key_1' => 1, 'key_2' => 2
-      #
-      def has_entries(entries) # rubocop:disable Naming/PredicateName
-        HasEntries.new(entries)
-      end
+    # Matches +Hash+ containing all +entries+.
+    #
+    # @param [Hash] entries expected +Hash+ entries.
+    # @return [HasEntries] parameter matcher.
+    #
+    # @see Expectation#with
+    #
+    # @example Actual parameter contains all expected entries.
+    #   object = mock()
+    #   object.expects(:method_1).with(has_entries('key_1' => 1, 'key_2' => 2))
+    #   object.method_1('key_1' => 1, 'key_2' => 2, 'key_3' => 3)
+    #   # no error raised
+    #
+    # @example Actual parameter does not contain all expected entries.
+    #   object = mock()
+    #   object.expects(:method_1).with(has_entries('key_1' => 1, 'key_2' => 2))
+    #   object.method_1('key_1' => 1, 'key_2' => 99)
+    #   # error raised, because method_1 was not called with Hash containing entries: 'key_1' => 1, 'key_2' => 2
+    #
+    def has_entries(entries) # rubocop:disable Naming/PredicateName
+      HasEntries.new(entries)
     end
 
-    define_deprecated_matcher_method(:has_entries)
-
     # Parameter matcher which matches when actual parameter contains all expected +Hash+ entries.
     class HasEntries
-      include BaseMethods
+      include Base
 
       # @private
       def initialize(entries, exact: false)
@@ -58,7 +55,5 @@ module Mocha
         @exact ? @entries.mocha_inspect : "has_entries(#{@entries.mocha_inspect})"
       end
     end
-
-    provide_deprecated_access_to(:HasEntries)
   end
 end

data/lib/mocha/parameter_matchers/has_entry.rb

@@ -1,67 +1,64 @@
+# frozen_string_literal: true
+
 require 'mocha/parameter_matchers/base'
-require 'mocha/parameter_matchers/deprecations'
 
 module Mocha
   module ParameterMatchers
-    module Methods
-      # Matches +Hash+ containing entry with +key+ and +value+.
-      #
-      # @overload def has_entry(key, value)
-      #   @param [Object] key key for entry.
-      #   @param [Object] value value for entry.
-      # @overload def has_entry(single_entry_hash)
-      #   @param [Hash] single_entry_hash +Hash+ with single entry.
-      #   @raise [ArgumentError] if +single_entry_hash+ does not contain exactly one entry.
-      #
-      # @return [HasEntry] parameter matcher.
-      #
-      # @see Expectation#with
-      #
-      # @example Actual parameter contains expected entry supplied as key and value.
-      #   object = mock()
-      #   object.expects(:method_1).with(has_entry('key_1', 1))
-      #   object.method_1('key_1' => 1, 'key_2' => 2)
-      #   # no error raised
-      #
-      # @example Actual parameter contains expected entry supplied as +Hash+ entry.
-      #   object = mock()
-      #   object.expects(:method_1).with(has_entry('key_1' => 1))
-      #   object.method_1('key_1' => 1, 'key_2' => 2)
-      #   # no error raised
-      #
-      # @example Actual parameter does not contain expected entry supplied as key and value.
-      #   object = mock()
-      #   object.expects(:method_1).with(has_entry('key_1', 1))
-      #   object.method_1('key_1' => 2, 'key_2' => 1)
-      #   # error raised, because method_1 was not called with Hash containing entry: 'key_1' => 1
-      #
-      # @example Actual parameter does not contain expected entry supplied as +Hash+ entry.
-      #
-      #   object = mock()
-      #   object.expects(:method_1).with(has_entry('key_1' => 1))
-      #   object.method_1('key_1' => 2, 'key_2' => 1)
-      #   # error raised, because method_1 was not called with Hash containing entry: 'key_1' => 1
-      #
-      def has_entry(*options) # rubocop:disable Naming/PredicateName
-        case options.length
-        when 0
-          raise ArgumentError, 'No arguments. Expecting at least one.'
-        when 1
-          key, value = HasEntry.parse_option(options[0])
-        when 2
-          key, value = options
-        else
-          raise ArgumentError, 'Too many arguments; use either a single argument (must be a Hash) or two arguments (a key and a value).'
-        end
-        HasEntry.new(key, value)
+    # Matches +Hash+ containing entry with +key+ and +value+.
+    #
+    # @overload def has_entry(key, value)
+    #   @param [Object] key key for entry.
+    #   @param [Object] value value for entry.
+    # @overload def has_entry(single_entry_hash)
+    #   @param [Hash] single_entry_hash +Hash+ with single entry.
+    #   @raise [ArgumentError] if +single_entry_hash+ does not contain exactly one entry.
+    #
+    # @return [HasEntry] parameter matcher.
+    #
+    # @see Expectation#with
+    #
+    # @example Actual parameter contains expected entry supplied as key and value.
+    #   object = mock()
+    #   object.expects(:method_1).with(has_entry('key_1', 1))
+    #   object.method_1('key_1' => 1, 'key_2' => 2)
+    #   # no error raised
+    #
+    # @example Actual parameter contains expected entry supplied as +Hash+ entry.
+    #   object = mock()
+    #   object.expects(:method_1).with(has_entry('key_1' => 1))
+    #   object.method_1('key_1' => 1, 'key_2' => 2)
+    #   # no error raised
+    #
+    # @example Actual parameter does not contain expected entry supplied as key and value.
+    #   object = mock()
+    #   object.expects(:method_1).with(has_entry('key_1', 1))
+    #   object.method_1('key_1' => 2, 'key_2' => 1)
+    #   # error raised, because method_1 was not called with Hash containing entry: 'key_1' => 1
+    #
+    # @example Actual parameter does not contain expected entry supplied as +Hash+ entry.
+    #
+    #   object = mock()
+    #   object.expects(:method_1).with(has_entry('key_1' => 1))
+    #   object.method_1('key_1' => 2, 'key_2' => 1)
+    #   # error raised, because method_1 was not called with Hash containing entry: 'key_1' => 1
+    #
+    def has_entry(*options) # rubocop:disable Naming/PredicateName
+      case options.length
+      when 0
+        raise ArgumentError, 'No arguments. Expecting at least one.'
+      when 1
+        key, value = parse_option(options[0])
+      when 2
+        key, value = options
+      else
+        raise ArgumentError, 'Too many arguments; use either a single argument (must be a Hash) or two arguments (a key and a value).'
       end
+      HasEntry.new(key, value)
     end
 
-    define_deprecated_matcher_method(:has_entry)
-
     # Parameter matcher which matches when actual parameter contains expected +Hash+ entry.
     class HasEntry
-      include BaseMethods
+      include Base
 
       # @private
       def initialize(key, value)
@@ -73,6 +70,7 @@ module Mocha
       def matches?(available_parameters)
         parameter = available_parameters.shift
         return false unless parameter.respond_to?(:keys) && parameter.respond_to?(:[])
+
         matching_keys = parameter.keys.select { |key| @key.to_matcher.matches?([key]) }
         matching_keys.any? { |key| @value.to_matcher.matches?([parameter[key]]) }
       end
@@ -81,25 +79,25 @@ module Mocha
       def mocha_inspect
         "has_entry(#{@key.mocha_inspect} => #{@value.mocha_inspect})"
       end
+    end
 
-      # @private
-      def self.parse_option(option)
-        case option
-        when Hash
-          case option.length
-          when 0
-            raise ArgumentError, 'Argument has no entries.'
-          when 1
-            option.first
-          else
-            raise ArgumentError, 'Argument has multiple entries. Use Mocha::ParameterMatchers#has_entries instead.'
-          end
+    private
+
+    # @private
+    def parse_option(option)
+      case option
+      when Hash
+        case option.length
+        when 0
+          raise ArgumentError, 'Argument has no entries.'
+        when 1
+          option.first
         else
-          raise ArgumentError, 'Argument is not a Hash.'
+          raise ArgumentError, 'Argument has multiple entries. Use Mocha::ParameterMatchers#has_entries instead.'
         end
+      else
+        raise ArgumentError, 'Argument is not a Hash.'
       end
     end
-
-    provide_deprecated_access_to(:HasEntry)
   end
 end

data/lib/mocha/parameter_matchers/has_key.rb

@@ -1,38 +1,35 @@
+# frozen_string_literal: true
+
 require 'mocha/parameter_matchers/base'
-require 'mocha/parameter_matchers/deprecations'
 
 module Mocha
   module ParameterMatchers
-    module Methods
-      # Matches +Hash+ containing +key+.
-      #
-      # @param [Object] key expected key.
-      # @return [HasKey] parameter matcher.
-      #
-      # @see Expectation#with
-      #
-      # @example Actual parameter contains entry with expected key.
-      #   object = mock()
-      #   object.expects(:method_1).with(has_key('key_1'))
-      #   object.method_1('key_1' => 1, 'key_2' => 2)
-      #   # no error raised
-      #
-      # @example Actual parameter does not contain entry with expected key.
-      #   object = mock()
-      #   object.expects(:method_1).with(has_key('key_1'))
-      #   object.method_1('key_2' => 2)
-      #   # error raised, because method_1 was not called with Hash containing key: 'key_1'
-      #
-      def has_key(key) # rubocop:disable Naming/PredicateName
-        HasKey.new(key)
-      end
+    # Matches +Hash+ containing +key+.
+    #
+    # @param [Object] key expected key.
+    # @return [HasKey] parameter matcher.
+    #
+    # @see Expectation#with
+    #
+    # @example Actual parameter contains entry with expected key.
+    #   object = mock()
+    #   object.expects(:method_1).with(has_key('key_1'))
+    #   object.method_1('key_1' => 1, 'key_2' => 2)
+    #   # no error raised
+    #
+    # @example Actual parameter does not contain entry with expected key.
+    #   object = mock()
+    #   object.expects(:method_1).with(has_key('key_1'))
+    #   object.method_1('key_2' => 2)
+    #   # error raised, because method_1 was not called with Hash containing key: 'key_1'
+    #
+    def has_key(key) # rubocop:disable Naming/PredicateName
+      HasKey.new(key)
     end
 
-    define_deprecated_matcher_method(:has_key)
-
     # Parameter matcher which matches when actual parameter contains +Hash+ entry with expected key.
     class HasKey
-      include BaseMethods
+      include Base
 
       # @private
       def initialize(key)
@@ -43,6 +40,7 @@ module Mocha
       def matches?(available_parameters)
         parameter = available_parameters.shift
         return false unless parameter.respond_to?(:keys)
+
         parameter.keys.any? { |key| @key.to_matcher.matches?([key]) }
       end
 
@@ -51,7 +49,5 @@ module Mocha
         "has_key(#{@key.mocha_inspect})"
       end
     end
-
-    provide_deprecated_access_to(:HasKey)
   end
 end

data/lib/mocha/parameter_matchers/has_keys.rb

@@ -1,38 +1,35 @@
+# frozen_string_literal: true
+
 require 'mocha/parameter_matchers/base'
-require 'mocha/parameter_matchers/deprecations'
 
 module Mocha
   module ParameterMatchers
-    module Methods
-      # Matches +Hash+ containing +keys+.
-      #
-      # @param [*Array<Object>] keys expected keys.
-      # @return [HasKeys] parameter matcher.
-      #
-      # @see Expectation#with
-      #
-      # @example Actual parameter contains entry with expected keys.
-      #   object = mock()
-      #   object.expects(:method_1).with(has_keys(:key_1, :key_2))
-      #   object.method_1(:key_1 => 1, :key_2 => 2, :key_3 => 3)
-      #   # no error raised
-      #
-      # @example Actual parameter does not contain all expected keys.
-      #   object = mock()
-      #   object.expects(:method_1).with(has_keys(:key_1, :key_2))
-      #   object.method_1(:key_2 => 2)
-      #   # error raised, because method_1 was not called with Hash containing key: :key_1
-      #
-      def has_keys(*keys) # rubocop:disable Naming/PredicateName
-        HasKeys.new(*keys)
-      end
+    # Matches +Hash+ containing +keys+.
+    #
+    # @param [*Array<Object>] keys expected keys.
+    # @return [HasKeys] parameter matcher.
+    #
+    # @see Expectation#with
+    #
+    # @example Actual parameter contains entry with expected keys.
+    #   object = mock()
+    #   object.expects(:method_1).with(has_keys(:key_1, :key_2))
+    #   object.method_1(:key_1 => 1, :key_2 => 2, :key_3 => 3)
+    #   # no error raised
+    #
+    # @example Actual parameter does not contain all expected keys.
+    #   object = mock()
+    #   object.expects(:method_1).with(has_keys(:key_1, :key_2))
+    #   object.method_1(:key_2 => 2)
+    #   # error raised, because method_1 was not called with Hash containing key: :key_1
+    #
+    def has_keys(*keys) # rubocop:disable Naming/PredicateName
+      HasKeys.new(*keys)
     end
 
-    define_deprecated_matcher_method(:has_keys)
-
     # Parameter matcher which matches when actual parameter contains +Hash+ with all expected keys.
     class HasKeys
-      include BaseMethods
+      include Base
 
       # @private
       def initialize(*keys)
@@ -53,10 +50,8 @@ module Mocha
 
       # @private
       def mocha_inspect
-        "has_keys(#{@keys.mocha_inspect(false)})"
+        "has_keys(#{@keys.mocha_inspect(wrapped: false)})"
       end
     end
-
-    provide_deprecated_access_to(:HasKeys)
   end
 end

data/lib/mocha/parameter_matchers/has_value.rb

@@ -1,38 +1,35 @@
+# frozen_string_literal: true
+
 require 'mocha/parameter_matchers/base'
-require 'mocha/parameter_matchers/deprecations'
 
 module Mocha
   module ParameterMatchers
-    module Methods
-      # Matches +Hash+ containing +value+.
-      #
-      # @param [Object] value expected value.
-      # @return [HasValue] parameter matcher.
-      #
-      # @see Expectation#with
-      #
-      # @example Actual parameter contains entry with expected value.
-      #   object = mock()
-      #   object.expects(:method_1).with(has_value(1))
-      #   object.method_1('key_1' => 1, 'key_2' => 2)
-      #   # no error raised
-      #
-      # @example Actual parameter does not contain entry with expected value.
-      #   object = mock()
-      #   object.expects(:method_1).with(has_value(1))
-      #   object.method_1('key_2' => 2)
-      #   # error raised, because method_1 was not called with Hash containing value: 1
-      #
-      def has_value(value) # rubocop:disable Naming/PredicateName
-        HasValue.new(value)
-      end
+    # Matches +Hash+ containing +value+.
+    #
+    # @param [Object] value expected value.
+    # @return [HasValue] parameter matcher.
+    #
+    # @see Expectation#with
+    #
+    # @example Actual parameter contains entry with expected value.
+    #   object = mock()
+    #   object.expects(:method_1).with(has_value(1))
+    #   object.method_1('key_1' => 1, 'key_2' => 2)
+    #   # no error raised
+    #
+    # @example Actual parameter does not contain entry with expected value.
+    #   object = mock()
+    #   object.expects(:method_1).with(has_value(1))
+    #   object.method_1('key_2' => 2)
+    #   # error raised, because method_1 was not called with Hash containing value: 1
+    #
+    def has_value(value) # rubocop:disable Naming/PredicateName
+      HasValue.new(value)
     end
 
-    define_deprecated_matcher_method(:has_value)
-
     # Parameter matcher which matches when actual parameter contains +Hash+ entry with expected value.
     class HasValue
-      include BaseMethods
+      include Base
 
       # @private
       def initialize(value)
@@ -43,6 +40,7 @@ module Mocha
       def matches?(available_parameters)
         parameter = available_parameters.shift
         return false unless parameter.respond_to?(:values)
+
         parameter.values.any? { |value| @value.to_matcher.matches?([value]) }
       end
 
@@ -51,7 +49,5 @@ module Mocha
         "has_value(#{@value.mocha_inspect})"
       end
     end
-
-    provide_deprecated_access_to(:HasValue)
   end
 end