confset 1.0.0

data/spec/fixtures/overwrite_arrays/config1.yml

@@ -0,0 +1,17 @@
+array1:
+  - item1
+  - item2
+  - item3
+  - item4
+
+array2:
+  inner:
+    - item1
+    - item2
+    - item3
+    - item4
+
+array3:
+  - item1
+  - item2
+  - item3

data/spec/fixtures/overwrite_arrays/config2.yml

@@ -0,0 +1,12 @@
+array1:
+  - item2
+  - item4
+  - item5
+
+array2:
+  inner:
+    - item2
+    - item4
+    - item5
+
+array3: []

data/spec/fixtures/overwrite_arrays/config3.yml

@@ -0,0 +1,10 @@
+array1:
+  - item4
+  - item5
+  - item6
+
+array2:
+  inner:
+    - item4
+    - item5
+    - item6

data/spec/fixtures/reserved_keywords.yml

@@ -0,0 +1,7 @@
+select: apple
+collect: banana
+count: lemon
+zip: cherry
+max: kumquat
+min: fig
+exit!: taro

data/spec/fixtures/settings.yml

@@ -0,0 +1,22 @@
+##
+# Settings for Rails database.yml
+#
+databases:
+  development:
+    database: db/development.sqlite3
+  test:
+    database: db/test.sqlite3
+  production:
+    database: db/production.sqlite3
+##
+# ...
+#
+size: 1
+number_in_quotes: "2.56"
+server: google.com
+1: "one"
+photo_sizes:
+  avatar: [60, 60]
+root:
+  yahoo.com: 2
+  'google.com': 3

data/spec/fixtures/settings2.yml

@@ -0,0 +1 @@
+another: "something"

data/spec/fixtures/unsafe_load.yml

@@ -0,0 +1,12 @@
+development: &defaults
+  adapter: postgresql
+  encoding: unicode
+  pool: &pool 5
+test:
+  <<: *defaults         # Psych::BadAlias: Unknown alias
+  database: myapp_test
+  pool: *pool           # Psych::BadAlias: Unknown alias
+others:
+  regex: !ruby/regexp '/https?:\/\/.*exmaple\.com/' # Tried to load unspecified class: Regexp (Psych::DisallowedClass)
+  date: 2021-08-03                                  # Tried to load unspecified class: Date (Psych::DisallowedClass)
+  time: 2001-12-14T21:59:43.10-05:00                # Tried to load unspecified class: Time (Psych::DisallowedClass)

data/spec/fixtures/validation/confset.yml

@@ -0,0 +1,3 @@
+youtube:
+  api_key: ADSEF453
+  multiple_requirements: A

data/spec/fixtures/with_erb.yml

@@ -0,0 +1,4 @@
+computed: <%= 1 + 2 + 3 %>
+section:
+  computed1: <%= "1" %>
+  computed2: <%= "2" %>

data/spec/fixtures/with_malformed_erb.yml

@@ -0,0 +1 @@
+malformed_erb: <%= = %>

data/spec/options_spec.rb

