anyway_config 2.6.2 → 2.6.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e761c4c95eec2740f7db9c02482f4ffbcfdcf2493e0085a281f5a12d24b467fd
-  data.tar.gz: 1eddf63bbb44cb50e510fdab9b5a5bfeb68029c7a827fda96a7ea452aa35a985
+  metadata.gz: 9272986ff4c206ffad5c0877ca80e7506568f37ec5bce4d2d21de72c4892780e
+  data.tar.gz: b2437f38022bb345cee5d4d92f482ff3ca0e4789420c68a8f8c3121b27e92403
 SHA512:
-  metadata.gz: 455e2745b78c356e8baa57a504a5be3fa84cd4d9f166a5bb9352fe195cce2c1f44babe59615a8f6c87398020b91307f06b82bbb46c3286c5c2a0719cf1017ea4
-  data.tar.gz: f595fb6da6d1e7b9b3f8581dfcb776c1437f0ea0414e4e82728d36f60c7875ddf32c570f1910a823125c50d016d6fb1a5e3e61b2857c4d1ec6f3c9f93e5dcfef
+  metadata.gz: b2081d401c0f624420ee215c3d5941e17c2e7a0180e8e803830442ed284e5316631be8f458f903a61c6c234e94d05c1a4fb9c3e6f52f9e03435cea4db466806d
+  data.tar.gz: 36cff9c0ad7a1c0f6c5a5ff9b601f31dd559936fdb6edcbd50457f3c65a8337e5dc68c185e7888a46e7ae89909aab9d2aa3cc3ef7fe1949d6d21057bcc731584

data/CHANGELOG.md

@@ -2,6 +2,10 @@
 
 ## master
 
