sinclair 2.1.1 → 3.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d76ebc93311a132641b78144b2b81a05c84fade374cc0d149ff0164b9a5e07ff
-  data.tar.gz: 90bac707ca24a39baed7352cffa1ffcba9f3f7082077caf1d0cd20e9eb1021fb
+  metadata.gz: f788dd288f95c7d9ef8620ae943ecaefee7cf4a92a78775ef192e9b2a9a2db3c
+  data.tar.gz: 5147eaed065d2379d4fc2f89da54f03c58e866d0424fb87305a7b793531bc0ec
 SHA512:
-  metadata.gz: 6c0e1ee48effffc16883f6d1b514089e0673d073970131ea9e1ba480fbfb4dbc4d4bc871d3dcd92d21aebb3e78b36cb7e775493bfb8f490ad6cedebe0a8e1e1a
-  data.tar.gz: f48a3a61574f6b9d66122a0a23b1f709ac29f36b5dbd41bd246908280779fafc9bc42ad494d4da21b70772323bd43bfff5848ed8941229f01a8d4da8b8180e7c
+  metadata.gz: df2085b864fc83862f28142ae6b7ad665e8e591eeb749cd13ccaf9f00d2753f13a8c17031cd4487afa2c122dbbe58e01cc7acc3ab01e1a04a0abdf2ae96fe1bf
+  data.tar.gz: a016558c3dd413674e3573d5db481c55c11a1e95c4388e3013a740668c11b45b84c6d35abc142a5cb7498e06d487e517143ea12cdacf2dd033b1a41acf7e7d7f

data/.circleci/config.yml

@@ -22,7 +22,7 @@ workflows:
 jobs:
   test:
     docker:
-      - image: darthjee/circleci_ruby_270:1.2.0
+      - image: darthjee/circleci_ruby_331:1.0.1
         environment:
           PROJECT: sinclair
     steps:
@@ -41,7 +41,7 @@ jobs:
           command: cc-test-reporter after-build --exit-code $?
   checks:
     docker:
-      - image: darthjee/circleci_ruby_270:1.2.0
+      - image: darthjee/circleci_ruby_331:1.0.1
         environment:
           PROJECT: sinclair
     steps:
@@ -66,7 +66,7 @@ jobs:
           command: check_specs
   build-and-release:
     docker:
-      - image: darthjee/circleci_ruby_270:1.2.0
+      - image: darthjee/circleci_ruby_331:1.0.1
         environment:
           PROJECT: sinclair
     steps:

data/.rubocop.yml

@@ -2,7 +2,8 @@ require: rubocop-rspec
 inherit_from: .rubocop_todo.yml
 
 AllCops:
-  TargetRubyVersion: 2.5
+  TargetRubyVersion: 3.3
+  NewCops: enable
 
 RSpec/DescribeClass:
   Exclude:
@@ -58,3 +59,34 @@ Style/HashTransformKeys:
 
 Style/HashTransformValues:
   Enabled: true
+
+RSpec/MultipleMemoizedHelpers:
+  Enabled: false
+
+Naming/VariableNumber:
+  Enabled: false
+
+RSpec/IndexedLet:
+  Enabled: false
+
+RSpec/IdenticalEqualityAssertion:
+  Enabled: false
+
+RSpec/VerifiedDoubleReference:
+  Enabled: false
+
+RSpec/RedundantPredicateMatcher:
+  Exclude:
+    - 'spec/integration/yard/sinclair/config_factory_spec.rb'
+    - 'spec/lib/sinclair/equals_checker_spec.rb'
+
+Gemspec/RequireMFA:
+  Enabled: false
+
+Lint/EmptyBlock:
+  Exclude:
+    - 'spec/**/*_spec.rb'
+
+Lint/EmptyClass:
+  Exclude:
+    - 'spec/**/*.rb'

data/.rubocop_todo.yml

@@ -1,7 +1,19 @@
 # This configuration was generated by
 # `rubocop --auto-gen-config`
-# on 2020-04-27 21:26:53 +0000 using RuboCop version 0.80.1.
+# on 2025-05-09 01:27:02 UTC using RuboCop version 1.59.0.
 # The point is for the user to remove these configuration records
 # one by one as the offenses are removed from the code base.
 # Note that changes in the inspected code, or installation of new
 # versions of RuboCop, may require this file to be generated again.
+
+# Offense count: 1
+# This cop supports unsafe autocorrection (--autocorrect-all).
+# Configuration parameters: AllowSplatArgument.
+Style/HashConversion:
+  Exclude:
+    - 'lib/sinclair/input_hash.rb'
+
+# Offense count: 1
+Style/OpenStructUse:
+  Exclude:
+    - 'lib/sinclair/options_parser.rb'

