layeredyamlconfig 1.4.3

data/lib/layeredyamlconfig/hash_traverse.rb

@@ -0,0 +1,20 @@
+# adapted from Ruby Facets (https://github.com/rubyworks/facets) to support nested Array traversal
+# we're using the Ruby license, clause 2a by making LayeredYAMLConfig freely available
+class Hash
+
+    def traverse(&blk)
+        nh = {}
+        inject(nh) do |h, (k, v)|
+            case v
+                when Hash
+                    v = v.traverse(&blk)
+                when Array
+                    v = v.traverse(&blk)
+            end
+            nv = blk.call(v)
+            h[k.to_sym] = nv
+            h
+        end
+    end
+
+end

data/lib/layeredyamlconfig/templates.rb

@@ -0,0 +1,64 @@
+require 'layeredyamlconfig/array_traverse.rb'
+require 'layeredyamlconfig/hash_traverse.rb'
+
+class LayeredYAMLConfig
+
+    def resolve_templates
+        # lazy-load dependencies
+        if ! defined?(TinyEruby)
+            require 'erubis/tiny'
+        end
+       
+        # if templates are enabled:
+        # - walk the tree finding String leaves that look like ERB tags
+        # - evaluate them with self as context
+        # - rescue errors and increment success / failure counts
+        # - A: if we saw no failures, we're done
+        # - B: if we saw no successes for the first time, set a flag
+        #      if we saw no failures for the second time, raise
+        # - otherwise keep going until A or B are true
+        all_failed_once = false
+        while true do
+            success = 0
+            failure = 0
+            newcfg = @cfg.traverse do |v|
+                if v.kind_of?(String) and v.match(/^<%=/)
+                    begin
+                        nv = Erubis::TinyEruby.new(v).evaluate(:cfg => @cfg)
+                        if ! self.class.emptyok && nv.empty?
+                            failure += 1
+                            v
+                        elsif ! nv.match(/^<%=/)
+                            success += 1
+                            nv
+                        else
+                            failure += 1
+                            v
+                        end
+                    rescue
+                        failure += 1
+                        v
+                    end
+                else
+                    v
+                end
+            end
+            @cfg = newcfg
+            # all success
+            if 0 == failure
+                return
+            # all failure
+            elsif 0 == success
+                if all_failed_once
+                    raise "all template evaluation failed"
+                else
+                    all_failed_once = true
+                end
+            # mix
+            else
+                all_failed_once = false
+            end
+        end
+    end
+    
+end

data/test/ex1.yaml

@@ -0,0 +1,2 @@
+---
+foo: bar

data/test/ex10.yaml

@@ -0,0 +1,3 @@
+---
+foo: bar
+baz: <%= @cfg[:foo] %>

data/test/ex11.yaml

@@ -0,0 +1,4 @@
+---
+foo:
+    bar:
+        baz: <%= @cfg[:foo][:bar][:quux] %>

data/test/ex12.yaml

@@ -0,0 +1,4 @@
+---
+foo:
+    bar:
+        quux: gzonk

data/test/ex13.yaml

@@ -0,0 +1,5 @@
+---
+a:
+    b:
+        c: <%= @cfg[:d][:e][:f] %>
+

data/test/ex14.yaml

@@ -0,0 +1,4 @@
+---
+d:
+    e:
+        f: <%= @cfg[:g][:h][:i] %>

data/test/ex15.yaml

@@ -0,0 +1,4 @@
+---
+g:
+    h:
+        i: j

data/test/ex16.yaml

@@ -0,0 +1,8 @@
+---
+a: d
+b: e
+c: f
+g:
+    - <%= @cfg[:a] %>
+    - <%= @cfg[:b] %>
+    - <%= @cfg[:c] %>

data/test/ex17.yaml

@@ -0,0 +1,5 @@
+---
+a:
+    b:
+        c: d
+        e: <%= @cfg[:a][:b][:f] %>

data/test/ex18.yaml

@@ -0,0 +1,23 @@
+---
+a:
+    - 1
+    - 2
+    - 3
+b:
+    one:
+        a: <%= @cfg[:a][0] %>
+    two:
+        b: <%= @cfg[:a][1] %>
+    three:
+        c: <%= @cfg[:a][2] %>
+c:
+    - - <%= @cfg[:a][0] %>
+      - <%= @cfg[:a][1] %>
+      - <%= @cfg[:a][2] %>
+    - - <%= @cfg[:a][0] %>
+      - <%= @cfg[:a][1] %>
+      - <%= @cfg[:a][2] %>
+d:
+    - one: <%= @cfg[:a][0] %>
+      two: <%= @cfg[:a][1] %>
+      three: <%= @cfg[:a][2] %>

data/test/ex2.yaml

@@ -0,0 +1,2 @@
+---
+bar: baz

data/test/ex3.yaml

@@ -0,0 +1,2 @@
+---
+foo: bar

data/test/ex4.yaml

@@ -0,0 +1,2 @@
+---
+foo: baz

data/test/ex5.yaml

@@ -0,0 +1,6 @@
+# this is a comment
+foo: bar
+# this is a comment for a list
+bar: [ baz, quux ]
+# this is a comment for a map
+baz: { foo: bar, baz: quux }

