sinclair 1.9.0 → 1.11.0

data/config/check_specs.yml

@@ -1,10 +1,9 @@
 ignore:
   - lib/sinclair/comparable/class_methods.rb
+  - lib/sinclair/exception.rb
   - lib/sinclair/matchers/add_method_to.rb
   - lib/sinclair/matchers/add_method.rb
-  - lib/sinclair/version.rb
-  - lib/sinclair/method_builder/base.rb
-  - lib/sinclair/exception.rb
-  - lib/sinclair/matchers/method_to.rb
   - lib/sinclair/matchers/base.rb
+  - lib/sinclair/matchers/method_to.rb
   - lib/sinclair/matchers/change_method_on.rb
+  - lib/sinclair/version.rb

data/config/yardstick.yml

@@ -1,4 +1,4 @@
-threshold: 99.8
+threshold: 100
 require_exact_threshold: false
 rules:
   ApiTag::Presence:
@@ -16,6 +16,8 @@ rules:
   ExampleTag:
     enabled: true
     exclude:
+      - Sinclair#add_method
+      - Sinclair#add_class_method
       - Sinclair::Configurable#config
       - Sinclair::Configurable#reset_config
       - Sinclair::Configurable#configure
@@ -23,6 +25,10 @@ rules:
       - Sinclair::Options#==
       - Sinclair::OptionsParser#options
       - Sinclair::OptionsParser#options_object
+      - Sinclair::Matchers#add_method
+      - Sinclair::Matchers#add_class_method
+      - Sinclair::Matchers#change_method
+      - Sinclair::Matchers#change_class_method
   ReturnTag:
     enabled: true
     exclude:
@@ -50,7 +56,9 @@ rules:
       - Sinclair::Matchers::ChangeInstanceMethodOn#initialize
       - Sinclair::MethodBuilder
       - Sinclair::MethodBuilder::Base#initialize
+      - Sinclair::MethodBuilder::Accessor#initialize
       - Sinclair::MethodDefinition#initialize
+      - Sinclair::MethodDefinition::CallDefinition#initialize
       - Sinclair::MethodDefinition::BlockDefinition#initialize
       - Sinclair::MethodDefinition::StringDefinition#initialize
       - Sinclair::Options#initialize

data/lib/sinclair/configurable.rb

@@ -81,6 +81,8 @@ class Sinclair
     # @method as_options(options_hash = {})
     # @api public
     #
+    # Returns options with configurated values
+    #
     # @param (see Sinclair::Config#as_options)
     # @return (see Sinclair::Config#as_options)
     # @example (see Sinclair::Config#as_options)

data/lib/sinclair/equals_checker.rb

@@ -1,5 +1,7 @@
 # frozen_string_literal: true
 
+require 'set'
+
 class Sinclair
   # @api public
   # @author darthjee

data/lib/sinclair/matchers/add_class_method.rb

@@ -6,33 +6,32 @@ class Sinclair
     # @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 < Base
-      include AddMethod
+    class AddClassMethod < AddMethod
+      # @example Checking if a class had a class method added
+      #   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>
+      with_final_matcher :to, AddClassMethodTo
 
       private
 
@@ -45,15 +44,6 @@ class Sinclair
         'You should specify which class the method is being added to' \
           "add_class_method(:#{method_name}).to(klass)"
       end
-
-      # @private
-      #
-      # Class of the real matcher
-      #
-      # @return [Class<Sinclair::Matchers::Base>]
-      def add_method_to_class
-        AddClassMethodTo
-      end
     end
   end
 end

data/lib/sinclair/matchers/add_instance_method.rb

@@ -7,56 +7,65 @@ class Sinclair
     #
     # 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 < Base
-      include AddMethod
+    class AddInstanceMethod < AddMethod
+      # @example Using inside RSpec and checking an instance method being added
+      #   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'
+      with_final_matcher :to, AddInstanceMethodTo
+
+      # @method to(target = nil)
+      # @api public
+      #
+      # The matcher checks if an instance method was added to a class
+      #
+      # @param (see AddMethod#to)
+      #
+      # @return [AddClassMethodTo]
 
       private
 
@@ -69,15 +78,6 @@ class Sinclair
         'You should specify which instance the method is being added to' \
           "add_method(:#{method_name}).to(instance)"
       end
-
-      # @private
-      #
-      # Class of the real matcher
-      #
-      # @return [Class<Sinclair::Matchers::Base>]
-      def add_method_to_class
-        AddInstanceMethodTo
-      end
     end
   end
 end

data/lib/sinclair/matchers/add_method.rb

@@ -4,41 +4,39 @@ class Sinclair
   module Matchers
     # @api private
     #