@@ -0,0 +1,255 @@
+# frozen_string_literal: true
+
+require "spec_helper"
+
+describe Confset::Options do
+  before :each do
+    Confset.reset
+  end
+
+  context "when Settings file is using keywords reserved for OpenStruct" do
+    let(:config) do
+      Confset.load_files("spec/fixtures/reserved_keywords.yml")
+    end
+
+    it "should allow to access them via object member notation" do
+      expect(config.select).to eq("apple")
+      expect(config.collect).to eq("banana")
+      expect(config.count).to eq("lemon")
+      expect(config.zip).to eq("cherry")
+      expect(config.max).to eq("kumquat")
+      expect(config.min).to eq("fig")
+      expect(config.exit!).to eq("taro")
+    end
+
+    it "should allow to access them using [] operator" do
+      expect(config["select"]).to eq("apple")
+      expect(config["collect"]).to eq("banana")
+      expect(config["count"]).to eq("lemon")
+      expect(config["zip"]).to eq("cherry")
+      expect(config["max"]).to eq("kumquat")
+      expect(config["min"]).to eq("fig")
+      expect(config["exit!"]).to eq("taro")
+
+      expect(config[:select]).to eq("apple")
+      expect(config[:collect]).to eq("banana")
+      expect(config[:count]).to eq("lemon")
+      expect(config[:zip]).to eq("cherry")
+      expect(config[:max]).to eq("kumquat")
+      expect(config[:min]).to eq("fig")
+      expect(config[:exit!]).to eq("taro")
+    end
+  end
+
+  context "adding sources" do
+    let(:config) do
+      Confset.load_files("spec/fixtures/settings.yml")
+    end
+
+    before do
+      config.add_source!("spec/fixtures/deep_merge2/config1.yml")
+      config.reload!
+    end
+
+    it "should still have the initial config" do
+      expect(config["size"]).to eq(1)
+    end
+
+    it "should add keys from the added file" do
+      expect(config["tvrage"]["service_url"]).to eq("http://services.tvrage.com")
+    end
+
+    context "overwrite with YAML file" do
+      before do
+        config.add_source!("spec/fixtures/deep_merge2/config2.yml")
+        config.reload!
+      end
+
+      it "should overwrite the previous values" do
+        expect(config["tvrage"]["service_url"]).to eq("http://url2")
+      end
+    end
+
+    context "overwrite with Hash" do
+      before do
+        config.add_source!({ tvrage: { service_url: "http://url3" } })
+        config.reload!
+      end
+
+      it "should overwrite the previous values" do
+        expect(config["tvrage"]["service_url"]).to eq("http://url3")
+      end
+    end
+  end
+
+  context "prepending sources" do
+    let(:config) do
+      Confset.load_files("spec/fixtures/settings.yml")
+    end
+
+    before do
+      config.prepend_source!("spec/fixtures/deep_merge2/config1.yml")
+      config.reload!
+    end
+
+    it "should still have the initial config" do
+      expect(config["size"]).to eq(1)
+    end
+
+    it "should add keys from the added file" do
+      expect(config["tvrage"]["service_url"]).to eq("http://services.tvrage.com")
+    end
+
+    context "be overwritten" do
+      before do
+        config.prepend_source!("spec/fixtures/deep_merge2/config2.yml")
+        config.reload!
+      end
+
+      it "should overwrite the previous values" do
+        expect(config["tvrage"]["service_url"]).to eq("http://services.tvrage.com")
+      end
+    end
+
+    context "source is a hash" do
+      let(:hash_source) {
+        { tvrage: { service_url: "http://url3" }, meaning_of_life: 42 }
+      }
+      before do
+        config.prepend_source!(hash_source)
+        config.reload!
+      end
+
+      it "should be overwriten by the following values" do
+        expect(config["tvrage"]["service_url"]).to eq("http://services.tvrage.com")
+      end
+
+      it "should set meaning of life" do
+        expect(config["meaning_of_life"]).to eq(42)
+      end
+    end
+  end
+
+  context "when fail_on_missing option" do
+    context "is set to true" do
+      before { Confset.setup { |cfg| cfg.fail_on_missing = true } }
+
+      it "should raise an error when accessing a missing key" do
+        config = Confset.load_files("spec/fixtures/empty1.yml")
+
+        expect { config.not_existing_method }.to raise_error(KeyError)
+        expect { config[:not_existing_method] }.to raise_error(KeyError)
+      end
+
+      it "should raise an error when accessing a removed key" do
+        config = Confset.load_files("spec/fixtures/empty1.yml")
+
+        config.tmp_existing = 1337
+        expect(config.tmp_existing).to eq(1337)
+
+        config.delete_field(:tmp_existing)
+        expect { config.tmp_existing }.to raise_error(KeyError)
+        expect { config[:tmp_existing] }.to raise_error(KeyError)
+      end
+    end
+
+    context "is set to false" do
+      before { Confset.setup { |cfg| cfg.fail_on_missing = false } }
+
+      it "should return nil when accessing a missing key" do
+        config = Confset.load_files("spec/fixtures/empty1.yml")
+
+        expect(config.not_existing_method).to eq(nil)
+        expect(config[:not_existing_method]).to eq(nil)
+      end
+    end
+  end
+
+  context "#key? and #has_key? methods" do
+    let(:config) {
+      config = Confset.load_files("spec/fixtures/empty1.yml")
+      config.existing = nil
+      config.send("complex_value=", nil)
+      config.send("even_more_complex_value==", nil)
+      config.nested = Confset.load_files("spec/fixtures/empty2.yml")
+      config.nested.existing = nil
+      config
+    }
+
+    it "should test if a value exists for a given key" do
+      expect(config.key?(:not_existing)).to eq(false)
+      expect(config.key?(:complex_value)).to eq(true)
+      expect(config.key?("even_more_complex_value=".to_sym)).to eq(true)
+      expect(config.key?(:nested)).to eq(true)
+      expect(config.nested.key?(:not_existing)).to eq(false)
+      expect(config.nested.key?(:existing)).to eq(true)
+    end
+
+    it "should be sensible to key's class" do
+      expect(config.key?(:existing)).to eq(true)
+      expect(config.key?("existing")).to eq(false)
+    end
+  end
+
+  context "when merge_hash_arrays options" do
+    context "is set to true" do
+      before { Confset.setup { |cfg|
+        cfg.overwrite_arrays = false
+        cfg.merge_hash_arrays = true
+      } }
+
+      it "should merge the arrays" do
+        config = Confset.load_files("spec/fixtures/deep_merge3/config1.yml", "spec/fixtures/deep_merge3/config2.yml")
+
+        expect(config.array.length).to eq(1)
+        expect(config.array[0].a).to eq("one")
+        expect(config.array[0].b).to eq("two")
+      end
+    end
+
+    context "is set to false" do
+      before { Confset.setup { |cfg|
+        cfg.overwrite_arrays = false
+        cfg.merge_hash_arrays = false
+      } }
+
+      it "should merge the arrays" do
+        config = Confset.load_files("spec/fixtures/deep_merge3/config1.yml", "spec/fixtures/deep_merge3/config2.yml")
+
+        expect(config.array.length).to eq(2)
+        expect(config.array[0].b).to eq(nil)
+        expect(config.array[1].b).to eq("two")
+      end
+    end
+  end
+
+  context "when calling #as_json" do
+    it "should return a Hash of the keys and values" do
+      unless defined?(::Rails)
+        skip <<~REASON
+          Confset::Options#as_json raises a runtime error unless Active Support
+          Core Extensions are loaded. We don't expect users to call this method
+          at all if they're not using AS, so we disable this test except when
+          running the suite against Rails.
+        REASON
+      end
+
+      options = Confset::Options.new(foo: :bar)
+      expect(options.as_json).to eq({ "foo" => "bar" })
+    end
+  end
+
+  context "parsing values" do
+    let(:config) do
+      Confset.load_files("spec/fixtures/settings.yml")
+    end
+
+    it "should return number when its specified without quotes" do
+      expect(config["size"]).to eq(1)
+    end
+
+    it "should return string when number specified with quotes" do
+      expect(config["number_in_quotes"]).to eq("2.56")
+    end
+  end
+end

