sinclair 1.4.1 → 1.4.2

data/lib/sinclair/matchers/add_method_to.rb

@@ -4,92 +4,21 @@ class Sinclair
   module Matchers
     # @api private
     # @author darthjee
+    # @abstract
     #
-    # AddMethodTo 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)
-    #
-    # @author darthjee
-    #
-    # @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
+    # Base class for add_method_to matcher
     class AddMethodTo < RSpec::Matchers::BuiltIn::BaseMatcher
-      # @private
-      #
-      # Returns a new instance of AddMethodTo
-      #
-      # @overload initialize(klass, method)
-      #   @param [Class] klass
-      #     class where the method should be added to
-      #
-      # @overload initialize(instance, method)
-      #   @param [Object] klass
-      #     instance of the class where the method should be added to
-      #
-      # @param method
-      #   method name
-      def initialize(target, method)
-        if target.is_a?(Class)
-          @klass = target
-        else
-          @instance = target
-        end
+      # @param method [SYmbol,String] method name
+      def initialize(method)
         @method = method
       end
 
-      # @private
-      #
-      # Returnst expectaton description
-      #
-      # @return [String]
-      def description
-        "add method '#{method}' to #{klass} instances"
-      end
-
-      # @private
-      #
-      # 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
-
-      # @private
-      #
-      # 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
-
-      # @private
-      #
       # 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?
@@ -100,26 +29,27 @@ 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 &&
-          other.instance == instance
+          other.klass == klass
       end
 
       alias == equal?
-      alias failure_message failure_message_for_should
-      alias failure_message_when_negated failure_message_for_should_not
 
       protected
 
-      # @api private
+      # @method method
       # @private
-      attr_reader :method, :instance
+      #
+      # The method, to be checked, name
+      #
+      # @return [Symbol]
+      attr_reader :method
 
       private
 
@@ -142,34 +72,6 @@ class Sinclair
         event_proc.call
         @final_state = method_defined?
       end
-
-      # @private
-      #
-      # Checks if class has instance method defined
-      #
-      # @return [Boolean]
-      def method_defined?
-        klass.method_defined?(method)
-      end
-
-      # @private
-      #
-      # Class to be analised
-      #
-      # @return [Class]
-      def klass
-        @klass ||= instance.class
-      end
-
-      # @private
-      #
-      # Raises when block was not given
-      #
-      # @raise SyntaxError
-      def raise_block_syntax_error
-        raise SyntaxError, 'Block not received by the `add_method_to` matcher. ' \
-          'Perhaps you want to use `{ ... }` instead of do/end?'
-      end
     end
   end
 end

data/lib/sinclair/method_definition.rb

@@ -8,27 +8,20 @@ class Sinclair
   class MethodDefinition
     include Sinclair::OptionsParser
 
-    autoload :BlockDefinition, 'sinclair/method_definition/block_definition'
-    autoload :StringDefinition, 'sinclair/method_definition/string_definition'
+    autoload :InstanceMethodDefinition, 'sinclair/method_definition/instance_method_definition'
+    autoload :ClassMethodDefinition,    'sinclair/method_definition/class_method_definition'
+    autoload :BlockDefinition,          'sinclair/method_definition/block_definition'
+    autoload :StringDefinition,         'sinclair/method_definition/string_definition'
+    autoload :InstanceBlockDefinition,  'sinclair/method_definition/instance_block_definition'
+    autoload :InstanceStringDefinition, 'sinclair/method_definition/instance_string_definition'
+    autoload :ClassBlockDefinition,     'sinclair/method_definition/class_block_definition'
+    autoload :ClassStringDefinition,    'sinclair/method_definition/class_string_definition'
 
     # Default options of initialization
     DEFAULT_OPTIONS = {
       cached: false
     }.freeze
 
