sinclair 2.1.1 → 3.0.1

data/lib/sinclair/model.rb

@@ -51,9 +51,9 @@ class Sinclair
       #     job.state # returns :done
       #
       # @return [Class<Model>] a new class with the chosen attributes
-      def for(*attributes, **options)
+      def for(*attributes, **)
         Class.new(self) do |klass|
-          Builder.new(klass, *attributes, **options).build
+          Builder.new(klass, *attributes, **).build
         end
       end
 
@@ -100,8 +100,8 @@ class Sinclair
       #     job.state # returns :done
       #
       # @return [Array<MethodDefinition>]
-      def initialize_with(*attributes, **options)
-        Builder.new(self, *attributes, **options).build
+      def initialize_with(*attributes, **)
+        Builder.new(self, *attributes, **).build
       end
     end
   end

data/lib/sinclair/options/class_methods.rb

@@ -1,7 +1,5 @@
 # frozen_string_literal: true
 
-require 'set'
-
 class Sinclair
   class Options
     # Class Methods for {Sinclair::Options}

data/lib/sinclair/options.rb

@@ -1,7 +1,5 @@
 # frozen_string_literal: true
 
-require 'set'
-
 class Sinclair
   # @api public
   # @author Darthjee

data/lib/sinclair/settable/builder.rb

@@ -21,6 +21,10 @@ class Sinclair
       #
       # @option options type [Symbol] type to cast the value fetched
       # @option options default [Object] Default value
+      # @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(klass, *settings_name, **options)
         super(klass, **options)
 
@@ -62,6 +66,7 @@ class Sinclair
       alias read_block read_with
 
       attr_reader :settings
+
       # @method settings
       # @private
       # @api private
@@ -88,13 +93,14 @@ class Sinclair
       #
       # @return (see Sinclair#add_class_method)
       def add_setting_method(name)
-        options   = call_options
-        block     = read_block
-        caster    = caster_class.caster_for(type)
-        default   = options_object.default
+        read_options = call_options
+        block        = read_block
+        caster       = caster_class.caster_for(type)
+        default      = options_object.default
+        cached       = options.key?(:cached) ? options[:cached] : :full
 
-        add_class_method(name, cached: :full) do
-          value = instance_exec(name, **options, &block)
+        add_class_method(name, cached:) do
+          value = instance_exec(name, **read_options, &block)
 
           value ? caster.cast(value) : default
         end

data/lib/sinclair/settable/caster.rb

@@ -56,6 +56,8 @@ class Sinclair
       cast_with(:integer, &:to_i)
       cast_with(:string, &:to_s)
       cast_with(:float, &:to_f)
+      cast_with(:seconds) { |value| value.to_i.seconds }
+      cast_with(:boolean) { |value| value.to_s.downcase == 'true' }
     end
   end
 end

data/lib/sinclair/settable.rb

@@ -78,7 +78,7 @@ class Sinclair
       setting_with_options(*settings_name)
 
       defaults.each do |key, default|
-        setting_with_options(key, default: default)
+        setting_with_options(key, default:)
       end
     end
 
@@ -92,7 +92,16 @@ class Sinclair
     #   to be added
     # @param options [Hash<Symbol, Object>] setting exposition options
     # @option options type [Symbol] type to cast the value fetched
+    #   - integer: converts to Integer
+    #   - string: converts to String
+    #   - float: converts to Float
+    #   - seconds: converts to ActiveSupport::Duration in seconds
+    #   - boolean: converts to Boolean (true/false)
     # @option options default [Object] Default value
+    # @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+.
     #
     # @see with_settings
     # @return (see Sinclair#build)

data/lib/sinclair/version.rb

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

data/lib/sinclair.rb

@@ -205,8 +205,10 @@ class Sinclair
   #   @param name [String,Symbol] name of the method to be added
   #   @param code [String] code to be evaluated when the method is ran
   #   @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+
   #   @see MethodDefinition::StringDefinition
   #
   #   @example Using string code to add a string defined method
@@ -229,8 +231,10 @@ class Sinclair
   #   @param name [String,Symbol] name of the method to be added
   #   @param block [Proc]  block to be ran as 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+
   #   @see MethodDefinition::BlockDefinition
   #
   #   @example Using block to add a block method