data/Dockerfile

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

data/Gemfile

@@ -3,3 +3,20 @@
 source 'https://rubygems.org'
 
 gemspec
+
+gem 'bundler',            '>= 2.5.13'
+gem 'pry',                '0.14.2'
+gem 'pry-nav',            '1.0.0'
+gem 'rake',               '13.1.0'
+gem 'reek',               '6.1.4'
+gem 'rspec',              '3.12.0'
+gem 'rspec-core',         '3.12.2'
+gem 'rspec-expectations', '3.12.3'
+gem 'rspec-mocks',        '3.12.5'
+gem 'rspec-support',      '3.12.0'
+gem 'rubocop',            '1.59.0'
+gem 'rubocop-rspec',      '3.0.0'
+gem 'rubycritic',         '4.9.1'
+gem 'simplecov',          '0.22.0'
+gem 'yard',               '0.9.36'
+gem 'yardstick',          '0.9.9'

data/Makefile

@@ -0,0 +1,6 @@
+.PHONY: dev
+
+PROJECT?=sinclair
+
+dev:
+	docker-compose run $(PROJECT) /bin/bash

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

data/lib/sinclair/caster/class_methods.rb

@@ -13,8 +13,8 @@ class Sinclair
       end
 
       # (see Caster.cast_with)
-      def cast_with(key, method_name = nil, &block)
-        caster = instance_for(method_name, &block)
+      def cast_with(key, method_name = nil, &)
+        caster = instance_for(method_name, &)
 
         return class_casters[key] = caster if key.is_a?(Class)
 
@@ -22,8 +22,8 @@ class Sinclair
       end
 
       # (see Caster.cast)
-      def cast(value, key, **opts)
-        caster_for(key).cast(value, **opts)
+      def cast(value, key, **)
+        caster_for(key).cast(value, **)
       end
 
       # (see Caster.caster_for)
@@ -93,8 +93,8 @@ class Sinclair
       #   @param caster [Caster] instance of caster to be returned
       #
       # @return [Caster]
-      def instance_for(method_name, &block)
-        return new(&block) unless method_name
+      def instance_for(method_name, &)
+        return new(&) unless method_name
         return method_name if method_name.is_a?(Caster)
 
         new(&method_name)

data/lib/sinclair/chain_settable.rb

@@ -76,7 +76,7 @@ class Sinclair
     def default_options
       {
         sources: sources_order,
-        sources_map: sources_map
+        sources_map:
       }
     end
   end

data/lib/sinclair/class_methods.rb

@@ -11,9 +11,10 @@ class Sinclair
     # The block is executed adding the methods and after the builder
     # runs build building all the methods
     #
-    # @param (see Sinclair#initialize)
-    # @param block [Proc] block to be executed by the builder
-    #   in order to add the methods before running build
+    # @overload build(*args, **options, &block)
+    #   @param (see Sinclair#initialize)
+    #   @param block [Proc] block to be executed by the builder
+    #     in order to add the methods before running build
     #
     # @yield an instance of a builder ({Sinclair})
     #
@@ -32,9 +33,9 @@ class Sinclair
     #   model = MyPerson.new
     #
     #   model.random_name # returns 'John 803 Doe'
-    def build(*args, **opts, &block)
-      new(*args, **opts).tap do |builder|
-        builder.instance_eval(&block) if block_given?
+    def build(*, **, &)
+      new(*, **).tap do |builder|
+        builder.instance_eval(&) if block_given?
       end.build
     end
   end

data/lib/sinclair/config_builder.rb

@@ -38,21 +38,21 @@ class Sinclair
     private
 
     # @private
-    #
     # Method called for methods missing
     #
     # When a method is missing, it is expected that it is the
     # name of a variable to be set on config (as long as it was
     # defined in the config_attributes_array)
     #
-    # @param method_name [Symbol] name of the method called
-    # @param args [Array<Object>] arguments of the call
+    # @overload method_missing(method_name, *args)
+    #   @param method_name [Symbol] name of the method called
+    #   @param args [Array<Object>] arguments of the call
     #
     # @return [Object]
-    def method_missing(method_name, *args)
+    def method_missing(method_name, *)
       return super unless method_included?(method_name)
 
-      @config.instance_variable_set("@#{method_name}", *args)
+      @config.instance_variable_set("@#{method_name}", *)
     end
 
     # @private
@@ -78,8 +78,8 @@ class Sinclair
       klass = @config.class
 
       @config_attributes.include?(method_name) ||
-        klass.is_a?(Sinclair::ConfigClass) &&
-          klass.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

@@ -79,11 +79,11 @@ class Sinclair
     #
     #   config.secret # return '123abc'
     #   config.app_name # return 'MySuperApp'
-    def add_configs(*args)
-      Config::MethodsBuilder.new(self, *args).tap do |builder|
+    def add_configs(*)
+      Config::MethodsBuilder.new(self, *).tap do |builder|
         builder.build
 
-        Sinclair::InputHash.input_hash(*args).each do |name, value|
+        Sinclair::InputHash.input_hash(*).each do |name, value|
           options_class.with_options(name => value)
         end
 

data/lib/sinclair/config_factory.rb

@@ -21,8 +21,8 @@ class Sinclair
     # Deprecation warning message
     # @see https://github.com/darthjee/sinclair/blob/master/WARNINGS.md#usage-of-custom-config-classes
     CONFIG_CLASS_WARNING = 'Config class is expected to be ConfigClass. ' \
-      "In future releases this will be enforced.\n" \
-      'see more on https://github.com/darthjee/sinclair/blob/master/WARNINGS.md#usage-of-custom-config-classes'
+                           "In future releases this will be enforced.\n" \
+                           'see more on https://github.com/darthjee/sinclair/blob/master/WARNINGS.md#usage-of-custom-config-classes'
 
     # @param config_class [Class] configuration class to be used
     # @param config_attributes [Array<Symbol,String>] list of possible configurations
@@ -56,11 +56,11 @@ class Sinclair
     #
     #   config.respond_to? :active
     #   # returns true
-    def add_configs(*args)
+    def add_configs(*)
       builder = if config_class.is_a?(Sinclair::ConfigClass)
-                  config_class.add_configs(*args)
+                  config_class.add_configs(*)
                 else
-                  Config::MethodsBuilder.build(config_class, *args)
+                  Config::MethodsBuilder.build(config_class, *)
                 end
 
       config_attributes.concat(builder.config_names.map(&:to_sym))
@@ -138,13 +138,14 @@ class Sinclair
     def child
       self.class.new(
         config_class: Class.new(config_class),
-        config_attributes: config_attributes
+        config_attributes:
       )
     end
 
     private
 
     attr_reader :config_class, :config_attributes
+
     # @method config_class
     # @private
     # @api private

data/lib/sinclair/configurable.rb

@@ -22,10 +22,10 @@ class Sinclair
     # Deprecation warning message
     # @see https://github.com/darthjee/sinclair/blob/master/WARNINGS.md#usage-of-custom-config-classes
     CONFIG_CLASS_WARNING = 'Config classes attributes should ' \
-      'be defined inside the class or through the usage of ' \
-      "configurable_with.\n" \
-      "In future releases this will be enforced.\n" \
-      'see more on https://github.com/darthjee/sinclair/blob/master/WARNINGS.md#usage-of-custom-config-classes'
+                           'be defined inside the class or through the usage of ' \
+                           "configurable_with.\n" \
+                           "In future releases this will be enforced.\n" \
+                           'see more on https://github.com/darthjee/sinclair/blob/master/WARNINGS.md#usage-of-custom-config-classes'
 
     # @method config
     #
@@ -202,7 +202,7 @@ class Sinclair
       warn CONFIG_CLASS_WARNING if with.present?
 
       @config_factory = ConfigFactory.new(
-        config_class: config_class,
+        config_class:,
         config_attributes: with.map(&:to_sym)
       )
     end

data/lib/sinclair/env_settable.rb

@@ -30,7 +30,7 @@ class Sinclair
     read_with do |key, prefix: nil|
       env_key = [prefix, key].compact.join('_').to_s.upcase
 
-      ENV[env_key]
+      ENV.fetch(env_key, nil)
     end
 
     private

data/lib/sinclair/equals_checker.rb

@@ -1,7 +1,5 @@
 # frozen_string_literal: true
 
-require 'set'
-
 class Sinclair
   # @api public
   # @author darthjee
@@ -90,7 +88,7 @@ class Sinclair
     #
     # @return  [TrueClass,FalseClass]
     def match?(model, other)
-      return false unless model.class == other.class
+      return false unless model.instance_of?(other.class)
 
       attributes.all? do |attr|
         Reader.attributes_match?(attr, model, other)

data/lib/sinclair/exception.rb

@@ -18,6 +18,7 @@ class Sinclair
     class InvalidOptions < Sinclair::Exception
       # @param invalid_keys [Array<Symbol>] list of invalid keys
       def initialize(invalid_keys = [])