-    # Commone methods for matchers
-    module AddMethod
-      # @api public
-      #
-      # Builds final matcher
-      #
-      # The matcher checks if a method was added
-      # to a class or instance
-      #
-      # @param [target] target where the method will be added
-      #
-      # @return [Sinclair::Matchers::Base]
-      #
-      # @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
-      def to(target = nil)
-        add_method_to_class.new(target, method_name)
+    # Common methods for matchers
+    class AddMethod < Base
+      class << self
+        private
+
+        # @api private
+        # @private
+        #
+        # Add a method to generate the final matcher
+        #
+        # @param name [String,Symbol] the name of the method
+        # @param matcher_class [Class<AddMethodTo>] The matcher class to be returned
+        #
+        # @return (see Sinclair#build)
+        #
+        # @!macro with_final_matcher
+        #   @!method $1(target = nil)
+        #   @api public
+        #
+        #   Builds final matcher
+        #
+        #   The matcher checks if a method was added
+        #   to a class or instance
+        #
+        #   @param [Class,Object] target where the method will be added
+        #
+        #   @return [$2]
+        def with_final_matcher(name, matcher_class)
+          matcher = matcher_class
+          Sinclair.new(self).tap do |builder|
+            builder.add_method(name) { |target| matcher.new(target, method_name) }
+          end.build
+        end
       end
 
       # @abstract

data/lib/sinclair/matchers/change_class_method.rb

@@ -7,15 +7,30 @@ class Sinclair
     #
     # AddInstanceMethod is able to build an instance of
     # {Sinclair::Matchers::ChangeClassMethodOn}
-    class ChangeClassMethod < Base
-      include AddMethod
-
-      # @api public
+    class ChangeClassMethod < AddMethod
+      # @example Checking if a class method has changed
+      #  RSpec.configure do |config|
+      #    config.include Sinclair::Matchers
+      #  end
+      #
+      #  class MyModel
+      #  end
       #
-      # Builds final matcher
+      #  RSpec.describe 'my test' do
+      #    let(:builder) { Sinclair.new(klass) }
+      #    let(:klass)   { Class.new(MyModel) }
       #
-      # @return [Sinclair::Matchers::ChangeClassMethodOn]
-      alias on to
+      #    before do
+      #      builder.add_class_method(:the_method) { 10 }
+      #      builder.build
+      #      builder.add_class_method(:the_method) { 20 }
+      #    end
+      #
+      #    it do
+      #      expect{ builder.build }.to change_class_method(:the_method).on(klass)
+      #    end
+      #  end
+      with_final_matcher :on, ChangeClassMethodOn
 
       private
 
@@ -28,15 +43,6 @@ class Sinclair
         '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_instance_method.rb

@@ -7,15 +7,54 @@ class Sinclair
     #
     # AddInstanceMethod is able to build an instance of
     # {Sinclair::Matchers::ChangeInstanceMethodOn}
-    class ChangeInstanceMethod < Base
-      include AddMethod
-
-      # @api public
+    class ChangeInstanceMethod < AddMethod
+      # @example Checking if an instance method has changed
+      #  RSpec.configure do |config|
+      #    config.include Sinclair::Matchers
+      #  end
+      #
+      #  class MyModel
+      #  end
+      #
+      #  RSpec.describe 'my test' do
+      #    let(:builder) { Sinclair.new(klass) }
+      #    let(:klass)   { Class.new(MyModel) }
+      #
+      #    before do
+      #      builder.add_method(:the_method) { 10 }
+      #      builder.build
+      #      builder.add_method(:the_method) { 20 }
+      #    end
+      #
+      #    it do
+      #      expect{ builder.build }.to change_method(:the_method).on(klass)
+      #    end
+      #  end
+      #
+      # @example Checking if an instance method has changed on an instance
+      #  RSpec.configure do |config|
+      #    config.include Sinclair::Matchers
+      #  end
+      #
+      #  class MyModel
+      #  end
       #
-      # Builds final matcher
+      #  RSpec.describe 'my test' do
+      #    let(:builder)  { Sinclair.new(klass) }
+      #    let(:instance) { klass.new }
+      #    let(:klass)    { Class.new(MyModel) }
       #
-      # @return [Sinclair::Matchers::ChangeInstanceMethodOn]
-      alias on to
+      #    before do
+      #      builder.add_method(:the_method) { 10 }
+      #      builder.build
+      #      builder.add_method(:the_method) { 20 }
+      #    end
+      #
+      #    it do
+      #      expect{ builder.build }.to change_method(:the_method).on(instance)
+      #    end
+      #  end
+      with_final_matcher :on, ChangeInstanceMethodOn
 
       private
 
@@ -28,15 +67,6 @@ class Sinclair
         '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.rb

@@ -6,8 +6,6 @@ class Sinclair
   #
   # Matchers module will have the DSL to be included in RSpec in order to have
   # access to the matchers
-  #
-  # @example (see Sinclair::Matchers::AddMethod#to)
   module Matchers
     autoload :Base,                   'sinclair/matchers/base'
     autoload :AddInstanceMethod,      'sinclair/matchers/add_instance_method'
@@ -25,7 +23,6 @@ class Sinclair
 
     # DSL to AddInstanceMethod
     #
-    # @example (see Sinclair::Matchers)
     # @example (see Sinclair::Matchers::AddInstanceMethod#to)
     #
     # @return [AddInstanceMethod] RSpec Matcher
@@ -35,7 +32,6 @@ class Sinclair
 
     # DSL to AddClassMethod
     #
-    # @example (see Sinclair::Matchers)
     # @example (see Sinclair::Matchers::AddClassMethod#to)
     #
     # @return [AddClassMethod] RSpec Matcher
