antlers 1.0.0 → 1.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7e2b59df9502f3e66f123ec45e707de957f8e96656c44ddd6b8a026cf96f73ef
-  data.tar.gz: f8455c5e3de15fc2fdfd8ab1c41dc6c2f6ab377e7d811522f7dc4aa36c40e223
+  metadata.gz: 3c1e20787d49349b0f3df0f6df128650c7214ec53cd697ec66840d6f3884d9e8
+  data.tar.gz: 3048610d15b4fe61ff67123aba2b6f81a5ef9019e4ac03dea657995c30501b17
 SHA512:
-  metadata.gz: '045843a0d001f3f6cc846cdca65935f30a1ecb7aea81e4d5a6fb4bce3627ffb670b458f2457c65b582d048f37747e061bf62754beefcde8e4f327eb17da9565a'
-  data.tar.gz: 7995630d52ba13a9756ee08bdb394ce7afeef4c96397eb7da0822952cf6f8516cdd54c7df519d8fdc9826a792495b9ad2b5a6aab42b683d9c07e70d2a713efaa
+  metadata.gz: bc0ff003117d8d08b22146b15a32f32288aef44191ba401080db525ed3125e6a7cc38fd278b64eb96eda1659d7b608cbf41f4b9a1879c8641eecf0f3fa4fc83d
+  data.tar.gz: e0a5d0d1c71721a4727b3f6134a1eafb40b75b34cff799cc5f2d94677cbf84b6e41dad3b6d8ad5bee5293ca1b1de10969d8e6af1d8cc19c6889b0dc0dbaca71b

data/lib/antlers/api.rb

@@ -2,6 +2,7 @@
 
 require_relative 'elements'
 require_relative 'lexer'
+require_relative 'parser'
 require_relative '../interfaces/lexeme'
 require_relative '../interfaces/branch_node'
 require_relative '../interfaces/leaf_node'

data/lib/antlers/lexer.rb

@@ -73,7 +73,7 @@ module Antlers
 
       while (keyword = keywords.shift)
         keyword.strip!
-        value = keyword.end_with?(':') && value?(keywords.first.strip) ? keywords.shift.strip : nil
+        value = keyword.end_with?(':') && value?(keywords.first) ? keywords.shift.strip : nil
         key_values[keyword] = value
       end
 
@@ -81,7 +81,9 @@ module Antlers
     end
 
     def value?(string)
-      !(string.start_with?(':') || string.end_with?(':'))
+      # Support keywords without a value like "<{ form: }>" whose value will become an empty string.
+      string = string.to_s.strip
+      !string.empty? && !(string.start_with?(':') || string.end_with?(':'))
     end
 
     def brackets?(segments:)

data/lib/antlers/parser.rb

@@ -36,7 +36,13 @@ module Antlers
 
     def sub_branch(node:, sequence:, end_key:, end_name: nil)
       sub_sequence = []
-      sub_sequence << sequence.shift until sequence.first.is_a?(Hash) && sequence.first[end_key] == end_name
+
+      until sequence.first.is_a?(Hash) && sequence.first[end_key] == end_name
+        raise ParserError, "Missing end tag for #{node.class}" if sequence.empty?
+
+        sub_sequence << sequence.shift
+      end
+
       # Remove the end tag we just stopped before.
       sequence.shift
 

data/lib/antlers/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Antlers
-  VERSION = '1.0.0'
+  VERSION = '1.1.1'
 end

data/lib/antlers.rb

@@ -4,21 +4,17 @@ require_relative 'antlers/elements'
 require_relative 'antlers/lexer'
 require_relative 'antlers/parser'
 
-# These requires allow downstream libraries to build their own antlers nodes.
-require_relative 'interfaces/branch_node'
-require_relative 'interfaces/leaf_node'
-
 module Antlers
-  DEFAULT_ELEMENTS = [:root, :html, :form, :for, :if, :prop, :slot, :yield, :var]
+  module_function
+
+  DEFAULT_ELEMENTS = %i[root html form for if prop slot yield var].freeze
 
