figleaf 0.3.0 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d9587314be7114b5e08704a3f1e2364f41cf90f926c890554b8dd31582dbd7c2
-  data.tar.gz: 7f1731a8135590e9992ff1a2e40382fd36f11f9bb3739d6006546a40069ee948
+  metadata.gz: d1b89f2110836d4dd5f0ad63b08f4a4ce2b8c6b17edbb1103a73e85ffaa898c9
+  data.tar.gz: b798a685d89f189e37e89624f08d8c2a6f9bce2abad278f983e83dee5cf292fe
 SHA512:
-  metadata.gz: '03471397a014e702344505aee3ebe6289b110278d662ed121fcc634c8a63a20f9207e90b1ca08ec7d6d693246f61b1dede83cec44af33694dae4621b4e892b56'
-  data.tar.gz: 76a9bdcec7177c4485273a93748c454b886f3adb22b12e4dfe485ea7359d9f7d418a15509f7ce7747b0b5225ff0fc896598f877c29354ea67d8090a4a03ee238
+  metadata.gz: b00325b3a45103b5b3d9859befeff699bea806e981757b86371ada1cf933ebdb9a4e1cbb139ae96127b221543d1f6092441dfb3e591624f289ae2e0bac91cccd
+  data.tar.gz: 51f854f9551e34b2b5492113f027cad42ad8519c1f86be2ed8c05bf8dc6ae498360edc0bd2578971e428bf39325ebe62f67a4aec9d43d812ba70972f04e2cab4

data/.rspec

@@ -1,2 +1,2 @@
 --color
---format progress
+--format documentation

data/.solargraph.yml

@@ -0,0 +1,16 @@
+---
+include:
+  - "**/*.rb"
+exclude:
+  - spec/**/*
+  - test/**/*
+  - vendor/**/*
+  - ".bundle/**/*"
+require: []
+domains: []
+reporters:
+  - update_errors
+formatter: null
+require_paths: []
+plugins: []
+max_files: 15000

data/CHANGELOG.md

@@ -1,28 +1,40 @@
 # Change Log
 
+## 0.3.1 (2024/04/24)
+
+- Allow loading regexps
+
 ## 0.3.0 (2024/04/05)
+
 - Use YAML.safe_load to support versions of Psych >4
 - Target modern rubies
 - Take advantage of Ruby 3's single line methods
 - Use standardrb to auto format all files
 
 ## 0.2.7, 0.2.8 and 0.2.9 (2017/09/28)
-Bugfixes
+
+- Bugfixes
 
 ## 0.2.6 (2017/09/28)
-Add ability to write config files in ruby
+
+- Add ability to write config files in ruby
 
 ## 0.2.5 (2017/09/28)
-Add support for `default` options
+
+- Add support for `default` options
 
 ## 0.2.4 (2017/08/25)
-Relax active support version dependency
+
+- Relax active support version dependency
 
 ## 0.2.3 (2017/03/09)
-Include original error along with file that failed loading
+
+- Include original error along with file that failed loading
 
 ## 0.2.2 (2017/03/08)
-Report what file failed loading on startup
+
+- Report what file failed loading on startup
 
 ## 0.2.1
-Fixes for rails 4
+
+- Fixes for rails 4

data/lib/figleaf/config.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Figleaf
   # Convert a ruby block to nested hash
   class Config
@@ -33,17 +35,4 @@ module Figleaf
 
     attr_reader :property
   end
-
-  class LazyBlockHash < Hash
-    def [](attr)
-      val = super(attr)
-      if val.is_a?(Proc)
-        val.call
-      else
-        val
-      end
-    rescue => e
-      raise Settings::InvalidRb, "Configuration has invalid Ruby\n" + e.message
-    end
-  end
 end

data/lib/figleaf/fighash.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Figleaf
   class Fighash < Hashie::Mash
     def method_missing(method_name, *args, &blk)

data/lib/figleaf/lazy_block_hash.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module Figleaf
+  class LazyBlockHash < Hash
+    def [](attr)
+      val = super
+      if val.is_a?(Proc)
+        val.call
+      else
+        val
+      end
+    rescue => e
+      raise Settings::InvalidRb, "Configuration has invalid Ruby\n#{e.message}"
+    end
+  end
+end

data/lib/figleaf/settings.rb

@@ -1,7 +1,10 @@
+# frozen_string_literal: true
+
 module Figleaf
   class Settings
     InvalidYAML = Class.new(RuntimeError)
     InvalidRb = Class.new(RuntimeError)
+    MismatchedTypes = Class.new(RuntimeError)
 
     class_attribute :auto_define
     self.auto_define = false
