babl-json 0.1.1

data/lib/babl/rendering/noop_preloader.rb

@@ -0,0 +1,10 @@
+module Babl
+    module Rendering
+        # BABL uses this preloader by default. It does nothing.
+        class NoopPreloader
+            def self.preload(data, *_params)
+                data
+            end
+        end
+    end
+end

data/lib/babl/rendering/terminal_value_node.rb

@@ -0,0 +1,54 @@
+require 'singleton'
+
+module Babl
+    module Rendering
+        # A TerminalValueNode node is always implicitely added to the end of the
+        # chain during compilation. It basically ensures that the output contains only
+        # primitives, arrays and hashes.
+        class TerminalValueNode
+            include Singleton
+
+            def documentation
+                :__value__
+            end
+
+            def dependencies
+                {}
+            end
+
+            def pinned_dependencies
+                {}
+            end
+
+            def render(ctx)
+                render_object(ctx.object)
+            end
+
+            def render_object(obj)
+                case obj
+                when String, Numeric, NilClass, TrueClass, FalseClass then obj
+                when Hash then render_hash(obj)
+                when Array then render_array(obj)
+                else raise Babl::RenderingError, "Only primitives can be serialized: #{obj}"
+                end
+            end
+
+            private
+
+            def render_array(array)
+                array.map { |obj| render_object(obj) }
+            end
+
+            def render_hash(hash)
+                hash.map { |k, v| [render_key(k), render_object(v)] }.to_h
+            end
+
+            def render_key(key)
+                case key
+                when Symbol, String, Numeric, NilClass, TrueClass, FalseClass then :"#{key}"
+                else raise Babl::RenderingError, "Invalid key for JSON object: #{obj}"
+                end
+            end
+        end
+    end
+end

data/lib/babl/template.rb

@@ -0,0 +1,48 @@
+require 'babl/utils/hash'
+
+require 'babl/operators/array'
+require 'babl/operators/call'
+require 'babl/operators/dep'
+require 'babl/operators/each'
+require 'babl/operators/enter'
+require 'babl/operators/merge'
+require 'babl/operators/nav'
+require 'babl/operators/nullable'
+require 'babl/operators/object'
+require 'babl/operators/parent'
+require 'babl/operators/partial'
+require 'babl/operators/pin'
+require 'babl/operators/source'
+require 'babl/operators/static'
+require 'babl/operators/switch'
+require 'babl/operators/with'
+
+require 'babl/builder/template_base'
+require 'babl/builder/chain_builder'
+
+require 'babl/rendering/compiled_template'
+require 'babl/rendering/context'
+require 'babl/rendering/internal_value_node'
+require 'babl/rendering/terminal_value_node'
+require 'babl/rendering/noop_preloader'
+
+module Babl
+    class Template < Babl::Builder::TemplateBase
+        include Operators::Array::DSL
+        include Operators::Call::DSL
+        include Operators::Dep::DSL
+        include Operators::Each::DSL
+        include Operators::Enter::DSL
+        include Operators::Merge::DSL
+        include Operators::Nav::DSL
+        include Operators::Nullable::DSL
+        include Operators::Object::DSL
+        include Operators::Parent::DSL
+        include Operators::Partial::DSL
+        include Operators::Pin::DSL
+        include Operators::Source::DSL
+        include Operators::Static::DSL
+        include Operators::Switch::DSL
+        include Operators::With::DSL
+    end
+end

data/lib/babl/utils/hash.rb

@@ -0,0 +1,11 @@
+module Babl
+    module Utils
+        class Hash
+            # Source: http://stackoverflow.com/a/9381776/1434017 (Jon M)
+            def self.deep_merge(first, second)
+                merger = proc { |_key, v1, v2| ::Hash === v1 && ::Hash === v2 ? v1.merge(v2, &merger) : v2 }
+                first.merge(second, &merger)
+            end
+        end
+    end
+end

data/lib/babl/version.rb

@@ -0,0 +1,3 @@
+module Babl
+    VERSION = '0.1.1'
+end

data/spec/construction_spec.rb

