antlers 0.9.0 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f16d22b587d7dbdc07a0a51fc19032271be9347e90eb09c77541a56099f8088f
-  data.tar.gz: b1437b4cac8a748fc23fc6eaf06c07e5d3111d63d5100651afb9195f488dacfb
+  metadata.gz: 375ebfb2e841c81843bb17b1025d8cd43dbe851f803f4845afb73f6d24f8ef30
+  data.tar.gz: a7db1372364cb6633b6ce6ae2492966ecf1c6d2a20f3d7af214ce14e18feda21
 SHA512:
-  metadata.gz: ecc5de204a45f9cda60f03aeefc49aee735fc9aa3da5fd20b1d12959497bfb4683ab299bd64d4ae8795b3296ab9e018c8b8eb70672f3788aeeeaf8355f03d07e
-  data.tar.gz: 0b14edede169971914c9958f4b3369c361271566d36c883dd3c1774ef968e8299d2d95c58a90e921ea2bbae5d70f4a2634c8ce00217e058c2ee6c71a9ec3a42f
+  metadata.gz: c0b9b231ebe71d01f50443bebcec9210c3f97fe238138d172974ef5c298d5c543af1371a3806f45e54cc8e5a6a8cb32d6e51e17547465ed96682a633393c0ca4
+  data.tar.gz: d7c42c19f7c1aa9a5bcb27d30fe2fe0118054897bb5e2388f266b7127bf6c89bdc35b7da4fa20e39f969a20f6a7a2ce9c6e8325ac32e0a9f78720b85a06bb21c

data/lib/antlers/api.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+require_relative 'elements'
+require_relative 'lexer'
+require_relative 'parser'
+require_relative '../interfaces/lexeme'
+require_relative '../interfaces/branch_node'
+require_relative '../interfaces/leaf_node'
+require_relative '../modules/props'
+require_relative '../modules/variables'
+
+# Usage: require 'antlers/api'

data/lib/antlers/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Antlers
-  VERSION = '0.9.0'
+  VERSION = '1.1.0'
 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]
 
-  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/modules/props.rb

@@ -1,6 +1,5 @@
 # frozen_string_literal: true
 
-require 'low_event'
 require_relative 'variables'
 
 module Antlers
@@ -17,10 +16,6 @@ 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?
 

data/lib/nodes/for_node.rb

@@ -20,7 +20,7 @@ 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|
@@ -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,11 +19,11 @@ module Antlers
       @method = method
     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 = "<form action='#{@action}' 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>'

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:)
         @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

@@ -18,7 +18,7 @@ module Antlers
       @raw = raw
     end
 
-    def render(current_binding: nil, parent_binding: nil, slot_node: nil)
+    def render(current_binding: nil, parent_binding: nil, slot_node: nil, metadata: {})
       result = evaluate(name: @value, current_binding:) || fallback(@value)
 
       return result if @raw

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: 0.9.0
+  version: 1.1.0
 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
@@ -74,6 +60,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - lib/antlers.rb
+- lib/antlers/api.rb
 - lib/antlers/elements.rb
 - lib/antlers/lexer.rb
 - lib/antlers/parser.rb