antlers 1.3.0 → 1.4.0

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: 3e2171b35a91ba36a0d5e6170d7da64bb15028a5b26e65eeee7c5427ec8ddb8d
4
- data.tar.gz: '09633300573cff4fdf4254bc6e04c67d6ee3aefc0619c83eeb721777b2ce1298'
3
+ metadata.gz: 5e345f003b2ddcbc49368e2dca56c53b6a951391c665a0df4e2c74c730aa49e8
4
+ data.tar.gz: 93451081d3fa7710222a377bb4720ad0d0681a516d3e0ae2216f8db3e7444ee0
5
5
  SHA512:
6
- metadata.gz: 5c521ea635616f24c9242d4154813005d0ba680220629dcea1691adeded1f282aed438b87cc061c60b41220a4799d850655d58a7a686b5af06ccccae6b017bf1
7
- data.tar.gz: b5bc4aae08ef50e06c4aa90bbd053313db39a952fab71cf77971bbfa1134058493356ee191aea2756ceedd15dc51f08cf323fe9480fc29e4e306eceba3bab707
6
+ metadata.gz: a7533d48dc0af7027a292778f682e56a561982718ce9e3e99ee886a10c200d0d30cd90ccedca92d62d3fe8bc9ecf4dae028418019ead16298fb45db201da5619
7
+ data.tar.gz: 30435e823d94a88673aeb320bed8dac1e4a1b29634bca6b4dda37c60a8eccf2b3ac4cb41ef55b0470b939dbfdfc5c820fcdd3102cd2287becb16dba6bf9b6cc3
data/lib/antlers/api.rb CHANGED
@@ -8,5 +8,6 @@ require_relative '../interfaces/branch_node'
8
8
  require_relative '../interfaces/leaf_node'
9
9
  require_relative '../modules/props'
10
10
  require_relative '../modules/variables'
11
+ require_relative '../support/queries'
11
12
 
12
13
  # Usage: require 'antlers/api'
@@ -1,5 +1,5 @@
1
1
  # frozen_string_literal: true
2
2
 
3
3
  module Antlers
4
- VERSION = '1.3.0'
4
+ VERSION = '1.4.0'
5
5
  end
@@ -20,8 +20,19 @@ module Antlers
20
20
  end
21
21
 
22
22
  # Support sending an event to render_template hook when lowevent available. See lownode as an example implementation.
23
- def possible_render_event(props:)
24
- Low::Events::RenderEvent.new(action: :render, props:) if defined?(Low::Events::RenderEvent)
23
+ def possible_render_event(props:, current_binding: nil)
24
+ return unless defined?(Low::Events::RenderEvent)
25
+ return Low::Events::RenderEvent.new(action: :render, props:) unless Low::Events::RenderEvent.members.include?(:params)
26
+
27
+ Low::Events::RenderEvent.new(action: :render, props:, params: parent_params(current_binding:))
28
+ end
29
+
30
+ # The parent node's event (a RouteEvent or RenderEvent) is the "event" local variable on its binding.
31
+ def parent_params(current_binding:)
32
+ return {} unless current_binding&.local_variable_defined?(:event)
33
+
34
+ event = current_binding.local_variable_get(:event)
35
+ (event.params if event.respond_to?(:params)) || {}
25
36
  end
26
37
 
27
38
  class << self
@@ -1,12 +1,10 @@
1
1
  # frozen_string_literal: true
2
2
 
3
3
  require_relative '../interfaces/lexeme'
4
- require_relative '../support/queries'
5
4
 
6
5
  module Antlers
7
6
  module VarLexeme
8
7
  include Lexeme
9
- extend Queries
10
8
  extend self
11
9
 
12
10
  # Variables are special and are matched by the lexer in a hard-coded fashion.
@@ -1,23 +1,22 @@
1
1
  # frozen_string_literal: true
2
2
 
3
- require 'erb'
3
+ require 'cgi/escape'
4
4
  require 'lowkey'
5
+
5
6
  require_relative '../support/queries'
6
7
 
7
8
  module Antlers
8
9
  module Variables
9
- extend Queries
10
-
11
10
  # Evaluation limited to the following for security and to stop a templating language becoming a programming language.
12
11
  # 1. A value ('string', 3, 1.5, true, nil or :symbol)
13
12
  # 2. Invalid string ("Hi #{name}", 'it's', 'a' + 'b')
14
13
  # 3. An instance variable
15
14
  # 4. A method call/local variable
16
- # 5. A method chain
15
+ # 5. A nested path (a hash's key, an array's or string's basic methods, an object's public method)
17
16
  def evaluate(value:, current_binding:, escape: true)
18
17
  result = result(value:, current_binding:)
19
18
 
20
- return ERB::Util.html_escape(result) if escape
19
+ return CGI.escapeHTML(result.to_s) if escape
21
20
 
22
21
  result
23
22
  end
@@ -34,10 +33,10 @@ module Antlers
34
33
  private
35
34
 
36
35
  def variable(value:, current_binding:)
37
- name, *chain = value.split('.')
36
+ name, *path = value.split('.')
38
37
 
39
38
  result = method_var(name:, current_binding:)
40
- return method_chain(result:, chain:) if chain.count > 0
39
+ return Queries.read_path(value: result, path:) if path.count > 0
41
40
 
42
41
  result
43
42
  end
@@ -49,11 +48,5 @@ module Antlers
49
48
 
50
49
  nil
51
50
  end
52
-
53
- def method_chain(result:, chain:)
54
- chain.reduce(result) do |result, method_call|
55
- result&.send(method_call.to_sym)
56
- end
57
- end
58
51
  end
59
52
  end
@@ -27,7 +27,7 @@ module Antlers
27
27
  # Classes referenced via "<{ MyNode }>" must implement class/instance and render/render_template methods (See lownode).
28
28
  def render(current_binding: nil, parent_binding: nil, slot_node: nil, metadata: {})
29
29
  props = evaluate_props(props: @props, current_binding:)
30
- event = possible_render_event(props:)
30
+ event = possible_render_event(props:, current_binding:)
31
31
 
32
32
  klass = node_class || raise(NameError, "uninitialized constant #{@name}")
33
33
 
@@ -23,7 +23,7 @@ module Antlers
23
23
 
24
24
  def render(current_binding: nil, parent_binding: nil, slot_node: nil, metadata: {})
25
25
  props = evaluate_props(props: @props, current_binding:)
26
- event = possible_render_event(props:)
26
+ event = possible_render_event(props:, current_binding:)
27
27
 
28
28
  klass = class_constant(namespace: @namespace&.split('::') || [], name:)
29
29
  keywords = props.merge(event:)
@@ -1,5 +1,6 @@
1
1
  # frozen_string_literal: true
2
2
 
3
+ require 'cgi/escape'
3
4
  require_relative '../interfaces/leaf_node'
4
5
  require_relative '../modules/variables'
5
6
  require_relative '../antlers/translations'
@@ -23,7 +24,7 @@ module Antlers
23
24
  return evaluate(value: @value, current_binding:, escape: !@raw).to_s unless @translatable
24
25
 
25
26
  result = Translations.translate(result(value: @value, current_binding:))
26
- (@raw ? result : ERB::Util.html_escape(result)).to_s
27
+ (@raw ? result : CGI.escapeHTML(result.to_s)).to_s
27
28
  end
28
29
 
29
30
  class << self
@@ -2,6 +2,10 @@
2
2
 
3
3
  module Antlers
4
4
  module Queries
5
+ BASIC_TYPES = [Symbol, Numeric, TrueClass, FalseClass, NilClass].freeze
6
+ ENUMERABLE_ALLOWLIST = %w[first last size].freeze
7
+ STRING_ALLOWLIST = %w[upcase downcase].freeze
8
+
5
9
  class << self
6
10
  def user_defined_string?(string)
7
11
  wrapped_in?(string, "'") || wrapped_in?(string, '"')
@@ -15,6 +19,44 @@ module Antlers
15
19
  def wrapped_in?(string, delimeter)
16
20
  string[0] == delimeter && string[-1] == delimeter
17
21
  end
22
+
23
+ def read_path(value:, path:)
24
+ path.reduce(value) do |current_value, key|
25
+ case current_value
26
+ when Hash then read_hash(current_value, key:)
27
+ when Array then read_array(current_value, key:)
28
+ when String then read_string(current_value, key:)
29
+ when *BASIC_TYPES then nil
30
+ else current_value.public_send(key.to_sym)
31
+ end
32
+ end
33
+ end
34
+
35
+ private
36
+
37
+ def read_hash(hash, key:)
38
+ hash.fetch(key) do
39
+ hash.fetch(key.to_sym) do
40
+ call_enumerable_method(hash, key:)
41
+ end
42
+ end
43
+ end
44
+
45
+ def read_array(array, key:)
46
+ index = Integer(key, exception: false)
47
+ return array[index] if index
48
+
49
+ call_enumerable_method(array, key:)
50
+ end
51
+
52
+ def read_string(string, key:)
53
+ string.public_send(key) if STRING_ALLOWLIST.include?(key)
54
+ end
55
+
56
+ def call_enumerable_method(enumerable, key:)
57
+ # A hash has no last method so fail gracefully.
58
+ enumerable.public_send(key) if ENUMERABLE_ALLOWLIST.include?(key) && enumerable.respond_to?(key)
59
+ end
18
60
  end
19
61
  end
20
62
  end
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.3.0
4
+ version: 1.4.0
5
5
  platform: ruby
6
6
  authors:
7
7
  - maedi
@@ -9,20 +9,6 @@ bindir: exe
9
9
  cert_chain: []
10
10
  date: 1980-01-02 00:00:00.000000000 Z
11
11
  dependencies:
12
- - !ruby/object:Gem::Dependency
13
- name: erb
14
- requirement: !ruby/object:Gem::Requirement
15
- requirements:
16
- - - ">="
17
- - !ruby/object:Gem::Version
18
- version: '0'
19
- type: :runtime
20
- prerelease: false
21
- version_requirements: !ruby/object:Gem::Requirement
22
- requirements:
23
- - - ">="
24
- - !ruby/object:Gem::Version
25
- version: '0'
26
12
  - !ruby/object:Gem::Dependency
27
13
  name: lowkey
28
14
  requirement: !ruby/object:Gem::Requirement