@@ -0,0 +1,246 @@
+require 'babl'
+
+describe ::Babl::Template do
+    let(:dsl) { ::Babl::Template.new }
+    let(:compiled) { template.compile }
+    let(:json) { Oj.load(compiled.json(object)) }
+    let(:dependencies) { compiled.dependencies }
+    let(:documentation) { compiled.documentation }
+
+    describe '#object' do
+        let(:template) { dsl.source { object(:a, :b, c: _, d: nav(:d)) } }
+        let(:object) { { a: 1, b: 2, c: 3, d: 4 } }
+
+        it { expect(json).to eq('a' => 1, 'b' => 2, 'c' => 3, 'd' => 4) }
+        it { expect(documentation).to eq(a: :__value__, b: :__value__, c: :__value__, d: :__value__) }
+        it { expect(dependencies).to eq(a: {}, b: {}, c: {}, d: {}) }
+
+        context 'misused (chaining after object)' do
+            let(:template) { dsl.source { object(:a).object(:b) } }
+            it { expect { compiled }.to raise_error Babl::InvalidTemplateError }
+        end
+    end
+
+    describe '#each' do
+        context 'when everything is fine' do
+            let(:template) { dsl.source { each.nav(:a) } }
+            let(:object) { [{ a: 3 }, { a: 2 }, { a: 1 }] }
+
+            it { expect(json).to eq [3, 2, 1] }
+            it { expect(dependencies).to eq(__each__: { a: {} }) }
+            it { expect(documentation).to eq [:__value__] }
+        end
+
+        context 'error while navigating' do
+            let(:object) { { box: [{ trololol: 2 }, 42] } }
+            let(:template) { dsl.source { nav(:box).each.nav(:trololol) } }
+
+            it { expect { json }.to raise_error(/\__root__\.box\.1\.trololol/) }
+        end
+    end
+
+    describe '#static' do
+        let(:template) { dsl.source { static('1': 'cava') } }
+        let(:object) { nil }
+
+        it { expect(json).to eq('1' => 'cava') }
+        it { expect(dependencies).to eq({}) }
+        it { expect(documentation).to eq('1': 'cava') }
+
+        context 'invalid' do
+            let(:template) { dsl.source { static(test: Object.new) } }
+            it { expect { compiled }.to raise_error Babl::InvalidTemplateError }
+        end
+    end
+
+    describe '#array' do
+        let(:template) { dsl.source { array('coucou', 45, a: 1, b: [_]) } }
+        let(:object) { { b: 12 } }
+        it { expect(json).to eq ['coucou', 45, { 'a' => 1, 'b' => [12] }] }
+        it { expect(dependencies).to eq(b: {}) }
+        it { expect(documentation).to eq ['coucou', 45, a: 1, b: [:__value__]] }
+    end
+
+    describe '#call' do
+        let(:object) { nil }
+
+        context 'false' do
+            let(:template) { dsl.call(false) }
+
+            it { expect(json).to eq false }
+            it { expect(dependencies).to eq({}) }
+            it { expect(documentation).to eq false }
+        end
+
+        context 'block' do
+            let(:object) { 2 }
+            let(:template) { dsl.call { self * 2 } }
+
+            it { expect(json).to eq 4 }
+        end
+
+        context 'hash' do
+            let(:object) { nil }
+            let(:template) { dsl.call('a' => 1, b: 2) }
+
+            it { expect(json).to eq('a' => 1, 'b' => 2) }
+            it { expect(dependencies).to eq({}) }
+        end
+
+        context 'array' do
+            let(:object) { { b: 42 } }
+            let(:template) { dsl.call(['a', 2, :b]) }
+
+            it { expect(json).to eq(['a', 2, 42]) }
+            it { expect(dependencies).to eq(b: {}) }
+        end
+
+        context 'block' do
+            let(:object) { OpenStruct.new(lol: 'tam') }
+            let(:template) { dsl.call(:lol) }
+
+            it { expect(json).to eq 'tam' }
+            it { expect(dependencies).to eq(lol: {}) }
+        end
+
+        context 'template' do
+            let(:object) { OpenStruct.new(a: OpenStruct.new(b: 1)) }
+            let(:template) { dsl.source { object(coucou: nav(:a).call(nav(:b))) } }
+
+            it { expect(dependencies).to eq(a: { b: {} }) }
+            it { expect(json).to eq('coucou' => 1) }
+            it { expect(documentation).to eq(coucou: :__value__) }
+        end
+    end
+
+    describe '#switch' do
+        context do
+            let(:template) {
+                dsl.source {
+                    even = nullable.nav(:even?)
+                    odd = nullable.nav(:odd?)
+
+                    each.switch(
+                        even => nav { |x| "#{x} is even" },
+                        odd => nav { |x| "#{x} is odd" },
+                        default => continue
+                    ).static('WTF')
+                }
+            }
+
+            let(:object) { [1, 2, nil, 5] }
+
+            it { expect(json).to eq ['1 is odd', '2 is even', 'WTF', '5 is odd'] }
+            it { expect(dependencies).to eq(__each__: { even?: {}, odd?: {} }) }
+            it {
+                expect(documentation).to eq [
+                    'Case 1': :__value__,
+                    'Case 2': :__value__,
+                    'Case 3': 'WTF'
+                ]
+            }
+        end
+
+        context 'static condition' do
+            let(:template) { dsl.source { switch(true => 42) } }
+            let(:object) { {} }
+            it { expect(json).to eq 42 }
+        end
+
+        context 'navigation before continue' do
+            let(:template) { dsl.source { nav(:abc).switch(false => 1, default => nav(:lol).continue).object(val: nav(:ok)) } }
+
+            it { expect { compiled }.to raise_error Babl::InvalidTemplateError }
+        end
+
+        context 'continue in sub-object' do
+            let(:template) { dsl.source { object(a: switch(default => object(x: continue))) } }
+
+            it { expect { compiled }.to raise_error Babl::InvalidTemplateError }
+        end
+
+        context 'unhandled default' do
+            let(:object) { { abc: { lol: { ok: 42 } } } }
+            let(:template) { dsl.source { switch(false => 1) } }
+
+            it { expect(dependencies).to eq({}) }
+            it { expect { json }.to raise_error Babl::RenderingError }
+        end
+
+        context 'continue without switch' do
+            let(:template) { dsl.source { continue } }
+
+            it { expect { compiled }.to raise_error Babl::InvalidTemplateError }
+        end
+
+        context 'non serializable objects are allowed internally' do
+            let(:template) { dsl.source { switch(test: 42) } }
+            let(:object) { { test: Object.new } }
+
+            it { expect(json).to eq 42 }
+        end
+
+        context do
+            let(:template) {
+                dsl.source {
+                    nav(:test).switch(nav(:keke) => parent.nav(:lol))
+                }
+            }
+            it { expect(dependencies).to eq(test: { keke: {} }, lol: {}) }
+        end
+    end
+
+    describe '#with' do
+        context 'everything is fine' do
+            let(:template) {
+                dsl.source {
+                    object(
+                        result: with(
+                            unscoped,
+                            :msg,
+                            _.parent.nav(:msg).dep(:lol)
+                        ) { |obj, a, b| "#{a} #{b} #{obj[:msg]}" }
+                    )
+                }
+            }
+
+            let(:object) { { result: 42, msg: 'Hello C' } }
+
+            it { expect(json).to eq('result' => 'Hello C Hello C Hello C') }
+            it { expect(dependencies).to eq(result: {}, msg: { lol: {} }) }
+            it { expect(documentation).to eq(result: :__value__) }
+        end
+
+        context 'when the block raise an exception' do
+            let(:object) { nil }
+            let(:template) { dsl.source { with { raise 'lol' } } }
+            it { expect { json }.to raise_error(/\__root__\.__block__/) }
+        end
+    end
+
+    describe '#merge' do
+        context do
+            let(:template) {
+                dsl.source {
+                    merge(
+                        object(a: static('A')),
+                        b: _
+                    )
+                }
+            }
+
+            let(:object) { { b: 42 } }
+
+            it { expect(json).to eq('a' => 'A', 'b' => 42) }
+            it { expect(dependencies).to eq(b: {}) }
+            it { expect(documentation).to eq('Merge 1': { a: 'A' }, 'Merge 2': { b: :__value__ }) }
+        end
+
+        context 'merge inside object' do
+            let(:template) { dsl.source { object(toto: merge(_, lol: 42)) } }
+            let(:object) { { toto: { cool: 'ouai' } } }
+
+            it { expect(json).to eq('toto' => { 'lol' => 42, 'cool' => 'ouai' }) }
+        end
+    end
+end

