anyway_config 2.8.1 → 2.9.1

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

@@ -33,6 +33,7 @@ module Anyway # :nodoc:
       deconstruct_keys
       dig
       dup
+      format_unknown_attribute
       initialize
       load
       load_from_sources
@@ -52,6 +53,8 @@ module Anyway # :nodoc:
 
     class ValidationError < Error; end
 
+    class UnknownAttributesError < ValidationError; end
+
     include OptparseConfig
     include DynamicConfig
 
@@ -374,6 +377,8 @@ module Anyway # :nodoc:
         )
 
         if overrides
+          reject_unknown_config_attributes!(overrides, source: :overrides, strict: Settings.future.reject_unknown_overrides == true)
+
           Tracing.trace!(:load) { overrides }
 
           Utils.deep_merge!(base_config, overrides)
@@ -400,10 +405,16 @@ module Anyway # :nodoc:
     def load_from_sources(base_config, **opts)
       source_filter = self.class.configuration_sources
 
-      Anyway.loaders.each do |(id, loader)|
+      Anyway.loaders.each do |(id, loader_or_proc)|
         next if source_filter && !source_filter.include?(id)
-        Utils.deep_merge!(base_config, loader.call(**opts))
+
+        loader = (loader_or_proc.is_a?(Class) && loader_or_proc <= Loaders::Base) ? loader_or_proc.new(**opts) : loader_or_proc
+        loader_data = loader.call(**opts)
+        reject_unknown_config_attributes!(loader_data, source: id) if loader.is_a?(Loaders::Base) && loader.schemaful?
+
+        Utils.deep_merge!(base_config, loader_data)
       end
+
       base_config
     end
 
@@ -460,13 +471,50 @@ module Anyway # :nodoc:
 
       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?)
+        val.nil? || (val.respond_to?(:to_s) && val.to_s.empty?)
       end.then do |missing|
         next if missing.empty?
         raise_validation_error "The following config parameters for `#{self.class.name}(config_name: #{self.class.config_name})` are missing or empty: #{missing.join(", ")}"
       end
     end
 
+    def reject_unknown_config_attributes!(data, source:, strict: false)
+      return if data.nil? || data.empty?
+
+      mode = strict || Settings.enforce_config_schema
+      return unless mode
+
+      known = self.class.config_attributes.map(&:to_s)
+      unknown = data.keys.map(&:to_s) - known
+
+      unless strict
+        rescuer = Settings.rescue_unknown_attributes_with
+        unknown.reject! { |it| rescuer.call(self, it) } if rescuer
+      end
+
+      return if unknown.empty?
+
+      msg = "Unknown config attributes for `#{self.class.name || "<anonymous>"}(config_name: #{config_name})` " \
+        "provided by #{source}: #{unknown.map { |it| format_unknown_attribute(it, known) }.join(", ")}"
+
+      if strict
+        raise ArgumentError, msg
+      elsif mode == :warn
+        Kernel.warn msg
+      else
+        raise UnknownAttributesError, msg
+      end
+    end
+
+    def format_unknown_attribute(key, known)
+      return key unless defined?(::DidYouMean::SpellChecker)
+
+      suggestions = ::DidYouMean::SpellChecker.new(dictionary: known).correct(key)
+      return key if suggestions.empty?
+
+      "#{key} (did you mean: #{suggestions.join(", ")}?)"
+    end
+
     def write_config_attr(key, val)
       key = key.to_sym
       return unless self.class.config_attributes.include?(key)

data/lib/.rbnext/3.2/anyway/loaders/base.rb

@@ -11,11 +11,15 @@ module Anyway
         end
       end
 
-      def initialize(local:)
+      def initialize(local: Anyway::Settings.use_local_files, **__kwrest__)
         @local = local
       end
 
       def use_local?() = @local == true
+
+      # Whether this loader supports strict schema (so we can warn or raise on
+      # unknown attributes)
+      def schemaful?() = false
     end
   end
 end

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

@@ -33,6 +33,7 @@ module Anyway # :nodoc:
       deconstruct_keys
       dig
       dup