data/spec/sources/env_source_spec.rb

@@ -0,0 +1,81 @@
+# frozen_string_literal: true
+
+require "spec_helper"
+
+module Confset::Sources
+  describe EnvSource do
+    context "configuration options" do
+      before :each do
+        Confset.reset
+        Confset.env_prefix           = nil
+        Confset.env_separator        = "."
+        Confset.env_converter        = :downcase
+        Confset.env_parse_values     = true
+      end
+
+      context "default configuration" do
+        it "should use global prefix configuration by default" do
+          Confset.env_prefix = "MY_CONFIG"
+
+          source = EnvSource.new({ "MY_CONFIG.ACTION_MAILER" => "enabled" })
+          results = source.load
+          expect(results["action_mailer"]).to eq("enabled")
+        end
+
+        it "should use global separator configuration by default" do
+          Confset.env_separator = "__"
+
+          source = EnvSource.new({ "Settings__ACTION_MAILER__ENABLED" => "yes" })
+          results = source.load
+          expect(results["action_mailer"]["enabled"]).to eq("yes")
+        end
+
+        it "should use global converter configuration by default" do
+          Confset.env_converter = nil
+
+          source = EnvSource.new({ "Settings.ActionMailer.Enabled" => "yes" })
+          results = source.load
+          expect(results["ActionMailer"]["Enabled"]).to eq("yes")
+        end
+
+        it "should use global parse_values configuration by default" do
+          Confset.env_parse_values = false
+
+          source = EnvSource.new({ "Settings.ACTION_MAILER.ENABLED" => "true" })
+          results = source.load
+          expect(results["action_mailer"]["enabled"]).to eq("true")
+        end
+      end
+
+      context "configuration overrides" do
+        it "should allow overriding prefix configuration" do
+          source = EnvSource.new({ "MY_CONFIG.ACTION_MAILER" => "enabled" },
+                                 prefix: "MY_CONFIG")
+          results = source.load
+          expect(results["action_mailer"]).to eq("enabled")
+        end
+
+        it "should allow overriding separator configuration" do
+          source = EnvSource.new({ "Settings__ACTION_MAILER__ENABLED" => "yes" },
+                                 separator: "__")
+          results = source.load
+          expect(results["action_mailer"]["enabled"]).to eq("yes")
+        end
+
+        it "should allow overriding converter configuration" do
+          source = EnvSource.new({ "Settings.ActionMailer.Enabled" => "yes" },
+                                 converter: nil)
+          results = source.load
+          expect(results["ActionMailer"]["Enabled"]).to eq("yes")
+        end
+
+        it "should allow overriding parse_values configuration" do
+          source = EnvSource.new({ "Settings.ACTION_MAILER.ENABLED" => "true" },
+                                 parse_values: false)
+          results = source.load
+          expect(results["action_mailer"]["enabled"]).to eq("true")
+        end
+      end
+    end
+  end
+end

