sinclair 1.6.2 → 1.6.7

data/lib/sinclair/matchers/add_method.rb

@@ -3,43 +3,26 @@
 class Sinclair
   module Matchers
     # @api private
-    # @author darthjee
-    # @abstract
     #
-    # Base class for add_method matcher
-    class AddMethod < RSpec::Matchers::BuiltIn::BaseMatcher
-      # @param method [String,Symbol] the method, to be checked, name
-      def initialize(method)
-        @method = method.to_sym
-      end
-
-      # definition needed for block matchers
+    # Commone methods for matchers
+    module AddMethod
+      # @api public
       #
-      # @return [Boolean]
-      def supports_block_expectations?
-        true
-      end
-
-      # Checkes if another instnce is equal self
+      # Builds final matcher
       #
-      # @return [Boolean]
-      def equal?(other)
-        return unless other.class == self.class
-
-        other.method == method
+      # @return [Sinclair::Matchers::Base]
+      def to(target = nil)
+        add_method_to_class.new(target, method_name)
       end
 
-      alias == equal?
-
-      protected
-
-      # @method method
-      # @private
+      # @abstract
       #
-      # The method, to be checked, name
+      # Raise a warning on the usage as this is only a builder
       #
-      # @return [Symbol]
-      attr_reader :method
+      # @raise SyntaxError
+      def matches?(_actual)
+        raise SyntaxError, matcher_error
+      end
     end
   end
 end

data/lib/sinclair/matchers/add_method_to.rb

@@ -7,49 +7,8 @@ class Sinclair
     # @abstract
     #
     # Base class for add_method_to matcher
-    class AddMethodTo < RSpec::Matchers::BuiltIn::BaseMatcher
-      # @param method [SYmbol,String] method name
-      def initialize(method)
-        @method = method
-      end
-
-      # Checks if expectation is true or not
-      #
-      # @return [Boolean] expectation check
-      def matches?(event_proc)
-        return false unless event_proc.is_a?(Proc)
-
-        raise_block_syntax_error if block_given?
-        perform_change(event_proc)
-        added?
-      end
-
-      # definition needed for block matchers
-      def supports_block_expectations?
-        true
-      end
-
-      # Checkes if another instnce is equal self
-      #
-      # @return [Boolean]
-      def equal?(other)
-        return unless other.class == self.class
-
-        other.method == method &&
-          other.klass == klass
-      end
-
-      alias == equal?
-
-      protected
-
-      # @method method
-      # @private
-      #
-      # The method, to be checked, name
-      #
-      # @return [Symbol]
-      attr_reader :method
+    class AddMethodTo < Base
+      include MethodTo
 
       private
 
@@ -58,19 +17,8 @@ class Sinclair
       # Checks if a method was added (didn't exist before)
       #
       # @return Boolean
-      def added?
-        !@initial_state && @final_state
-      end
-
-      # @private
-      #
-      # Call block to check if it aded a method or not
-      #
-      # @return [Boolan]
-      def perform_change(event_proc)
-        @initial_state = method_defined?
-        event_proc.call
-        @final_state = method_defined?
+      def check
+        !initial_state && final_state
       end
     end
   end

data/lib/sinclair/matchers/base.rb

@@ -0,0 +1,45 @@
+# frozen_string_literal: true
+
+class Sinclair
+  module Matchers
+    # @abstract
+    # @api private
+    #
+    # Base class for all matchers
+    class Base < RSpec::Matchers::BuiltIn::BaseMatcher
+      # @param method_name [String,Symbol] the method, to be checked, name
+      def initialize(method_name)
+        @method_name = method_name.to_sym
+      end
+
+      # definition needed for block matchers
+      #
+      # @return [Boolean]
+      def supports_block_expectations?
+        true
+      end
+
+      # Checkes if another instnce is equal self
+      #
+      # @return [Boolean]
+      def equal?(other)
+        return unless other.class == self.class
+
+        other.method_name == method_name &&
+          other.try(:klass) == try(:klass)
+      end
+
+      alias == equal?
+
+      protected
+
+      # @method method_name
+      # @private
+      #
+      # The method, to be checked, name
+      #
+      # @return [Symbol]
+      attr_reader :method_name
+    end
+  end
+end

data/lib/sinclair/matchers/change_class_method.rb

@@ -0,0 +1,42 @@
+# frozen_string_literal: true
+
+class Sinclair
+  module Matchers
+    # @api private
+    # @author darthjee
+    #
+    # AddInstanceMethod is able to build an instance of
+    # {Sinclair::Matchers::ChangeClassMethodOn}
+    class ChangeClassMethod < Base
+      include AddMethod
+
+      # @api public
+      #
+      # Builds final matcher
+      #
+      # @return [Sinclair::Matchers::ChangeClassMethodOn]
+      alias on to
+
+      private
+
+      # @private
+      #
+      # Error description on wrong usage
+      #
+      # @return String
+      def matcher_error
+        'You should specify which class the method is being changed on' \
+          "change_class_method(:#{method_name}).on(klass)"
+      end
+
+      # @private
+      #
+      # Class of the real matcher
+      #
+      # @return [Class<ChangeClassMethodOn>]
+      def add_method_to_class
+        ChangeClassMethodOn
+      end
+    end
+  end
+end

data/lib/sinclair/matchers/change_class_method_on.rb