data/test/ex6.yaml

@@ -0,0 +1,9 @@
+foo:
+    # a comment
+    - bar
+    # another comment
+    - baz
+bar:    # map comment
+    bar: baz
+    # a comment
+    quux: gzonk

data/test/ex7.yaml

@@ -0,0 +1,3 @@
+---
+foo:
+    bar: baz

data/test/ex8.yaml

@@ -0,0 +1,3 @@
+---
+foo:
+    gzonk: quux

data/test/ex9.yaml

@@ -0,0 +1,3 @@
+---
+foo:
+    wibble: wobble

data/test/exbad1.yaml

@@ -0,0 +1 @@
+foo

data/test/exbad2.yaml

@@ -0,0 +1,2 @@
+---
+- foo

data/test/minitest_helper.rb

@@ -0,0 +1,12 @@
+require 'simplecov'
+require 'simplecov-console'
+SimpleCov.formatter = SimpleCov::Formatter::MultiFormatter[
+    SimpleCov::Formatter::HTMLFormatter,
+    SimpleCov::Formatter::Console,
+]
+SimpleCov.start do
+    add_filter '/vendor/'
+    add_filter '/test/'
+end
+
+require 'minitest/debugger' if ENV['DEBUG']

data/test/test_addlayer.rb

@@ -0,0 +1,22 @@
+require 'minitest_helper'
+require 'minitest/autorun'
+require 'layeredyamlconfig'
+
+class OurConfig < LayeredYAMLConfig
+end
+
+class TestAddLayer < Minitest::Test
+    def setup
+        LayeredYAMLConfig.clear_all
+        LayeredYAMLConfig.reset_all
+    end
+    def test_add_layer
+        c = OurConfig.instance( 'test/ex7.yaml', 'test/ex8.yaml' )
+        assert_instance_of(OurConfig, c)
+        assert_equal('baz', c[:foo][:bar])
+        assert_equal('quux', c[:foo][:gzonk])
+        c.add( 'test/ex9.yaml' )
+        assert_instance_of(OurConfig, c)
+        assert_equal('wobble', c[:foo]['wibble'])
+    end
+end

data/test/test_clear.rb

@@ -0,0 +1,48 @@
+require 'minitest_helper'
+require 'minitest/autorun'
+require 'layeredyamlconfig'
+
+class OurConfig1 < LayeredYAMLConfig
+end
+
+class OurConfig2 < LayeredYAMLConfig
+end
+
+class TestClear < Minitest::Test
+    def setup
+        LayeredYAMLConfig.clear_all
+        LayeredYAMLConfig.reset_all
+    end
+    def test_clear_oneclass
+        c1 = OurConfig1.instance( 'test/ex1.yaml' )
+        c2 = OurConfig2.instance( 'test/ex1.yaml' )
+        assert_instance_of(OurConfig1, c1)
+        assert_instance_of(OurConfig2, c2)
+        assert_raises(ArgumentError) {
+            OurConfig1.instance( 'test/ex1.yaml' )
+        }
+        OurConfig1.clear
+        c3 = OurConfig1.instance( 'test/ex1.yaml' )
+        assert_instance_of(OurConfig1, c3)
+        c4 = OurConfig2.instance
+        assert_instance_of(OurConfig2, c4)
+        assert_equal(c2, c4)
+    end
+    def test_clear_all
+        c1 = OurConfig1.instance( 'test/ex1.yaml' )
+        c2 = OurConfig2.instance( 'test/ex1.yaml' )
+        assert_instance_of(OurConfig1, c1)
+        assert_instance_of(OurConfig2, c2)
+        assert_raises(ArgumentError) {
+            OurConfig1.instance( 'test/ex1.yaml' )
+        }
+        assert_raises(ArgumentError) {
+            OurConfig2.instance( 'test/ex1.yaml' ) 
+        }
+        LayeredYAMLConfig.clear_all
+        c3 = OurConfig1.instance( 'test/ex1.yaml' )
+        assert_instance_of(OurConfig1, c3)
+        c4 = OurConfig2.instance( 'test/ex1.yaml' )
+        assert_instance_of(OurConfig2, c4)
+    end
+end

data/test/test_comments.rb

@@ -0,0 +1,26 @@
+require 'minitest_helper'
+require 'minitest/autorun'
+require 'layeredyamlconfig'
+
+class OurConfig < LayeredYAMLConfig
+end
+
+class TestComments < Minitest::Test
+    def setup
+        LayeredYAMLConfig.clear_all
+        LayeredYAMLConfig.reset_all
+    end
+    def test_file_with_comments
+        c = OurConfig.instance( 'test/ex5.yaml' )
+        assert_instance_of(OurConfig, c)
+        assert_equal('bar', c[:foo])
+        assert_equal(%w(baz quux), c[:bar])
+        assert_equal({ 'foo' => 'bar', 'baz' => 'quux' }, c["baz"])
+    end
+    def test_embedded_comments
+        c = OurConfig.instance( 'test/ex6.yaml' )
+        assert_instance_of(OurConfig, c)
+        assert_equal(%w(bar baz), c[:foo])
+        assert_equal({ 'bar' => 'baz', 'quux' => 'gzonk' }, c["bar"])
+    end
+end

