antlers 0.3.0 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 57d224246ca8ba02aac3045b0f06904d8cebb0cfdb7f3d518d3c646324a1e3b6
-  data.tar.gz: e8b7787ccfc284dbb1d370292ba4238576e346c75bc957d5da70067220635ba7
+  metadata.gz: 181c1f53191d4d32c458d74cc67b1d97082d0c023631b0af0fe726dc0db86d9e
+  data.tar.gz: 010ab20070af4634c783f2aa8573f8fa69be674bf96451df15e59f434cc8fa90
 SHA512:
-  metadata.gz: b4cb6632bbbafb3ec12cc27256b2ae9e2134e3b621e28a7edcfd269bfff828d128cd0f659d7135a734b7792d121477c0ca012c3215a1eef442d3106bb637e89d
-  data.tar.gz: 0a0f5f6fc83e72a7253a737956c3a4cff5961999722b23b96ad44716b3ad2b2e40ce7742145cea8610f9604467a438a12000a0609cd9408487f85472f362cb3d
+  metadata.gz: d50a398b59defec9de55b59e45c3bd1b57d56f846221b6e00bbd080522909225f6a9e62cd6bc7326b30d60322faf30fbaecf41cada8ed04caa076bafc44be1d0
+  data.tar.gz: 4c8e9d78e0ee5ce5fbb6dcdb1c76e3ebd91f1c2600cd6accbb066cce81ccad9038aed99f65c6f3c28c99265dcfe7a95729bae02f07ca17283d81821153e7f9ae

data/lib/factories/node_factory.rb

@@ -10,7 +10,8 @@ module Antlers
   class NodeFactory
     class << self
       def for_node(segment:)
-        ForNode.new(name: segment[:for_def], item: segment[:for_def], items: segment[:in])
+        value, key, items = segment.values_at(:for_def, :key, :in)
+        ForNode.new(name: value, key:, value:, items:)
       end
 
       def prop_node(segment:)

data/lib/lexer.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-require_relative 'queries'
+require_relative 'support/queries'
 
 module Antlers
   extend Queries
@@ -67,12 +67,12 @@ module Antlers
     end
 
     def var?(segments:)
-      first, middle, last = segments[@cursor..@cursor + 3].map(&:strip)
+      first, _, last = segments[@cursor..@cursor + 3].map(&:strip)
       first == '{' && last == '}'
     end
 
     def for_loop?(keywords:)
-      keywords.first == 'for:' || keywords.first == ':for'
+      ['for:', ':for'].include?(keywords.first)
     end
 
     def slot?(name)
@@ -89,19 +89,18 @@ module Antlers
 
     def var(antlers_segment:)
       # String is already interpolated or not depending on user input on the template layer, now we store it without those template quotes.
-      if Queries.user_defined_string?(antlers_segment)
-        antlers_segment = antlers_segment[1..-2]
-      end
+      antlers_segment = antlers_segment[1..-2] if Queries.user_defined_string?(antlers_segment)
 
       { var: antlers_segment }
     end
 
     def for_loop(keywords:)
-      key_values = keywords.count % 2 == 0 ? keywords.each_slice(2).to_h : {}
+      key_values = keywords.count.even? ? keywords.each_slice(2).to_h : {}
 
       if key_values['for:']
-        for_def = { for_def: key_values['for:'] }
-        for_def[:in] = key_values['in:']
+        *key, value = key_values['for:'].split(',').map(&:strip)
+        for_def = { for_def: value, in: key_values['in:'] }
+        for_def[:key] = key.first unless key.empty?
         return for_def
       end
 

data/lib/modules/props.rb

@@ -1,9 +1,12 @@
 # frozen_string_literal: true
 
 require 'low_event'
+require_relative 'variables'
 
 module Antlers
   module Props
+    include Variables
+
     attr_accessor :props
 
     def initialize(name:, props: {}, **)
@@ -24,13 +27,7 @@ module Antlers
       evaluated_props = {}
 
       props.each do |name, value|
-        receiver = current_binding.receiver
-        
-        if receiver.respond_to?(value.to_sym)
-          evaluated_props[name] = receiver.send(value.to_sym) 
-        elsif value.start_with?('@')
-          evaluated_props[name] = receiver.instance_variable_get(value)
-        end
+        evaluated_props[name] = evaluate(name: value, current_binding:) || fallback(value)
       end
 
       evaluated_props

data/lib/modules/variables.rb

@@ -1,19 +1,48 @@
+require_relative '../support/queries'
+
 module Antlers
   module Variables
-    # A variable is deliberately limited in what it can represent.
+    extend Queries
+
+    # Evaluation limited to the following for security and to prevent a templating language becoming a programming language.
     #  1. An instance variable
     #  2. A method call/local variable
