config 4.2.1 → 5.5.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d8e3673269abb8919961385bf27374aac4125d46988f5f69114feb7b2d36ef30
-  data.tar.gz: 040fff3a658f33f09da8296079a0672b28fbce8e3e6333c8dfacdfb8a239e998
+  metadata.gz: 7d45b7406d553675ee52e72b0844d60c2bf2f1f27bc8c29fb1833cbe86ca92d3
+  data.tar.gz: 234c1d664bc25031df364c3a8a3384544862cfb39b838c6c1b39e5d28687ea70
 SHA512:
-  metadata.gz: 859eda030f5b0ac224a367359f4fc8c1af2a45eab726c74691db3da79fd3f2cb8fa6f85011036be6fef7c07600a0f5687e96db2f3a09bb1430755bfb7322cd86
-  data.tar.gz: 0d233e69e12d0f92d6edd3d588e727905b8bff7d57b93027ec40290131ea3883208e4509db3fff946a30a326a6b34fe6fae340dacb12ea196cb07cd1eb68c850
+  metadata.gz: a107c67a53f64d1a4af4694d38355a028af0caee739ea640f32f03343f06a850b70bb64a580dcfdae2576e413cc83898f613fe196e8065ec36edc40712e02cf6
+  data.tar.gz: 2a24721b6a2e355c482659a6d76d657fc1b67fb3390fabffafeb9433bceb80423e0254aa972052a237f4f277815ea17442fa3ab86b3ce9521953c8ffab277de8

data/CHANGELOG.md

@@ -1,5 +1,52 @@
 # Changelog
 
