sinclair 1.4.1 → 1.4.2

data/lib/sinclair/configurable.rb

@@ -2,6 +2,7 @@
 
 class Sinclair
   # @api public
+  # @author darthjee
   #
   # Module capable of giving configuration capability
   #

data/lib/sinclair/matchers.rb

@@ -28,17 +28,31 @@ class Sinclair
   #    end
   #  end
   module Matchers
-    autoload :AddMethod,   'sinclair/matchers/add_method'
-    autoload :AddMethodTo, 'sinclair/matchers/add_method_to'
+    autoload :AddMethod,           'sinclair/matchers/add_method'
+    autoload :AddInstanceMethod,   'sinclair/matchers/add_instance_method'
+    autoload :AddClassMethod,      'sinclair/matchers/add_class_method'
+    autoload :AddMethodTo,         'sinclair/matchers/add_method_to'
+    autoload :AddInstanceMethodTo, 'sinclair/matchers/add_instance_method_to'
+    autoload :AddClassMethodTo,    'sinclair/matchers/add_class_method_to'
 
-    # DSL to AddMethod
+    # DSL to AddInstanceMethod
     #
     # @example (see Sinclair::Matchers)
-    # @example (see Sinclair::Matchers::AddMethod#to)
+    # @example (see Sinclair::Matchers::AddInstanceMethod#to)
     #
-    # @return [AddMethod] RSpec Matcher
+    # @return [AddInstanceMethod] RSpec Matcher
     def add_method(method)
-      Sinclair::Matchers::AddMethod.new(method)
+      Sinclair::Matchers::AddInstanceMethod.new(method)
+    end
+
+    # DSL to AddClassMethod
+    #
+    # @example (see Sinclair::Matchers)
+    # @example (see Sinclair::Matchers::AddClassMethod#to)
+    #
+    # @return [AddClassMethod] RSpec Matcher
+    def add_class_method(method)
+      Sinclair::Matchers::AddClassMethod.new(method)
     end
   end
 end

data/lib/sinclair/matchers/add_class_method.rb

@@ -0,0 +1,56 @@
+# frozen_string_literal: true
+
+class Sinclair
+  module Matchers
+    # @api private
+    # @author darthjee
+    #
+    # AddClassMethod is able to build an instance of {Sinclair::Matchers::AddClassMethodTo}
+    #
+    # @example
+    #   RSpec.configure do |config|
+    #     config.include Sinclair::Matchers
+    #   end
+    #
+    #   class MyModel
+    #   end
+    #
+    #   RSpec.describe 'MyBuilder' do
+    #     let(:clazz)   { Class.new(MyModel) }
+    #
+    #     let(:block) do
+    #       proc do
+    #         clazz.define_singleton_method(:new_method) { 2 }
+    #       end
+    #     end
+    #
+    #     it do
+    #       expect(&block).to add_class_method(:new_method).to(clazz)
+    #     end
+    #   end
+    #
+    #   # outputs
+    #   # should add method class_method 'new_method' to #<Class:0x000055b4d0a25c80>
+    class AddClassMethod < AddMethod
+      # @abstract
+      #
+      # Raise a warning on the usage as this is only a builder for AddClassMethodTo
+      #
+      # @raise SyntaxError
+      def matches?(_actual)
+        raise SyntaxError, 'You should specify which class the method is being added to' \
+          "add_class_method(:#{method}).to(klass)"
+      end
+
+      # Creates a matcher {AddClassMethodTo}
+      #
+      # @param target [Class]
+      #   class where the method should be added to
+      #
+      # @return [AddClassMethodTo] the correct matcher
+      def to(target = nil)
+        AddClassMethodTo.new(target, method)
+      end
+    end
+  end
+end

data/lib/sinclair/matchers/add_class_method_to.rb