-    #  3. A static string
-    def evaluate_variable(name:, current_binding:)
-      if current_binding
-        return current_binding.receiver.instance_variable_get(name) if name.start_with?('@')
-        return current_binding.local_variable_get(name) if current_binding.local_variable_defined?(name)
-        return current_binding.receiver.send(name.to_sym) if current_binding.receiver.respond_to?(name.to_sym)
-      end
+    #  3. A method chain
+    #  4. A static string
+    def evaluate(name:, current_binding:)
+      return name.to_s unless current_binding
+
+      name, *chain = name.split('.')
+
+      result = method_var(name:, current_binding:)
+      return method_chain(result:, chain:, current_binding:) 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.to_s
-    rescue NameError
-      @value.to_s
+      value
+    end
+
+    private
+
+    def method_var(name:, current_binding:)
+      return current_binding.receiver.instance_variable_get(name) if name.start_with?('@')
+      return current_binding.local_variable_get(name) if current_binding.local_variable_defined?(name)
+      return current_binding.receiver.send(name.to_sym) if current_binding.receiver.respond_to?(name.to_sym)
+
+      nil
+    end
+
+    def method_chain(result:, chain:, current_binding:)
+      chain.reduce(result) do |result, method_call|
+        result.send(method_call.to_sym)
+      end
     end
   end
 end

data/lib/nodes/for_node.rb

@@ -11,18 +11,23 @@ module Antlers
 
     attr_accessor :children
 
-    def initialize(name:, item:, items:, props: [], children: [])
+    def initialize(name:, items:, value:, key: nil, props: [], children: [])
       super(name:, props:, children:)
 
-      @item = item
       @items = items
+      @value = value
+      @key = key
     end
 
     def render(current_binding: nil, parent_binding: nil, slot_node: nil, namespace: nil)
       output = ''
 
-      evaluate_variable(name: @items, current_binding:).each do |item|
-        current_binding.local_variable_set(@item, item)
+      evaluate(name: @items, current_binding:).each do |value|
+        key, value = value if @key
+
+        # TODO: Parallelize by creating new bindings and ensuring children have any args they need via RenderEvent.
+        current_binding.local_variable_set(@value, value)
+        current_binding.local_variable_set(@key, key) if @key
 
         @children.each do |child|
           # Antlers nodes respond to "render", whereas HTML is stored as a string and output as is.

data/lib/nodes/prop_node.rb

@@ -12,7 +12,10 @@ module Antlers
       event = create_render_event(props:)
 
       renderable_klass = class_from_namespace(namespace: namespace&.split('::') || [], name: @name)
-      renderable_instance = renderable_klass.new(event:)
+      # TODO: There's currently 2 results for "Lowkey[renderable_klass.to_s]", this should not be.
+      # TODO: Only provide args that are defined, similar to how render_template does it.
+      initialize_method = Lowkey[renderable_klass.to_s].first[renderable_klass.to_s][:initialize]
+      renderable_instance = initialize_method ? renderable_klass.new(event:, **props) : renderable_klass.new(event:)
 
       # Classes referenced via "<{ ChildNode }>" must implement class/instance render/render_template methods (See LowNode).
       return renderable_instance.render_template(event:, parent_binding:, props:) if renderable_klass.template

data/lib/nodes/var_node.rb

@@ -11,14 +11,14 @@ module Antlers
 
     attr_reader :value
 
-    def initialize(name: :var, value:)
+    def initialize(value:, name: :var)
       super(name:)
 
       @value = value
     end
 
     def render(current_binding: nil, parent_binding: nil, slot_node: nil, namespace: nil)
-      ERB::Util.html_escape(evaluate_variable(name: @value, current_binding:) || @value)
+      ERB::Util.html_escape(evaluate(name: @value, current_binding:) || fallback(@value))
     end
   end
 end

data/lib/nodes/yield_node.rb

@@ -14,7 +14,11 @@ module Antlers
 
       slot_node.children.each do |child|
         # Antlers nodes respond to "render", whereas HTML is stored as a string and output as is.
-        output += (child.respond_to?(:render) ? child.render(current_binding: parent_binding, parent_binding: nil, slot_node: nil, namespace:) : child) || ''
+        if child.respond_to?(:render) # rubocop:disable Style/ConditionalAssignment
+          output += child.render(current_binding: parent_binding, parent_binding: nil, slot_node: nil, namespace:)
+        else
+          output += child || ''
+        end
       end
 
       output

data/lib/{queries.rb → support/queries.rb}

@@ -4,7 +4,7 @@ module Antlers
   module Queries
     class << self
       def user_defined_string?(string)
-        wrapped_in?(string, %q{'}) || wrapped_in?(string, %q{"})
+        wrapped_in?(string, "'") || wrapped_in?(string, '"')
       end
 
       def wrapped_in?(string, delimeter)

data/lib/version.rb

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: antlers
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.5.0
 platform: ruby
 authors:
 - maedi
@@ -10,7 +10,7 @@ cert_chain: []
 date: 1980-01-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: low_event
+  name: erb
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -24,7 +24,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: erb
+  name: low_event
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -59,7 +59,7 @@ files:
 - lib/nodes/var_node.rb
 - lib/nodes/yield_node.rb
 - lib/parser.rb
-- lib/queries.rb
+- lib/support/queries.rb
 - lib/version.rb
 homepage: https://codeberg.org/raindeer/antlers
 licenses: []