+## 2.6.3 (2024-02-06)
+
+- Add `permitted_classes` configuration for YAML loaders. ([@palkan][])
+
 ## 2.6.2 (2024-01-08)
 
 - Fix Ruby 3.3.0 compatibility issues (caused by [Ruby bug](https://bugs.ruby-lang.org/issues/20090)) ([@palkan][])

data/README.md

@@ -370,6 +370,12 @@ development:
 
 **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"`.
 
+You can also configure additional Ruby classes that you want to deserialized from YAML (`permitted_classes` option). For example:
+
+```ruby
+Anyway::Loaders::YAML.permitted_classes << Date
+```
+
 ### 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`._

data/lib/.rbnext/2.7/anyway/loaders/yaml.rb

@@ -9,6 +9,12 @@ using Anyway::Ext::Hash
 module Anyway
   module Loaders
     class YAML < Base
+      @@permitted_classes = []
+
+      class << self
+        def permitted_classes ;  @@permitted_classes; end
+      end
+
       def call(config_path:, **_options)
         rel_config_path = relative_config_path(config_path).to_s
         base_config = trace!(:yml, path: rel_config_path) do
@@ -53,9 +59,9 @@ module Anyway
         # the interface when no config file is present.
         begin
           if defined?(ERB)
-            ::YAML.load(ERB.new(File.read(path)).result, aliases: true) || {}
+            ::YAML.load(ERB.new(File.read(path)).result, aliases: true, permitted_classes: self.class.permitted_classes) || {}
           else
-            ::YAML.load_file(path, aliases: true) || {}
+            ::YAML.load_file(path, aliases: true, permitted_classes: self.class.permitted_classes) || {}
           end
         rescue ArgumentError
           if defined?(ERB)

data/lib/.rbnext/3.0/anyway/loaders/yaml.rb

@@ -0,0 +1,90 @@
+# frozen_string_literal: true
+
+require "pathname"
+require "anyway/ext/hash"
+
+using RubyNext
+using Anyway::Ext::Hash
+
+module Anyway
+  module Loaders
+    class YAML < Base
+      @@permitted_classes = []
+
+      class << self
+        def permitted_classes ;  @@permitted_classes; end
+      end
+
+      def call(config_path:, **_options)
+        rel_config_path = relative_config_path(config_path).to_s
+        base_config = trace!(:yml, path: rel_config_path) do
+          config = load_base_yml(config_path)
+          environmental?(config) ? config_with_env(config) : config
+        end
+
+        return base_config unless use_local?
+
+        local_path = local_config_path(config_path)
+        local_config = trace!(:yml, path: relative_config_path(local_path).to_s) { load_local_yml(local_path) }
+        Utils.deep_merge!(base_config, local_config)
+      end
+
+      private
+
+      def environmental?(parsed_yml)
+        # strange, but still possible
+        return true if Settings.default_environmental_key? && parsed_yml.key?(Settings.default_environmental_key)
+        # possible
+        return true if !Settings.future.unwrap_known_environments && Settings.current_environment
+        # for other environments
+        return true if Settings.known_environments&.any? { parsed_yml.key?(_1) }
+        # preferred
+        parsed_yml.key?(Settings.current_environment)
+      end
+
+      def config_with_env(config)
+        env_config = config[Settings.current_environment] || {}
+        return env_config unless Settings.default_environmental_key?
+
+        default_config = config[Settings.default_environmental_key] || {}
+        Utils.deep_merge!(default_config, env_config)
+      end
+
+      def parse_yml(path)
+        return {} unless File.file?(path)
+        require "yaml" unless defined?(::YAML)
+
+        # By default, YAML load will return `false` when the yaml document is
+        # empty. When this occurs, we return an empty hash instead, to match
+        # the interface when no config file is present.
+        begin
+          if defined?(ERB)
+            ::YAML.load(ERB.new(File.read(path)).result, aliases: true, permitted_classes: self.class.permitted_classes) || {}
+          else
+            ::YAML.load_file(path, aliases: true, permitted_classes: self.class.permitted_classes) || {}
+          end
+        rescue ArgumentError
+          if defined?(ERB)
+            ::YAML.load(ERB.new(File.read(path)).result) || {}
+          else
+            ::YAML.load_file(path) || {}
+          end
+        end
+      end
+
+      alias_method :load_base_yml, :parse_yml
+      alias_method :load_local_yml, :parse_yml
+
+      def local_config_path(path)
+        path.sub(".yml", ".local.yml")
+      end
+
+      def relative_config_path(path)
+        Pathname.new(path).then do |path|
+          return path if path.relative?
+          path.relative_path_from(Settings.app_root)
+        end
+      end
+    end
+  end
+end

data/lib/anyway/loaders/yaml.rb

@@ -9,6 +9,12 @@ using Anyway::Ext::Hash
 module Anyway
   module Loaders
     class YAML < Base
+      @@permitted_classes = []
+
+      class << self
+        def permitted_classes = @@permitted_classes
+      end
+
       def call(config_path:, **_options)
         rel_config_path = relative_config_path(config_path).to_s
         base_config = trace!(:yml, path: rel_config_path) do
@@ -53,9 +59,9 @@ module Anyway
         # the interface when no config file is present.
         begin
           if defined?(ERB)
-            ::YAML.load(ERB.new(File.read(path)).result, aliases: true) || {}
+            ::YAML.load(ERB.new(File.read(path)).result, aliases: true, permitted_classes: self.class.permitted_classes) || {}
           else
-            ::YAML.load_file(path, aliases: true) || {}
+            ::YAML.load_file(path, aliases: true, permitted_classes: self.class.permitted_classes) || {}
           end
         rescue ArgumentError
           if defined?(ERB)

data/lib/anyway/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: anyway_config
 version: !ruby/object:Gem::Version
-  version: 2.6.2
+  version: 2.6.3
 platform: ruby
 authors:
 - Vladimir Dementyev
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-01-09 00:00:00.000000000 Z
+date: 2024-02-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: ruby-next-core
@@ -132,6 +132,7 @@ files:
 - lib/.rbnext/3.0/anyway/config.rb
 - lib/.rbnext/3.0/anyway/loaders.rb
 - lib/.rbnext/3.0/anyway/loaders/base.rb
+- lib/.rbnext/3.0/anyway/loaders/yaml.rb
 - lib/.rbnext/3.0/anyway/tracing.rb
 - lib/.rbnext/3.1/anyway/config.rb
 - lib/.rbnext/3.1/anyway/dynamic_config.rb