-    # Creates a new instance based on arguments
-    #
-    # @return [MethodDefinition] When block is given, a
-    #   new instance of {BlockDefinition} is returned,
-    #   otherwise {StringDefinition} is returned
-    def self.from(name, code = nil, **options, &block)
-      if block
-        BlockDefinition.new(name, **options, &block)
-      else
-        StringDefinition.new(name, code, **options)
-      end
-    end
-
     # @param name    [String,Symbol] name of the method
     # @param options [Hash] Options of construction
     # @option options cached [Boolean] Flag telling to create
@@ -38,54 +31,16 @@ class Sinclair
       @options = DEFAULT_OPTIONS.merge(options)
     end
 
+    # @abstract
+    #
     # Adds the method to given klass
     #
     # This should be implemented on child classes
     #
     # @param _klass [Class] class which will receive the new method
     #
-    # @example Using block method with no options
-    #   class MyModel
-    #   end
-    #
-    #   instance = MyModel.new
-    #
-    #   method_definition = Sinclair::MethodDefinition.from(
-    #     :sequence, '@x = @x.to_i ** 2 + 1'
-    #   )
-    #
-    #   method_definition.build(klass)  # adds instance_method :sequence to
-    #                                  # MyModel instances
-    #
-    #   instance.instance_variable_get(:@x)        # returns nil
-    #
-    #   instance.sequence               # returns 1
-    #   instance.sequence               # returns 2
-    #   instance.sequence               # returns 5
-    #
-    #   instance.instance_variable_get(:@x)        # returns 5
-    #
-    # @example Using string method with no options
-    #   class MyModel
-    #   end
-    #
-    #   instance = MyModel.new
-    #
-    #   method_definition = Sinclair::MethodDefinition.from(:sequence) do
-    #     @x = @x.to_i ** 2 + 1
-    #   end
-    #
-    #   method_definition.build(klass)  # adds instance_method :sequence to
-    #                                  # MyModel instances
-    #
-    #   instance.instance_variable_get(:@sequence) # returns nil
-    #   instance.instance_variable_get(:@x)        # returns nil
-    #
-    #   instance.sequence               # returns 1
-    #   instance.sequence               # returns 1 (cached value)
-    #
-    #   instance.instance_variable_get(:@sequence) # returns 1
-    #   instance.instance_variable_get(:@x)        # returns 1
+    # @example (see MethodDefinition::StringDefinition#build)
+    # @example (see MethodDefinition::BlockDefinition#build)
     #
     # @return [Symbol] name of the created method
     def build(_klass)
@@ -95,8 +50,13 @@ class Sinclair
 
     private
 
+    # @method name
     # @private
-    attr_reader :name, :code, :block
+    #
+    # name of the method
+    #
+    # @return [String,Symbol]
+    attr_reader :name
     delegate :cached, to: :options_object
 
     # @private

data/lib/sinclair/method_definition/block_definition.rb

@@ -2,6 +2,9 @@
 
 class Sinclair
   class MethodDefinition
+    # @abstract
+    # @author darthjee
+    #
     # Define a method from block
     class BlockDefinition < MethodDefinition
       # @param name    [String,Symbol] name of the method
@@ -14,7 +17,7 @@ class Sinclair
         super(name, **options)
       end
 
-      # Adds the method to given klass
+      # Adds the instance method to given klass
       #
       # @param klass [Class] class which will receive the new method
       #
@@ -22,18 +25,20 @@ class Sinclair
       #
       # @return [Symbol] name of the created method
       #
-      # @example Using block method with no options
+      # @example Using instance block method with cached options
       #   class MyModel
       #   end
       #
       #   instance = MyModel.new
       #
-      #   method_definition = Sinclair::MethodDefinition::BlockDefinition.new(:sequence) do
+      #   method_definition = Sinclair::MethodDefinition::InstanceBlockDefinition.new(
+      #     :sequence, cached: true
+      #   ) do
       #     @x = @x.to_i ** 2 + 1
       #   end
       #
-      #   method_definition.build(klass)  # adds instance_method :sequence to
-      #                                  # MyModel instances
+      #   method_definition.build(MyModel) # adds instance_method :sequence to
+      #                                    # MyModel instances
       #
       #   instance.instance_variable_get(:@sequence) # returns nil
       #   instance.instance_variable_get(:@x)        # returns nil
