babl-json 0.4.0 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 03dff31c23ccad4de2970e0e9f1e8c0ac2df3257
-  data.tar.gz: 88bfe61b0d2fcfc20ff71a4e009d6ddf15416e00
+  metadata.gz: 1bad3eaac421de5e967efa6a17096a9a95529174
+  data.tar.gz: e722e283eb9a3004a935a28bac8b09f8f94a10e6
 SHA512:
-  metadata.gz: c9c04e5150dd7aeda65aefcb989f4a72eb5aed5b5afd0f18edae0495818e45b6fad658c1d693375ff711329c0c036e0c333d0d5ce99349f100c8a2da0b98f07c
-  data.tar.gz: 720f05f879639374ab4a26bc7be49b4d32c6fb7c8534621643d09bb2d3a4f402cedc8af994682268760fcdc2418ac72e6cf7e9ffd9bda8dbf14d4d914683cec7
+  metadata.gz: fa8c6c330b936f4c1b4a3a455bba8491a43911c7c644d161b233215e8a436e2091722e6d85c0005d2b6aa89f5641d69dddb8d50ebd1cc49010368caa434633fb
+  data.tar.gz: 9a6a76cc67edcf4f7f2b952b645d5fa974f492294dde354925c9eb3aa794dd3c210689c55b082923ee4682eaaa960cc6db540dd78776cc10ac7fc6cb83758bc6

data/lib/babl.rb

@@ -6,32 +6,84 @@ require 'babl/rendering'
 require 'babl/operators'
 
 module Babl
+    # There is basically two ways to use BABL: the Rails way, and the clean way.
+    #
+    # Rails way
+    # - BABL detects Rails and integrates with it automatically (only if BABL is required AFTER Rails).
+    # - BABL configuration is global (defined via Babl.configure).
+    # - Global configuration is also used by:
+    #      Babl.template
+    #      Babl.compile
+    #      Babl.source
+    #
+    # Clean way
+    # - You can decide not to use global configuration. It will result in more verbosity
+    #   but it protects you from global settings.
+    # - Equivalences:
+    #       Babl.template  ==> Babl::Template.new
+    #       Babl.compile   ==> Babl::Template#compile
+    #       Babl.source    ==> Babl::Template#source
+    #
     class Config
-        attr_accessor :search_path, :preloader, :pretty, :cache_templates
+        attr_accessor :preloader, # No practical use outside Bannerman today.
+            :pretty,              # Pretty format JSON output (boolean).
+            :cache_templates,     # Enable or disable caching of compiled templates (Rails only, boolean).
+            :lookup_context,      # Specify how to find templates.
+            :using                # List of user-defined modules containing custom operators.
 
         def initialize
-            @search_path = nil
             @preloader = Rendering::NoopPreloader
             @pretty = true
             @cache_templates = false
+            @lookup_context = nil
+            @using = []
+        end
+    end
+
+    class AbsoluteLookupContext
+        attr_reader :search_path
+
+        def initialize(search_path)
+            @search_path = search_path
+            raise Errors::InvalidTemplate, 'Missing search path' unless search_path
+        end
+
+        def find(current_template, partial_name)
+            query = File.join(search_path, "{#{partial_name}}{.babl,}")
+            path = Dir[query].first
+            return unless path
+            source = File.read(path)
+            [current_template.source(source, path, 0), self]
         end
     end
 
     class << self
-        def compile(&block)
-            source(&block).compile(
+        def compile(*args, &block)
+            raise ArgumentError, 'Wrong number of arguments' if args.size > 1
+            raise ArgumentError, 'Template or block expected' unless args.empty? ^ block.nil?
+
+            (args.empty? ? source(&block) : template.call(args.first)).compile(
                 pretty: config.pretty,
-                preloader: config.preloader
+                preloader: config.preloader,
+                lookup_context: config.lookup_context
             )
         end
 
-        def source(&block)
-            template = Template.new
-            if config.search_path
-                ctx = Operators::Partial::AbsoluteLookupContext.new(config.search_path)
-                template = template.with_lookup_context(ctx)
-            end
-            template.source(&block)
+        def source(*args, &block)
+            template.source(*args, &block)
+        end
+
+        def template
+            cached = @cached_template
+            return cached.last if cached && config.using == cached.first
+            # Calling 'using' is a very inefficient operation, because
+            # it creates a new class. We can avoid that cost most of the
+            # time, assuming 'config.using' does not change often (typically
+            # it should only change once at startup)
+            modules = config.using.dup
+            template = Template.new.using(*modules)
+            @cached_template = [modules, template]
+            template
         end
 
         def configure

data/lib/babl/builder/chain_builder.rb

@@ -57,11 +57,7 @@ module Babl
             end
 
             def wrap
-                rescope { |bound| yield bind(bound) }
-            end
-
-            def rescope(&block)
-                dup.tap { |tb| tb.instance_variable_set(:@scope, block) }
+                self.class.new { |bound| yield bind(bound) }
             end
         end
 

data/lib/babl/builder/template_base.rb

@@ -8,17 +8,20 @@ module Babl
     module Builder
         # TemplateBase is a thin wrapper around Builder.
         #
-        # Since the BABL code is run via #instance_eval within an instance of this class, we want to
+        # Since the BABL code is run via #instance_exec within an instance of this class, we want to
         # define as few methods as possible here.
-        class TemplateBase < Utils::Value.new(:builder)
+        class TemplateBase
+            attr_reader :builder
+
             def initialize(builder = ChainBuilder.new(&:itself))
-                super(builder)
+                @builder = builder
+                freeze
             end
 
-            def compile(preloader: Rendering::NoopPreloader, pretty: true, optimize: true)
+            def compile(preloader: Rendering::NoopPreloader, pretty: true, optimize: true, lookup_context: nil)
                 # Compute dependencies & schema on the non-simplified node tree in order
                 # to catch all errors.
-                tree = precompile
+                tree = precompile(lookup_context: lookup_context)
                 dependencies = tree.dependencies
                 schema = tree.schema
 
@@ -40,13 +43,13 @@ module Babl
             end
 
             def unscoped
-                self.class.new builder.rescope(&:itself)
+                self.class.new
             end
 
             protected
 
-            def precompile
-                builder.precompile(Nodes::TerminalValue.instance)
+            def precompile(node = Nodes::TerminalValue.instance, **context)
+                builder.precompile(node, **context)
             end
 
             def construct_node(**new_context, &block)

data/lib/babl/operators.rb

@@ -21,4 +21,5 @@ require 'babl/operators/source'
 require 'babl/operators/static'
 require 'babl/operators/switch'
 require 'babl/operators/typed'
+require 'babl/operators/using'
 require 'babl/operators/with'

data/lib/babl/operators/parent.rb

@@ -13,7 +13,7 @@ module Babl
                 protected
 
                 # Override TemplateBase#precompile to add parent dependencies verification
-                def precompile
+                def precompile(*)
                     Nodes::Parent::Verifier.new(super)
                 end
             end

data/lib/babl/operators/partial.rb

@@ -8,40 +8,14 @@ module Babl
                 # Load a partial template given its name
                 # A 'lookup_context' must be defined
                 def partial(partial_name)
-                    raise Errors::InvalidTemplate, 'Cannot use partial without lookup context' unless lookup_context
-
-                    path, source, partial_lookup_context = lookup_context.find(partial_name)
-                    raise Errors::InvalidTemplate, "Cannot find partial '#{partial_name}'" unless path
-
-                    with_lookup_context(partial_lookup_context)
-                        .source(source, path, 0)
-                        .with_lookup_context(lookup_context)
-                end
-
-                def with_lookup_context(lookup_context)
-                    self.class.new(builder.dup.tap { |inst| inst.instance_variable_set(:@lookup_context, lookup_context) })
-                end
-
-                def lookup_context
-                    builder.instance_variable_get(:@lookup_context)
-                end
-            end
-
-            class AbsoluteLookupContext
-                attr_reader :search_path
-
-                def initialize(search_path)
-                    @search_path = search_path
-                    raise Errors::InvalidTemplate, 'Invalid search path' unless search_path
-                end
-
-                def find(partial_name)
-                    query = File.join(search_path, "{#{partial_name}}{.babl,}")
-                    path = Dir[query].first
-                    return unless path
-
-                    source = File.read(path)
-                    [path, source, self]
+                    current_template = unscoped
+                    construct_terminal { |ctx|
+                        lookup_context = ctx[:lookup_context]
+                        raise Errors::InvalidTemplate, 'Cannot use partial without lookup context' unless lookup_context
+                        template, new_lookup_context = lookup_context.find(current_template, partial_name)
+                        raise Errors::InvalidTemplate, "Cannot find partial '#{partial_name}'" unless template
+                        template.precompile(Nodes::TerminalValue.instance, lookup_context: new_lookup_context)
+                    }
                 end
             end
         end

data/lib/babl/operators/pin.rb

@@ -23,7 +23,7 @@ module Babl
                 protected
 
                 # Override TemplateBase#precompile to ensure that all pin dependencies are satisfied.
-                def precompile
+                def precompile(*)
                     super.tap do |node|
                         raise Errors::InvalidTemplate, 'Unresolved pin' unless node.pinned_dependencies.empty?
                     end

data/lib/babl/operators/using.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+module Babl
+    module Operators
+        module Using
+            module DSL
+                def using(*mods, &block)
+                    extended_self =
+                        if mods.empty?
+                            self
+                        else
+                            ::Class.new(self.class) { mods.each { |mod| include mod } }.new(builder)
+                        end
+
+                    extended_self.source(&(block || -> { self }))
+                end
+            end
+        end
+    end
+end

data/lib/babl/rendering/context.rb

@@ -51,7 +51,7 @@ module Babl
 
             # Return an array containing the navigation history
             def stack
-                (parent ? parent.stack : []) + [key].compact
+                (parent ? parent.stack : Utils::Array::EMPTY) + [key].compact
             end
         end
     end

data/lib/babl/schema/fixed_array.rb

@@ -4,11 +4,11 @@ require 'babl/utils'
 module Babl
     module Schema
         class FixedArray < Utils::Value.new(:items)
-            EMPTY = new([])
+            EMPTY = new(Utils::Array::EMPTY)
 
             def json
                 if items.empty?
-                    { enum: [[]] }
+                    { enum: [Utils::Array::EMPTY] }
                 else
                     { type: 'array', items: items.map(&:json), additionalItems: false }
                 end

data/lib/babl/schema/object.rb

@@ -9,8 +9,8 @@ module Babl
                 super(properties.to_set.freeze, additional)
             end
 
-            EMPTY = new([], false)
-            EMPTY_WITH_ADDITIONAL = new([], true)
+            EMPTY = new(Utils::Array::EMPTY, false)
+            EMPTY_WITH_ADDITIONAL = new(Utils::Array::EMPTY, true)
 
             class Property < Utils::Value.new(:name, :value, :required)
                 def initialize(name, value, required)

data/lib/babl/template.rb

@@ -24,6 +24,7 @@ module Babl
         include Operators::Pin::DSL
         include Operators::Source::DSL
         include Operators::Static::DSL
+        include Operators::Using::DSL
         include Operators::Switch::DSL
         include Operators::Typed::DSL
         include Operators::With::DSL

data/lib/babl/utils/dsl_proxy.rb

@@ -33,7 +33,7 @@ module Babl
             end
 
             def self.eval(dsl, &block)
-                new(dsl, block.binding.receiver).instance_eval(&block)
+                new(dsl, block.binding.receiver).instance_exec(&block)
             end
 
             def initialize(receiver, fallback)

data/lib/babl/utils/value.rb

@@ -5,35 +5,44 @@ module Babl
     module Utils
         # Construct deeply immutable value objects
         # Similar to Struct, but:
-        # - Properties are assumed deeply immutable (#hash is assumed constant)
+        # - Properties are assumed deeply immutable (#hash is assumed constant & store permanently)
         # - Constructor requires all arguments
         # - #== has the same meaning as #eql?
-        class Value
+        # - The object is frozen
+        #
+        # Goals :
+        # - Create completely immutable value objects
+        # - Fast comparison between instances (using precomputed hash values)
+        # - Low overhead (relies on native Ruby Struct)
+        class Value < Struct
             def self.new(*fields)
-                ::Class.new(::Struct.new(:_cached_hash, *fields)) do
-                    field_aliases = ::Array.new(fields.size) { |i| "v#{i}" }
-                    const_set(:FIELDS, fields.map(&:to_sym))
-                    class_eval <<-RUBY
-                        def initialize(#{field_aliases.join(',')})
-                            super(#{['nil', field_aliases].join(',')})
-                            hash
-                            freeze
-                        end
+                fields = fields.map(&:to_sym)
+                field_aliases = ::Array.new(fields.size) { |i| "v#{i}" }
 
-                        def hash
-                            self._cached_hash ||= super
-                        end
+                clazz = super(:_cached_hash, *fields)
+                clazz.const_set(:FIELDS, fields)
+                clazz.class_eval <<-RUBY
+                    def initialize(#{field_aliases.join(',')})
+                        super(#{['nil', field_aliases].join(',')})
+                        hash
+                        freeze
+                    end
+                RUBY
 
-                        def ==(other)
-                            eql?(other)
-                        end
+                clazz
+            end
+
+            def hash
+                self._cached_hash ||= super
+            end
+
+            def ==(other)
+                eql?(other)
+            end
 
-                        def self.with(hash = Utils::Hash::EMPTY)
-                            raise ::ArgumentError unless ::Hash === hash && (hash.keys - FIELDS).empty?
-                            new(*FIELDS.map { |f| hash.fetch(f) })
-                        end
-                    RUBY
-                end
+            def self.with(hash = Utils::Hash::EMPTY)
+                raise ::ArgumentError unless ::Hash === hash && (hash.keys - self::FIELDS).empty?
+                new(*self::FIELDS.map { |f| hash.fetch(f) })
             end
         end
     end

data/lib/babl/version.rb

@@ -1,4 +1,4 @@
 # frozen_string_literal: true
 module Babl
-    VERSION = '0.4.0'
+    VERSION = '0.5.0'
 end

metadata

@@ -1,113 +1,113 @@
 --- !ruby/object:Gem::Specification
 name: babl-json
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 0.5.0
 platform: ruby
 authors:
 - Frederic Terrazzoni
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-10-03 00:00:00.000000000 Z
+date: 2017-10-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: pry
+  name: coveralls
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '0.8'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '0.8'
 - !ruby/object:Gem::Dependency
-  name: rspec
+  name: jbuilder
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3'
+        version: '2'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3'
+        version: '2'
 - !ruby/object:Gem::Dependency
-  name: rubocop
+  name: json-schema
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.50'
+        version: '2.8'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.50'
+        version: '2.8'
 - !ruby/object:Gem::Dependency
-  name: json-schema
+  name: pry
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.8'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.8'
+        version: '0'
 - !ruby/object:Gem::Dependency
-  name: coveralls
+  name: rabl
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.8'
+        version: '0.13'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.8'
+        version: '0.13'
 - !ruby/object:Gem::Dependency
-  name: jbuilder
+  name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2'
+        version: '3'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2'
+        version: '3'
 - !ruby/object:Gem::Dependency
-  name: rabl
+  name: rubocop
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - '='
       - !ruby/object:Gem::Version
-        version: '0.13'
+        version: '0.51'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - '='
       - !ruby/object:Gem::Version
-        version: '0.13'
+        version: '0.51'
 - !ruby/object:Gem::Dependency
   name: multi_json
   requirement: !ruby/object:Gem::Requirement
@@ -175,6 +175,7 @@ files:
 - lib/babl/operators/static.rb
 - lib/babl/operators/switch.rb
 - lib/babl/operators/typed.rb
+- lib/babl/operators/using.rb
 - lib/babl/operators/with.rb
 - lib/babl/railtie.rb
 - lib/babl/rendering.rb