raindeer 0.11.1 → 1.0.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: 00e1c8ea25c77f078076f7997931cc4d68ffbc073dbc6e38820f42744be37df3
4
- data.tar.gz: fc8a23be880837861fac8f81af34b440e819ae35863048a624655a557b9b83fa
3
+ metadata.gz: abe5a7c77334e217fbe50fd81ae0cd6edc1869fecb0220f56a25128d362374a3
4
+ data.tar.gz: adea7d48b1d09b070aa1a619399360280dac1fae6fdac662a86ac585fbcee95b
5
5
  SHA512:
6
- metadata.gz: aef29d377676a4e661d889ac0a87dd6aceb0310d8b2fffe5537ff120c90259f70e910b29765d2bebb04623c3178710a8c2795c64d0064dd64973b77fa34cecc6
7
- data.tar.gz: 1221b6cc68e0d6b07abc6f1fb844ac3c84fda5c5f9a58db89400c6c66d6dbc9bdee56ef76f1756aa91998618e8492e3258203fc8c1e30bb1dd91ee6b32300c8e
6
+ metadata.gz: bd12f9ed51b2ea46444e59fc22a8e2ba7651d1ceec6eb7f98b9f43a2a4a77c4229ddbd8c9e94e3efeb95d2487da3532d4a844d44e3b543b296b1bafd887b92a7
7
+ data.tar.gz: e1ba9fc03f7c7ff757128ce0159d4662a7098bfba8447a25465a4bfeab7b8176402bc680e6cdc6143e97555f46eed5c83a5e2717d7de6002d4d4a8fe9f3490ca
data/lib/cli/static.rb CHANGED
@@ -9,6 +9,7 @@ require 'dirload'
9
9
  require 'lowdata' # Data classes can be loaded without a database.
10
10
 
11
11
  require_relative '../pages/pages'
12
+ require_relative '../support/config_loader'
12
13
 
13
14
  module Rain
14
15
  module CLI
@@ -23,6 +24,7 @@ module Rain
23
24
 
24
25
  public_path = File.expand_path('public', application_path)
25
26
  build_assets(application_path:, public_path:)
27
+ load_translations(application_path:)
26
28
 
27
29
  FileUtils.rm_rf(build_path)
28
30
  FileUtils.mkdir_p(build_path)
@@ -33,16 +35,23 @@ module Rain
33
35
  end
34
36
 
35
37
  request_results(metadata:).each do |request_result|
36
- folder_path = File.join(build_path, request_result.path)
38
+ file_path = output_path(build_path:, path: request_result.path)
37
39
 
38
- puts "#{folder_path} => #{request_result.status}"
40
+ puts "#{file_path} => #{request_result.status}"
39
41
  next unless request_result.html
40
42
 
41
- FileUtils.mkdir_p(folder_path)
42
- File.write(File.expand_path('index.html', folder_path), request_result.html)
43
+ FileUtils.mkdir_p(File.dirname(file_path))
44
+ File.write(file_path, request_result.html)
43
45
  end
44
46
  end
45
47
 
48
+ # Pages are files so hosts like Cloudflare Pages serve "docs.html" at "/docs" without a trailing slash.
49
+ def output_path(build_path:, path:)
50
+ return File.join(build_path, 'index.html') if path == '/'
51
+
52
+ File.join(build_path, "#{path.delete_suffix('/')}.html")
53
+ end
54
+
46
55
  private
47
56
 
48
57
  # Bundles are written into "public" and .gitignore'd, then copied into the build with everything else.
@@ -50,7 +59,6 @@ module Rain
50
59
  config_path = File.expand_path('config/config.yaml', application_path)
51
60
  return unless File.exist?(config_path)
52
61
 
53
- require_relative '../support/config_loader'
54
62
  bundles = Rain::ConfigLoader.load(config_path).assets
55
63
  return unless bundles
56
64
 
@@ -58,6 +66,15 @@ module Rain
58
66
  Rain::Assets.new(web_root: public_path, bundles:).build
59
67
  end
60
68
 
69
+ # Static builds have no Accept-Language header, so pages render in the "source_locale" config option ("en" by default).
70
+ def load_translations(application_path:)
71
+ config_path = File.expand_path('config/config.yaml', application_path)
72
+ source_locale = File.exist?(config_path) ? Rain::ConfigLoader.load(config_path).source_locale : nil
73
+
74
+ require_relative '../translations/translations'
75
+ Rain::Translations.load(File.expand_path('config/translations.yaml', application_path), source_locale:)
76
+ end
77
+
61
78
  def load_user_application(app_path:)
62
79
  metadata = dirload(app_path)
63
80
 
data/lib/raindeer/boot.rb CHANGED
@@ -27,6 +27,9 @@ module Rain
27
27
  config_path = File.expand_path('config/config.yaml', Dir.pwd)
