config_reader 3.0.1 → 3.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: cae8d3f402a58472016b70dd56fc8e5f97f099c77809edf8a6145cfe80425139
-  data.tar.gz: 87b86f1f97bc4586aa20768f7216b235fc42ed463bc568f5775c87e756b32c55
+  metadata.gz: c5f34ccb03e315e9301ebedd211dca7e5fde4842e14e15a4f809ee6c0e5f16cd
+  data.tar.gz: 45f064ce87458166d7ccec76e18d8f3ceeaee36ac91665d6c0db6037f8e84d9b
 SHA512:
-  metadata.gz: a64b08e7e67f9313d2c44b179769b84594c3dc5e48f22b0551787d352274724f38ca8db544ba16904fad67d0c6358026c65edda44fef181981031cf952391226
-  data.tar.gz: 38d8e881518b32c0e997d2f859127deb40bafc5dc3478c34fb6927f46cf63d80dc2fd4240cf9dc4b66fb02f950ebe6329d67625842792bec7f44020878525452
+  metadata.gz: 297c24bc4211132943f69e3a5b85f7d2686389f481c4b3b51fc10d530abebd638bb2705b274ac4546be65f9738331f573b39f10ea5b8d2d088270653c41058d5
+  data.tar.gz: 171d64da65475f7188967b1152715ec63730a4322b814372b66c4f5da1f8601b9619ff82c437907efc3acaf3e9ecff06bbcb7cd068584a0adb44e613cfb5c024

data/CHANGELOG.md

@@ -1,10 +1,18 @@
 # Changelog
 
-## 3.0.1 2024-12-13
+## 3.0.3 2025-01-06
+
+Fix a bug in deep merge where values weren't getting set properly.
+
+## 3.0.2 2024-12-13
+
+Fix an issue when merging multiple envs.
+
+## 3.0.1 2024-12-13 (yanked)
 
 Don't merge! in deep_merge
 
-## 3.0.0 2024-12-12
+## 3.0.0 2024-12-12 (yanked)
 
 Update to latest Sekrets (1.14.0)
 Explicitly require abbrev gem

data/lib/config_reader/config_hash.rb

@@ -24,13 +24,11 @@ class ConfigReader
     end
 
     def method_missing(key, *args, &block)
-      key?(key) ? fetch(key) : super
-    rescue KeyError, NoMethodError => e # skipcq: RB-P1001
-      raise e unless ignore_missing_keys
+      ignore_missing_keys ? self[key] : fetch(key)
     end
 
     def respond_to_missing?(m, *)
-      config.key?(m)
+      key?(m)
     end
   end
 end

data/lib/config_reader/version.rb

@@ -1,3 +1,3 @@
 class ConfigReader
-  VERSION = "3.0.1"
+  VERSION = "3.0.3"
 end

data/lib/config_reader.rb

@@ -2,6 +2,11 @@ require "config_reader/version"
 require "config_reader/config_hash"
 require "psych"
 
+begin
+  require "sekrets"
+rescue LoadError
+end
+
 begin
   require "erb"
 rescue LoadError
@@ -31,7 +36,7 @@ class ConfigReader
     end
 
     def deep_merge(hash, other_hash)
-      hash.merge(other_hash) do |_key, this_val, other_val|
+      hash.merge(other_hash) do |key, this_val, other_val|
         if this_val.is_a?(Hash) && other_val.is_a?(Hash)
           deep_merge(this_val, other_val)
         else
@@ -58,26 +63,13 @@ class ConfigReader
     end
 
     def inspect
-      puts config.inspect
+      config.inspect
     end
 
     def load_config
       raise "No config file set" unless find_config
 
-      conf =
-        if defined?(ERB)
-          Psych.safe_load(
-            ERB.new(File.read(find_config)).result,
-            aliases: true,
-            permitted_classes: configuration.permitted_classes.to_a + [Symbol]
-          )
-        else
-          Psych.safe_load_file(
-            File.read(find_config),
-            aliases: true,
-            permitted_classes: configuration.permitted_classes.to_a + [Symbol]
-          )
-        end
+      conf = load_yaml
 
       raise "No config found" unless conf
 
@@ -85,43 +77,59 @@ class ConfigReader
     end
 
     def load_sekrets
-      sekrets = {}
-
       if configuration.sekrets_file
-        begin
-          require "sekrets"
-          sekrets = ::Sekrets.settings_for(configuration.sekrets_file)
-          raise "No sekrets found" unless sekrets
-        rescue LoadError
-          warn "You specified a sekrets_file, but the sekrets gem isn't available."
+        if !defined?(::Sekrets)
+          raise ArgumentError,
+                "You specified a sekrets_file, but the sekrets gem isn't available."
+        else
+          ::Sekrets.settings_for(configuration.sekrets_file) ||
+            raise("No sekrets found")
         end
       end
