smart_config 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5baec6d3e93cb78128a09ddf0448b50b291c72d41002f161f0adbfcda8f0471d
-  data.tar.gz: 98b529930e526149c73a85080acb0b2b008db88d02e8a75f9720db195721e835
+  metadata.gz: 6c77b3cfa7c43568ea7791ab092681b4849013a52736c6a86b58520dfc65ebbd
+  data.tar.gz: 05fa38afe44718cf69416dbc3dc54d188c5089e82f9ebfa7bdfca38171dc14a6
 SHA512:
-  metadata.gz: 83b4657ecdfe488d740ab0494f391cbc8c9436339f0c794790da0e7f376c0a1383d80f9a20768977ca3a70eaa7edf2b3089a3605b148f2a28e5af0c6e14d7554
-  data.tar.gz: 321702e528aa873f3bb7953c72b8b805b75b497dfac2b7aa7060fb914c48f35f528367e5b4b538946db91bd61dd8cda5d5dd467bab5f28e8fb2f5f28afdf6607
+  metadata.gz: 80126e552dd05d1837b65d5cedecef13dddb21239222e913a256719264fcf9495019d78b617d76ca994598af5ff94d14f8ed017ffa0cd60bbb34d40747cf46ab
+  data.tar.gz: 63d1884eac87f5f04f898fb0fc317fda3bd95423390a0604587c91ee63208de275b027061ececdad3be79994ede65456b7c87dba4206a671613e1cc6b4f9662e

data/README.md

@@ -85,19 +85,22 @@ All available options are:
 | default     | Sets a default value for the field, if no configuration could be found. If this option is not set, getting an unset field will raise an exception. |
 | format      | Sets the format of the field. If this option is not set, the field will be formatted as string.                                                    |
 | description | A free-form text description of the field. Optional. Used for documentation generation.                                                           |
+| example     | A free-form example value for the field. Optional. Used for documentation generation.                                                             |
+| no_docs     | When set to `true`, excludes the field from documentation generation.                                                                             |
 
-The `description` option is also accepted on `group`:
+The `description`, `example`, and `no_docs` options are also accepted on `group`. When `no_docs: true` is set on a group, the entire group and all its nested values are excluded from documentation.
 
 ```ruby
 group :smtp, description: 'SMTP server settings' do
-  value :hostname, description: 'The SMTP server hostname'
-  value :port, format: :integer, description: 'The SMTP server port'
+  value :hostname, description: 'The SMTP server hostname', example: 'smtp.example.com'
+  value :port, format: :integer, description: 'The SMTP server port', example: '587'
+  value :password, no_docs: true
 end
 ```
 
 #### Generating Documentation
 
-`SmartConfig::Markdown` renders a Markdown table documenting all values in a config module, including their descriptions, defaults, and formats:
+`SmartConfig::Markdown` renders a Markdown table documenting all values in a config module, including their descriptions, examples, defaults, and formats:
 
 ```ruby
 puts SmartConfig::Markdown.new(Config).render
@@ -106,11 +109,11 @@ puts SmartConfig::Markdown.new(Config).render
 Output:
 
 ```
-| Key            | Description              | Default | Format  |
-|----------------|--------------------------|---------|---------|
-| app_name       |                          | My App  | string  |
-| smtp.hostname  | The SMTP server hostname |         | string  |
-| smtp.port      | The SMTP server port     |         | integer |
+| Key            | Description              | Example          | Default | Format  |
+|----------------|--------------------------|------------------|---------|---------|
+| app_name       |                          |                  | My App  | string  |
+| smtp.hostname  | The SMTP server hostname | smtp.example.com |         | string  |
+| smtp.port      | The SMTP server port     | 587              |         | integer |
 ```
 
-Values from nested groups are listed with their full dotted key path. Groups themselves are not rendered as rows.
+Values from nested groups are listed with their full dotted key path. Groups themselves are not rendered as rows. Values and groups with `no_docs: true` are omitted entirely.

data/lib/smart_config/markdown.rb

@@ -14,10 +14,10 @@ module SmartConfig
       return '' if rows.empty?
 
       lines = []
-      lines << '| Key | Description | Default | Format |'
-      lines << '|-----|-------------|---------|--------|'
+      lines << '| Key | Description | Example | Default | Format |'
+      lines << '|-----|-------------|---------|---------|--------|'
       rows.each do |row|
-        cells = [row[:path], row[:description], row[:default], row[:format]]
+        cells = [row[:path], row[:description], row[:example], row[:default], row[:format]]
         lines << "| #{cells.map { |c| escape(c) }.join(' | ')} |"
       end
       lines.join("\n")
@@ -32,6 +32,8 @@ module SmartConfig
     def collect_entries(config, prefix)
       raw = config.instance_variable_get(:@config) || {}
       raw.flat_map do |key, entry|
+        next [] if entry[:no_docs]
+
         next_prefix = prefix + [key.to_s]
         if entry.key?(:group)
           collect_entries(entry[:group], next_prefix)
@@ -45,6 +47,7 @@ module SmartConfig
       {
         path: prefix.join('.'),
         description: entry.fetch(:description, ''),
+        example: entry.fetch(:example, ''),
         default: entry.key?(:default) ? entry[:default].to_s : '',
         format: entry[:format].to_s
       }

data/lib/smart_config/values.rb

@@ -37,6 +37,10 @@ module SmartConfig
       (@config || {})[name.to_sym]&.fetch(:description, '') || ''
     end
 
+    def example_for(name)
+      (@config || {})[name.to_sym]&.fetch(:example, '') || ''
+    end
+
     def get_value(name)
       return @config[name][:group] if @config[name].key?(:group)
 

data/lib/smart_config/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module SmartConfig
-  VERSION = '0.2.0'
+  VERSION = '0.3.0'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: smart_config
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors:
 - Damien MATHIEU