data/spec/sources/hash_source_spec.rb

@@ -0,0 +1,49 @@
+# frozen_string_literal: true
+
+require "spec_helper"
+
+module Confset::Sources
+  describe HashSource do
+    it "should take a hash as initializer" do
+      source = HashSource.new(foo: 5)
+      expect(source.hash).to eq(foo: 5)
+    end
+
+    context "basic hash" do
+      let(:source) do
+        HashSource.new(
+          {
+            "size" => 2,
+            "section" => {
+              "size" => 3,
+              "servers" => [ { "name" => "yahoo.com" }, { "name" => "amazon.com" } ]
+            }
+          }
+        )
+      end
+
+      it "should properly read the settings" do
+        results = source.load
+        expect(results["size"]).to eq(2)
+      end
+
+      it "should properly read nested settings" do
+        results = source.load
+        expect(results["section"]["size"]).to eq(3)
+        expect(results["section"]["servers"]).to be_instance_of(Array)
+        expect(results["section"]["servers"].size).to eq(2)
+      end
+    end
+
+    context "parameter is not a hash" do
+      let(:source) do
+        HashSource.new "hello world"
+      end
+
+      it "should return an empty hash" do
+        results = source.load
+        expect(results).to eq({})
+      end
+    end
+  end
+end

data/spec/sources/yaml_source_spec.rb

