anyway_config 2.3.0 → 2.4.0

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

@@ -8,6 +8,7 @@ module Anyway # :nodoc:
   using Anyway::Ext::DeepDup
   using Anyway::Ext::DeepFreeze
   using Anyway::Ext::Hash
+  using Anyway::Ext::FlattenNames
 
   using(Module.new do
     refine Object do
@@ -26,6 +27,7 @@ module Anyway # :nodoc:
     RESERVED_NAMES = %i[
       config_name
       env_prefix
+      as_env
       values
       class
       clear
@@ -47,8 +49,6 @@ module Anyway # :nodoc:
       __type_caster__
     ].freeze
 
-    ENV_OPTION_EXCLUDE_KEY = :except
-
     class Error < StandardError; end
 
     class ValidationError < Error; end
@@ -128,34 +128,14 @@ module Anyway # :nodoc:
         end
       end
 
-      def required(*names, env: nil)
-        unknown_names = names - config_attributes
+      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?
 
-        names = filter_by_env(names, env)
-        required_attributes.push(*names)
-      end
+        return unless Settings.matching_env?(env)
 
-      def filter_by_env(names, env)
-        return names if env.nil? || env.to_s == current_env
-
-        filtered_names = if env.is_a?(Hash)
-          names_with_exclude_env_option(names, env)
-        elsif env.is_a?(Array)
-          names if env.flat_map(&:to_s).include?(current_env)
-        end
-
-        filtered_names || []
-      end
-
-      def current_env
-        Settings.current_environment.to_s
-      end
-
-      def names_with_exclude_env_option(names, env)
-        envs = env[ENV_OPTION_EXCLUDE_KEY]
-        excluded_envs = [envs].flat_map(&:to_s)
-        names if excluded_envs.none?(current_env)
+        required_attributes.push(*names)
+        required_attributes.push(*nested.flatten_names)
       end
 
       def required_attributes
@@ -223,6 +203,12 @@ module Anyway # :nodoc:
 
       def coerce_types(mapping)
         Utils.deep_merge!(coercion_mapping, mapping)
+
+        mapping.each do |key, val|
+          next unless val == :boolean || (val.is_a?(::Hash) && val[:type] == :boolean)
+
+          alias_method :"#{key}?", :"#{key}"
+        end
       end
 
       def coercion_mapping
@@ -268,7 +254,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)
               values[:#{name}] = val
             end
 
@@ -297,7 +283,7 @@ module Anyway # :nodoc:
         # - SomeModule::Config => "some_module"
         # - SomeConfig => "some"
         unless name =~ /^(\w+)(::)?Config$/
-          raise "Couldn't infer config name, please, specify it explicitly" \
+          raise "Couldn't infer config name, please, specify it explicitly " \
             "via `config_name :my_config`"
         end
 
@@ -430,13 +416,18 @@ module Anyway # :nodoc:
       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|
-        values[name].nil? || (values[name].is_a?(String) && values[name].empty?)
+        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(", ")}"

data/lib/.rbnext/3.1/anyway/env.rb

@@ -8,14 +8,31 @@ module Anyway
     using Anyway::Ext::DeepDup
     using Anyway::Ext::Hash
 
+    class << self
+      def from_hash(hash, prefix: nil, memo: {})
+        hash.each do |key, value|
+          prefix_with_key = (prefix && !prefix.empty?) ? "#{prefix}_#{key.to_s.upcase}" : key.to_s.upcase
+
+          if value.is_a?(Hash)
+            from_hash(value, prefix: "#{prefix_with_key}_", memo: memo)
+          else
+            memo[prefix_with_key] = value.to_s
+          end
+        end
+
+        memo
+      end
+    end
+
     include Tracing
 
-    attr_reader :data, :traces, :type_cast
+    attr_reader :data, :traces, :type_cast, :env_container
 
-    def initialize(type_cast: AutoCast)
+    def initialize(type_cast: AutoCast, env_container: ENV)
       @type_cast = type_cast
       @data = {}
       @traces = {}
+      @env_container = env_container
     end
 
     def clear
@@ -42,11 +59,11 @@ module Anyway
     private
 
     def parse_env(prefix)
-      match_prefix = "#{prefix}_"
-      ENV.each_pair.with_object({}) do |(key, val), data|
+      match_prefix = prefix.empty? ? prefix : "#{prefix}_"
+      env_container.each_pair.with_object({}) do |(key, val), data|
         next unless key.start_with?(match_prefix)
 
-        path = key.sub(/^#{prefix}_/, "").downcase
+        path = key.sub(/^#{match_prefix}/, "").downcase
 
         paths = path.split("__")
         trace!(:env, *paths, key: key) { data.bury(type_cast.call(val), *paths) }

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

@@ -19,7 +19,7 @@ module Anyway
       def initialize(type = :trace, value = UNDEF, **source)
         @type = type
         @source = source
-        @value = value == UNDEF ? Hash.new { |h, k| h[k] = Trace.new(:trace) } : value
+        @value = (value == UNDEF) ? Hash.new { |h, k| h[k] = Trace.new(:trace) } : value
       end
 
       def dig(...)
@@ -35,7 +35,7 @@ module Anyway
         end
 
         target_trace = path.empty? ? self : value.dig(*path)
-        target_trace.value[key.to_s] = trace
+        target_trace.record_key(key.to_s, trace)
 
         val
       end
@@ -54,6 +54,12 @@ module Anyway
         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?

data/lib/anyway/config.rb

@@ -8,6 +8,7 @@ module Anyway # :nodoc:
   using Anyway::Ext::DeepDup
   using Anyway::Ext::DeepFreeze
   using Anyway::Ext::Hash
+  using Anyway::Ext::FlattenNames
 
   using(Module.new do
     refine Object do
@@ -26,6 +27,7 @@ module Anyway # :nodoc:
     RESERVED_NAMES = %i[
       config_name
       env_prefix
+      as_env
       values
       class
       clear
@@ -47,8 +49,6 @@ module Anyway # :nodoc:
       __type_caster__
     ].freeze
 
-    ENV_OPTION_EXCLUDE_KEY = :except
-
     class Error < StandardError; end
 
     class ValidationError < Error; end
@@ -128,34 +128,14 @@ module Anyway # :nodoc:
         end
       end
 
-      def required(*names, env: nil)
-        unknown_names = names - config_attributes
+      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?
 
-        names = filter_by_env(names, env)
-        required_attributes.push(*names)
-      end
+        return unless Settings.matching_env?(env)
 
-      def filter_by_env(names, env)
-        return names if env.nil? || env.to_s == current_env
-
-        filtered_names = if env.is_a?(Hash)
-          names_with_exclude_env_option(names, env)
-        elsif env.is_a?(Array)
-          names if env.flat_map(&:to_s).include?(current_env)
-        end
-
-        filtered_names || []
-      end
-
-      def current_env
-        Settings.current_environment.to_s
-      end
-
-      def names_with_exclude_env_option(names, env)
-        envs = env[ENV_OPTION_EXCLUDE_KEY]
-        excluded_envs = [envs].flat_map(&:to_s)
-        names if excluded_envs.none?(current_env)
+        required_attributes.push(*names)
+        required_attributes.push(*nested.flatten_names)
       end
 
       def required_attributes
@@ -223,6 +203,12 @@ module Anyway # :nodoc:
 
       def coerce_types(mapping)
         Utils.deep_merge!(coercion_mapping, mapping)
+
+        mapping.each do |key, val|
+          next unless val == :boolean || (val.is_a?(::Hash) && val[:type] == :boolean)
+
+          alias_method :"#{key}?", :"#{key}"
+        end
       end
 
       def coercion_mapping
@@ -268,7 +254,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)
               values[:#{name}] = val
             end
 
@@ -297,7 +283,7 @@ module Anyway # :nodoc:
         # - SomeModule::Config => "some_module"
         # - SomeConfig => "some"
         unless name =~ /^(\w+)(::)?Config$/
-          raise "Couldn't infer config name, please, specify it explicitly" \
+          raise "Couldn't infer config name, please, specify it explicitly " \
             "via `config_name :my_config`"
         end
 
@@ -430,13 +416,18 @@ module Anyway # :nodoc:
       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|
-        values[name].nil? || (values[name].is_a?(String) && values[name].empty?)
+        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(", ")}"

data/lib/anyway/ejson_parser.rb

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+
+require "open3"
+require "anyway/ext/hash"
+
+using Anyway::Ext::Hash
+
+module Anyway
+  class EJSONParser
+    attr_reader :bin_path
+
+    def initialize(bin_path = "ejson")
+      @bin_path = bin_path
+    end
+
+    def call(file_path)
+      return unless File.exist?(file_path)
+
+      raw_content = nil
+
+      stdout, stderr, status = Open3.capture3("#{bin_path} decrypt #{file_path}")
+
+      if status.success?
+        raw_content = JSON.parse(stdout.chomp)
+      else
+        Kernel.warn "Failed to decrypt #{file_path}: #{stderr}"
+      end
+
+      return unless raw_content
+
+      raw_content.deep_transform_keys do |key|
+        if key[0] == "_"
+          key[1..]
+        else
+          key
+        end
+      end
+    end
+  end
+end

data/lib/anyway/env.rb

@@ -8,14 +8,31 @@ module Anyway
     using Anyway::Ext::DeepDup
     using Anyway::Ext::Hash
 
+    class << self
+      def from_hash(hash, prefix: nil, memo: {})
+        hash.each do |key, value|
+          prefix_with_key = (prefix && !prefix.empty?) ? "#{prefix}_#{key.to_s.upcase}" : key.to_s.upcase
+
+          if value.is_a?(Hash)
+            from_hash(value, prefix: "#{prefix_with_key}_", memo:)
+          else
+            memo[prefix_with_key] = value.to_s
+          end
+        end
+
+        memo
+      end
+    end
+
     include Tracing
 
-    attr_reader :data, :traces, :type_cast
+    attr_reader :data, :traces, :type_cast, :env_container
 
-    def initialize(type_cast: AutoCast)
+    def initialize(type_cast: AutoCast, env_container: ENV)
       @type_cast = type_cast
       @data = {}
       @traces = {}
+      @env_container = env_container
     end
 
     def clear
@@ -42,11 +59,11 @@ module Anyway
     private
 
     def parse_env(prefix)
-      match_prefix = "#{prefix}_"
-      ENV.each_pair.with_object({}) do |(key, val), data|
+      match_prefix = prefix.empty? ? prefix : "#{prefix}_"
+      env_container.each_pair.with_object({}) do |(key, val), data|
         next unless key.start_with?(match_prefix)
 
-        path = key.sub(/^#{prefix}_/, "").downcase
+        path = key.sub(/^#{match_prefix}/, "").downcase
 
         paths = path.split("__")
         trace!(:env, *paths, key:) { data.bury(type_cast.call(val), *paths) }

data/lib/anyway/ext/flatten_names.rb

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+module Anyway
+  module Ext
+    # Convert Hash with mixed array and hash values to an
+    # array of paths.
+    module FlattenNames
+      refine ::Array do
+        def flatten_names(prefix, buf)
+          if empty?
+            buf << :"#{prefix}"
+            return buf
+          end
+
+          each_with_object(buf) do |name, acc|
+            if name.is_a?(::Symbol)
+              acc << :"#{prefix}.#{name}"
+            else
+              name.flatten_names(prefix, acc)
+            end
+          end
+        end
+      end
+
+      refine ::Hash do
+        def flatten_names(prefix = nil, buf = [])
+          each_with_object(buf) do |(k, v), acc|
+            parent = prefix ? "#{prefix}.#{k}" : k
+            v.flatten_names(parent, acc)
+          end
+        end
+      end
+
+      using self
+    end
+  end
+end

data/lib/anyway/ext/hash.rb

@@ -21,11 +21,18 @@ module Anyway
 
           last_key = path.pop
           hash = path.reduce(self) do |hash, k|
-            hash[k] = {} unless hash.key?(k)
+            hash[k] = {} unless hash.key?(k) && hash[k].is_a?(::Hash)
             hash[k]
           end
+
           hash[last_key] = val
         end
+
+        def deep_transform_keys(&block)
+          each_with_object({}) do |(key, value), result|
+            result[yield(key)] = value.is_a?(::Hash) ? value.deep_transform_keys(&block) : value
+          end
+        end
       end
 
       using self

data/lib/anyway/ext/string_constantize.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+module Anyway
+  module Ext
+    # Add simple safe_constantize method to String
+    module StringConstantize
+      refine String do
+        def safe_constantize
+          names = split("::")
+
+          return nil if names.empty?
+
+          # Remove the first blank element in case of '::ClassName' notation.
+          names.shift if names.size > 1 && names.first.empty?
+
+          names.inject(Object) do |constant, name|
+            break if constant.nil?
+            constant.const_get(name, false) if constant.const_defined?(name, false)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/anyway/loaders/doppler.rb

@@ -0,0 +1,63 @@
+# frozen_string_literal: true
+
+require "uri"
+require "net/http"
+require "json"
+
+module Anyway
+  using RubyNext
+
+  module Loaders
+    class Doppler < Base
+      class RequestError < StandardError; end
+
+      class << self
+        attr_accessor :download_url
+        attr_writer :token
+
+        def token
+          @token || ENV["DOPPLER_TOKEN"]
+        end
+      end
+
+      self.download_url = "https://api.doppler.com/v3/configs/config/secrets/download"
+
+      def call(env_prefix:, **_options)
+        env_payload = parse_doppler_response(url: Doppler.download_url, token: Doppler.token)
+
+        env = ::Anyway::Env.new(type_cast: ::Anyway::NoCast, env_container: env_payload)
+
+        env.fetch_with_trace(env_prefix).then do |(conf, trace)|
+          Tracing.current_trace&.merge!(trace)
+          conf
+        end
+      end
+
+      private
+
+      def parse_doppler_response(url:, token:)
+        response = fetch_doppler_config(url, token)
+
+        unless response.is_a?(Net::HTTPSuccess)
+          raise RequestError, "#{response.code} #{response.message}"
+        end
+
+        JSON.parse(response.read_body)
+      end
+
+      def fetch_doppler_config(url, token)
+        uri = URI.parse(url)
+        raise "Doppler token is required to load configuration from Doppler" if token.nil?
+
+        http = Net::HTTP.new(uri.host, uri.port)
+        http.use_ssl = true if uri.scheme == "https"
+
+        request = Net::HTTP::Get.new(uri)
+        request["Accept"] = "application/json"
+        request["Authorization"] = "Bearer #{token}"
+
+        http.request(request)
+      end
+    end
+  end
+end

data/lib/anyway/loaders/ejson.rb

@@ -0,0 +1,85 @@
+# frozen_string_literal: true
+
+require "anyway/ejson_parser"
+
+module Anyway
+  module Loaders
+    class EJSON < Base
+      class << self
+        attr_accessor :bin_path
+      end
+
+      self.bin_path = "ejson"
+
+      def call(name:, ejson_parser: Anyway::EJSONParser.new(EJSON.bin_path), **_options)
+        configs = []
+
+        rel_config_paths.each do |rel_config_path|
+          secrets_hash, rel_path =
+            extract_hash_from_rel_config_path(
+              ejson_parser: ejson_parser,
+              rel_config_path: rel_config_path
+            )
+
+          next unless secrets_hash
+
+          config_hash = secrets_hash[name]
+
+          next unless config_hash.is_a?(Hash)
+
+          configs <<
+            trace!(:ejson, path: rel_path) do
+              config_hash
+            end
+        end
+
+        return {} if configs.empty?
+
+        configs.inject do |result_config, next_config|
+          Utils.deep_merge!(result_config, next_config)
+        end
+      end
+
+      private
+
+      def rel_config_paths
+        chain = [environmental_rel_config_path]
+
+        chain << "secrets.local.ejson" if use_local?
+
+        chain
+      end
+
+      def environmental_rel_config_path
+        if Settings.current_environment
+          # if environment file is absent, then take data from the default one
+          [
+            "#{Settings.current_environment}/secrets.ejson",
+            default_rel_config_path
+          ]
+        else
+          default_rel_config_path
+        end
+      end
+
+      def default_rel_config_path
+        "secrets.ejson"
+      end
+
+      def extract_hash_from_rel_config_path(ejson_parser:, rel_config_path:)
+        rel_config_path = [rel_config_path] unless rel_config_path.is_a?(Array)
+
+        rel_config_path.each do |rel_conf_path|
+          rel_path = "config/#{rel_conf_path}"
+          abs_path = "#{Settings.app_root}/#{rel_path}"
+
+          result = ejson_parser.call(abs_path)
+
+          return [result, rel_path] if result
+        end
+
+        nil
+      end
+    end
+  end
+end

data/lib/anyway/loaders/yaml.rb

@@ -53,13 +53,13 @@ module Anyway
         # the interface when no config file is present.
         begin
           if defined?(ERB)
-            ::YAML.load(ERB.new(File.read(path)).result, aliases: true) || {} # rubocop:disable Security/YAMLLoad
+            ::YAML.load(ERB.new(File.read(path)).result, aliases: true) || {}
           else
             ::YAML.load_file(path, aliases: true) || {}
           end
         rescue ArgumentError
           if defined?(ERB)
-            ::YAML.load(ERB.new(File.read(path)).result) || {} # rubocop:disable Security/YAMLLoad
+            ::YAML.load(ERB.new(File.read(path)).result) || {}
           else
             ::YAML.load_file(path) || {}
           end

data/lib/anyway/loaders.rb

@@ -75,3 +75,5 @@ end
 require "anyway/loaders/base"
 require "anyway/loaders/yaml"
 require "anyway/loaders/env"
+require "anyway/loaders/doppler"
+require "anyway/loaders/ejson"

data/lib/anyway/rails/settings.rb

@@ -18,6 +18,8 @@ module Anyway
 
           return unless ::Rails.root.join(val).exist?
 
+          return if val == autoload_static_config_path
+
           autoloader&.unload
 
           @autoload_static_config_path = val

data/lib/anyway/settings.rb

@@ -80,6 +80,20 @@ module Anyway
       def default_environmental_key?
         !default_environmental_key.nil?
       end
+
+      def matching_env?(env)
+        return true if env.nil? || env.to_s == current_environment
+
+        if env.is_a?(::Hash)
+          envs = env[:except]
+          excluded_envs = [envs].flat_map(&:to_s)
+          excluded_envs.none?(current_environment)
+        elsif env.is_a?(::Array)
+          env.flat_map(&:to_s).include?(current_environment)
+        else
+          false
+        end
+      end
     end
 
     # By default, use local files only in development (that's the purpose if the local files)