@@ -0,0 +1,98 @@
+# frozen_string_literal: true
+
+class Sinclair
+  module Matchers
+    # @api private
+    # @author darthjee
+    #
+    # AddClassMethodTo checks whether a method was
+    # or not added to a class by the call of a block
+    #
+    # This is used with a RSpec DSL method
+    # add_class_method(method_name).to(class_object)
+    #
+    # @example
+    #   RSpec.configure do |config|
+    #     config.include Sinclair::Matchers
+    #   end
+    #
+    #   class MyModel
+    #   end
+    #
+    #   describe 'my test' do
+    #     let(:klass)   { Class.new(MyModel) }
+    #
+    #     let(:block) do
+    #       proc do
+    #         klass.define_singleton_method(:parent_name) { superclass.name }
+    #       end
+    #     end
+    #
+    #     it do
+    #       expect(&block).to add_class_method(:parent_name).to(klass)
+    #     end
+    #   end
+    class AddClassMethodTo < AddMethodTo
+      # @param [Class] klass
+      #   Class where the class method should be added to
+      #
+      # @param method [SYmbol,String] method name
+      def initialize(klass, method)
+        @klass = klass
+        super(method)
+      end
+
+      # Return expectaton description
+      #
+      # @return [String]
+      def description
+        "add method class_method '#{method}' to #{klass}"
+      end
+
+      # Returns message on expectation failure
+      #
+      # @return [String]
+      def failure_message_for_should
+        "expected class_method '#{method}' to be added to #{klass} but " \
+          "#{@initial_state ? 'it already existed' : "it didn't"}"
+      end
+
+      # Returns message on expectation failure for negative expectation
+      #
+      # @return [String]
+      def failure_message_for_should_not
+        "expected class_method '#{method}' not to be added to #{klass} but it was"
+      end
+
+      alias failure_message failure_message_for_should
+      alias failure_message_when_negated failure_message_for_should_not
+
+      protected
+
+      # @method klass
+      # @private
+      #
+      # Class where class method should be added to
+      #
+      # @return [Class]
+      attr_reader :klass
+
+      private
+
+      # Checks if class has instance method defined
+      #
+      # @return [Boolean]
+      def method_defined?
+        klass.methods(false).include?(method.to_sym)
+      end
+
+      # Raises when block was not given
+      #
+      # @raise SyntaxError
+      def raise_block_syntax_error
+        raise SyntaxError, 'Block not received by the `add_class_method_to` matcher. ' \
+          'Perhaps you want to use `{ ... }` instead of do/end?'
+      end
+    end
+  end
+end

data/lib/sinclair/matchers/add_instance_method.rb

@@ -0,0 +1,85 @@
+# frozen_string_literal: true
+
+class Sinclair
+  module Matchers
+    # @api private
+    # @author darthjee
+    #
+    # AddInstanceMethod is able to build an instance of {Sinclair::Matchers::AddInstanceMethodTo}
+    #
+    # @example Using inside RSpec and checking Class
+    #   RSpec.configure do |config|
+    #     config.include Sinclair::Matchers
+    #   end
+    #
+    #   class MyModel
+    #   end
+    #
+    #   RSpec.describe "MyBuilder" do
+    #     let(:clazz)   { Class.new(MyModel) }
+    #     let(:builder) { Sinclair.new(clazz) }
+    #
+    #     before do
+    #       builder.add_method(:new_method, "2")
+    #     end
+    #
+    #     it do
+    #       expect { builder.build }.to add_method(:new_method).to(clazz)
+    #     end
+    #   end
+    #
+    #   # Outputs
+    #   # 'should add method 'new_method' to #<Class:0x000056441bf46608> instances'
+    #
+    # @example Using inside RSpec and checking instance
+    #   RSpec.configure do |config|
+    #     config.include Sinclair::Matchers
+    #   end
+    #
+    #   class MyModel
+    #   end
+    #
+    #   RSpec.describe "MyBuilder" do
+    #     let(:clazz)    { Class.new(MyModel) }
+    #     let(:builder)  { Sinclair.new(clazz) }
+    #     let(:instance) { clazz.new }
+    #
+    #     before do
+    #       builder.add_method(:the_method, "true")
+    #     end
+    #
+    #     it do
+    #       expect { builder.build }.to add_method(:the_method).to(instance)
+    #     end
+    #   end
+    #
+    #   # Outputs
+    #   # 'should add method 'the_method' to #<Class:0x000056441bf46608> instances'
+    class AddInstanceMethod < AddMethod
+      # @abstract
+      #
+      # Raise a warning on the usage as this is only a builder for {AddInstanceMethodTo}
+      #
+      # @raise SyntaxError
+      def matches?(_actual)
+        raise SyntaxError, 'You should specify which instance the method is being added to' \
+          "add_method(:#{method}).to(instance)"
+      end
+
+      # Creates a matcher AddInstanceMethodTo
+      #
+      # @overload to(klass)
+      #   @param [Class] klass
+      #     class where the method should be added to
+      #
+      # @overload to(instance)
+      #   @param [Object] instance
+      #     instance of the class where the method should be added to
+      #
+      # @return [AddInstanceMethodTo] the correct matcher
+      def to(target = nil)
+        AddInstanceMethodTo.new(target, method)
+      end
+    end
+  end
+end

data/lib/sinclair/matchers/add_instance_method_to.rb