@@ -254,8 +258,10 @@ class Sinclair
   #   @param type [Symbol] type of method definition
   #   @param block [Proc]  block to be ran as method when type is block
   #   @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+
   #   @see MethodDefinition::BlockDefinition
   #   @see MethodDefinition::StringDefinition
   #   @see MethodDefinition::CallDefinition
@@ -294,8 +300,8 @@ class Sinclair
   #     person.bond_name # returns 'Bond, James Bond'
   #
   # @return [Array<MethodDefinition>] the list of all currently defined instance methods
-  def add_method(*args, type: nil, **options, &block)
-    definitions.add(*args, type: type, **options, &block)
+  def add_method(*, type: nil, **, &)
+    definitions.add(*, type:, **, &)
   end
 
   # Add a method to the method list to be created on klass
@@ -305,8 +311,10 @@ class Sinclair
   #   @param name [String,Symbol] name of the method to be added
   #   @param code [String] code to be evaluated when the method is ran
   #   @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+
   #
   #   @example Adding a method by String
   #     class EnvFetcher
@@ -325,8 +333,10 @@ class Sinclair
   #   @param name [String,Symbol] name of the method to be added
   #   @param block [Proc]  block to be ran as 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+
   #
   #   @example Adding a method by Block
   #     class EnvFetcher
@@ -346,8 +356,10 @@ class Sinclair
   #   @param type [Symbol] type of method definition
   #   @param block [Proc]  block to be ran as method when type is block
   #   @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+
   #   @see MethodDefinition::BlockDefinition
   #   @see MethodDefinition::StringDefinition
   #   @see MethodDefinition::CallDefinition
@@ -379,8 +391,8 @@ class Sinclair
   #     env_fetcher.timeout # returns '10'
   #
   # @return [Array<MethodDefinition>] the list of all currently defined class methods
-  def add_class_method(*args, type: nil, **options, &block)
-    class_definitions.add(*args, type: type, **options, &block)
+  def add_class_method(*, type: nil, **, &)
+    class_definitions.add(*, type:, **, &)
   end
 
   # Evaluetes a block which will result in a String, the method code
@@ -453,8 +465,8 @@ class Sinclair
   #
   #   Purchase.new(2.3, 5).total_price # returns 11.5
   # @return [Array<MethodDefinition>] the list of all currently defined instance methods
-  def eval_and_add_method(name, &block)
-    add_method(name, instance_eval(&block))
+  def eval_and_add_method(name, &)
+    add_method(name, instance_eval(&))
   end
 
   private

data/sinclair.gemspec

@@ -12,29 +12,12 @@ Gem::Specification.new do |gem|
   gem.homepage              = 'https://github.com/darthjee/sinclair'
   gem.description           = 'Gem for easy concern creation'
   gem.summary               = gem.description
-  gem.required_ruby_version = '>= 2.5.0'
+  gem.required_ruby_version = '>= 3.3.1'
 
   gem.files                 = `git ls-files`.split($INPUT_RECORD_SEPARATOR)
   gem.executables           = gem.files.grep(%r{^bin/}) { |f| File.basename(f) }
-  gem.test_files            = gem.files.grep(%r{^(test|gem|features)/})
   gem.require_paths         = ['lib']
+  gem.metadata['rubygems_mfa_required'] = 'false'
 
-  gem.add_runtime_dependency 'activesupport', '~> 7.0.4'
-
-  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'
-  gem.add_development_dependency 'reek',               '6.0.3'
-  gem.add_development_dependency 'rspec',              '3.11.0'
-  gem.add_development_dependency 'rspec-core',         '3.11.0'
-  gem.add_development_dependency 'rspec-expectations', '3.11.0'
-  gem.add_development_dependency 'rspec-mocks',        '3.11.1'
-  gem.add_development_dependency 'rspec-support',      '3.11.0'
-  gem.add_development_dependency 'rubocop',            '0.80.1'
-  gem.add_development_dependency 'rubocop-rspec',      '1.38.1'
-  gem.add_development_dependency 'rubycritic',         '4.7.0'
-  gem.add_development_dependency 'simplecov',          '0.21.2'
-  gem.add_development_dependency 'yard',               '0.9.27'
-  gem.add_development_dependency 'yardstick',          '0.9.9'
+  gem.add_dependency 'activesupport', '~> 7.2.x'
 end

