sinclair 3.0.0 → 3.1.0

data/spec/spec_helper.rb

@@ -1,6 +1,12 @@
 # frozen_string_literal: true
 
 require 'simplecov'
+require 'simplecov-lcov'
+
+if ENV['CI']
+  SimpleCov::Formatter::LcovFormatter.config.report_with_single_file = true
+  SimpleCov.formatter = SimpleCov::Formatter::LcovFormatter
+end
 
 SimpleCov.profiles.define 'gem' do
   add_filter '/spec/'

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/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/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:, default: 'my-host.com' } }
 
-    it 'returns default value' do
-      expect(settable.host).to eq('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 '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,13 +84,14 @@ 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
 
@@ -62,11 +99,21 @@ shared_examples 'settings reading' do
     let(:settings) { %i[port] }
     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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: sinclair
 version: !ruby/object:Gem::Version
-  version: 3.0.0
+  version: 3.1.0
 platform: ruby
 authors:
 - DarthJee
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2025-05-09 00:00:00.000000000 Z
+date: 2026-03-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -32,6 +32,8 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".circleci/config.yml"
+- ".github/copilot-instructions.md"
+- ".github/sinclair-usage.md"
 - ".gitignore"
 - ".rspec"
 - ".rubocop.yml"
@@ -109,7 +111,7 @@ files:
 - lib/sinclair/settable/class_methods.rb
 - lib/sinclair/version.rb
 - sinclair.gemspec
-- sinclair.jpg
+- sinclair.png
 - spec/integration/readme/my_class_spec.rb
 - spec/integration/readme/my_model_spec.rb
 - spec/integration/readme/sinclair/comparable_spec.rb
@@ -198,6 +200,7 @@ files:
 - spec/lib/sinclair/options_parser_spec.rb
 - spec/lib/sinclair/options_spec.rb
 - spec/lib/sinclair/settable/builder_spec.rb
+- spec/lib/sinclair/settable/caster_spec.rb
 - spec/lib/sinclair/settable_spec.rb
 - spec/lib/sinclair_spec.rb
 - spec/spec_helper.rb