@@ -58,11 +61,11 @@ module Figleaf
       end
 
       def load_file(file, env_to_load = env)
+        property_name = File.basename(file, ".*")
+
         if file.end_with?(".rb")
-          property_name = File.basename(file, ".rb")
           config = load_rb_file(file) or return nil
         else
-          property_name = File.basename(file, ".yml")
           config = load_yaml_file(file) or return nil
         end
 
@@ -70,7 +73,23 @@ module Figleaf
 
         default = config["default"]
         property = config[env_to_load]
-        property = default.merge(property || {}) if !default.nil?
+
+        property =
+          if property.nil? && default.nil?
+            return nil
+          elsif property.nil?
+            default
+          elsif default.nil?
+            property
+          elsif default.class.name != property.class.name
+            raise MismatchedTypes, "Error loading file #{file}: mismatch between default values (type #{default.class.name}) and #{env_to_load} (type #{property.class.name})"
+          else
+            case default
+            when Hash then default.deep_merge(property)
+            when Array then default + property
+            else property
+            end
+          end
 
         [property_name, use_hashie_if_hash(property)]
       end
@@ -84,7 +103,7 @@ module Figleaf
       end
 
       def load_yaml_file(file_path)
-        YAML.safe_load(ERB.new(IO.read(file_path)).result, aliases: true)
+        YAML.safe_load(ERB.new(IO.read(file_path)).result, aliases: true, permitted_classes: [Regexp])
       rescue Psych::SyntaxError => e
         raise InvalidYAML, "#{file_path} has invalid YAML\n" + e.message
       end
@@ -95,7 +114,11 @@ module Figleaf
       end
 
       def default_file_pattern
-        [root.join("config/settings/*.yml"), root.join("config/settings/*.rb")]
+        [
+          root.join("config", "settings", "*.yml"),
+          root.join("config", "settings", "*.yaml"),
+          root.join("config", "settings", "*.rb")
+        ]
       end
 
       def env

data/lib/figleaf/version.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Figleaf
-  VERSION = "0.3.0"
+  VERSION = "0.4.0"
 end

data/lib/figleaf.rb

@@ -1,5 +1,8 @@
+# frozen_string_literal: true
+
 require "active_support/concern"
 require "active_support/core_ext/class/attribute"
+require "active_support/core_ext/hash"
 require "active_support/core_ext/module/attribute_accessors"
 require "active_support/core_ext/object/blank"
 require "erb"
@@ -10,6 +13,7 @@ require "yaml"
 module Figleaf
   autoload :Config, "figleaf/config"
   autoload :Fighash, "figleaf/fighash"
+  autoload :LazyBlockHash, "figleaf/lazy_block_hash"
   autoload :Settings, "figleaf/settings"
   autoload :VERSION, "figleaf/version"
 end

data/spec/figleaf/config_spec.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require "spec_helper"
 
 module Figleaf

data/spec/figleaf/configuration_spec.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require "spec_helper"
 
 describe Figleaf::Settings do
@@ -8,12 +10,12 @@ describe Figleaf::Settings do
       end
       it "should auto define methods and set initial value when setter used" do
         described_class.fictional_feature_enabled = :on
-        described_class.fictional_feature_enabled.should == :on
+        expect(described_class.fictional_feature_enabled).to eq(:on)
       end
 
       it "should return result of proc when set as a proc" do
         described_class.call_this_proc = -> { 3 }
-        described_class.call_this_proc.should == 3
+        expect(described_class.call_this_proc).to eq(3)
       end
     end
 
@@ -25,15 +27,15 @@ describe Figleaf::Settings do
       end
 
       it "should not auto defined setters and getters" do
-        expect { described_class.undefined_setting = :raises_error }.to raise_error
-        expect { described_class.undefined_setting }.to raise_error
+        expect { described_class.undefined_setting = :raises_error }.to raise_error(NoMethodError)
+        expect { described_class.undefined_setting }.to raise_error(NoMethodError)
       end
 
       it "should set/get previous defined attributes" do
-        described_class.fictional_feature_enabled.should eq(:on)
+        expect(described_class.fictional_feature_enabled).to eq(:on)
 
         described_class.fictional_feature_enabled = :off
-        described_class.fictional_feature_enabled.should eq(:off)
+        expect(described_class.fictional_feature_enabled).to eq(:off)
       end
     end
   end
@@ -45,8 +47,8 @@ describe Figleaf::Settings do
         s.enable_fictional_activity_feed = true
       end
 