data/test/test_constructor.rb

@@ -0,0 +1,50 @@
+require 'minitest_helper'
+require 'minitest/autorun'
+require 'layeredyamlconfig'
+
+class OurConfig < LayeredYAMLConfig
+end
+
+class TestConstructor < Minitest::Test
+    def setup
+        OurConfig.clear
+        OurConfig.reset
+    end
+    def test_nofiles
+        assert_raises(ArgumentError) {
+             OurConfig.instance
+        }
+    end
+    def test_onefile
+        c = OurConfig.instance( 'test/ex1.yaml' )
+        assert_instance_of(OurConfig, c)
+        assert_equal('bar', c[:foo])
+        assert_equal('bar', c['foo'])
+    end
+    def test_onefile_noarray
+        c = OurConfig.instance( 'test/ex1.yaml' )
+        assert_instance_of(OurConfig, c)
+        assert_equal('bar', c[:foo])
+        assert_equal('bar', c['foo'])
+    end
+    def test_twofiles
+        c = OurConfig.instance( 'test/ex1.yaml', 'test/ex2.yaml' )
+        assert_instance_of(OurConfig, c)
+        assert_equal('bar', c[:foo])
+        assert_equal('bar', c['foo'])
+        assert_equal('baz', c[:bar])
+        assert_equal('baz', c['bar'])
+    end
+    def test_twofiles_3_4
+        c = OurConfig.instance( 'test/ex3.yaml', 'test/ex4.yaml' )
+        assert_instance_of(OurConfig, c)
+        assert_equal('baz', c[:foo])
+        assert_equal('baz', c['foo'])
+    end
+    def test_twofiles_4_3
+        c = OurConfig.instance( 'test/ex4.yaml', 'test/ex3.yaml' )
+        assert_instance_of(OurConfig, c)
+        assert_equal('bar', c[:foo])
+        assert_equal('bar', c['foo'])
+    end
+end

data/test/test_deepmerge.rb

@@ -0,0 +1,19 @@
+require 'minitest_helper'
+require 'minitest/autorun'
+require 'layeredyamlconfig'
+
+class OurConfig < LayeredYAMLConfig
+end
+
+class TestDeepMerge < Minitest::Test
+    def setup
+        LayeredYAMLConfig.clear_all
+        LayeredYAMLConfig.reset_all
+    end
+    def test_deep_merge
+        c = OurConfig.instance( 'test/ex7.yaml', 'test/ex8.yaml' )
+        assert_instance_of(OurConfig, c)
+        assert_equal('baz', c[:foo][:bar])
+        assert_equal('quux', c[:foo][:gzonk])
+    end
+end

data/test/test_erb.rb

@@ -0,0 +1,24 @@
+require 'minitest_helper'
+require 'minitest/autorun'
+require 'layeredyamlconfig'
+
+class OurConfig < LayeredYAMLConfig
+end
+
+class TestErb < Minitest::Test
+    def setup
+        OurConfig.clear
+        OurConfig.reset
+    end
+    def test_erb_disabled
+        c = OurConfig.instance( 'test/ex10.yaml' )
+        assert_instance_of(OurConfig, c)
+        assert_match '<%=', c[:baz]
+    end
+    def test_erb_enabled
+        OurConfig.templates = true
+        c = OurConfig.instance( 'test/ex10.yaml' )
+        assert_instance_of(OurConfig, c)
+        assert_equal 'bar', c[:baz]
+    end
+end

data/test/test_erb_array.rb

@@ -0,0 +1,40 @@
+require 'minitest_helper'
+require 'minitest/autorun'
+require 'layeredyamlconfig'
+
+class OurConfig < LayeredYAMLConfig
+end
+
+class TestErbArray < Minitest::Test
+    def setup
+        OurConfig.clear
+        OurConfig.reset
+    end
+    def test_erb_array
+        OurConfig.templates = true
+        c = OurConfig.instance 'test/ex16.yaml'
+        assert_instance_of(OurConfig, c)
+        assert_equal 'd', c[:g][0]
+        assert_equal 'e', c[:g][1]
+        assert_equal 'f', c[:g][2]
+    end
+    def test_erb_array_of_array
+        OurConfig.templates = true
+        c = OurConfig.instance 'test/ex18.yaml'
+        assert_instance_of(OurConfig, c)
+        assert_equal '1', c[:c][0][0]
+        assert_equal '2', c[:c][0][1]
+        assert_equal '3', c[:c][0][2]
+        assert_equal '1', c[:c][1][0]
+        assert_equal '2', c[:c][1][1]
+        assert_equal '3', c[:c][1][2]
+    end
+    def test_erb_array_of_hash
+        OurConfig.templates = true
+        c = OurConfig.instance 'test/ex18.yaml'
+        assert_instance_of(OurConfig, c)
+        assert_equal '1', c[:d][0][:one]
+        assert_equal '2', c[:d][0][:two]
+        assert_equal '3', c[:d][0][:three]
+    end
+end