anyway_config 2.5.4 → 2.6.0

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

@@ -0,0 +1,473 @@
+# 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 Anyway::Ext::FlattenNames
+
+  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
+      as_env
+      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
+      __type_caster__
+    ].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, env: nil, **nested)
+        unknown_names = names + nested.keys - config_attributes
+        raise ArgumentError, "Unknown config param: #{unknown_names.join(",")}" if unknown_names.any?
+
+        return unless Settings.matching_env?(env)
+
+        required_attributes.push(*names)
+        required_attributes.push(*nested.flatten_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 { it = _1;NamedCallback.new(it) })
+        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 loader_options(val = nil)
+        return (@loader_options = val) unless val.nil?
+
+        return @loader_options if instance_variable_defined?(:@loader_options)
+
+        @loader_options = if superclass < Anyway::Config
+          superclass.loader_options
+        else
+          {}
+        end
+      end
+
+      def new_empty_config() = {}
+
+      def coerce_types(mapping)
+        Utils.deep_merge!(coercion_mapping, mapping)
+
+        mapping.each do |key, val|
+          type = val.is_a?(::Hash) ? val[:type] : val
+          next if type != :boolean
+
+          alias_method :"#{key}?", :"#{key}"
+        end
+      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)
+              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
+
+        # TODO(v3.0): Replace downcase with underscore
+        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:,
+          config_path:,
+          **self.class.loader_options
+        )
+
+        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 { it = _1;it.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, **__kwrest__)
+      Anyway.loaders.each do |(_id, loader)|
+        Utils.deep_merge!(base_config, loader.call(**__kwrest__))
+      end
+      base_config
+    end
+
+    def dig(*__rest__) = values.dig(*__rest__)
+
+    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
+
+    def as_env
+      Env.from_hash(to_h, prefix: env_prefix)
+    end
+
+    private
+
+    attr_reader :values, :__trace__
+
+    def validate_required_attributes!
+      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?)
+      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 write_config_attr(key, val)
+      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/.rbnext/3.2/anyway/loaders/base.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+module Anyway
+  module Loaders
+    class Base
+      include Tracing
+
+      class << self
+        def call(local: Anyway::Settings.use_local_files, **__kwrest__)
+          new(local:).call(**__kwrest__)
+        end
+      end
+
+      def initialize(local:)
+        @local = local
+      end
+
+      def use_local?() = @local == true
+    end
+  end
+end

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

@@ -0,0 +1,188 @@
+# frozen_string_literal: true
+
+module Anyway
+  # Provides method to trace values association
+  module Tracing
+    using Anyway::Ext::DeepDup
+
+    using(Module.new do
+      refine Thread::Backtrace::Location do
+        def path_lineno() = "#{path}:#{lineno}"
+      end
+    end)
+
+    class Trace
+      UNDEF = Object.new
+
+      attr_reader :type, :value, :source
+
+      def initialize(type = :trace, value = UNDEF, **source)
+        @type = type
+        @source = source
+        @value = (value == UNDEF) ? Hash.new { |h, k| h[k] = Trace.new(:trace) } : value
+      end
+
+      def dig(...)
+        value.dig(...)
+      end
+
+      def record_value(val, *path, **__kwrest__)
+        key = path.pop
+        trace = if val.is_a?(Hash)
+          Trace.new.tap { it = _1;it.merge_values(val, **__kwrest__) }
+        else
+          Trace.new(:value, val, **__kwrest__)
+        end
+
+        target_trace = path.empty? ? self : value.dig(*path)
+        target_trace.record_key(key.to_s, trace)
+
+        val
+      end
+
+      def merge_values(hash, **__kwrest__)
+        return hash unless hash
+
+        hash.each do |key, val|
+          if val.is_a?(Hash)
+            value[key.to_s].merge_values(val, **__kwrest__)
+          else
+            value[key.to_s] = Trace.new(:value, val, **__kwrest__)
+          end
+        end
+
+        hash
+      end
+
+      def record_key(key, key_trace)
+        @value = Hash.new { |h, k| h[k] = Trace.new(:trace) } unless value.is_a?(::Hash)
+
+        value[key] = key_trace
+      end
+
+      def merge!(another_trace)
+        raise ArgumentError, "You can only merge into a :trace type, and this is :#{type}" unless trace?
+        raise ArgumentError, "You can only merge a :trace type, but trying :#{type}" unless another_trace.trace?
+
+        another_trace.value.each do |key, sub_trace|
+          if sub_trace.trace?
+            value[key].merge! sub_trace
+          else
+            value[key] = sub_trace
+          end
+        end
+      end
+
+      def keep_if(...)
+        raise ArgumentError, "You can only filter :trace type, and this is :#{type}" unless trace?
+        value.keep_if(...)
+      end
+
+      def clear() = value.clear
+
+      def trace?() = type == :trace
+
+      def to_h
+        if trace?
+          value.transform_values(&:to_h).tap { it = _1;it.default_proc = nil }
+        else
+          {value:, source:}
+        end
+      end
+
+      def dup() = self.class.new(type, value.dup, **source)
+
+      def pretty_print(q)
+        if trace?
+          q.nest(2) do
+            q.breakable ""
+            q.seplist(value, nil, :each) do |k, v|
+              q.group do
+                q.text k
+                q.text " =>"
+                if v.trace?
+                  q.text " { "
+                  q.pp v
+                  q.breakable " "
+                  q.text "}"
+                else
+                  q.breakable " "
+                  q.pp v
+                end
+              end
+            end
+          end
+        else
+          q.pp value
+          q.group(0, " (", ")") do
+            q.seplist(source, lambda { q.breakable " " }, :each) do |k, v|
+              q.group do
+                q.text k.to_s
+                q.text "="
+                q.text v.to_s
+              end
+            end
+          end
+        end
+      end
+    end
+
+    class << self
+      def capture
+        unless Settings.tracing_enabled
+          yield
+          return
+        end
+
+        trace = Trace.new
+        trace_stack.push trace
+        yield
+        trace_stack.last
+      ensure
+        trace_stack.pop
+      end
+
+      def trace_stack
+        (Thread.current[:__anyway__trace_stack__] ||= [])
+      end
+
+      def current_trace() = trace_stack.last
+
+      alias_method :tracing?, :current_trace
+
+      def source_stack
+        (Thread.current[:__anyway__trace_source_stack__] ||= [])
+      end
+
+      def current_trace_source
+        source_stack.last || accessor_source(caller_locations(2, 1).first)
+      end
+
+      def with_trace_source(src)
+        source_stack << src
+        yield
+      ensure
+        source_stack.pop
+      end
+
+      private
+
+      def accessor_source(location)
+        {type: :accessor, called_from: location.path_lineno}
+      end
+    end
+
+    module_function
+
+    def trace!(type, *path, **__kwrest__)
+      return yield unless Tracing.tracing?
+      val = yield
+      if val.is_a?(Hash)
+        Tracing.current_trace.merge_values(val, type:, **__kwrest__)
+      elsif !path.empty?
+        Tracing.current_trace.record_value(val, *path, type:, **__kwrest__)
+      end
+      val
+    end
+  end
+end