-      described_class.another_fictional_feature_mode.should eq(:admin)
-      described_class.enable_fictional_activity_feed.should be true
+      expect(described_class.another_fictional_feature_mode).to eq(:admin)
+      expect(described_class.enable_fictional_activity_feed).to be true
     end
   end
 
@@ -56,8 +58,8 @@ describe Figleaf::Settings do
         s.some_boolean = true
       end
 
-      described_class.some_boolean.should be true
-      described_class.some_boolean?.should be true
+      expect(described_class.some_boolean).to be true
+      expect(described_class.some_boolean?).to be true
     end
 
     it "should define predicate methods for false value" do
@@ -65,8 +67,8 @@ describe Figleaf::Settings do
         s.another_boolean = false
       end
 
-      described_class.another_boolean.should be false
-      described_class.another_boolean?.should be false
+      expect(described_class.another_boolean).to be false
+      expect(described_class.another_boolean?).to be false
     end
 
     it "should evaluate presence predicate methods for string value" do
@@ -74,7 +76,7 @@ describe Figleaf::Settings do
         s.not_a_boolean = "Hello, world!"
       end
 
-      described_class.not_a_boolean?.should be true
+      expect(described_class.not_a_boolean?).to be true
     end
 
     it "should return false for empty string" do
@@ -82,7 +84,7 @@ describe Figleaf::Settings do
         s.empty_string = ""
       end
 
-      described_class.empty_string?.should be false
+      expect(described_class.empty_string?).to be false
     end
 
     it "return true for lists" do
@@ -90,7 +92,7 @@ describe Figleaf::Settings do
         s.not_a_boolean = %w[1 2 3]
       end
 
-      described_class.not_a_boolean?.should be true
+      expect(described_class.not_a_boolean?).to be true
     end
   end
 
@@ -105,7 +107,7 @@ describe Figleaf::Settings do
         s.fictional_feature_enabled = :off
       end
 
-      described_class.fictional_feature_enabled.should == :off
+      expect(described_class.fictional_feature_enabled).to eq(:off)
     end
 
     it "should only allow setting of values for previously defined attributes" do
@@ -113,7 +115,7 @@ describe Figleaf::Settings do
         described_class.configure do |s|
           s.undefined_setting = :should_raise_error
         end
-      }.to raise_error
+      }.to raise_error(NoMethodError)
     end
   end
 end

data/spec/figleaf/fighash_spec.rb

@@ -1,25 +1,27 @@
+# frozen_string_literal: true
+
 require "spec_helper"
 
 describe Figleaf::Fighash do
   describe "#to_hash" do
     it "should return class Hash" do
-      subject.to_hash.class.should == Hash
+      expect(subject.to_hash.class).to eq(Hash)
     end
 
     context "should have symbols as keys" do
       it "for symbol keys" do
         subject = described_class.new({a: :b, c: 1, d: "foo"})
-        subject.to_hash.should == {a: :b, c: 1, d: "foo"}
+        expect(subject.to_hash).to eq({a: :b, c: 1, d: "foo"})
       end
 
       it "for string keys" do
         subject = described_class.new({"a" => :b, "c" => 1, "d" => "foo"})
-        subject.to_hash.should == {a: :b, c: 1, d: "foo"}
+        expect(subject.to_hash).to eq({a: :b, c: 1, d: "foo"})
       end
 
       it "should have symbols as keys inside two levels" do
         subject = described_class.new({a: {b: :d}})
-        subject.to_hash.should == {a: {b: :d}}
+        expect(subject.to_hash).to eq({a: {b: :d}})
       end
     end
   end

data/spec/figleaf/settings_spec.rb

@@ -1,12 +1,21 @@
+# frozen_string_literal: true
+
 require "spec_helper"
 
 describe Figleaf::Settings do
+  # Force a freshly loaded Figleaf::Settings class on every test run
+  before do
+    Figleaf.send(:remove_const, :Settings) if Figleaf.const_defined?(:Settings)
+    load "lib/figleaf/settings.rb"
+  end
+
+  # Force a new reference to the class
+  subject(:described_class) { Figleaf::Settings }
+
   describe "self.load_settings" do
-    before do
-      @fixtures_path = File.expand_path("../../fixtures/*.yml", __FILE__)
+    let(:fixtures_path) { File.expand_path("../../fixtures/*.yml", __FILE__) }
 
-      described_class.load_settings(@fixtures_path, "test")
-    end
+    before { described_class.load_settings(fixtures_path, "test") }
 
     it "load some service" do
       expect(described_class.service["foo"]).to eq("bar")
@@ -42,7 +51,7 @@ describe Figleaf::Settings do
     end
 
     it "and for boolean (false)" do
