sinclair 2.1.1 → 3.0.1

data/spec/lib/sinclair/method_definitions_spec.rb

@@ -48,22 +48,22 @@ describe Sinclair::MethodDefinitions do
       let(:arguments) { %i[attr_reader some_attribute other_attribute] }
 
       it do
-        expect(definitions.add(*arguments, type: type))
+        expect(definitions.add(*arguments, type:))
           .to be_a(Array)
       end
 
       it 'creates a new definition' do
-        expect(definitions.add(*arguments, type: type).last)
+        expect(definitions.add(*arguments, type:).last)
           .to be_a(Sinclair::MethodDefinition)
       end
 
       it 'creates a new definition of the chosen type' do
-        expect(definitions.add(*arguments, type: type).last)
+        expect(definitions.add(*arguments, type:).last)
           .to be_a(Sinclair::MethodDefinition::CallDefinition)
       end
 
       it 'initializes it correctly' do
-        expect { klass.module_eval(&definitions.add(*arguments, type: type).last.code_block) }
+        expect { klass.module_eval(&definitions.add(*arguments, type:).last.code_block) }
           .to add_method(:some_attribute).to(klass)
       end
     end
@@ -89,7 +89,7 @@ describe Sinclair::MethodDefinitions do
       end
 
       it 'initializes it correctly' do
-        expect(definitions.add(method_name, type: type, &block).last.name)
+        expect(definitions.add(method_name, type:, &block).last.name)
           .to eq(method_name)
       end
     end
@@ -100,22 +100,22 @@ describe Sinclair::MethodDefinitions do
       let(:code)        { '10' }
 
       it do
-        expect(definitions.add(method_name, code, type: type))
+        expect(definitions.add(method_name, code, type:))
           .to be_a(Array)
       end
 
       it 'creates a new definition' do
-        expect(definitions.add(method_name, code, type: type).last)
+        expect(definitions.add(method_name, code, type:).last)
           .to be_a(Sinclair::MethodDefinition)
       end
 
       it 'creates a new definition of the chosen type' do
-        expect(definitions.add(method_name, code, type: type).last)
+        expect(definitions.add(method_name, code, type:).last)
           .to be_a(Sinclair::MethodDefinition::StringDefinition)
       end
 
       it 'initializes it correctly' do
-        expect(definitions.add(method_name, code, type: type).last.name)
+        expect(definitions.add(method_name, code, type:).last.name)
           .to eq(method_name)
       end
     end

data/spec/lib/sinclair/model_spec.rb

@@ -3,7 +3,7 @@
 require 'spec_helper'
 
 describe Sinclair::Model do
-  subject(:model) { klass.new(name: name) }
+  subject(:model) { klass.new(name:) }
 
   let(:name)       { SecureRandom.hex(10) }
   let(:attributes) { %i[name] }
@@ -55,7 +55,7 @@ describe Sinclair::Model do
     end
 
     context 'when class is subclass of another model' do
-      subject(:model) { klass.new(name: name, age: age) }
+      subject(:model) { klass.new(name:, age:) }
 
       let(:age) { Random.rand(10..20) }
 
@@ -72,7 +72,7 @@ describe Sinclair::Model do
       end
 
       it 'is initialized with both attributes' do
-        expect { klass.new(name: name, age: age) }
+        expect { klass.new(name:, age:) }
           .not_to raise_error
       end
 

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

@@ -107,7 +107,7 @@ describe Sinclair::Options::ClassMethods do
           .to change {
             klass.invalid_options_in(test_keys)
           }.from(%i[protocol port invalid])
-          .to([:invalid])
+           .to([:invalid])
       end
 
       it do

data/spec/lib/sinclair/options_spec.rb

@@ -20,7 +20,7 @@ describe Sinclair::Options do
 
     context 'when initializing with valid args' do
       subject(:options) do
-        klass.new(timeout: timeout, protocol: 'http')
+        klass.new(timeout:, protocol: 'http')
       end
 
       let(:timeout) { Random.rand(10..19) }
@@ -44,7 +44,7 @@ describe Sinclair::Options do
 
     context 'when initializing subclass with valid args' do
       subject(:options) do
