kreds 1.0.0 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: bd360d0e070613f6faa2659de2f39cd477f4e4f4e9b2b8b040698ad6569b7b19
-  data.tar.gz: 6a8d3d9693fe0d81a8fa44495db0e147704f9db807620f83716166579d7a17c0
+  metadata.gz: de9b5e5f467bfe86da6487a402620213b7108dbcd90d64a5c088e8f563dc466e
+  data.tar.gz: c147c37a7ca2ea09f166022b0ffb294c5f452a33392a8d15edfe07ed30167a40
 SHA512:
-  metadata.gz: f97393f35e509b0c25ed21edcbb412ccf15dee7afc06542fc81d166d14a227d6255be674bc7463bb4cd6bcb8f7d163ce645ae808e7ad5ce1657f3bc33bb45e71
-  data.tar.gz: f8ea75d9b59928922488e95a49d7a0de81e61ac2aaf412384727644844623174a8b628f539bcf9a685889e20ae18ebfea4c213db12d83e0bf0a7eb43f3d30c39
+  metadata.gz: 164bdf54d2f0ec9037cc568c6749bd22fdca2fed40388a74f9a35a8954cf34cc74697efdb2516fa57c34966c194f9d65c466c0a447f6ca4489504c1d3c913bb3
+  data.tar.gz: 90850b11cbe6f9890dd7e60752251af0f3e323cf7c87a460677fef764a80421690d9de2979fd0e0761ffd29295fc686501385fd8e911bd6c35af8aaad51b8383

data/CHANGELOG.md

@@ -1,3 +1,7 @@
+## v1.1.0
+
+- Added block support for fallback behavior in all fetching methods
+
 ## v1.0.0
 
 - Dropped support for Rails 7.0

data/README.md

@@ -52,7 +52,7 @@ If all keys are correct but the value is blank, Kreds will raise `Kreds::BlankCr
 You can optionally provide a fallback environment variable:
 
 ```ruby
-Kreds.fetch!(:aws, :s3, :credentials, :access_key_id, env_var: "AWS_ACCESS_KEY_ID")
+Kreds.fetch!(:aws, :s3, :credentials, :access_key_id, var: "AWS_ACCESS_KEY_ID")
 ```
 
 If the key is missing or blank in credentials, Kreds will attempt to fetch the value from the specified environment variable.
@@ -85,6 +85,18 @@ You can also provide an optional fallback environment variable:
 Kreds.env_fetch!(:recaptcha, :site_key, var: "RECAPTCHA_SITE_KEY")
 ```
 
+### Pass a block on failure
+
+You can pass a block to `fetch!`, `env_fetch!`, and `var!`, which will be executed if the method fails to retrieve the value.
+
+```ruby
+Kreds.fetch!(:aws, :s3, :credentials, :access_key_id) do
+  raise MyCustomError, "Custom error message"
+end
+
+Kreds.var!("THREADS") { 1 }
+```
+
 ### Show credentials
 
 To inspect all credentials as a hash:

data/lib/kreds/fetch.rb

@@ -1,6 +1,6 @@
 module Kreds
   module Fetch
-    def fetch!(*keys, var: nil)
+    def fetch!(*keys, var: nil, &)
       validate_keys!(keys)
       validate_var!(var)
 
@@ -11,18 +11,21 @@ module Kreds
         fetch_key(hash, key, path, keys)
       end
     rescue Kreds::BlankCredentialsError, Kreds::UnknownCredentialsError => e
-      fallback_to_var(e, var)
+      fallback_to_var(e, var, &)
     end
 
-    def env_fetch!(*keys, var: nil)
-      fetch!(Rails.env, *keys, var: var)
+    def env_fetch!(*keys, var: nil, &)
+      fetch!(Rails.env, *keys, var: var, &)
     end
 
-    def var!(var)
+    def var!(var, &)
       validate_var!(var)
 
       result, success = check_var(var)
-      success ? result : raise(result)
+
+      return result if success
+
+      raise_or_yield(result, &)
     end
 
     private
@@ -50,11 +53,16 @@ module Kreds
       raise Kreds::UnknownCredentialsError, "Credentials key not found: [:#{path.join("][:")}]"
     end
 
-    def fallback_to_var(error, var)
-      return raise error if var.blank?
+    def fallback_to_var(error, var, &)
+      if var.present?
+        result, success = check_var(var)
 
-      result, success = check_var(var)
-      success ? result : raise(Kreds::Error, [error.message, result.message].join(", "))
+        return result if success
+
+        raise_or_yield(Kreds::Error.new([error.message, result.message].join(", ")), &)
+      end
+
+      raise_or_yield(error, &)
     end
 
     def check_var(var)
@@ -66,5 +74,9 @@ module Kreds
     rescue KeyError
       [Kreds::UnknownEnvironmentVariableError.new("Environment variable not found: #{var.inspect}"), false]
     end
+
+    def raise_or_yield(error, &)
+      block_given? ? yield : raise(error)
+    end
   end
 end

data/lib/kreds/version.rb

@@ -1,3 +1,3 @@
 module Kreds
-  VERSION = "1.0.0"
+  VERSION = "1.1.0"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: kreds
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.1.0
 platform: ruby
 authors:
 - enjaku4