+## 5.5.1
+
+### Documentation
+
+* Fix funding_url to funding_uri in gemspec ([#361](https://github.com/rubyconfig/config/pull/361))
+
+## 5.5.0
+
+### New features
+
+* Allow arrays to be passed through env variables ([#354](https://github.com/rubyconfig/config/pull/354))
+
+### Documentation
+
+* Use funding_url rather than post_install_message ([#360](https://github.com/rubyconfig/config/pull/360))
+* Fix typos in the tests and documentation ([#359](https://github.com/rubyconfig/config/pull/359))
+
+## 5.4.0
+
+### New features
+
+* Add configuration option `environment` to override the use of `Rails.env` ([#356](https://github.com/rubyconfig/config/pull/356))
+
+## 5.3.0
+
+* Remove `dry-validation` from dependencies ([#333](https://github.com/rubyconfig/config/pull/333))
+
+## 5.2.0
+
+### New features
+
+* Allow to use custom filename && directory name to store configs ([#341](https://github.com/rubyconfig/config/pull/341))
+
+### Bug fixes
+
+* Prevent name collision with private methods from ancestors ([#351](https://github.com/rubyconfig/config/pull/351))
+
+## 5.1.0
+
+* Fix conflicts with Rails 7 active_support methods ([#347](https://github.com/rubyconfig/config/pull/347))
+
+## 5.0.0
+
+### BREAKING CHANGES
+
+* No longer load `deep_merge`'s monkey patch for `Hash#deep_merge` and `Hash#deep_merge!` ([#342](https://github.com/rubyconfig/config/pull/342)). If you rely on those methods and are not using Rails / Active Support, you can load the monkey patch via `require 'deep_merge/deep_merge_hash'`. This change fixes Rails 7.x support.
+
 ## 4.2.1
 
 ### Bug fixes
@@ -26,7 +73,7 @@
 * Rails versions `< 5.2` are no longer supported ([#316](https://github.com/rubyconfig/config/pull/316))
 * Ruby versions `< 2.6` are no longer supported ([#316](https://github.com/rubyconfig/config/pull/316))
 * Support `HashSource` and `EnvSource` instances in `Config.load_files` and `Config.load_and_set_settings`. ([#315](https://github.com/rubyconfig/config/pull/315)). There are a few subtle breaking changes:
-  * Previously, `Config.load_files` (called from `Config.load_and_set_settings`) would call `.to_s` on each of its arguments. Now, this responsibility is defered to YAMLSource. In effect, if your application passes String or Pathname objects to `Config.load_files`, no changes are necessary, but if you were somehow relying on the `.to_s` call for some other type of object, you'll now need to call `.to_s` on that object before passing it to `Config`.
+  * Previously, `Config.load_files` (called from `Config.load_and_set_settings`) would call `.to_s` on each of its arguments. Now, this responsibility is deferred to YAMLSource. In effect, if your application passes String or Pathname objects to `Config.load_files`, no changes are necessary, but if you were somehow relying on the `.to_s` call for some other type of object, you'll now need to call `.to_s` on that object before passing it to `Config`.
   * Before this change, `Config.load_files` would call `uniq` on its argument array. This call has been removed, so duplicate file paths are not removed before further processing. In some cases, this can cause differences in behavior since later config files override the values in earlier ones. In most cases, it's best to ensure that duplicate paths are not passed to `Config.load_files`.
 
 ## 3.1.1

data/CONTRIBUTING.md

@@ -3,7 +3,7 @@
 Install appraisal
 
 ```bash
-gem install bundler -v 1.17.3
+gem install bundler
 gem install appraisal
 ```
 
@@ -16,13 +16,19 @@ bundle install
 Bootstrap
 
 ```bash
-appraisal install
+bundle exec appraisal install
+```
+
+If you need to create new test app for specific rails version
+
+```bash
+bundle exec appraisal rails-7.0 rails new spec/app/rails_7.0
 ```
 
 Run the test suite:
 
 ```bash
-appraisal rspec
+bundle exec appraisal rspec
 ```
 
 If you modified any of the documentation files verify their format:

data/README.md

@@ -53,6 +53,8 @@ which will generate customizable config file `config/initializers/config.rb` and
 
 You can now edit them to adjust to your needs.
 
+> Note: By default, the config environment will match the Rails environment (`Rails.env`). This can be changed by setting `config.environment`.
+
 ### Installing on Padrino
 
 Add the gem to your `Gemfile` and run `bundle install` to install it. Then edit `app.rb` and register `Config`
@@ -270,6 +272,8 @@ After installing `Config` in Rails, you will find automatically generated file t
 
 * `const_name` - name of the object holing you settings. Default: `'Settings'`
 * `evaluate_erb_in_yaml` - evaluate ERB in YAML config files. Set to false if the config file contains ERB that should not be evaluated at load time. Default: `true`
+* `file_name` - name of the file to store general keys accessible in all environments. Default: `'settings'` - located at `config/settings.yml`
+* `dir_name` - name of the directory to store environment-specific files. Default: `'settings'` - located at `config/settings/`
 
 ### Merge customization
 
@@ -424,7 +428,7 @@ ENV['Settings.section.server'] = 'google.com'
 
 It won't work with arrays, though.
 
-It is considered an error to use environment variables to simutaneously assign a "flat" value and a multi-level value to a key.
+It is considered an error to use environment variables to simultaneously assign a "flat" value and a multi-level value to a key.
 
 ```ruby
 # Raises an error when settings are loaded

data/config.gemspec

@@ -1,6 +1,5 @@
-$:.push File.expand_path('../lib', __FILE__)
-
-require 'config/version'
+require_relative 'lib/config/version'
+require_relative 'lib/config/dry_validation_requirements'
 
 Gem::Specification.new do |s|
   s.name             = 'config'
@@ -15,11 +14,13 @@ Gem::Specification.new do |s|
   s.license          = 'MIT'
   s.extra_rdoc_files = %w[README.md CHANGELOG.md CONTRIBUTING.md LICENSE.md]
   s.rdoc_options     = ['--charset=UTF-8']
-  s.post_install_message = "\n\e[33mThanks for installing Config\e[0m
-Please consider donating to our open collective to help us maintain this project.
-\n
-Donate: \e[34mhttps://opencollective.com/rubyconfig/donate\e[0m\n"
 
+  s.metadata = {
+    'changelog_uri' => "https://github.com/rubyconfig/config/blob/master/CHANGELOG.md",
+    'funding_uri' => 'https://opencollective.com/rubyconfig/donate',
+    'source_code_uri' => 'https://github.com/rubyconfig/config',
+    'bug_tracker_uri' => 'https://github.com/rubyconfig/config/issues'
+  }
   s.files = `git ls-files`.split($/)
   s.files.select! { |file| /(^lib\/|^\w+.md$|\.gemspec$)/ =~ file }
 
@@ -27,12 +28,12 @@ Donate: \e[34mhttps://opencollective.com/rubyconfig/donate\e[0m\n"
   s.required_ruby_version = '>= 2.6.0'
 
   s.add_dependency 'deep_merge', '~> 1.2', '>= 1.2.1'
-  s.add_dependency 'dry-validation', '~> 1.0', '>= 1.0.0'
 
+  s.add_development_dependency 'dry-validation', *Config::DryValidationRequirements::VERSIONS
   s.add_development_dependency 'rake', '~> 12.0', '>= 12.0.0'
 
   # Testing
-  s.add_development_dependency 'appraisal', '~> 2.3', '>= 2.3.0'
+  s.add_development_dependency 'appraisal', '~> 2.5', '>= 2.5.0'
   s.add_development_dependency 'rspec', '~> 3.9', '>= 3.9.0'
 
   # Default RSpec run will test against latest Rails app

data/lib/config/dry_validation_requirements.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+module Config
+  module DryValidationRequirements
+    VERSIONS = ['~> 1.0', '>= 1.0.0'].freeze
+
+    def self.load_dry_validation!
+      return if defined?(@load_dry_validation)
+
+      begin
+        require 'dry/validation/version'
+        version = Gem::Version.new(Dry::Validation::VERSION)
+        unless VERSIONS.all? { |req| Gem::Requirement.new(req).satisfied_by?(version) }
+          raise LoadError
+        end
+      rescue LoadError
+        raise ::Config::Error, 'Could not find a dry-validation version' \
+          ' matching requirements' \
+          " (#{VERSIONS.map(&:inspect) * ','})"
+      end
+
+      require 'dry/validation'
+      @load_dry_validation = true
+      nil
+    end
+  end
+end

data/lib/config/error.rb

@@ -0,0 +1,4 @@
+module Config
+  class Error < StandardError
+  end
+end

data/lib/config/integrations/heroku.rb

@@ -14,8 +14,8 @@ module Config
       def vars
         # Load only local options to Heroku
         Config.load_and_set_settings(
-            Rails.root.join("config", "settings.local.yml").to_s,
-            Rails.root.join("config", "settings", "#{environment}.local.yml").to_s,
+            Rails.root.join("config", "#{Config.file_name}.local.yml").to_s,
+            Rails.root.join("config", Config.dir_name, "#{environment}.local.yml").to_s,
             Rails.root.join("config", "environments", "#{environment}.local.yml").to_s
         )
 

data/lib/config/integrations/rails/railtie.rb

@@ -9,7 +9,7 @@ module Config
 
           # Parse the settings before any of the initializers
           Config.load_and_set_settings(
-            Config.setting_files(::Rails.root.join('config'), ::Rails.env)
+            Config.setting_files(::Rails.root.join('config'), Config.environment.nil? ? ::Rails.env : Config.environment.to_sym)
           )
         end
 

data/lib/config/options.rb

@@ -114,11 +114,15 @@ module Config
     # Some keywords that don't play nicely with OpenStruct
     SETTINGS_RESERVED_NAMES = %w[select collect test count zip min max exit! table].freeze
 
+    # Some keywords that don't play nicely with Rails 7.*
+    RAILS_RESERVED_NAMES = %w[maximum minimum].freeze
+
     # An alternative mechanism for property access.
     # This let's you do foo['bar'] along with foo.bar.
     def [](param)
       return super if SETTINGS_RESERVED_NAMES.include?(param)
-      send("#{param}")
+      return super if RAILS_RESERVED_NAMES.include?(param)
+      public_send("#{param}")
     end
 
     def []=(param, value)
@@ -131,6 +135,12 @@ module Config
       end
     end
 
+    RAILS_RESERVED_NAMES.each do |name|
+      define_method name do
+        self[name]
+      end
+    end
+
     def key?(key)
       @table.key?(key)
     end

data/lib/config/sources/env_source.rb

@@ -6,17 +6,20 @@ module Config
       attr_reader :separator
       attr_reader :converter
       attr_reader :parse_values
+      attr_reader :parse_arrays
 
       def initialize(env,
                      prefix: Config.env_prefix || Config.const_name,
                      separator: Config.env_separator,
                      converter: Config.env_converter,
-                     parse_values: Config.env_parse_values)
+                     parse_values: Config.env_parse_values,
+                     parse_arrays: Config.env_parse_arrays)
         @env = env
         @prefix = prefix.to_s.split(separator)
         @separator = separator
         @converter = converter
         @parse_values = parse_values
+        @parse_arrays = parse_arrays
       end
 
       def load
@@ -52,10 +55,28 @@ module Config
           leaf[keys.last] = parse_values ? __value(value) : value
         end
 
-        hash
+        parse_arrays ? convert_hashes_to_arrays(hash) : hash
       end
 
       private
+      def convert_hashes_to_arrays(hash)
+        hash.each_with_object({}) do |(key, value), new_hash|
+          if value.is_a?(Hash)
+            value = convert_hashes_to_arrays(value)
+            if consecutive_numeric_keys?(value.keys)
+              new_hash[key] = value.keys.sort_by(&:to_i).map { |k| value[k] }
+            else
+              new_hash[key] = value
+            end
+          else
+            new_hash[key] = value
+          end
+        end
+      end
+
+      def consecutive_numeric_keys?(keys)
+        keys.map(&:to_i).sort == (0...keys.size).to_a && keys.all? { |k| k == k.to_i.to_s }
+      end
 
       # Try to convert string to a correct type
       def __value(v)

data/lib/config/validation/error.rb

@@ -1,6 +1,8 @@
+require_relative "../error"
+
 module Config
   module Validation
-    class Error < StandardError
+    class Error < ::Config::Error
 
       def self.format(v_res)
         v_res.errors.group_by(&:path).map do |path, messages|

data/lib/config/validation/schema.rb

@@ -1,3 +1,6 @@
+require_relative '../dry_validation_requirements'
+require_relative '../error'
+
 module Config
   module Validation
     module Schema
@@ -9,7 +12,7 @@ module Config
       def schema(&block)
         if block_given?
           # Delay require until optional schema validation is requested
-          require 'dry-validation'
+          Config::DryValidationRequirements.load_dry_validation!
           @schema = Dry::Schema.define(&block)
         else
           @schema

data/lib/config/validation/validate.rb

@@ -4,6 +4,10 @@ module Config
   module Validation
     module Validate
       def validate!
+        return unless Config.validation_contract || Config.schema
+
+        Config::DryValidationRequirements.load_dry_validation!
+
         validate_using!(Config.validation_contract)
         validate_using!(Config.schema)
       end

data/lib/config/version.rb

@@ -1,3 +1,3 @@
 module Config
-  VERSION = '4.2.1'.freeze
+  VERSION = '5.5.1'.freeze
 end

data/lib/config.rb

@@ -1,12 +1,12 @@
-require 'config/compatibility'
 require 'config/options'
 require 'config/configuration'
+require 'config/dry_validation_requirements'
 require 'config/version'
 require 'config/sources/yaml_source'
 require 'config/sources/hash_source'
 require 'config/sources/env_source'
 require 'config/validation/schema'
-require 'deep_merge'
+require 'deep_merge/core'
 
 module Config
   extend Config::Validation::Schema
@@ -18,14 +18,18 @@ module Config
     env_separator: '.',
     env_converter: :downcase,
     env_parse_values: true,
+    env_parse_arrays: false,
     fail_on_missing: false,
+    file_name: 'settings',
+    dir_name: 'settings',
     # deep_merge options
     knockout_prefix: nil,
     merge_nil_values: true,
     overwrite_arrays: true,
     merge_hash_arrays: false,
     validation_contract: nil,
-    evaluate_erb_in_yaml: true
+    evaluate_erb_in_yaml: true,
+    environment: nil
   )
 
   def self.setup
@@ -58,8 +62,8 @@ module Config
 
   def self.setting_files(config_root, env)
     [
-      File.join(config_root, 'settings.yml').to_s,
-      File.join(config_root, 'settings', "#{env}.yml").to_s,
+      File.join(config_root, "#{Config.file_name}.yml").to_s,
+      File.join(config_root, Config.dir_name, "#{env}.yml").to_s,
       File.join(config_root, 'environments', "#{env}.yml").to_s,
       *local_setting_files(config_root, env)
     ].freeze
@@ -67,8 +71,8 @@ module Config
 
   def self.local_setting_files(config_root, env)
     [
-      (File.join(config_root, 'settings.local.yml').to_s if env != 'test'),
-      File.join(config_root, 'settings', "#{env}.local.yml").to_s,
+      (File.join(config_root, "#{Config.file_name}.local.yml").to_s if env != 'test'),
+      File.join(config_root, Config.dir_name, "#{env}.local.yml").to_s,
       File.join(config_root, 'environments', "#{env}.local.yml").to_s
     ].compact
   end

data/lib/generators/config/install_generator.rb

@@ -12,18 +12,18 @@ module Config
       end
 
       def copy_settings
-        template "settings.yml", "config/settings.yml"
-        template "settings.local.yml", "config/settings.local.yml"
-        directory "settings", "config/settings"
+        template "settings.yml", "config/#{Config.file_name}.yml"
+        template "settings.local.yml", "config/#{Config.file_name}.local.yml"
+        directory "settings", "config/#{Config.dir_name}"
       end
 
       def modify_gitignore
         create_file '.gitignore' unless File.exist? '.gitignore'
 
         append_to_file '.gitignore' do
-          "\n"                                +
-          "config/settings.local.yml\n"       +
-          "config/settings/*.local.yml\n"     +
+          "\n"                                      +
+          "config/#{Config.file_name}.local.yml\n"  +
+          "config/#{Config.dir_name}/*.local.yml\n" +
           "config/environments/*.local.yml\n"
         end
       end

data/lib/generators/config/templates/config.rb

@@ -15,6 +15,11 @@ Config.setup do |config|
   #
   # config.overwrite_arrays = true
 
+  # Defines current environment, affecting which settings file will be loaded.
+  # Default: `Rails.env`
+  #
+  # config.environment = ENV.fetch('ENVIRONMENT', :development)
+
   # Load environment variables from the `ENV` object and override any settings defined in files.
   #
   # config.use_env = false
@@ -55,4 +60,9 @@ Config.setup do |config|
   # Evaluate ERB in YAML config files at load time.
   #
   # config.evaluate_erb_in_yaml = true
+
+  # Name of directory and file to store config keys
+  #
+  # config.file_name = 'settings'
+  # config.dir_name = 'settings'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: config
 version: !ruby/object:Gem::Version
-  version: 4.2.1
+  version: 5.5.1
 platform: ruby
 authors:
 - Piotr Kuczynski
@@ -10,7 +10,7 @@ authors:
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-06-14 00:00:00.000000000 Z
+date: 2024-05-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: deep_merge
@@ -42,7 +42,7 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: 1.0.0
-  type: :runtime
+  type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
@@ -78,20 +78,20 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.3'
+        version: '2.5'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 2.3.0
+        version: 2.5.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.3'
+        version: '2.5'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 2.3.0
+        version: 2.5.0
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -118,42 +118,56 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 1.4.4
+        version: 1.16.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 1.4.4
+        version: 1.16.0
 - !ruby/object:Gem::Dependency
   name: rails
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 6.1.4
+        version: 7.1.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 6.1.4
+        version: 7.1.0
 - !ruby/object:Gem::Dependency
   name: rspec-rails
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '5.0'
+        version: 6.0.3
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 6.0.3
+- !ruby/object:Gem::Dependency
+  name: sprockets-rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.4.2
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '5.0'
+        version: 3.4.2
 - !ruby/object:Gem::Dependency
   name: psych
   requirement: !ruby/object:Gem::Requirement
@@ -222,8 +236,9 @@ files:
 - README.md
 - config.gemspec
 - lib/config.rb
-- lib/config/compatibility.rb
 - lib/config/configuration.rb
+- lib/config/dry_validation_requirements.rb
+- lib/config/error.rb
 - lib/config/integrations/heroku.rb
 - lib/config/integrations/rails/railtie.rb
 - lib/config/integrations/sinatra.rb
@@ -247,9 +262,12 @@ files:
 homepage: https://github.com/rubyconfig/config
 licenses:
 - MIT
-metadata: {}
-post_install_message: "\n\e[33mThanks for installing Config\e[0m\nPlease consider
-  donating to our open collective to help us maintain this project.\n\n\nDonate: \e[34mhttps://opencollective.com/rubyconfig/donate\e[0m\n"
+metadata:
+  changelog_uri: https://github.com/rubyconfig/config/blob/master/CHANGELOG.md
+  funding_uri: https://opencollective.com/rubyconfig/donate
+  source_code_uri: https://github.com/rubyconfig/config
+  bug_tracker_uri: https://github.com/rubyconfig/config/issues
+post_install_message:
 rdoc_options:
 - "--charset=UTF-8"
 require_paths:
@@ -265,7 +283,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.13
+rubygems_version: 3.5.4
 signing_key:
 specification_version: 4
 summary: Effortless multi-environment settings in Rails, Sinatra, Padrino and others

data/lib/config/compatibility.rb

@@ -1,3 +0,0 @@
-if defined?(RbConfig) && defined?(Config)
-  Object.send :remove_const, :Config
-end