mocha 1.4.0 → 1.7.0

data/lib/mocha/object_methods.rb

@@ -4,18 +4,20 @@ require 'mocha/argument_iterator'
 require 'mocha/expectation_error_factory'
 
 module Mocha
-
   # Methods added to all objects to allow mocking and stubbing on real (i.e. non-mock) objects.
   #
   # Both {#expects} and {#stubs} return an {Expectation} which can be further modified by methods on {Expectation}.
   module ObjectMethods
-
     # @private
     alias_method :_method, :method
 
     # @private
-    def mocha
-      @mocha ||= Mocha::Mockery.instance.mock_impersonating(self)
+    def mocha(instantiate = true)
+      if instantiate
+        @mocha ||= Mocha::Mockery.instance.mock_impersonating(self)
+      else
+        defined?(@mocha) ? @mocha : nil
+      end
     end
 
     # @private
@@ -71,14 +73,14 @@ module Mocha
       expectation = nil
       mockery = Mocha::Mockery.instance
       iterator = ArgumentIterator.new(expected_methods_vs_return_values)
-      iterator.each { |*args|
+      iterator.each do |*args|
         method_name = args.shift
         mockery.on_stubbing(self, method_name)
         method = stubba_method.new(stubba_object, method_name)
         mockery.stubba.stub(method)
         expectation = mocha.expects(method_name, caller)
-        expectation.returns(args.shift) if args.length > 0
-      }
+        expectation.returns(args.shift) unless args.empty?
+      end
       expectation
     end
 
@@ -117,14 +119,14 @@ module Mocha
       expectation = nil
       mockery = Mocha::Mockery.instance
       iterator = ArgumentIterator.new(stubbed_methods_vs_return_values)
-      iterator.each { |*args|
+      iterator.each do |*args|
         method_name = args.shift
         mockery.on_stubbing(self, method_name)
         method = stubba_method.new(stubba_object, method_name)
         mockery.stubba.stub(method)
         expectation = mocha.stubs(method_name, caller)
-        expectation.returns(args.shift) if args.length > 0
-      }
+        expectation.returns(args.shift) unless args.empty?
+      end
       expectation
     end
 
@@ -162,14 +164,12 @@ module Mocha
     # @private
     def method_exists?(method, include_public_methods = true)
       if include_public_methods
-        return true if public_methods(include_superclass_methods = true).include?(method)
+        return true if public_methods(true).include?(method)
         return true if respond_to?(method.to_sym)
       end
-      return true if protected_methods(include_superclass_methods = true).include?(method)
-      return true if private_methods(include_superclass_methods = true).include?(method)
-      return false
+      return true if protected_methods(true).include?(method)
+      return true if private_methods(true).include?(method)
+      false
     end
-
   end
-
 end

data/lib/mocha/parameter_matchers/all_of.rb

@@ -1,9 +1,7 @@
 require 'mocha/parameter_matchers/base'
 
 module Mocha
-
   module ParameterMatchers
-
     # Matches if all +matchers+ match.
     #
     # @param [*Array<Base>] parameter_matchers parameter matchers.
@@ -28,7 +26,6 @@ module Mocha
 
     # Parameter matcher which combines a number of other matchers using a logical AND.
     class AllOf < Base
-
       # @private
       def initialize(*matchers)
         @matchers = matchers
@@ -42,11 +39,8 @@ module Mocha
 
       # @private
       def mocha_inspect
-        "all_of(#{@matchers.map { |matcher| matcher.mocha_inspect }.join(", ") })"
+        "all_of(#{@matchers.map(&:mocha_inspect).join(', ')})"
       end
-
     end
-
   end
-
 end

data/lib/mocha/parameter_matchers/any_of.rb

@@ -1,9 +1,7 @@
 require 'mocha/parameter_matchers/base'
 
 module Mocha
-
   module ParameterMatchers
-
     # Matches if any +matchers+ match.
     #
     # @param [*Array<Base>] parameter_matchers parameter matchers.