28
28
  config = ConfigLoader.load(config_path, env)
29
29
 
30
+ require_relative '../translations/translations'
31
+ Translations.load(source_locale: config.source_locale)
32
+
30
33
  Providers.define('rain.router') do
31
34
  require_relative '../router/router'
32
35
  Router.new
data/lib/router/router.rb CHANGED
@@ -7,6 +7,7 @@ require_relative 'events/wildcard_event'
7
7
  require_relative 'http'
8
8
  require_relative 'route'
9
9
  require_relative 'trie'
10
+ require_relative '../translations/translations'
10
11
 
11
12
  module Rain
12
13
  # Defines routes and routes requests to a matching route event.
@@ -57,21 +58,44 @@ module Rain
57
58
  end
58
59
 
59
60
  def request(event: RequestEvent)
61
+ accept_language = event.request.headers['accept-language']&.join(',')
62
+ locale = Rain::Translations.negotiate(accept_language:)
63
+
64
+ response_event = Antlers::Translations.with_locale(locale) do
65
+ respond(request: event.request)
66
+ end
67
+ language_headers(response: response_event.response, locale:) if response_event.is_a?(ResponseEvent)
68
+
69
+ response_event
70
+ end
71
+
72
+ private
73
+
74
+ def language_headers(response:, locale:)
75
+ return unless response
76
+ return if Antlers::Translations.locales.empty?
77
+
78
+ headers = response.headers
79
+ headers.add('vary', 'accept-language')
80
+ headers.add('content-language', locale) unless headers.include?('content-language')
81
+ end
82
+
83
+ def respond(request:)
60
84
  response_event = nil
61
85
 
62
86
  # The last route event will render a response event which we want to return to the request event.
63
- @trie.match(request: event.request).each do |route_event|
87
+ @trie.match(request:).each do |route_event|
64
88
  response_event = route_event.take
65
89
  end
66
90
  return response_event if response_event
67
91
 
68
92
  if @routes['/*']
69
- route = Route.new(path: event.request.path, verbs: @routes['/*'].verbs)
93
+ route = Route.new(path: request.path, verbs: @routes['/*'].verbs)
70
94
  wildcard_event = WildcardEvent.take(key: '/*', action: :render, route:)
71
95
  return wildcard_event if wildcard_event
72
96
  end
73
97
 
74
- StatusEvent.take(status: Status[404], request: event.request)
98
+ StatusEvent.take(status: Status[404], request:)
75
99
  end
76
100
  end
77
101
  end
@@ -0,0 +1,60 @@
1
+ # frozen_string_literal: true
2
+
3
+ require 'antlers/translations'
4
+ require 'yaml'
5
+
6
+ module Rain
7
+ # Loads config/translations.yaml into Antlers and picks a request's locale from its Accept-Language header.
8
+ # The "source_locale" config option is the language templates are written in, used when no other language is requested.
9
+ module Translations
10
+ DEFAULT_SOURCE_LOCALE = 'en'
11
+
12
+ module_function
13
+
14
+ def load(file_path = File.expand_path('config/translations.yaml', Dir.pwd), source_locale: nil)
15
+ @source_locale = (source_locale || DEFAULT_SOURCE_LOCALE).to_s
16
+ return unless File.exist?(file_path)
17
+
18
+ Antlers::Translations.load(YAML.safe_load_file(file_path))
19
+ end
20
+
21
+ def source_locale
22
+ @source_locale || DEFAULT_SOURCE_LOCALE
23
+ end
24
+
25
+ # The templates' own language can be requested too, so "en,es;q=0.5" renders English templates as written.
26
+ def negotiate(accept_language:, locales: Antlers::Translations.locales)
27
+ locales = [source_locale, *locales.reject { it.casecmp?(source_locale) }]
28
+
29
+ requested_locale(accept_language:, locales:) || source_locale
30
+ end
31
+
32
+ # The first language in "es-ES,es;q=0.9,en;q=0.8" that has a locale, preferring higher "q" values.
33
+ def requested_locale(accept_language:, locales:)
34
+ return nil if accept_language.nil?
35
+
36
+ languages(accept_language:).each do |language|
37
+ tag = language.downcase
38
+ locale = locales.find { it.downcase == tag } || locales.find { it.downcase == tag.split('-').first }
39
+ return locale if locale
40
+ end
41
+
42
+ nil
43
+ end
44
+
45
+ def languages(accept_language:)
46
+ languages = accept_language.split(',').map { |part| language(part:) }
47
+ languages = languages.reject { |language, q| language.empty? || language == '*' || q <= 0 }
48
+
49
+ languages.sort_by.with_index { |(_, q), index| [-q, index] }.map(&:first)
50
+ end
51
+
52
+ # "es;q=0.9" => ['es', 0.9]
53
+ def language(part:)
54
+ language, *params = part.split(';').map(&:strip)
55
+ q = params.find { it.start_with?('q=') }&.delete_prefix('q=')
56
+
57
+ [language.to_s, q ? q.to_f : 1.0]
58
+ end
59
+ end
60
+ end
data/lib/version.rb CHANGED
@@ -1,5 +1,5 @@
1
1
  # frozen_string_literal: true
