antlers 1.4.0 → 1.5.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: 5e345f003b2ddcbc49368e2dca56c53b6a951391c665a0df4e2c74c730aa49e8
4
- data.tar.gz: 93451081d3fa7710222a377bb4720ad0d0681a516d3e0ae2216f8db3e7444ee0
3
+ metadata.gz: b7caf18802ef4881de424f56a12f669b0387734b11594a92ca4da432e56452d5
4
+ data.tar.gz: e2774b94f9e0332661e9b7bf5ff9f2c6a37eb70f9eec6cf666945b8411edcb96
5
5
  SHA512:
6
- metadata.gz: a7533d48dc0af7027a292778f682e56a561982718ce9e3e99ee886a10c200d0d30cd90ccedca92d62d3fe8bc9ecf4dae028418019ead16298fb45db201da5619
7
- data.tar.gz: 30435e823d94a88673aeb320bed8dac1e4a1b29634bca6b4dda37c60a8eccf2b3ac4cb41ef55b0470b939dbfdfc5c820fcdd3102cd2287becb16dba6bf9b6cc3
6
+ metadata.gz: 47227e6ee158c6a3415e3664a13c9ea89c69e25cdcee5bbd0c674d1d166f2f6eda5fdc5be9bfc7273f2eada55678a6541faca7239efe04626090d1ec70e7a12b
7
+ data.tar.gz: 199174ab2082ede0fdebe181125c7600bc594bdb1b34420aeb3f23b1bb5eb2d08dc8eec12c89247857c2463e37a0caef283f302d2f1bc456cfe40f4f1150c538
@@ -70,18 +70,18 @@ module Antlers
70
70
  end
71
71
  end
72
72
 
73
- plug(:prop) do
73
+ plug(:solo) do
74
74
  plug(:lexeme) do
75
75
  lazy do
76
- require_relative '../lexemes/prop_lexeme'
77
- PropLexeme
76
+ require_relative '../lexemes/solo_lexeme'
77
+ SoloLexeme
78
78
  end
79
79
  end
80
80
 
81
81
  plug(:node) do
82
82
  lazy do
83
- require_relative '../nodes/prop_node'
84
- PropNode
83
+ require_relative '../nodes/solo_node'
84
+ SoloNode
85
85
  end
86
86
  end
87
87
  end
data/lib/antlers/lexer.rb CHANGED
@@ -8,15 +8,19 @@ module Antlers
8
8
  class Lexer
9
9
  # Only matches when the rest of the segment has balanced quotes, so title='A title = good' isn't split inside its quotes.
10
10
  OUTSIDE_QUOTES = /(?=(?:[^'"]|'[^']*'|"[^"]*")*\z)/
11
+ PROPS = /(=)#{OUTSIDE_QUOTES}|\s+#{OUTSIDE_QUOTES}/
12
+ DELIMITERS = /(#{Regexp.union('<{', '}>')})/
13
+ VAR_DELIMITERS = /(#{Regexp.union('<{', '}>', '{', '}')})/
14
+ # Keywords are compiled once for each set of lexemes, as a lexer's made for each template.
15
+ KEYWORDS = Hash.new { |keywords, words| keywords[words] = /(?<!\S)(#{Regexp.union(words)})(?!\S)#{OUTSIDE_QUOTES}/ }
11
16
 
12
17
  def initialize(lexeme_types:)
13
18
  @lexeme_types = lexeme_types.to_a
14
19
  @var_lexeme = @lexeme_types.find { it == VarLexeme }
15
20
 
16
- @delimiters = ['<{', '}>']
17
- @delimiters = [*@delimiters, '{', '}'] if @var_lexeme
18
-
19
- @keywords = @lexeme_types.flat_map { |lexeme| lexeme.const_get(:KEYWORDS) }
21
+ @delimiters = DELIMITERS
22
+ @delimiters = VAR_DELIMITERS if @var_lexeme
23
+ @keywords = KEYWORDS[@lexeme_types.flat_map { |lexeme| lexeme.const_get(:KEYWORDS) }]
20
24
  @cursor = 0
21
25
  end
22
26
 
@@ -26,7 +30,7 @@ module Antlers
26
30
 
27
31
  # Split on delimiters and retain capture groups.
28
32
  # Whitespace inside the template is kept, but not around it, like the indentation of a template in a method body.
29
- segments = template.strip.split(/(#{Regexp.union(@delimiters)})/)
33
+ segments = template.strip.split(@delimiters)
30
34
 
31
35
  until segments[@cursor].nil?
32
36
  if (segment = antlers_segment(segments:))
@@ -59,8 +63,9 @@ module Antlers
59
63
 
60
64
  name, props, keywords = parse_antlers_segment(segment:)
61
65
 
62
- lexeme = @lexeme_types.find { it.match?(name:, keywords:) }
63
- return lexeme.lexeme(name:, props:, keywords:) if lexeme
66
+ # The segment is the directive as it's written, for a lexeme that reads it its own way.
67
+ lexeme = @lexeme_types.find { it.match?(name:, keywords:, segment:) }
68
+ return lexeme.lexeme(name:, props:, keywords:, segment:) if lexeme
64
69
 
65
70
  return @var_lexeme.lexeme(segment:, raw: true) if @var_lexeme && deerheads?(segments:)
66
71
 
@@ -70,8 +75,8 @@ module Antlers
70
75
  # Keywords are whole words, so a name like "Plain::Card" isn't split on the "in:" in it.
71
76
  # Props are split into tokens like ['title', '=', "'A title'", 'size', '=', '2'].
72
77
  def parse_antlers_segment(segment:)
73
- name_and_props, *keywords = segment.split(/(?<!\S)(#{Regexp.union(@keywords)})(?!\S)#{OUTSIDE_QUOTES}/)
74
- name, *props = name_and_props.split(/(=)#{OUTSIDE_QUOTES}|\s+#{OUTSIDE_QUOTES}/).reject(&:empty?)
78
+ name_and_props, *keywords = segment.split(@keywords)
79
+ name, *props = name_and_props.split(PROPS).reject(&:empty?)
75
80
  [name, props, parse_keywords(keywords:)]
76
81
  end
77
82
 
@@ -1,5 +1,5 @@
1
1
  # frozen_string_literal: true
2
2
 
3
3
  module Antlers
4
- VERSION = '1.4.0'
4
+ VERSION = '1.5.1'
5
5
  end
data/lib/antlers.rb CHANGED
@@ -9,20 +9,20 @@ require_relative 'antlers/translations'
9
9
  module Antlers
10
10
  module_function
11
11
 
12
- DEFAULT_ELEMENTS = %i[root html form for if prop slot yield var].freeze
12
+ DEFAULT_ELEMENTS = %i[root html form for if solo slot yield var].freeze
13
13
 
14
14
  def ast(template:, namespace: nil, elements: Elements[*DEFAULT_ELEMENTS])
15
15
  sequence = Lexer.new(lexeme_types: elements[:lexeme]).parse(template:)
16
16
  Parser.new(namespace:, node_types: elements[:node]).parse(sequence:, template:)
17
17
  end
18
18
 
19
- def render(ast:, current_binding:, parent_binding: nil, slot_node: nil, metadata: {})
20
- ast.render(current_binding:, parent_binding:, slot_node:, metadata:)
19
+ def render(ast:, current_binding:, parent_binding: nil, slot_node: nil, context: {})
20
+ ast.render(current_binding:, parent_binding:, slot_node:, context:)
21
21
  end
22
22
 
23
- # Call once an app has loaded, to find prop nodes built before their class loaded.
24
- # Returns the prop nodes whose class is still undefined, which look up their class when first rendered.
23
+ # Call once an app has loaded, to find solo nodes built before their class loaded.
24
+ # Returns the solo nodes whose class is still undefined, which look up their class when first rendered.
25
25
  def resolve_nodes
26
- PropNode.resolve
26
+ SoloNode.resolve
27
27
  end
28
28
  end
@@ -11,7 +11,7 @@ module Antlers
11
11
  @name = name
12
12
  end
13
13
 
14
- def render(current_binding: nil, parent_binding: nil, slot_node: nil, namespace: nil, metadata: {})
14
+ def render(current_binding: nil, parent_binding: nil, slot_node: nil, namespace: nil, context: {})
15
15
  raise NotImplementedError
16
16
  end
17
17
 
@@ -12,11 +12,11 @@ module Antlers
12
12
  @children = children
13
13
  end
14
14
 
15
- def render(current_binding: nil, parent_binding: nil, slot_node: nil, metadata: {})
15
+ def render(current_binding: nil, parent_binding: nil, slot_node: nil, context: {})
16
16
  output = ''
17
17
 
18
18
  @children.each do |child|
19
- output += child.render(current_binding:, parent_binding:, slot_node:, metadata:) || ''
19
+ output += child.render(current_binding:, parent_binding:, slot_node:, context:) || ''
20
20
  end
21
21
 
22
22
  output
@@ -4,7 +4,7 @@ module Antlers
4
4
  module Lexeme
5
5
  KEYWORDS = [].freeze
6
6
 
7
- def match?(name: nil, keywords: {}) = false
7
+ def match?(name: nil, keywords: {}, segment: nil) = false
8
8
 
9
9
  def lexeme(name:, props:, keywords:, segment: nil, raw: false)
10
10
  raise NotImplementedError
@@ -3,7 +3,7 @@
3
3
  require_relative '../interfaces/lexeme'
4
4
 
5
5
  module Antlers
6
- module PropLexeme
6
+ module SoloLexeme
7
7
  include Lexeme
8
8
  extend self
9
9
 
@@ -12,9 +12,9 @@ module Antlers
12
12
  end
13
13
 
14
14
  def lexeme(name:, props:, **)
15
- prop = { prop: name }
16
- prop[:props] = props(props) unless props.empty?
17
- prop
15
+ solo = { solo: name }
16
+ solo[:props] = props(props) unless props.empty?
17
+ solo
18
18
  end
19
19
  end
20
20
  end
@@ -20,7 +20,7 @@ module Antlers
20
20
  @key = key
21
21
  end
22
22
 
23
- def render(current_binding: nil, parent_binding: nil, slot_node: nil, metadata: {})
23
+ def render(current_binding: nil, parent_binding: nil, slot_node: nil, context: {})
24
24
  output = ''
25
25
 
26
26
  evaluate(value: @items, current_binding:, escape: false).each do |value|
@@ -31,7 +31,7 @@ module Antlers
31
31
  current_binding.local_variable_set(@key, key) if @key
32
32
 
33
33
  @children.each do |child|
34
- output += child.render(current_binding:, parent_binding:, slot_node:, metadata:) || ''
34
+ output += child.render(current_binding:, parent_binding:, slot_node:, context:) || ''
35
35
  end
36
36
  end
37
37
 
@@ -19,11 +19,11 @@ module Antlers
19
19
  @method = method
20
20
  end
21
21
 
22
- def render(current_binding: nil, parent_binding: nil, slot_node: nil, metadata: {})
22
+ def render(current_binding: nil, parent_binding: nil, slot_node: nil, context: {})
23
23
  output = "<form action='#{action(current_binding:)}' method='#{@method}'>"
24
24
 
25
25
  @children.each do |child|
26
- output += child.render(current_binding:, parent_binding:, slot_node:, metadata:) || ''
26
+ output += child.render(current_binding:, parent_binding:, slot_node:, context:) || ''
27
27
  end
28
28
 
29
29
  output += '</form>'
data/lib/nodes/if_node.rb CHANGED
@@ -18,12 +18,12 @@ module Antlers
18
18
  @value = value
19
19
  end
20
20
 
21
- def render(current_binding: nil, parent_binding: nil, slot_node: nil, metadata: {})
21
+ def render(current_binding: nil, parent_binding: nil, slot_node: nil, context: {})
22
22
  output = ''.dup
23
23
 
24
24
  if evaluate(value: @value, current_binding:, escape: false)
25
25
  @children.each do |child|
26
- output += child.render(current_binding:, parent_binding:, slot_node:, metadata:) || ''
26
+ output += child.render(current_binding:, parent_binding:, slot_node:, context:) || ''
27
27
  end
28
28
  end
29
29
 
@@ -21,7 +21,7 @@ module Antlers
21
21
  @namespace = namespace
22
22
  end
23
23
 
24
- def render(current_binding: nil, parent_binding: nil, slot_node: nil, metadata: {})
24
+ def render(current_binding: nil, parent_binding: nil, slot_node: nil, context: {})
25
25
  props = evaluate_props(props: @props, current_binding:)
26
26
  event = possible_render_event(props:, current_binding:)
27
27
 
@@ -36,13 +36,13 @@ module Antlers
36
36
 
37
37
  # Without a class template, a component's own render method can receive its slot's rendered children as slot:.
38
38
  render_method = instance.method(:render)
39
- keywords[:slot] = slot(current_binding:, metadata:) if Keywords.takes?(render_method, :slot)
39
+ keywords[:slot] = slot(current_binding:, context:) if Keywords.takes?(render_method, :slot)
40
40
  instance.render(**Keywords.accepted(render_method, keywords))
41
41
  end
42
42
 
43
43
  # The children rendered in the binding the slot is in, like a yield in a template renders them.
44
- def slot(current_binding:, metadata:)
45
- @children.map { |child| child.render(current_binding:, parent_binding: current_binding, slot_node: self, metadata:) || '' }.join
44
+ def slot(current_binding:, context:)
45
+ @children.map { |child| child.render(current_binding:, parent_binding: current_binding, slot_node: self, context:) || '' }.join
46
46
  end
47
47
 
48
48
  def end_name
@@ -6,7 +6,7 @@ require_relative '../modules/namespace'
6
6
  require_relative '../modules/props'
7
7
 
8
8
  module Antlers
9
- class PropNode < LeafNode
9
+ class SoloNode < LeafNode
10
10
  include Namespace
11
11
  include Props # Immediate parent ancestor that super() refers to.
12
12
 
@@ -16,7 +16,7 @@ module Antlers
16
16
  @namespace = namespace
17
17
 
18
18
  # A class defined in a file that hasn't loaded yet is pending until "Antlers.resolve_nodes" or its first render.
19
- PropNode.pending << self unless resolve
19
+ SoloNode.pending << self unless resolve
20
20
  end
21
21
 
22
22
  # Whether the prop's class is defined.
@@ -25,7 +25,7 @@ module Antlers
25
25
  end
26
26
 
27
27
  # Classes referenced via "<{ MyNode }>" must implement class/instance and render/render_template methods (See lownode).
28
- def render(current_binding: nil, parent_binding: nil, slot_node: nil, metadata: {})
28
+ def render(current_binding: nil, parent_binding: nil, slot_node: nil, context: {})
29
29
  props = evaluate_props(props: @props, current_binding:)
30
30
  event = possible_render_event(props:, current_binding:)
31
31
 
@@ -52,11 +52,11 @@ module Antlers
52
52
  end
53
53
 
54
54
  def match?(segment:)
55
- segment[:prop]
55
+ segment[:solo]
56
56
  end
57
57
 
58
58
  def build(segment:, namespace:, **)
59
- new(name: segment[:prop], props: segment[:props], namespace:)
59
+ new(name: segment[:solo], props: segment[:props], namespace:)
60
60
  end
61
61
  end
62
62
 
@@ -20,7 +20,7 @@ module Antlers
20
20
  @translatable = Queries.translatable?(value.strip)
21
21
  end
22
22
 
23
- def render(current_binding: nil, parent_binding: nil, slot_node: nil, metadata: {})
23
+ def render(current_binding: nil, parent_binding: nil, slot_node: nil, context: {})
24
24
  return evaluate(value: @value, current_binding:, escape: !@raw).to_s unless @translatable
25
25
 
26
26
  result = Translations.translate(result(value: @value, current_binding:))
@@ -9,11 +9,11 @@ module Antlers
9
9
  end
10
10
 
11
11
  # Render the children in the binding of the parent.
12
- def render(parent_binding:, slot_node:, current_binding: nil, metadata: {})
12
+ def render(parent_binding:, slot_node:, current_binding: nil, context: {})
13
13
  output = ''
14
14
 
15
15
  slot_node.children.each do |child|
16
- output += child.render(current_binding: parent_binding, parent_binding:, slot_node:, metadata:) || ''
16
+ output += child.render(current_binding: parent_binding, parent_binding:, slot_node:, context:) || ''
17
17
  end
18
18
 
19
19
  output
metadata CHANGED
@@ -1,7 +1,7 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: antlers
3
3
  version: !ruby/object:Gem::Version
4
- version: 1.4.0
4
+ version: 1.5.1
5
5
  platform: ruby
6
6
  authors:
7
7
  - maedi
@@ -60,8 +60,8 @@ files:
60
60
  - lib/lexemes/for_lexeme.rb
61
61
  - lib/lexemes/form_lexeme.rb
62
62
  - lib/lexemes/if_lexeme.rb
63
- - lib/lexemes/prop_lexeme.rb
64
63
  - lib/lexemes/slot_lexeme.rb
64
+ - lib/lexemes/solo_lexeme.rb
65
65
  - lib/lexemes/var_lexeme.rb
66
66
  - lib/lexemes/yield_lexeme.rb
67
67
  - lib/modules/namespace.rb
@@ -71,9 +71,9 @@ files:
71
71
  - lib/nodes/form_node.rb
72
72
  - lib/nodes/html_node.rb
73
73
  - lib/nodes/if_node.rb
74
- - lib/nodes/prop_node.rb
75
74
  - lib/nodes/root_node.rb
76
75
  - lib/nodes/slot_node.rb
76
+ - lib/nodes/solo_node.rb
77
77
  - lib/nodes/var_node.rb
78
78
  - lib/nodes/yield_node.rb
79
79
  - lib/support/queries.rb
@@ -96,7 +96,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
96
96
  - !ruby/object:Gem::Version
97
97
  version: '0'
98
98
  requirements: []
99
- rubygems_version: 4.0.6
99
+ rubygems_version: 4.0.20
100
100
  specification_version: 4
101
101
  summary: Templating language inside HTML inside Ruby
102
102
  test_files: []