anyway_config 2.0.1 → 2.0.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9b9434114b530b5850b6f9210018f05b1d271072b5f29769700dd166b498c4b0
-  data.tar.gz: a14411a20a2f549fd955c53dc5e57535207338d7a10c9b91af1dc612b06b30df
+  metadata.gz: b3fcc40e50bfd285e686ca346ff5ddb3f4039104f1b5a79a8a4dd305d5d53707
+  data.tar.gz: 1f43073daee8706d7c9be2161bd226cb07f04a92929e6cdd81d64c8303f029da
 SHA512:
-  metadata.gz: 97362fd7819d70b1d52700146d12457fd62a0e2eaa34bc9511da87bb362a7722d066dc87c83c5a14381467a8fa934f5f25afe545036d8a6dae6a1492daf0ccfa
-  data.tar.gz: 2653e0fc1dfb868e0b015048c7f46567b90fb30892fcf9cd6b52d69a16f2635b91e6e409b499b7d0364635d4d755f811e2a1a63bf19831dffa7916ec9b964780
+  metadata.gz: 8125fbf4c4c592f673eca184d74ec3e02e1217016e4fa5a5d6371a24d13b9b092c48220dcd0bc57e33cbf7b0b28f0a1f5d2b9ce4c2f33aba42506e3444855bc9
+  data.tar.gz: 5076ec06d2dd7acbcb8a002653eb5e8df80a666ef83e7820d9ba9dd19103ac70db9560c818774bc8d8a26ea5f4b67b929c9e192c487f3e1785a5ed3f0d85b00a

data/CHANGELOG.md

@@ -1,5 +1,27 @@
 # Change log
 
+## 2.0.6 (2020-07-7)
+
+- Fix Ruby 2.7 warnings. ([@palkan][])
+
+## 2.0.5 (2020-05-15)
+
+- Use `YAML.load` instead of `YAML.safe_laad`. ([@palkan][])
+
+## 2.0.4 (2020-05-15)
+
+- Fix regression with adding `ruby-next` as a runtime dependency even for RubyGems release. ([@palkan][])
+
+## 2.0.3 (2020-05-12)
+
+- Enable [auto-transpiling](https://github.com/ruby-next/ruby-next#transpiled-files-vs-vcs-vs-installing-from-source) to allow installing from source. ([@palkan][])
+
+## 2.0.2 (2020-04-24)
+
+- Make sure configs are eager loaded in Rails when `config.eager_load = true`. ([@palkan][])
+
+  Fixes [#58](https://github.com/palkan/anyway_config/issues/58).
+
 ## 2.0.1 (2020-04-15)
 
 - Fix loading Railtie when application has been already initialized. ([@palkan][])

data/README.md

@@ -1,4 +1,4 @@
-[![Cult Of Martians](http://cultofmartians.com/assets/badges/badge.svg)](http://cultofmartians.com)
+[![Cult Of Martians](http://cultofmartians.com/assets/badges/badge.svg)](https://cultofmartians.com/tasks/anyway-config-options-parse.html#task)
 [![Gem Version](https://badge.fury.io/rb/anyway_config.svg)](https://rubygems.org/gems/anyway_config) [![Build](https://github.com/palkan/anyway_config/workflows/Build/badge.svg)](https://github.com/palkan/anyway_config/actions)
 [![JRuby Build](https://github.com/palkan/anyway_config/workflows/JRuby%20Build/badge.svg)](https://github.com/palkan/anyway_config/actions)
 

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

@@ -11,9 +11,7 @@ module Anyway # :nodoc:
 
   using(Module.new do
     refine Object do
-      def vm_object_id
-        (object_id << 1).to_s(16)
-      end
+      def vm_object_id() ;  (object_id << 1).to_s(16); end
     end
   end)
 
@@ -72,9 +70,7 @@ module Anyway # :nodoc:
         @name = name
       end
 
-      def apply_to(config)
-        config.send(name)
-      end
+      def apply_to(config) ;  config.send(name); end
     end
 
     class << self
@@ -110,23 +106,21 @@ module Anyway # :nodoc:
       def defaults
         return @defaults if instance_variable_defined?(:@defaults)
 
-        @defaults =
-          if superclass < Anyway::Config
-            superclass.defaults.deep_dup
-          else
-            new_empty_config
-          end
+        @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
+        @config_attributes = if superclass < Anyway::Config
+          superclass.config_attributes.dup
+        else
+          []
+        end
       end
 
       def required(*names)
@@ -140,12 +134,11 @@ module Anyway # :nodoc:
       def required_attributes
         return @required_attributes if instance_variable_defined?(:@required_attributes)
 
-        @required_attributes =
-          if superclass < Anyway::Config
-            superclass.required_attributes.dup
-          else
-            []
-          end
+        @required_attributes = if superclass < Anyway::Config
+          superclass.required_attributes.dup
+        else
+          []
+        end
       end
 
       def on_load(*names, &block)
@@ -161,12 +154,11 @@ module Anyway # :nodoc:
       def load_callbacks
         return @load_callbacks if instance_variable_defined?(:@load_callbacks)
 
-        @load_callbacks =
-          if superclass <= Anyway::Config
-            superclass.load_callbacks.dup
-          else
-            []
-          end
+        @load_callbacks = if superclass <= Anyway::Config
+          superclass.load_callbacks.dup
+        else
+          []
+        end
       end
 
       def config_name(val = nil)
@@ -186,26 +178,21 @@ module Anyway # :nodoc:
           end
       end
 
-      def explicit_config_name?
-        !explicit_config_name.nil?
-      end
+      def explicit_config_name?() ;  !explicit_config_name.nil?; end
 
       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
+        @env_prefix = if superclass < Anyway::Config && superclass.explicit_config_name?
+          superclass.env_prefix
+        else
+          config_name.upcase
+        end
       end
 
-      def new_empty_config
-        {}
-      end
+      def new_empty_config() ;  {}; end
 
       private
 
@@ -213,7 +200,7 @@ module Anyway # :nodoc:
         names.each do |name|
           accessors_module.module_eval <<~RUBY, __FILE__, __LINE__ + 1
             def #{name}=(val)
-              __trace__&.record_value(val, \"#{name}\", Tracing.current_trace_source)
+              __trace__&.record_value(val, \"#{name}\", **Tracing.current_trace_source)
               # DEPRECATED: instance variable set will be removed in 2.1
               @#{name} = values[:#{name}] = val
             end
@@ -339,13 +326,9 @@ module Anyway # :nodoc:
       base_config
     end
 
-    def dig(*keys)
-      values.dig(*keys)
-    end
+    def dig(*keys) ;  values.dig(*keys); end
 
-    def to_h
-      values.deep_dup.deep_freeze
-    end
+    def to_h() ;  values.deep_dup.deep_freeze; end
 
     def dup
       self.class.allocate.tap do |new_config|
@@ -360,13 +343,9 @@ module Anyway # :nodoc:
       Anyway.env.fetch(env_prefix).delete("conf") || Settings.default_config_path.call(name)
     end
 
-    def deconstruct_keys(keys)
-      values.deconstruct_keys(keys)
-    end
+    def deconstruct_keys(keys) ;  values.deconstruct_keys(keys); end
 
-    def to_source_trace
-      __trace__&.to_h
-    end
+    def to_source_trace() ;  __trace__&.to_h; end
 
     def inspect
       "#<#{self.class}:0x#{vm_object_id.rjust(16, "0")} config_name=\"#{config_name}\" env_prefix=\"#{env_prefix}\" " \

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

@@ -13,9 +13,7 @@ module Anyway
       end
 
       refine Thread::Backtrace::Location do
-        def path_lineno
-          "#{path}:#{lineno}"
-        end
+        def path_lineno() ;  "#{path}:#{lineno}"; end
       end
     end)
 
@@ -34,13 +32,14 @@ module Anyway
         value.dig(*__rest__, &__block__)
       end
 
-      def record_value(val, *path, key, **opts)
-        trace =
-          if val.is_a?(Hash)
-            Trace.new.tap { |_1| _1.merge_values(val, **opts) }
-          else
-            Trace.new(:value, val, **opts)
-          end
+      def record_value(val, *path, **opts)
+        key = path.pop
+        trace = if val.is_a?(Hash)
+          Trace.new.tap { |_1| _1.merge_values(val, **opts) }
+        else
+          Trace.new(:value, val, **opts)
+        end
+
         target_trace = path.empty? ? self : value.dig(*path)
         target_trace.value[key.to_s] = trace
 
@@ -79,13 +78,9 @@ module Anyway
         value.keep_if(*__rest__, &__block__)
       end
 
-      def clear
-        value.clear
-      end
+      def clear() ;  value.clear; end
 
-      def trace?
-        type == :trace
-      end
+      def trace?() ;  type == :trace; end
 
       def to_h
         if trace?
@@ -95,9 +90,7 @@ module Anyway
         end
       end
 
-      def dup
-        self.class.new(type, value.dup, source)
-      end
+      def dup() ;  self.class.new(type, value.dup, **source); end
 
       def pretty_print(q)
         if trace?
@@ -146,9 +139,7 @@ module Anyway
         (Thread.current[:__anyway__trace_stack__] ||= [])
       end
 
-      def current_trace
-        trace_stack.last
-      end
+      def current_trace() ;  trace_stack.last; end
 
       alias tracing? current_trace
 
@@ -178,12 +169,11 @@ module Anyway
 
     def trace!(type, *path, **opts)
       return yield unless Tracing.tracing?
-      source = {type: type}.merge(opts)
       val = yield
       if val.is_a?(Hash)
-        Tracing.current_trace.merge_values(val, **source)
+        Tracing.current_trace.merge_values(val, type: type, **opts)
       else
-        Tracing.current_trace.record_value(val, *path, **source)
+        Tracing.current_trace.record_value(val, *path, type: type, **opts)
       end
       val
     end

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

@@ -0,0 +1,393 @@
+# 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
+  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
+      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
+    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_given? && !names.empty?
+
+        if block_given?
+          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?; end
+
+      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() ;  {}; 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
+            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 }
+
+        load_from_sources(
+          base_config,
+          name: config_name,
+          env_prefix: env_prefix,
+          config_path: resolve_config_path(config_name, env_prefix)
+        )
+
+        if overrides
+          Tracing.trace!(:load) { overrides }
+
+          base_config.deep_merge!(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)|
+        base_config.deep_merge!(loader.call(**options))
+      end
+      base_config
+    end
+
+    def dig(*keys) ;  values.dig(*keys); end
+
+    def to_h() ;  values.deep_dup.deep_freeze; end
+
+    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); end
+
+    def to_source_trace() ;  __trace__&.to_h; end
+
+    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