antlers 1.2.3 → 1.3.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: bb164dc9fe0a7028143fb9ee9550231e3be407bb5561ab08e454a79d6f2bac35
4
- data.tar.gz: 88d3a6d1ca5cc268b5f23498783d6cda88b363b4cb3ea5ef38f832b0220f3add
3
+ metadata.gz: 6e220f38c25950fe7a5a59fc1908baf9d3fb623ee6855a25f4556387b0ed5cbf
4
+ data.tar.gz: c58bc67992e37f1be57268758db76dfe656e597748c21544db5fa9c6c9f233a3
5
5
  SHA512:
6
- metadata.gz: 037fe04a5654399195cd96f73cd06223027e96625b77bb1f1701bdc9cb4f74a457aa61432a369f25d9af315ce8ff1ba691420d4b35c67492014c57bfe0b9f314
7
- data.tar.gz: aa1c8ad96c830b9cb392c3630e3c5e0c83dff95d9e56ca2fa10c9f39ce2cd8d9de27d94ab551fc03ec7cd88e18417d46a5049cc53206cc99732f1d01c0d09fd3
6
+ metadata.gz: 26cc264629f5dc2417269200a9a9a91c76143d0d0b59e599acbff1b0c92cc8e7c497c50c2c85145ae18e2fce1d21e6f5f5be200d0ff0988a1939e0b40d28fbce
7
+ data.tar.gz: a76a58672ec0b4b4e435d76df032d8f475afa6a6e829d86c328508f1a7409242253ef4d13af3ca43c52c19824a072fe704517737f0485d40384bbb1e3ffac342
@@ -0,0 +1,59 @@
1
+ # frozen_string_literal: true
2
+
3
+ module Antlers
4
+ # Translates strings like {"Hello"} and symbols like {:app_name} into the current locale.
5
+ # Top-level keys are "symbols" or a language code, mapping a source string to its translation:
6
+ # symbols:
7
+ # app_name: 'Raindeer'
8
+ # es:
9
+ # 'Hello': 'Hola'
10
+ module Translations
11
+ SYMBOLS = 'symbols'
12
+
13
+ module_function
14
+
15
+ def load(translations)
16
+ @translations = (translations || {}).to_h do |locale, mappings|
17
+ [locale.to_s, (mappings || {}).to_h { |source, translation| [source.to_s, translation.to_s] }.freeze]
18
+ end.freeze
19
+ end
20
+
21
+ def translations
22
+ @translations ||= {}.freeze
23
+ end
24
+
25
+ def locales
26
+ translations.keys - [SYMBOLS]
27
+ end
28
+
29
+ # Fiber storage is inherited by child fibers, so a locale set for a request applies to everything it renders.
30
+ def locale
31
+ Fiber[:antlers_locale]
32
+ end
33
+
34
+ def locale=(locale)
35
+ Fiber[:antlers_locale] = locale&.to_s
36
+ end
37
+
38
+ def with_locale(locale)
39
+ previous = self.locale
40
+ self.locale = locale
41
+ yield
42
+ ensure
43
+ self.locale = previous
44
+ end
45
+
46
+ # A string translates to the locale's mapping for it, or stays the same when there isn't one.
47
+ # A symbol renders its value under "symbols", which is then translated like any other string.
48
+ def translate(value, locale: self.locale)
49
+ if value.is_a?(Symbol)
50
+ name = value.to_s
51
+ value = translations.dig(SYMBOLS, name) || name
52
+ end
53
+
54
+ return value unless value.is_a?(String) && locale
55
+
56
+ translations.dig(locale.to_s, value) || value
57
+ end
58
+ end
59
+ end
@@ -1,5 +1,5 @@
1
1
  # frozen_string_literal: true
2
2
 
3
3
  module Antlers
4
- VERSION = '1.2.3'
4
+ VERSION = '1.3.1'
5
5
  end
data/lib/antlers.rb CHANGED
@@ -4,6 +4,7 @@ require_relative 'antlers/elements'
4
4
  require_relative 'antlers/keywords'
5
5
  require_relative 'antlers/lexer'
6
6
  require_relative 'antlers/parser'
7
+ require_relative 'antlers/translations'
7
8
 
8
9
  module Antlers
9
10
  module_function
@@ -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
@@ -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:)
@@ -2,6 +2,8 @@
2
2
 
3
3
  require_relative '../interfaces/leaf_node'
4
4
  require_relative '../modules/variables'
5
+ require_relative '../antlers/translations'
6
+ require_relative '../support/queries'
5
7
 
6
8
  module Antlers
7
9
  class VarNode < LeafNode
@@ -14,10 +16,14 @@ module Antlers
14
16
 
15
17
  @value = value
16
18
  @raw = raw
19
+ @translatable = Queries.translatable?(value.strip)
17
20
  end
18
21
 
19
22
  def render(current_binding: nil, parent_binding: nil, slot_node: nil, metadata: {})
20
- evaluate(value: @value, current_binding:, escape: !@raw).to_s
23
+ return evaluate(value: @value, current_binding:, escape: !@raw).to_s unless @translatable
24
+
25
+ result = Translations.translate(result(value: @value, current_binding:))
26
+ (@raw ? result : ERB::Util.html_escape(result)).to_s
21
27
  end
22
28
 
23
29
  class << self
@@ -7,6 +7,11 @@ module Antlers
7
7
  wrapped_in?(string, "'") || wrapped_in?(string, '"')
8
8
  end
9
9
 
10
+ # Strings like {"Hello"} and symbols like {:app_name} are translated, but not methods or instance variables.
11
+ def translatable?(string)
12
+ user_defined_string?(string) || string.start_with?(':')
13
+ end
14
+
10
15
  def wrapped_in?(string, delimeter)
11
16
  string[0] == delimeter && string[-1] == delimeter
12
17
  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.2.3
4
+ version: 1.3.1
5
5
  platform: ruby
6
6
  authors:
7
7
  - maedi
@@ -65,6 +65,7 @@ files:
65
65
  - lib/antlers/keywords.rb
66
66
  - lib/antlers/lexer.rb
67
67
  - lib/antlers/parser.rb
68
+ - lib/antlers/translations.rb
68
69
  - lib/antlers/version.rb
69
70
  - lib/interfaces/antler_node.rb
70
71
  - lib/interfaces/branch_node.rb