+    end
+
+    def load_yaml
+      permitted_classes = configuration.permitted_classes.to_a + [Symbol]
 
-      sekrets
+      if defined?(ERB)
+        Psych.safe_load(
+          ERB.new(File.read(find_config)).result,
+          aliases: true,
+          permitted_classes: permitted_classes
+        )
+      else
+        Psych.safe_load_file(
+          File.read(find_config),
+          aliases: true,
+          permitted_classes: permitted_classes
+        )
+      end
     end
 
-    def merge_configs(conf, sekrets)
+    def merge_all_configs(conf, defaults, sekrets)
       @envs = {}
-      env_keys = conf.keys - ["defaults"]
-      env = configuration.environment
 
-      defaults = conf["defaults"]
+      conf.keys.each do |env|
+        env_hash = deep_merge(defaults, conf[env] || {})
+        env_hash = deep_merge(env_hash, sekrets[env] || {}) if sekrets
 
-      if sekrets && sekrets["defaults"]
-        defaults = deep_merge(defaults, sekrets["defaults"])
+        @envs[env] = ConfigHash.convert_hash(
+          env_hash,
+          configuration.ignore_missing_keys
+        )
       end
+    end
 
-      env_keys.each do |key|
-        key_hash = deep_merge(defaults, conf[key]) if conf[key]
-        key_hash = deep_merge(defaults, sekrets[key]) if sekrets && sekrets[key]
+    def merge_configs(conf, sekrets)
+      defaults = conf["defaults"]
 
-        @envs[key] = ConfigHash.convert_hash(
-          key_hash,
-          configuration.ignore_missing_keys
-        )
+      if sekrets&.[]("defaults")
+        defaults = deep_merge(defaults, sekrets["defaults"])
       end
 
-      @envs[env]
+      merge_all_configs(conf, defaults, sekrets)
+
+      @envs[configuration.environment]
     end
 
     def method_missing(key, *_args, &_block)

data/spec/config_reader_spec.rb

@@ -27,13 +27,14 @@ describe "ConfigReader" do
     end
 
     it "should raise on missing nested key with #key accessor" do
-      expect { TestConfig.nested_key.missing }.to raise_error(NoMethodError)
+      expect { TestConfig.nested_key.missing }.to raise_error(KeyError)
     end
   end
 
   describe "all envs available" do
     it "should have all envs available" do
-      expect(TestConfig.envs.keys).to eq(%w[test not_test])
+      TestConfig.reload
+      expect(TestConfig.envs.keys).to eq(%w[defaults test not_test])
     end
 
     it "should have ConfigHash for all envs" do

data/spec/multi_envs/merge_config.rb

@@ -0,0 +1,6 @@
+class MergeConfig < ConfigReader
+  configure do |config|
+    config.environment = "merge"
+    config.config_file = "spec/multi_envs/merge_config.yml"
+  end
+end

data/spec/multi_envs/merge_config.yml

@@ -0,0 +1,15 @@
+---
+defaults:
+  app_name: default_app
+  nested_key:
+    value: test
+
+test:
+  app_name: test_app
+  nested_key:
+    only_in_test_env: true
+
+not_test:
+  app_name: not_test_app
+
+merge:

data/spec/multi_envs/merge_spec.rb

@@ -0,0 +1,18 @@
+require "spec_helper"
+require "multi_envs/merge_config"
+
+describe "ConfigReader" do
+  before(:all) { MergeConfig.reload }
+
+  describe "all envs available" do
+    it "should have all envs available" do
+      expect(MergeConfig.envs.keys).to eq(%w[defaults test not_test merge])
+    end
+
+    it "should have ConfigHash for all envs" do
+      expect(MergeConfig.envs["test"].app_name).to eq("test_app")
+      expect(MergeConfig.envs["not_test"].app_name).to eq("not_test_app")
+      expect(MergeConfig.envs["merge"]).to eq(MergeConfig.envs["defaults"])
+    end
+  end
+end

data/spec/sekrets_config.yml.enc

@@ -1,2 +1,3 @@
 
-�Y"������,K�m4�9-�T�it}ju�v�
+�Y"������,K�m4�9-�T�i6	�dT~�7��w�kp��Coy6Ōݕ
+��7

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: config_reader
 version: !ruby/object:Gem::Version
-  version: 3.0.1
+  version: 3.0.3
 platform: ruby
 authors:
 - Michael Moen
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-12-13 00:00:00.000000000 Z
+date: 2025-01-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: abbrev
@@ -113,6 +113,9 @@ files:
 - lib/config_reader/config_hash.rb
 - lib/config_reader/version.rb
 - spec/config_reader_spec.rb
+- spec/multi_envs/merge_config.rb
+- spec/multi_envs/merge_config.yml
+- spec/multi_envs/merge_spec.rb
 - spec/no_key_no_error_config.rb
 - spec/sekrets_config.rb
 - spec/sekrets_config.yml.enc