anyway_config 2.4.1 → 2.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: dd660b7594fd85e041d4f00a4abbadef72085256e250df638cd239a3512db58c
-  data.tar.gz: 94fa4463eaf4bf2d64cddba05ba1fac18e635f62ff89620f8a460c9cf0162535
+  metadata.gz: 29fe2702743a353cb8d7d793d59278dea2cfef4075e17204181ffdab9b594274
+  data.tar.gz: dd34c9bf703b5b93b4e5c4a1cce3e9ede85af1666d5de484005e13f217d897bd
 SHA512:
-  metadata.gz: a1585d343611b50d1ca021dfbd2dfb49f92b8aad835c7f3c48aabeab4d5cc905877db4ef57a86e51b59c53f9b1192f69c7b58af4ec6c1b182447b146e19b4a3b
-  data.tar.gz: 983a3079303037e6cda97057ad51ef2479000baa1e975d481a7c2f4cd2510605fd36227d3692b1a82f7a85db333a7909e5610515286e1c10adc0aeb0e11f3006
+  metadata.gz: 3f1d05c31f97864f64b2ace127636d15535ed18c50f44f11e90949d784df40d437e48d9cd37a0bc2b8ccab0c5b17dd6a25062cbf25669f51e654fb1a5b356b2d
+  data.tar.gz: 6a7ceda8a770887e3775d5c75e6d8e5a6afa98f49851926d40d131c4ca0034f60b1739868d142029b35fe44b4bf39205e68d84fe97f65c89c146cbe74a4750aa

data/CHANGELOG.md

@@ -2,6 +2,20 @@
 
 ## master
 
