sinclair 1.16.0 → 1.16.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 54cfb901ecd8185d00862d7c0b5a99e9cb626d2bbadf45db59553ae980ef9dc1
-  data.tar.gz: 7f0f0a291a659fbc5eaa0d6b56a8bc0f2dfe08b3c0a0d290dad2a6136c7ccc53
+  metadata.gz: 474f2601f89233396a82476209781ffb365ceb839756d70defeadade14a0b07e
+  data.tar.gz: 0de9aa5777826bb36c69e7499fce572f7dabcb2fff8d3fb322de75f71edcbf41
 SHA512:
-  metadata.gz: d788efed427695e2b001e7b38cc7fa4ef41fb8f6e6b855d321e88f24cb7c97b71b7f4d2622041a5f36ed9921b88513bb26beb4d3b0f11c37a19425a2d1698d9b
-  data.tar.gz: 66f7170ee3a639fa43219f10f3c984369d72ac3e58f182ac00bf0fecf947efa0e5f25107cffa45db30048366085c7c329cd214b5ed5659d854af93f0588b264b
+  metadata.gz: d1b82cbba327c1310c7783b3223acb1d7d412dfc8af26f98993499104cd8aac30ba06cfc334f433c59d052631c7d28a76638b6894d8247811ad682d95a8d2c90
+  data.tar.gz: bf2039f736954188ee656c8f6d871a4d10546f9a9b6e80f5bdaa88f8a22cbf4ea94a650bb5d1101b4d68ab3fbf1553701d70f27613c8233f0fe699fc619add0f

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.16.0](https://github.com/darthjee/sinclair/tree/1.16.0)
+Current Release: [1.16.2](https://github.com/darthjee/sinclair/tree/1.16.2)
 
-[Next release](https://github.com/darthjee/sinclair/compare/1.16.0...master)
+[Next release](https://github.com/darthjee/sinclair/compare/1.16.2...master)
 
 Yard Documentation
 -------------------
-[https://www.rubydoc.info/gems/sinclair/1.16.0](https://www.rubydoc.info/gems/sinclair/1.16.0)
+[https://www.rubydoc.info/gems/sinclair/1.16.2](https://www.rubydoc.info/gems/sinclair/1.16.2)
 
 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

@@ -30,11 +30,21 @@ class Sinclair
       def caster_for(key)
         return casters[key] if casters.key?(key)
 
-        caster_for_class(key) || superclas_caster_for(key) || new { |value| value }
+        caster_for_class(key) || superclas_caster_for(key) || Sinclair::Caster.default
       end
 
       protected
 
+      # @private
+      # @api private
+      #
+      # Default caster that performs no casting returning the value itself
+      #
+      # @return [Caster]
+      def default
+        @default ||= new
+      end
+
       # @api private
       #
       # Returns a caster from the superclass

data/lib/sinclair/caster.rb

@@ -317,7 +317,7 @@ class Sinclair
 
     # @param block [Proc] Proc to be used when converting the value object
     def initialize(&block)
-      @block = block.to_proc
+      @block = block&.to_proc
     end
 
     # Cast a value using the given the set +block+
@@ -348,6 +348,8 @@ class Sinclair
     #
     # @return [Object] the result of the converting block
     def cast(value, **opts)
+      return value unless block
+
       options = opts.select do |key, _|
         options_keys.include?(key)
       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,20 +93,19 @@ 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
 
     private
 
-    attr_reader :attributes
-
     # @private
     # @api private
-    # @method attributes
+    # @attr_reader attributes
     #
     # attributes relevant for checking difference
     #
     # @return [Set<Symbol,String>]
+    attr_reader :attributes
   end
 end

data/lib/sinclair/method_builder.rb

@@ -36,13 +36,14 @@ class Sinclair
 
     private
 
-    attr_reader :klass
-    # @method klass
+    # @attr_reader klass
     # @private
     # @api private
+    # @!visibility public
     #
     # class to receive the method
     #
     # @return [Class]
+    attr_reader :klass
   end
 end

data/lib/sinclair/method_definition.rb

@@ -16,7 +16,7 @@ class Sinclair
     autoload :ParameterHelper,  'sinclair/method_definition/parameter_helper'
     autoload :Stringifier,      'sinclair/method_definition/stringifier'
 
-    # @method name
+    # @attr_reader name
     #
     # name of the method
     #

data/lib/sinclair/options/builder.rb

@@ -43,14 +43,14 @@ class Sinclair
 
       private
 
-      attr_reader :attributes
-      # @method attributes
       # @api private
       # @private
+      # @attr_reader attributes
       #
       # Options attributes
       #
       # @return [Hash<Symbol.Object>]
+      attr_reader :attributes
 
       # Add all methods for options
       #

data/lib/sinclair/options_parser.rb

@@ -30,7 +30,9 @@ class Sinclair
   module OptionsParser
     private
 
+    # @attr_reader options
     # @!visibility public
+    # @private
     #
     # Options hash
     #

data/lib/sinclair/version.rb

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

data/lib/sinclair.rb

@@ -457,14 +457,14 @@ class Sinclair
 
   private
 
-  attr_reader :klass
-  # @method klass
+  # @!visibility public
   # @api private
   # @private
   #
   # Class that will receive the methods
   #
   # @return [Class]
+  attr_reader :klass
 
   # @private
   # @api private

data/spec/lib/sinclair/caster_spec.rb

@@ -6,8 +6,29 @@ describe Sinclair::Caster do
   subject(:caster) { caster_class.new(&method_name) }
 
   let(:caster_class) { Class.new(described_class) }
+  let(:value)        { values.sample }
+  let(:values) do
+    [Random.rand, 'some string', { key: 10 }, Object.new, Class.new, [2, 3]]
+  end
+
+  describe '#cast' do
+    context 'when no block is given' do
+      subject(:caster) { caster_class.new }
+
+      context 'when no options are given' do
+        it 'returns the value' do
+          expect(caster.cast(value)).to be(value)
+        end
+      end
+
+      context 'when options are given' do
+        it 'returns the value' do
+          expect(caster.cast(value, key: :value))
+            .to be(value)
+        end
+      end
+    end
 
-  describe '.cast' do
     context 'when no options are given and the block accepts none' do
       let(:method_name) { :to_s }
 

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.16.0
+  version: 1.16.2
 platform: ruby
 authors:
 - DarthJee
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2023-05-02 00:00:00.000000000 Z
+date: 2023-05-03 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