config 5.1.0 → 5.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0e7864a2d30e62a39dbeb3c3eff43e07568a844b391e8c5f51f49c0712a2786b
-  data.tar.gz: b79745abcd726d5665aff0069ef3bef63250af5df0157f7515d0f67b65bfc9f6
+  metadata.gz: 777b7f8139564b25204ca8c3d375044d16d7ed58132d898493404f04133f7a22
+  data.tar.gz: 8ce204241f891f5cf9b2130d02c0d03c12999624dd6a12efc653462bc4e781f1
 SHA512:
-  metadata.gz: 27b2ac548df27cb149bfb6f60753179d36d6bf2fa3caa0cb7a5f5e456450840357272c4c53bba986ad8f62d12f79960e87183faa2cd48f0afecdb695c802730a
-  data.tar.gz: 71c11e19fe808da90a497616ff635e00e0a3a86c971b751cf5e9bdebe34d86272a9197ca1b8104f7a1b0d2d98677ecb56bb681168c7a08d9bbc4e7cf9b914913
+  metadata.gz: 143d0364fd88bfacfceb6032d82bdd7e8cf74179f4bef6b9439dc966e94692ebfd41c166a85b31dbfa052b57004cfbc91dccb6fb80646d23764ee5a9466f1902
+  data.tar.gz: a71272f604d882b05eab6958bddbb0aac72894dc62463668aaedcd3d98814d6eada6ab480cffd0679763bb0d8a125e792e7d02577b118a7771738dace0ad6af3

data/CHANGELOG.md

@@ -1,8 +1,22 @@
 # Changelog
 
+## 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/339))
+* Fix conflicts with Rails 7 active_support methods ([#347](https://github.com/rubyconfig/config/pull/347))
 
 ## 5.0.0
 

data/README.md

@@ -270,6 +270,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
 

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'
@@ -20,6 +19,11 @@ 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",
+    '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,8 +31,8 @@ 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

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/options.rb

@@ -122,7 +122,7 @@ module Config
     def [](param)
       return super if SETTINGS_RESERVED_NAMES.include?(param)
       return super if RAILS_RESERVED_NAMES.include?(param)
-      send("#{param}")
+      public_send("#{param}")
     end
 
     def []=(param, value)

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 = '5.1.0'.freeze
+  VERSION = '5.3.0'.freeze
 end

data/lib/config.rb

@@ -1,6 +1,6 @@
-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'
@@ -19,6 +19,8 @@ module Config
     env_converter: :downcase,
     env_parse_values: true,
     fail_on_missing: false,
+    file_name: 'settings',
+    dir_name: 'settings',
     # deep_merge options
     knockout_prefix: nil,
     merge_nil_values: true,
@@ -58,8 +60,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 +69,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

@@ -55,4 +55,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: 5.1.0
+  version: 5.3.0
 platform: ruby
 authors:
 - Piotr Kuczynski
@@ -10,7 +10,7 @@ authors:
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-12-18 00:00:00.000000000 Z
+date: 2024-03-01 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:
@@ -236,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
@@ -261,7 +262,10 @@ files:
 homepage: https://github.com/rubyconfig/config
 licenses:
 - MIT
-metadata: {}
+metadata:
+  changelog_uri: https://github.com/rubyconfig/config/blob/master/CHANGELOG.md
+  source_code_uri: https://github.com/rubyconfig/config
+  bug_tracker_uri: https://github.com/rubyconfig/config/issues
 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"
 rdoc_options:
@@ -279,7 +283,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.10
+rubygems_version: 3.4.22
 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