@@ -34,7 +32,6 @@ module Mocha
 
     # Parameter matcher which combines a number of other matchers using a logical OR.
     class AnyOf < Base
-
       # @private
       def initialize(*matchers)
         @matchers = matchers
@@ -48,11 +45,8 @@ module Mocha
 
       # @private
       def mocha_inspect
-        "any_of(#{@matchers.map { |matcher| matcher.mocha_inspect }.join(", ") })"
+        "any_of(#{@matchers.map(&:mocha_inspect).join(', ')})"
       end
-
     end
-
   end
-
 end

data/lib/mocha/parameter_matchers/any_parameters.rb

@@ -1,9 +1,7 @@
 require 'mocha/parameter_matchers/base'
 
 module Mocha
-
   module ParameterMatchers
-
     # Matches any parameters. This is used as the default for a newly built expectation.
     #
     # @return [AnyParameters] parameter matcher.
@@ -26,22 +24,18 @@ module Mocha
 
     # Parameter matcher which always matches whatever the parameters.
     class AnyParameters < Base
-
       # @private
       def matches?(available_parameters)
-        while available_parameters.length > 0 do
+        until available_parameters.empty?
           available_parameters.shift
         end
-        return true
+        true
       end
 
       # @private
       def mocha_inspect
-        "any_parameters"
+        'any_parameters'
       end
-
     end
-
   end
-
 end

data/lib/mocha/parameter_matchers/anything.rb

@@ -1,9 +1,7 @@
 require 'mocha/parameter_matchers/base'
 
 module Mocha
-
   module ParameterMatchers
-
     # Matches any object.
     #
     # @return [Anything] parameter matcher.
@@ -23,20 +21,16 @@ module Mocha
 
     # Parameter matcher which always matches a single parameter.
     class Anything < Base
-
       # @private
       def matches?(available_parameters)
         available_parameters.shift
-        return true
+        true
       end
 
       # @private
       def mocha_inspect
-        "anything"
+        'anything'
       end
-
     end
-
   end
-
 end

data/lib/mocha/parameter_matchers/base.rb

@@ -1,10 +1,7 @@
 module Mocha
-
   module ParameterMatchers
-
     # @abstract Subclass and implement +#matches?+ and +#mocha_inspect+ to define a custom matcher. Also add a suitably named instance method to {ParameterMatchers} to build an instance of the new matcher c.f. {#equals}.
     class Base
-
       # @private
       def to_matcher
         self
@@ -16,7 +13,7 @@ module Mocha
       #
       # This shorthand will not work with an implicit equals match. Instead, an explicit {Equals} matcher should be used.
       #
-      # @param [Base] matcher parameter matcher.
+      # @param [Base] other parameter matcher.
       # @return [AllOf] parameter matcher.
       #
       # @see Expectation#with
@@ -30,8 +27,8 @@ module Mocha
       #
       #   object.expects(:run).with(has_key(:foo) & has_key(:bar))
       #   object.run(:foo => 'foovalue', :bar => 'barvalue)
-      def &(matcher)
-        AllOf.new(self, matcher)
+      def &(other)
+        AllOf.new(self, other)
       end
 
       # A shorthand way of combining two matchers when at least one must match.
@@ -40,7 +37,7 @@ module Mocha
       #
       # This shorthand will not work with an implicit equals match. Instead, an explicit {Equals} matcher should be used.
       #
-      # @param [Base] matcher parameter matcher.
+      # @param [Base] other parameter matcher.
       # @return [AnyOf] parameter matcher.
       #
       # @see Expectation#with
@@ -60,12 +57,9 @@ module Mocha
       #   object.run(1) # passes
       #   object.run(2) # passes
       #   object.run(3) # fails
-      def |(matcher)
-        AnyOf.new(self, matcher)
+      def |(other)
+        AnyOf.new(self, other)
       end
-
     end
-
   end
-
 end

data/lib/mocha/parameter_matchers/equals.rb

@@ -1,9 +1,7 @@
 require 'mocha/parameter_matchers/base'
 
 module Mocha
-
   module ParameterMatchers
-
     # Matches any +Object+ equalling +value+.
     #
     # @param [Object] value expected value.
@@ -29,7 +27,6 @@ module Mocha
 
     # Parameter matcher which matches when actual parameter equals expected value.
     class Equals < Base
-
       # @private
       def initialize(value)
         @value = value
@@ -45,9 +42,6 @@ module Mocha
       def mocha_inspect
         @value.mocha_inspect
       end
-
     end
-
   end
-
 end

data/lib/mocha/parameter_matchers/equivalent_uri.rb

@@ -5,7 +5,6 @@ require 'cgi'
 
 module Mocha
   module ParameterMatchers
-
     # Matches a URI without regard to the ordering of parameters in the query string.
     #
     # @param [String] uri URI to match.
@@ -29,15 +28,16 @@ module Mocha
     end
 
     # @deprecated Use {#equivalent_uri} instead.
+    # rubocop:disable Naming/PredicateName
     def has_equivalent_query_string(uri)
-      Mocha::Deprecation.warning("`has_equivalent_query_string` is deprecated. Please use `equivalent_uri` instead.")
+      Mocha::Deprecation.warning('`has_equivalent_query_string` is deprecated. Please use `equivalent_uri` instead.')
 
       equivalent_uri(uri)
     end
+    # rubocop:enable Naming/PredicateName
 
     # Parameter matcher which matches URIs with equivalent query strings.
     class EquivalentUri < Base
-
       # @private
       def initialize(uri)
         @uri = URI.parse(uri)
@@ -55,13 +55,13 @@ module Mocha
         "equivalent_uri(#{@uri.mocha_inspect})"
       end
 
-    private
+      private
+
       # @private
       def explode(uri)
         query_hash = CGI.parse(uri.query || '')
-        URI::Generic::COMPONENT.inject({}){ |h, k| h.merge(k => uri.__send__(k)) }.merge(:query => query_hash)
+        URI::Generic::COMPONENT.inject({}) { |h, k| h.merge(k => uri.__send__(k)) }.merge(:query => query_hash)
       end
-
     end
   end
 end

data/lib/mocha/parameter_matchers/has_entries.rb

@@ -3,9 +3,7 @@ require 'mocha/parameter_matchers/all_of'
 require 'mocha/parameter_matchers/has_entry'
 
 module Mocha
-
   module ParameterMatchers
-
     # Matches +Hash+ containing all +entries+.
     #
     # @param [Hash] entries expected +Hash+ entries.
@@ -24,13 +22,14 @@ module Mocha
     #   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
+    # rubocop:disable Naming/PredicateName
     def has_entries(entries)
       HasEntries.new(entries)
     end
+    # rubocop:enable Naming/PredicateName
 
     # Parameter matcher which matches when actual parameter contains all expected +Hash+ entries.
     class HasEntries < Base
-
       # @private
       def initialize(entries)
         @entries = entries
@@ -47,9 +46,6 @@ module Mocha
       def mocha_inspect
         "has_entries(#{@entries.mocha_inspect})"
       end
-
     end
-
   end
-
 end

data/lib/mocha/parameter_matchers/has_entry.rb

@@ -1,9 +1,7 @@
 require 'mocha/parameter_matchers/base'
 
 module Mocha
-
   module ParameterMatchers
-
     # Matches +Hash+ containing entry with +key+ and +value+.
     #
     # @overload def has_entry(key, value)
@@ -41,6 +39,7 @@ module Mocha
     #   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
+    # rubocop:disable Naming/PredicateName
     def has_entry(*options)
       case options.length
       when 1
@@ -48,29 +47,30 @@ module Mocha
         when Hash
           case options[0].length
           when 0
-            raise ArgumentError.new("Argument has no entries.")
+            raise ArgumentError, 'Argument has no entries.'
           when 1
             key, value = options[0].first
           else
-            raise ArgumentError.new("Argument has multiple entries. Use Mocha::ParameterMatchers#has_entries instead.")
+            raise ArgumentError, 'Argument has multiple entries. Use Mocha::ParameterMatchers#has_entries instead.'
           end
         else
-          raise ArgumentError.new("Argument is not a Hash.")
+          raise ArgumentError, 'Argument is not a Hash.'
         end
       when 2
         key, value = options
       else
-        raise ArgumentError.new("Too many arguments; use either a single argument (must be a Hash) or two arguments (a key and a value).")
+        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
+    # rubocop:enable Naming/PredicateName
 
     # Parameter matcher which matches when actual parameter contains expected +Hash+ entry.
     class HasEntry < Base
-
       # @private
       def initialize(key, value)
-        @key, @value = key, value
+        @key = key
+        @value = value
       end
 
       # @private
@@ -85,9 +85,6 @@ module Mocha
       def mocha_inspect
         "has_entry(#{@key.mocha_inspect} => #{@value.mocha_inspect})"
       end
-
     end
-
   end
-
 end

data/lib/mocha/parameter_matchers/has_key.rb

@@ -1,9 +1,7 @@
 require 'mocha/parameter_matchers/base'
 
 module Mocha
-
   module ParameterMatchers
-
     # Matches +Hash+ containing +key+.
     #
     # @param [Object] key expected key.
@@ -22,13 +20,14 @@ module Mocha
     #   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'
+    # rubocop:disable Naming/PredicateName
     def has_key(key)
       HasKey.new(key)
     end
+    # rubocop:enable Naming/PredicateName
 
     # Parameter matcher which matches when actual parameter contains +Hash+ entry with expected key.
     class HasKey < Base
-
       # @private
       def initialize(key)
         @key = key
@@ -45,9 +44,6 @@ module Mocha
       def mocha_inspect
         "has_key(#{@key.mocha_inspect})"
       end
-
     end
-
   end
-
 end

data/lib/mocha/parameter_matchers/has_value.rb

@@ -1,9 +1,7 @@
 require 'mocha/parameter_matchers/base'
 
 module Mocha
-
   module ParameterMatchers
-
     # Matches +Hash+ containing +value+.
     #
     # @param [Object] value expected value.
@@ -22,13 +20,14 @@ module Mocha
     #   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
+    # rubocop:disable Naming/PredicateName
     def has_value(value)
       HasValue.new(value)
     end
+    # rubocop:enable Naming/PredicateName
 
     # Parameter matcher which matches when actual parameter contains +Hash+ entry with expected value.
     class HasValue < Base
-
       # @private
       def initialize(value)
         @value = value
@@ -45,9 +44,6 @@ module Mocha
       def mocha_inspect
         "has_value(#{@value.mocha_inspect})"
       end
-
     end
-
   end
-
 end

data/lib/mocha/parameter_matchers/includes.rb

@@ -2,9 +2,7 @@ require 'mocha/parameter_matchers/all_of'
 require 'mocha/parameter_matchers/base'
 
 module Mocha
-
   module ParameterMatchers
-
     # Matches any object that responds with +true+ to +include?(item)+
     # for all items.
     #
@@ -68,7 +66,6 @@ module Mocha
 
     # Parameter matcher which matches when actual parameter includes expected values.
     class Includes < Base
-
       # @private
       def initialize(*items)
         @items = items
@@ -79,12 +76,14 @@ module Mocha
         parameter = available_parameters.shift
         return false unless parameter.respond_to?(:include?)
         if @items.size == 1
+          # rubocop:disable Style/GuardClause
           if parameter.respond_to?(:any?) && !parameter.is_a?(String)
             parameter = parameter.keys if parameter.is_a?(Hash)
             return parameter.any? { |p| @items.first.to_matcher.matches?([p]) }
           else
             return parameter.include?(@items.first)
           end
+          # rubocop:enable Style/GuardClause
         else
           includes_matchers = @items.map { |item| Includes.new(item) }
           AllOf.new(*includes_matchers).matches?([parameter])
