anyway_config 2.0.5 → 2.2.1

data/lib/anyway/config.rb

@@ -19,7 +19,7 @@ module Anyway # :nodoc:
   # Provides `attr_config` method to describe
   # configuration parameters and set defaults
   class Config
-    PARAM_NAME = /^[a-z_]([\w]+)?$/
+    PARAM_NAME = /^[a-z_](\w+)?$/
 
     # List of names that couldn't be used as config names
     # (the class instance methods we use)
@@ -40,12 +40,15 @@ module Anyway # :nodoc:
       raise_validation_error
       reload
       resolve_config_path
+      tap
       to_h
       to_source_trace
       write_config_attr
+      __type_caster__
     ].freeze
 
     class Error < StandardError; end
+
     class ValidationError < Error; end
 
     include OptparseConfig
@@ -106,21 +109,21 @@ module Anyway # :nodoc:
       def defaults
         return @defaults if instance_variable_defined?(:@defaults)
 
-        if superclass < Anyway::Config
+        @defaults = if superclass < Anyway::Config
           superclass.defaults.deep_dup
         else
           new_empty_config
-        end => @defaults
+        end
       end
 
       def config_attributes
         return @config_attributes if instance_variable_defined?(:@config_attributes)
 
-        if superclass < Anyway::Config
+        @config_attributes = if superclass < Anyway::Config
           superclass.config_attributes.dup
         else
           []
-        end => @config_attributes
+        end
       end
 
       def required(*names)
@@ -134,17 +137,17 @@ module Anyway # :nodoc:
       def required_attributes
         return @required_attributes if instance_variable_defined?(:@required_attributes)
 
-        if superclass < Anyway::Config
+        @required_attributes = if superclass < Anyway::Config
           superclass.required_attributes.dup
         else
           []
-        end => @required_attributes
+        end
       end
 
       def on_load(*names, &block)
-        raise ArgumentError, "Either methods or block should be specified, not both" if block_given? && !names.empty?
+        raise ArgumentError, "Either methods or block should be specified, not both" if block && !names.empty?
 
-        if block_given?
+        if block
           load_callbacks << BlockCallback.new(block)
         else
           load_callbacks.push(*names.map { NamedCallback.new(_1) })
@@ -154,11 +157,11 @@ module Anyway # :nodoc:
       def load_callbacks
         return @load_callbacks if instance_variable_defined?(:@load_callbacks)
 
-        if superclass <= Anyway::Config
+        @load_callbacks = if superclass <= Anyway::Config
           superclass.load_callbacks.dup
         else
           []
-        end => @load_callbacks
+        end
       end
 
       def config_name(val = nil)
@@ -185,24 +188,64 @@ module Anyway # :nodoc:
 
         return @env_prefix if instance_variable_defined?(:@env_prefix)
 
-        if superclass < Anyway::Config && superclass.explicit_config_name?
+        @env_prefix = if superclass < Anyway::Config && superclass.explicit_config_name?
           superclass.env_prefix
         else
           config_name.upcase
-        end => @env_prefix
+        end
       end
 
       def new_empty_config() = {}
 
+      def coerce_types(mapping)
+        coercion_mapping.deep_merge!(mapping)
+      end
+
+      def coercion_mapping
+        return @coercion_mapping if instance_variable_defined?(:@coercion_mapping)
+
+        @coercion_mapping = if superclass < Anyway::Config
+          superclass.coercion_mapping.deep_dup
+        else
+          {}
+        end
+      end
+
+      def type_caster(val = nil)
+        return @type_caster unless val.nil?
+
+        @type_caster ||=
+          if coercion_mapping.empty?
+            fallback_type_caster
+          else
+            ::Anyway::TypeCaster.new(coercion_mapping, fallback: fallback_type_caster)
+          end
+      end
+
+      def fallback_type_caster(val = nil)
+        return (@fallback_type_caster = val) unless val.nil?
+
+        return @fallback_type_caster if instance_variable_defined?(:@fallback_type_caster)
+
+        @fallback_type_caster = if superclass < Anyway::Config
+          superclass.fallback_type_caster.deep_dup
+        else
+          ::Anyway::AutoCast
+        end
+      end
+
+      def disable_auto_cast!
+        @fallback_type_caster = ::Anyway::NoCast
+      end
+
       private
 
       def define_config_accessor(*names)
         names.each do |name|
           accessors_module.module_eval <<~RUBY, __FILE__, __LINE__ + 1
             def #{name}=(val)
-              __trace__&.record_value(val, \"#{name}\", Tracing.current_trace_source)
-              # DEPRECATED: instance variable set will be removed in 2.1
-              @#{name} = values[:#{name}] = val
+              __trace__&.record_value(val, \"#{name}\", **Tracing.current_trace_source)
+              values[:#{name}] = val
             end
 
             def #{name}
@@ -215,9 +258,9 @@ module Anyway # :nodoc:
       def accessors_module
         return @accessors_module if instance_variable_defined?(:@accessors_module)
 
-        Module.new.tap do |mod|
+        @accessors_module = Module.new.tap do |mod|
           include mod
-        end => @accessors_module
+        end
       end
 
       def build_config_name
@@ -229,7 +272,7 @@ module Anyway # :nodoc:
         # handle two cases:
         # - SomeModule::Config => "some_module"
         # - SomeConfig => "some"
-        unless name =~ /^(\w+)(\:\:)?Config$/
+        unless name =~ /^(\w+)(::)?Config$/
           raise "Couldn't infer config name, please, specify it explicitly" \
             "via `config_name :my_config`"
         end
@@ -285,22 +328,19 @@ module Anyway # :nodoc:
     def load(overrides = nil)
       base_config = self.class.defaults.deep_dup
 
-      Tracing.capture do
+      trace = Tracing.capture do
         Tracing.trace!(:defaults) { base_config }
 
-        load_from_sources(
-          base_config,
-          name: config_name,
-          env_prefix: env_prefix,
-          config_path: resolve_config_path(config_name, env_prefix)
-        )
+        config_path = resolve_config_path(config_name, env_prefix)
+
+        load_from_sources(base_config, name: config_name, env_prefix:, config_path:)
 
         if overrides
           Tracing.trace!(:load) { overrides }
 
-          base_config.deep_merge!(overrides)
+          Utils.deep_merge!(base_config, overrides)
         end
-      end => trace
+      end
 
       base_config.each do |key, val|
         write_config_attr(key.to_sym, val)
@@ -321,7 +361,7 @@ module Anyway # :nodoc:
 
     def load_from_sources(base_config, **options)
       Anyway.loaders.each do |(_id, loader)|
-        base_config.deep_merge!(loader.call(**options))
+        Utils.deep_merge!(base_config, loader.call(**options))
       end
       base_config
     end
@@ -375,7 +415,7 @@ module Anyway # :nodoc:
         values[name].nil? || (values[name].is_a?(String) && values[name].empty?)
       end.then do |missing|
         next if missing.empty?
-        raise_validation_error "The following config parameters are missing or empty: #{missing.join(", ")}"
+        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
 
@@ -383,11 +423,16 @@ module Anyway # :nodoc:
       key = key.to_sym
       return unless self.class.config_attributes.include?(key)
 
+      val = __type_caster__.coerce(key, val)
       public_send(:"#{key}=", val)
     end
 
     def raise_validation_error(msg)
       raise ValidationError, msg
     end
+
+    def __type_caster__
+      self.class.type_caster
+    end
   end
 end

data/lib/anyway/dynamic_config.rb

@@ -12,11 +12,15 @@ module Anyway
       #   my_config = Anyway::Config.for(:my_app)
       #   # will load data from config/my_app.yml, secrets.my_app, ENV["MY_APP_*"]
       #
-      def for(name, **options)
+      def for(name, auto_cast: true, **options)
         config = allocate
         options[:env_prefix] ||= name.to_s.upcase
         options[:config_path] ||= config.resolve_config_path(name, options[:env_prefix])
-        config.load_from_sources(new_empty_config, name: name, **options)
+
+        raw_config = config.load_from_sources(new_empty_config, name:, **options)
+        return raw_config unless auto_cast
+
+        AutoCast.call(raw_config)
       end
     end
 

data/lib/anyway/env.rb

@@ -49,7 +49,7 @@ module Anyway
         path = key.sub(/^#{prefix}_/, "").downcase
 
         paths = path.split("__")
-        trace!(:env, *paths, key: key) { data.bury(type_cast.call(val), *paths) }
+        trace!(:env, *paths, key:) { data.bury(type_cast.call(val), *paths) }
       end
     end
   end

data/lib/anyway/ext/deep_dup.rb

@@ -30,6 +30,18 @@ module Anyway
         end
       end
 
+      refine ::Object do
+        def deep_dup
+          dup
+        end
+      end
+
+      refine ::Module do
+        def deep_dup
+          self
+        end
+      end
+
       using self
     end
   end

data/lib/anyway/ext/hash.rb

@@ -5,18 +5,6 @@ module Anyway
     # Extend Hash through refinements
     module Hash
       refine ::Hash do
-        # From ActiveSupport http://api.rubyonrails.org/classes/Hash.html#method-i-deep_merge
-        def deep_merge!(other_hash)
-          merge!(other_hash) do |key, this_value, other_value|
-            if this_value.is_a?(::Hash) && other_value.is_a?(::Hash)
-              this_value.deep_merge!(other_value)
-              this_value
-            else
-              other_value
-            end
-          end
-        end
-
         def stringify_keys!
           keys.each do |key|
             value = delete(key)
@@ -38,6 +26,16 @@ module Anyway
           end
           hash[last_key] = val
         end
+
+        def deep_merge!(other)
+          other.each do |k, v|
+            if key?(k) && self[k].is_a?(::Hash) && v.is_a?(::Hash)
+              self[k].deep_merge!(v)
+            else
+              self[k] = v
+            end
+          end
+        end
       end
 
       using self

data/lib/anyway/loaders/base.rb

@@ -7,7 +7,7 @@ module Anyway
 
       class << self
         def call(local: Anyway::Settings.use_local_files, **opts)
-          new(local: local).call(**opts)
+          new(local:).call(**opts)
         end
       end
 

data/lib/anyway/loaders/env.rb

@@ -6,7 +6,9 @@ module Anyway
   module Loaders
     class Env < Base
       def call(env_prefix:, **_options)
-        Anyway.env.fetch_with_trace(env_prefix).then do |(conf, trace)|
+        env = ::Anyway::Env.new(type_cast: ::Anyway::NoCast)
+
+        env.fetch_with_trace(env_prefix).then do |(conf, trace)|
           Tracing.current_trace&.merge!(trace)
           conf
         end

data/lib/anyway/loaders/yaml.rb

@@ -17,7 +17,7 @@ module Anyway
         local_path = local_config_path(config_path)
         local_config = trace!(:yml, path: relative_config_path(local_path).to_s) { load_local_yml(local_path) }
 
-        base_config.deep_merge!(local_config)
+        Utils.deep_merge!(base_config, local_config)
       end
 
       private
@@ -25,15 +25,19 @@ module Anyway
       def parse_yml(path)
         return {} unless File.file?(path)
         require "yaml" unless defined?(::YAML)
+
+        # By default, YAML load will return `false` when the yaml document is
+        # empty. When this occurs, we return an empty hash instead, to match
+        # the interface when no config file is present.
         if defined?(ERB)
-          ::YAML.load(ERB.new(File.read(path)).result) # rubocop:disable Security/YAMLLoad
+          ::YAML.load(ERB.new(File.read(path)).result) || {} # rubocop:disable Security/YAMLLoad
         else
-          ::YAML.load_file(path)
+          ::YAML.load_file(path) || {}
         end
       end
 
-      alias load_base_yml parse_yml
-      alias load_local_yml parse_yml
+      alias_method :load_base_yml, :parse_yml
+      alias_method :load_local_yml, :parse_yml
 
       def local_config_path(path)
         path.sub(/\.yml/, ".local.yml")

data/lib/anyway/option_parser_builder.rb

@@ -8,8 +8,6 @@ module Anyway # :nodoc:
     class << self
       def call(options)
         OptionParser.new do |opts|
-          opts.accept(AutoCast) { AutoCast.call(_1) }
-
           options.each do |key, descriptor|
             opts.on(*option_parser_on_args(key, **descriptor)) do |val|
               yield [key, val]
@@ -20,7 +18,7 @@ module Anyway # :nodoc:
 
       private
 
-      def option_parser_on_args(key, flag: false, desc: nil, type: AutoCast)
+      def option_parser_on_args(key, flag: false, desc: nil, type: ::String)
         on_args = ["--#{key.to_s.tr("_", "-")}#{flag ? "" : " VALUE"}"]
         on_args << type unless flag
         on_args << desc unless desc.nil?

data/lib/anyway/optparse_config.rb

@@ -70,13 +70,11 @@ module Anyway
     end
 
     def option_parser
-      @option_parser ||= begin
-        OptionParserBuilder.call(self.class.option_parser_options) do |key, val|
-          write_config_attr(key, val)
-        end.tap do |parser|
-          self.class.option_parser_extensions.map do |extension|
-            extension.call(parser, self)
-          end
+      @option_parser ||= OptionParserBuilder.call(self.class.option_parser_options) do |key, val|
+                           write_config_attr(key, val)
+                         end.tap do |parser|
+        self.class.option_parser_extensions.map do |extension|
+          extension.call(parser, self)
         end
       end
     end

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

@@ -22,15 +22,15 @@ module Anyway
             :credentials,
             store: credentials_path
           ) do
-            ::Rails.application.credentials.public_send(name)
+            ::Rails.application.credentials.config[name.to_sym]
           end.then do |creds|
-            config.deep_merge!(creds) if creds
+            Utils.deep_merge!(config, creds) if creds
           end
 
           if use_local?
             trace!(:credentials, store: LOCAL_CONTENT_PATH) do
               local_credentials(name)
-            end.then { |creds| config.deep_merge!(creds) if creds }
+            end.then { |creds| Utils.deep_merge!(config, creds) if creds }
           end
 
           config
@@ -48,7 +48,7 @@ module Anyway
             key_path: ::Rails.root.join("config/credentials/local.key")
           )
 
-          creds.public_send(name)
+          creds.config[name.to_sym]
         end
 
         def credentials_path

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

@@ -15,7 +15,7 @@ module Anyway
           trace!(:secrets) do
             secrets.public_send(name)
           end.then do |secrets|
-            config.deep_merge!(secrets) if secrets
+            Utils.deep_merge!(config, secrets) if secrets
           end
 
           config
@@ -24,13 +24,11 @@ module Anyway
         private
 
         def secrets
-          @secrets ||= begin
-            ::Rails.application.secrets.tap do |_|
-              # Reset secrets state if the app hasn't been initialized
-              # See https://github.com/palkan/anyway_config/issues/14
-              next if ::Rails.application.initialized?
-              ::Rails.application.remove_instance_variable(:@secrets)
-            end
+          @secrets ||= ::Rails.application.secrets.tap do |_|
+            # Reset secrets state if the app hasn't been initialized
+            # See https://github.com/palkan/anyway_config/issues/14
+            next if ::Rails.application.initialized?
+            ::Rails.application.remove_instance_variable(:@secrets)
           end
         end
       end

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

@@ -5,11 +5,22 @@ module Anyway
     module Loaders
       class YAML < Anyway::Loaders::YAML
         def load_base_yml(*)
+          parsed_yml = super
+          return parsed_yml unless environmental?(parsed_yml)
+
           super[::Rails.env] || {}
         end
 
         private
 
+        def environmental?(parsed_yml)
+          return true unless Settings.future.unwrap_known_environments
+          # likely
+          return true if parsed_yml.key?(::Rails.env)
+          # less likely
+          ::Rails.application.config.anyway_config.known_environments.any? { parsed_yml.key?(_1) }
+        end
+
         def relative_config_path(path)
           Pathname.new(path).relative_path_from(::Rails.root)
         end

data/lib/anyway/rails/settings.rb

@@ -9,8 +9,13 @@ end
 
 module Anyway
   class Settings
+    class Future
+      setting :unwrap_known_environments, true
+    end
+
     class << self
       attr_reader :autoload_static_config_path, :autoloader
+      attr_accessor :known_environments
 
       if defined?(::Zeitwerk)
         def autoload_static_config_path=(val)
@@ -22,10 +27,11 @@ module Anyway
 
           @autoload_static_config_path = val
 
-          # See https://github.com/rails/rails/blob/8ab4fd12f18203b83d0f252db96d10731485ff6a/railties/lib/rails/autoloaders.rb#L10
+          # See Rails 6 https://github.com/rails/rails/blob/8ab4fd12f18203b83d0f252db96d10731485ff6a/railties/lib/rails/autoloaders.rb#L10
+          # and Rails 7 https://github.com/rails/rails/blob/5462fbd5de1900c1b1ce1c9dc11c1a2d8cdcd809/railties/lib/rails/autoloaders.rb#L15
           @autoloader = Zeitwerk::Loader.new.tap do |loader|
             loader.tag = "anyway.config"
-            loader.inflector = ActiveSupport::Dependencies::ZeitwerkIntegration::Inflector
+            loader.inflector = defined?(ActiveSupport::Dependencies::ZeitwerkIntegration::Inflector) ? ActiveSupport::Dependencies::ZeitwerkIntegration::Inflector : ::Rails::Autoloaders::Inflector
             loader.push_dir(::Rails.root.join(val))
             loader.setup
           end
@@ -56,5 +62,6 @@ module Anyway
     end
 
     self.default_config_path = ->(name) { ::Rails.root.join("config", "#{name}.yml") }
+    self.known_environments = %w[test development production]
   end
 end

data/lib/anyway/rbs.rb

@@ -0,0 +1,92 @@
+# frozen_string_literal: true
+
+module Anyway
+  module RBSGenerator
+    TYPE_TO_CLASS = {
+      string: "String",
+      integer: "Integer",
+      float: "Float",
+      date: "Date",
+      datetime: "DateTime",
+      uri: "URI",
+      boolean: "bool"
+    }.freeze
+
+    # Generate RBS signature from a config class
+    def to_rbs
+      *namespace, class_name = name.split("::")
+
+      buf = []
+      indent = 0
+      interface_name = "_Config"
+
+      if namespace.empty?
+        interface_name = "_#{class_name}"
+      else
+        buf << "module #{namespace.join("::")}"
+        indent += 1
+      end
+
+      # Using interface emulates a module we include to provide getters and setters
+      # (thus making `super` possible)
+      buf << "#{"  " * indent}interface #{interface_name}"
+      indent += 1
+
+      # Generating setters and getters for config attributes
+      config_attributes.each do |param|
+        type = coercion_mapping[param] || defaults[param.to_s]
+
+        type =
+          case type
+          in NilClass
+            "untyped"
+          in Symbol
+            TYPE_TO_CLASS.fetch(type) { defaults[param] ? "Symbol" : "untyped" }
+          in Array
+            "Array[untyped]"
+          in array:, type:, **nil
+            "Array[#{TYPE_TO_CLASS.fetch(type, "untyped")}]"
+          in Hash
+            "Hash[string,untyped]"
+          in TrueClass | FalseClass
+            "bool"
+          else
+            type.class.to_s
+          end
+
+        getter_type = type
+        getter_type = "#{type}?" unless required_attributes.include?(param)
+
+        buf << "#{"  " * indent}def #{param}: () -> #{getter_type}"
+        buf << "#{"  " * indent}def #{param}=: (#{type}) -> void"
+
+        if type == "bool" || type == "bool?"
+          buf << "#{"  " * indent}def #{param}?: () -> #{getter_type}"
+        end
+      end
+
+      indent -= 1
+      buf << "#{"  " * indent}end"
+
+      buf << ""
+
+      buf << "#{"  " * indent}class #{class_name} < #{superclass.name}"
+      indent += 1
+
+      buf << "#{"  " * indent}include #{interface_name}"
+
+      indent -= 1
+      buf << "#{"  " * indent}end"
+
+      unless namespace.empty?
+        buf << "end"
+      end
+
+      buf << ""
+
+      buf.join("\n")
+    end
+  end
+
+  Config.extend RBSGenerator
+end