sinclair 1.15.0 → 1.16.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: bd10c98e0ec9983e0bd34a8b438126cc391ae667c9e7d5b7ca62f473c5296aea
-  data.tar.gz: f1bffcf49524f9dc05ee27e7510c4e0a76be23b674642fcfa2b10cfdb9f43a82
+  metadata.gz: '0633819d57447ccb757e81a154d58e8b5c47ed5fb49a6b738b6e3b27801ceeb0'
+  data.tar.gz: 0b50ae42aa0c487d3ae12d5e2b0c0933b4cff0040d7635340d82a5122a038c47
 SHA512:
-  metadata.gz: f3afe247b25b8b10f692227c3d5c031e4d6fd04f8aa00e021d0aa8d5813d9cba75c05b4a7d8aae6cc5b6be96d7de404becf35e9391db92c3ceadfc2804f72ce5
-  data.tar.gz: c80cee176cd24ecce3410fa6a64789ca3f52789bce24d558b421751fb6c74a4bf5c86eb1246e48d09abbad962e3bc6f965f1dcf09beae9eca68a198d4e969771
+  metadata.gz: a72bfc2c48a33ef60fa56a4a7dd8009a12737752ffa3075ef58a50f43968779155f95b095afc7b01d2f9172b2f6d88a2cdf1f2b1e010036686cdb4be7ae376fb
+  data.tar.gz: 3e0e0a9a8bc66d1d13c427895bd9473d1a984b30bd66a8fbc961d2f80d9f54910381a2ec6d3f1ab256590a9c6aaf559b71bba921f8c1bd2466501c02e835ced0

data/README.md

@@ -15,13 +15,13 @@ create custom comparators, configure your application, create powerfull options,
 
 Employing Sinclair in your applications helps you streamline your development workflow and enhance your development process through more efficient, cleaner code
 