+        super
         @invalid_keys = invalid_keys
       end
 

data/lib/sinclair/input_hash.rb

@@ -34,8 +34,8 @@ class Sinclair
     #   #   key3: 10,
     #   #   'key4' => 20
     #   # }
-    def self.input_hash(*args)
-      new(*args).to_h
+    def self.input_hash(*)
+      new(*).to_h
     end
 
     # @api private
@@ -51,6 +51,7 @@ class Sinclair
     private
 
     attr_reader :attributes, :hash
+
     # @method attributes
     # @api private
     # @private

data/lib/sinclair/matchers/add_class_method_to.rb

@@ -78,7 +78,7 @@ class Sinclair
       # @raise SyntaxError
       def raise_block_syntax_error
         raise SyntaxError, 'Block not received by the `add_class_method_to` matcher. ' \
-          'Perhaps you want to use `{ ... }` instead of do/end?'
+                           'Perhaps you want to use `{ ... }` instead of do/end?'
       end
     end
   end

data/lib/sinclair/matchers/add_instance_method_to.rb

@@ -108,7 +108,7 @@ class Sinclair
       # @raise SyntaxError
       def raise_block_syntax_error
         raise SyntaxError, 'Block not received by the `add_instance_method_to` matcher. ' \
-          'Perhaps you want to use `{ ... }` instead of do/end?'
+                           'Perhaps you want to use `{ ... }` instead of do/end?'
       end
     end
   end

data/lib/sinclair/matchers/base.rb

@@ -9,6 +9,7 @@ class Sinclair
     class Base < RSpec::Matchers::BuiltIn::BaseMatcher
       # @param method_name [String,Symbol] the method, to be checked, name
       def initialize(method_name)
+        super
         @method_name = method_name.to_sym
       end
 
@@ -23,7 +24,7 @@ class Sinclair
       #
       # @return [Boolean]
       def equal?(other)
-        return unless other.class == self.class
+        return false unless other.class == self.class
 
         other.method_name == method_name &&
           other.try(:klass) == try(:klass)

data/lib/sinclair/matchers/change_class_method_on.rb

@@ -57,7 +57,7 @@ class Sinclair
       # @raise SyntaxError
       def raise_block_syntax_error
         raise SyntaxError, 'Block not received by the `change_class_method_on` matcher. ' \
-          'Perhaps you want to use `{ ... }` instead of do/end?'
+                           'Perhaps you want to use `{ ... }` instead of do/end?'
       end
     end
   end

data/lib/sinclair/matchers/change_instance_method_on.rb

@@ -91,7 +91,7 @@ class Sinclair
       # @raise SyntaxError
       def raise_block_syntax_error
         raise SyntaxError, 'Block not received by the `change_instance_method_on` matcher. ' \
-          'Perhaps you want to use `{ ... }` instead of do/end?'
+                           'Perhaps you want to use `{ ... }` instead of do/end?'
       end
     end
   end

data/lib/sinclair/method_builder/base.rb

@@ -19,7 +19,7 @@ class Sinclair
       #
       # @return [Symbol] name of the method built
       def self.build(klass, definition, type:)
-        new(klass, definition, type: type).build
+        new(klass, definition, type:).build
       end
 
       # @param klass [Class] class to receive the method
@@ -45,6 +45,7 @@ class Sinclair
       private
 
       attr_reader :klass, :definition, :type
+
       # @method klass
       # @private
       # @api private

data/lib/sinclair/method_definition/block_helper.rb

@@ -14,12 +14,12 @@ class Sinclair
       # Returns proc block when {#cached?} as simple
       #
       # @return [Proc]
-      def cached_method_proc(method_name, &inner_block)
+      def cached_method_proc(method_name, &)
         proc do
           instance_variable_get("@#{method_name}") ||
             instance_variable_set(
               "@#{method_name}",
-              instance_eval(&inner_block)
+              instance_eval(&)
             )
         end
       end
@@ -29,14 +29,14 @@ class Sinclair
       # Returns proc block when {#cached?} as full
       #
       # @return [Proc]
-      def full_cached_method_proc(method_name, &inner_block)
+      def full_cached_method_proc(method_name, &)
         proc do
           if instance_variable_defined?("@#{method_name}")
             instance_variable_get("@#{method_name}")
           else
             instance_variable_set(
               "@#{method_name}",
-              instance_eval(&inner_block)
+              instance_eval(&)
             )
           end
         end

data/lib/sinclair/method_definition/parameter_builder.rb

@@ -23,8 +23,8 @@ class Sinclair
       #   and +Hash+ representing parameters with default values
       #
       # @return [String]