+      format_unknown_attribute
       initialize
       load
       load_from_sources
@@ -52,6 +53,8 @@ module Anyway # :nodoc:
 
     class ValidationError < Error; end
 
+    class UnknownAttributesError < ValidationError; end
+
     include OptparseConfig
     include DynamicConfig
 
@@ -374,6 +377,8 @@ module Anyway # :nodoc:
         )
 
         if overrides
+          reject_unknown_config_attributes!(overrides, source: :overrides, strict: Settings.future.reject_unknown_overrides == true)
+
           Tracing.trace!(:load) { overrides }
 
           Utils.deep_merge!(base_config, overrides)
@@ -400,10 +405,16 @@ module Anyway # :nodoc:
     def load_from_sources(base_config, **opts)
       source_filter = self.class.configuration_sources
 
-      Anyway.loaders.each do |(id, loader)|
+      Anyway.loaders.each do |(id, loader_or_proc)|
         next if source_filter && !source_filter.include?(id)
-        Utils.deep_merge!(base_config, loader.call(**opts))
+
+        loader = (loader_or_proc.is_a?(Class) && loader_or_proc <= Loaders::Base) ? loader_or_proc.new(**opts) : loader_or_proc
+        loader_data = loader.call(**opts)
+        reject_unknown_config_attributes!(loader_data, source: id) if loader.is_a?(Loaders::Base) && loader.schemaful?
+
+        Utils.deep_merge!(base_config, loader_data)
       end
+
       base_config
     end
 
@@ -460,13 +471,50 @@ module Anyway # :nodoc:
 
       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?)
+        val.nil? || (val.respond_to?(:to_s) && val.to_s.empty?)
       end.then do |missing|
         next if missing.empty?
         raise_validation_error "The following config parameters for `#{self.class.name}(config_name: #{self.class.config_name})` are missing or empty: #{missing.join(", ")}"
       end
     end
 
+    def reject_unknown_config_attributes!(data, source:, strict: false)
+      return if data.nil? || data.empty?
+
+      mode = strict || Settings.enforce_config_schema
+      return unless mode
+
+      known = self.class.config_attributes.map(&:to_s)
+      unknown = data.keys.map(&:to_s) - known
+
+      unless strict
+        rescuer = Settings.rescue_unknown_attributes_with
+        unknown.reject! { |it| rescuer.call(self, it) } if rescuer
+      end
+
+      return if unknown.empty?
+
+      msg = "Unknown config attributes for `#{self.class.name || "<anonymous>"}(config_name: #{config_name})` " \
+        "provided by #{source}: #{unknown.map { |it| format_unknown_attribute(it, known) }.join(", ")}"
+
+      if strict
+        raise ArgumentError, msg
+      elsif mode == :warn
+        Kernel.warn msg
+      else
+        raise UnknownAttributesError, msg
+      end
+    end
+
+    def format_unknown_attribute(key, known)
+      return key unless defined?(::DidYouMean::SpellChecker)
+
+      suggestions = ::DidYouMean::SpellChecker.new(dictionary: known).correct(key)
+      return key if suggestions.empty?
+
+      "#{key} (did you mean: #{suggestions.join(", ")}?)"
+    end
+
     def write_config_attr(key, val)
       key = key.to_sym
       return unless self.class.config_attributes.include?(key)

data/lib/anyway/config.rb

@@ -33,6 +33,7 @@ module Anyway # :nodoc:
       deconstruct_keys
       dig
       dup
+      format_unknown_attribute
       initialize
       load
       load_from_sources
@@ -52,6 +53,8 @@ module Anyway # :nodoc:
 
     class ValidationError < Error; end
 
+    class UnknownAttributesError < ValidationError; end
+
     include OptparseConfig
     include DynamicConfig
 
@@ -374,6 +377,8 @@ module Anyway # :nodoc:
         )
 
         if overrides
+          reject_unknown_config_attributes!(overrides, source: :overrides, strict: Settings.future.reject_unknown_overrides == true)
+
           Tracing.trace!(:load) { overrides }
 
           Utils.deep_merge!(base_config, overrides)
@@ -400,10 +405,16 @@ module Anyway # :nodoc:
     def load_from_sources(base_config, **opts)
       source_filter = self.class.configuration_sources
 
-      Anyway.loaders.each do |(id, loader)|
+      Anyway.loaders.each do |(id, loader_or_proc)|
         next if source_filter && !source_filter.include?(id)
-        Utils.deep_merge!(base_config, loader.call(**opts))
+
+        loader = (loader_or_proc.is_a?(Class) && loader_or_proc <= Loaders::Base) ? loader_or_proc.new(**opts) : loader_or_proc
+        loader_data = loader.call(**opts)
+        reject_unknown_config_attributes!(loader_data, source: id) if loader.is_a?(Loaders::Base) && loader.schemaful?
+
+        Utils.deep_merge!(base_config, loader_data)
       end
+
       base_config
     end
 
@@ -460,13 +471,50 @@ module Anyway # :nodoc:
 
       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?)
+        val.nil? || (val.respond_to?(:to_s) && val.to_s.empty?)
       end.then do |missing|
         next if missing.empty?
         raise_validation_error "The following config parameters for `#{self.class.name}(config_name: #{self.class.config_name})` are missing or empty: #{missing.join(", ")}"
       end
     end
 
+    def reject_unknown_config_attributes!(data, source:, strict: false)
+      return if data.nil? || data.empty?
+
+      mode = strict || Settings.enforce_config_schema
+      return unless mode
+
+      known = self.class.config_attributes.map(&:to_s)
+      unknown = data.keys.map(&:to_s) - known
+
+      unless strict
+        rescuer = Settings.rescue_unknown_attributes_with
+        unknown.reject! { rescuer.call(self, it) } if rescuer
+      end
+
+      return if unknown.empty?
+
+      msg = "Unknown config attributes for `#{self.class.name || "<anonymous>"}(config_name: #{config_name})` " \
+        "provided by #{source}: #{unknown.map { format_unknown_attribute(it, known) }.join(", ")}"
+
+      if strict
+        raise ArgumentError, msg
+      elsif mode == :warn
+        Kernel.warn msg
+      else
+        raise UnknownAttributesError, msg
+      end
+    end
+
+    def format_unknown_attribute(key, known)
+      return key unless defined?(::DidYouMean::SpellChecker)
+
+      suggestions = ::DidYouMean::SpellChecker.new(dictionary: known).correct(key)
+      return key if suggestions.empty?
+
+      "#{key} (did you mean: #{suggestions.join(", ")}?)"
+    end
+
     def write_config_attr(key, val)
       key = key.to_sym
       return unless self.class.config_attributes.include?(key)

data/lib/anyway/loaders/base.rb

@@ -11,11 +11,15 @@ module Anyway
         end
       end
 
-      def initialize(local:)
+      def initialize(local: Anyway::Settings.use_local_files, **)
         @local = local
       end
 
       def use_local?() = @local == true
+
+      # Whether this loader supports strict schema (so we can warn or raise on
+      # unknown attributes)
+      def schemaful?() = false
     end
   end
 end

data/lib/anyway/loaders/ejson.rb

@@ -26,11 +26,14 @@ module Anyway
           config_hash = if ejson_namespace
             secrets_hash[ejson_namespace]
           else
-            secrets_hash.except("_public_key")
+            secrets_hash
           end
 
           next unless config_hash.is_a?(Hash)
 
+          # Underscore-prefixed keys are not encrypted (e.g., _public_key)
+          config_hash = config_hash.reject { |key, _| key.start_with?("_") }
+
           configs <<
             trace!(:ejson, path: rel_path) do
               config_hash
@@ -44,6 +47,8 @@ module Anyway
         end
       end
 
+      def schemaful?() = true
+
       private
 
       def rel_config_paths

data/lib/anyway/loaders/yaml.rb

@@ -28,6 +28,8 @@ module Anyway
         Utils.deep_merge!(base_config, local_config)
       end
 
+      def schemaful?() = true
+
       private
 
       def environmental?(parsed_yml)

data/lib/anyway/rails/loaders/credentials.rb

@@ -34,6 +34,8 @@ module Anyway
           config
         end
 
+        def schemaful?() = true
+
         private
 
         def local_credentials(name)

data/lib/anyway/rails/loaders/secrets.rb

@@ -19,6 +19,8 @@ module Anyway
           config
         end
 
+        def schemaful?() = true
+
         private
 
         def secrets

data/lib/anyway/rails.rb

@@ -12,7 +12,7 @@ require "anyway/rails/loaders"
 # Configure Rails loaders
 Anyway.loaders.override :yml, Anyway::Rails::Loaders::YAML
 
-if Rails::VERSION::MAJOR >= 7 && Rails::VERSION::MINOR >= 1
+if Gem::Version.new(Rails.version) >= Gem::Version.new("7.1")
   Anyway.loaders.insert_after :yml, :credentials, Anyway::Rails::Loaders::Credentials
 else
   Anyway.loaders.insert_after :yml, :secrets, Anyway::Rails::Loaders::Secrets

data/lib/anyway/settings.rb

@@ -38,6 +38,7 @@ module Anyway
       end
 
       setting :unwrap_known_environments, true
+      setting :reject_unknown_overrides, true
 
       private
 
@@ -55,6 +56,14 @@ module Anyway
       # Suppress required validations for CI/CD pipelines
       attr_accessor :suppress_required_validations
 
+      # Whether to check for unknown attributes in schemaful (key-based) sources:
+      # false — ignore unknown attributes, true — raise, :warn — print a warning
+      attr_accessor :enforce_config_schema
+
+      # A callable (config, key) -> bool to ignore specific unknown attributes
+      # (e.g., when the same source is shared by multiple configs)
+      attr_accessor :rescue_unknown_attributes_with
+
       # A proc returning a path to YML config file given the config name
       attr_reader :default_config_path
 
@@ -113,5 +122,8 @@ module Anyway
 
     # By default, use ANYWAY_SUPPRESS_VALIDATIONS
     self.suppress_required_validations = %w[1 t true y yes].include?(ENV["ANYWAY_SUPPRESS_VALIDATIONS"])
+
+    # Unknown attributes are ignored by default
+    self.enforce_config_schema = false
   end
 end

data/lib/anyway/version.rb

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

data/sig/anyway_config.rbs

@@ -9,6 +9,10 @@ module Anyway
     def self.default_environmental_key: -> String?
     def self.suppress_required_validations: -> bool
     def self.known_environments: -> Array[String]?
+    def self.enforce_config_schema: -> (bool | :warn)
+    def self.enforce_config_schema=: (bool | :warn) -> void
+    def self.rescue_unknown_attributes_with: -> (^(Config, String) -> boolish)?
+    def self.rescue_unknown_attributes_with=: ((^(Config, String) -> boolish)?) -> void
 
     class Future
       def self.setting: (untyped name, untyped default_value) -> untyped
@@ -107,6 +111,8 @@ module Anyway
     private
     attr_reader values: Hash[untyped, untyped]
     def raise_validation_error: (String msg) -> void
+    def reject_unknown_config_attributes!: (Hash[untyped, untyped]? data, source: Symbol, ?strict: bool) -> void
+    def format_unknown_attribute: (String key, Array[String] known) -> String
     def flatten_hash: (Hash[untyped, untyped], String, Hash[String, String]) -> Hash[String, String]
 
     class Error < StandardError
@@ -114,6 +120,9 @@ module Anyway
 
     class ValidationError < Error
     end
+
+    class UnknownAttributesError < ValidationError
+    end
   end
 
   class Env
@@ -127,8 +136,10 @@ module Anyway
       include Tracing
 
       def self.call: (?local: bool, **untyped) -> untyped
-      def initialize: (local: bool) -> void
+      def initialize: (?local: bool, **untyped) -> void
+      def call: (name: String, env_prefix: String, config_path: String | Pathname, **untyped) -> Hash[untyped, untyped]
       def use_local?: -> bool
+      def schemaful?: -> bool
     end
 
     interface _Loader