-  class << self
-    def ast(template:, namespace: nil, elements: Elements[*DEFAULT_ELEMENTS])
-      sequence = Lexer.new(lexeme_types: elements[:lexeme]).parse(template:)
-      Parser.new(namespace:, node_types: elements[:node]).parse(sequence:, template:)
-    end
+  def ast(template:, namespace: nil, elements: Elements[*DEFAULT_ELEMENTS])
+    sequence = Lexer.new(lexeme_types: elements[:lexeme]).parse(template:)
+    Parser.new(namespace:, node_types: elements[:node]).parse(sequence:, template:)
+  end
 
-    def render(ast:, current_binding:, parent_binding: nil, slot_node: nil)
-      ast.render(current_binding:, parent_binding:, slot_node:)
-    end
+  def render(ast:, current_binding:, parent_binding: nil, slot_node: nil, metadata: {})
+    ast.render(current_binding:, parent_binding:, slot_node:, metadata:)
   end
 end

data/lib/interfaces/antler_node.rb

@@ -11,7 +11,7 @@ module Antlers
       @name = name
     end
 
-    def render(current_binding: nil, parent_binding: nil, slot_node: nil, namespace: nil)
+    def render(current_binding: nil, parent_binding: nil, slot_node: nil, namespace: nil, metadata: {})
       raise NotImplementedError
     end
 
@@ -19,6 +19,13 @@ module Antlers
       'level_1'
     end
 
+    # Support sending an event to render_template hook when lowevent available. See lownode as an example implementation.
+    def possible_render_event(props:)
+      Low::Events::RenderEvent.new(action: :render, props:) if defined?(LowEvent)
+
+      nil
+    end
+
     class << self
       def match?(segment:)
         raise NotImplementedError

data/lib/interfaces/branch_node.rb

@@ -12,11 +12,11 @@ module Antlers
       @children = children
     end
 
-    def render(current_binding: nil, parent_binding: nil, slot_node: nil)
+    def render(current_binding: nil, parent_binding: nil, slot_node: nil, metadata: {})
       output = ''
 
       @children.each do |child|
-        output += child.render(current_binding:, parent_binding:, slot_node:) || ''
+        output += child.render(current_binding:, parent_binding:, slot_node:, metadata:) || ''
       end
 
       output

data/lib/interfaces/lexeme.rb

@@ -2,7 +2,7 @@
 
 module Antlers
   module Lexeme
-    KEYWORDS = []
+    KEYWORDS = [].freeze
 
     def match?(name: nil, keywords: {}) = false
 

data/lib/lexemes/form_lexeme.rb

@@ -14,10 +14,7 @@ module Antlers
     end
 
     def lexeme(keywords:, **)
-      if keywords.key?('form:')
-        action = keywords['form:'] ? keywords['form:'][1...-1] : nil
-        return { form_def: action }
-      end
+      return { form_def: keywords['form:'] } if keywords.key?('form:')
 
       { form_end: 'level_1' }
     end

data/lib/lexemes/var_lexeme.rb

@@ -9,15 +9,12 @@ module Antlers
     extend Queries
     extend self
 
-    # Variables are special and are matched by the lexer.
+    # Variables are special and are matched by the lexer in a hard-coded fashion.
     def match?(**)
       false
     end
 
     def lexeme(segment:, raw:, **)
-      # String is already interpolated or not depending on user input on the template layer, now we store it without those template quotes.
-      segment = segment[1..-2] if Queries.user_defined_string?(segment)
-
       return { raw_var: segment } if raw
 
       { var: segment }

data/lib/modules/props.rb

@@ -1,6 +1,5 @@
 # frozen_string_literal: true
 
-require 'low_event'
 require_relative 'variables'
 
 module Antlers
@@ -17,17 +16,13 @@ module Antlers
 
     private
 
-    def create_render_event(props:)
-      Low::Events::RenderEvent.new(action: :render, props:)
-    end
-
     def evaluate_props(props:, current_binding:)
       return {} if props.nil?
 
       evaluated_props = {}
 
       props.each do |name, value|
-        evaluated_props[name] = evaluate(name: value, current_binding:) || fallback(value)
+        evaluated_props[name] = evaluate(value:, current_binding:)
       end
 
       evaluated_props