data/spec/navigation_spec.rb

@@ -0,0 +1,133 @@
+require 'babl'
+
+describe ::Babl::Template do
+    let(:dsl) { ::Babl::Template.new }
+    let(:compiled) { template.compile }
+    let(:json) { Oj.load(compiled.json(object)) }
+    let(:dependencies) { compiled.dependencies }
+    let(:documentation) { compiled.documentation }
+
+    describe '#parent' do
+        context 'valid usage' do
+            let(:template) {
+                dsl.source {
+                    nav(:box).dep(:box_dep).parent.dep(:root_dep)
+                }
+            }
+
+            let(:object) { { box: 42 } }
+
+            it { expect(documentation).to eq :__value__ }
+            it { expect(dependencies).to eq(box: { box_dep: {} }, root_dep: {}) }
+            it { expect(json).to eq('box' => 42) }
+        end
+
+        context 'error while navigating' do
+            let(:object) { { a: { b: { c: 56 } } } }
+            let(:template) { dsl.source { nav(:a).parent.nav(:a).nav(:b, :x) } }
+
+            it { expect { json }.to raise_error(/\__root__\.a\.b\.x/) }
+        end
+
+        context 'invalid usage' do
+            let(:template) { dsl.source { parent } }
+            it { expect { compiled }.to raise_error Babl::InvalidTemplateError }
+        end
+
+        context 'deeply nested parent chain' do
+            let(:template) {
+                dsl.source {
+                    nav(:a, :b, :c, :d, :e).parent.parent.parent.nav(:f, :g, :h).parent.parent.parent.parent.nav(:i)
+                }
+            }
+            it { expect(dependencies).to eq(a: { b: { f: { g: { h: {} } }, c: { d: { e: {} } } }, i: {} }) }
+        end
+
+        context 'same-level key + nested parent chain' do
+            let(:template) {
+                dsl.source {
+                    object(
+                        a: _.nav(:b, :c).parent.parent.nav(:h),
+                        b: _.nav(:a).parent.nav(:a)
+                    )
+                }
+            }
+            it { expect(dependencies).to eq(a: { b: { c: {} }, h: {} }, b: { a: {} }) }
+        end
+    end
+
+    describe '#dep' do
+        let(:template) {
+            dsl.source {
+                dep(a: [:b, :c]).nav(:b).dep(x: :y).nav(:z)
+            }
+        }
+
+        let(:object) { { b: { z: 42 } } }
+
+        it { expect(documentation).to eq :__value__ }
+        it { expect(dependencies).to eq(a: { b: {}, c: {} }, b: { x: { y: {} }, z: {} }) }
+        it { expect(json).to eq(42) }
+    end
+
+    describe '#enter' do
+        context 'invalid usage' do
+            let(:template) { dsl.source { enter } }
+            it { expect { compiled }.to raise_error Babl::InvalidTemplateError }
+        end
+
+        context 'valid usage' do
+            let(:template) { dsl.source { object(a: enter) } }
+            let(:object) { { a: 42 } }
+
+            it { expect(documentation).to eq(a: :__value__) }
+            it { expect(dependencies).to eq(a: {}) }
+            it { expect(json).to eq('a' => 42) }
+        end
+    end
+
+    describe '#nav' do
+        let(:template) { dsl.source { nav(:a) } }
+
+        context 'hash navigation' do
+            let(:object) { { a: 42 } }
+            it { expect(json).to eq(42) }
+            it { expect(dependencies).to eq(a: {}) }
+
+            context 'block navigation propagate dependency chain' do
+                let(:template) { dsl.source { nav(:a).nav(:to_i) } }
+                it { expect(dependencies).to eq(a: { to_i: {} }) }
+            end
+        end
+
+        context 'navigate to non serializable' do
+            let(:template) { dsl.source { nav(:a) } }
+            let(:object) { { a: :test } }
+            it { expect { json }.to raise_error Babl::RenderingError }
+        end
+
+        context 'object navigation' do
+            let(:object) { Struct.new(:a).new(42) }
+            it { expect(json).to eq(42) }
+            it { expect(dependencies).to eq(a: {}) }
+        end
+
+        context 'block navigation' do
+            let(:object) { 42 }
+            let(:template) { dsl.source { nav { |x| x * 2 } } }
+
+            it { expect(json).to eq(84) }
+            it { expect(dependencies).to eq({}) }
+
+            context 'block navigation breaks dependency chain' do
+                let(:template) { dsl.source { nav { |x| x * 2 }.nav(:to_i) } }
+                it { expect(dependencies).to eq({}) }
+            end
+        end
+
+        context '#nav should stop key propagation for #enter' do
+            let(:template) { dsl.source { object(a: nav._) } }
+            it { expect { compiled }.to raise_error Babl::InvalidTemplateError }
+        end
+    end
+end