@@ -45,8 +41,7 @@ class Sinclair
 
     # DSL to ChangeInstanceMethod
     #
-    # @example (see Sinclair::Matchers)
-    # @example (see Sinclair::Matchers::ChangeInstanceMethod#to)
+    # @example (see Sinclair::Matchers::ChangeInstanceMethod#on)
     #
     # @return [ChangeInstanceMethod] RSpec Matcher
     def change_method(method_name)
@@ -55,8 +50,7 @@ class Sinclair
 
     # DSL to ChangeClassMethod
     #
-    # @example (see Sinclair::Matchers)
-    # @example (see Sinclair::Matchers::ChangeClassMethod#to)
+    # @example (see Sinclair::Matchers::ChangeClassMethod#on)
     #
     # @return [ChangeClassMethod] RSpec Matcher
     def change_class_method(method_name)

data/lib/sinclair/method_builder/base.rb

@@ -7,6 +7,21 @@ class Sinclair
     #
     # Base class responsible for building methods
     class Base
+      # Instantiate the class and build the method
+      #
+      # @param klass [Class] class to receive the method
+      # @param definition [MethodDefinition] method defined
+      # @param type [Symbol] type of method to be build
+      #   - +:instance+ instance methods
+      #   - +:class+ class methods
+      #
+      # @see #build
+      #
+      # @return [Symbol] name of the method built
+      def self.build(klass, definition, type:)
+        new(klass, definition, type: type).build
+      end
+
       # @param klass [Class] class to receive the method
       # @param definition [MethodDefinition] method defined
       # @param type [Symbol] type of method to be build
@@ -22,9 +37,9 @@ class Sinclair
       #
       # @return [Symbol] name of the method built
       #
-      # @raise NotImplementedYet
+      # @raise NotImplementedError
       def build
-        raise 'Not implemented yet. this should be imlemented in subclasses'
+        raise NotImplementedError, 'Not implemented yet. this should be imlemented in subclasses'
       end
 
       private

data/lib/sinclair/method_builder/call_method_builder.rb

@@ -0,0 +1,49 @@
+# frozen_string_literal: true
+
+class Sinclair
+  class MethodBuilder
+    # @api private
+    # @author darthjee
+    #
+    # Build a method based on a {MethodDefinition::CallDefinition}
+    class CallMethodBuilder < Base
+      # Builds the method
+      #
+      # The build uses +module_eval+ over a class
+      #
+      # The code is ran either on the class itself or in
+      # a block that allow creation of class methods
+      #
+      # @return [NilClass]
+      def build
+        evaluating_class.module_eval(&code_block)
+      end
+
+      private
+
+      delegate :code_block, to: :definition
+      # @method code_block
+      # @api private
+      # @private
+      #
+      # Code block to be evaluated by the class
+      #
+      # @return [Proc]
+
+      # Returns the klass where the proc block will be evaluated
+      #
+      # For instance type, the class itself is returned
+      #
+      # For adding class methods, the superclass is returned
+      #
+      # @return [Class]
+      def evaluating_class
+        return klass if instance?
+
+        class << klass
+          return self
+        end
+      end
+    end
+  end
+end

data/lib/sinclair/method_builder.rb

@@ -10,6 +10,8 @@ class Sinclair
     autoload :StringMethodBuilder, 'sinclair/method_builder/string_method_builder'
     autoload :BlockMethodBuilder,  'sinclair/method_builder/block_method_builder'
 
+    autoload :CallMethodBuilder, 'sinclair/method_builder/call_method_builder'
+
     CLASS_METHOD = :class
     INSTANCE_METHOD = :instance
 
@@ -23,11 +25,13 @@ class Sinclair
     # @param definitions [MethodDefinitions] all methods
     #   definitions to be built
     # @param type [Symbol] type of method to be built
+    #   - {CLASS_METHOD} : A class method will be built
+    #   - {INSTANCE_METHOD} : An instance method will be built
     #
     # @return [MethodDefinitions]
     def build_methods(definitions, type)
       definitions.each do |definition|
-        build_from_definition(definition, type)
+        definition.build(klass, type)
       end
     end
 
@@ -41,21 +45,5 @@ class Sinclair
     # class to receive the method
     #
     # @return [Class]
-
-    # @private
-    #
-    # Build one method from definition
-    #
-    # @param definition [MethodDefinition] the method definition
-    # @param type [Symbol] type of method to be built
-    #
-    # @return (see Base#build)
-    def build_from_definition(definition, type)
-      if definition.string?
-        StringMethodBuilder.new(klass, definition, type: type).build
-      else
-        BlockMethodBuilder.new(klass, definition, type: type).build
-      end
-    end
   end
 end

data/lib/sinclair/method_definition/block_definition.rb

@@ -7,6 +7,8 @@ class Sinclair
     #
     # Define a method from block
     class BlockDefinition < MethodDefinition
+      build_with MethodBuilder::BlockMethodBuilder
+
       # @param name    [String,Symbol] name of the method
       # @param block   [Proc] block with code to be added as method
       # @param options [Hash] Options of construction