data/spec/integration/readme/my_class_spec.rb

@@ -10,9 +10,9 @@ describe MyClass do
   let(:age)   { 20 }
   let(:attributes) do
     {
-      name: name,
+      name:,
       surname: 'surname',
-      age: age,
+      age:,
       legs: 2
     }
   end

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

@@ -11,14 +11,14 @@ describe Sinclair::Model do
       expect(human1.name).to eq('John Doe')
       expect(human1.age).to eq(22)
       expect(human1.gender).to eq(:undefined)
-      expect(human1 == human2).to eq(true)
+      expect(human1 == human2).to be(true)
     end
 
     it 'Without comparable' do
       tv1 = Tv.new(model: 'Sans Sunga Xt')
       tv2 = Tv.new(model: 'Sans Sunga Xt')
 
-      expect(tv1 == tv2).to eq(false)
+      expect(tv1 == tv2).to be(false)
     end
   end
 end

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

@@ -11,7 +11,7 @@ describe Sinclair::Options do
       )
 
       expect(options.timeout).to eq(10)
-      expect(options.retries).to eq(nil)
+      expect(options.retries).to be_nil
       expect(options.protocol).to eq('http')
       expect(options.port).to eq(443)
     end

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

@@ -19,7 +19,7 @@ describe 'yard Sinclair#add_class_method' do
   describe 'Adding a method by Block' do
     it 'returns the timeout' do
       builder = Sinclair.new(klass)
-      builder.add_class_method(:timeout) { ENV['TIMEOUT'] }
+      builder.add_class_method(:timeout) { ENV.fetch('TIMEOUT', nil) }
       builder.build
       ENV['TIMEOUT'] = '300'
 
@@ -30,7 +30,7 @@ describe 'yard Sinclair#add_class_method' do
   describe 'Passing type block' do
     it 'creates new method' do
       builder = Sinclair.new(klass)
-      builder.add_class_method(:timeout, type: :block) { ENV['TIMEOUT'] }
+      builder.add_class_method(:timeout, type: :block) { ENV.fetch('TIMEOUT', nil) }
       builder.build
       ENV['TIMEOUT'] = '300'
 

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

@@ -15,8 +15,8 @@ describe 'yard Sinclair::Caster' do
     it 'Casts passing parameter' do
       base = Random.rand(3..6)
       initial = Random.rand(10..20)
-      log = MathCaster.cast(initial, :log, base: base)
-      exp = MathCaster.cast(log, :exp, base: base)
+      log = MathCaster.cast(initial, :log, base:)
+      exp = MathCaster.cast(log, :exp, base:)
 
       expect(exp).to be_between(initial - 0.0001, initial + 0.0001)
     end

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

@@ -45,7 +45,7 @@ describe 'yard Sinclair::Caster.cast_with' do
     values.map! do |config|
       value = config[:value]
       klass = config[:klass]
-      my_caster.cast(value, klass, klass: klass)
+      my_caster.cast(value, klass, klass:)
     end
 
     expect(values[0]).to eq('{"name":"john","age":20,"country":"BR"}')

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

@@ -6,8 +6,8 @@ describe Sinclair::ConfigFactory do
   describe '#yard' do
     subject(:factory) do
       described_class.new(
-        config_class: config_class,
-        config_attributes: config_attributes
+        config_class:,
+        config_attributes:
       )
     end
 
@@ -74,13 +74,13 @@ describe Sinclair::ConfigFactory do
 
       describe 'Setting name with hash and block' do
         it 'sets name on config' do
-          expect { factory.configure(email: email) { name 'John' } }
+          expect { factory.configure(email:) { name 'John' } }
             .to change(config, :name)
             .from(nil).to('John')
         end
 
         it 'sets email on config' do
-          expect { factory.configure(email: email) { name 'John' } }
+          expect { factory.configure(email:) { name 'John' } }
             .to change(config, :email)
             .from(nil).to(email)
         end

data/spec/integration/yard/sinclair/core_ext/object_spec.rb

@@ -7,8 +7,8 @@ describe Object do
         it do
           object = [1, 2, 3]
 