@@ -0,0 +1,64 @@
+# frozen_string_literal: true
+
+class Sinclair
+  module Matchers
+    # @api private
+    # @author darthjee
+    #
+    # Checks if a class method was changed
+    # by the call of a block
+    #
+    #  This is used with a RSpec DSL method
+    #  change_class_method(method_name).on(class_object)
+    class ChangeClassMethodOn < ChangeMethodOn
+      # @param [Class] klass
+      #   Class where the class method should be added to
+      #
+      # @param method_name [SYmbol,String] method name
+      def initialize(target, method_name)
+        @klass = target
+        super(method_name)
+      end
+
+      # Return expectaton description
+      #
+      # @return [String]
+      def description
+        "change class method '#{method_name}' on #{klass}"
+      end
+
+      # Returns message on expectation failure
+      #
+      # @return [String]
+      def failure_message_for_should
+        "expected class method '#{method_name}' to be changed on #{klass} but " \
+          "#{initial_state ? "it didn't" : "it didn't exist"}"
+      end
+
+      # Returns message on expectation failure for negative expectation
+      #
+      # @return [String]
+      def failure_message_for_should_not
+        "expected class method '#{method_name}' not to be changed on #{klass} but it was"
+      end
+
+      private
+
+      # Checks if class has instance method defined
+      #
+      # @return [Boolean]
+      def state
+        klass.methods(false).include?(method_name.to_sym) \
+          && klass.method(method_name)
+      end
+
+      # Raises when block was not given
+      #
+      # @raise SyntaxError
+      def raise_block_syntax_error
+        raise SyntaxError, 'Block not received by the `change_class_method_on` matcher. ' \
+          'Perhaps you want to use `{ ... }` instead of do/end?'
+      end
+    end
+  end
+end

data/lib/sinclair/matchers/change_instance_method.rb

@@ -0,0 +1,42 @@
+# frozen_string_literal: true
+
+class Sinclair
+  module Matchers
+    # @api private
+    # @author darthjee
+    #
+    # AddInstanceMethod is able to build an instance of
+    # {Sinclair::Matchers::ChangeInstanceMethodOn}
+    class ChangeInstanceMethod < Base
+      include AddMethod
+
+      # @api public
+      #
+      # Builds final matcher
+      #
+      # @return [Sinclair::Matchers::ChangeInstanceMethodOn]
+      alias on to
+
+      private
+
+      # @private
+      #
+      # Error description on wrong usage
+      #
+      # @return String
+      def matcher_error
+        'You should specify which instance the method is being changed on' \
+          "change_method(:#{method_name}).on(instance)"
+      end
+
+      # @private
+      #
+      # Class of the real matcher
+      #
+      # @return [Class<Sinclair::Matchers::Base>]
+      def add_method_to_class
+        ChangeInstanceMethodOn
+      end
+    end
+  end
+end

data/lib/sinclair/matchers/change_instance_method_on.rb

@@ -0,0 +1,98 @@
+# frozen_string_literal: true
+
+class Sinclair
+  module Matchers
+    # @api private
+    # @author darthjee
+    #
+    # Checks if a method was changed
+    # by the call of a block
+    #
+    #  This is used with a RSpec DSL method
+    #  change_method(method_name).on(class_object)
+    class ChangeInstanceMethodOn < ChangeMethodOn
+      # @overload initialize(klass, method_name)
+      #   @param [Class] klass
+      #     class where the method should be added to
+      #
+      # @overload initialize(instance, method_name)
+      #   @param [Object] instance
+      #     instance of the class where the method should be added to
+      #
+      # @param method_name [Symbol,String] method name
+      def initialize(target, method_name)
+        if target.is_a?(Class)
+          @klass = target
+        else
+          @instance = target
+        end
+
+        super(method_name)
+      end
+
+      # Returnst expectaton description
+      #
+      # @return [String]
+      def description
+        "change method '#{method_name}' on #{klass} instances"
+      end
+
+      # Returns message on expectation failure
+      #
+      # @return [String]
+      def failure_message_for_should
+        "expected '#{method_name}' to be changed on #{klass} but " \
+          "#{initial_state ? "it didn't" : "it didn't exist"}"
+      end
+
+      # Returns message on expectation failure for negative expectation
+      #
+      # @return [String]
+      def failure_message_for_should_not
+        "expected '#{method_name}' not to be changed on #{klass} but it was"
+      end
+
+      protected
+
+      # @method instance
+      # @api private
+      # @private
+      #
+      # Instance of the class where the method should be added
+      #
+      # @return [Object]
+      attr_reader :instance
+
+      # @private
+      #
+      # Class to be analised
+      #
+      # @return [Class]
+      def klass
+        @klass ||= instance.class
+      end
+
+      private
+
+      # @private
+      #
+      # Checks if class has instance method defined
+      #
+      # @return [Boolean]
+      def state
+        klass.method_defined?(method_name) &&
+          klass.instance_method(method_name)
+      end
+
+      # @private
+      #
+      # Raises when block was not given
+      #
+      # @raise SyntaxError
+      def raise_block_syntax_error
+        raise SyntaxError, 'Block not received by the `change_instance_method_on` matcher. ' \
+          'Perhaps you want to use `{ ... }` instead of do/end?'
+      end
+    end
+  end
+end

data/lib/sinclair/matchers/change_method_on.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+class Sinclair
+  module Matchers
+    # @api private
+    # @author darthjee
+    # @abstract
+    #
+    # Base class for change_method_on matcher
+    class ChangeMethodOn < Base
+      include MethodTo
+
+      private
+
+      # @private
+      #
+      # Checks if a method was changed
+      #
+      # @return Boolean
+      def check
+        initial_state && initial_state != final_state
+      end
+    end
+  end
+end