-      described_class.load_settings(@fixtures_path, "alt")
+      described_class.load_settings(fixtures_path, "alt")
       expect(described_class.boolean).to eq(false)
     end
 
@@ -51,8 +60,12 @@ describe Figleaf::Settings do
       expect(described_class.erb.bar).to be_nil
     end
 
+    it "and for regexp values" do
+      expect(described_class.regexp.some_matcher).to eq(/\Amatcher\z/)
+    end
+
     it "raise exception when loading an undefined value" do
-      YAML.stub(:load_yaml_file).and_return({"test" => {}})
+      allow(YAML).to receive(:load_yaml_file).and_return({"test" => {}})
       described_class.load_settings
       expect { described_class.service.blah }.to raise_error NoMethodError
     end
@@ -77,6 +90,29 @@ describe Figleaf::Settings do
       end
     end
 
+    context "incompatible types" do
+      context "bad overrides" do
+        subject(:settings) { described_class.bad_overrides }
+
+        let(:fixtures_path) { File.expand_path("../../fixtures/type_errors/bad_overrides.yml", __FILE__) }
+
+        it "raises an error when overloading a hash with an array" do
+          expect { described_class.load_settings(fixtures_path, "array") }
+            .to raise_error(described_class::MismatchedTypes)
+        end
+
+        it "raises an error when overloading a hash with a string" do
+          expect { described_class.load_settings(fixtures_path, "string") }
+            .to raise_error(described_class::MismatchedTypes)
+        end
+
+        it "raises an error when overloading a hash with a bool" do
+          expect { described_class.load_settings(fixtures_path, "bool") }
+            .to raise_error(described_class::MismatchedTypes)
+        end
+      end
+    end
+
     context "overloading settings" do
       before do
         overload = File.expand_path("../../fixtures/extra/*.yml", __FILE__)
@@ -106,7 +142,7 @@ describe Figleaf::Settings do
       end
 
       it "overrides values" do
-        expect(described_class.default.foo).to eq("overriden")
+        expect(described_class.default.foo).to eq("overridden")
       end
 
       it "respects values set in default" do
@@ -121,7 +157,7 @@ describe Figleaf::Settings do
       end
 
       it "overrides values" do
-        expect(described_class.default_anchor.foo).to eq("overriden")
+        expect(described_class.default_anchor.foo).to eq("overridden")
       end
 
       it "respects values set in default_anchor" do
@@ -130,12 +166,69 @@ describe Figleaf::Settings do
     end
   end
 
-  context "load ruby files" do
-    before do
-      fixtures_path = File.expand_path("../../fixtures/extra/*.rb", __FILE__)
-      described_class.load_settings(fixtures_path, "test")
+  shared_examples_for "merged hashes" do
+    context "when using the default" do
+      before { described_class.load_settings(fixtures_path, "some_env") }
+
+      it "test a non overridden environment" do
+        expect(merged).to match(
+          "leaf1" => "default1",
+          "root1" => {"leaf11" => "default2"},
+          "root2" => {
+            "leaf21" => "default3",
+            "root21" => {
+              "leaf211" => "default4",
+              "root211" => {"leaf2111" => "default5"}
+            }
+          }
+        )
+      end
     end
 
+    context "with an overridden environment" do
+      before { described_class.load_settings(fixtures_path, "overridden") }
+
+      it "merges the values" do
+        expect(merged).to match(
+          "leaf1" => "default1",
+          "leaf2" => "overridden1",
+          "root1" => {"leaf11" => "overridden2"},
+          "root2" => {
+            "leaf21" => "default3",
+            "leaf22" => "overridden3",
+            "root21" => {
+              "leaf211" => "overridden4",
+              "root211" => {
+                "leaf2111" => "default5",
+                "leaf2112" => "overridden5"
+              }
+            }
+          }
+        )
+      end
+    end
+  end
+
+  context "load yaml files" do
+    let(:fixtures_path) { File.expand_path("../../fixtures/**/*.yaml", __FILE__) }
+
+    before { described_class.load_settings(fixtures_path, "test") }
+
+    it "reads them just fine" do
+      expect(described_class.yaml.works).to eq("here")
+    end
+
+    context "hashes are merged" do
+      subject(:merged) { described_class.merged_yaml }
+      it_behaves_like "merged hashes"
+    end
+  end
+
+  context "load ruby files" do
+    let(:fixtures_path) { File.expand_path("../../fixtures/extra/*.rb", __FILE__) }
+
+    before { described_class.load_settings(fixtures_path, "test") }
+
     it "load indifferently the key names" do
       expect(described_class.code["foo"]).to eq("bar")
       expect(described_class.code[:foo]).to eq("bar")