@@ -0,0 +1,119 @@
+# frozen_string_literal: true
+
+class Sinclair
+  module Matchers
+    # @api private
+    # @author darthjee
+    #
+    # AddInstanceMethodTo checks whether a method was or not added by the call of a block
+    #
+    # This is used with a RSpec DSL method add_method(method_name).to(class_object)
+    #
+    # @example
+    #   RSpec.configure do |config|
+    #     config.include Sinclair::Matchers
+    #   end
+    #
+    #   class MyModel
+    #   end
+    #
+    #   RSpec.describe 'my test' do
+    #     let(:klass)   { Class.new(MyModel) }
+    #     let(:builder) { Sinclair.new(klass) }
+    #
+    #     before do
+    #       builder.add_method(:class_name, 'self.class.name')
+    #     end
+    #
+    #     it do
+    #       expect { builder.build }.to add_method(:class_name).to(klass)
+    #     end
+    #   end
+    class AddInstanceMethodTo < AddMethodTo
+      # Returns a new instance of AddInstanceMethodTo
+      #
+      # @overload initialize(klass, method)
+      #   @param [Class] klass
+      #     class where the method should be added to
+      #
+      # @overload initialize(instance, method)
+      #   @param [Object] instance
+      #     instance of the class where the method should be added to
+      #
+      # @param method [Symbol,String] method name
+      def initialize(target, method)
+        if target.is_a?(Class)
+          @klass = target
+        else
+          @instance = target
+        end
+        super(method)
+      end
+
+      # Returnst expectaton description
+      #
+      # @return [String]
+      def description
+        "add method '#{method}' to #{klass} instances"
+      end
+
+      # Returns message on expectation failure
+      #
+      # @return [String]
+      def failure_message_for_should
+        "expected '#{method}' to be added to #{klass} but " \
+          "#{@initial_state ? 'it already existed' : "it didn't"}"
+      end
+
+      # Returns message on expectation failure for negative expectation
+      #
+      # @return [String]
+      def failure_message_for_should_not
+        "expected '#{method}' not to be added to #{klass} but it was"
+      end
+
+      alias failure_message failure_message_for_should
+      alias failure_message_when_negated failure_message_for_should_not
+
+      protected
+
+      # @method instance
+      # @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 method_defined?
+        klass.method_defined?(method)
+      end
+
+      # @private
+      #
+      # Raises when block was not given
+      #
+      # @raise SyntaxError
+      def raise_block_syntax_error
+        raise SyntaxError, 'Block not received by the `add_instance_method_to` matcher. ' \
+          'Perhaps you want to use `{ ... }` instead of do/end?'
+      end
+    end
+  end
+end

data/lib/sinclair/matchers/add_method.rb

@@ -2,82 +2,17 @@
 
 class Sinclair
   module Matchers
+    # @api private
     # @author darthjee
-    # AddMethod is able to build an instance of Sinclair::Matchers::AddMethodTo
+    # @abstract
+    #
+    # Base class for add_method matcher
     class AddMethod < RSpec::Matchers::BuiltIn::BaseMatcher
-      # @api private
-      # @abstract
-      #
-      # Raise a warning on the usage as this is only a builder for AddMethodTo
-      #
-      # @raise SyntaxError
-      def matches?(_actual)
-        raise SyntaxError, 'You should specify which instance the method is being added to' \
-          "add_method(:#{method}).to(instance)"
-      end
-
-      # @api private
-      #
-      # Returns a new instance of AddMethod
-      #
       # @param method [String,Symbol] the method, to be checked, name
       def initialize(method)
-        @method = method
-      end
-
-      # @api public
-      #
-      # Creates a matcher AddMethodTo
-      #
-      # @overload to(klass)
-      #   @param [Class] klass
-      #     class where the method should be added to
-      #
-      # @overload to(instance)
-      #   @param [Object] instance
-      #     instance of the class where the method should be added to
-      #
-      # @example Using inside RSpec and checking Class
-      #   RSpec.describe "MyBuilder" do
-      #     let(:clazz)   { Class.new }
-      #     let(:builder) { Sinclair.new(clazz) }
-      #
-      #     before do
-      #       builder.add_method(:new_method, "2")
-      #     end
-      #
-      #     it do
-      #       expect { builder.build }.to add_method(:new_method).to(clazz)
-      #     end
-      #   end
-      #
-      #   # Outputs
-      #   # 'should add method 'new_method' to #<Class:0x000056441bf46608> instances'
-      # @example Using inside RSpec and checking instance
-      #   RSpec.describe "MyBuilder" do
-      #     let(:clazz)    { Class.new }
-      #     let(:builder)  { Sinclair.new(clazz) }
-      #     let(:instance) { clazz.new }
-      #
-      #     before do
-      #       builder.add_method(:the_method, "true")
-      #     end
-      #
-      #     it do
-      #       expect { builder.build }.to add_method(:the_method).to(instance)
-      #     end
-      #   end
-      #
-      #   # Outputs
-      #   # 'should add method 'the_method' to #<Class:0x000056441bf46608> instances'
-      #
-      # @return [AddMethodTo] the correct matcher
-      def to(target = nil)
-        AddMethodTo.new(target, method)
+        @method = method.to_sym
       end
 
-      # @api private
-      #
       # definition needed for block matchers
       #
       # @return [Boolean]
@@ -85,13 +20,12 @@ class Sinclair
         true
       end
 
-      # @api private
-      #
       # Checkes if another instnce is equal self
       #
       # @return [Boolean]
       def equal?(other)
         return unless other.class == self.class
+
         other.method == method
       end
 
@@ -99,8 +33,12 @@ class Sinclair
 
       protected
 
-      # @api private
+      # @method method
       # @private
+      #
+      # The method, to be checked, name
+      #
+      # @return [Symbol]
       attr_reader :method
     end
   end