superconfig 2.2.0 → 3.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 38c1ba78820c0d5133c121b5b4157a94c0f49030ae4ae3ee700e231564d4bfc6
-  data.tar.gz: '014789c1819732d0b4e213d59189a5c958b60475ec06d71c3d25bdcc1c9bd0f9'
+  metadata.gz: fae15b25d13e8edeb01416840600001b47723b09842466d40cfc65b491a4e236
+  data.tar.gz: 0d7e291466bf767592b1b7f16e64fd62fb865659212b58664c8c78ff65699407
 SHA512:
-  metadata.gz: 43da8d2e33cdbcc32bc1c53d89bec045049500a6dca584d86eb8ce51fa6a14db3104b955d17cab3a5a3f493e831da923226a05399a07b6438ddf93cd3da52e21
-  data.tar.gz: 57723e9ac840ddf395a63496836770f4905ee4a2747f77fb72a19b49c8e81a51e1dffd9cff4ec2b99376caf94789d46c7a0a4e0f1750abe60d93b87241ac6b8f
+  metadata.gz: 3a301a35a1e4daf689ab1d50c026d1c620328ad50ad24e2d09625d1fc9f97141b6d9079b1f06af9f4d26ddf6aa23c79905d428dc21572983ac812940e550f26f
+  data.tar.gz: 326dc0c6f7e035520e9df57ba3f55fcb7dfc4041ea77925a5e66442420add636a4690856fbe56a0f81b19a848524e61eeaa3872e04a9edf8d5fa0c998c1c062d

data/.gitignore

@@ -8,3 +8,4 @@
 /spec/reports/
 /tmp/
 *.enc
+.minitestfailures

data/CHANGELOG.md

@@ -11,7 +11,18 @@ Prefix your message with one of the following:
 - [Security] in case of vulnerabilities.
 -->
 
-# Unreleased
+# v3.0.0
+
+- [Added] Add support for prefixed env vars with (e.g. `MYAPP_`).
+- [Added] Add `SuperConfig#get` method to retrieve values.
+- [Changed] Define boolean properties defined with `SuperConfig#set` as
+  predicates.
+
+# v2.2.1
+
+- [Changed] Silence warnings when reassigning a method with `set`.
+
+# v2.2.0
 
 - [Added] `SuperConfig#set(key, value)` method to set arbitrary values.
 

data/README.md

@@ -38,6 +38,12 @@ Config.timeout
 Config.force_ssl?
 ```
 
+> [!NOTE]
+>
+> Properties defined with `bool` will always be named as predicates, ending with
+> `?`. The same thing happens if you define properties using `#set(name, value)`
+> where the value is a boolean.
+
 You can specify the description for both `mandatory` and `optional` methods;
 this will be used in exceptions.
 
@@ -49,6 +55,21 @@ end
 #=> SuperConfig::MissingEnvironmentVariable: MISSING_VAR (this is important) is not defined
 ```
 
+### Using prefixed environment variables
+
+If you're creating a library, you may want to use prefixed env vars. In this
+case, you can pass a prefix to `SuperConfig.new`.
+
+```ruby
+Config = SuperConfig.new(prefix: "MYAPP") do
+  optional :redis_url, string, "redis://127.0.0.1"
+end
+```
+
+This will look for `MYAPP_REDIS_URL` in the environment variables.
+
+### Setting arbitrary properties
+
 If you're going to use `SuperConfig` as your main configuration object, you can
 also set arbitrary properties, like the following:
 
@@ -64,6 +85,8 @@ Config.redis.get("key")
 #=> "value"
 ```
 
+### Caching values
+
 Values are cached by default. If you want to dynamically generate new values,
 set `cache: false`.
 
@@ -73,6 +96,8 @@ Config = SuperConfig.new do
 end
 ```
 
+### Setting values
+
 You can also set values using `SuperConfig#set`.
 
 ```ruby
@@ -81,6 +106,8 @@ Config = SuperConfig.new do
 end
 ```
 
+### Troubleshooting
+
 You may want to start a debug session without raising exceptions for missing
 variables. In this case, just pass `raise_exception: false` instead to log error
 messages to `$stderr`. This is especially great with Rails' credentials command
@@ -94,8 +121,10 @@ end
 #=> [SUPERCONFIG] DATABASE_URL (the leader database) is not defined
 ```
 
-I'd like to centralize access to my credentials; there's a handy mechanism for
-doing that with `SuperConfig`:
+### Rails credentials
+
+I like to centralize access to my Rails credentials; there's a handy mechanism
+for doing that with `SuperConfig`:
 
 ```ruby
 Config = SuperConfig.new do

data/lib/superconfig.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 module SuperConfig
-  VERSION = "2.2.0"
+  VERSION = "3.0.0"
 
   MissingEnvironmentVariable = Class.new(StandardError)
   MissingCallable = Class.new(StandardError)
@@ -14,8 +14,15 @@ module SuperConfig
     BOOL_TRUE = ["yes", "true", "1", true].freeze
     BOOL_FALSE = %w[no false].freeze
 
-    def initialize(env: ENV, raise_exception: true, stderr: $stderr, &block)
+    def initialize(
+      env: ENV,
+      prefix: nil,
+      raise_exception: true,
+      stderr: $stderr,
+      &block
+    )
       @env = env
+      @prefix = prefix
       @raise_exception = raise_exception
       @stderr = stderr
       @attributes = {}
@@ -29,6 +36,8 @@ module SuperConfig
     alias inspect to_s
 
     def validate!(env_var, required, description)
+      env_var = [@prefix, env_var].compact.join("_").upcase
+
       return unless required
       return if @env.key?(env_var)
 
@@ -57,8 +66,22 @@ module SuperConfig
       assign(name, type, default, aliases:, description:)
     end
 
+    def get(name)
+      predicate = "#{name}?"
+
+      if respond_to?(predicate)
+        public_send(predicate)
+      else
+        public_send(name)
+      end
+    end
+
     def set(name, value)
-      property(name) { value }
+      name = "#{name}?" if value.is_a?(TrueClass) || value.is_a?(FalseClass)
+
+      silence_warnings do
+        property(name) { value }
+      end
     end
 
     def property(name, func = nil, cache: true, description: nil, &block) # rubocop:disable Lint/UnusedMethodArgument
@@ -196,7 +219,7 @@ module SuperConfig
       description: nil
     )
       name = name.to_s
-      env_var = name.upcase
+      env_var = [@prefix, name].compact.join("_").upcase
 
       @attributes[env_var] = {required:, default:}
 
@@ -214,5 +237,13 @@ module SuperConfig
         define_singleton_method(alias_name, method(name))
       end
     end
+
+    private def silence_warnings(&)
+      old_verbose = $VERBOSE
+      $VERBOSE = nil
+      yield
+    ensure
+      $VERBOSE = old_verbose
+    end
   end
 end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: superconfig
 version: !ruby/object:Gem::Version
-  version: 2.2.0
+  version: 3.0.0
 platform: ruby
 authors:
 - Nando Vieira
 bindir: bin
 cert_chain: []
-date: 2025-02-10 00:00:00.000000000 Z
+date: 2025-03-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler