anyway_config 2.0.6 → 2.1.0

data/README.md

@@ -329,7 +329,9 @@ and then use [Rails generators](#generators) to make your application Anyway Con
 
 Your config is filled up with values from the following sources (ordered by priority from low to high):
 
-- `RAILS_ROOT/config/my_cool_gem.yml` (for the current `RAILS_ENV`, supports `ERB`):
+1) **YAML configuration files**: `RAILS_ROOT/config/my_cool_gem.yml`.
+
+Recognizes Rails environment, supports `ERB`:
 
 ```yml
 test:
@@ -341,9 +343,51 @@ development:
   port: 3000
 ```
 
-**NOTE:** you can override the default YML lookup path by setting `MYCOOLGEM_CONF` env variable.
+### Multi-env configuration
+
+_⚡️ This feature will be turned on by default in the future releases. You can turn it on now via `config.anyway_config.future.use :unwrap_known_environments`._
+
+If the YML does not have keys that are one of the "known" Rails environments (development, production, test)—the same configuration will be available in all environments, similar to non-Rails behavior:
+
+```yml
+host: localhost
+port: 3002
+# These values will be active in all environments
+```
+
+To extend the list of known environments, use the setting in the relevant part of your Rails code:
+
+```ruby
+Rails.application.config.anyway_config.known_environments << "staging"
+```
+
+If your YML defines at least a single "environmental" top-level, you _have_ to separate all your settings per-environment. You can't mix and match:
+
+```yml
+staging:
+  host: localhost # This value will be loaded when Rails.env.staging? is true
+
+port: 3002 # This value will not be loaded at all
+```
+
+You can specify the lookup path for YAML files in one of the following ways:
+
+- By setting `config.anyway_config.default_config_path` to a target directory path:
+
+```ruby
+config.anyway_config.default_config_path = "/etc/configs"
+config.anyway_config.default_config_path = Rails.root.join("etc", "configs")
+```
+
+- By setting `config.anyway_config.default_config_path` to a Proc, which accepts a config name and returns the path:
 
-- `Rails.application.secrets.my_cool_gem` (if `secrets.yml` present):
+```ruby
+config.anyway_config.default_config_path = ->(name) { Rails.root.join("data", "configs", "#{name}.yml") }
+```
+
+- By overriding a specific config YML file path via the `<NAME>_CONF` env variable, e.g., `MYCOOLGEM_CONF=path/to/cool.yml`
+
+2) **Rails secrets**: `Rails.application.secrets.my_cool_gem` (if `secrets.yml` present).
 
 ```yml
 # config/secrets.yml
@@ -352,7 +396,7 @@ development:
     port: 4444
 ```
 
-- `Rails.application.credentials.my_cool_gem` (if supported):
+3) **Rails credentials**: `Rails.application.credentials.my_cool_gem` (if supported):
 
 ```yml
 my_cool_gem:
@@ -361,7 +405,7 @@ my_cool_gem:
 
 **NOTE:** You can backport Rails 6 per-environment credentials to Rails 5.2 app using [this patch](https://gist.github.com/palkan/e27e4885535ff25753aefce45378e0cb).
 
-- `ENV['MYCOOLGEM_*']`.
+4) **Environment variables**: `ENV['MYCOOLGEM_*']`.
 
 See [environment variables](#environment-variables).
 
@@ -444,7 +488,7 @@ Alternatively, you can call `rails g anyway:app_config name param1 param2 ...`.
 
 The default data loading mechanism for non-Rails applications is the following (ordered by priority from low to high):
 
-- `./config/<config-name>.yml` (`ERB` is supported if `erb` is loaded)
+1) **YAML configuration files**: `./config/<config-name>.yml`.
 
 In pure Ruby apps, we do not know about _environments_ (`test`, `development`, `production`, etc.); thus, we assume that the YAML contains values for a single environment:
 
@@ -453,9 +497,25 @@ host: localhost
 port: 3000
 ```
 
-**NOTE:** you can override the default YML lookup path by setting `MYCOOLGEM_CONF` env variable.
+`ERB` is supported if `erb` is loaded (thus, you need to call `require "erb"` somewhere before loading configuration).
+
+You can specify the lookup path for YAML files in one of the following ways:
+
+- By setting `Anyway::Settings.default_config_path` to a target directory path:
+
+```ruby
+Anyway::Settings.default_config_path = "/etc/configs"
+```
+
+- By setting `Anyway::Settings.default_config_path` to a Proc, which accepts a config name and returns the path:
+
+```ruby
+Anyway::Settings.default_config_path = ->(name) { Rails.root.join("data", "configs", "#{name}.yml") }
+```
+
+- By overriding a specific config YML file path via the `<NAME>_CONF` env variable, e.g., `MYCOOLGEM_CONF=path/to/cool.yml`
 
-- `ENV['MYCOOLGEM_*']`.
+2) **Environment variables**: `ENV['MYCOOLGEM_*']`.
 
 See [environment variables](#environment-variables).
 
@@ -666,7 +726,7 @@ If you want to delete the env var, pass `nil` as the value.
 
 This helper is automatically included to RSpec if `RAILS_ENV` or `RACK_ENV` env variable is equal to "test". It's only available for the example with the tag `type: :config` or with the path `spec/configs/...`.
 
-You can add it manually by requiring `"anyway/testing/helpers"` and including the `Anyway::Test::Helpers` module (into RSpec configuration or Minitest test class).
+You can add it manually by requiring `"anyway/testing/helpers"` and including the `Anyway::Testing::Helpers` module (into RSpec configuration or Minitest test class).
 
 ## OptionParser integration
 

data/lib/.rbnext/1995.next/anyway/config.rb

@@ -0,0 +1,391 @@
+# frozen_string_literal: true
+
+require "anyway/optparse_config"
+require "anyway/dynamic_config"
+
+module Anyway # :nodoc:
+  using RubyNext
+  using Anyway::Ext::DeepDup
+  using Anyway::Ext::DeepFreeze
+  using Anyway::Ext::Hash
+
+  using(Module.new do
+    refine Object do
+      def vm_object_id() = (object_id << 1).to_s(16)
+    end
+  end)
+
+  # Base config class
+  # Provides `attr_config` method to describe
+  # configuration parameters and set defaults
+  class Config
+    PARAM_NAME = /^[a-z_](\w+)?$/
+
+    # List of names that couldn't be used as config names
+    # (the class instance methods we use)
+    RESERVED_NAMES = %i[
+      config_name
+      env_prefix
+      values
+      class
+      clear
+      deconstruct_keys
+      dig
+      dup
+      initialize
+      load
+      load_from_sources
+      option_parser
+      pretty_print
+      raise_validation_error
+      reload
+      resolve_config_path
+      tap
+      to_h
+      to_source_trace
+      write_config_attr
+    ].freeze
+
+    class Error < StandardError; end
+
+    class ValidationError < Error; end
+
+    include OptparseConfig
+    include DynamicConfig
+
+    class BlockCallback
+      attr_reader :block
+
+      def initialize(block)
+        @block = block
+      end
+
+      def apply_to(config)
+        config.instance_exec(&block)
+      end
+    end
+
+    class NamedCallback
+      attr_reader :name
+
+      def initialize(name)
+        @name = name
+      end
+
+      def apply_to(config) = config.send(name)
+    end
+
+    class << self
+      def attr_config(*args, **hargs)
+        new_defaults = hargs.deep_dup
+        new_defaults.stringify_keys!
+
+        defaults.merge! new_defaults
+
+        new_keys = ((args + new_defaults.keys) - config_attributes)
+
+        validate_param_names! new_keys.map(&:to_s)
+
+        new_keys.map!(&:to_sym)
+
+        unless (reserved_names = (new_keys & RESERVED_NAMES)).empty?
+          raise ArgumentError, "Can not use the following reserved names as config attrubutes: " \
+            "#{reserved_names.sort.map(&:to_s).join(", ")}"
+        end
+
+        config_attributes.push(*new_keys)
+
+        define_config_accessor(*new_keys)
+
+        # Define predicate methods ("param?") for attributes
+        # having `true` or `false` as default values
+        new_defaults.each do |key, val|
+          next unless val.is_a?(TrueClass) || val.is_a?(FalseClass)
+          alias_method :"#{key}?", :"#{key}"
+        end
+      end
+
+      def defaults
+        return @defaults if instance_variable_defined?(:@defaults)
+
+        @defaults = if superclass < Anyway::Config
+          superclass.defaults.deep_dup
+        else
+          new_empty_config
+        end
+      end
+
+      def config_attributes
+        return @config_attributes if instance_variable_defined?(:@config_attributes)
+
+        @config_attributes = if superclass < Anyway::Config
+          superclass.config_attributes.dup
+        else
+          []
+        end
+      end
+
+      def required(*names)
+        unless (unknown_names = (names - config_attributes)).empty?
+          raise ArgumentError, "Unknown config param: #{unknown_names.join(",")}"
+        end
+
+        required_attributes.push(*names)
+      end
+
+      def required_attributes
+        return @required_attributes if instance_variable_defined?(:@required_attributes)
+
+        @required_attributes = if superclass < Anyway::Config
+          superclass.required_attributes.dup
+        else
+          []
+        end
+      end
+
+      def on_load(*names, &block)
+        raise ArgumentError, "Either methods or block should be specified, not both" if block && !names.empty?
+
+        if block
+          load_callbacks << BlockCallback.new(block)
+        else
+          load_callbacks.push(*names.map { NamedCallback.new(_1) })
+        end
+      end
+
+      def load_callbacks
+        return @load_callbacks if instance_variable_defined?(:@load_callbacks)
+
+        @load_callbacks = if superclass <= Anyway::Config
+          superclass.load_callbacks.dup
+        else
+          []
+        end
+      end
+
+      def config_name(val = nil)
+        return (@explicit_config_name = val.to_s) unless val.nil?
+
+        return @config_name if instance_variable_defined?(:@config_name)
+
+        @config_name = explicit_config_name || build_config_name
+      end
+
+      def explicit_config_name
+        return @explicit_config_name if instance_variable_defined?(:@explicit_config_name)
+
+        @explicit_config_name =
+          if superclass.respond_to?(:explicit_config_name)
+            superclass.explicit_config_name
+          end
+      end
+
+      def explicit_config_name?() = !explicit_config_name.nil?
+
+      def env_prefix(val = nil)
+        return (@env_prefix = val.to_s.upcase) unless val.nil?
+
+        return @env_prefix if instance_variable_defined?(:@env_prefix)
+
+        @env_prefix = if superclass < Anyway::Config && superclass.explicit_config_name?
+          superclass.env_prefix
+        else
+          config_name.upcase
+        end
+      end
+
+      def new_empty_config() = {}
+
+      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)
+              values[:#{name}] = val
+            end
+
+            def #{name}
+              values[:#{name}]
+            end
+          RUBY
+        end
+      end
+
+      def accessors_module
+        return @accessors_module if instance_variable_defined?(:@accessors_module)
+
+        @accessors_module = Module.new.tap do |mod|
+          include mod
+        end
+      end
+
+      def build_config_name
+        unless name
+          raise "Please, specify config name explicitly for anonymous class " \
+            "via `config_name :my_config`"
+        end
+
+        # handle two cases:
+        # - SomeModule::Config => "some_module"
+        # - SomeConfig => "some"
+        unless name =~ /^(\w+)(::)?Config$/
+          raise "Couldn't infer config name, please, specify it explicitly" \
+            "via `config_name :my_config`"
+        end
+
+        Regexp.last_match[1].tap(&:downcase!)
+      end
+
+      def validate_param_names!(names)
+        invalid_names = names.reject { |name| name =~ PARAM_NAME }
+        return if invalid_names.empty?
+
+        raise ArgumentError, "Invalid attr_config name: #{invalid_names.join(", ")}.\n" \
+          "Valid names must satisfy /#{PARAM_NAME.source}/."
+      end
+    end
+
+    on_load :validate_required_attributes!
+
+    attr_reader :config_name, :env_prefix
+
+    # Instantiate config instance.
+    #
+    # Example:
+    #
+    #   my_config = Anyway::Config.new()
+    #
+    #   # provide some values explicitly
+    #   my_config = Anyway::Config.new({some: :value})
+    #
+    def initialize(overrides = nil)
+      @config_name = self.class.config_name
+
+      raise ArgumentError, "Config name is missing" unless @config_name
+
+      @env_prefix = self.class.env_prefix
+      @values = {}
+
+      load(overrides)
+    end
+
+    def reload(overrides = nil)
+      clear
+      load(overrides)
+      self
+    end
+
+    def clear
+      values.clear
+      @__trace__ = nil
+      self
+    end
+
+    def load(overrides = nil)
+      base_config = self.class.defaults.deep_dup
+
+      trace = Tracing.capture do
+        Tracing.trace!(:defaults) { base_config }
+
+        config_path = resolve_config_path(config_name, env_prefix)
+
+        load_from_sources(base_config, name: config_name, env_prefix: env_prefix, config_path: config_path)
+
+        if overrides
+          Tracing.trace!(:load) { overrides }
+
+          Utils.deep_merge!(base_config, overrides)
+        end
+      end
+
+      base_config.each do |key, val|
+        write_config_attr(key.to_sym, val)
+      end
+
+      # Trace may contain unknown attributes
+      trace&.keep_if { |key| self.class.config_attributes.include?(key.to_sym) }
+
+      # Run on_load callbacks
+      self.class.load_callbacks.each { _1.apply_to(self) }
+
+      # Set trace after we write all the values to
+      # avoid changing the source to accessor
+      @__trace__ = trace
+
+      self
+    end
+
+    def load_from_sources(base_config, **options)
+      Anyway.loaders.each do |(_id, loader)|
+        Utils.deep_merge!(base_config, loader.call(**options))
+      end
+      base_config
+    end
+
+    def dig(*keys) = values.dig(*keys)
+
+    def to_h() = values.deep_dup.deep_freeze
+
+    def dup
+      self.class.allocate.tap do |new_config|
+        %i[config_name env_prefix __trace__].each do |ivar|
+          new_config.instance_variable_set(:"@#{ivar}", send(ivar).dup)
+        end
+        new_config.instance_variable_set(:@values, values.deep_dup)
+      end
+    end
+
+    def resolve_config_path(name, env_prefix)
+      Anyway.env.fetch(env_prefix).delete("conf") || Settings.default_config_path.call(name)
+    end
+
+    def deconstruct_keys(keys) = values.deconstruct_keys(keys)
+
+    def to_source_trace() = __trace__&.to_h
+
+    def inspect
+      "#<#{self.class}:0x#{vm_object_id.rjust(16, "0")} config_name=\"#{config_name}\" env_prefix=\"#{env_prefix}\" " \
+      "values=#{values.inspect}>"
+    end
+
+    def pretty_print(q)
+      q.object_group self do
+        q.nest(1) do
+          q.breakable
+          q.text "config_name=#{config_name.inspect}"
+          q.breakable
+          q.text "env_prefix=#{env_prefix.inspect}"
+          q.breakable
+          q.text "values:"
+          q.pp __trace__
+        end
+      end
+    end
+
+    private
+
+    attr_reader :values, :__trace__
+
+    def validate_required_attributes!
+      self.class.required_attributes.select do |name|
+        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(", ")}"
+      end
+    end
+
+    def write_config_attr(key, val)
+      key = key.to_sym
+      return unless self.class.config_attributes.include?(key)
+
+      public_send(:"#{key}=", val)
+    end
+
+    def raise_validation_error(msg)
+      raise ValidationError, msg
+    end
+  end
+end