-        klass.new(timeout: timeout, protocol: 'http')
+        klass.new(timeout:, protocol: 'http')
       end
 
       let(:klass)   { Class.new(ConnectionOptions) }
@@ -142,7 +142,7 @@ describe Sinclair::Options do
     context 'when overriding values with false' do
       let(:options) { klass.new(protocol: false) }
 
-      it { expect(options.protocol).to eq(false) }
+      it { expect(options.protocol).to be(false) }
     end
   end
 

data/spec/lib/sinclair/settable/builder_spec.rb

@@ -16,7 +16,7 @@ describe Sinclair::Settable::Builder do
   let(:username)   { 'my_login' }
   let(:password)   { Random.rand(10_000).to_s }
   let(:settings)   { %i[username password] }
-  let(:options)    { { prefix: prefix } }
+  let(:options)    { { prefix: } }
 
   let(:builder) do
     described_class.new(settable, *settings, **options)
@@ -31,6 +31,8 @@ describe Sinclair::Settable::Builder 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'
   end
@@ -41,6 +43,8 @@ describe Sinclair::Settable::Builder 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/settable/caster_spec.rb

@@ -0,0 +1,79 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+describe Sinclair::Settable::Caster do
+  describe '.cast' do
+    context 'when casting to integer' do
+      it 'converts string to integer' do
+        expect(described_class.cast('10', :integer)).to eq(10)
+      end
+
+      it 'converts float to integer' do
+        expect(described_class.cast(10.5, :integer)).to eq(10)
+      end
+    end
+
+    context 'when casting to string' do
+      it 'converts integer to string' do
+        expect(described_class.cast(10, :string)).to eq('10')
+      end
+
+      it 'converts symbol to string' do
+        expect(described_class.cast(:symbol, :string)).to eq('symbol')
+      end
+    end
+
+    context 'when casting to float' do
+      it 'converts string to float' do
+        expect(described_class.cast('10.5', :float)).to eq(10.5)
+      end
+
+      it 'converts integer to float' do
+        expect(described_class.cast(10, :float)).to eq(10.0)
+      end
+    end
+
+    context 'when casting to seconds' do
+      it 'converts string to seconds duration' do
+        expect(described_class.cast('300', :seconds)).to eq(300.seconds)
+      end
+
+      it 'converts integer to seconds duration' do
+        expect(described_class.cast(60, :seconds)).to eq(60.seconds)
+      end
+    end
+
+    context 'when casting to boolean' do
+      it 'converts string "true" to boolean true' do
+        expect(described_class.cast('true', :boolean)).to be true
+      end
+
+      it 'converts string "TRUE" to boolean true' do
+        expect(described_class.cast('TRUE', :boolean)).to be true
+      end
+
+      it 'converts string "false" to boolean false' do
+        expect(described_class.cast('false', :boolean)).to be false
+      end
+
+      it 'converts string "FALSE" to boolean false' do
+        expect(described_class.cast('FALSE', :boolean)).to be false
+      end
+
+      it 'converts any other string to boolean false' do
+        expect(described_class.cast('anything', :boolean)).to be false
+      end
+
+      it 'converts nil to boolean false' do
+        expect(described_class.cast(nil, :boolean)).to be false
+      end
+    end
+
+    context 'when casting with unknown type' do
+      it 'returns the original value' do
+        expect(described_class.cast('value', :unknown)).to eq('value')
+      end
+    end
+  end
+end

data/spec/lib/sinclair/settable_spec.rb

@@ -13,6 +13,8 @@ describe Sinclair::Settable 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'
 
@@ -23,6 +25,8 @@ describe Sinclair::Settable 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
@@ -38,6 +42,8 @@ describe Sinclair::Settable 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' do
       let(:env_hash) { HashAppClient::HASH }

data/spec/spec_helper.rb

@@ -14,7 +14,7 @@ require 'pry-nav'
 
 support_files = File.expand_path('spec/support/**/*.rb')
 
-Dir[support_files].sort.each { |file| require file }
+Dir[support_files].each { |file| require file }
 
 RSpec.configure do |config|
   config.run_all_when_everything_filtered = true

data/spec/support/models/app_client.rb

@@ -5,4 +5,6 @@ class AppClient
 
   with_settings :username, :password, host: 'my-host.com'
   setting_with_options :port, type: :integer
