const_conf 0.5.0 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 20b3d110806cb0cab793f81c1c2f5caf027cc8cab072154030524a1fffb147c2
-  data.tar.gz: 9af6c5ad81b643d069b5094a5663ef818f34b2b59641346c0251c47560301b56
+  metadata.gz: 75174c5894d1b360f0479a75f47121b16ea7cfd8d3bf92b6d6c886eb41620459
+  data.tar.gz: b8fcd102d3c0287854d4e5dc26b137840a5ff36596096d740b60830bdc7cc4c0
 SHA512:
-  metadata.gz: 19a8afc56213a644542b9b21946e4d6630ef7d9cca2cfa393f9a943f1733adce3d962b7d07f3b137fd33061a4c95d64d67c0789a10d02a6dde9ce2fd210503ff
-  data.tar.gz: 4cf7e96d1be6958b2f18eeeb8944120b15f0e429ae2a8ff6693cf0e659d342f2602f3ec5079b618aabec7febbca8ec7dc60b5768dc34ea5e307489b9823abc80
+  metadata.gz: 226ffb061d21faed487ba07e44a95f6a352b3da9fc38fdde00be4a15c6e5721cad0f436f85fea82d2f553b4a172335d3b6b6eca5578b84481d968f8130a29770
+  data.tar.gz: bd2d8a7cacff72d4f6d460120b3b85407863fdd451a35cf3a848f5c2bf98807b3b0d3c17cb9451e79321a4feda4b375778fac1c4996a73da916ad89f9f666ef3

data/CHANGES.md

@@ -1,5 +1,26 @@
 # Changes
 
+## 2026-01-27 v0.6.0
+
+- Added `documentation` method to `ConstConf` module that generates Markdown
+  documentation
+    - Method supports both string return and IO writing modes via `io:` parameter
+    - Handles sensitive values by redacting them with `_redacted_`
+    - Includes default value handling with `_undefined_` for nil defaults
+    - Method produces output suitable for README files and documentation
+    - Added comprehensive tests for the new `documentation` method
+    - Method integrates with existing `env_var_names` and `setting_for` infrastructure
+    - Supports `ConstConf::Setting` objects with proper description and default value handling
+- Updated CI configuration
+    - Use `bundle exec rake spec` instead of `rake spec`
+    - Added `before` and `after` hooks in CI script to remove `Gemfile.lock` during runs
+    - Added `changelog` configuration block to specify `CHANGES.md` as the changelog filename
+- Updated `all_images` gem dependency from version **0.8** to **>= 0.12**
+- Updated `gem_hadar` development dependency from **2.16.3** to **2.17.0**
+- Updated Ruby version from 4.0-rc-alpine to 4.0-alpine
+- Updated rubygems version to **4.0.3**
+- Simplified environment variable handling logic
+
 ## 2025-12-19 v0.5.0
 
 - Added `ruby:4.0-rc-alpine` image to test matrix in `.all_images.yml`

data/Rakefile

@@ -21,6 +21,10 @@ GemHadar do
     '.contexts', '.github'
   readme      'README.md'
 
+  changelog do
+    filename 'CHANGES.md'
+  end
+
   github_workflows(
     'static.yml' => {}
   )
@@ -34,8 +38,8 @@ GemHadar do
   development_dependency 'debug'
   development_dependency 'rspec',         '~> 3.13'
   development_dependency 'context_spook', '~> 0.4'
-  development_dependency 'all_images',    '~> 0.8'
   development_dependency 'simplecov',     '~> 0.22'
+  development_dependency 'all_images',    '>= 0.12'
 
   licenses << 'MIT'
 end

data/const_conf.gemspec

@@ -1,9 +1,9 @@
 # -*- encoding: utf-8 -*-
-# stub: const_conf 0.5.0 ruby lib
+# stub: const_conf 0.6.0 ruby lib
 
 Gem::Specification.new do |s|
   s.name = "const_conf".freeze
-  s.version = "0.5.0".freeze
+  s.version = "0.6.0".freeze
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0".freeze) if s.respond_to? :required_rubygems_version=
   s.require_paths = ["lib".freeze]
@@ -17,18 +17,18 @@ Gem::Specification.new do |s|
   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]
   s.required_ruby_version = Gem::Requirement.new(">= 3.2".freeze)
-  s.rubygems_version = "4.0.2".freeze
+  s.rubygems_version = "4.0.3".freeze
   s.summary = "Clean DSL for config settings with validation and Rails integration".freeze
   s.test_files = ["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.specification_version = 4
 
-  s.add_development_dependency(%q<gem_hadar>.freeze, ["~> 2.10".freeze])
+  s.add_development_dependency(%q<gem_hadar>.freeze, [">= 2.17.0".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.4".freeze])
-  s.add_development_dependency(%q<all_images>.freeze, ["~> 0.8".freeze])
   s.add_development_dependency(%q<simplecov>.freeze, ["~> 0.22".freeze])
+  s.add_development_dependency(%q<all_images>.freeze, [">= 0.12".freeze])
   s.add_runtime_dependency(%q<tins>.freeze, ["~> 1.43".freeze])
   s.add_runtime_dependency(%q<json>.freeze, ["~> 2.0".freeze])
   s.add_runtime_dependency(%q<complex_config>.freeze, ["~> 0.23".freeze])

data/lib/const_conf/setting.rb

@@ -247,8 +247,6 @@ class ConstConf::Setting
   def configured_value
     if ignored
       nil
-    elsif env_var.nil?
-      nil
     else
       env_var
     end

data/lib/const_conf/version.rb

@@ -1,6 +1,6 @@
 module ConstConf
   # ConstConf version
-  VERSION         = '0.5.0'
+  VERSION         = '0.6.0'
   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

@@ -424,6 +424,38 @@ module ConstConf
       end
     end
 
+    # Generates documentation for all configuration settings as a Markdown
+    # table
+    #
+    # This method provides a Markdown-formatted list showing all configuration
+    # settings with their environment variable names, descriptions, default
+    # values, and required status. The output is suitable for inclusion in
+    # README files or documentation.
+    #
+    # @param io [IO, nil] the IO object to write the documentation to; if nil, returns a String
+    # @return [String, nil] the Markdown documentation as a string if io is nil, nil otherwise
+    def documentation(io: nil)
+      result = io || +''
+      result << "## Environment variables\n\n"
+
+      env_var_names.map do |env_var_name|
+        setting_for(env_var_name)
+      end.each do |setting|
+        default = if setting.sensitive?
+                    '_redacted_'
+                  elsif setting.default_value.nil?
+                    '_undefined_'
+                  else
+                    "`#{setting.default_value.inspect}`"
+                  end
+        result << " - `#{setting.env_var_name}`\n"
+        result << "   - __description__: #{setting.description}\n"
+        result << "   - __default__: #{default}\n"
+      end
+
+      result
+    end
+
     # Iterates over a configuration module and its nested configurations in a
     # depth-first manner.
     #

data/spec/const_conf_spec.rb

@@ -256,14 +256,37 @@ describe ConstConf do
             expect(TestConstConf.setting_for('TEST_CONST_CONF_TEST').value).
               to eq 'bar'
           end
+        end
 
-          describe '.view' do
-            it 'renders tree view' do
-              expect(ConstConf::Tree).to receive(:from_const_conf).with(
-                TestConstConf
-              )
-              TestConstConf.view
-            end
+        describe '.view' do
+          it 'renders tree view' do
+            expect(ConstConf::Tree).to receive(:from_const_conf).with(
+              TestConstConf
+            )
+            TestConstConf.view
+          end
+        end
+
+        describe '.documentation' do
+          it 'generates markdown documentation' do
+            doc = TestConstConf.documentation
+            expect(doc).to be_a String
+            expect(doc).to include('## Environment variables')
+            expect(doc).to include('`TEST_CONST_CONF_TEST`')
+            expect(doc).to match(/description.*?test/)
+            expect(doc).to match(/default.*?bar/)
+          end
+
+          it 'writes documentation to IO object' do
+            io = StringIO.new
+            result = TestConstConf.documentation(io: io)
+
+            expect(result).to be_a StringIO
+            doc = io.string
+            expect(doc).to include('## Environment variables')
+            expect(doc).to include('`TEST_CONST_CONF_TEST`')
+            expect(doc).to match(/description.*?test/)
+            expect(doc).to match(/default.*?bar/)
           end
         end
       end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: const_conf
 version: !ruby/object:Gem::Version
-  version: 0.5.0
+  version: 0.6.0
 platform: ruby
 authors:
 - Florian Frank
@@ -13,16 +13,16 @@ dependencies:
   name: gem_hadar
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '2.10'
+        version: 2.17.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '2.10'
+        version: 2.17.0
 - !ruby/object:Gem::Dependency
   name: debug
   requirement: !ruby/object:Gem::Requirement
@@ -66,33 +66,33 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0.4'
 - !ruby/object:Gem::Dependency
-  name: all_images
+  name: simplecov
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.8'
+        version: '0.22'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.8'
+        version: '0.22'
 - !ruby/object:Gem::Dependency
-  name: simplecov
+  name: all_images
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '0.22'
+        version: '0.12'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '0.22'
+        version: '0.12'
 - !ruby/object:Gem::Dependency
   name: tins
   requirement: !ruby/object:Gem::Requirement
@@ -229,7 +229,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 4.0.2
+rubygems_version: 4.0.3
 specification_version: 4
 summary: Clean DSL for config settings with validation and Rails integration
 test_files: