complex_config 0.22.2 → 0.23.0

data/lib/complex_config/tree.rb

@@ -1,5 +1,29 @@
 module ComplexConfig
+  # A tree class that provides hierarchical representation of configuration
+  # data
+  #
+  # The Tree class is used to create visual tree structures from configuration
+  # data, allowing for easy display and understanding of nested configuration
+  # settings. It supports both UTF-8 and ASCII character sets for rendering
+  # tree connections and can handle various data types including Settings
+  # objects, hashes, arrays, and primitive values.
+  #
+  # @see ComplexConfig::Settings
+  # @see ComplexConfig::Tree#to_s
+  # @see ComplexConfig::Tree#to_a
   class Tree
+    # The convert method transforms configuration data into a tree structure
+    #
+    # This method recursively processes configuration values and converts them
+    # into a hierarchical tree representation. It handles different value types
+    # including ComplexConfig::Settings objects, Hashes, Arrays, and primitive
+    # values, creating appropriate tree nodes for each case.
+    #
+    # @param name [Object] The name or key to use for the tree node
+    # @param value [Object] The configuration value to convert, which can be a
+    #   ComplexConfig::Settings object, Hash, Array, or primitive value
+    # @return [ComplexConfig::Tree] A tree object representing the hierarchical
+    #   structure of the configuration data
     def self.convert(name, value)
       case value
       when ComplexConfig::Settings
@@ -25,18 +49,42 @@ module ComplexConfig
       end
     end
 
+    # The initialize method sets up a new tree node with the specified name and
+    # UTF-8 support configuration.
+    #
+    # @param name [Object] The name or key to use for the tree node
+    # @param utf8 [Boolean] Whether to use UTF-8 characters for tree rendering,
+    #   defaults to the result of default_utf8
     def initialize(name, utf8: default_utf8)
       @name     = name
       @utf8     = utf8
       @children = []
     end
 
+    # The default_utf8 method determines whether UTF-8 character support should
+    # be enabled
+    #
+    # This method checks the LANG environment variable to determine if UTF-8
+    # encoding should be used for tree rendering.
+    #
+    # @return [TrueClass, FalseClass] true if the LANG environment variable indicates
+    #   UTF-8 encoding, false otherwise
     def default_utf8
       !!(ENV['LANG'] =~ /utf-8\z/i)
     end
 
     private
 
+    # The inner_child_prefix method determines the appropriate prefix string
+    # for tree child nodes
+    #
+    # This method returns a Unicode or ASCII character sequence used to
+    # visually represent the connection between parent and child nodes in a
+    # tree structure, depending on whether UTF-8 characters are enabled and
+    # whether the current node is the first child
+    #
+    # @param i [Integer] the index of the child node in relation to its siblings
+    # @return [String] the prefix string for the child node visualization
     def inner_child_prefix(i)
       if @utf8
         i.zero? ? "├─ " : "│  "
@@ -45,6 +93,11 @@ module ComplexConfig
       end
     end
 
+    # The last_child_prefix method determines the appropriate prefix string for
+    # tree child nodes
+    #
+    # @param i [Integer] the index of the child node in relation to its siblings
+    # @return [String] the prefix string for the last child node visualization
     def last_child_prefix(i)
       if @utf8
         i.zero? ? "└─ " : "   "
@@ -55,6 +108,16 @@ module ComplexConfig
 
     public
 
+    # The to_enum method creates an enumerator for tree traversal
+    #
+    # This method generates an Enumerator that yields string representations of
+    # the tree structure, including node names and their hierarchical
+    # relationships. It processes children recursively and applies appropriate
+    # prefix characters based on UTF-8 support and child position to visually
+    # represent the tree structure.
+    #
+    # @return [Enumerator] An enumerator that yields formatted tree node strings
+    #   in a hierarchical format with proper indentation and connection characters
     def to_enum
       Enumerator.new do |y|
         y.yield @name
@@ -74,20 +137,50 @@ module ComplexConfig
       end
     end
 
+    # The << method appends a child node to the tree structure
+    #
+    # @param child [ComplexConfig::Tree] the child tree node to add to this
+    #   node's children
+    # @return [self] returns self to allow for method chaining after adding the
+    #   child node
     def <<(child)
       @children << child
     end
 
+    # The to_ary method converts the tree structure to an array representation
+    #
+    # This method generates an array containing string representations of all
+    # nodes in the tree structure, including their hierarchical relationships
+    # and proper indentation with connection characters. It delegates to the
+    # to_enum method to produce the underlying enumeration before converting it
+    # to an array.
+    #
+    # @return [Array<String>] an array of formatted strings representing the tree
+    #   structure with proper indentation and visual connections between parent
+    #   and child nodes
     def to_ary
       to_enum.to_a
     end
 
+    # Alias for {to_ary}
+    #
+    # @see to_ary
     alias to_a to_ary
 
+    # The to_str method converts the tree structure to a string representation
+    #
+    # This method generates a string by joining all node representations in the
+    # tree with newline characters, providing a flat text representation of the
+    # hierarchical structure.
+    #
+    # @return [String] a newline-separated string containing all tree node representations
     def to_str
       to_ary * ?\n
     end
 
+    # Alias for {to_str}
+    #
+    # @see to_str
     alias to_s to_str
   end
 end

data/lib/complex_config/version.rb

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

data/lib/complex_config.rb

@@ -1,5 +1,18 @@
 require 'tins'
 
+# Main namespace module for the ComplexConfig library
+#
+# This module serves as the root namespace for all components of the
+# ComplexConfig system, providing configuration management, encryption
+# capabilities, and structured access to YAML-based configuration data with
+# support for environment-specific settings and plugin-based attribute
+# resolution.
+#
+# @see ComplexConfig::Config
+# @see ComplexConfig::Provider
+# @see ComplexConfig::Settings
+# @see ComplexConfig::Encryption
+# @see ComplexConfig::KeySource
 module ComplexConfig
 end
 

data/spec/complex_config/config_spec.rb

@@ -1,6 +1,6 @@
 require 'spec_helper'
 
-RSpec.describe ComplexConfig::Config do
+describe ComplexConfig::Config do
   let :plugin_code do
     -> id { skip }
   end

data/spec/complex_config/encryption_spec.rb

@@ -1,6 +1,6 @@
 require 'spec_helper'
 
-RSpec.describe ComplexConfig::Encryption do
+describe ComplexConfig::Encryption do
   let :secret do
     "\x1A8\x9E\xA8\xC2\x7F@@6\xB2W\a\x9A)\xCDw"
   end

data/spec/complex_config/key_source_spec.rb

@@ -1,6 +1,6 @@
 require 'spec_helper'
 
-RSpec.describe ComplexConfig::KeySource do
+describe ComplexConfig::KeySource do
   it 'should provide key from pathname' do
     ks = described_class.new(pathname: asset('with-key-file.yml'))
     expect(ks.key).to eq '90ec1139596f9dfdb51e72277735ce9a'

data/spec/complex_config/plugins_spec.rb

@@ -1,7 +1,7 @@
 require 'spec_helper'
 require 'complex_config/plugins/enable'
 
-RSpec.describe ComplexConfig::Plugins do
+describe ComplexConfig::Plugins do
   let :provider do
     ComplexConfig::Provider
   end

data/spec/complex_config/provider_spec.rb

@@ -1,7 +1,7 @@
 require 'spec_helper'
 require 'fileutils'
 
-RSpec.describe ComplexConfig::Provider do
+describe ComplexConfig::Provider do
   reset_new_config = -> * {
     described_class.config_dir = Pathname.new(__FILE__).dirname.dirname + 'config'
     described_class.key = nil

data/spec/complex_config/settings_spec.rb

@@ -1,6 +1,6 @@
 require 'spec_helper'
 
-RSpec.describe ComplexConfig::Settings do
+describe ComplexConfig::Settings do
   before do
     # Disable all plugins for this spec b/c they interfere with how rspec works
     allow(ComplexConfig::Provider.instance).to receive(:plugins).and_return([])

data/spec/complex_config/shortcuts_spec.rb

@@ -1,7 +1,7 @@
 require 'spec_helper'
 require 'complex_config/shortcuts'
 
-RSpec.describe 'shortcuts' do
+describe 'shortcuts' do
   let :provider do
     ComplexConfig::Provider
   end

data/spec/spec_helper.rb

@@ -1,8 +1,7 @@
-if ENV['START_SIMPLECOV'].to_i == 1
-  require 'simplecov'
-  SimpleCov.start do
-    add_filter "#{File.basename(File.dirname(__FILE__))}/"
-  end
+begin
+  require 'gem_hadar/simplecov'
+  GemHadar::SimpleCov.start
+rescue LoadError
 end
 require 'rspec'
 begin

metadata

@@ -1,14 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: complex_config
 version: !ruby/object:Gem::Version
-  version: 0.22.2
+  version: 0.23.0
 platform: ruby
 authors:
 - Florian Frank
-autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-10-21 00:00:00.000000000 Z
+date: 1980-01-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: gem_hadar
@@ -16,14 +15,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.19'
+        version: '2.6'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.19'
+        version: '2.6'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -94,6 +93,34 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: all_images
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.8'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.8'
+- !ruby/object:Gem::Dependency
+  name: context_spook
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.4'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.4'
 - !ruby/object:Gem::Dependency
   name: json
   requirement: !ruby/object:Gem::Requirement
@@ -112,36 +139,30 @@ dependencies:
   name: tins
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '1'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '1'
 - !ruby/object:Gem::Dependency
   name: mize
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.3'
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 0.3.4
+        version: '0.6'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.3'
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 0.3.4
+        version: '0.6'
 - !ruby/object:Gem::Dependency
   name: base64
   requirement: !ruby/object:Gem::Requirement
@@ -182,7 +203,6 @@ extra_rdoc_files:
 - lib/complex_config/tree.rb
 - lib/complex_config/version.rb
 files:
-- ".all_images.yml"
 - CHANGES.md
 - Gemfile
 - LICENSE
@@ -231,7 +251,6 @@ homepage: https://github.com/flori/complex_config
 licenses:
 - Apache-2.0
 metadata: {}
-post_install_message:
 rdoc_options:
 - "--title"
 - ComplexConfig -- configuration library
@@ -250,8 +269,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.18
-signing_key:
+rubygems_version: 3.6.9
 specification_version: 4
 summary: configuration library
 test_files:

data/.all_images.yml

@@ -1,16 +0,0 @@
-dockerfile: |-
-  RUN apk add --no-cache build-base git
-  RUN gem update --system
-  RUN gem install gem_hadar bundler
-script: &script |-
-  echo -e "\e[1m"
-  ruby -v
-  echo -e "\e[0m"
-  bundle install --full-index
-  rake spec
-
-images:
-  ruby:3.3-alpine: *script
-  ruby:3.2-alpine: *script
-  ruby:3.1-alpine: *script
-  ruby:3.0-alpine: *script