@@ -0,0 +1,145 @@
+# frozen_string_literal: true
+
+require "spec_helper"
+
+module Confset::Sources
+  describe YAMLSource do
+    it "should take a path as initializer" do
+      source = YAMLSource.new "somepath"
+      expect(source.path).to eq("somepath")
+    end
+
+    context "basic yml file" do
+      let(:source) do
+        YAMLSource.new "spec/fixtures/development.yml"
+      end
+
+      it "should properly read the settings" do
+        results = source.load
+        expect(results["size"]).to eq(2)
+      end
+
+      it "should properly read nested settings" do
+        results = source.load
+        expect(results["section"]["size"]).to eq(3)
+        expect(results["section"]["servers"]).to be_instance_of(Array)
+        expect(results["section"]["servers"].size).to eq(2)
+      end
+    end
+
+    context "yml file with erb tags" do
+      let(:source) do
+        YAMLSource.new("spec/fixtures/with_erb.yml")
+      end
+
+      it "should properly evaluate the erb" do
+        results = source.load
+        expect(results["computed"]).to eq(6)
+      end
+
+      it "should properly evaluate the nested erb settings" do
+        results = source.load
+        expect(results["section"]["computed1"]).to eq(1)
+        expect(results["section"]["computed2"]).to eq(2)
+      end
+
+      context "with malformed erb tags" do
+        let(:source) do
+          YAMLSource.new("spec/fixtures/with_malformed_erb.yml")
+        end
+
+        it "should properly evaluate the erb" do
+          expect {
+            source.load
+          }.to raise_error(SyntaxError)
+        end
+      end
+    end
+
+    context "yaml file with erb tags but erb disabled" do
+      let(:source) do
+        YAMLSource.new("spec/fixtures/with_erb.yml", evaluate_erb: false)
+      end
+
+      it "should load the file and leave the erb without being evaluated" do
+        results = source.load
+        expect(results["computed"]).to eq("<%= 1 + 2 + 3 %>")
+        expect(results["section"]["computed1"]).to eq("<%= \"1\" %>")
+      end
+
+      context "with global config" do
+        let(:source) do
+          YAMLSource.new("spec/fixtures/with_erb.yml")
+        end
+
+        around do |example|
+          original_evaluate_erb_in_yaml = Confset.evaluate_erb_in_yaml
+          Confset.evaluate_erb_in_yaml = false
+          example.run
+          Confset.evaluate_erb_in_yaml = original_evaluate_erb_in_yaml
+        end
+
+        it "should load the file and leave the erb without being evaluated" do
+          results = source.load
+          expect(results["computed"]).to eq("<%= 1 + 2 + 3 %>")
+          expect(results["section"]["computed1"]).to eq("<%= \"1\" %>")
+        end
+      end
+
+      context "with malformed erb tags" do
+        let(:source) do
+          YAMLSource.new("spec/fixtures/with_malformed_erb.yml", evaluate_erb: false)
+        end
+
+        it "should properly evaluate the erb" do
+          expect {
+            results = source.load
+            expect(results["malformed_erb"]).to eq("<%= = %>")
+          }.to_not raise_error
+        end
+      end
+    end
+
+    context "missing yml file" do
+      let(:source) do
+        YAMLSource.new "somewhere_that_doesnt_exist.yml"
+      end
+
+      it "should return an empty hash" do
+        results = source.load
+        expect(results).to eq({})
+      end
+    end
+
+    context "blank yml file" do
+      let(:source) do
+        YAMLSource.new "spec/fixtures/empty1.yml"
+      end
+
+      it "should return an empty hash" do
+        results = source.load
+        expect(results).to eq({})
+      end
+    end
+
+    context "malformed yml file" do
+      let(:source) do
+        YAMLSource.new "spec/fixtures/malformed.yml"
+      end
+
+      it "should raise an useful exception" do
+        expect { source.load }.to raise_error(/malformed\.yml/)
+      end
+    end
+
+    context "unsafe yml file" do
+      let(:source) do
+        YAMLSource.new "spec/fixtures/unsafe_load.yml"
+      end
+
+      it "should load without any exception" do
+        expect { source.load }.not_to raise_error
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+ENV["RAILS_ENV"] ||= "test"
+
+require "confset"
+
+Dir["./spec/support/**/*.rb"].each { |f| require f }
+
+RSpec.configure do |config|
+  # Turn the deprecation warnings into errors, giving you the full backtrace
+  config.raise_errors_for_deprecations!
+
+  config.before(:suite) do
+    Confset.module_eval do
+      # Extend Confset module with ability to reset configuration to the default values
+      def self.reset
+        self.const_name           = "Settings"
+        self.use_env              = false
+        self.knockout_prefix      = nil
+        self.overwrite_arrays     = true
+        self.schema               = nil
+        self.validation_contract  = nil
+        self.fail_on_missing      = false
+        instance_variable_set(:@_ran_once, false)
+      end
+    end
+  end
+end

data/spec/support/fixture_helper.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+##
+# Confset Fixture Helpers
+#
+
+module FixtureHelper
+  FIXTURE_PATH = File.expand_path("../../fixtures", __FILE__)
+
+  # Provide fixture path as same way as rspec-rails
+  def fixture_path
+    FIXTURE_PATH
+  end
+end