@@ -169,5 +262,14 @@ describe Figleaf::Settings do
     it "and for ENV values" do
       expect(described_class.code.from_env).to eq("foo")
     end
+
+    it "and for regexp values" do
+      expect(described_class.regexp.value).to eq(/\Amatcher\z/)
+    end
+
+    context "hashes are merged" do
+      subject(:merged) { described_class.merged_rb }
+      it_behaves_like "merged hashes"
+    end
   end
 end

data/spec/fixtures/extra/default.yml

@@ -3,4 +3,4 @@ default:
   bar: baz
 
 test:
-  foo: overriden
+  foo: overridden

data/spec/fixtures/extra/default_anchor.yml

@@ -4,4 +4,4 @@ default: &default
 
 test:
   <<: *default
-  foo: overriden
+  foo: overridden

data/spec/fixtures/extra/merged_rb.rb

@@ -0,0 +1,33 @@
+default do
+  leaf1 "default1"
+  root1(leaf11: "default2")
+  root2(
+    leaf21: "default3",
+    root21: {
+      leaf211: "default4",
+      root211: {
+        leaf2111: "default5"
+      }
+    }
+  )
+end
+
+unused do
+  root1(leaf11: "unused11")
+  root2(root21: {root21: {leaf211: "unused2"}})
+end
+
+overridden do
+  leaf2 "overridden1"
+  root1(leaf11: "overridden2")
+
+  root2(
+    leaf22: "overridden3",
+    root21: {
+      leaf211: "overridden4",
+      root211: {
+        leaf2112: "overridden5"
+      }
+    }
+  )
+end

data/spec/fixtures/extra/merged_yaml.yaml

@@ -0,0 +1,29 @@
+---
+default:
+  leaf1: default1
+  root1:
+    leaf11: default2
+  root2:
+    leaf21: default3
+    root21:
+      leaf211: default4
+      root211:
+        leaf2111: default5
+
+unused:
+  root1:
+    leaf11: unused1
+  root2:
+    root21:
+      leaf211: unused2
+
+overridden:
+  leaf2: overridden1
+  root1:
+    leaf11: overridden2
+  root2:
+    leaf22: overridden3
+    root21:
+      leaf211: overridden4
+      root211:
+        leaf2112: overridden5

data/spec/fixtures/extra/regexp.rb

@@ -0,0 +1,3 @@
+default do
+  value %r{\Amatcher\z}
+end

data/spec/fixtures/regexp.yml

@@ -0,0 +1,2 @@
+default:
+  some_matcher: !ruby/regexp /\Amatcher\z/

data/spec/fixtures/type_errors/bad_overrides.yml

@@ -0,0 +1,11 @@
+---
+default:
+  foo: bar
+
+array:
+  - foo
+
+string: "HELLO"
+
+bool:
+  true

data/spec/fixtures/yaml.yaml

@@ -0,0 +1,3 @@
+---
+test:
+  works: here

metadata

@@ -1,14 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: figleaf
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.4.0
 platform: ruby
 authors:
 - Juan C. Müller
-autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-04-24 00:00:00.000000000 Z
+date: 1980-01-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -47,6 +46,7 @@ extra_rdoc_files: []
 files:
 - ".gitignore"
 - ".rspec"
+- ".solargraph.yml"
 - ".travis.yml"
 - CHANGELOG.md
 - Gemfile
@@ -59,6 +59,7 @@ files:
 - lib/figleaf.rb
 - lib/figleaf/config.rb
 - lib/figleaf/fighash.rb
+- lib/figleaf/lazy_block_hash.rb
 - lib/figleaf/settings.rb
 - lib/figleaf/version.rb
 - spec/figleaf/config_spec.rb
@@ -75,14 +76,19 @@ files:
 - spec/fixtures/extra/code.rb
 - spec/fixtures/extra/default.yml
 - spec/fixtures/extra/default_anchor.yml
+- spec/fixtures/extra/merged_rb.rb
+- spec/fixtures/extra/merged_yaml.yaml
+- spec/fixtures/extra/regexp.rb
 - spec/fixtures/extra/service.yml
+- spec/fixtures/regexp.yml
 - spec/fixtures/service.yml
 - spec/fixtures/string.yml
+- spec/fixtures/type_errors/bad_overrides.yml
+- spec/fixtures/yaml.yaml
 - spec/spec_helper.rb
 homepage: http://github.com/jcmuller/figleaf
 licenses: []
 metadata: {}
-post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -97,8 +103,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.19
-signing_key:
+rubygems_version: 3.7.1
 specification_version: 4
 summary: YAML based DRY settings manager.
 test_files: []