@@ -43,12 +48,38 @@ class Sinclair
       #
       #   instance.instance_variable_get(:@sequence) # returns 1
       #   instance.instance_variable_get(:@x)        # returns 1
+      #
+      # @example Using class block method without options
+      #   class MyModel
+      #   end
+      #
+      #   method_definition = Sinclair::MethodDefinition::ClassBlockDefinition.new(:sequence) do
+      #     @x = @x.to_i ** 2 + 1
+      #   end
+      #
+      #   method_definition.build(MyModel)    # adds instance_method :sequence to
+      #                                       # MyModel instances
+      #
+      #   MyModel.instance_variable_get(:@x) # returns nil
+      #
+      #   MyModel.sequence                   # returns 1
+      #   MyModel.sequence                   # returns 2
+      #   MyModel.sequence                   # returns 5
+      #
+      #   MyModel.instance_variable_get(:@x) # returns 5
       def build(klass)
-        klass.send(:define_method, name, method_block)
+        klass.send(method_definer, name, method_block)
       end
 
       private
 
+      # @method block
+      # @private
+      #
+      # Block with code to be added as method
+      # @return [Proc]
+      attr_reader :block
+
       # @private
       #
       # Returns the block that will be used for method creattion

data/lib/sinclair/method_definition/class_block_definition.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+class Sinclair
+  class MethodDefinition
+    # @api private
+    # @author darthjee
+    #
+    # Define an class method from block
+    class ClassBlockDefinition < BlockDefinition
+      private
+
+      # @private
+      #
+      # Method used to define a class method
+      #
+      # @return [Symbol] Always :define_singleton_method
+      def method_definer
+        :define_singleton_method
+      end
+    end
+  end
+end

data/lib/sinclair/method_definition/class_method_definition.rb

@@ -0,0 +1,50 @@
+# frozen_string_literal: true
+
+class Sinclair
+  class MethodDefinition
+    # @api private
+    # @author darthjee
+    #
+    # Module responsible for building class method definitions
+    module ClassMethodDefinition
+      # Returns an instance method definition
+      #
+      # When block is given returns an instance of
+      # {InstanceBlockDefinition}, and when not, returns
+      # {InstanceStringDefinition}
+      #
+      # @param name    [String,Symbol] name of the method
+      # @param code    [String] code to be evaluated as method
+      # @param block   [Proc] block with code to be added as method
+      # @param options [Hash] Options of construction
+      # @option options cached [Boolean] Flag telling to create
+      #   a method with cache
+      #
+      # @example With cache
+      #   klass = Class.new
+      #
+      #   method_definition = Sinclair::MethodDefinition::InstanceMethodDefinition.from(
+      #     :sequence, cached: true
+      #   ) do
+      #     @x = @x.to_i ** 2 + 1
+      #   end
+      #
+      #   method_definition.build(klass)
+      #
+      #   klass.sequence # returns 1
+      #   klass.sequence # returns 1
+      #
+      #   klass.instance_variable_get(:@x)        # returns 1
+      #   klass.instance_variable_get(:@sequence) # returns 1
+      #
+      # @return MethodDefinition
+      def self.from(name, code = nil, **options, &block)
+        if block
+          ClassBlockDefinition.new(name, **options, &block)
+        else
+          ClassStringDefinition.new(name, code, **options)
+        end
+      end
+    end
+  end
+end

data/lib/sinclair/method_definition/class_string_definition.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+class Sinclair
+  class MethodDefinition
+    # @api private
+    # @author darthjee
+    #
+    # Define a method from string
+    class ClassStringDefinition < StringDefinition
+      private
+
+      # @private
+      #
+      # String used when defining method
+      #
+      # Class definition appends +self.+ to method name
+      #
+      # @return [String]
+      def method_name
+        "self.#{name}"
+      end
+    end
+  end
+end