+  setting_with_options :domain, cached: true
+  setting_with_options :secret, cached: false
 end

data/spec/support/models/default_valueable.rb

@@ -5,7 +5,7 @@ require './spec/support/models/default_value_builder'
 module DefaultValueable
   def default_reader(*methods, value:, accept_nil: false)
     DefaultValueBuilder.new(
-      self, value: value, accept_nil: accept_nil
+      self, value:, accept_nil:
     ).add_default_values(*methods)
   end
 end

data/spec/support/models/env_settings.rb

@@ -13,7 +13,7 @@ module EnvSettings
       env_key = [env_prefix, method_name].compact.join('_').upcase
 
       builder.add_class_method(method_name, cached: true) do
-        ENV[env_key]
+        ENV.fetch(env_key, nil)
       end
 
       builder.build

data/spec/support/models/hash_app_client.rb

@@ -11,4 +11,6 @@ class HashAppClient
 
   with_settings :username, :password, host: 'my-host.com'
   setting_with_options :port, type: :integer
+  setting_with_options :domain, cached: true
+  setting_with_options :secret, cached: false
 end

data/spec/support/models/my_app_client.rb

@@ -7,4 +7,6 @@ class MyAppClient
 
   with_settings :username, :password, host: 'my-host.com'
   setting_with_options :port, type: :integer
+  setting_with_options :domain, cached: true
+  setting_with_options :secret, cached: false
 end

data/spec/support/models/non_default_app_client.rb

@@ -5,4 +5,6 @@ class NonDefaultAppClient
 
   with_settings :username, :password, :host
   setting_with_options :port, type: :integer
+  setting_with_options :domain, cached: true
+  setting_with_options :secret, cached: false
 end

data/spec/support/models/random_generator.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 class RandomGenerator
-  KAPA = 3.9 + Random.rand / 10.0
+  KAPA = 3.9 + (Random.rand / 10.0)
 
   class << self
     def rand

data/spec/support/shared_examples/model.rb

@@ -18,7 +18,7 @@ shared_examples 'sinclair model building' do
     end
 
     it 'returns a new class with a comparable that finds matches' do
-      expect(model).to eq(klass.new(name: name))
+      expect(model).to eq(klass.new(name:))
     end
 
     it 'returns a new class with a comparable that find misses' do
@@ -48,7 +48,7 @@ shared_examples 'sinclair model building' do
     let(:options) { { comparable: false } }
 
     it 'returns a new class without comparable' do
-      expect(model).not_to eq(klass.new(name: name))
+      expect(model).not_to eq(klass.new(name:))
     end
   end
 

data/spec/support/shared_examples/settable.rb

@@ -4,6 +4,11 @@ shared_examples 'settings reading' do
   let(:env_hash) { ENV }
 
   context 'when the key is not set' do
+    after do
+      env_hash.delete(username_key)
+      env_hash.delete(password_key)
+    end
+
     it 'retrieves username from env' do
       expect(settable.username).to be_nil
     end
@@ -11,6 +16,16 @@ shared_examples 'settings reading' do
     it 'retrieves password from env' do
       expect(settable.password).to be_nil
     end
+
+    it 'cache username from env' do
+      expect { env_hash[username_key] = SecureRandom.hex }
+        .not_to(change(settable, :username))
+    end
+
+    it 'cache password from env' do
+      expect { env_hash[password_key] = SecureRandom.hex }
+        .not_to(change(settable, :password))
+    end
   end
 
   context 'when the key is set' do
@@ -31,14 +46,35 @@ shared_examples 'settings reading' do
     it 'retrieves password from env' do
       expect(settable.password).to eq(password)
     end
+
+    it 'cache username from env' do
+      expect { env_hash[username_key] = SecureRandom.hex }
+        .not_to(change(settable, :username))
+    end
+
+    it 'cache password from env' do
+      expect { env_hash[password_key] = SecureRandom.hex }
+        .not_to(change(settable, :password))
+    end
   end
 
   context 'when defining defaults' do
     let(:settings)   { %i[host] }
-    let(:options)    { { prefix: prefix, default: 'my-host.com' } }
+    let(:options)    { { prefix:, default: 'my-host.com' } }
+
+    after do
+      env_hash.delete(host_key)
+    end
+
+    context 'when not setting the env variable' do
+      it 'returns default value' do
+        expect(settable.host).to eq('my-host.com')
+      end
 
