sinclair 1.6.6 → 1.6.7

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

data/lib/sinclair/matchers/method_to.rb

@@ -0,0 +1,82 @@
+# frozen_string_literal: true
+
+class Sinclair
+  module Matchers
+    # @api private
+    #
+    # Common methods on final matchers
+    module MethodTo
+      # Used for other versions of rspec
+      #
+      # Some versions call failure_message, others
+      # call failure_message_for_should
+      #
+      # @return [String]
+      def failure_message
+        failure_message_for_should
+      end
+
+      # Used for other versions of rspec
+      #
+      # Some versions call failure_message_when_negated, others
+      # call failure_message_for_should_not
+      #
+      # @return [String]
+      def failure_message_when_negated
+        failure_message_for_should_not
+      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)
+        check
+      end
+
+      protected
+
+      # @method klass
+      # @api private
+      # @private
+      #
+      # Class where class method should be added to
+      #
+      # @return [Class]
+      attr_reader :klass
+
+      private
+
+      # @method initial_state
+      # @api private
+      # @private
+      #
+      # State before running the block
+      #
+      # @return [Object]
+
+      # @method final_state
+      # @api private
+      # @private
+      #
+      # State after running the block
+      #
+      # @return [Object]
+      attr_reader :initial_state, :final_state
+
+      # @private
+      #
+      # Call block to check if it aded a method or not
+      #
+      # @return [Boolan]
+      def perform_change(event_proc)
+        @initial_state = state
+        event_proc.call
+        @final_state = state
+      end
+    end
+  end
+end

data/lib/sinclair/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 class Sinclair
-  VERSION = '1.6.6'
+  VERSION = '1.6.7'
 end

data/spec/lib/sinclair/matchers/add_class_method_to_spec.rb

@@ -13,22 +13,46 @@ describe Sinclair::Matchers::AddClassMethodTo do
       proc { klass.send(:define_singleton_method, method) {} }
     end
 
-    context 'when a method is added' do
-      it { expect(matcher).to be_matches(event_proc) }
-    end
+    context 'when class does not have the method yet' do
+      context 'when a method is added' do
+        it { expect(matcher).to be_matches(event_proc) }
+      end
 
-    context 'when a method is not added' do
-      let(:event_proc) { proc {} }
+      context 'when a method is not added' do
+        let(:event_proc) { proc {} }
 
-      it { expect(matcher).not_to be_matches(event_proc) }
-    end
+        it { expect(matcher).not_to be_matches(event_proc) }
+      end
+
+      context 'when the wrong method is added' do
+        let(:event_proc) do
+          proc { klass.send(:define_singleton_method, :another_method) {} }
+        end
+
+        it { expect(matcher).not_to be_matches(event_proc) }
+      end
 
-    context 'when the wrong method is added' do
-      let(:event_proc) do
-        proc { klass.send(:define_singleton_method, :another_method) {} }
+      context 'when method already existed' do
+        before { event_proc.call }
+
+        it { expect(matcher).not_to be_matches(event_proc) }
       end
 
-      it { expect(matcher).not_to be_matches(event_proc) }
+      context 'when method is added to instances' do
+        let(:event_proc) do
+          proc { klass.send(:define_method, method) {} }
+        end
+
+        it { expect(matcher).not_to be_matches(event_proc) }
+      end
+    end
+
+    context 'when class already has the method' do
+      before { klass.send(:define_singleton_method, method) {} }
+
+      context 'when a method is changed' do
+        it { expect(matcher).not_to be_matches(event_proc) }
+      end
     end
 
     context 'when a block is given' do
@@ -36,7 +60,7 @@ describe Sinclair::Matchers::AddClassMethodTo do
         expect { matcher.matches?(event_proc) { 1 } }
           .to raise_error(
             SyntaxError, 'Block not received by the `add_class_method_to` matcher. ' \
-          'Perhaps you want to use `{ ... }` instead of do/end?'
+            'Perhaps you want to use `{ ... }` instead of do/end?'
           )
       end
     end
@@ -45,7 +69,7 @@ describe Sinclair::Matchers::AddClassMethodTo do
   describe '#failure_message_for_should' do
     it 'returns information on the instance class and method' do
       expect(matcher.failure_message_for_should)
-        .to eq("expected class_method '#{method}' to be added to #{klass} but it didn't")
+        .to eq("expected class method '#{method}' to be added to #{klass} but it didn't")
     end
 
     context 'when method already exited' do
@@ -56,7 +80,7 @@ describe Sinclair::Matchers::AddClassMethodTo do
 
       it 'returns information on the instance class and method' do
         expect(matcher.failure_message_for_should)
-          .to eq("expected class_method '#{method}' to be added to #{klass} but it already existed")
+          .to eq("expected class method '#{method}' to be added to #{klass} but it already existed")
       end
     end
   end
@@ -64,14 +88,14 @@ describe Sinclair::Matchers::AddClassMethodTo do
   describe '#failure_message_for_should_not' do
     it 'returns information on the instance class and method' do
       expect(matcher.failure_message_for_should_not)
-        .to eq("expected class_method '#{method}' not to be added to #{klass} but it was")
+        .to eq("expected class method '#{method}' not to be added to #{klass} but it was")
     end
   end
 
   describe 'description' do
     it 'returns information on the instance class and method' do
       expect(matcher.description)
-        .to eq("add method class_method '#{method}' to #{klass}")
+        .to eq("add class method '#{method}' to #{klass}")
     end
   end
 end