const_conf 0.1.2 → 0.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 21696ce6543e72a68deeb2d52ce6bffe75276b71276bce49d6e7f21aa65ba541
-  data.tar.gz: 71be5a80a5074b05bea37a188dabd2539e2a608cb54514cdfe17c3053ec97d52
+  metadata.gz: 3f4332160b0b98f289ef65141551d279cdd3b24e7ff8e0187c04c1c9351ec645
+  data.tar.gz: 1d63082f8583882e65a772a0122b52613eea67eaecc70ccab49fe44c8efc0e8f
 SHA512:
-  metadata.gz: 5ccdd2ff221e1b0030951eb96c3ae360336a1a01abb97b85bdaccbf835cc60da8196eb5e5aa419f61ef425420835d66cc4c004049430466a16dc37b540fee9ac
-  data.tar.gz: '054088042d5a6b301482edf9c435d4258d98ddf23544874f95e0724af7a0986741cb83a5f795a74ab75a25e52a47a2c994b349ae23f8e613239d917f69b7ecd2'
+  metadata.gz: 241953d4a3f7c6265134bd300a5847a0232b59a8e4a8a62526344f34334e510a422ba313da10816b15bc9d9356f35c77a5b05164c517655bc3f335427bff460d
+  data.tar.gz: 7d30537f86f8828455ba14a3cd08741d162e15fcf1821484743bcf092cb6982e7e4b509e67b8a0b713f9e5b7fcd92d0f03fd810c0c2de288b8cbe8b46f45b12f

data/CHANGES.md

@@ -0,0 +1,42 @@
+# Changes
+
+## 2025-09-07 v0.2.1
+
+- Removed explicit boolean coercion previously applied to test values in
+  predicate methods
+
+## 2025-09-07 v0.2.0
+
+- Implemented `ConstConf::ConstConfHelper` module in
+  `lib/const_conf/spec/const_conf_helper.rb`
+- Added comprehensive testing chapter to README.md explaining usage of
+  `const_conf_as` helper
+- Helper supports nested module constants and predicate method mocking
+- Created `lib/const_conf/spec.rb` require file for testing utilities
+
+## 2025-09-02 v0.1.2
+
+- Added bold formatting to value display in tree output
+
+## 2025-09-01 v0.1.1
+
+- Enables usage in both Rails and non-Rails applications
+- Maintains Rails integration when Rails is present
+- Uses more precise dependency on Active Support rather than full Rails
+  framework
+
+## 2025-08-30 v0.1.0
+
+- Added `nested_module_constants` tracking set to maintain definition order
+- Updated `each_nested_configuration` to use depth-first search (DFS) with
+  correct ordering
+- Implemented override for `remove_const` method to keep tracking consistent
+- Added comprehensive tests for nested configuration ordering
+- Updated tree display implementation to use `nested_module_constants` instead
+  of `constants.sort`
+- Added comprehensive documentation and improved JSON/YAML plugin
+  implementations
+
+## 2025-08-28 v0.0.0
+
+  * Start

data/README.md

@@ -762,6 +762,76 @@ ConstConf automatically integrates with Rails:
 - Configuration is reloaded when the application prepares configuration
 - Works seamlessly with Rails environment variables
 
+## Testing with ConstConf
+
+ConstConf provides built-in testing utilities to make it easy to test your
+configuration in isolation.
+
+### Using `const_conf_as` Helper
+
+The `ConstConf::ConstConfHelper` provides a convenient way to temporarily
+override constant values during testing:
+
+```ruby
+# In your test file
+require 'const_conf/spec'
+
+RSpec.describe "MyApp" do
+  include ConstConf::ConstConfHelper
+  
+  it "works with overridden configuration" do
+    const_conf_as(
+      'AppConfig::DATABASE_URL' => 'postgresql://test:pass@localhost/test',
+      'AppConfig::API_KEY' => 'test-key-123'
+    )
+    
+    # Now your tests can use the overridden values
+    expect(AppConfig::DATABASE_URL).to eq('postgresql://test:pass@localhost/test')
+    expect(AppConfig::API_KEY).to eq('test-key-123')
+  end
+end
+```
+
+To make the helper available throughout your test suite, add this to your
+`spec/spec_helper.rb` or `rails_helper.rb`:
+
+```ruby
+require 'const_conf/spec'
+
+# spec/spec_helper.rb or spec/rails_helper.rb
+RSpec.configure do |config|
+  config.include ConstConf::ConstConfHelper
+end
+```
+
+### Testing Nested Modules
+
+The helper also works with nested configuration modules:
+
+```ruby
+const_conf_as(
+  'AppConfig::Database::URL' => 'postgresql://test:pass@localhost/test',
+  'AppConfig::Database::ENABLED' => true
+)
+```
+
+This automatically sets up the predicate methods (`?`) for nested constants, so
+you can test both the values and their active status:
+
+```ruby
+expect(AppConfig::Database::URL?).to be_truthy
+expect(AppConfig::Database::ENABLED?).to be true
+```
+
+The helper ensures that:
+- Constants exist before attempting to override them
+- Parent modules are properly handled for nested constants
+- Predicate methods are correctly mocked for boolean values
+- Proper error handling is in place for missing constants
+
+This approach makes testing configuration-dependent code much easier and more
+reliable than relying on environment variables or manual setup.
+
 ## Debugging and Inspection
 
 View configuration hierarchies:

data/const_conf.gemspec

@@ -1,9 +1,9 @@
 # -*- encoding: utf-8 -*-
-# stub: const_conf 0.1.2 ruby lib
+# stub: const_conf 0.2.1 ruby lib
 
 Gem::Specification.new do |s|
   s.name = "const_conf".freeze
-  s.version = "0.1.2".freeze
+  s.version = "0.2.1".freeze
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0".freeze) if s.respond_to? :required_rubygems_version=
   s.require_paths = ["lib".freeze]
@@ -11,8 +11,8 @@ Gem::Specification.new do |s|
   s.date = "1980-01-02"
   s.description = "ConstConf is a Ruby configuration library that manages settings\nthrough environment variables, files, and directories with comprehensive\nvalidation and Rails integration.\n".freeze
   s.email = "flori@ping.de".freeze
-  s.extra_rdoc_files = ["README.md".freeze, "lib/const_conf.rb".freeze, "lib/const_conf/dir_plugin.rb".freeze, "lib/const_conf/env_dir_extension.rb".freeze, "lib/const_conf/errors.rb".freeze, "lib/const_conf/file_plugin.rb".freeze, "lib/const_conf/json_plugin.rb".freeze, "lib/const_conf/railtie.rb".freeze, "lib/const_conf/setting.rb".freeze, "lib/const_conf/setting_accessor.rb".freeze, "lib/const_conf/tree.rb".freeze, "lib/const_conf/version.rb".freeze, "lib/const_conf/yaml_plugin.rb".freeze]
-  s.files = ["Gemfile".freeze, "LICENSE".freeze, "README.md".freeze, "Rakefile".freeze, "const_conf.gemspec".freeze, "lib/const_conf.rb".freeze, "lib/const_conf/dir_plugin.rb".freeze, "lib/const_conf/env_dir_extension.rb".freeze, "lib/const_conf/errors.rb".freeze, "lib/const_conf/file_plugin.rb".freeze, "lib/const_conf/json_plugin.rb".freeze, "lib/const_conf/railtie.rb".freeze, "lib/const_conf/setting.rb".freeze, "lib/const_conf/setting_accessor.rb".freeze, "lib/const_conf/tree.rb".freeze, "lib/const_conf/version.rb".freeze, "lib/const_conf/yaml_plugin.rb".freeze, "spec/assets/.env/API_KEY".freeze, "spec/assets/config.json".freeze, "spec/assets/config.yml".freeze, "spec/assets/config_env.yml".freeze, "spec/const_conf/dir_plugin_spec.rb".freeze, "spec/const_conf/env_dir_extension_spec.rb".freeze, "spec/const_conf/file_plugin_spec.rb".freeze, "spec/const_conf/json_plugin_spec.rb".freeze, "spec/const_conf/setting_accessor_spec.rb".freeze, "spec/const_conf/setting_spec.rb".freeze, "spec/const_conf/tree_spec.rb".freeze, "spec/const_conf/yaml_plugin_spec.rb".freeze, "spec/const_conf_spec.rb".freeze, "spec/spec_helper.rb".freeze]
+  s.extra_rdoc_files = ["README.md".freeze, "lib/const_conf.rb".freeze, "lib/const_conf/dir_plugin.rb".freeze, "lib/const_conf/env_dir_extension.rb".freeze, "lib/const_conf/errors.rb".freeze, "lib/const_conf/file_plugin.rb".freeze, "lib/const_conf/json_plugin.rb".freeze, "lib/const_conf/railtie.rb".freeze, "lib/const_conf/setting.rb".freeze, "lib/const_conf/setting_accessor.rb".freeze, "lib/const_conf/spec.rb".freeze, "lib/const_conf/spec/const_conf_helper.rb".freeze, "lib/const_conf/tree.rb".freeze, "lib/const_conf/version.rb".freeze, "lib/const_conf/yaml_plugin.rb".freeze]
+  s.files = ["CHANGES.md".freeze, "Gemfile".freeze, "LICENSE".freeze, "README.md".freeze, "Rakefile".freeze, "const_conf.gemspec".freeze, "lib/const_conf.rb".freeze, "lib/const_conf/dir_plugin.rb".freeze, "lib/const_conf/env_dir_extension.rb".freeze, "lib/const_conf/errors.rb".freeze, "lib/const_conf/file_plugin.rb".freeze, "lib/const_conf/json_plugin.rb".freeze, "lib/const_conf/railtie.rb".freeze, "lib/const_conf/setting.rb".freeze, "lib/const_conf/setting_accessor.rb".freeze, "lib/const_conf/spec.rb".freeze, "lib/const_conf/spec/const_conf_helper.rb".freeze, "lib/const_conf/tree.rb".freeze, "lib/const_conf/version.rb".freeze, "lib/const_conf/yaml_plugin.rb".freeze, "spec/assets/.env/API_KEY".freeze, "spec/assets/config.json".freeze, "spec/assets/config.yml".freeze, "spec/assets/config_env.yml".freeze, "spec/const_conf/dir_plugin_spec.rb".freeze, "spec/const_conf/env_dir_extension_spec.rb".freeze, "spec/const_conf/file_plugin_spec.rb".freeze, "spec/const_conf/json_plugin_spec.rb".freeze, "spec/const_conf/setting_accessor_spec.rb".freeze, "spec/const_conf/setting_spec.rb".freeze, "spec/const_conf/tree_spec.rb".freeze, "spec/const_conf/yaml_plugin_spec.rb".freeze, "spec/const_conf_spec.rb".freeze, "spec/spec_helper.rb".freeze]
   s.homepage = "https://github.com/flori/const_conf".freeze
   s.licenses = ["MIT".freeze]
   s.rdoc_options = ["--title".freeze, "ConstConf - Clean DSL for config settings with validation and Rails integration".freeze, "--main".freeze, "README.md".freeze]

data/lib/const_conf/dir_plugin.rb

@@ -51,9 +51,11 @@ module ConstConf::DirPlugin
     # configuration.
     #
     # @param name [String] the name used to derive the directory path
-    # @param root_path [String, nil] the root path to use for deriving the directory path
+    # @param root_path [String, nil] the root path to use for deriving the
+    # directory path
     # @param env_var [String, nil] the environment variable value to use
-    # @param env_var_name [String, nil] the name of the environment variable to look up
+    # @param env_var_name [String, nil] the name of the environment variable to
+    # look up
     #
     # @raise [ArgumentError] if env_var and env_var_name were given.
     def initialize(name, root_path: nil, env_var:, env_var_name: nil)
@@ -129,8 +131,10 @@ module ConstConf::DirPlugin
     # Derives the full directory path by combining the root path and the given
     # name.
     #
-    # @param name [ String ] the name of the directory to be appended to the root path
-    # @param root_path [ String, nil ] the root path to use; if nil, the default root path is used
+    # @param name [ String ] the name of the directory to be appended to the
+    # root path
+    # @param root_path [ String, nil ] the root path to use; if nil, the
+    # default root path is used
     #
     # @return [ Pathname ] the combined directory path as a Pathname object
     def derive_directory_path(name, root_path)
@@ -163,9 +167,11 @@ module ConstConf::DirPlugin
   #
   # @param name [String] the name of the configuration directory
   # @param path [String] the filesystem path to the directory
-  # @param env_var [String, nil] the environment variable name to use for configuration
+  # @param env_var [String, nil] the environment variable name to use for
+  # configuration
   # @param env_var_name [String, nil] the full environment variable name to use
-  # @param default [Object] the default value to use when no configuration is provided
+  # @param default [Object] the default value to use when no configuration is
+  # provided
   # @param required [Boolean] whether the directory path is required to exist
   #
   # @return [Object] the result of reading path from the directory name

data/lib/const_conf/env_dir_extension.rb

@@ -53,8 +53,10 @@ module ConstConf::EnvDirExtension
   # the filename and configures them as required and sensitive settings with
   # chomped values.
   #
-  # @param globs [Array<String>] glob patterns to match files containing environment variables
-  # @yield [ binding ] yields the binding of the caller to allow evaluation in the correct context
+  # @param globs [Array<String>] glob patterns to match files containing
+  # environment variables
+  # @yield [ binding ] yields the binding of the caller to allow evaluation in
+  # the correct context
   # @yieldparam binding [Binding] the binding to evaluate constants in
   def load_dotenv_dir(*globs, &block)
     block or raise ArgumentError, '&block argument is required'

data/lib/const_conf/file_plugin.rb

@@ -15,7 +15,8 @@ module ConstConf::FilePlugin
   # RequiredValueNotConfigured exception is raised.
   #
   # @param path [String] the filesystem path to the file to be read
-  # @param required [Boolean] whether the file is required to exist, defaults to false
+  # @param required [Boolean] whether the file is required to exist, defaults
+  # to false
   #
   # @return [String, nil] the content of the file if it exists, or nil if it
   # doesn't and required is false

data/lib/const_conf/setting.rb

@@ -99,9 +99,9 @@ class ConstConf::Setting
 
   # Checks if the configuration setting passes its validation check.
   #
-  # @return [Boolean, Symbol] true if the setting's check logic evaluates to true,
-  # false or false if not. I no check was defined, returns :unchecked_true.
-  # @see check
+  # @return [Boolean, Symbol] true if the setting's check logic evaluates to
+  # true, # false or false if not. I no check was defined, returns
+  # :unchecked_true. @see check
   def checked?
     instance_eval(&check)
   end
@@ -119,8 +119,10 @@ class ConstConf::Setting
   # @param value [Boolean, Proc] the value to set for the required flag
   #   - true/false: Simple boolean requirement check
   #   - Proc: Dynamic validation logic that can be evaluated in two ways:
-  #     * With arity 1: Called with the setting's value (e.g., `->(value) { value.present? }`)
-  #     * With arity 0: Called without arguments (e.g., `-> { some_value.present? }`)
+  #     * With arity 1: Called with the setting's value (e.g., `->(value) {
+  #     value.present? }`)
+  #     * With arity 0: Called without arguments (e.g., `-> {
+  #     some_value.present? }`)
   # @return [Boolean, Proc] returns the value that was set
   # @method required(value = nil, &block)
   # @see #required?
@@ -129,10 +131,10 @@ class ConstConf::Setting
   # Checks if the setting has a required value configured or as a default
   # value.
   #
-  # This method evaluates whether the configuration setting is marked as required
-  # and determines if a valid value is present. It handles different forms of
-  # required specification including boolean flags and Proc objects that can
-  # perform dynamic validation based on the current value or context.
+  # This method evaluates whether the configuration setting is marked as
+  # required and determines if a valid value is present. It handles different
+  # forms of required specification including boolean flags and Proc objects
+  # that can perform dynamic validation based on the current value or context.
   #
   # @return [Boolean] true if the setting is marked as required and has a valid
   #   value according to its validation logic, false otherwise

data/lib/const_conf/setting_accessor.rb

@@ -55,8 +55,10 @@ module ConstConf::SettingAccessor
   # objects which are evaluated when needed.
   #
   # @param name [Symbol] the name of the setting accessor to define
-  # @param default [Object] the default value for the setting, can be a Proc that gets evaluated
-  # @yield [] optional block to evaluate for default value when no explicit default is provided
+  # @param default [Object] the default value for the setting, can be a Proc
+  # that gets evaluated
+  # @yield [] optional block to evaluate for default value when no explicit
+  # default is provided
   # @return [Symbol] always returns the name as Symbol as it defines a method
   def setting_accessor(name, default = nil, transform: nil, &block)
     variable = "@#{name}"
@@ -76,7 +78,8 @@ module ConstConf::SettingAccessor
         if self.class.respond_to?(:setter_mode)
           if self.class.setter_mode && was_not_set
             raise ArgumentError,
-              "need an argument for the setting #{name.inspect} of #{self}, was nil"
+              "need an argument for the setting #{name.inspect} "\
+              "of #{self}, was nil"
           end
         end
         result =

data/lib/const_conf/spec/const_conf_helper.rb

@@ -0,0 +1,37 @@
+# Sets constants and their configured values for testing purposes.
+#
+# This module provides a helper method for temporarily overriding constant
+# values during testing, including nested constants within modules. It ensures
+# that specified constants exist before stubbing them and handles configuration
+# of boolean-check methods for nested constants.
+#
+# @example
+#   const_conf_as('FooConfig::DATABASE::ENABLED' => true)
+module ConstConf::ConstConfHelper
+  # Sets constants and their configured values for testing purposes.
+  #
+  # This method is designed to facilitate testing by allowing test code to
+  # temporarily override the values of constants, including nested constants
+  # within modules. It ensures that the specified constants exist before
+  # attempting to stub them, and also handles the configuration of
+  # boolean-check methods for nested constants.
+  #
+  # @param config_hash [Hash] a hash mapping constant names (as strings) to
+  # their intended values
+  def const_conf_as(config_hash)
+    config_hash.each do |const_name, value|
+      Object.const_defined?(const_name) or
+        raise NameError, "constant #{const_name} does not exist"
+      stub_const("#{const_name}", value)
+      const_parts = const_name.split('::')
+      if const_parts.size > 1
+        parent_const_name = const_parts[0..-2] * '::'
+        Object.const_defined?(parent_const_name) or raise NameError,
+          "parent constant #{parent_const_name} does not exist"
+        parent_const = Object.const_get(parent_const_name)
+        allow(parent_const).to receive("#{const_parts.last}?").
+          and_return(value)
+      end
+    end
+  end
+end

data/lib/const_conf/spec.rb

@@ -0,0 +1,2 @@
+require 'const_conf'
+require 'const_conf/spec/const_conf_helper'

data/lib/const_conf/version.rb

@@ -1,6 +1,6 @@
 module ConstConf
   # ConstConf version
-  VERSION         = '0.1.2'
+  VERSION         = '0.2.1'
   VERSION_ARRAY   = VERSION.split('.').map(&:to_i) # :nodoc:
   VERSION_MAJOR   = VERSION_ARRAY[0] # :nodoc:
   VERSION_MINOR   = VERSION_ARRAY[1] # :nodoc:

data/lib/const_conf.rb

@@ -32,7 +32,8 @@ module ConstConf
     # synchronize access to shared resources across threads. It ensures that
     # only one thread can execute critical sections of code at a time.
     #
-    # @return [Monitor] the singleton Monitor instance used for thread synchronization
+    # @return [Monitor] the singleton Monitor instance used for thread
+    # synchronization
     def monitor
       @monitor ||= Monitor.new
     end
@@ -43,7 +44,8 @@ module ConstConf
     # This method serves as a getter and setter for the module_files attribute,
     # which stores a hash mapping modules to their corresponding file paths.
     #
-    # @return [Hash, nil] the current value of the module_files instance variable
+    # @return [Hash, nil] the current value of the module_files instance
+    # variable
     attr_accessor :module_files
 
     # Registers a module-file mapping in the global registry.
@@ -68,7 +70,8 @@ module ConstConf
     # It collects the file paths associated with each module before removing
     # them, returning an array of the collected file paths.
     #
-    # @return [Array<String>] an array containing the file paths of the destroyed modules
+    # @return [Array<String>] an array containing the file paths of the
+    # destroyed modules
     def destroy
       monitor.synchronize do
         files = []
@@ -111,7 +114,8 @@ module ConstConf
     #
     # @param plugin [ Module ] the module to be included in ConstConf::Setting
     #
-    # @return [ Class ] returns the current class (self) to allow for method chaining
+    # @return [ Class ] returns the current class (self) to allow for method
+    # chaining
     def plugin(plugin)
       ConstConf::Setting.class_eval { include plugin }
       self
@@ -150,7 +154,8 @@ module ConstConf
           setting = Setting.new(name: [ name, id ], prefix:, &setting_block)
           if previous_setting = outer_configuration.setting_for(setting.env_var_name)
             raise ConstConf::SettingAlreadyDefined,
-              "setting for env var #{setting.env_var_name} already defined in #{previous_setting.name}"
+              "setting for env var #{setting.env_var_name} already defined "\
+              "in #{previous_setting.name}"
           end
           settings[setting.env_var_name] = setting
           const_set id, setting.value
@@ -202,13 +207,14 @@ module ConstConf
 
     # Returns the settings hash for the configuration module.
     #
-    # This method provides access to the internal hash that stores all configuration
-    # settings defined within the module. It ensures the hash is initialized before
-    # returning it, guaranteeing that subsequent accesses will return the same hash
-    # instance.
+    # This method provides access to the internal hash that stores all
+    # configuration settings defined within the module. It ensures the hash is
+    # initialized before returning it, guaranteeing that subsequent accesses
+    # will return the same hash instance.
     #
-    # @return [Hash<String, ConstConf::Setting>] the hash containing all settings
-    #   for this configuration module, keyed by their environment variable names
+    # @return [Hash<String, ConstConf::Setting>] the hash containing all
+    # settings for this configuration module, keyed by their environment
+    # variable names
     def settings
       @settings ||= {}
     end
@@ -221,7 +227,8 @@ module ConstConf
     # include ConstConf. It ensures the set is initialized before returning it,
     # guaranteeing that subsequent accesses will return the same set instance.
     #
-    # @return [Set<Symbol>] the set containing the names of nested module constants
+    # @return [Set<Symbol>] the set containing the names of nested module
+    # constants
     # @see #const_added
     # @see #nested_configurations
     # @see #all_configurations
@@ -264,7 +271,8 @@ module ConstConf
     # identifying the top-level configuration module that contains the current
     # one.
     #
-    # @return [ Module, nil ] the outer configuration module if found, or nil if none exists
+    # @return [ Module, nil ] the outer configuration module if found, or nil
+    # if none exists
     def outer_configuration
       [ self, *module_parents ].reverse_each.find { it < ConstConf }
     end
@@ -316,10 +324,14 @@ module ConstConf
     # environment variable name. It iterates through the module hierarchy to
     # find the setting, checking each module's settings hash for a match.
     #
-    # @param name [ String, Symbol ] the environment variable name to search for
-    # @param modules [ Array<Module> ] the array of modules to search within, defaults to [ self ]
+    # @param name [ String, Symbol ] the environment variable name to search
+    # for
     #
-    # @return [ ConstConf::Setting, nil ] the matching setting object if found, or nil if not found
+    # @param modules [ Array<Module> ] the array of modules to search within,
+    # defaults to [ self ]
+    #
+    # @return [ ConstConf::Setting, nil ] the matching setting object if found,
+    # or nil if not found
     def setting_for(name)
       name = name.to_s
       each_nested_configuration do |modul,|
@@ -338,8 +350,9 @@ module ConstConf
     # the module hierarchy to gather these names, ensuring that each setting's
     # environment variable name is included in the final result.
     #
-    # @return [Array<String>] an array containing all the environment variable names
-    #   used in the configuration settings across the module and its nested modules
+    # @return [Array<String>] an array containing all the environment variable
+    # names used in the configuration settings across the module and its nested
+    # modules
     def env_var_names
       names = Set[]
       each_nested_configuration do |modul,|
@@ -357,25 +370,27 @@ module ConstConf
     # environment variable names and values are their corresponding
     # configuration values.
     #
-    # @return [ Hash<String, Object> ] a hash mapping environment variable names to their values
+    # @return [ Hash<String, Object> ] a hash mapping environment variable
+    # names to their values
     def env_vars
       env_var_names.each_with_object({}) do |n, hash|
         hash[n] = setting_value_for(n)
       end
     end
 
-    # Retrieves the effective value for a configuration setting identified by its
-    # environment variable name.
+    # Retrieves the effective value for a configuration setting identified by
+    # its environment variable name.
     #
-    # This method looks up a configuration setting using the provided environment
-    # variable name and returns its effective value, which is determined by
-    # checking the environment variable and falling back to the default value if
-    # not set.
+    # This method looks up a configuration setting using the provided
+    # environment variable name and returns its effective value, which is
+    # determined by checking the environment variable and falling back to the
+    # default value if not set.
     #
-    # @param name [String, Symbol] the environment variable name used to identify the setting
+    # @param name [String, Symbol] the environment variable name used to
+    # identify the setting
     #
-    # @return [Object] the effective configuration value for the specified setting,
-    #   or the default value if the environment variable is not set
+    # @return [Object] the effective configuration value for the specified
+    # setting, or the default value if the environment variable is not set
     def setting_value_for(name)
       setting = setting_for(name)
       setting&.value
@@ -391,7 +406,8 @@ module ConstConf
     # standard output.
     #
     # @param object [Object] the ConstConf module or setting to display
-    # @param io [IO, nil] the IO object to write the output to; if nil, uses STDOUT
+    # @param io [IO, nil] the IO object to write the output to; if nil, uses
+    # STDOUT
     def view(object: self, io: nil)
       output = ConstConf::Tree.from_const_conf(object).to_a
       if io
@@ -414,8 +430,10 @@ module ConstConf
     # internally to process all configuration settings across a module
     # hierarchy.
     #
-    # @yield [ configuration ] yields each configuration module in the hierarchy
-    # @yieldparam configuration [ Module ] a configuration module from the hierarchy
+    # @yield [ configuration ] yields each configuration module in the
+    # hierarchy
+    # @yieldparam configuration [ Module ] a configuration module from the
+    # hierarchy
     #
     # @return [ Enumerator ] returns an enumerator if no block is given,
     # otherwise nil.

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: const_conf
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.2.1
 platform: ruby
 authors:
 - Florian Frank
@@ -167,10 +167,13 @@ extra_rdoc_files:
 - lib/const_conf/railtie.rb
 - lib/const_conf/setting.rb
 - lib/const_conf/setting_accessor.rb
+- lib/const_conf/spec.rb
+- lib/const_conf/spec/const_conf_helper.rb
 - lib/const_conf/tree.rb
 - lib/const_conf/version.rb
 - lib/const_conf/yaml_plugin.rb
 files:
+- CHANGES.md
 - Gemfile
 - LICENSE
 - README.md
@@ -185,6 +188,8 @@ files:
 - lib/const_conf/railtie.rb
 - lib/const_conf/setting.rb
 - lib/const_conf/setting_accessor.rb
+- lib/const_conf/spec.rb
+- lib/const_conf/spec/const_conf_helper.rb
 - lib/const_conf/tree.rb
 - lib/const_conf/version.rb
 - lib/const_conf/yaml_plugin.rb