-    it 'returns default value' do
-      expect(settable.host).to eq('my-host.com')
+      it 'caches default value' do
+        expect { env_hash[host_key] = SecureRandom.hex }
+          .not_to(change(settable, :host))
+      end
     end
 
     context 'when setting the env variable' do
@@ -48,25 +84,36 @@ shared_examples 'settings reading' do
         env_hash[host_key] = other_host
       end
 
-      after do
-        env_hash.delete(host_key)
-      end
-
       it 'retrieves host from env' do
         expect(settable.host).to eq(other_host)
       end
+
+      it 'caches env value' do
+        expect { env_hash[host_key] = SecureRandom.hex }
+          .not_to(change(settable, :host))
+      end
     end
   end
 
   context 'when defining a type' do
     let(:settings) { %i[port] }
-    let(:options)  { { prefix: prefix, type: :integer } }
+    let(:options)  { { prefix:, type: :integer } }
     let(:port)     { Random.rand(10..100) }
+    let(:new_port) { Random.rand(1000..10_000) }
+
+    after do
+      env_hash.delete(port_key)
+    end
 
     context 'when the key is not set' do
       it 'retrieves port and cast to string' do
         expect(settable.port).to be_nil
       end
+
+      it 'caches port as nil' do
+        expect { env_hash[port_key] = new_port.to_s }
+          .not_to(change(settable, :port))
+      end
     end
 
     context 'when the key is set' do
@@ -74,13 +121,93 @@ shared_examples 'settings reading' do
         env_hash[port_key] = port.to_s
       end
 
-      after do
-        env_hash.delete(port_key)
-      end
-
       it 'retrieves port and cast to string' do
         expect(settable.port).to eq(port)
       end
+
+      it 'caches port as integer' do
+        expect { env_hash[port_key] = new_port.to_s }
+          .not_to(change(settable, :port))
+      end
+    end
+  end
+
+  context 'when defining cache type as true' do
+    let(:settings)      { %i[domain] }
+    let(:options)       { { prefix:, cached: true } }
+    let(:options_hash)  { options }
+    let(:domain)        { 'example.com' }
+    let(:new_domain)    { 'new-example.com' }
+
+    after do
+      env_hash.delete(domain_key)
+    end
+
+    context 'when the key is not set' do
+      it 'retrieves domain and cast to string' do
+        expect(settable.domain).to be_nil
+      end
+
+      it 'does not caches domain as nil' do
+        expect { env_hash[domain_key] = new_domain.to_s }
+          .to change(settable, :domain)
+          .from(nil).to(new_domain)
+      end
+    end
+
+    context 'when the key is set' do
+      before do
+        env_hash[domain_key] = domain.to_s
+      end
+
+      it 'retrieves domain and cast to string' do
+        expect(settable.domain).to eq(domain)
+      end
+
+      it 'caches domain as string' do
+        expect { env_hash[domain_key] = new_domain }
+          .not_to(change(settable, :domain))
+      end
+    end
+  end
+
+  context 'when defining cache false' do
+    let(:settings)      { %i[secret] }
+    let(:options)       { { prefix:, cached: false } }
+    let(:options_hash)  { options }
+    let(:secret)        { 'my_secret' }
+    let(:new_secret)    { 'new_secret' }
+
+    after do
+      env_hash.delete(secret_key)
+    end
+
+    context 'when the key is not set' do
+      it 'retrieves secret and cast to string' do
+        expect(settable.secret).to be_nil
+      end
+
+      it 'does not caches secret as nil' do
+        expect { env_hash[secret_key] = new_secret.to_s }
+          .to change(settable, :secret)
+          .from(nil).to(new_secret)
+      end
+    end
+
+    context 'when the key is set' do
+      before do
+        env_hash[secret_key] = secret.to_s
+      end
+
+      it 'retrieves secret and cast to string' do
+        expect(settable.secret).to eq(secret)
+      end
+
+      it 'does not caches secret' do
+        expect { env_hash[secret_key] = new_secret }
+          .to change(settable, :secret)
+          .from(secret).to(new_secret)
+      end
     end
   end
 end