-          expect(object.is_any?(Hash, Class)).to eq(false)
-          expect(object.is_any?(Hash, Array)).to eq(true)
+          expect(object.is_any?(Hash, Class)).to be(false)
+          expect(object.is_any?(Hash, Array)).to be(true)
         end
       end
     end

data/spec/lib/sinclair/chain_settable_spec.rb

@@ -13,7 +13,9 @@ describe Sinclair::ChainSettable do
       source :app_client, env_setting
       source :my_app_client, Class.new(MyAppClient)
 
-      setting_with_options :username, :password, :host, :port, **options
+      setting_with_options :username, :password,
+                           :host, :port, :domain,
+                           :secret, **options
     end
   end
 
@@ -21,12 +23,15 @@ describe Sinclair::ChainSettable do
   let(:options_hash)      { {} }
   let(:username)          { 'my_login' }
   let(:password)          { Random.rand(10_000).to_s }
+  let(:prefix)            { '' }
 
   context 'when the first setting finds the data' do
     let(:username_key) { 'USERNAME' }
     let(:password_key) { 'PASSWORD' }
     let(:host_key)     { 'HOST' }
     let(:port_key)     { 'PORT' }
+    let(:domain_key)   { 'DOMAIN' }
+    let(:secret_key)   { 'SECRET' }
 
     it_behaves_like 'settings reading'
   end
@@ -36,6 +41,9 @@ describe Sinclair::ChainSettable do
     let(:password_key) { 'MY_APP_PASSWORD' }
     let(:host_key)     { 'MY_APP_HOST' }
     let(:port_key)     { 'MY_APP_PORT' }
+    let(:domain_key)   { 'MY_APP_DOMAIN' }
+    let(:secret_key)   { 'MY_APP_SECRET' }
+    let(:prefix)       { 'MY_APP_' }
 
     it_behaves_like 'settings reading'
   end
@@ -69,7 +77,7 @@ describe Sinclair::ChainSettable do
 
   context 'when none has value' do
     let(:default)      { 'some_default_username' }
-    let(:options_hash) { { default: default } }
+    let(:options_hash) { { default: } }
 
     it 'returns the first value' do
       expect(settable.username).to eq(default)

data/spec/lib/sinclair/config_factory_spec.rb

@@ -153,7 +153,7 @@ describe Sinclair::ConfigFactory do
     end
 
     context 'when config class was set from common class' do
-      subject(:factory) { described_class.new(config_class: config_class) }
+      subject(:factory) { described_class.new(config_class:) }
 
       let(:config_class) { Class.new }
 

data/spec/lib/sinclair/env_settable_spec.rb

@@ -12,6 +12,8 @@ describe Sinclair::EnvSettable do
   let(:password_key) { 'PASSWORD' }
   let(:host_key)     { 'HOST' }
   let(:port_key)     { 'PORT' }
+  let(:domain_key)   { 'DOMAIN' }
+  let(:secret_key)   { 'SECRET' }
 
   it_behaves_like 'settings reading'
 
@@ -22,6 +24,8 @@ describe Sinclair::EnvSettable do
     let(:password_key) { 'MY_APP_PASSWORD' }
     let(:host_key)     { 'MY_APP_HOST' }
     let(:port_key)     { 'MY_APP_PORT' }
+    let(:domain_key)   { 'MY_APP_DOMAIN' }
+    let(:secret_key)   { 'MY_APP_SECRET' }
 
     it_behaves_like 'settings reading'
   end

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

@@ -6,7 +6,7 @@ describe Sinclair::EqualsChecker::Reader do
   subject(:reader) { described_class.new(attribute) }
 
   let(:attribute) { :information }
-  let(:model)     { SampleModel.new(name: name, age: age) }
+  let(:model)     { SampleModel.new(name:, age:) }
   let(:name)      { 'The Name' }
   let(:age)       { 25 }
 

data/spec/lib/sinclair/matchers/add_class_method_spec.rb

@@ -23,7 +23,7 @@ describe Sinclair::Matchers::AddClassMethod do
       expect { matcher.matches?(proc {}) }
         .to raise_error(
           SyntaxError, 'You should specify which class the method is being added to' \
-          "add_class_method(:#{method}).to(klass)"
+                       "add_class_method(:#{method}).to(klass)"
         )
     end
   end

data/spec/lib/sinclair/matchers/add_class_method_to_spec.rb

@@ -60,7 +60,7 @@ describe Sinclair::Matchers::AddClassMethodTo do
         expect { matcher.matches?(event_proc) { 1 } }
           .to raise_error(
             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

data/spec/lib/sinclair/matchers/add_instance_method_spec.rb

@@ -25,7 +25,7 @@ describe Sinclair::Matchers::AddInstanceMethod do
       expect { matcher.matches?(proc {}) }
         .to raise_error(
           SyntaxError, 'You should specify which instance the method is being added to' \
-          "add_method(:#{method}).to(instance)"
+                       "add_method(:#{method}).to(instance)"
         )
     end
   end

data/spec/lib/sinclair/matchers/add_instance_method_to_spec.rb

@@ -69,7 +69,7 @@ describe Sinclair::Matchers::AddInstanceMethodTo do
         expect { matcher.matches?(event_proc) { 1 } }
           .to raise_error(
             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

data/spec/lib/sinclair/matchers/change_class_method_on_spec.rb

@@ -54,7 +54,7 @@ describe Sinclair::Matchers::ChangeClassMethodOn do
         expect { matcher.matches?(event_proc) { 1 } }
           .to raise_error(
             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

data/spec/lib/sinclair/matchers/change_class_method_spec.rb

@@ -25,7 +25,7 @@ describe Sinclair::Matchers::ChangeClassMethod do
       expect { matcher.matches?(proc {}) }
         .to raise_error(
           SyntaxError, 'You should specify which class the method is being changed on' \
-          "change_class_method(:#{method}).on(klass)"
+                       "change_class_method(:#{method}).on(klass)"
         )
     end
   end

data/spec/lib/sinclair/matchers/change_instance_method_on_spec.rb

@@ -65,7 +65,7 @@ describe Sinclair::Matchers::ChangeInstanceMethodOn do
         expect { matcher.matches?(event_proc) { 1 } }
           .to raise_error(
             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

data/spec/lib/sinclair/matchers/change_instance_method_spec.rb

@@ -25,7 +25,7 @@ describe Sinclair::Matchers::ChangeInstanceMethod do
       expect { matcher.matches?(proc {}) }
         .to raise_error(
           SyntaxError, 'You should specify which instance the method is being changed on' \
-          "change_method(:#{method}).on(instance)"
+                       "change_method(:#{method}).on(instance)"
         )
     end
   end

data/spec/lib/sinclair/method_builder/base_spec.rb

@@ -8,7 +8,7 @@ describe Sinclair::MethodBuilder::Base do
     let(:type)  { Sinclair::MethodBuilder::CLASS_METHOD }
 
     it do
-      expect { described_class.build(klass, instance_of(described_class), type: type) }
+      expect { described_class.build(klass, instance_of(described_class), type:) }
         .to raise_error(NotImplementedError)
     end
   end

data/spec/lib/sinclair/method_builder/block_method_builder_spec.rb

@@ -5,7 +5,7 @@ require 'spec_helper'
 describe Sinclair::MethodBuilder::BlockMethodBuilder do
   describe '#build' do
     subject(:builder) do
-      described_class.new(klass, definition, type: type)
+      described_class.new(klass, definition, type:)
     end
 
     let(:klass)       { Class.new }

data/spec/lib/sinclair/method_builder/call_method_builder_spec.rb

@@ -5,7 +5,7 @@ require 'spec_helper'
 describe Sinclair::MethodBuilder::CallMethodBuilder do
   describe '#build' do
     subject(:builder) do
-      described_class.new(klass, definition, type: type)
+      described_class.new(klass, definition, type:)
     end
 
     let(:call_name) { "attr_#{accessor_type}" }

data/spec/lib/sinclair/method_builder/string_method_builder_spec.rb

@@ -5,7 +5,7 @@ require 'spec_helper'
 describe Sinclair::MethodBuilder::StringMethodBuilder do
   describe '#build' do
     subject(:builder) do
-      described_class.new(klass, definition, type: type)
+      described_class.new(klass, definition, type:)
     end
 
     let(:klass)       { Class.new }

data/spec/lib/sinclair/method_definition_spec.rb

@@ -28,6 +28,7 @@ describe Sinclair::MethodDefinition do
           attr_reader :name
 
           def initialize(name)
+            super
             @name = name
           end