const_conf 0.0.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1d203a95288fee3358eba1ffa8033550252282e86446c08b1f262b9e98e6b84a
-  data.tar.gz: 68a77997fb9d3f2682f40447f1260f84b3453df63257ce006ae8cd5a92a2f84b
+  metadata.gz: 46f0215dedac0b12181bb9621013af573bd2b03e81a89840c09fab2759c88c7b
+  data.tar.gz: 5a4ee56d3186be9916bc137fe0826087a07c23bba9170e8cc2eb13aeaf0b1ccc
 SHA512:
-  metadata.gz: 30ed2d7b6797f23a445fd2e02baac6f78b6352ef25b454d6ed1d8eea86465516de2b4d90db178ef16b3fb9a72ae190b565f71ae43e1d6b6a561b383defc60eca
-  data.tar.gz: 5dacf8711fd6ab72c0f85dd748da9fbfbcdb4117dc07e87364fbfb7faca38ed57585050d3057dab68524da5a860be3f99e7fb46ac3eb8db8ccfcb3e1e9567df7
+  metadata.gz: ca385b1ae66ce0f2187f3dd6f54d572fd5138cc06cc10a292354bc3ca5a4b13abedd723d202b4dd98fcbc1334b8763cfe102936d7c98da8400b0e94a692442f2
+  data.tar.gz: 7901878fdbe3a08b9726f4d195e422ca93a4683cf37b1cc09edb1ffd7d6c57bdccefaa9706b212d2881ac09185e6c03f3ef7c811330793860fa1638eeb400db6

data/Rakefile

@@ -16,15 +16,15 @@ GemHadar do
   EOT
   test_dir    'spec'
   ignore      '.*.sw[pon]', 'pkg', 'Gemfile.lock', '.AppleDouble', '.bundle',
-    '.yardoc', 'doc', 'tags', 'coverage'
+    '.yardoc', 'doc', 'tags', 'coverage', 'cscope.out', '.starscope.db'
   package_ignore '.all_images.yml', '.gitignore', 'VERSION', '.utilsrc',
     '.github', *Dir['.contexts/*']
   readme      'README.md'
 
   dependency 'tins',           '~> 1.42'
-  dependency 'rails',          '~> 8'
   dependency 'json',           '~> 2.0'
   dependency 'complex_config', '~> 0.22'
+  dependency 'activesupport',  '~> 8'
   development_dependency 'debug'
   development_dependency 'rspec',         '~> 3.13'
   development_dependency 'context_spook', '~> 0.3'

data/const_conf.gemspec

@@ -1,9 +1,9 @@
 # -*- encoding: utf-8 -*-
-# stub: const_conf 0.0.0 ruby lib
+# stub: const_conf 0.1.1 ruby lib
 
 Gem::Specification.new do |s|
   s.name = "const_conf".freeze
-  s.version = "0.0.0".freeze
+  s.version = "0.1.1".freeze
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0".freeze) if s.respond_to? :required_rubygems_version=
   s.require_paths = ["lib".freeze]
@@ -22,14 +22,14 @@ Gem::Specification.new do |s|
 
   s.specification_version = 4
 
-  s.add_development_dependency(%q<gem_hadar>.freeze, ["~> 2.1".freeze])
+  s.add_development_dependency(%q<gem_hadar>.freeze, ["~> 2.2".freeze])
   s.add_development_dependency(%q<debug>.freeze, [">= 0".freeze])
   s.add_development_dependency(%q<rspec>.freeze, ["~> 3.13".freeze])
   s.add_development_dependency(%q<context_spook>.freeze, ["~> 0.3".freeze])
   s.add_development_dependency(%q<all_images>.freeze, ["~> 0.6".freeze])
   s.add_development_dependency(%q<simplecov>.freeze, ["~> 0.22".freeze])
   s.add_runtime_dependency(%q<tins>.freeze, ["~> 1.42".freeze])
-  s.add_runtime_dependency(%q<rails>.freeze, ["~> 8".freeze])
   s.add_runtime_dependency(%q<json>.freeze, ["~> 2.0".freeze])
   s.add_runtime_dependency(%q<complex_config>.freeze, ["~> 0.22".freeze])
+  s.add_runtime_dependency(%q<activesupport>.freeze, ["~> 8".freeze])
 end

data/lib/const_conf/json_plugin.rb

@@ -1,6 +1,31 @@
 require 'json'
 
+# A module that provides functionality for reading and parsing JSON file
+# contents as configuration values.
+#
+# The JSONPlugin module extends the ConstConf::Setting class to enable
+# configuration settings that are sourced from JSON files. This allows for
+# structured configuration data to be loaded from files and used within the
+# application's configuration system, supporting both standard JSON parsing and
+# environment-specific configuration loading.
 module ConstConf::JSONPlugin
+  # Reads and parses a JSON file, optionally with environment-specific loading
+  #
+  # This method attempts to read and parse a JSON file at the specified path.
+  # It supports environment-specific configuration loading when the env
+  # parameter is provided. The method uses thread synchronization to ensure
+  # safe access to the ComplexConfig provider.
+  #
+  # @param path [String] the filesystem path to the JSON file to be read
+  # @param required [Boolean] whether the file is required to exist, defaults to false
+  #
+  # @return [Object, nil] the parsed JSON content as a Ruby object, or nil if
+  # the file doesn't exist and required is false
+  #
+  # @raise [ConstConf::RequiredValueNotConfigured] if the file does not exist
+  # and required is true
+  # @raise [ConstConf::RequiredValueNotConfigured] if env is true and RAILS_ENV
+  # is not set and no explicit environment is provided
   def json(path, required: false, object_class: JSON::GenericObject)
     if File.exist?(path)
       JSON.load_file(path, object_class:)

data/lib/const_conf/setting.rb

@@ -349,6 +349,7 @@ class ConstConf::Setting
     io.string
   end
 
+  # The original inspect method.
   alias inspect_original inspect
 
   # The inspect method returns a string representation of the object, with

data/lib/const_conf/tree.rb

@@ -80,7 +80,7 @@ module ConstConf
           obj << convert_setting(setting)
         end
 
-        modul.constants.sort.each do |const_name|
+        modul.nested_module_constants.each do |const_name|
           begin
             const = modul.const_get(const_name)
             if const.is_a?(Module) && const < ConstConf

data/lib/const_conf/version.rb

@@ -1,6 +1,6 @@
 module ConstConf
   # ConstConf version
-  VERSION         = '0.0.0'
+  VERSION         = '0.1.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/yaml_plugin.rb

@@ -1,15 +1,42 @@
 require 'complex_config'
 
+# A module that provides functionality for reading and parsing YAML file
+# contents as configuration values.
+#
+# The YAMLPlugin module extends the ConstConf::Setting class to enable
+# configuration settings that are sourced from YAML files. This allows for
+# structured configuration data to be loaded from files and used within the
+# application's configuration system, supporting both standard YAML parsing and
+# environment-specific configuration loading.
 module ConstConf::YAMLPlugin
   include ComplexConfig::Provider::Shortcuts
 
+  # Reads and parses a YAML file, optionally with environment-specific loading
+  #
+  # This method attempts to read and parse a YAML file at the specified path.
+  # It supports environment-specific configuration loading when the env
+  # parameter is provided. The method uses thread synchronization to ensure
+  # safe access to the ComplexConfig provider.
+  #
+  # @param path [String] the filesystem path to the YAML file to be read
+  # @param required [Boolean] whether the file is required to exist, defaults to false
+  # @param env [Boolean, String] whether to load environment-specific configuration,
+  #   can be true to use RAILS_ENV or a specific environment string
+  #
+  # @return [Object, nil] the parsed YAML content as a Ruby object, or nil if
+  # the file doesn't exist and required is false
+  #
+  # @raise [ConstConf::RequiredValueNotConfigured] if the file does not exist
+  # and required is true
+  # @raise [ConstConf::RequiredValueNotConfigured] if env is true and RAILS_ENV
+  # is not set and no explicit environment is provided
   def yaml(path, required: false, env: false)
     if File.exist?(path)
       ConstConf.monitor.synchronize do
         config_dir = File.dirname(path)
         ComplexConfig::Provider.config_dir = config_dir
-        ext        = File.extname(path)
-        name       = File.basename(path, ext)
+        ext  = File.extname(path)
+        name = File.basename(path, ext)
         if env
           env == true and env = ENV['RAILS_ENV']
           if env

data/lib/const_conf.rb

@@ -20,7 +20,7 @@ require 'const_conf/json_plugin'
 require 'const_conf/yaml_plugin'
 require 'const_conf/env_dir_extension'
 require 'const_conf/tree'
-require 'const_conf/railtie'
+require 'const_conf/railtie' if defined? Rails::Railtie
 
 module ConstConf
   include ConstConf::Errors
@@ -129,7 +129,9 @@ module ConstConf
     #
     # @param id [ Symbol ] the name of the constant being added
     def const_added(id)
+      id = id.to_sym
       if const = const_get(id) and const.is_a?(Module)
+        nested_module_constants << id
         const.class_eval do
           include ConstConf
         end
@@ -165,6 +167,20 @@ module ConstConf
       super if defined? super
     end
 
+    # Removes a constant from the module and updates the nested module
+    # constants set.
+    #
+    # This method removes a constant from its parent module using the standard
+    # super mechanism and then removes the constant name from the
+    # nested_module_constants set to maintain consistency in tracking nested
+    # configuration modules.
+    #
+    # @param id [ Symbol ] the name of the constant to remove
+    private def remove_const(id)
+      super
+      nested_module_constants.delete(id.to_sym)
+    end
+
     # Sets or retrieves the description for a ConstConf module.
     #
     # This method provides access to the description attribute of a
@@ -197,6 +213,22 @@ module ConstConf
       @settings ||= {}
     end
 
+    # Returns the set of nested module constants for the configuration in
+    # definition order.
+    #
+    # This method provides access to the internal storage that tracks which
+    # constants within a configuration module are themselves modules that
+    # 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
+    # @see #const_added
+    # @see #nested_configurations
+    # @see #all_configurations
+    def nested_module_constants
+      @nested_module_constants ||= Set[]
+    end
+
     # The prefix reader accessor returns the configured prefix for the setting.
     #
     # @return [String, nil] the prefix value, or nil if not set
@@ -264,7 +296,7 @@ module ConstConf
     # @return [ Array<Module> ] an array containing nested configuration
     # modules that inherit from ConstConf
     def nested_configurations
-      constants.map { |c|
+      nested_module_constants.map { |c|
         begin
           m = const_get(c)
         rescue NameError
@@ -377,9 +409,10 @@ module ConstConf
     # Iterates over a configuration module and its nested configurations in a
     # depth-first manner.
     #
-    # This method yields each configuration module, including the receiver and all nested modules,
-    # in a depth-first traversal order. It is used internally to process all configuration
-    # settings across a module hierarchy.
+    # This method yields each configuration module, including the receiver and
+    # all nested modules, in a depth-first traversal order. It is used
+    # 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
@@ -389,12 +422,12 @@ module ConstConf
     def each_nested_configuration(&block)
       return enum_for(:each_nested_configuration) unless block_given?
       configuration_modules = [ self ]
-      while configuration = configuration_modules.shift
-        yield configuration
-        configuration.nested_configurations.each do
+      while configuration = configuration_modules.pop
+        configuration.nested_configurations.reverse_each do
           configuration_modules.member?(it) and next
           configuration_modules << it
         end
+        yield configuration
       end
     end
   end

data/spec/const_conf_spec.rb

@@ -88,34 +88,60 @@ describe ConstConf do
           module TestNestedConstConf
             include ConstConf
 
-            description 'TestConstConf'
+            module Zebra
+              description 'Last module defined'
 
-            module InnerConstConf
-              description 'InnerConstConf'
+              module InnerZebra
+                description 'Inner zebra'
+              end
+            end
+
+            module Alpha
+              description 'First module defined'
+
+              module InnerAlpha
+                description 'Inner alpha'
+              end
+            end
+
+            module Beta
+              description 'Middle module defined'
+
+              module InnerBeta
+                description 'Inner beta'
+              end
             end
           end
         end
 
         describe '.outer_configuration' do
           it 'knows about outer_configuration' do
-            expect(TestNestedConstConf::InnerConstConf.outer_configuration).
+            expect(TestNestedConstConf::Zebra::InnerZebra.outer_configuration).
               to eq TestNestedConstConf
           end
         end
 
         describe '.all_configurations' do
           it 'can return all configurations' do
-            expect(TestNestedConstConf.all_configurations).to eq(
-              [ TestNestedConstConf, TestNestedConstConf::InnerConstConf ]
-            )
+            expect(TestNestedConstConf.all_configurations).to eq [
+              TestNestedConstConf,
+              TestNestedConstConf::Zebra,
+              TestNestedConstConf::Zebra::InnerZebra,
+              TestNestedConstConf::Alpha,
+              TestNestedConstConf::Alpha::InnerAlpha,
+              TestNestedConstConf::Beta,
+              TestNestedConstConf::Beta::InnerBeta,
+            ]
           end
         end
 
         describe '.nested_configurations' do
           it 'can return nested configurations' do
-            expect(TestNestedConstConf.nested_configurations).to eq(
-              [ TestNestedConstConf::InnerConstConf ]
-            )
+            expect(TestNestedConstConf.nested_configurations).to eq [
+              TestNestedConstConf::Zebra,
+              TestNestedConstConf::Alpha,
+              TestNestedConstConf::Beta,
+            ]
           end
 
           describe '.each_nested_configuration' do
@@ -123,7 +149,37 @@ describe ConstConf do
               expect(TestNestedConstConf.each_nested_configuration).
                 to be_a Enumerator
               expect(TestNestedConstConf.each_nested_configuration.to_a).
-                to eq([ TestNestedConstConf, TestNestedConstConf::InnerConstConf ])
+                to eq [
+                  TestNestedConstConf,
+                  TestNestedConstConf::Zebra,
+                  TestNestedConstConf::Zebra::InnerZebra,
+                  TestNestedConstConf::Alpha,
+                  TestNestedConstConf::Alpha::InnerAlpha,
+                  TestNestedConstConf::Beta,
+                  TestNestedConstConf::Beta::InnerBeta,
+                ]
+            end
+          end
+
+          describe '.remove_const' do
+            it 'can remove a constant' do
+              expect(TestNestedConstConf.all_configurations).to eq [
+                TestNestedConstConf,
+                TestNestedConstConf::Zebra,
+                TestNestedConstConf::Zebra::InnerZebra,
+                TestNestedConstConf::Alpha,
+                TestNestedConstConf::Alpha::InnerAlpha,
+                TestNestedConstConf::Beta,
+                TestNestedConstConf::Beta::InnerBeta,
+              ]
+              TestNestedConstConf.send(:remove_const, :Alpha)
+              expect(TestNestedConstConf.all_configurations).to eq [
+                TestNestedConstConf,
+                TestNestedConstConf::Zebra,
+                TestNestedConstConf::Zebra::InnerZebra,
+                TestNestedConstConf::Beta,
+                TestNestedConstConf::Beta::InnerBeta,
+              ]
             end
           end
         end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: const_conf
 version: !ruby/object:Gem::Version
-  version: 0.0.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Florian Frank
@@ -15,14 +15,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.1'
+        version: '2.2'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.1'
+        version: '2.2'
 - !ruby/object:Gem::Dependency
   name: debug
   requirement: !ruby/object:Gem::Requirement
@@ -108,47 +108,47 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '1.42'
 - !ruby/object:Gem::Dependency
-  name: rails
+  name: json
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '8'
+        version: '2.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '8'
+        version: '2.0'
 - !ruby/object:Gem::Dependency
-  name: json
+  name: complex_config
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.0'
+        version: '0.22'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.0'
+        version: '0.22'
 - !ruby/object:Gem::Dependency
-  name: complex_config
+  name: activesupport
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.22'
+        version: '8'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.22'
+        version: '8'
 description: |
   ConstConf is a Ruby configuration library that manages settings
   through environment variables, files, and directories with comprehensive