superconfig 2.1.0 → 2.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c9e0e414be8780a5a7815b5cdceb25a430f86363bf9120e42b1d3a55ca756f46
-  data.tar.gz: 0a216ce70e1f2430517dec63f62efc22654c051898837e17979c3f91a6ebe565
+  metadata.gz: 38c1ba78820c0d5133c121b5b4157a94c0f49030ae4ae3ee700e231564d4bfc6
+  data.tar.gz: '014789c1819732d0b4e213d59189a5c958b60475ec06d71c3d25bdcc1c9bd0f9'
 SHA512:
-  metadata.gz: aa41c22654cec2830fc13fed09ff67b1db897b554d56109da014ba15152801a599524c88fedb482e4780cad795494ec36f49e39fd4e5b8d3d59e867418fc01a3
-  data.tar.gz: 2967f86046040444020ef8f04b8fe0161d1f27bf748b8c3c1ac464ebae342031ab1b5562c0194c1d780c4e13f19747c3b7ec2b5a6ae1ff1035d592adbeb2591d
+  metadata.gz: 43da8d2e33cdbcc32bc1c53d89bec045049500a6dca584d86eb8ce51fa6a14db3104b955d17cab3a5a3f493e831da923226a05399a07b6438ddf93cd3da52e21
+  data.tar.gz: 57723e9ac840ddf395a63496836770f4905ee4a2747f77fb72a19b49c8e81a51e1dffd9cff4ec2b99376caf94789d46c7a0a4e0f1750abe60d93b87241ac6b8f

data/.github/workflows/ruby-tests.yml

@@ -19,14 +19,14 @@ jobs:
     strategy:
       fail-fast: false
       matrix:
-        ruby: ["2.7", "3.0", "3.1"]
+        ruby: ["3.1", "3.2", "3.3"]
         gemfile:
           - Gemfile
 
     steps:
-      - uses: actions/checkout@v2.4.0
+      - uses: actions/checkout@v4
 
-      - uses: actions/cache@v2
+      - uses: actions/cache@v4
         with:
           path: vendor/bundle
           key: >

data/.rubocop.yml

@@ -3,7 +3,7 @@ inherit_gem:
   rubocop-fnando: .rubocop.yml
 
 AllCops:
-  TargetRubyVersion: 2.7
+  TargetRubyVersion: 3.1
   NewCops: enable
   Exclude:
     - vendor/**/*

data/CHANGELOG.md

@@ -11,6 +11,14 @@ Prefix your message with one of the following:
 - [Security] in case of vulnerabilities.
 -->
 
-## Unreleased
+# Unreleased
+
+- [Added] `SuperConfig#set(key, value)` method to set arbitrary values.
+
+## v2.1.1
+
+- [Changed] Ensure bad JSON strings doesn't leak it's contents.
+
+## v2.0.0
 
 - Initial release.

data/README.md

@@ -73,6 +73,14 @@ Config = SuperConfig.new do
 end
 ```
 
+You can also set values using `SuperConfig#set`.
+
+```ruby
+Config = SuperConfig.new do
+  set :domain, "example.com"
+end
+```
+
 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

data/lib/superconfig.rb

@@ -1,13 +1,13 @@
 # frozen_string_literal: true
 
 module SuperConfig
-  VERSION = "2.1.0"
+  VERSION = "2.2.0"
 
   MissingEnvironmentVariable = Class.new(StandardError)
   MissingCallable = Class.new(StandardError)
 
-  def self.new(**kwargs, &block)
-    Base.new(**kwargs, &block)
+  def self.new(...)
+    Base.new(...)
   end
 
   class Base
@@ -28,34 +28,6 @@ module SuperConfig
     end
     alias inspect to_s
 
-    def set(
-      name,
-      type,
-      default = nil,
-      required: false,
-      aliases: [],
-      description: nil
-    )
-      name = name.to_s
-      env_var = name.upcase
-
-      @attributes[env_var] = {required: required, default: default}
-
-      name = "#{name}?" if type == bool
-
-      validate!(env_var, required, description)
-
-      define_singleton_method(name) do
-        return default unless @env.key?(env_var)
-
-        coerce(type, @env[env_var])
-      end
-
-      aliases.each do |alias_name|
-        define_singleton_method(alias_name, method(name))
-      end
-    end
-
     def validate!(env_var, required, description)
       return unless required
       return if @env.key?(env_var)
@@ -72,21 +44,25 @@ module SuperConfig
     end
 
     def mandatory(name, type, aliases: [], description: nil)
-      set(
+      assign(
         name,
         type,
         required: true,
-        aliases: aliases,
-        description: description
+        aliases:,
+        description:
       )
     end
 
     def optional(name, type, default = nil, aliases: [], description: nil)
-      set(name, type, default, aliases: aliases, description: description)
+      assign(name, type, default, aliases:, description:)
+    end
+
+    def set(name, value)
+      property(name) { value }
     end
 
     def property(name, func = nil, cache: true, description: nil, &block) # rubocop:disable Lint/UnusedMethodArgument
-      callable = (func || block)
+      callable = func || block
 
       unless callable
         raise MissingCallable, "arg[1] must respond to #call or pass a block"
@@ -103,7 +79,7 @@ module SuperConfig
 
     def credential(name, &block)
       define_singleton_method(name) do
-        @__cache__["_credential_#{name}".to_sym] ||= begin
+        @__cache__[:"_credential_#{name}"] ||= begin
           value = Rails.application.credentials.fetch(name)
           block ? block.call(value) : value # rubocop:disable Performance/RedundantBlockCall
         end
@@ -169,44 +145,74 @@ module SuperConfig
       "#{report.join("\n")}\n"
     end
 
-    private def coerce_to_string(value)
+    private def coerce_to_string(_name, value)
       value
     end
 
-    private def coerce_to_bool(value)
+    private def coerce_to_bool(_name, value)
       BOOL_TRUE.include?(value)
     end
 
-    private def coerce_to_int(value)
+    private def coerce_to_int(_name, value)
       Integer(value) if !BOOL_FALSE.include?(value) && value
     end
 
-    private def coerce_to_float(value)
+    private def coerce_to_float(_name, value)
       Float(value) if value
     end
 
-    private def coerce_to_bigdecimal(value)
+    private def coerce_to_bigdecimal(_name, value)
       BigDecimal(value) if value
     end
 
-    private def coerce_to_symbol(value)
+    private def coerce_to_symbol(_name, value)
       value&.to_sym
     end
 
-    private def coerce_to_array(value, type)
-      value&.split(/, */)&.map {|v| coerce(type, v) }
+    private def coerce_to_array(name, value, type)
+      value&.split(/, */)&.map {|v| coerce(name, type, v) }
     end
 
-    private def coerce_to_json(value)
+    private def coerce_to_json(name, value)
       value && JSON.parse(value)
+    rescue JSON::ParserError
+      raise ArgumentError, "#{name} is not a valid JSON string"
     end
 
-    private def coerce(type, value)
+    private def coerce(name, type, value)
       main_type, sub_type = type
-      args = [value]
+      args = [name, value]
       args << sub_type if sub_type
 
-      send("coerce_to_#{main_type}", *args)
+      send(:"coerce_to_#{main_type}", *args)
+    end
+
+    private def assign(
+      name,
+      type,
+      default = nil,
+      required: false,
+      aliases: [],
+      description: nil
+    )
+      name = name.to_s
+      env_var = name.upcase
+
+      @attributes[env_var] = {required:, default:}
+
+      name = "#{name}?" if type == bool
+
+      validate!(env_var, required, description)
+
+      define_singleton_method(name) do
+        return default unless @env.key?(env_var)
+
+        coerce(env_var, type, @env[env_var])
+      end
+
+      aliases.each do |alias_name|
+        define_singleton_method(alias_name, method(name))
+      end
     end
   end
 end

data/superconfig.gemspec

@@ -1,13 +1,13 @@
 # frozen_string_literal: true
 
-require_relative "./lib/superconfig"
+require_relative "lib/superconfig"
 
 Gem::Specification.new do |spec|
   spec.name          = "superconfig"
   spec.version       = SuperConfig::VERSION
   spec.authors       = ["Nando Vieira"]
   spec.email         = ["me@fnando.com"]
-  spec.required_ruby_version = Gem::Requirement.new(">= 2.7.0")
+  spec.required_ruby_version = Gem::Requirement.new(">= 3.1.0")
   spec.metadata = {"rubygems_mfa_required" => "true"}
 
   spec.summary       = "Access environment variables. Also includes presence " \

metadata

@@ -1,14 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: superconfig
 version: !ruby/object:Gem::Version
-  version: 2.1.0
+  version: 2.2.0
 platform: ruby
 authors:
 - Nando Vieira
-autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-01-16 00:00:00.000000000 Z
+date: 2025-02-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -169,7 +168,6 @@ licenses:
 - MIT
 metadata:
   rubygems_mfa_required: 'true'
-post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -177,15 +175,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.7.0
+      version: 3.1.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.3
-signing_key:
+rubygems_version: 3.6.2
 specification_version: 4
 summary: Access environment variables. Also includes presence validation, type coercion
   and default values.