anyway_config 2.4.0 → 2.4.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 44a860f50ae339b170da1a4ea99a7c6125b8ddcf2e25269c7341150bb8b8cf1f
-  data.tar.gz: f39c3ff413a1f334ad85a8f3eb0dfabca16dfc0c18c7f8719236607a777f947d
+  metadata.gz: 822e17fb52f85c3f3066322083d1d2d30265bb58fbce6f50e88590ebea140ba4
+  data.tar.gz: c3cfd97af9fe5de290b8a378517b3f11a7a020e550929c7e3765e34411988246
 SHA512:
-  metadata.gz: 6b903f239c176e8c031fdea2d81f9d6d46d0657c2b5525f7e36fed495ab2410dc017bbe676fdc8c633d6b303c619e5caeb109d8c172d172720bfb3417746c612
-  data.tar.gz: 7bbb6db11016ce9c9473009c49aa676e3121ab921a2493ceb6d8e0e270cf75369935678bb1a2e5f69ebe387be1d5a44d159df819dcfab4a591aa67bab2e757fa
+  metadata.gz: 8fabe569de72f9a65d22a4a69a8b2b4cad0d97ef2dc62f245133352b142402ec2eb2b6f9492c713aceaac6518ca1453e1527855e6eaf5b4adb12ec0b2c2c1b50
+  data.tar.gz: 2fe2eef92329925f2626a501bd34c0081170e507f30214b9199710e509f208b0f3df7bfda163b304304e1fda58c8b4f757f527e748afd21708514877e4a1765c

data/CHANGELOG.md

@@ -2,9 +2,21 @@
 
 ## master
 
+## 2.4.2 (2023-06-07)
+
+- Use ANYWAY_ENV as the current environment if defined. ([@palkan][])
+
+It can be used to specify environment for configs independently of Rails environment.
+
+## 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 +529,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

@@ -367,6 +367,8 @@ development:
   port: 3000
 ```
 
+**NOTE:** You can override the environment name for configuration files via the `ANYWAY_ENV` environment variable or by setting it explicitly in the code: `Anyway::Settings.current_environment = "some_other_env"`.
+
 ### Multi-env configuration
 
 _⚡️ This feature will be turned on by default in the future releases. You can turn it on now via `config.anyway_config.future.use :unwrap_known_environments`._
@@ -544,6 +546,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):
@@ -557,6 +561,8 @@ If you want to enable this feature you must specify `Anyway::Settings.current_en
 Anyway::Settings.current_environment = "development"
 ```
 
+You can also specify the `ANYWAY_ENV=development` environment variable to set the current environment for configuration.
+
 YAML files should be in this format:
 
 ```yml
@@ -790,6 +796,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 +828,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/2.7/anyway/settings.rb

@@ -96,8 +96,11 @@ module Anyway
       end
     end
 
+    # By default, use ANYWAY_ENV
+    self.current_environment = ENV["ANYWAY_ENV"]
+
     # By default, use local files only in development (that's the purpose if the local files)
-    self.use_local_files = (ENV["RACK_ENV"] == "development" || ENV["RAILS_ENV"] == "development")
+    self.use_local_files = (ENV["ANYWAY_ENV"] == "development" || ENV["RACK_ENV"] == "development" || ENV["RAILS_ENV"] == "development")
 
     # By default, consider configs are stored in the ./config folder
     self.default_config_path = ->(name) { "./config/#{name}.yml" }

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,14 +50,23 @@ 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
-        ::Rails.env.to_s
+        @current_environment || ::Rails.env.to_s
       end
 
       def app_root
@@ -68,6 +76,7 @@ module Anyway
 
     self.default_config_path = ->(name) { ::Rails.root.join("config", "#{name}.yml") }
     self.known_environments = %w[test development production]
+    self.use_local_files ||= ::Rails.env.development?
     # Don't try read defaults when no key defined
     self.default_environmental_key = nil
   end

data/lib/anyway/settings.rb

@@ -96,8 +96,11 @@ module Anyway
       end
     end
 
+    # By default, use ANYWAY_ENV
+    self.current_environment = ENV["ANYWAY_ENV"]
+
     # By default, use local files only in development (that's the purpose if the local files)
-    self.use_local_files = (ENV["RACK_ENV"] == "development" || ENV["RAILS_ENV"] == "development")
+    self.use_local_files = (ENV["ANYWAY_ENV"] == "development" || ENV["RACK_ENV"] == "development" || ENV["RAILS_ENV"] == "development")
 
     # By default, consider configs are stored in the ./config folder
     self.default_config_path = ->(name) { "./config/#{name}.yml" }

data/lib/anyway/testing.rb

@@ -2,7 +2,7 @@
 
 require "anyway/testing/helpers"
 
-if defined?(RSpec::Core)
+if defined?(RSpec::Core) && RSpec.respond_to?(:configure)
   RSpec.configure do |config|
     config.include(
       Anyway::Testing::Helpers,

data/lib/anyway/version.rb

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

data/sig/manifest.yml

@@ -4,4 +4,3 @@ dependencies:
   - name: pathname
   - name: date
   - name: time
-  - name: set

metadata

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