-      def self.from(*args)
-        new(*args).to_s
+      def self.from(*)
+        new(*).to_s
       end
 
       private_class_method :new

data/lib/sinclair/method_definition/parameter_helper.rb

@@ -17,8 +17,8 @@ class Sinclair
       #     named parameters
       #
       # @return [String]
-      def self.parameters_from(*args, **opts)
-        new(*args, **opts).strings
+      def self.parameters_from(*, **)
+        new(*, **).strings
       end
 
       private_class_method :new

data/lib/sinclair/method_definition.rb

@@ -36,12 +36,15 @@ class Sinclair
         define_method(method_name) { value }
       end
 
-      # @param name    [String,Symbol] name of the method
-      # @param code    [String] code to be evaluated as method
-      # @param block   [Proc] block with code to be added as method
-      # @param options [Hash] Options of construction
-      # @option options cached [Boolean] Flag telling to create a block
-      #   with cache
+      # @overload from(name, code = nil, **options, &block)
+      #   @param name    [String,Symbol] name of the method
+      #   @param code    [String] code to be evaluated as method
+      #   @param block   [Proc] block with code to be added as method
+      #   @param options [Hash] Options of construction
+      #   @option options cached [Boolean, Symbol] Flag informing if value
+      #     is cached or not.
+      #     If +true+ the value is cached unless it is +nil+ or +false+.
+      #     If +:full+ the value is cached even if it is +nil+ or +false+
       #
       # builds a method definition based on arguments
       #
@@ -49,11 +52,11 @@ class Sinclair
       # returns a {StringDefinition} otherwise
       #
       # @return [Base]
-      def from(name, code = nil, **options, &block)
+      def from(name, code = nil, **, &block)
         if block
-          BlockDefinition.new(name, **options, &block)
+          BlockDefinition.new(name, **, &block)
         else
-          StringDefinition.new(name, code, **options)
+          StringDefinition.new(name, code, **)
         end
       end
 
@@ -68,11 +71,11 @@ class Sinclair
       # @param type [Symbol] the method definition type
       #
       # @return [Sinclair::MethodDefinition] an instance of a subclass
-      def for(type, *args, **options, &block)
-        return from(*args, **options, &block) unless type
+      def for(type, ...)
+        return from(...) unless type
 
         klass = const_get("#{type}_definition".camelize)
-        klass.new(*args, **options, &block)
+        klass.new(...)
       end
 
       # Defines builder for a definition class
@@ -100,15 +103,17 @@ class Sinclair
       #   @return [Symbol] the name of the method built
       def build_with(builder_class)
         define_method(:build) do |klass, type|
-          builder_class.build(klass, self, type: type)
+          builder_class.build(klass, self, type:)
         end
       end
     end
 
     # @param name    [String,Symbol] name of the method
     # @param options [Hash] Options of construction
-    # @option options cached [Boolean] Flag telling to create
-    #   a method with cache
+    # @option options cached [Boolean, Symbol] Flag informing if value
+    #   is cached or not.
+    #   If +true+ the value is cached unless it is +nil+ or +false+.
+    #   If +:full+ the value is cached even if it is +nil+ or +false+
     def initialize(name, **options)
       @name =    name
       @options = DEFAULT_OPTIONS.merge(options)
@@ -131,7 +136,7 @@ class Sinclair
     # @raise NotImplementedError
     def build(_klass, _type)
       raise NotImplementedError, 'Build is implemented in subclasses. ' \
-        "Use #{self.class}.from to initialize a proper object"
+                                 "Use #{self.class}.from to initialize a proper object"
     end
 
     delegate :cached, to: :options_object

data/lib/sinclair/method_definitions.rb

@@ -40,8 +40,8 @@ class Sinclair
     # @see MethodDefinition.from
     #
     # @return [Array<MethodDefinition>]
-    def add(*args, type: nil, **options, &block)
-      definitions << MethodDefinition.for(type, *args, **options, &block)
+    def add(*, type: nil, **, &)
+      definitions << MethodDefinition.for(type, *, **, &)
     end
 
     private

data/lib/sinclair/model/builder.rb

@@ -26,10 +26,10 @@ class Sinclair
       #     method should be added
       #   @param comparable [TrueClass,FalseClass] flag to make the class {Comparable}
       #     by the fields
-      def initialize(klass, *attributes, **options)
+      def initialize(klass, *attributes, **)
         super(klass)
         @attributes = attributes.flatten
-        @options = BuilderOptions.new(**options)
+        @options = BuilderOptions.new(**)
 
         add_methods
         change_equals