@@ -96,9 +95,6 @@ module Mocha
         item_descriptions = @items.map(&:mocha_inspect)
         "includes(#{item_descriptions.join(', ')})"
       end
-
     end
-
   end
-
 end

data/lib/mocha/parameter_matchers/instance_of.rb

@@ -1,9 +1,7 @@
 require 'mocha/parameter_matchers/base'
 
 module Mocha
-
   module ParameterMatchers
-
     # Matches any object that is an instance of +klass+
     #
     # @param [Class] klass expected class.
@@ -29,7 +27,6 @@ module Mocha
 
     # Parameter matcher which matches when actual parameter is an instance of the specified class.
     class InstanceOf < Base
-
       # @private
       def initialize(klass)
         @klass = klass
@@ -45,9 +42,6 @@ module Mocha
       def mocha_inspect
         "instance_of(#{@klass.mocha_inspect})"
       end
-
     end
-
   end
-
 end

data/lib/mocha/parameter_matchers/is_a.rb

@@ -1,9 +1,7 @@
 require 'mocha/parameter_matchers/base'
 
 module Mocha
-
   module ParameterMatchers
-
     # Matches any object that is a +klass+.
     #
     # @param [Class] klass expected class.
@@ -23,13 +21,14 @@ module Mocha
     #   object.expects(:method_1).with(is_a(Integer))
     #   object.method_1('string')
     #   # error raised, because method_1 was not called with an Integer
+    # rubocop:disable Naming/PredicateName
     def is_a(klass)
       IsA.new(klass)
     end
+    # rubocop:enable Naming/PredicateName
 
     # Parameter matcher which matches when actual parameter is a specific class.
     class IsA < Base
-
       # @private
       def initialize(klass)
         @klass = klass
@@ -45,9 +44,6 @@ module Mocha
       def mocha_inspect
         "is_a(#{@klass.mocha_inspect})"
       end
-
     end
-
   end
-
 end

data/lib/mocha/parameter_matchers/kind_of.rb

@@ -1,9 +1,7 @@
 require 'mocha/parameter_matchers/base'
 
 module Mocha
-
   module ParameterMatchers
-
     # Matches any +Object+ that is a kind of +klass+.
     #
     # @param [Class] klass expected class.
@@ -29,7 +27,6 @@ module Mocha
 
     # Parameter matcher which matches when actual parameter is a kind of specified class.
     class KindOf < Base
-
       # @private
       def initialize(klass)
         @klass = klass
@@ -38,16 +35,15 @@ module Mocha
       # @private
       def matches?(available_parameters)
         parameter = available_parameters.shift
+        # rubocop:disable Style/ClassCheck
         parameter.kind_of?(@klass)
+        # rubocop:enable Style/ClassCheck
       end
 
       # @private
       def mocha_inspect
         "kind_of(#{@klass.mocha_inspect})"
       end
-
     end
-
   end
-
 end

data/lib/mocha/parameter_matchers/not.rb

@@ -1,9 +1,7 @@
 require 'mocha/parameter_matchers/base'
 
 module Mocha
-
   module ParameterMatchers
-
     # Matches if +matcher+ does *not* match.
     #
     # @param [Base] matcher matcher whose logic to invert.
@@ -22,13 +20,14 @@ module Mocha
     #   object.expects(:method_1).with(Not(includes(1)))
     #   object.method_1([0, 1, 2, 3])
     #   # error raised, because method_1 was not called with object not including 1
+    # rubocop:disable Naming/MethodName
     def Not(matcher)
       Not.new(matcher)
     end
+    # rubocop:enable Naming/MethodName
 
     # Parameter matcher which inverts the logic of the specified matcher using a logical NOT operation.
     class Not < Base
-
       # @private
       def initialize(matcher)
         @matcher = matcher
@@ -44,9 +43,6 @@ module Mocha
       def mocha_inspect
         "Not(#{@matcher.mocha_inspect})"
       end
-
     end
-
   end
-
 end