sinclair 1.9.0 → 1.10.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 23c4aa7f5d3c743f783dc6196e0799bbef94fa2c4f42825379c4cc61aad8e9ec
-  data.tar.gz: 4aa6481202521cc4c0cf8b0210e798a8d56344a43c42e41157ae7a3121ea67a4
+  metadata.gz: 4a3575c54efcf82ce477b70a6a34b6f6d37d6242b2c272454b141942ee90e381
+  data.tar.gz: fdae2230f95d50d239537f01dace6b278b7930cef96115667b424910d7106c78
 SHA512:
-  metadata.gz: 3b07675d7768ea9db9e858498863fec96959e209b2bf9596f78e4f57ff2134f286723d8d7d3c42b9be5f8efc907602dee83dc3d0914473cc73c163a65362e84f
-  data.tar.gz: 8f596032dfad280158eeeb5a4a74400386f960010b86480608864d81d9c017ad6fdcd8fcabf01d97ef9987a333719561f59d883840514fc707d076872760d195
+  metadata.gz: 424c2bd3b847482b32b45da5f3778c724c967fff11a14fdb5664e1d9b61fd0c484dc00e5f938739ffa46d3f04fcce7614ee9ed55b2fa3c3151af24a543b9d20e
+  data.tar.gz: 5094b1a51ae631f01163015b97131f7aaf78b349ca959f326823939de6b4205da8d64d750fad32837bdb28e74b76888644cf1518d9d51cdd2baba5318f61e595

data/.rubocop.yml

@@ -40,7 +40,7 @@ RSpec/MultipleExpectations:
     - spec/lib/sinclair_spec.rb
 
 RSpec/NestedGroups:
-  Max: 4
+  Max: 5
   Exclude:
     - spec/integration/yard/**/*.rb
 

data/README.md

@@ -13,11 +13,11 @@ This gem helps the creation of complex gems/concerns
 that enables creation of methods on the fly through class
 methods
 
-Next release: [1.10.0](https://github.com/darthjee/sinclair/compare/1.9.0...master)
+Next release: [1.11.0](https://github.com/darthjee/sinclair/compare/1.10.0...master)
 
 Yard Documentation
 -------------------
-[https://www.rubydoc.info/gems/sinclair/1.9.0](https://www.rubydoc.info/gems/sinclair/1.9.0)
+[https://www.rubydoc.info/gems/sinclair/1.10.0](https://www.rubydoc.info/gems/sinclair/1.10.0)
 
 Installation
 ---------------

data/config/yardstick.yml

@@ -1,4 +1,4 @@
-threshold: 99.8
+threshold: 100
 require_exact_threshold: false
 rules:
   ApiTag::Presence:
@@ -23,6 +23,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 +54,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,33 @@ 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
+      # @method #to(target = nil)
+      # @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 +45,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/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
+      #
+      # @return [NilClass]
+      def build
+        klass.module_eval(code_line, __FILE__, __LINE__ + 1)
+      end
+
+      private
+
+      # @api private
+      # @private
+      #
+      # String to be evaluated when building the method
+      #
+      # This can be {code_string} or {class_code_string}
+      # @return (see MethodDefinition::CallDefinition#code_string)
+      def code_line
+        instance? ? code_string : class_code_string
+      end
+
+      delegate :code_string, :class_code_string, to: :definition
+
+      # @method code_string
+      # @private
+      # @api private
+      #
+      # Delegated from {MethodDefinition::CallDefinition}
+      #
+      # @see MethodDefinition::CallDefinition#code_string
+      # @return [String]
+
+      # @method class_code_string
+      # @private
+      # @api private
+      #
+      # @see MethodDefinition::CallDefinition#class_code_string
+      # @return [String]
+    end
+  end
+end

data/lib/sinclair/method_builder.rb

@@ -9,6 +9,7 @@ class Sinclair
     autoload :Base,                'sinclair/method_builder/base'
     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
@@ -53,8 +54,10 @@ class Sinclair
     def build_from_definition(definition, type)
       if definition.string?
         StringMethodBuilder.new(klass, definition, type: type).build
-      else
+      elsif definition.block?
         BlockMethodBuilder.new(klass, definition, type: type).build
+      else
+        CallMethodBuilder.new(klass, definition, type: type).build
       end
     end
   end

data/lib/sinclair/method_definition/call_definition.rb

@@ -0,0 +1,52 @@
+# frozen_string_literal: true
+
+class Sinclair
+  class MethodDefinition
+    # @api private
+    # @author darthjee
+    #
+    # Define a call of method to e done within the class
+    class CallDefinition < MethodDefinition
+      # @param method_name [Symbol] method to be called
+      # @param arguments [Array<Symbol,String>] parameters to be passed as
+      #   arguments to the call
+      def initialize(method_name, *arguments)
+        @arguments = arguments
+        super(method_name)
+      end
+
+      default_value :block?, false
+      default_value :string?, false
+
+      # String to be executed within the class
+      # @return [String]
+      def code_string
+        "#{name} :#{arguments.join(', :')}"
+      end
+
+      # String to be executed within the class running code to change the class itself
+      #
+      # @see code_string
+      # @return [String]
+      def class_code_string
+        <<-CODE
+          class << self
+            #{code_string}
+          end
+        CODE
+      end
+
+      private
+
+      attr_reader :arguments
+
+      # @method arguments
+      # @api private
+      # @private
+      #
+      # parameters to be passed as arguments to the call
+      #
+      # @return [Array<Symbol,String>]
+    end
+  end
+end