data/lib/modules/variables.rb

@@ -1,5 +1,6 @@
 # frozen_string_literal: true
 
+require 'erb'
 require_relative '../support/queries'
 
 module Antlers
@@ -7,28 +8,29 @@ module Antlers
     extend Queries
 
     # Evaluation limited to the following for security and to stop a templating language becoming a programming language.
-    #  1. An instance variable
-    #  2. A method call/local variable
-    #  3. A method chain
-    #  4. A static string
-    def evaluate(name:, current_binding:)
-      return name.to_s unless current_binding
+    #  1. A static string
+    #  2. An instance variable
+    #  3. A method call/local variable
+    #  4. A method chain
+    def evaluate(value:, current_binding:, escape: true)
+      result = result(value:, current_binding:)
 
-      name, *chain = name.split('.')
+      return ERB::Util.html_escape(result) if escape
+
+      result
+    end
+
+    def result(value:, current_binding:)
+      return value[1..-2] if Queries.user_defined_string?(value)
+      return value unless current_binding
+
+      name, *chain = value.split('.')
 
       result = method_var(name:, current_binding:)
       return method_chain(result:, chain:) if chain.count > 0
       return result if result
 
       nil
-    rescue StandardError
-      nil
-    end
-
-    def fallback(value)
-      return value[1..-2] if Queries.user_defined_string?(value)
-
-      value
     end
 
     private

data/lib/nodes/for_node.rb

@@ -20,10 +20,10 @@ module Antlers
       @key = key
     end
 
-    def render(current_binding: nil, parent_binding: nil, slot_node: nil)
+    def render(current_binding: nil, parent_binding: nil, slot_node: nil, metadata: {})
       output = ''
 
-      evaluate(name: @items, current_binding:).each do |value|
+      evaluate(value: @items, current_binding:, escape: false).each do |value|
         key, value = value if @key
 
         # TODO: Parallelize by creating new bindings and ensuring children have any args they need via RenderEvent.
@@ -31,7 +31,7 @@ module Antlers
         current_binding.local_variable_set(@key, key) if @key
 
         @children.each do |child|
-          output += child.render(current_binding:, parent_binding:, slot_node:) || ''
+          output += child.render(current_binding:, parent_binding:, slot_node:, metadata:) || ''
         end
       end
 

data/lib/nodes/form_node.rb

@@ -19,20 +19,28 @@ module Antlers
       @method = method
     end
 
-    def render(current_binding: nil, parent_binding: nil, slot_node: nil)
-      output = "<form action='#{@action}' method='#{@method}'>"
+    def render(current_binding: nil, parent_binding: nil, slot_node: nil, metadata: {})
+      output = "<form action='#{action(current_binding:)}' method='#{@method}'>"
 
       @children.each do |child|
-        output += child.render(current_binding:, parent_binding:, slot_node:) || ''
+        output += child.render(current_binding:, parent_binding:, slot_node:, metadata:) || ''
       end
 
       output += '</form>'
       output
     end
 
+    private
+
+    def action(current_binding:)
+      return if @action.nil?
+
+      evaluate(value: @action, current_binding:)
+    end
+
     class << self
       def match?(segment:)
-        segment[DEF_KEY]
+        segment.is_a?(Hash) && segment.key?(DEF_KEY)
       end
 
       def build(segment:, **)

data/lib/nodes/if_node.rb

@@ -18,12 +18,12 @@ module Antlers
       @value = value
     end
 
-    def render(current_binding: nil, parent_binding: nil, slot_node: nil)
+    def render(current_binding: nil, parent_binding: nil, slot_node: nil, metadata: {})
       output = ''.dup
 
-      if evaluate(name: @value, current_binding:)
+      if evaluate(value: @value, current_binding:, escape: false)
         @children.each do |child|
-          output += child.render(current_binding:, parent_binding:, slot_node:) || ''
+          output += child.render(current_binding:, parent_binding:, slot_node:, metadata:) || ''
         end
       end
 

data/lib/nodes/prop_node.rb

@@ -15,12 +15,12 @@ module Antlers
       @namespace = namespace
     end
 
-    # Classes referenced via "<{ MyNode }>" must implement class/instance and render/render_template methods (See LowNode).
-    def render(current_binding: nil, parent_binding: nil, slot_node: nil)
+    # Classes referenced via "<{ MyNode }>" must implement class/instance and render/render_template methods (See lownode).
+    def render(current_binding: nil, parent_binding: nil, slot_node: nil, metadata: {})
       props = evaluate_props(props: @props, current_binding:)
-      event = create_render_event(props:)
+      event = possible_render_event(props:)
 
-      # TODO: Get LowLoad to load constants defined in "<{ MyNode }>" syntax so that we can resolve namespace/params on class load.
+      # TODO: Get dirload to load constants defined in "<{ MyNode }>" syntax so that we can resolve namespace/params on class load.
       klass = class_constant(namespace: @namespace&.split('::') || [], name: @name)
       class_proxy = Lowkey[klass.to_s].first[klass.to_s]
 
@@ -44,6 +44,7 @@ module Antlers
 
     def create_instance(class_proxy:, klass:, event:, props:)
       initialize_params = class_proxy.instance_methods[:initialize]&.tagged_params(:keyword)&.map(&:name) || []
+
       return klass.new(event:, **props) if initialize_params.include?(:event) && initialize_params.count > 1
       return klass.new(**props) if initialize_params.count > 1
       return klass.new(event:) if initialize_params.include?(:event)

data/lib/nodes/root_node.rb

@@ -14,7 +14,7 @@ module Antlers
       end
 
       def build(**)
-        new()
+        new
       end
     end
   end

data/lib/nodes/slot_node.rb

@@ -20,9 +20,9 @@ module Antlers
       @namespace = namespace
     end
 
-    def render(current_binding: nil, parent_binding: nil, slot_node: nil)
+    def render(current_binding: nil, parent_binding: nil, slot_node: nil, metadata: {})
       props = evaluate_props(props: @props, current_binding:)
-      event = create_render_event(props:)
+      event = possible_render_event(props:)
 
       # TODO: Get LowLoad to load constants defined in "<{ MyNode }>" syntax so that we can resolve namespace/params on class load.
       klass = class_constant(namespace: @namespace&.split('::') || [], name:)

data/lib/nodes/var_node.rb

@@ -1,7 +1,5 @@
 # frozen_string_literal: true
 
-require 'erb'
-
 require_relative '../interfaces/leaf_node'
 require_relative '../modules/variables'
 
@@ -18,12 +16,8 @@ module Antlers
       @raw = raw
     end
 
-    def render(current_binding: nil, parent_binding: nil, slot_node: nil)
-      result = evaluate(name: @value, current_binding:) || fallback(@value)
-
-      return result if @raw
-
-      ERB::Util.html_escape(result)
+    def render(current_binding: nil, parent_binding: nil, slot_node: nil, metadata: {})
+      evaluate(value: @value, current_binding:, escape: !@raw)
     end
 
     class << self
@@ -32,7 +26,7 @@ module Antlers
       end
 
       def build(segment:, **)
-        new(value: segment[:var] || segment[:raw_var], raw: !!segment[:raw_var])
+        new(value: segment[:var] || segment[:raw_var], raw: !segment[:raw_var].nil?)
       end
     end
   end

data/lib/nodes/yield_node.rb

@@ -9,11 +9,11 @@ module Antlers
     end
 
     # Render the children in the binding of the parent.
-    def render(current_binding: nil, parent_binding:, slot_node:)
+    def render(parent_binding:, slot_node:, current_binding: nil, metadata: {})
       output = ''
 
       slot_node.children.each do |child|
-        output += child.render(current_binding: parent_binding, parent_binding:, slot_node:) || ''
+        output += child.render(current_binding: parent_binding, parent_binding:, slot_node:, metadata:) || ''
       end
 
       output

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: antlers
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.1.1
 platform: ruby
 authors:
 - maedi
@@ -23,20 +23,6 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-- !ruby/object:Gem::Dependency
-  name: low_event
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
 - !ruby/object:Gem::Dependency
   name: lowkey
   requirement: !ruby/object:Gem::Requirement