anyway_config 2.4.0 → 2.4.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 44a860f50ae339b170da1a4ea99a7c6125b8ddcf2e25269c7341150bb8b8cf1f
-  data.tar.gz: f39c3ff413a1f334ad85a8f3eb0dfabca16dfc0c18c7f8719236607a777f947d
+  metadata.gz: dd660b7594fd85e041d4f00a4abbadef72085256e250df638cd239a3512db58c
+  data.tar.gz: 94fa4463eaf4bf2d64cddba05ba1fac18e635f62ff89620f8a460c9cf0162535
 SHA512:
-  metadata.gz: 6b903f239c176e8c031fdea2d81f9d6d46d0657c2b5525f7e36fed495ab2410dc017bbe676fdc8c633d6b303c619e5caeb109d8c172d172720bfb3417746c612
-  data.tar.gz: 7bbb6db11016ce9c9473009c49aa676e3121ab921a2493ceb6d8e0e270cf75369935678bb1a2e5f69ebe387be1d5a44d159df819dcfab4a591aa67bab2e757fa
+  metadata.gz: a1585d343611b50d1ca021dfbd2dfb49f92b8aad835c7f3c48aabeab4d5cc905877db4ef57a86e51b59c53f9b1192f69c7b58af4ec6c1b182447b146e19b4a3b
+  data.tar.gz: 983a3079303037e6cda97057ad51ef2479000baa1e975d481a7c2f4cd2510605fd36227d3692b1a82f7a85db333a7909e5610515286e1c10adc0aeb0e11f3006

data/CHANGELOG.md

@@ -2,9 +2,15 @@
 
 ## 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)
 
-- Add `Confi#as_env` to convert config into a ENV-like HASH. ([@tagirahmad][])
+- Added `Confi#as_env` to convert config into a ENV-like Hash. ([@tagirahmad][])
 
 - Added experimental support for sub-configs via coercion. ([@palkan][])
 
@@ -517,3 +523,4 @@ No we're dependency-free!
 [@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

@@ -544,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):
@@ -790,6 +792,18 @@ To debug any problems with loading configurations from `.ejson` files you can di
 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):
@@ -810,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.7/anyway/config.rb

@@ -199,6 +199,18 @@ 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)
@@ -343,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 }

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

@@ -199,6 +199,18 @@ 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)
@@ -343,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 }

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

@@ -199,6 +199,18 @@ 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() = {}
 
       def coerce_types(mapping)
@@ -343,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 }

data/lib/anyway/config.rb

@@ -199,6 +199,18 @@ 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() = {}
 
       def coerce_types(mapping)
@@ -343,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:, config_path:)
+        load_from_sources(
+          base_config,
+          name: config_name,
+          env_prefix:,
+          config_path:,
+          **self.class.loader_options
+        )
 
         if overrides
           Tracing.trace!(:load) { overrides }

data/lib/anyway/loaders/ejson.rb

@@ -11,7 +11,7 @@ module Anyway
 
       self.bin_path = "ejson"
 
-      def call(name:, ejson_parser: Anyway::EJSONParser.new(EJSON.bin_path), **_options)
+      def call(name:, ejson_namespace: name, ejson_parser: Anyway::EJSONParser.new(EJSON.bin_path), **_options)
         configs = []
 
         rel_config_paths.each do |rel_config_path|
@@ -23,7 +23,11 @@ module Anyway
 
           next unless secrets_hash
 
-          config_hash = secrets_hash[name]
+          config_hash = if ejson_namespace
+            secrets_hash[ejson_namespace]
+          else
+            secrets_hash.except("_public_key")
+          end
 
           next unless config_hash.is_a?(Hash)
 

data/lib/anyway/rails/settings.rb

@@ -11,9 +11,10 @@ module Anyway
   class Settings
     class << self
       attr_reader :autoload_static_config_path, :autoloader
+      attr_writer :autoload_via_zeitwerk
 
-      if defined?(::Zeitwerk)
-        def autoload_static_config_path=(val)
+      def autoload_static_config_path=(val)
+        if autoload_via_zeitwerk
           raise "Cannot setup autoloader after application has been initialized" if ::Rails.application.initialized?
 
           return unless ::Rails.root.join(val).exist?
@@ -28,18 +29,16 @@ module Anyway
           # and Rails 7 https://github.com/rails/rails/blob/5462fbd5de1900c1b1ce1c9dc11c1a2d8cdcd809/railties/lib/rails/autoloaders.rb#L15
           @autoloader = Zeitwerk::Loader.new.tap do |loader|
             loader.tag = "anyway.config"
-            loader.inflector = defined?(ActiveSupport::Dependencies::ZeitwerkIntegration::Inflector) ? ActiveSupport::Dependencies::ZeitwerkIntegration::Inflector : ::Rails::Autoloaders::Inflector
+
+            if defined?(ActiveSupport::Dependencies::ZeitwerkIntegration::Inflector)
+              loader.inflector = ActiveSupport::Dependencies::ZeitwerkIntegration::Inflector
+            elsif defined?(::Rails::Autoloaders::Inflector)
+              loader.inflector = ::Rails::Autoloaders::Inflector
+            end
             loader.push_dir(::Rails.root.join(val))
             loader.setup
           end
-        end
-
-        def cleanup_autoload_paths
-          return unless autoload_static_config_path
-          ActiveSupport::Dependencies.autoload_paths.delete(::Rails.root.join(autoload_static_config_path).to_s)
-        end
-      else
-        def autoload_static_config_path=(val)
+        else
           if autoload_static_config_path
             old_path = ::Rails.root.join(autoload_static_config_path).to_s
             ActiveSupport::Dependencies.autoload_paths.delete(old_path)
@@ -51,10 +50,19 @@ module Anyway
           ActiveSupport::Dependencies.autoload_paths << new_path
           ::Rails.application.config.eager_load_paths << new_path
         end
+      end
 
-        def cleanup_autoload_paths
-          :no_op
-        end
+      def cleanup_autoload_paths
+        return unless autoload_via_zeitwerk
+
+        return unless autoload_static_config_path
+        ActiveSupport::Dependencies.autoload_paths.delete(::Rails.root.join(autoload_static_config_path).to_s)
+      end
+
+      def autoload_via_zeitwerk
+        return @autoload_via_zeitwerk if instance_variable_defined?(:@autoload_via_zeitwerk)
+
+        @autoload_via_zeitwerk = defined?(::Zeitwerk)
       end
 
       def current_environment

data/lib/anyway/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Anyway # :nodoc:
-  VERSION = "2.4.0"
+  VERSION = "2.4.1"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: anyway_config
 version: !ruby/object:Gem::Version
-  version: 2.4.0
+  version: 2.4.1
 platform: ruby
 authors:
 - Vladimir Dementyev
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-04-05 00:00:00.000000000 Z
+date: 2023-05-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: ruby-next-core