sinclair 1.7.0 → 1.9.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4e9a5068ba9c9c0f3def716decd2cea72fbdea0e6a3255d2bd0d324462de4ef5
-  data.tar.gz: c067ae53d0320738e785675306dc7f8848851a3adb964217bd30593c15eaedbf
+  metadata.gz: 23c4aa7f5d3c743f783dc6196e0799bbef94fa2c4f42825379c4cc61aad8e9ec
+  data.tar.gz: 4aa6481202521cc4c0cf8b0210e798a8d56344a43c42e41157ae7a3121ea67a4
 SHA512:
-  metadata.gz: ddc575979d46b47983aa57083243e674ac1da951e1e8407b98ee188a17e60e7683d5a73ad829914e34d076764970fb93484f9da67b767a89b301f47d081aad47
-  data.tar.gz: 0052e1e9b9e86758cf2b35c215509d6d4946b5e8bd0fde994b2e8121b83807de04d8c4e84d3fa3ee47565e4a07f89313f0ef871d6156f93ebdd7e6c8df0a83c5
+  metadata.gz: 3b07675d7768ea9db9e858498863fec96959e209b2bf9596f78e4f57ff2134f286723d8d7d3c42b9be5f8efc907602dee83dc3d0914473cc73c163a65362e84f
+  data.tar.gz: 8f596032dfad280158eeeb5a4a74400386f960010b86480608864d81d9c017ad6fdcd8fcabf01d97ef9987a333719561f59d883840514fc707d076872760d195

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:

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.10.0](https://github.com/darthjee/sinclair/compare/1.9.0...master)
+
 Yard Documentation
 -------------------
-[https://www.rubydoc.info/gems/sinclair/1.7.0](https://www.rubydoc.info/gems/sinclair/1.7.0)
+[https://www.rubydoc.info/gems/sinclair/1.9.0](https://www.rubydoc.info/gems/sinclair/1.9.0)
 
 Installation
 ---------------
@@ -369,6 +371,12 @@ hash
   MyConfigurable.config.host # returns 'interstella.art'
   MyConfigurable.config.port # returns 5555
 
+  # Configurable enables options that can be passed
+  MyConfigurable.as_options.host # returns 'interstella.art'
+
+  # Configurable enables options that can be passed with custom values
+  MyConfigurable.as_options(host: 'other').host # returns 'other'
+
   MyConfigurable.reset_config
 
   MyConfigurable.config.host # returns nil
@@ -469,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
 ---------------
 
@@ -553,3 +583,4 @@ Projects Using
 
 -   [Arstotzka](https://github.com/darthjee/arstotzka)
 -   [Azeroth](https://github.com/darthjee/azeroth)
+-   [Magicka](https://github.com/darthjee/magicka)

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

@@ -19,6 +19,7 @@ rules:
       - Sinclair::Configurable#config
       - Sinclair::Configurable#reset_config
       - Sinclair::Configurable#configure
+      - Sinclair::EqualsChecker#initialize
       - Sinclair::Options#==
       - Sinclair::OptionsParser#options
       - Sinclair::OptionsParser#options_object
@@ -37,6 +38,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

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.rb

@@ -63,10 +63,10 @@ class Sinclair
     #     conf.password :some_password
     #   end
     #
-    #   options = LoginConfigurable.config.options
+    #   options = LoginConfigurable.config.as_options
     #
-    #   config.options.username # returns :some_username
-    #   config.options.password # returns :some_password
+    #   config.as_options.username # returns :some_username
+    #   config.as_options.password # returns :some_password
     #
     # @example returning custom options
     #   LoginConfigurable.configure do |conf|
@@ -74,13 +74,13 @@ class Sinclair
     #     conf.password :some_password
     #   end
     #
-    #   options = LoginConfigurable.config.options(
+    #   options = LoginConfigurable.config.as_options(
     #     password: :correct_password
     #   )
     #
-    #   config.options.username # returns :some_username
-    #   config.options.password # returns :correct_password
-    def options(options_hash = {})
+    #   config.as_options.username # returns :some_username
+    #   config.as_options.password # returns :correct_password
+    def as_options(options_hash = {})
       self.class.options_class.new(to_hash.merge(options_hash))
     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/config_class.rb

@@ -105,7 +105,7 @@ class Sinclair
     #
     # @return [Class<Sinclair::Options>]
     def options_class
-      @options_class ||= Class.new(Sinclair::Options)
+      @options_class ||= Class.new(superclass.try(:options_class) || Options)
     end
   end
 end

data/lib/sinclair/configurable.rb

@@ -9,8 +9,8 @@ class Sinclair
   # By extending Configurable, class receives the methods public
   # {ConfigFactory#config .config}, {ConfigFactory#reset_config .reset_config}
   # and {ConfigFactory#configure .configure}
-  # and the private methods {#configurable_with .configurable_with}
-  # and {#configurable_by .configurable_by}
+  # and the private methods {#configurable_with .configurable_with},
+  # {#configurable_by .configurable_by} and {#as_options .as_options}
   #
   # @see ConfigFactory
   # @see ConfigBuilder
@@ -78,13 +78,13 @@ class Sinclair
     # @see ConfigFactory#configure
     delegate :config, :reset_config, :configure, to: :config_factory
 
-    # @method options(options_hash = {})
+    # @method as_options(options_hash = {})
     # @api public
     #
-    # @param (see Sinclair::Config#options)
-    # @return (see Sinclair::Config#options)
-    # @example (see Sinclair::Config#options)
-    delegate :options, to: :config
+    # @param (see Sinclair::Config#as_options)
+    # @return (see Sinclair::Config#as_options)
+    # @example (see Sinclair::Config#as_options)
+    delegate :as_options, to: :config
 
     protected
 

data/lib/sinclair/equals_checker.rb

@@ -0,0 +1,108 @@
+# frozen_string_literal: true
+
+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/change_class_method_on.rb

@@ -11,10 +11,10 @@ class Sinclair
     #  This is used with a RSpec DSL method
     #  change_class_method(method_name).on(class_object)
     class ChangeClassMethodOn < ChangeMethodOn
-      # @param [Class] klass
+      # @param target [Class]
       #   Class where the class method should be added to
       #
-      # @param method_name [SYmbol,String] method name
+      # @param method_name [Symbol,String] method name
       def initialize(target, method_name)
         @klass = target
         super(method_name)

data/lib/sinclair/options/class_methods.rb

@@ -4,7 +4,7 @@ require 'set'
 
 class Sinclair
   class Options
-    # Class Methods for {Sinclai::Options}
+    # Class Methods for {Sinclair::Options}
     module ClassMethods
       # @api private
       #

data/lib/sinclair/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 class Sinclair
-  VERSION = '1.7.0'
+  VERSION = '1.9.0'
 end

data/lib/sinclair.rb

@@ -88,8 +88,10 @@ class Sinclair
   autoload :ConfigClass,       'sinclair/config_class'
   autoload :ConfigFactory,     'sinclair/config_factory'
   autoload :Configurable,      'sinclair/configurable'
+  autoload :Comparable,        'sinclair/comparable'
   autoload :EnvSettable,       'sinclair/env_settable'
   autoload :Exception,         'sinclair/exception'
+  autoload :EqualsChecker,     'sinclair/equals_checker'
   autoload :InputHash,         'sinclair/input_hash'
   autoload :MethodBuilder,     'sinclair/method_builder'
   autoload :MethodDefinition,  'sinclair/method_definition'

data/sinclair.gemspec

@@ -21,7 +21,7 @@ Gem::Specification.new do |gem|
 
   gem.add_runtime_dependency 'activesupport', '~> 5.2.0'
 
-  gem.add_development_dependency 'bundler',            '2.3.20'
+  gem.add_development_dependency 'bundler',            '2.3.25'
   gem.add_development_dependency 'pry',                '0.14.1'
   gem.add_development_dependency 'pry-nav',            '1.0.0'
   gem.add_development_dependency 'rake',               '13.0.1'

data/spec/integration/readme/sinclair/comparable_spec.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+describe Sinclair::Comparable do
+  describe '#readme' do
+    describe '.comparable_by?' do
+      let(:model_class) do
+        Class.new(SampleModel) do
+          include Sinclair::Comparable
+
+          comparable_by :name
+        end
+      end
+
+      it 'regular usage' do
+        model1 = model_class.new(name: 'jack', age: 21)
+        model2 = model_class.new(name: 'jack', age: 23)
+
+        expect(model1 == model2).to be_truthy
+      end
+    end
+  end
+end

data/spec/integration/readme/sinclair/configurable_spec.rb

@@ -25,7 +25,17 @@ describe Sinclair::Configurable do
           .to eq(5555)
       end
 
-      context 'when #rest_config is called' do
+      it 'enables options to be returned' do
+        expect(MyConfigurable.as_options.host)
+          .to eq('interstella.art')
+      end
+
+      it 'enables custom options to be returned' do
+        expect(MyConfigurable.as_options(host: 'other').host)
+          .to eq('other')
+      end
+
+      context 'when #reset_config is called' do
         before do
           MyConfigurable.reset_config
         end

data/spec/integration/yard/sinclair/comparable_spec.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+describe Sinclair::Comparable do
+  describe '#yard' do
+    describe '.comparable_by?' do
+      let(:model_class) do
+        Class.new(SampleModel) do
+          include Sinclair::Comparable
+
+          comparable_by :name
+        end
+      end
+
+      it 'regular usage' do
+        model1 = model_class.new(name: 'jack', age: 21)
+        model2 = model_class.new(name: 'jack', age: 23)
+
+        expect(model1 == model2).to be_truthy
+      end
+    end
+  end
+end

data/spec/integration/yard/sinclair/config_spec.rb

@@ -38,12 +38,12 @@ describe Sinclair::Config do
       end
 
       it 'returns options with correct values' do
-        expect(config.options.username).to eq(:some_username)
-        expect(config.options.password).to eq(:some_password)
+        expect(config.as_options.username).to eq(:some_username)
+        expect(config.as_options.password).to eq(:some_password)
       end
 
       context 'when merging with given attributes' do
-        subject(:options) { config.options(password: :correct_password) }
+        subject(:options) { config.as_options(password: :correct_password) }
 
         it 'returns options with custom values' do
           expect(options.username).to eq(:some_username)

data/spec/integration/yard/sinclair/equals_checker_spec.rb

@@ -0,0 +1,51 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+describe Sinclair::EqualsChecker do
+  describe '#yard' do
+    describe '#match?' do
+      it 'regular usage' do
+        checker = Sinclair::EqualsChecker.new(:name, :age)
+
+        model1 = SampleModel.new(name: 'jack', age: 21)
+        model2 = SampleModel.new(name: 'rose', age: 23)
+
+        expect(checker.match?(model1, model2)).to be_falsey
+      end
+
+      it 'similar models' do
+        checker = Sinclair::EqualsChecker.new(:name, :age)
+
+        model1 = SampleModel.new(name: 'jack', age: 21)
+        model2 = SampleModel.new(name: 'jack', age: 21)
+
+        expect(checker.match?(model1, model2)).to be_truthy
+      end
+
+      it 'different classes' do
+        checker = Sinclair::EqualsChecker.new(:name, :age)
+
+        model1 = SampleModel.new(name: 'jack', age: 21)
+        model2 = OtherModel.new(name: 'jack', age: 21)
+
+        expect(checker.match?(model1, model2)).to be_falsey
+      end
+    end
+
+    describe '#add' do
+      it 'adding fields to equal checker' do
+        checker = Sinclair::EqualsChecker.new(:name)
+
+        model1 = SampleModel.new(name: 'jack', age: 21)
+        model2 = SampleModel.new(name: 'jack', age: 22)
+
+        expect(checker.match?(model1, model2)).to be_truthy
+
+        checker.add(:age)
+
+        expect(checker.match?(model1, model2)).to be_falsey
+      end
+    end
+  end
+end

data/spec/lib/sinclair/comparable_spec.rb

@@ -0,0 +1,202 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+describe Sinclair::Comparable do
+  let(:model_class) do
+    Class.new(SampleModel) do
+      include Sinclair::Comparable
+    end
+  end
+
+  let(:attributes)   { %i[] }
+  let(:model1_class) { model_class }
+  let(:model2_class) { model_class }
+  let(:model1)       { model1_class.new(**model1_attributes) }
+  let(:model2)       { model2_class.new(**model2_attributes) }
+
+  let(:model1_attributes) { { name: name1, age: age1 } }
+  let(:model2_attributes) { { name: name2, age: age2 } }
+  let(:name1)             { SecureRandom.hex(10) }
+  let(:name2)             { SecureRandom.hex(10) }
+  let(:age1)              { Random.rand(10..20) }
+  let(:age2)              { Random.rand(21..50) }
+
+  describe '.comparable_by' do
+    let(:model2_class) { model1_class }
+
+    context 'when no field was present' do
+      it 'adds the field for comparison' do
+        expect { model1_class.comparable_by(:name) }
+          .to change { model1 == model2 }
+          .from(true).to(false)
+      end
+    end
+
+    context 'when there was a field present' do
+      let(:name2) { name1 }
+
+      before { model1_class.comparable_by(:name) }
+
+      it 'adds the field for comparison' do
+        expect { model1_class.comparable_by(:age) }
+          .to change { model1 == model2 }
+          .from(true).to(false)
+      end
+    end
+
+    context 'when there was a field present and it made a non match' do
+      let(:age2) { age1 }
+
+      before { model1_class.comparable_by(:name) }
+
+      it 'adds the field for comparison without forgeting the previous' do
+        expect { model1_class.comparable_by(:age) }
+          .not_to change { model1 == model2 }
+          .from(false)
+      end
+    end
+
+    context 'when the class parent class adds a field' do
+      let(:model1_class) { Class.new(model_class) }
+      let(:model2_class) { model1_class }
+
+      it 'takes the field into consideration' do
+        expect { model_class.comparable_by(:name) }
+          .to change { model1 == model2 }
+          .from(true).to(false)
+      end
+
+      context 'when we add a field to the class itself' do
+        let(:name2) { name1 }
+
+        before { model_class.comparable_by(:name) }
+
+        it 'takes all fields into consideration' do
+          expect { model1_class.comparable_by(:age) }
+            .to change { model1 == model2 }
+            .from(true).to(false)
+        end
+      end
+
+      context 'when we add a field to the parent class after' do
+        let(:name2) { name1 }
+
+        before { model1_class.comparable_by(:name) }
+
+        it 'takes all fields into consideration' do
+          expect { model_class.comparable_by(:age) }
+            .to change { model1 == model2 }
+            .from(true).to(false)
+        end
+      end
+    end
+  end
+
+  describe '#==' do
+    before do
+      model1_class.comparable_by(attributes)
+      model2_class.comparable_by(attributes)
+    end
+
+    context 'when the attributes is empty' do
+      context 'when they are different classes and attributes are the same' do
+        let(:model2_class) { Class.new(model1_class) }
+        let(:name2)        { name1 }
+        let(:age2)         { age1 }
+
+        it do
+          expect(model1).not_to eq(model2)
+        end
+      end
+
+      context 'when the models have the same attributes' do
+        let(:name2) { name1 }
+        let(:age2)  { age1 }
+
+        it do
+          expect(model1).to eq(model2)
+        end
+      end
+
+      context 'when the models have very different attributes' do
+        it do
+          expect(model1).to eq(model2)
+        end
+      end
+    end
+
+    context 'when the attributes is missing just one attribute' do
+      let(:attributes) { %i[name] }
+
+      context 'when they are different classes and attributes are the same' do
+        let(:model2_class) { Class.new(model1_class) }
+        let(:name2)        { name1 }
+        let(:age2)         { age1 }
+
+        it do
+          expect(model1).not_to eq(model2)
+        end
+      end
+
+      context 'when the models have a non listed different attribute' do
+        let(:name2) { name1 }
+
+        it do
+          expect(model1).to eq(model2)
+        end
+      end
+
+      context 'when the models have a listed different attribute' do
+        let(:age2) { age1 }
+
+        it do
+          expect(model1).not_to eq(model2)
+        end
+      end
+
+      context 'when the models have very different attributes' do
+        it do
+          expect(model1).not_to eq(model2)
+        end
+      end
+    end
+
+    context 'when all attributes are included' do
+      let(:attributes) { %i[name age] }
+
+      context 'when they are different classes and attributes are the same' do
+        let(:model2_class) { Class.new(model1_class) }
+        let(:name2)        { name1 }
+        let(:age2)         { age1 }
+
+        it do
+          expect(model1).not_to eq(model2)
+        end
+      end
+
+      context 'when the models have the same attributes' do
+        let(:name2) { name1 }
+        let(:age2)  { age1 }
+
+        it do
+          expect(model1).to eq(model2)
+        end
+      end
+
+      context 'when the models have a listed different attribute' do
+        let(:name) { name1 }
+
+        it do
+          expect(model1).not_to eq(model2)
+        end
+      end
+
+      context 'when the models have very different attributes' do
+        it do
+          expect(model1).not_to eq(model2)
+        end
+      end
+    end
+  end
+end

data/spec/lib/sinclair/config_spec.rb

@@ -109,29 +109,29 @@ describe Sinclair::Config do
     end
   end
 
-  describe '#options' do
+  describe '#as_options' do
     let(:expected_options) do
       klass.options_class.new(username: :user, password: nil)
     end
 
+    let(:builder) do
+      Sinclair::ConfigBuilder.new(config, :username, :password)
+    end
+
     before do
       klass.add_configs(:password, username: :user)
     end
 
     it do
-      expect(config.options).to be_a(Sinclair::Options)
+      expect(config.as_options).to be_a(Sinclair::Options)
     end
 
     it 'returns an option with default values' do
-      expect(config.options)
+      expect(config.as_options)
         .to eq(expected_options)
     end
 
     context 'when config has been changed' do
-      let(:builder) do
-        Sinclair::ConfigBuilder.new(config, :username, :password)
-      end
-
       let(:expected_options) do
         klass.options_class.new(
           username: :other_user, password: :some_password
@@ -144,7 +144,7 @@ describe Sinclair::Config do
       end
 
       it 'returns an option with values from config' do
-        expect(config.options)
+        expect(config.as_options)
           .to eq(expected_options)
       end
     end
@@ -157,7 +157,7 @@ describe Sinclair::Config do
       end
 
       it 'returns merged options' do
-        expect(config.options(password: :some_password))
+        expect(config.as_options(password: :some_password))
           .to eq(expected_options)
       end
     end
@@ -170,9 +170,23 @@ describe Sinclair::Config do
       end
 
       it 'returns merged options' do
-        expect(config.options('password' => :some_password))
+        expect(config.as_options('password' => :some_password))
           .to eq(expected_options)
       end
+
+      context 'when the config is changed' do
+        let(:options) { config.as_options }
+
+        it 'changes the option returned' do
+          expect { builder.username :other_user }
+            .to change { config.as_options.username }
+        end
+
+        it 'changes the option previously returned' do
+          expect { builder.username :other_user }
+            .not_to change(options, :username)
+        end
+      end
     end
   end
 end

data/spec/lib/sinclair/equals_checker_spec.rb

@@ -0,0 +1,148 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+describe Sinclair::EqualsChecker do
+  subject(:checker) { described_class.new(attributes) }
+
+  let(:attributes) { %i[] }
+
+  let(:model1_class) { SampleModel }
+  let(:model2_class) { SampleModel }
+  let(:model1)       { model1_class.new(**model1_attributes) }
+  let(:model2)       { model2_class.new(**model2_attributes) }
+
+  let(:model1_attributes) { { name: name1, age: age1 } }
+  let(:model2_attributes) { { name: name2, age: age2 } }
+  let(:name1)             { SecureRandom.hex(10) }
+  let(:name2)             { SecureRandom.hex(10) }
+  let(:age1)              { Random.rand(10..20) }
+  let(:age2)              { Random.rand(21..50) }
+
+  describe 'match?' do
+    context 'when the attributes is empty' do
+      context 'when they are different classes and attributes are the same' do
+        let(:model2_class) { Class.new(SampleModel) }
+        let(:name2)        { name1 }
+        let(:age2)         { age1 }
+
+        it do
+          expect(checker).not_to be_match(model1, model2)
+        end
+      end
+
+      context 'when the models have the same attributes' do
+        let(:name2) { name1 }
+        let(:age2)  { age1 }
+
+        it do
+          expect(checker).to be_match(model1, model2)
+        end
+      end
+
+      context 'when the models have very different attributes' do
+        it do
+          expect(checker).to be_match(model1, model2)
+        end
+      end
+    end
+
+    context 'when the attributes is missing just one attribute' do
+      let(:attributes) { %i[name] }
+
+      context 'when they are different classes and attributes are the same' do
+        let(:model2_class) { Class.new(SampleModel) }
+        let(:name2)        { name1 }
+        let(:age2)         { age1 }
+
+        it do
+          expect(checker).not_to be_match(model1, model2)
+        end
+      end
+
+      context 'when the models have a non listed different attribute' do
+        let(:name2) { name1 }
+
+        it do
+          expect(checker).to be_match(model1, model2)
+        end
+      end
+
+      context 'when the models have a listed different attribute' do
+        let(:age2) { age1 }
+
+        it do
+          expect(checker).not_to be_match(model1, model2)
+        end
+      end
+
+      context 'when the models have very different attributes' do
+        it do
+          expect(checker).not_to be_match(model1, model2)
+        end
+      end
+    end
+
+    context 'when all attributes are included' do
+      let(:attributes) { %i[name age] }
+
+      context 'when they are different classes and attributes are the same' do
+        let(:model2_class) { Class.new(SampleModel) }
+        let(:name2)        { name1 }
+        let(:age2)         { age1 }
+
+        it do
+          expect(checker).not_to be_match(model1, model2)
+        end
+      end
+
+      context 'when the models have the same attributes' do
+        let(:name2) { name1 }
+        let(:age2)  { age1 }
+
+        it do
+          expect(checker).to be_match(model1, model2)
+        end
+      end
+
+      context 'when the models have a listed different attribute' do
+        let(:name) { name1 }
+
+        it do
+          expect(checker).not_to be_match(model1, model2)
+        end
+      end
+
+      context 'when the models have very different attributes' do
+        it do
+          expect(checker).not_to be_match(model1, model2)
+        end
+      end
+    end
+  end
+
+  describe '#add' do
+    let(:attributes)     { [:name] }
+    let(:new_attributes) { [:age] }
+
+    context 'when the new field has different values' do
+      let(:name2) { name1 }
+
+      it 'uses the new field to the match' do
+        expect { checker.add(new_attributes) }
+          .to change { checker.match?(model1, model2) }
+          .from(true).to(false)
+      end
+    end
+
+    context 'when the old field has different values' do
+      let(:age2) { age1 }
+
+      it 'uses the new field to the match' do
+        expect { checker.add(new_attributes) }
+          .not_to change { checker.match?(model1, model2) }
+          .from(false)
+      end
+    end
+  end
+end

data/spec/support/sample_model.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+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

data/spec/support/shared_examples/config.rb

@@ -161,5 +161,60 @@ shared_examples 'a config class with .add_configs method' do
           .to(klass.options_class)
       end
     end
+
+    context 'when there is a child class' do
+      let(:code_block) { proc { klass.add_configs(name: 'Bob') } }
+
+      it 'adds attributes to child class' do
+        expect(&code_block)
+          .to change(child_klass, :config_attributes)
+          .from([]).to(%i[name])
+      end
+
+      it 'adds attributes to child options class' do
+        expect(&code_block)
+          .to add_method(:name).to(child_klass)
+      end
+
+      context 'when child class already has attributes' do
+        before do
+          child_klass.add_configs('email')
+        end
+
+        it 'adds new attributes to child class' do
+          expect(&code_block)
+            .to change(child_klass, :config_attributes)
+            .from([:email]).to(%i[name email])
+        end
+      end
+    end
+
+    context 'when there is a parent class' do
+      let(:code_block) do
+        proc { child_klass.add_configs(name: 'Bob') }
+      end
+
+      it 'does not add attributes to parent class' do
+        expect(&code_block)
+          .not_to change(klass, :config_attributes)
+      end
+
+      it 'does not add attributes to child options class' do
+        expect(&code_block)
+          .not_to add_method(:name).to(klass)
+      end
+
+      context 'when parent already has attributes' do
+        before do
+          klass.config_attributes(:email, 'username')
+        end
+
+        it 'adds only attributes that had not been defined before' do
+          expect(&code_block)
+            .to change(child_klass, :config_attributes)
+            .from(%i[email username]).to(%i[email username name])
+        end
+      end
+    end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: sinclair
 version: !ruby/object:Gem::Version
-  version: 1.7.0
+  version: 1.9.0
 platform: ruby
 authors:
 - DarthJee
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-08-31 00:00:00.000000000 Z
+date: 2023-01-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -30,14 +30,14 @@ dependencies:
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 2.3.20
+        version: 2.3.25
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 2.3.20
+        version: 2.3.25
 - !ruby/object:Gem::Dependency
   name: pry
   requirement: !ruby/object:Gem::Requirement
@@ -272,6 +272,8 @@ files:
 - config/yardstick.yml
 - docker-compose.yml
 - lib/sinclair.rb
+- lib/sinclair/comparable.rb
+- lib/sinclair/comparable/class_methods.rb
 - lib/sinclair/config.rb
 - lib/sinclair/config/methods_builder.rb
 - lib/sinclair/config_builder.rb
@@ -280,6 +282,7 @@ files:
 - lib/sinclair/configurable.rb
 - lib/sinclair/env_settable.rb
 - lib/sinclair/env_settable/builder.rb
+- lib/sinclair/equals_checker.rb
 - lib/sinclair/exception.rb
 - lib/sinclair/input_hash.rb
 - lib/sinclair/matchers.rb
@@ -314,18 +317,21 @@ files:
 - sinclair.jpg
 - spec/integration/readme/my_class_spec.rb
 - spec/integration/readme/my_model_spec.rb
+- spec/integration/readme/sinclair/comparable_spec.rb
 - spec/integration/readme/sinclair/configurable_spec.rb
 - spec/integration/readme/sinclair/env_settable_spec.rb
 - spec/integration/readme/sinclair/matchers_spec.rb
 - spec/integration/readme/sinclair/options_spec.rb
 - spec/integration/readme/sinclair_spec.rb
 - spec/integration/yard/my_builder_spec.rb
+- spec/integration/yard/sinclair/comparable_spec.rb
 - spec/integration/yard/sinclair/config_builder_spec.rb
 - spec/integration/yard/sinclair/config_class_spec.rb
 - spec/integration/yard/sinclair/config_factory_spec.rb
 - spec/integration/yard/sinclair/config_spec.rb
 - spec/integration/yard/sinclair/configurable_spec.rb
 - spec/integration/yard/sinclair/env_settable_spec.rb
+- spec/integration/yard/sinclair/equals_checker_spec.rb
 - spec/integration/yard/sinclair/input_hash_spec.rb
 - spec/integration/yard/sinclair/matchers/add_class_method_spec.rb
 - spec/integration/yard/sinclair/matchers/add_class_method_to_spec.rb
@@ -334,6 +340,7 @@ files:
 - spec/integration/yard/sinclair/options_parser_spec.rb
 - spec/integration/yard/sinclair/options_spec.rb
 - spec/integration/yard/sinclair_spec.rb
+- spec/lib/sinclair/comparable_spec.rb
 - spec/lib/sinclair/config/methods_builder_spec.rb
 - spec/lib/sinclair/config_builder_spec.rb
 - spec/lib/sinclair/config_class_spec.rb
@@ -342,6 +349,7 @@ files:
 - spec/lib/sinclair/configurable_spec.rb
 - spec/lib/sinclair/env_settable/builder_spec.rb
 - spec/lib/sinclair/env_settable_spec.rb
+- spec/lib/sinclair/equals_checker_spec.rb
 - spec/lib/sinclair/exception/invalid_options_spec.rb
 - spec/lib/sinclair/input_hash_spec.rb
 - spec/lib/sinclair/matchers/add_class_method_spec.rb
@@ -404,6 +412,7 @@ files:
 - spec/support/models/server_config.rb
 - spec/support/models/service_client.rb
 - spec/support/models/validator_builder.rb
+- spec/support/sample_model.rb
 - spec/support/shared_examples/class_method_definition.rb
 - spec/support/shared_examples/config.rb
 - spec/support/shared_examples/config_factory.rb
@@ -427,7 +436,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.20
+rubygems_version: 3.3.25
 signing_key: 
 specification_version: 4
 summary: Gem for easy concern creation