sinclair 1.8.0 → 1.10.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0c06e4b7038a22a311b6ee13f1b8fd2df24211d8953982035df626dba8fb66c5
-  data.tar.gz: b19227562faa97bca59e76d997998917068ccb2d230a0b90dfa76140f2032209
+  metadata.gz: 4a3575c54efcf82ce477b70a6a34b6f6d37d6242b2c272454b141942ee90e381
+  data.tar.gz: fdae2230f95d50d239537f01dace6b278b7930cef96115667b424910d7106c78
 SHA512:
-  metadata.gz: 87daf64f9e084ef37bb47efee4fb6ff174e70cfdf5005e506acdff45647fd4ad502b348b23c6a3bbb1cce09676c14d7be52cc816b493fdbb4c92d23b94b33ecf
-  data.tar.gz: 3d02e09271942cd50dc21eb9e9578b63db0374196e084b3ce9b54e3d816206731a88f8cb470581d791ecaf5a0f7a5435d2489ecf7465fa446b56d8f8c8b6dd24
+  metadata.gz: 424c2bd3b847482b32b45da5f3778c724c967fff11a14fdb5664e1d9b61fd0c484dc00e5f938739ffa46d3f04fcce7614ee9ed55b2fa3c3151af24a543b9d20e
+  data.tar.gz: 5094b1a51ae631f01163015b97131f7aaf78b349ca959f326823939de6b4205da8d64d750fad32837bdb28e74b76888644cf1518d9d51cdd2baba5318f61e595

data/.circleci/config.yml

@@ -7,8 +7,12 @@ workflows:
           filters:
             tags:
               only: /.*/
+      - checks:
+          filters:
+            tags:
+              only: /.*/
       - build-and-release:
-          requires: [test]
+          requires: [test, checks]
           filters:
             tags:
               only: /\d+\.\d+\.\d+/
@@ -18,7 +22,7 @@ workflows:
 jobs:
   test:
     docker:
-      - image: darthjee/circleci_ruby_270:1.1.0
+      - image: darthjee/circleci_ruby_270:1.2.0
         environment:
           PROJECT: sinclair
     steps:
@@ -32,12 +36,22 @@ jobs:
       - run:
           name: RSpec
           command: bundle exec rspec
-      - run:
-          name: Rubocop
-          command: rubocop
       - run:
           name: Coverage Test Report
           command: cc-test-reporter after-build --exit-code $?
+  checks:
+    docker:
+      - image: darthjee/circleci_ruby_270:1.2.0
+        environment:
+          PROJECT: sinclair
+    steps:
+      - checkout
+      - run:
+          name: Bundle Install
+          command: bundle install
+      - run:
+          name: Rubocop
+          command: rubocop
       - run:
           name: Yardstick coverage check
           command: bundle exec rake verify_measurements
@@ -52,7 +66,7 @@ jobs:
           command: check_specs
   build-and-release:
     docker:
-      - image: darthjee/circleci_ruby_270:1.1.0
+      - image: darthjee/circleci_ruby_270:1.2.0
         environment:
           PROJECT: sinclair
     steps:

data/.rubocop.yml

@@ -10,7 +10,7 @@ Metrics/BlockLength:
     - 'spec/support/**/*.rb'
     - '*.gemspec'
 
-Metrics/LineLength:
+Layout/LineLength:
   Max: 100
 
 Lint/AmbiguousBlockAssociation:
@@ -20,6 +20,9 @@ Lint/AmbiguousBlockAssociation:
 RSpec/AlignLeftLetBrace:
   Enabled: true
 
+RSpec/PredicateMatcher:
+  Exclude:
+    - 'spec/integration/yard/**/*_spec.rb'
 
 RSpec/DescribedClass:
   Exclude:
@@ -37,7 +40,7 @@ RSpec/MultipleExpectations:
     - spec/lib/sinclair_spec.rb
 
 RSpec/NestedGroups:
-  Max: 4
+  Max: 5
   Exclude:
     - spec/integration/yard/**/*.rb
 

data/Dockerfile

@@ -1,6 +1,6 @@
 FROM darthjee/scripts:0.3.1 as scripts
 
-FROM darthjee/ruby_270:1.1.0 as base
+FROM darthjee/ruby_270:1.2.0 as base
 
 COPY --chown=app:app ./ /home/app/app/
 

data/README.md

@@ -13,9 +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.11.0](https://github.com/darthjee/sinclair/compare/1.10.0...master)
+
 Yard Documentation
 -------------------
-[https://www.rubydoc.info/gems/sinclair/1.8.0](https://www.rubydoc.info/gems/sinclair/1.8.0)
+[https://www.rubydoc.info/gems/sinclair/1.10.0](https://www.rubydoc.info/gems/sinclair/1.10.0)
 
 Installation
 ---------------
@@ -475,6 +477,28 @@ Options allows projects to have an easy to configure option object
  ConnectionOptions.new(invalid: 10) # raises Sinclair::Exception::InvalidOptions
 ```
 
+### Sinclair::Comparable
+Comparable allows a class to implement quickly a `==` method comparing given attributes
+
+```ruby
+  class SampleModel
+    include Sinclair::Comparable
+
+    comparable_by :name
+    attr_reader :name, :age
+
+    def initialize(name: nil, age: nil)
+      @name = name
+      @age  = age
+    end
+  end
+
+  model1 = model_class.new(name: 'jack', age: 21)
+  model2 = model_class.new(name: 'jack', age: 23)
+
+  model1 == model2 # returns true
+```
+
 RSspec matcher
 ---------------
 

data/config/check_specs.yml

@@ -1,4 +1,5 @@
 ignore:
+  - lib/sinclair/comparable/class_methods.rb
   - lib/sinclair/matchers/add_method_to.rb
   - lib/sinclair/matchers/add_method.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:
@@ -19,9 +19,14 @@ rules:
       - Sinclair::Configurable#config
       - Sinclair::Configurable#reset_config
       - Sinclair::Configurable#configure
+      - Sinclair::EqualsChecker#initialize
       - 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:
@@ -37,6 +42,7 @@ rules:
       - Sinclair::ConfigFactory#initialize
       - Sinclair::EnvSettable::Builder#initialize
       - Sinclair::Exception::InvalidOptions#initialize
+      - Sinclair::EqualsChecker#initialize
       - Sinclair::InputHash#initialize
       - Sinclair::Matchers::AddInstanceMethodTo#initialize
       - Sinclair::Matchers::AddClassMethodTo#initialize
@@ -48,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/comparable/class_methods.rb

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+class Sinclair
+  module Comparable
+    # @api public
+    # @author darthjee
+    #
+    # Class methods of {Sinclair::Comparable}
+    #
+    # @example (see Sinclair::Comparable)
+    module ClassMethods
+      # Adds fields to the comparison algorythim
+      #
+      # @param attributes [Array<Symbol>] attributes to be added to comparison
+      #
+      # @see Sinclair::EqualsChecker
+      # @return (see Sinclair::EqualsChecker#add)
+      # @example (see Sinclair::Comparable)
+      def comparable_by(*attributes)
+        equals_checker.add(*attributes)
+      end
+
+      # @api private
+      #
+      # Returns a comparable configured for the class
+      #
+      # @return [Sinclair::EqualsChecker]
+      def equals_checker
+        @equals_checker ||= Sinclair::EqualsChecker.new
+      end
+    end
+  end
+end

data/lib/sinclair/comparable.rb

@@ -0,0 +1,47 @@
+# frozen_string_literal: true
+
+require 'sinclair/comparable/class_methods'
+
+class Sinclair
+  # @api public
+  # @author darthjee
+  #
+  # Concern to be added on classes for easy +==+ comparison
+  #
+  # @example
+  #   class SampleModel
+  #     include Sinclair::Comparable
+  #
+  #     comparable_by :name
+  #     attr_reader :name, :age
+  #
+  #     def initialize(name: nil, age: nil)
+  #       @name = name
+  #       @age  = age
+  #     end
+  #   end
+  #
+  #   model1 = model_class.new(name: 'jack', age: 21)
+  #   model2 = model_class.new(name: 'jack', age: 23)
+  #
+  #   model1 == model2 # returns true
+  module Comparable
+    extend ActiveSupport::Concern
+
+    # Checks if an instance of a comparable is equals another
+    #
+    # @param other [Object] an object that should be equal to comparable
+    #
+    # @return [Boolean]
+    # @example (see Sinclair::Comparable)
+    def ==(other)
+      klass = self.class
+      superklass = klass.superclass
+
+      return false unless klass.equals_checker.match?(self, other)
+      return true unless superklass.include?(Sinclair::Comparable)
+
+      superklass.equals_checker.match?(self, other)
+    end
+  end
+end

data/lib/sinclair/config_builder.rb

@@ -75,9 +75,11 @@ class Sinclair
     # @todo get rid of @config_attributes when only
     #   Sinclair::ConfigClass are accepted
     def method_included?(method_name)
+      klass = @config.class
+
       @config_attributes.include?(method_name) ||
-        @config.class.is_a?(Sinclair::ConfigClass) &&
-          @config.class.config_attributes.include?(method_name)
+        klass.is_a?(Sinclair::ConfigClass) &&
+          klass.config_attributes.include?(method_name)
     end
   end
 end

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

@@ -0,0 +1,110 @@
+# frozen_string_literal: true
+
+require 'set'
+
+class Sinclair
+  # @api public
+  # @author darthjee
+  #
+  # Class responsible for checking if two instances of a class are the equals
+  #
+  # @example regular usage
+  #   class SampleModel
+  #     def initialize(name: nil, age: nil)
+  #       @name = name
+  #       @age  = age
+  #     end
+  #
+  #     protected
+  #
+  #     attr_reader :name
+  #
+  #     private
+  #
+  #     attr_reader :age
+  #   end
+  #
+  #   class OtherModel < SampleModel
+  #   end
+  #
+  #   checker = Sinclair::EqualsChecker.new(:name, :age)
+  #
+  #   model1 = SampleModel.new(name: 'jack', age: 21)
+  #   model2 = SampleModel.new(name: 'rose', age: 23)
+  #
+  #   checker.match?(model1, model2) # returns false
+  #
+  # @example similar models
+  #   checker = Sinclair::EqualsChecker.new(:name, :age)
+  #
+  #   model1 = SampleModel.new(name: 'jack', age: 21)
+  #   model2 = SampleModel.new(name: 'jack', age: 21)
+  #
+  #   checker.match?(model1, model2) # returns true
+  #
+  # @example different classes
+  #   checker = Sinclair::EqualsChecker.new(:name, :age)
+  #
+  #   model1 = SampleModel.new(name: 'jack', age: 21)
+  #   model2 = OtherModel.new(name: 'jack', age: 21)
+  #
+  #   checker.match?(model1, model2) # returns false
+  class EqualsChecker
+    # @param attributes [Array<Symbol,String>] list of relevant attributes
+    def initialize(*attributes)
+      @attributes = Set.new(attributes.flatten)
+    end
+
+    # Adds new fields to equals checker
+    #
+    # @param attributes [Array<Symbol,String>] list of relevant attributes
+    #
+    # @return [Set<Symbol,String>]
+    #
+    # @example adding fields to equal checker
+    #   checker = Sinclair::EqualsChecker.new(:name)
+    #
+    #   model1 = SampleModel.new(name: 'jack', age: 21)
+    #   model2 = SampleModel.new(name: 'jack', age: 22)
+    #
+    #  checker.match?(model1, model2) # returns true
+    #
+    #  checker.add(:age)
+    #
+    #  checker.match?(model1, model2) # returns false
+    def add(*attributes)
+      @attributes += Set.new(attributes.flatten)
+    end
+
+    # Returns if 2 objects are equals
+    #
+    # The check takes into consideration:
+    #   - They should be instances of the same class
+    #   - Their attributes (method calls) should return the same value,
+    #   for the configured attributes
+    #   - Public and private attributes are checked
+    #
+    # @example (see Sinclair::EqualsChecker)
+    #
+    # @return  [TrueClass,FalseClass]
+    def match?(model, other)
+      return false unless model.class == other.class
+
+      attributes.all? do |attr|
+        model.send(attr) == other.send(attr)
+      end
+    end
+
+    private
+
+    attr_reader :attributes
+
+    # @private
+    # @api private
+    # @method attributes
+    #
+    # attributes relevant for checking difference
+    #
+    # @return [Set<Symbol,String>]
+  end
+end

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