-Current Release: [1.15.0](https://github.com/darthjee/sinclair/tree/1.15.0)
+Current Release: [1.16.1](https://github.com/darthjee/sinclair/tree/1.16.1)
 
-[Next release](https://github.com/darthjee/sinclair/compare/1.15.0...master)
+[Next release](https://github.com/darthjee/sinclair/compare/1.16.1...master)
 
 Yard Documentation
 -------------------
-[https://www.rubydoc.info/gems/sinclair/1.15.0](https://www.rubydoc.info/gems/sinclair/1.15.0)
+[https://www.rubydoc.info/gems/sinclair/1.16.1](https://www.rubydoc.info/gems/sinclair/1.16.1)
 
 Installation
 ---------------

data/config/yardstick.yml

@@ -57,6 +57,7 @@ rules:
       - Sinclair::EnvSettable::Builder#initialize
       - Sinclair::Exception::InvalidOptions#initialize
       - Sinclair::EqualsChecker#initialize
+      - Sinclair::EqualsChecker::Reader#initialize
       - Sinclair::InputHash#initialize
       - Sinclair::Matchers::AddInstanceMethodTo#initialize
       - Sinclair::Matchers::AddClassMethodTo#initialize

data/lib/sinclair/caster/class_methods.rb

@@ -62,6 +62,8 @@ class Sinclair
       #
       # @return [Caster]
       def caster_for_class(klass)
+        return unless klass.is_a?(Class) || klass.is_a?(Module)
+
         class_casters.find do |klazz, _|
           klass <= klazz
         end&.second

data/lib/sinclair/caster.rb

@@ -24,7 +24,11 @@ class Sinclair
     # The master caster never checks with its an
     #
     # @example
-    #   class MyCaster < Sinclair::Caster
+    #   class BaseCaster < Sinclair::Caster
+    #     cast_with(:string, :to_s)
+    #   end
+    #
+    #   class MyCaster < BaseCaster
     #   end
     #
     #   MyCaster.cast(10, :string) # returns '10'
@@ -373,9 +377,5 @@ class Sinclair
     #
     # @return [Proc]
     attr_reader :block
-
-    cast_with(:string, :to_s)
-    cast_with(:integer, :to_i)
-    cast_with(:float, :to_f)
   end
 end

data/lib/sinclair/equals_checker/reader.rb

@@ -0,0 +1,58 @@
+# frozen_string_literal: true
+
+class Sinclair
+  class EqualsChecker
+    # @api private
+    # @author darthjee
+    #
+    # Class capable of reading an attribute from models
+    class Reader
+      # @private
+      # @api private
+      #
+      # Checks if two attributes from 2 object match
+      #
+      # @param attribute [Symbol] attribute name
+      # @param model [Object] object to be compared with other
+      # @param other [Object] object to be compared with model
+      #
+      # @see #match?
+      # @return [TrueClass,FalseClass]
+      def self.attributes_match?(attribute, model, other)
+        reader = new(attribute)
+
+        reader.read_from(model) == reader.read_from(other)
+      end
+
+      # @param attribute [Symbol] name of the attribute (method or variable)
+      #   to be accessed in the models
+      def initialize(attribute)
+        @attribute = attribute
+      end
+
+      # Reads the +attribute+ from the model
+      #
+      # When attribute is a method name, calls that method on the model
+      #
+      # When attribute is an instance variable name, that is read directly from the model
+      #
+      # @param model [Object] the model to be read
+      #
+      # @return [Object]
+      def read_from(model)
+        return model.send(attribute) unless attribute.to_s.match?(/^@.*/)
+
+        model.instance_variable_get(attribute)
+      end
+
+      private
+
+      # @attr_reader :attribute
+      #
+      # Reads the attribute that will be used to extract the value
+      #
+      # @return [Symbol]
+      attr_reader :attribute
+    end
+  end
+end

data/lib/sinclair/equals_checker.rb

@@ -50,6 +50,8 @@ class Sinclair
   #
   #   checker.match?(model1, model2) # returns false
   class EqualsChecker
+    autoload :Reader, 'sinclair/equals_checker/reader'
+
     # @param attributes [Array<Symbol,String>] list of relevant attributes
     def initialize(*attributes)
       @attributes = Set.new(attributes.flatten)
@@ -91,7 +93,7 @@ class Sinclair
       return false unless model.class == other.class
 
       attributes.all? do |attr|
-        model.send(attr) == other.send(attr)
+        Reader.attributes_match?(attr, model, other)
       end
     end
 

data/lib/sinclair/version.rb

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

data/spec/integration/yard/sinclair/caster/class_methods_spec.rb

@@ -3,7 +3,13 @@
 require 'spec_helper'
 
 describe 'yard Sinclair::Caster::ClassMethods' do
-  let(:my_caster) { Class.new(Sinclair::Caster) }
+  let(:my_caster) { Class.new(superclass) }
+
+  let(:superclass) do
+    Class.new(Sinclair::Caster) do
+      cast_with(:string, :to_s)
+    end
+  end
 
   describe '.master_caster!' do
     it 'Making a class to be a master caster' do

data/spec/lib/sinclair/caster/class_methods_spec.rb

@@ -3,7 +3,16 @@
 require 'spec_helper'
 
 describe Sinclair::Caster::ClassMethods do
-  subject(:caster) { Class.new(Sinclair::Caster) }
+  subject(:caster) { Class.new(superclass) }
+
+  let(:superclass) do
+    Class.new(Sinclair::Caster) do
+      cast_with(:string, :to_s)
+      cast_with(:integer, :to_i)
+      cast_with(:float, :to_f)
+      cast_with(String, :to_s)
+    end
+  end
 
   describe '.cast_with' do
     let(:value)       { instance_double('value', to_p: final_value) }
@@ -120,6 +129,19 @@ describe Sinclair::Caster::ClassMethods do
   end
 
   describe '.caster_for' do
+    context 'when nil key is given' do
+      let(:value) { values.sample }
+      let(:values) do
+        [Random.rand, 'some string', { key: 10 }, Object.new, Class.new, [2, 3]]
+      end
+
+      it { expect(caster.caster_for(nil)).to be_a(Sinclair::Caster) }
+
+      it 'returns the default caster' do
+        expect(caster.caster_for(nil).cast(value)).to eq(value)
+      end
+    end
+
     context 'when the key has been defined with a symbol key' do
       before { caster.cast_with(:problem, :to_p) }
 

data/spec/lib/sinclair/equals_checker/reader_spec.rb

@@ -0,0 +1,55 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+describe Sinclair::EqualsChecker::Reader do
+  subject(:reader) { described_class.new(attribute) }
+
+  let(:attribute) { :information }
+  let(:model)     { SampleModel.new(name: name, age: age) }
+  let(:name)      { 'The Name' }
+  let(:age)       { 25 }
+
+  describe '.attributes_match?' do
+    let(:other)      { SampleModel.new(name: other_name) }
+    let(:attribute)  { :name }
+
+    context 'when the value match' do
+      let(:other_name) { name }
+
+      it do
+        expect(described_class)
+          .to be_attributes_match(attribute, model, other)
+      end
+    end
+
+    context 'when the value does not match' do
+      let(:other_name) { 'Other Name' }
+
+      it do
+        expect(described_class)
+          .not_to be_attributes_match(attribute, model, other)
+      end
+    end
+  end
+
+  describe '#read_from' do
+    context 'when reading from a method' do
+      it 'returns the value from the method' do
+        expect(reader.read_from(model)).to eq('The Name: 25 yo')
+      end
+    end
+
+    context 'when reading from a variable' do
+      let(:attribute) { :@inner_variable }
+
+      before do
+        model.instance_variable_set(:@inner_variable, 301)
+      end
+
+      it 'returns the value from the variable' do
+        expect(reader.read_from(model)).to eq(301)
+      end
+    end
+  end
+end

data/spec/lib/sinclair/equals_checker_spec.rb

@@ -119,6 +119,18 @@ describe Sinclair::EqualsChecker do
         end
       end
     end
+
+    context 'when one of the attributes is an instance variable' do
+      let(:attributes) { %i[name @age] }
+
+      context 'when the instance variable is different and the method the same' do
+        let(:name2) { name1 }
+
+        it do
+          expect(checker).not_to be_match(model1, model2)
+        end
+      end
+    end
   end
 
   describe '#add' do

data/spec/support/{sample_model.rb → models/sample_model.rb}

@@ -6,6 +6,10 @@ class SampleModel
     @age  = age
   end
 
+  def information
+    "#{name}: #{age} yo"
+  end
+
   protected
 
   attr_reader :name

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: sinclair
 version: !ruby/object:Gem::Version
-  version: 1.15.0
+  version: 1.16.1
 platform: ruby
 authors:
 - DarthJee
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2023-04-29 00:00:00.000000000 Z
+date: 2023-05-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -288,6 +288,7 @@ files:
 - lib/sinclair/env_settable.rb
 - lib/sinclair/env_settable/builder.rb
 - lib/sinclair/equals_checker.rb
+- lib/sinclair/equals_checker/reader.rb
 - lib/sinclair/exception.rb
 - lib/sinclair/input_hash.rb
 - lib/sinclair/matchers.rb
@@ -380,6 +381,7 @@ files:
 - spec/lib/sinclair/core_ext/object_spec.rb
 - spec/lib/sinclair/env_settable/builder_spec.rb
 - spec/lib/sinclair/env_settable_spec.rb
+- spec/lib/sinclair/equals_checker/reader_spec.rb
 - spec/lib/sinclair/equals_checker_spec.rb
 - spec/lib/sinclair/exception/invalid_options_spec.rb
 - spec/lib/sinclair/input_hash_spec.rb
@@ -455,13 +457,13 @@ files:
 - spec/support/models/purchase.rb
 - spec/support/models/random_generator.rb
 - spec/support/models/ruby_string_caster.rb
+- spec/support/models/sample_model.rb
 - spec/support/models/server.rb
 - spec/support/models/server_config.rb
 - spec/support/models/service_client.rb
 - spec/support/models/string_parser.rb
 - spec/support/models/tv.rb
 - spec/support/models/validator_builder.rb
-- spec/support/sample_model.rb
 - spec/support/shared_examples/attribute_accessor.rb
 - spec/support/shared_examples/class_method_definition.rb
 - spec/support/shared_examples/config.rb