2
2
 
3
3
  module Raindeer
4
- VERSION = '0.11.1'
4
+ VERSION = '1.0.0'
5
5
  end
metadata CHANGED
@@ -1,7 +1,7 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: raindeer
3
3
  version: !ruby/object:Gem::Version
4
- version: 0.11.1
4
+ version: 1.0.0
5
5
  platform: ruby
6
6
  authors:
7
7
  - maedi
@@ -71,70 +71,70 @@ dependencies:
71
71
  requirements:
72
72
  - - "~>"
73
73
  - !ruby/object:Gem::Version
74
- version: 0.7.0
74
+ version: '0.7'
75
75
  type: :runtime
76
76
  prerelease: false
77
77
  version_requirements: !ruby/object:Gem::Requirement
78
78
  requirements:
79
79
  - - "~>"
80
80
  - !ruby/object:Gem::Version
81
- version: 0.7.0
81
+ version: '0.7'
82
82
  - !ruby/object:Gem::Dependency
83
83
  name: lowdata
84
84
  requirement: !ruby/object:Gem::Requirement
85
85
  requirements:
86
86
  - - "~>"
87
87
  - !ruby/object:Gem::Version
88
- version: '0.1'
88
+ version: '0.3'
89
89
  type: :runtime
90
90
  prerelease: false
91
91
  version_requirements: !ruby/object:Gem::Requirement
92
92
  requirements:
93
93
  - - "~>"
94
94
  - !ruby/object:Gem::Version
95
- version: '0.1'
95
+ version: '0.3'
96
96
  - !ruby/object:Gem::Dependency
97
97
  name: lowevent
98
98
  requirement: !ruby/object:Gem::Requirement
99
99
  requirements:
100
100
  - - "~>"
101
101
  - !ruby/object:Gem::Version
102
- version: 0.8.1
102
+ version: '0.8'
103
103
  type: :runtime
104
104
  prerelease: false
105
105
  version_requirements: !ruby/object:Gem::Requirement
106
106
  requirements:
107
107
  - - "~>"
108
108
  - !ruby/object:Gem::Version
109
- version: 0.8.1
109
+ version: '0.8'
110
110
  - !ruby/object:Gem::Dependency
111
111
  name: lowloop
112
112
  requirement: !ruby/object:Gem::Requirement
113
113
  requirements:
114
114
  - - "~>"
115
115
  - !ruby/object:Gem::Version
116
- version: 0.8.1
116
+ version: '0.8'
117
117
  type: :runtime
118
118
  prerelease: false
119
119
  version_requirements: !ruby/object:Gem::Requirement
120
120
  requirements:
121
121
  - - "~>"
122
122
  - !ruby/object:Gem::Version
123
- version: 0.8.1
123
+ version: '0.8'
124
124
  - !ruby/object:Gem::Dependency
125
125
  name: lownode
126
126
  requirement: !ruby/object:Gem::Requirement
127
127
  requirements:
128
128
  - - "~>"
129
129
  - !ruby/object:Gem::Version
130
- version: 0.5.3
130
+ version: '0.5'
131
131
  type: :runtime
132
132
  prerelease: false
133
133
  version_requirements: !ruby/object:Gem::Requirement
134
134
  requirements:
135
135
  - - "~>"
136
136
  - !ruby/object:Gem::Version
137
- version: 0.5.3
137
+ version: '0.5'
138
138
  - !ruby/object:Gem::Dependency
139
139
  name: lowtype
140
140
  requirement: !ruby/object:Gem::Requirement
@@ -155,70 +155,70 @@ dependencies:
155
155
  requirements:
156
156
  - - "~>"
157
157
  - !ruby/object:Gem::Version
158
- version: '1.0'
158
+ version: '1.3'
159
159
  type: :runtime
160
160
  prerelease: false
161
161
  version_requirements: !ruby/object:Gem::Requirement
162
162
  requirements:
163
163
  - - "~>"
164
164
  - !ruby/object:Gem::Version
165
- version: '1.0'
165
+ version: '1.3'
166
166
  - !ruby/object:Gem::Dependency
167
167
  name: expressions
168
168
  requirement: !ruby/object:Gem::Requirement
169
169
  requirements:
170
- - - ">="
170
+ - - "~>"
171
171
  - !ruby/object:Gem::Version
172
- version: '0'
172
+ version: '0.4'
173
173
  type: :runtime
174
174
  prerelease: false
175
175
  version_requirements: !ruby/object:Gem::Requirement
176
176
  requirements:
177
- - - ">="
177
+ - - "~>"
178
178
  - !ruby/object:Gem::Version
179
- version: '0'
179
+ version: '0.4'
180
180
  - !ruby/object:Gem::Dependency
181
181
  name: observers
182
182
  requirement: !ruby/object:Gem::Requirement
183
183
  requirements:
184
- - - ">="
184
+ - - "~>"
185
185
  - !ruby/object:Gem::Version
186
- version: '0'
186
+ version: '0.9'
187
187
  type: :runtime
188
188
  prerelease: false
189
189
  version_requirements: !ruby/object:Gem::Requirement
190
190
  requirements:
191
- - - ">="
191
+ - - "~>"
192
192
  - !ruby/object:Gem::Version
193
- version: '0'
193
+ version: '0.9'
194
194
  - !ruby/object:Gem::Dependency
195
195
  name: plugs
196
196
  requirement: !ruby/object:Gem::Requirement
197
197
  requirements:
198
- - - ">="
198
+ - - "~>"
199
199
  - !ruby/object:Gem::Version
200
- version: '0'
200
+ version: '0.4'
201
201
  type: :runtime
202
202
  prerelease: false
203
203
  version_requirements: !ruby/object:Gem::Requirement
204
204
  requirements:
205
- - - ">="
205
+ - - "~>"
206
206
  - !ruby/object:Gem::Version
207
- version: '0'
207
+ version: '0.4'
208
208
  - !ruby/object:Gem::Dependency
209
209
  name: providers
210
210
  requirement: !ruby/object:Gem::Requirement
211
211
  requirements:
212
- - - ">="
212
+ - - "~>"
213
213
  - !ruby/object:Gem::Version
214
- version: '0'
214
+ version: '0.6'
215
215
  type: :runtime
216
216
  prerelease: false
217
217
  version_requirements: !ruby/object:Gem::Requirement
218
218
  requirements:
219
- - - ">="
219
+ - - "~>"
220
220
  - !ruby/object:Gem::Version
221
- version: '0'
221
+ version: '0.6'
222
222
  - !ruby/object:Gem::Dependency
223
223
  name: raindown
224
224
  requirement: !ruby/object:Gem::Requirement
@@ -237,19 +237,19 @@ dependencies:
237
237
  name: trees
238
238
  requirement: !ruby/object:Gem::Requirement
239
239
  requirements:
240
- - - ">="
240
+ - - "~>"
241
241
  - !ruby/object:Gem::Version
242
- version: '0'
242
+ version: '0.3'
243
243
  type: :runtime
244
244
  prerelease: false
245
245
  version_requirements: !ruby/object:Gem::Requirement
246
246
  requirements:
247
- - - ">="
247
+ - - "~>"
248
248
  - !ruby/object:Gem::Version
249
- version: '0'
249
+ version: '0.3'
250
250
  description: "Raindeer is an event-driven framework using the dynamic features and
251
251
  latest async improvements in Ruby + some weird ideas, \nto build a new breed of
252
- web application. Each Raindeer component can be used individually in your exisiting
252
+ web application. Each Raindeer component can be used individually in your existing
253
253
  application, \nor all together as a cohesive framework. Deer to be different.\n"
254
254
  email:
255
255
  - maediprichard@gmail.com
@@ -291,12 +291,17 @@ files:
291
291
  - lib/system/status_404_node.rbx
292
292
  - lib/system/status_node.rbx
293
293
  - lib/system/system_routes.rb
294
+ - lib/translations/translations.rb
294
295
  - lib/version.rb
295
- homepage: https://github.com/raindeer-rb/raindeer
296
- licenses: []
296
+ homepage: https://raindeer.dev
297
+ licenses:
298
+ - MPL-2.0
297
299
  metadata:
298
- homepage_uri: https://github.com/raindeer-rb/raindeer
299
- source_code_uri: https://github.com/raindeer-rb/raindeer/src/branch/main
300
+ homepage_uri: https://raindeer.dev
301
+ documentation_uri: https://raindeer.dev/docs/getting-started/
302
+ source_code_uri: https://github.com/raindeer-rb/raindeer/tree/main
303
+ changelog_uri: https://github.com/raindeer-rb/raindeer/blob/main/CHANGELOG.md
304
+ bug_tracker_uri: https://github.com/raindeer-rb/raindeer/issues
300
305
  mailing_list_uri: https://www.rubyforum.org/tag/raindeer
301
306
  rdoc_options: []
302
307
  require_paths: