complex_config 0.26.0 → 0.27.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: 344002a57feb04b6b964c0a22190b91eb6516329583141521bb28b1151801a12
4
- data.tar.gz: c4827ea899280f0a61fb12aff86e38873e108146a21fddac406417b0a8aac838
3
+ metadata.gz: bb0168da7113c482a8b01b39e5eeab7b14979fa67a3a95727df1b6874a5899b3
4
+ data.tar.gz: a0024cc07bec355dd4627e34c2bf97f95067527ccb03e9dba22db372474a27fb
5
5
  SHA512:
6
- metadata.gz: 81baebce37c27193f528b07c5b5104d3527de3ece471df7493664832b53a5c69a24c120200e5814e34eeeeac9c31c4fbc28ede81ad8957f59cf98533bc40569d
7
- data.tar.gz: b22c324308a9b432a1134cb357ab98b8656f00c72052d462fcbe7c7c5972b4f7583f29d1fa332c94be80225bd44ebbc4137e77b6b1d7a9f9ab2c87b35b67ac55
6
+ metadata.gz: 3fb712daefe44011a52c1ddf773a2f12a6220c9656b3e9ef47b50a0335da070ed507fdffbd685f5845215e42d1b7d4ebeed55307c1bdbf3a9709faabeb7a1cb3
7
+ data.tar.gz: ff8045428bf18ea4732b2543224b45118cbe71f74f206c0a7636ca2a48f514adaca977111bfecec7c856c11e1ab04fc3139a2d714e4577fe8b9c547520a8ea2a
data/CHANGES.md CHANGED
@@ -1,5 +1,41 @@
1
1
  # Changes
2
2
 
3
+ ## 2026-11-15 v0.27.0
4
+
5
+ ### Fixes
6
+
7
+ - Corrected the misspelled `guidelins` key to `guidelines` in
8
+ `.contexts/code_comment.rb`.
9
+ - Fixed YARD documentation inaccuracies in `Proxy`, `Settings`, and `Provider`:
10
+ - Replaced the phantom `@attr_reader` in `Proxy` with a proper YARD block for
11
+ the `#complex_config_env` method.
12
+ - Corrected the description of `Settings#skip` to state that it throws a
13
+ `:skip` symbol rather than raising an exception.
14
+ - Clarified the `@return` tag for `Provider#write_config` to indicate that
15
+ the key is returned whenever encrypting, not only when `store_key` is true.
16
+
17
+ ### Improvements
18
+
19
+ - Rewrote the YARD cheatsheet in `.contexts/yard.md` as a documentation
20
+ generation guide:
21
+ - Replaced template-based references with an instructional guide for
22
+ generating YARD comments.
23
+ - Added a comprehensive example demonstrating documentation for classes,
24
+ methods, and attributes.
25
+ - Introduced rules specifying that only documentation comments should be
26
+ generated, omitting executable code.
27
+ - Defined constraints to exclude `@return` tags for void returns.
28
+
29
+ ### Build & CI
30
+
31
+ - Updated `s.rubygems_version` to **4.0.24** in `complex_config.gemspec`.
32
+ - Bumped the `gem_hadar` development dependency constraint to **>= 2.21.0**.
33
+
34
+ ### Documentation
35
+
36
+ - Added detailed header comments to `lib/complex_config/version.rb` explaining
37
+ its auto-generated nature and regeneration via `rake version`.
38
+
3
39
  ## 2026-07-10 v0.26.0
4
40
 
5
41
  ### New Features
data/VERSION CHANGED
@@ -1 +1 @@
1
- 0.26.0
1
+ 0.27.0
@@ -1,9 +1,9 @@
1
1
  # -*- encoding: utf-8 -*-
2
- # stub: complex_config 0.26.0 ruby lib
2
+ # stub: complex_config 0.27.0 ruby lib
3
3
 
4
4
  Gem::Specification.new do |s|
5
5
  s.name = "complex_config".freeze
6
- s.version = "0.26.0".freeze
6
+ s.version = "0.27.0".freeze
7
7
 
8
8
  s.required_rubygems_version = Gem::Requirement.new(">= 0".freeze) if s.respond_to? :required_rubygems_version=
9
9
  s.require_paths = ["lib".freeze]
@@ -17,13 +17,13 @@ Gem::Specification.new do |s|
17
17
  s.homepage = "https://github.com/flori/complex_config".freeze
18
18
  s.licenses = ["Apache-2.0".freeze]
19
19
  s.rdoc_options = ["--title".freeze, "ComplexConfig -- configuration library".freeze, "--main".freeze, "README.md".freeze]
20
- s.rubygems_version = "4.0.10".freeze
20
+ s.rubygems_version = "4.0.24".freeze
21
21
  s.summary = "configuration library".freeze
22
22
  s.test_files = ["spec/complex_config/config_spec.rb".freeze, "spec/complex_config/encryption_spec.rb".freeze, "spec/complex_config/key_source_spec.rb".freeze, "spec/complex_config/plugins_spec.rb".freeze, "spec/complex_config/provider_spec.rb".freeze, "spec/complex_config/settings_spec.rb".freeze, "spec/complex_config/shortcuts_spec.rb".freeze, "spec/spec_helper.rb".freeze]
23
23
 
24
24
  s.specification_version = 4
25
25
 
26
- s.add_development_dependency(%q<gem_hadar>.freeze, [">= 2.17.1".freeze])
26
+ s.add_development_dependency(%q<gem_hadar>.freeze, [">= 2.21.0".freeze])
27
27
  s.add_development_dependency(%q<rake>.freeze, [">= 0".freeze])
28
28
  s.add_development_dependency(%q<simplecov>.freeze, [">= 0".freeze])
29
29
  s.add_development_dependency(%q<rspec>.freeze, [">= 0".freeze])
@@ -329,7 +329,7 @@ class ComplexConfig::Provider
329
329
  # @param store_key [Boolean] Whether to store the encryption key in a
330
330
  # separate file
331
331
  #
332
- # @return [String, Boolean] The encryption key if stored, otherwise true
332
+ # @return [String, Boolean] The encryption key when encrypting, otherwise true
333
333
  # @see prepare_output for data formatting
334
334
  # @see provide_key_source for key management
335
335
  # @see flush_cache to clear the configuration cache after writing
@@ -6,9 +6,6 @@ module ComplexConfig
6
6
  # the actual configuration loading until a method is first called. It
7
7
  # supports environment-specific configuration lookups and can handle both
8
8
  # direct configuration access and existence checks.
9
- #
10
- # @attr_reader [String, nil] env The environment name used for configuration
11
- # lookups
12
9
  class Proxy < BasicObject
13
10
  # The proxy object's initialization method sets up the environment for
14
11
  # configuration access.
@@ -19,6 +16,20 @@ module ComplexConfig
19
16
  @env = env
20
17
  end
21
18
 
19
+ # The complex_config_env method retrieves the configured environment name
20
+ # for the proxy
21
+ #
22
+ # This method returns the environment name that was set during the
23
+ # initialization of the proxy object. It is used internally to determine
24
+ # the specific configuration environment to access when resolving dynamic
25
+ # method calls.
26
+ #
27
+ # @return [String, nil] the environment name configured for this proxy
28
+ # instance, or nil if no specific environment was set
29
+ def complex_config_env
30
+ @env
31
+ end
32
+
22
33
  # The to_s method returns a string representation of the proxy object.
23
34
  #
24
35
  # @return [String] the string 'ComplexConfig::Proxy'
@@ -610,7 +610,7 @@ class ComplexConfig::Settings < BasicObject
610
610
  id =~ /\?\z/ || attribute_set?(id)
611
611
  end
612
612
 
613
- # The skip method raises a skip exception to bypass plugin execution
613
+ # The skip method throws a :skip symbol to bypass plugin execution
614
614
  def skip
615
615
  throw :skip
616
616
  end
@@ -1,6 +1,11 @@
1
+ # Version information for the ComplexConfig gem.
2
+ #
3
+ # This module is auto-generated by GemHadar and exposes the
4
+ # current release version as a set of constants. Do not edit it
5
+ # by hand; it is rewritten on every `rake version` invocation.
1
6
  module ComplexConfig
2
- # ComplexConfig version
3
- VERSION = '0.26.0'
7
+ # The current version of the ComplexConfig gem as a String.
8
+ VERSION = '0.27.0'
4
9
  VERSION_ARRAY = VERSION.split('.').map(&:to_i) # :nodoc:
5
10
  VERSION_MAJOR = VERSION_ARRAY[0] # :nodoc:
6
11
  VERSION_MINOR = VERSION_ARRAY[1] # :nodoc:
metadata CHANGED
@@ -1,7 +1,7 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: complex_config
3
3
  version: !ruby/object:Gem::Version
4
- version: 0.26.0
4
+ version: 0.27.0
5
5
  platform: ruby
6
6
  authors:
7
7
  - Florian Frank
@@ -15,14 +15,14 @@ dependencies:
15
15
  requirements:
16
16
  - - ">="
17
17
  - !ruby/object:Gem::Version
18
- version: 2.17.1
18
+ version: 2.21.0
19
19
  type: :development
20
20
  prerelease: false
21
21
  version_requirements: !ruby/object:Gem::Requirement
22
22
  requirements:
23
23
  - - ">="
24
24
  - !ruby/object:Gem::Version
25
- version: 2.17.1
25
+ version: 2.21.0
26
26
  - !ruby/object:Gem::Dependency
27
27
  name: rake
28
28
  requirement: !ruby/object:Gem::Requirement
@@ -270,7 +270,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
270
270
  - !ruby/object:Gem::Version
271
271
  version: '0'
272
272
  requirements: []
273
- rubygems_version: 4.0.10
273
+ rubygems_version: 4.0.24
274
274
  specification_version: 4
275
275
  summary: configuration library
276
276
  test_files: