anyway_config 2.6.4 → 2.7.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c7cfb06bc950fa9f4c16b771509fc8e88cbe1481ea82a145c2fae80fca80b57b
-  data.tar.gz: fdbd419a8ff57a7fbbb4e887381048e68d830d4927761ec420706e8add146e3a
+  metadata.gz: c6e808e00b7756aa1b22f20792dfcfbc5989c5f41a88ae5b16e87ee3e556b17d
+  data.tar.gz: ef819a44f7ac000f206929dbb412f778130bb40b240c45478e548c582a7b52f9
 SHA512:
-  metadata.gz: b7dd1abbf6411c416571ac67c127b0f0e365c73689d96d094289ab0ede4c494bd56f4246848431a689b2292a2903cea74b918e11569d89423c21e11f2dc3e9ca
-  data.tar.gz: 4d8f2aecbbe6e79314a81d47f4fb92b3dcaba42a656387fbb24dd7c0dc051f3cae0b98de84f797cb48bc3fb9055bf59fd32c128ad4ee979e60eb3a71935a5e5a
+  metadata.gz: ca3f7f4ad799af0c53b613786a5407fa4d41a937528b12d17b69f466f3a7152a3b89e61cbcd4112f9bfd69b26089d3223eb85ba68859f9173997636ff04626a6
+  data.tar.gz: '00762802a9a92438cfd3ef29681eebaad657a81ddda44a06799c39c4f024d3975458b3380b8ef7b97611d9d561476a7fab386aa636aaa0a6712491790a583919'

data/CHANGELOG.md

@@ -2,6 +2,24 @@
 
 ## master
 
+## 2.7.1 (2025-02-24)
+
+- Suppress required validations when running Rails credentials commands. ([@palkan][])
+
+## 2.7.0 (2025-02-12)
+
+- Added `suppress_required_validations` configuration for skipping validation in CI. ([@OlegChuev][])
+
+- Support for the Rails built-in environment variable `SECRET_KEY_BASE_DUMMY`. If this variable is set, all validations for required attributes are skipped. This is particularly useful for executing `bundle exec rails assets:precompile` in CI/CD pipelines. ([@OlegChuev][])
+
+- Introduced a global setting `Anyway::Settings.suppress_required_validations = true` to disable validations. This can be toggled via the environment variable `ANYWAY_SUPPRESS_VALIDATIONS`. Please note, `ANYWAY_SUPPRESS_VALIDATIONS` takes precedence over `SECRET_KEY_BASE_DUMMY`.
+
+- Added `:integer!` type support (strong integer coercion). ([@klondaiker][])
+
+- Fix handling relative vs. absolute paths in `autoload_static_configs_path=`. ([@palkan][])
+
+- Fix support for array values in `except` option for required attributes. ([@dominikb][])
+
 ## 2.6.4 (2024-04-30)
 
 - Fix RBS manifest file name (`.yml` -> `.yaml`). ([@carlqt][])
@@ -579,3 +597,6 @@ No we're dependency-free!
 [@tagirahmad]: https://github.com/tagirahmad
 [@bessey]: https://github.com/bessey
 [@carlqt]: https://github.com/carlqt
+[@OlegChuev]: https://github.com/OlegChuev
+[@dominikb]: https://github.com/dominikb
+[@klondaiker]: https://github.com/klondaiker

data/README.md

@@ -73,7 +73,7 @@ end
 
 Using Ruby classes to represent configuration allows you to add helper methods and computed parameters easily, makes the configuration **testable**.
 
-The `anyway_config` gem takes care of loading parameters from **different sources** (YAML, credentials/secrets, environment variables, etc.). Internally, we use a _pipeline pattern_ and provide the [Loaders API](#data-loaders) to manage and [extend](#custom-loaders) its functionality.
+The `anyway_config` gem takes care of loading parameters from **different sources** (YAML, credentials, environment variables, etc.). Internally, we use a _pipeline pattern_ and provide the [Loaders API](#data-loaders) to manage and [extend](#custom-loaders) its functionality.
 
 Check out the libraries using Anyway Config for more examples:
 
@@ -270,7 +270,6 @@ This feature is similar to `Rails.application.config_for` but more powerful:
 | Feature | Rails | Anyway Config |
 | ------------- |-------------:| -----:|
 | Load data from `config/app.yml` | ✅ | ✅ |
-| Load data from `secrets` | ❌ | ✅ |
 | Load data from `credentials` | ❌ | ✅ |
 | Load data from environment | ❌ | ✅ |
 | Load data from [other sources](#data-loaders) | ❌ | ✅ |
@@ -304,6 +303,9 @@ MyConfig.new(api_secret: "") #=> raises Anyway::Config::ValidationError
 `Required` method supports additional `env` parameter which indicates necessity to run validations under specified
 environments. `Env` parameter could be present in symbol, string, array or hash formats:
 
+**NOTE:** You can suppress the validation of the required parameters (it can be useful for CI) via the `ANYWAY_SUPPRESS_VALIDATIONS` environment variable or by setting it explicitly in the code: `Anyway::Settings.suppress_required_validations = true`.
+If you are using Anyway Config with Rails and have already specified `SECRET_KEY_BASE_DUMMY` for asset pre compilation, validation will be skipped by default.
+
 ```ruby
 class EnvConfig < Anyway::Config
   required :password, env: "production"
@@ -712,7 +714,7 @@ CoolConfig.new.port == "443" #=> true
 
 **IMPORTANT**: Values provided explicitly (via attribute writers) are not coerced. Coercion is only happening during the load phase.
 
-The following types are supported out-of-the-box: `:string`, `:integer`, `:float`, `:date`, `:datetime`, `:uri`, `:boolean`.
+The following types are supported out-of-the-box: `:string`, `:integer`, `:integer!` (strict integer), `:float`, `:date`, `:datetime`, `:uri`, `:boolean`.
 
 You can use custom deserializers by passing a callable object instead of a type name:
 

data/lib/.rbnext/2.7/anyway/config.rb

@@ -445,6 +445,8 @@ module Anyway # :nodoc:
     attr_reader :values, :__trace__
 
     def validate_required_attributes!
+      return if Settings.suppress_required_validations
+
       self.class.required_attributes.select do |name|
         val = values.dig(*name.to_s.split(".").map(&:to_sym))
         val.nil? || (val.is_a?(String) && val.empty?)

data/lib/.rbnext/2.7/anyway/settings.rb

@@ -52,6 +52,9 @@ module Anyway
         :default_environmental_key,
         :known_environments
 
+      # Suppress required validations for CI/CD pipelines
+      attr_accessor :suppress_required_validations
+
       # A proc returning a path to YML config file given the config name
       attr_reader :default_config_path
 
@@ -86,7 +89,7 @@ module Anyway
 
         if env.is_a?(::Hash)
           envs = env[:except]
-          excluded_envs = [envs].flat_map(&:to_s)
+          excluded_envs = [*envs].flat_map(&:to_s)
           excluded_envs.none?(current_environment)
         elsif env.is_a?(::Array)
           env.flat_map(&:to_s).include?(current_environment)
@@ -107,5 +110,8 @@ module Anyway
 
     # Tracing is enabled by default
     self.tracing_enabled = true
+
+    # By default, use ANYWAY_SUPPRESS_VALIDATIONS
+    self.suppress_required_validations = %w[1 t true y yes].include?(ENV["ANYWAY_SUPPRESS_VALIDATIONS"])
   end
 end

data/lib/.rbnext/2.7/anyway/type_casting.rb

@@ -88,6 +88,10 @@ module Anyway
     obj.accept(:boolean) do |_1|
       _1.to_s.match?(/\A(true|t|yes|y|1)\z/i)
     end
+
+    obj.accept(:integer!) do |_1|
+      Integer(_1)
+    end
   end
 
   unless "".respond_to?(:safe_constantize)

data/lib/.rbnext/3.0/anyway/config.rb

@@ -445,6 +445,8 @@ module Anyway # :nodoc:
     attr_reader :values, :__trace__
 
     def validate_required_attributes!
+      return if Settings.suppress_required_validations
+
       self.class.required_attributes.select do |name|
         val = values.dig(*name.to_s.split(".").map(&:to_sym))
         val.nil? || (val.is_a?(String) && val.empty?)

data/lib/.rbnext/3.1/anyway/config.rb

@@ -445,6 +445,8 @@ module Anyway # :nodoc:
     attr_reader :values, :__trace__
 
     def validate_required_attributes!
+      return if Settings.suppress_required_validations
+
       self.class.required_attributes.select do |name|
         val = values.dig(*name.to_s.split(".").map(&:to_sym))
         val.nil? || (val.is_a?(String) && val.empty?)

data/lib/.rbnext/3.2/anyway/config.rb

@@ -445,6 +445,8 @@ module Anyway # :nodoc:
     attr_reader :values, :__trace__
 
     def validate_required_attributes!
+      return if Settings.suppress_required_validations
+
       self.class.required_attributes.select do |name|
         val = values.dig(*name.to_s.split(".").map(&:to_sym))
         val.nil? || (val.is_a?(String) && val.empty?)

data/lib/.rbnext/3.4/anyway/config.rb

@@ -445,6 +445,8 @@ module Anyway # :nodoc:
     attr_reader :values, :__trace__
 
     def validate_required_attributes!
+      return if Settings.suppress_required_validations
+
       self.class.required_attributes.select do |name|
         val = values.dig(*name.to_s.split(".").map(&:to_sym))
         val.nil? || (val.is_a?(String) && val.empty?)

data/lib/.rbnext/3.4/anyway/type_casting.rb

@@ -88,6 +88,10 @@ module Anyway
     obj.accept(:boolean) do
       _1.to_s.match?(/\A(true|t|yes|y|1)\z/i)
     end
+
+    obj.accept(:integer!) do
+      Integer(_1)
+    end
   end
 
   unless "".respond_to?(:safe_constantize)

data/lib/anyway/config.rb

@@ -445,6 +445,8 @@ module Anyway # :nodoc:
     attr_reader :values, :__trace__
 
     def validate_required_attributes!
+      return if Settings.suppress_required_validations
+
       self.class.required_attributes.select do |name|
         val = values.dig(*name.to_s.split(".").map(&:to_sym))
         val.nil? || (val.is_a?(String) && val.empty?)

data/lib/anyway/rails/settings.rb

@@ -19,7 +19,7 @@ module Anyway
 
           return unless ::Rails.root.join(val).exist?
 
-          return if val == autoload_static_config_path
+          return if ::Rails.root.join(val.to_s) == ::Rails.root.join(autoload_static_config_path.to_s)
 
           autoloader&.unload
 
@@ -79,5 +79,16 @@ module Anyway
     self.use_local_files ||= ::Rails.env.development?
     # Don't try read defaults when no key defined
     self.default_environmental_key = nil
+
+    self.suppress_required_validations = ENV.key?("SECRET_KEY_BASE_DUMMY") unless ENV.key?("ANYWAY_SUPPRESS_VALIDATIONS")
+
+    # Suppress validations when working with credentials
+    if defined?(::Rails::Command::CredentialsCommand) && ::Rails::Command.respond_to?(:const_source_location)
+      credentials_source_path = ::Rails::Command.const_source_location("CredentialsCommand").first
+
+      if caller_locations.any? { |l| l.absolute_path == credentials_source_path }
+        self.suppress_required_validations = true
+      end
+    end
   end
 end

data/lib/anyway/settings.rb

@@ -52,6 +52,9 @@ module Anyway
         :default_environmental_key,
         :known_environments
 
+      # Suppress required validations for CI/CD pipelines
+      attr_accessor :suppress_required_validations
+
       # A proc returning a path to YML config file given the config name
       attr_reader :default_config_path
 
@@ -86,7 +89,7 @@ module Anyway
 
         if env.is_a?(::Hash)
           envs = env[:except]
-          excluded_envs = [envs].flat_map(&:to_s)
+          excluded_envs = [*envs].flat_map(&:to_s)
           excluded_envs.none?(current_environment)
         elsif env.is_a?(::Array)
           env.flat_map(&:to_s).include?(current_environment)
@@ -107,5 +110,8 @@ module Anyway
 
     # Tracing is enabled by default
     self.tracing_enabled = true
+
+    # By default, use ANYWAY_SUPPRESS_VALIDATIONS
+    self.suppress_required_validations = %w[1 t true y yes].include?(ENV["ANYWAY_SUPPRESS_VALIDATIONS"])
   end
 end

data/lib/anyway/type_casting.rb

@@ -88,6 +88,10 @@ module Anyway
     obj.accept(:boolean) do
       _1.to_s.match?(/\A(true|t|yes|y|1)\z/i)
     end
+
+    obj.accept(:integer!) do
+      Integer(_1)
+    end
   end
 
   unless "".respond_to?(:safe_constantize)

data/lib/anyway/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Anyway # :nodoc:
-  VERSION = "2.6.4"
+  VERSION = "2.7.1"
 end

data/lib/rails/commands/local_credentials/local_credentials_command.rb

@@ -19,6 +19,13 @@ module Rails
 
         change_credentials_in_system_editor
       end
+
+      private
+
+      def load_environment_config!
+        ENV["ANYWAY_SUPPRESS_VALIDATIONS"] = "true"
+        super
+      end
     end
   end
 end

data/sig/anyway_config.rbs

@@ -7,6 +7,7 @@ module Anyway
     def self.future: -> Future
     def self.current_environment: -> String?
     def self.default_environmental_key: -> String?
+    def self.suppress_required_validations: -> bool
     def self.known_environments: -> Array[String]?
 
     class Future

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: anyway_config
 version: !ruby/object:Gem::Version
-  version: 2.6.4
+  version: 2.7.1
 platform: ruby
 authors:
 - Vladimir Dementyev
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-04-30 00:00:00.000000000 Z
+date: 2025-02-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: ruby-next-core
@@ -206,7 +206,7 @@ metadata:
   homepage_uri: http://github.com/palkan/anyway_config
   source_code_uri: http://github.com/palkan/anyway_config
   funding_uri: https://github.com/sponsors/palkan
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -222,7 +222,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubygems_version: 3.4.19
-signing_key: 
+signing_key:
 specification_version: 4
 summary: Configuration DSL for Ruby libraries and applications
 test_files: []