+## 2.5.0 (2023-07-24)
+
+- Generators: Add `config_name` to generated classes if name contains underscore. ([@palkan][])
+
+- Load Rails extensions even if Rails was loaded after Anyway Config. ([@palkan][])
+
+- Fix handling `config.credentials.content_path` provided as String. ([@palkan][])
+
+## 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])

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`._
@@ -546,6 +548,14 @@ 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).
 
+### Loading Anyway Config before Rails
+
+Anyway Config activates Rails-specific features automatically on the gem load only if Rails has been already required (we check for the `Rails::VERSION` constant presence). However, in some cases you may want to use Anyway Config before Rails initialization (e.g., in `config/puma.rb` when starting a Puma web server).
+
+By default, Anyway Config sets up a hook (via TracePoint API) and waits for Rails to be loaded to require the Rails extensions (`require "anyway/rails"`). In case you load Rails after Anyway Config, you will see a warning telling you about that. Note that config classes loaded before Rails are not populated from Rails-specific data sources (e.g., credentials).
+
+You can disable the warning by setting `Anyway::Rails.disable_postponed_load_warning = true` in your application. Also, you can disable the _hook_ completely by calling `Anyway::Rails.tracer.disable`.
+
 ## Using with Ruby
 
 The default data loading mechanism for non-Rails applications is the following (ordered by priority from low to high):
@@ -559,6 +569,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

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

@@ -299,6 +299,7 @@ module Anyway # :nodoc:
             "via `config_name :my_config`"
         end
 
+        # TODO(v3.0): Replace downcase with underscore
         Regexp.last_match[1].tap(&:downcase!)
       end
 

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

@@ -44,7 +44,7 @@ module Anyway
             TYPE_TO_CLASS.fetch(type) { defaults[param] ? "Symbol" : "untyped" }
           when (Array === __m__)
             "Array[untyped]"
-          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 (((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)) && ((((type = __m_hash__.delete(:type)) || true) && __m_hash__.empty?)))))
             "Array[#{TYPE_TO_CLASS.fetch(type, "untyped")}]"
           when (Hash === __m__)
             "Hash[string,untyped]"

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

@@ -299,6 +299,7 @@ module Anyway # :nodoc:
             "via `config_name :my_config`"
         end
 
+        # TODO(v3.0): Replace downcase with underscore
         Regexp.last_match[1].tap(&:downcase!)
       end
 

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

@@ -299,6 +299,7 @@ module Anyway # :nodoc:
             "via `config_name :my_config`"
         end
 
+        # TODO(v3.0): Replace downcase with underscore
         Regexp.last_match[1].tap(&:downcase!)
       end
 

data/lib/anyway/config.rb

@@ -299,6 +299,7 @@ module Anyway # :nodoc:
             "via `config_name :my_config`"
         end
 
+        # TODO(v3.0): Replace downcase with underscore
         Regexp.last_match[1].tap(&:downcase!)
       end
 

data/lib/anyway/rails/autoload.rb

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+# This module is used to detect a Rails application and activate the corresponding plugins
+# when Anyway Config is loaded before Rails (e.g., in config/puma.rb).
+module Anyway
+  module Rails
+    class << self
+      attr_reader :tracer
+      attr_accessor :disable_postponed_load_warning
+
+      private
+
+      def tracepoint_class_callback(event)
+        # Ignore singletons
+        return if event.self.singleton_class?
+
+        # We wait till `rails` has been loaded, which is enough to add a railtie
+        # https://github.com/rails/rails/blob/main/railties/lib/rails.rb
+        return unless event.self.name == "Rails"
+
+        # We must check for methods defined in `rails.rb` to distinguish events
+        # happening when we open the `Rails` module in other files.
+        if defined?(::Rails.env)
+          tracer.disable
+
+          unless disable_postponed_load_warning
+            warn "Anyway Config was loaded before Rails. Activating Anyway Config Rails plugins now.\n" \
+                 "NOTE: Already loaded configs were provisioned without Rails-specific sources."
+          end
+
+          require "anyway/rails"
+        end
+      end
+    end
+
+    @tracer = TracePoint.new(:class, &method(:tracepoint_class_callback))
+    @tracer.enable
+  end
+end

data/lib/anyway/rails/loaders/credentials.rb

@@ -53,7 +53,7 @@ module Anyway
 
         def credentials_path
           if ::Rails.application.config.respond_to?(:credentials)
-            ::Rails.application.config.credentials.content_path.relative_path_from(::Rails.root).to_s
+            ::Rails.root.join(::Rails.application.config.credentials.content_path).relative_path_from(::Rails.root).to_s
           else
             "config/credentials.yml.enc"
           end

data/lib/anyway/rails/settings.rb

@@ -66,7 +66,7 @@ module Anyway
       end
 
       def current_environment
-        ::Rails.env.to_s
+        @current_environment || ::Rails.env.to_s
       end
 
       def app_root
@@ -76,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/rbs.rb

@@ -44,7 +44,7 @@ module Anyway
             TYPE_TO_CLASS.fetch(type) { defaults[param] ? "Symbol" : "untyped" }
           in Array
             "Array[untyped]"
-          in array:, type:, **nil
+          in array: _, type:, **nil
             "Array[#{TYPE_TO_CLASS.fetch(type, "untyped")}]"
           in Hash
             "Hash[string,untyped]"

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.1"
+  VERSION = "2.5.0"
 end

data/lib/anyway_config.rb

@@ -45,5 +45,10 @@ module Anyway # :nodoc:
   end
 end
 
-require "anyway/rails" if defined?(::Rails::VERSION)
+if defined?(::Rails::VERSION)
+  require "anyway/rails"
+else
+  require "anyway/rails/autoload"
+end
+
 require "anyway/testing" if ENV["RACK_ENV"] == "test" || ENV["RAILS_ENV"] == "test"

data/lib/generators/anyway/config/config_generator.rb

@@ -41,6 +41,11 @@ module Anyway
           static_config_root
         end
       end
+
+      def needs_config_name?
+        raise "No longer needed" if Gem::Version.new(Anyway::VERSION) >= Gem::Version.new("3.0.0")
+        file_name.include?("_")
+      end
     end
   end
 end

data/lib/generators/anyway/config/templates/config.rb.tt

@@ -2,6 +2,9 @@
 
 <% module_namespacing do -%>
 class <%= class_name %>Config < ApplicationConfig
+<%- if needs_config_name? %>
+  config_name :<%= file_name %>
+<%- end -%>
 <%- unless parameters.empty? -%>
   attr_config <%= parameters.map { |param| ":#{param}" }.join(", ") %>
 <%- 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.1
+  version: 2.5.0
 platform: ruby
 authors:
 - Vladimir Dementyev
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-05-04 00:00:00.000000000 Z
+date: 2023-07-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: ruby-next-core
@@ -158,6 +158,7 @@ files:
 - lib/anyway/option_parser_builder.rb
 - lib/anyway/optparse_config.rb
 - lib/anyway/rails.rb
+- lib/anyway/rails/autoload.rb
 - lib/anyway/rails/config.rb
 - lib/anyway/rails/loaders.rb
 - lib/anyway/rails/loaders/credentials.rb