anyway_config 2.3.1 → 2.4.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0a5f209fc2143bc50d22a63e991a97c5cc70f29cf9a04df1910831699e186042
-  data.tar.gz: 43feb4ea48737e139022c848d6a4367fe6947ea24d3fc37c22292bd6b80c63c7
+  metadata.gz: dd660b7594fd85e041d4f00a4abbadef72085256e250df638cd239a3512db58c
+  data.tar.gz: 94fa4463eaf4bf2d64cddba05ba1fac18e635f62ff89620f8a460c9cf0162535
 SHA512:
-  metadata.gz: a89d3edcace073fdb144022fbaf31626a4131d4beb7164bc2bb13dd9e78b9cfb8dba9c007c9ca0b423b06319c9bd197b64c82033087cbfc3fbd375a41a02baf4
-  data.tar.gz: 035dd8e51f7a6e5fe02a03912bb147fb9de3e9a84525925a87e36451c97a71238639c2f0e60b94ddffddd203be50808ca11264be2dea9b43759676f9003cc0bd
+  metadata.gz: a1585d343611b50d1ca021dfbd2dfb49f92b8aad835c7f3c48aabeab4d5cc905877db4ef57a86e51b59c53f9b1192f69c7b58af4ec6c1b182447b146e19b4a3b
+  data.tar.gz: 983a3079303037e6cda97057ad51ef2479000baa1e975d481a7c2f4cd2510605fd36227d3692b1a82f7a85db333a7909e5610515286e1c10adc0aeb0e11f3006

data/CHANGELOG.md

@@ -2,6 +2,57 @@
 
 ## master
 
+## 2.4.1 (2023-05-04)
+
+- Add custom namespace support via `ejson_namespace` ([@bessey])
+
+- Add arbitrary custom loader options support via `loader_options` ([@bessey])
+
+## 2.4.0 (2023-04-04)
+
+- Added `Confi#as_env` to convert config into a ENV-like Hash. ([@tagirahmad][])
+
+- Added experimental support for sub-configs via coercion. ([@palkan][])
+
+```ruby
+class AnotherConfig < Anyway::Config
+  attr_config foo: "bar"
+end
+
+class MyConfig < Anyway::Config
+  attr_config :another_config
+
+  coerce_types another_config: "AnotherConfig"
+end
+
+MyConfig.new.another_config.foo #=> "bar"
+
+ENV["MY_ANOTHER_CONFIG__FOO"] = "baz"
+MyConfig.new.another_config.foo #=> "baz"
+```
+
+- Define predicate methods when `:boolean` type is specified for the attribute. ([@palkan][])
+
+- Add support for nested required config attributes. ([@palkan][])
+
+The API is inspired by Rails permitted params:
+
+```ruby
+class AppConfig < Anyway::Config
+  attr_config :assets_host, database: {host: nil, port: nil}
+
+  required :assets_host, database: [:host, :port]
+end
+```
+
+- Add support for using `env_prefix ""` to load from unprefixed env vars. ([@palkan][])
+
+See [#118](https://github.com/palkan/anyway_config/issues/118).
+
+- Added EJSON support. ([@inner-whisper])
+
+- Add Doppler loader. ([@prog-supdex][]).
+
 ## 2.3.1 (2023-01-17)
 
 - [Fixes [#110](https://github.com/palkan/anyway_config/issues/110)] Fix setting up autoloader for the same folder. ([@palkan][])
@@ -469,3 +520,7 @@ No we're dependency-free!
 [@progapandist]: https://github.com/progapandist
 [@skryukov]: https://github.com/skryukov
 [@fargelus]: https://github.com/fargelus
+[@prog-supdex]: https://github.com/prog-supdex
+[@inner-whisper]: https://github.com/inner-whisper
+[@tagirahmad]: https://github.com/tagirahmad
+[@bessey]: https://github.com/bessey

data/README.md

@@ -45,6 +45,9 @@ For version 1.x see the [1-4-stable branch](https://github.com/palkan/anyway_con
 - [Type coercion](#type-coercion)
 - [Local configuration](#local-files)
 - [Data loaders](#data-loaders)
+  - [Doppler integration](#doppler-integration)
+  - [EJSON support](#ejson-support)
+  - [Custom loaders](#custom-loaders)
 - [Source tracing](#tracing)
 - [Pattern matching](#pattern-matching)
 - [Test helpers](#test-helpers)
@@ -269,7 +272,7 @@ This feature is similar to `Rails.application.config_for` but more powerful:
 | Load data from `secrets` | ❌ | ✅ |
 | Load data from `credentials` | ❌ | ✅ |
 | Load data from environment | ❌ | ✅ |
-| Load data from [custom sources](#data-loaders) | ❌ | ✅ |
+| Load data from [other sources](#data-loaders) | ❌ | ✅ |
 | Local config files | ❌ | ✅ |
 | Type coercion | ❌ | ✅ |
 | [Source tracing](#tracing) | ❌ | ✅ |
@@ -541,6 +544,8 @@ Would you like to generate a heroku.yml file? (Y/n) n
 You can also specify the `--app` option to put the newly created class into `app/configs` folder.
 Alternatively, you can call `rails g anyway:app_config name param1 param2 ...`.
 
+**NOTE:** The generated `ApplicationConfig` class uses a singleton pattern along with `delegate_missing_to` to re-use the same instance across the application. However, the delegation can lead to unexpected behaviour and break Anyway Config internals if you have attributes named as `Anyway::Config` class methods. See [#120](https://github.com/palkan/anyway_config/issues/120).
+
 ## Using with Ruby
 
 The default data loading mechanism for non-Rails applications is the following (ordered by priority from low to high):
@@ -733,6 +738,74 @@ Don't forget to add `*.local.yml` (and `config/credentials/local.*`) to your `.g
 
 ## Data loaders
 
+### Doppler integration
+
+Anyway Config can pull configuration data from [Doppler](https://www.doppler.com/). All you need is to specify the `DOPPLER_TOKEN` environment variable with the **service token**, associated with the specific content (read more about [service tokens](https://docs.doppler.com/docs/service-tokens)).
+
+You can also configure Doppler loader manually if needed:
+
+```ruby
+# Add loader
+Anyway.loaders.append :Doppler, Anyway::Loaders::Doppler
+
+# Configure API URL and token (defaults are shown)
+Anyway::Loaders::Doppler.download_url = "https://api.doppler.com/v3/configs/config/secrets/download"
+Anyway::Loaders::Doppler.token = ENV["DOPPLER_TOKEN"]
+```
+
+**NOTE:** You can opt-out from Doppler loader by specifying the`ANYWAY_CONFIG_DISABLE_DOPPLER=true` env var (in case you have the `DOPPLER_TOKEN` env var, but don't want to use it with Anyway Config).
+
+### EJSON support
+
+Anyway Config allows you to keep your configuration also in encrypted `.ejson` files. More information
+about EJSON format you can read [here](https://github.com/Shopify/ejson).
+
+Configuration will be loaded only if you have `ejson` executable in your PATH. Easiest way to do this - install `ejson` as a gem into project:
+
+```ruby
+# Gemfile
+gem "ejson"
+```
+
+Loading order of configuration is next:
+
+- `config/secrets.local.ejson` (see [Local files](#local-files) for more information)
+- `config/<environment>/secrets.ejson` (if you have any multi-environment setup, e.g Rails environments)
+- `config/secrets.ejson`
+
+Example of `config/secrets.ejson` file content for your `MyConfig`:
+
+```json
+{
+  "_public_key": "0843d33f0eee994adc66b939fe4ef569e4c97db84e238ff581934ee599e19d1a",
+  "my":
+    {
+      "_username": "root",
+      "password": "EJ[1:IC1d347GkxLXdZ0KrjGaY+ljlsK1BmK7CobFt6iOLgE=:Z55OYS1+On0xEBvxUaIOdv/mE2r6lp44:T7bE5hkAbazBnnH6M8bfVcv8TOQJAgUDQffEgw==]"
+    }
+}
+```
+
+To debug any problems with loading configurations from `.ejson` files you can directly call `ejson decrypt`:
+
+```sh
+ejson decrypt config/secrets.ejson
+```
+
+You can customize the JSON namespace under which a loader searches for configuration via `loader_options`:
+
+```ruby
+class MyConfig < Anyway::Config
+  # To look under the key "foo" instead of the default key of "my"
+  loader_options ejson_namespace: "foo"
+
+  # Or to disable namespacing entirely, and instead search in the root object
+  loader_options ejson_namespace: false
+end
+```
+
+### Custom loaders
+
 You can provide your own data loaders or change the existing ones using the Loaders API (which is very similar to Rack middleware builder):
 
 ```ruby
@@ -751,7 +824,8 @@ def call(
   name:, # config name
   env_prefix:, # prefix for env vars if any
   config_path:, # path to YML config
-  local: # true|false, whether to load local configuration
+  local:, # true|false, whether to load local configuration
+  **options # custom options can be passed via Anyway::Config.loader_options example: "custom", option: "blah"
 )
   #=> must return Hash with configuration data
 end

data/lib/.rbnext/2.6/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..-1]
+        else
+          key
+        end
+      end
+    end
+  end
+end

data/lib/.rbnext/2.7/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
-
-      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
+        return unless Settings.matching_env?(env)
 
-      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
@@ -219,10 +199,28 @@ module Anyway # :nodoc:
         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() ;  {}; end
 
       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 +266,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
 
@@ -357,7 +355,13 @@ module Anyway # :nodoc:
 
         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)
+        load_from_sources(
+          base_config,
+          name: config_name,
+          env_prefix: env_prefix,
+          config_path: config_path,
+          **self.class.loader_options
+        )
 
         if overrides
           Tracing.trace!(:load) { overrides }
@@ -430,13 +434,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/2.7/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)

data/lib/.rbnext/2.7/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(*__rest__, &__block__)
@@ -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/.rbnext/2.7/anyway/type_casting.rb

@@ -90,6 +90,11 @@ module Anyway
     end
   end
 
+  unless "".respond_to?(:safe_constantize)
+    require "anyway/ext/string_constantize"
+    using Anyway::Ext::StringConstantize
+  end
+
   # TypeCaster is an object responsible for type-casting.
   # It uses a provided types registry and mapping, and also
   # accepts a fallback typecaster.
@@ -109,8 +114,16 @@ module Anyway
       return fallback.coerce(key, val) unless caster_config
 
       case; when ((__m__ = caster_config)) && false 
-      when (((array, type) = nil) || ((__m__.respond_to?(:deconstruct_keys) && (((__m_hash__src__ = __m__.deconstruct_keys(nil)) || true) && (Hash === __m_hash__src__ || Kernel.raise(TypeError, "#deconstruct_keys must return Hash"))) && (__m_hash__ = __m_hash__src__.dup)) && ((__m_hash__.key?(:array) && __m_hash__.key?(:type)) && (((array = __m_hash__.delete(:array)) || true) && (((type = __m_hash__.delete(:type)) || true) && __m_hash__.empty?)))))
+      when (((array, type) = nil) || ((Hash === __m__) && ((__m__.respond_to?(:deconstruct_keys) && (((__m_hash__src__ = __m__.deconstruct_keys(nil)) || true) && (Hash === __m_hash__src__ || Kernel.raise(TypeError, "#deconstruct_keys must return Hash"))) && (__m_hash__ = __m_hash__src__.dup)) && ((__m_hash__.key?(:array) && __m_hash__.key?(:type)) && (((array = __m_hash__.delete(:array)) || true) && (((type = __m_hash__.delete(:type)) || true) && __m_hash__.empty?))))))
         registry.deserialize(val, type, array: array)
+      when (((subconfig,) = nil) || ((Hash === __m__) && (__m__.respond_to?(:deconstruct_keys) && (((__m_hash__ = __m__.deconstruct_keys([:config])) || true) && (Hash === __m_hash__ || Kernel.raise(TypeError, "#deconstruct_keys must return Hash"))) && (__m_hash__.key?(:config) && ((subconfig = __m_hash__[:config]) || true)))))
+
+
+
+        subconfig = subconfig.safe_constantize if subconfig.is_a?(::String)
+        raise ArgumentError, "Config is not found: #{subconfig}" unless subconfig
+
+        subconfig.new(val)
       when (Hash === __m__)
 
 

data/lib/.rbnext/3.0/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
-
-      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
+        return unless Settings.matching_env?(env)
 
-      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
@@ -219,10 +199,28 @@ module Anyway # :nodoc:
         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() ;  {}; end
 
       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 +266,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
 
@@ -357,7 +355,13 @@ module Anyway # :nodoc:
 
         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)
+        load_from_sources(
+          base_config,
+          name: config_name,
+          env_prefix: env_prefix,
+          config_path: config_path,
+          **self.class.loader_options
+        )
 
         if overrides
           Tracing.trace!(:load) { overrides }
@@ -430,13 +434,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.0/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/.rbnext/3.0/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?