trek 2.4.0 → 2.6.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.
Files changed (217) hide show
  1. checksums.yaml +4 -4
  2. data/.node-version +1 -1
  3. data/AGENTS.md +12 -8
  4. data/CHANGELOG.md +62 -0
  5. data/Gemfile +5 -0
  6. data/Gemfile.lock +205 -171
  7. data/Makefile +28 -1
  8. data/README.md +2 -2
  9. data/app/components/trek/dashboard/tile_component/tile_component.css +9 -0
  10. data/app/components/trek/dashboard/tile_component/tile_component.html.slim +4 -2
  11. data/app/components/trek/dashboard/tile_component.rb +12 -2
  12. data/app/components/trek/form/content_editor_component/content_editor_component.css +5 -0
  13. data/app/components/trek/form/content_editor_component/content_editor_component.html.slim +19 -93
  14. data/app/components/trek/form/content_editor_component/content_editor_component.js +94 -251
  15. data/app/components/trek/form/content_editor_component/extensions/block_view.js +40 -0
  16. data/app/components/trek/form/content_editor_component/extensions/image_block.js +28 -26
  17. data/app/components/trek/form/content_editor_component/extensions/prompts_block.js +15 -26
  18. data/app/components/trek/form/content_editor_component/extensions/table_of_contents.js +1 -3
  19. data/app/components/trek/form/content_editor_component.rb +15 -0
  20. data/app/components/trek/form/image_field_component/image_field_component.css +40 -1
  21. data/app/components/trek/form/image_field_component/image_field_component.html.slim +0 -9
  22. data/app/components/trek/form/image_field_component.rb +37 -14
  23. data/app/components/trek/list/item_component.rb +1 -1
  24. data/app/components/trek/list/tree/item_component.rb +2 -2
  25. data/app/components/trek/search_component/search_component.html.slim +2 -1
  26. data/app/components/trek/search_component.rb +9 -1
  27. data/app/content/trek/content/bullet_list.rb +10 -0
  28. data/app/content/trek/content/cleaner.rb +53 -0
  29. data/app/content/trek/content/document.rb +33 -0
  30. data/app/content/trek/content/image_block.rb +52 -0
  31. data/app/content/trek/content/link_resolver.rb +33 -0
  32. data/app/content/trek/content/list_item.rb +19 -0
  33. data/app/content/trek/content/ordered_list.rb +10 -0
  34. data/app/content/trek/content/paragraph.rb +10 -0
  35. data/app/content/trek/content/prompts_block.rb +21 -0
  36. data/app/content/trek/content.rb +38 -0
  37. data/app/controllers/concerns/trek/reorderable.rb +32 -3
  38. data/app/controllers/trek/csp_reports_controller.rb +17 -7
  39. data/app/controllers/trek/panels/base_controller.rb +3 -0
  40. data/app/controllers/trek/panels/links_controller.rb +1 -1
  41. data/app/controllers/trek/panels/prompts_controller.rb +2 -2
  42. data/app/controllers/trek/resource_controller.rb +5 -5
  43. data/app/helpers/trek/thumbnail_helper.rb +11 -0
  44. data/app/jobs/trek/purge_expired_sessions_job.rb +4 -3
  45. data/app/models/concerns/trek/contentable.rb +19 -10
  46. data/app/models/concerns/trek/pageable.rb +10 -1
  47. data/app/models/concerns/trek/users/sign_in_code.rb +70 -0
  48. data/app/models/concerns/trek/users/sign_in_lockout.rb +4 -2
  49. data/app/views/trek/panels/images/_form.html.slim +1 -1
  50. data/app/views/trek/panels/images/create.turbo_stream.slim +1 -1
  51. data/app/views/trek/panels/links/_form.html.slim +3 -5
  52. data/app/views/trek/panels/prompts/_form.html.slim +1 -1
  53. data/app/views/trek/panels/prompts/create.turbo_stream.slim +0 -1
  54. data/config/locales/trek.en.yml +40 -2
  55. data/config/locales/trek.fr.yml +40 -2
  56. data/docs/.vitepress/config.mjs +4 -1
  57. data/docs/background-jobs.md +69 -0
  58. data/docs/content-editor.md +219 -0
  59. data/docs/customize.md +2 -0
  60. data/docs/deploy.md +2 -2
  61. data/docs/getting-started.md +4 -4
  62. data/docs/index.md +1 -1
  63. data/docs/reference/components.md +2 -2
  64. data/docs/reference/concerns/contentable.md +11 -4
  65. data/docs/reference/concerns/formattable.md +1 -1
  66. data/docs/reference/controllers.md +1 -1
  67. data/docs/reference/environment-variables.md +1 -0
  68. data/docs/reference/formatters.md +4 -9
  69. data/docs/reference/forms.md +1 -1
  70. data/docs/reference/generators/audit-log.md +2 -2
  71. data/docs/reference/generators/install.md +3 -2
  72. data/docs/reference/generators/public-accounts.md +141 -0
  73. data/docs/reference/generators/security-headers.md +1 -1
  74. data/docs/reference/index.md +2 -1
  75. data/docs/reference/models/fragment.md +1 -0
  76. data/docs/reference/models/user.md +3 -1
  77. data/docs/what-is-trek.md +5 -5
  78. data/lib/generators/trek/audit_log_generator.rb +54 -0
  79. data/lib/generators/trek/helpers.rb +13 -5
  80. data/lib/generators/trek/install/admin/users_generator.rb +6 -1
  81. data/lib/generators/trek/install/admin_generator.rb +8 -0
  82. data/lib/generators/trek/install/appsignal_generator.rb +1 -1
  83. data/lib/generators/trek/install/audit_log_generator.rb +9 -45
  84. data/lib/generators/trek/install/authentication_generator.rb +1 -1
  85. data/lib/generators/trek/install/authorization_generator.rb +1 -1
  86. data/lib/generators/trek/install/good_job_generator.rb +161 -0
  87. data/lib/generators/trek/install/model_specs_generator.rb +3 -3
  88. data/lib/generators/trek/install/postmark_generator.rb +2 -2
  89. data/lib/generators/trek/install/ruby_generator.rb +1 -1
  90. data/lib/generators/trek/install/scalingo_generator.rb +7 -45
  91. data/lib/generators/trek/install/specs_generator.rb +11 -0
  92. data/lib/generators/trek/install/user_generator.rb +1 -1
  93. data/lib/generators/trek/install_generator.rb +15 -0
  94. data/lib/generators/trek/public_accounts_generator.rb +267 -0
  95. data/lib/generators/trek/scaffold_generator.rb +13 -5
  96. data/lib/generators/trek/scalingo_generator.rb +55 -0
  97. data/lib/generators/trek/templates/.gitlab-ci.yml +1 -1
  98. data/lib/generators/trek/templates/Makefile +1 -1
  99. data/lib/generators/trek/templates/controllers/admin/fragments_controller.rb +7 -0
  100. data/lib/generators/trek/templates/controllers/admin/panels/images_controller.rb +8 -0
  101. data/lib/generators/trek/templates/controllers/admin/panels/links_controller.rb +8 -0
  102. data/lib/generators/trek/templates/controllers/admin/panels/prompts_controller.rb +8 -0
  103. data/lib/generators/trek/templates/controllers/admin/password_renewals_controller.rb +11 -0
  104. data/lib/generators/trek/templates/controllers/admin/user_sessions_controller.rb +1 -1
  105. data/lib/generators/trek/templates/controllers/admin/users_controller.rb +0 -8
  106. data/lib/generators/trek/templates/initializers/content_security_policy.rb +3 -2
  107. data/lib/generators/trek/templates/initializers/good_job.rb.tt +38 -0
  108. data/lib/generators/trek/templates/jobs/mail_delivery_job.rb +6 -0
  109. data/lib/generators/trek/templates/layouts/admin.html.slim +5 -0
  110. data/lib/generators/trek/templates/mailers/admin_mailer.rb +4 -2
  111. data/lib/generators/trek/templates/models/fragment.rb +14 -0
  112. data/lib/generators/trek/templates/package.json.tt +1 -1
  113. data/lib/generators/trek/templates/public_accounts/api/authentication.rb.tt +76 -0
  114. data/lib/generators/trek/templates/public_accounts/api/controllers/accounts_controller.rb.tt +22 -0
  115. data/lib/generators/trek/templates/public_accounts/api/controllers/active_sessions_controller.rb.tt +21 -0
  116. data/lib/generators/trek/templates/public_accounts/api/controllers/base_controller.rb.tt +71 -0
  117. data/lib/generators/trek/templates/public_accounts/api/controllers/email_changes_controller.rb.tt +55 -0
  118. data/lib/generators/trek/templates/public_accounts/api/controllers/email_confirmations_controller.rb.tt +19 -0
  119. data/lib/generators/trek/templates/public_accounts/api/controllers/password_resets_controller.rb.tt +28 -0
  120. data/lib/generators/trek/templates/public_accounts/api/controllers/passwords_controller.rb.tt +17 -0
  121. data/lib/generators/trek/templates/public_accounts/api/controllers/registrations_controller.rb.tt +17 -0
  122. data/lib/generators/trek/templates/public_accounts/api/controllers/sessions_controller.rb.tt +45 -0
  123. data/lib/generators/trek/templates/public_accounts/api/controllers/sign_in_codes_controller.rb.tt +15 -0
  124. data/lib/generators/trek/templates/public_accounts/jobs/sign_in_code_job.rb.tt +13 -0
  125. data/lib/generators/trek/templates/public_accounts/locales/accounts.en.yml.tt +205 -0
  126. data/lib/generators/trek/templates/public_accounts/locales/accounts.fr.yml.tt +205 -0
  127. data/lib/generators/trek/templates/public_accounts/mailers/account_mailer.rb.tt +85 -0
  128. data/lib/generators/trek/templates/public_accounts/migrations/create_accounts.rb.tt +46 -0
  129. data/lib/generators/trek/templates/public_accounts/models/account/session.rb.tt +47 -0
  130. data/lib/generators/trek/templates/public_accounts/models/account/sign_in_code.rb.tt +8 -0
  131. data/lib/generators/trek/templates/public_accounts/models/account.rb.tt +73 -0
  132. data/lib/generators/trek/templates/public_accounts/spec/api/accounts_spec.rb.tt +90 -0
  133. data/lib/generators/trek/templates/public_accounts/spec/api/sign_ins_spec.rb.tt +158 -0
  134. data/lib/generators/trek/templates/public_accounts/spec/models/account/sign_in_code_spec.rb.tt +56 -0
  135. data/lib/generators/trek/templates/public_accounts/spec/models/account_spec.rb.tt +109 -0
  136. data/lib/generators/trek/templates/public_accounts/spec/web/accounts_spec.rb.tt +126 -0
  137. data/lib/generators/trek/templates/public_accounts/spec/web/authentication_spec.rb.tt +43 -0
  138. data/lib/generators/trek/templates/public_accounts/spec/web/sign_ins_spec.rb.tt +215 -0
  139. data/lib/generators/trek/templates/public_accounts/views/mailer/email_change.en.html.slim.tt +10 -0
  140. data/lib/generators/trek/templates/public_accounts/views/mailer/email_change.en.text.erb.tt +8 -0
  141. data/lib/generators/trek/templates/public_accounts/views/mailer/email_change.fr.html.slim.tt +13 -0
  142. data/lib/generators/trek/templates/public_accounts/views/mailer/email_change.fr.text.erb.tt +8 -0
  143. data/lib/generators/trek/templates/public_accounts/views/mailer/email_change_code.en.html.slim.tt +9 -0
  144. data/lib/generators/trek/templates/public_accounts/views/mailer/email_change_code.en.text.erb.tt +11 -0
  145. data/lib/generators/trek/templates/public_accounts/views/mailer/email_change_code.fr.html.slim.tt +11 -0
  146. data/lib/generators/trek/templates/public_accounts/views/mailer/email_change_code.fr.text.erb.tt +11 -0
  147. data/lib/generators/trek/templates/public_accounts/views/mailer/email_confirmation.en.html.slim.tt +10 -0
  148. data/lib/generators/trek/templates/public_accounts/views/mailer/email_confirmation.en.text.erb.tt +8 -0
  149. data/lib/generators/trek/templates/public_accounts/views/mailer/email_confirmation.fr.html.slim.tt +10 -0
  150. data/lib/generators/trek/templates/public_accounts/views/mailer/email_confirmation.fr.text.erb.tt +8 -0
  151. data/lib/generators/trek/templates/public_accounts/views/mailer/password_reset.en.html.slim.tt +10 -0
  152. data/lib/generators/trek/templates/public_accounts/views/mailer/password_reset.en.text.erb.tt +8 -0
  153. data/lib/generators/trek/templates/public_accounts/views/mailer/password_reset.fr.html.slim.tt +13 -0
  154. data/lib/generators/trek/templates/public_accounts/views/mailer/password_reset.fr.text.erb.tt +8 -0
  155. data/lib/generators/trek/templates/public_accounts/views/mailer/sign_in_code.en.html.slim.tt +9 -0
  156. data/lib/generators/trek/templates/public_accounts/views/mailer/sign_in_code.en.text.erb.tt +11 -0
  157. data/lib/generators/trek/templates/public_accounts/views/mailer/sign_in_code.fr.html.slim.tt +9 -0
  158. data/lib/generators/trek/templates/public_accounts/views/mailer/sign_in_code.fr.text.erb.tt +11 -0
  159. data/lib/generators/trek/templates/public_accounts/views/mailer/sign_in_locked.en.html.slim.tt +23 -0
  160. data/lib/generators/trek/templates/public_accounts/views/mailer/sign_in_locked.en.text.erb.tt +14 -0
  161. data/lib/generators/trek/templates/public_accounts/views/mailer/sign_in_locked.fr.html.slim.tt +24 -0
  162. data/lib/generators/trek/templates/public_accounts/views/mailer/sign_in_locked.fr.text.erb.tt +14 -0
  163. data/lib/generators/trek/templates/public_accounts/web/authentication.rb.tt +97 -0
  164. data/lib/generators/trek/templates/public_accounts/web/controllers/accounts_controller.rb.tt +33 -0
  165. data/lib/generators/trek/templates/public_accounts/web/controllers/active_sessions_controller.rb.tt +15 -0
  166. data/lib/generators/trek/templates/public_accounts/web/controllers/base_controller.rb.tt +52 -0
  167. data/lib/generators/trek/templates/public_accounts/web/controllers/email_changes_controller.rb.tt +85 -0
  168. data/lib/generators/trek/templates/public_accounts/web/controllers/email_confirmations_controller.rb.tt +19 -0
  169. data/lib/generators/trek/templates/public_accounts/web/controllers/password_resets_controller.rb.tt +41 -0
  170. data/lib/generators/trek/templates/public_accounts/web/controllers/passwords_controller.rb.tt +23 -0
  171. data/lib/generators/trek/templates/public_accounts/web/controllers/registrations_controller.rb.tt +24 -0
  172. data/lib/generators/trek/templates/public_accounts/web/controllers/sessions_controller.rb.tt +78 -0
  173. data/lib/generators/trek/templates/public_accounts/web/controllers/sign_in_codes_controller.rb.tt +27 -0
  174. data/lib/generators/trek/templates/public_accounts/web/views/_flash.html.slim.tt +5 -0
  175. data/lib/generators/trek/templates/public_accounts/web/views/accounts/show.html.slim.tt +52 -0
  176. data/lib/generators/trek/templates/public_accounts/web/views/email_changes/edit.html.slim.tt +17 -0
  177. data/lib/generators/trek/templates/public_accounts/web/views/email_changes/new.html.slim.tt +15 -0
  178. data/lib/generators/trek/templates/public_accounts/web/views/password_resets/edit.html.slim.tt +26 -0
  179. data/lib/generators/trek/templates/public_accounts/web/views/password_resets/new.html.slim.tt +15 -0
  180. data/lib/generators/trek/templates/public_accounts/web/views/passwords/edit.html.slim.tt +25 -0
  181. data/lib/generators/trek/templates/public_accounts/web/views/registrations/new.html.slim.tt +28 -0
  182. data/lib/generators/trek/templates/public_accounts/web/views/sessions/new.html.slim.tt +38 -0
  183. data/lib/generators/trek/templates/public_accounts/web/views/sign_in_codes/new.html.slim.tt +17 -0
  184. data/lib/generators/trek/templates/spec/jobs/mail_delivery_job_spec.rb +11 -0
  185. data/lib/generators/trek/templates/spec/mailers/admin_mailer_spec.rb +12 -1
  186. data/lib/generators/trek/templates/spec/requests/admin/active_sessions_spec.rb +1 -0
  187. data/lib/generators/trek/templates/spec/requests/admin/fragments_spec.rb +27 -3
  188. data/lib/generators/trek/templates/spec/requests/admin/good_job_spec.rb +34 -0
  189. data/lib/generators/trek/templates/spec/requests/admin/pages_spec.rb +9 -1
  190. data/lib/generators/trek/templates/spec/requests/admin/panels_spec.rb +70 -0
  191. data/lib/generators/trek/templates/spec/requests/admin/password_renewal_spec.rb +2 -2
  192. data/lib/generators/trek/templates/spec/requests/admin/sign_in_lockout_spec.rb +1 -1
  193. data/lib/generators/trek/templates/spec/requests/admin/sign_in_notices_spec.rb +5 -3
  194. data/lib/generators/trek/templates/spec/requests/admin/user_sessions_spec.rb +2 -2
  195. data/lib/generators/trek/templates/views/admin/fragments/index.html.slim +14 -3
  196. data/lib/generators/trek/templates/views/admin/users/index.html.slim +1 -1
  197. data/lib/generators/trek/templates/views/admin_mailer/new_sign_in.en.html.slim +1 -1
  198. data/lib/generators/trek/templates/views/admin_mailer/new_sign_in.en.text.erb +1 -1
  199. data/lib/generators/trek/templates/views/admin_mailer/new_sign_in.fr.html.slim +1 -1
  200. data/lib/generators/trek/templates/views/admin_mailer/new_sign_in.fr.text.erb +1 -1
  201. data/lib/trek/csp_reports.rb +22 -4
  202. data/lib/trek/engine.rb +8 -3
  203. data/lib/trek/saved_attachments_reload.rb +2 -1
  204. data/lib/trek/typography_formatter.rb +35 -4
  205. data/lib/trek/version.rb +1 -1
  206. data/lib/trek.rb +1 -1
  207. data/package.json +12 -8
  208. data/renovate.json +1 -0
  209. data/trek.gemspec +3 -3
  210. data/vitest.config.mjs +24 -0
  211. data/yarn.lock +1706 -1028
  212. metadata +116 -14
  213. data/app/formatters/prosemirror_to_html/global_id_to_links_formatter.rb +0 -19
  214. data/app/formatters/prosemirror_to_html/nodes/image_block.rb +0 -44
  215. data/app/formatters/prosemirror_to_html/nodes/prompts_block.rb +0 -28
  216. data/app/formatters/prosemirror_to_html/remove_empty_paragraphs_formatter.rb +0 -11
  217. data/app/models/prosemirror.rb +0 -23
@@ -62,6 +62,7 @@ RSpec.describe "Admin active sessions", type: :request do
62
62
  before { sign_in(editor) }
63
63
 
64
64
  it "lists the user's sessions with their browser and IP address" do
65
+ editor.update!(locale: "en") # the browsers' descriptions are in English
65
66
  get admin_user_path(editor)
66
67
 
67
68
  expect(response.body).to include("Safari on macOS").and include("Firefox on Windows").and include("203.0.113.7")
@@ -8,10 +8,34 @@ RSpec.describe "Admin fragments", type: :request do
8
8
  post admin_user_session_path, params: { email: editor.email, password: users.password }
9
9
  end
10
10
 
11
- it "lists the fragments" do
11
+ it "lists the fragments with their key and an excerpt of their content" do
12
+ footer.update!(content: { type: "doc", content: [{ type: "paragraph", content: [{ type: "text", text: "All rights reserved" }] }] })
13
+
12
14
  get admin_fragments_path
13
15
 
14
- expect(response.body).to include("footer")
16
+ expect(response.body).to include("Footer", "<code>layout.footer</code>", "All rights reserved")
17
+ end
18
+
19
+ describe "searching" do
20
+ before do
21
+ footer.update!(content: { type: "doc", content: [{ type: "paragraph", content: [{ type: "text", text: "All rights reserved" }] }] })
22
+ fragments.create(key: "tagline", namespace: "home", title: "Tagline")
23
+ end
24
+
25
+ it "finds fragments by key, title or content text", :aggregate_failures do
26
+ ["layout.foot", "FOOTER", "rights"].each do |search|
27
+ get admin_fragments_path(search:)
28
+
29
+ expect(response.body).to include("layout.footer")
30
+ expect(response.body).not_to include("home.tagline")
31
+ end
32
+ end
33
+
34
+ it "ignores the content's structure" do
35
+ get admin_fragments_path(search: "paragraph")
36
+
37
+ expect(response.body).not_to include("layout.footer")
38
+ end
15
39
  end
16
40
 
17
41
  it "renders the new fragment form" do
@@ -29,7 +53,7 @@ RSpec.describe "Admin fragments", type: :request do
29
53
  it "refuses a key already used in the namespace" do
30
54
  post admin_fragments_path, params: { fragment: { key: "footer", namespace: "layout", title: "Another footer" } }
31
55
 
32
- expect(response).to have_http_status(:unprocessable_entity)
56
+ expect(response).to have_http_status(:unprocessable_content)
33
57
  end
34
58
 
35
59
  it "renders the edit form" do
@@ -0,0 +1,34 @@
1
+ require "rails_helper"
2
+
3
+ # The GoodJob dashboard is mounted outside the admin controllers (config/routes.rb), so the guard
4
+ # lives in config/initializers/good_job.rb. Anyone but an administrator must get a 404.
5
+ RSpec.describe "GoodJob dashboard", type: :request do
6
+ let(:password) { "secret-password-123" }
7
+
8
+ def sign_in(user)
9
+ post admin_user_session_path, params: { email: user.email, password: }
10
+ end
11
+
12
+ it "lets an administrator in" do
13
+ sign_in User.create!(email: "admin@example.com", password:, role: "admin")
14
+
15
+ get "/admin/good_job"
16
+ follow_redirect!
17
+
18
+ expect(response).to have_http_status(:ok)
19
+ end
20
+
21
+ it "hides the dashboard from a privileged user who is not an administrator" do
22
+ sign_in User.create!(email: "editor@example.com", password:, role: "editor")
23
+
24
+ get "/admin/good_job"
25
+
26
+ expect(response).to have_http_status(:not_found)
27
+ end
28
+
29
+ it "hides the dashboard from a visitor" do
30
+ get "/admin/good_job"
31
+
32
+ expect(response).to have_http_status(:not_found)
33
+ end
34
+ end
@@ -13,6 +13,14 @@ RSpec.describe "Admin pages", type: :request do
13
13
  expect(response.body).to include("Company").and include("Our team")
14
14
  end
15
15
 
16
+ it "lists a page with an image" do
17
+ pages.company.update!(image: file_fixture("image.png").open)
18
+
19
+ get admin_pages_path
20
+
21
+ expect(response).to have_http_status(:ok)
22
+ end
23
+
16
24
  it "renders the new page form" do
17
25
  get new_admin_page_path
18
26
 
@@ -26,7 +34,7 @@ RSpec.describe "Admin pages", type: :request do
26
34
  it "refuses a page without a title" do
27
35
  post admin_pages_path, params: { page: { title: "" } }
28
36
 
29
- expect(response).to have_http_status(:unprocessable_entity)
37
+ expect(response).to have_http_status(:unprocessable_content)
30
38
  end
31
39
 
32
40
  it "renders the edit form" do
@@ -0,0 +1,70 @@
1
+ require "rails_helper"
2
+
3
+ # The content editor's side panels (link, image, prompt), which its toolbar loads into the layout's
4
+ # stacked panel frame
5
+ RSpec.describe "Admin content editor panels", type: :request do
6
+ before do
7
+ editor = users.create(role: :editor)
8
+ post admin_user_session_path, params: { email: editor.email, password: users.password }
9
+ end
10
+
11
+ # A missing translation in a panel fails the request, instead of showing "Translation missing"
12
+ around do |example|
13
+ raise_on_missing = ActionView::Helpers::TranslationHelper.raise_on_missing_translations
14
+ ActionView::Helpers::TranslationHelper.raise_on_missing_translations = true
15
+ example.run
16
+ ensure
17
+ ActionView::Helpers::TranslationHelper.raise_on_missing_translations = raise_on_missing
18
+ end
19
+
20
+ def stacked_panel
21
+ Nokogiri::HTML5(response.body).at_css("turbo-frame#trek--layout-stacked-panel")
22
+ end
23
+
24
+ {
25
+ "link" => [:new_admin_panels_link_path, :link, :admin_panels_links_path],
26
+ "image" => [:new_admin_panels_image_path, :image, :admin_panels_images_path],
27
+ "prompt" => [:new_admin_panels_prompt_path, :prompt, :admin_panels_prompts_path]
28
+ }.each do |panel, (path, param, form_path)|
29
+ it "opens the #{panel} panel" do
30
+ get public_send(path, param => { turbo_frame_id: "page_1_content" })
31
+
32
+ expect(stacked_panel.at_css("form")["action"]).to eq(public_send(form_path))
33
+ end
34
+
35
+ it "titles the #{panel} panel" do
36
+ get public_send(path, param => { turbo_frame_id: "page_1_content" })
37
+
38
+ expect(stacked_panel.at_css("h1").text.squish).to eq(I18n.t("admin.panels.#{panel}s.form.title"))
39
+ end
40
+ end
41
+
42
+ it "opens the link panel on a link to another site" do
43
+ get new_admin_panels_link_path(link: { turbo_frame_id: "page_1_content", href: "https://example.com/", text: "Example" })
44
+
45
+ expect(stacked_panel.at_css("form")["action"]).to eq(admin_panels_links_path)
46
+ end
47
+
48
+ it "inserts a link into the editor" do
49
+ post admin_panels_links_path(format: :turbo_stream),
50
+ params: { link: { turbo_frame_id: "page_1_content", href: "https://example.com/", text: "Example" } }
51
+
52
+ expect(response).to have_http_status(:ok)
53
+ end
54
+
55
+ it "asks for a link's title, and gives it to the editor", :aggregate_failures do
56
+ get new_admin_panels_link_path(link: { turbo_frame_id: "page_1_content" })
57
+ expect(stacked_panel.at_css("input[name='link[title]']")).to be_present
58
+
59
+ post admin_panels_links_path(format: :turbo_stream),
60
+ params: { link: { turbo_frame_id: "page_1_content", href: "https://example.com/", title: "An example" } }
61
+ expect(response.body).to include("&quot;title&quot;:&quot;An example&quot;")
62
+ end
63
+
64
+ it "inserts a call to action into the editor" do
65
+ post admin_panels_prompts_path(format: :turbo_stream),
66
+ params: { prompt: { turbo_frame_id: "page_1_content", href: "https://example.com/", text: "Sign up" } }
67
+
68
+ expect(response.body).to include("<prompts-block", "Sign up")
69
+ end
70
+ end
@@ -12,7 +12,7 @@ RSpec.describe "Admin password renewal", type: :request do
12
12
  editor
13
13
  sign_in(admin)
14
14
 
15
- post require_password_renewal_admin_users_path
15
+ post admin_password_renewal_path
16
16
 
17
17
  expect(editor.reload.password_renewal_required).to be(true)
18
18
  end
@@ -21,7 +21,7 @@ RSpec.describe "Admin password renewal", type: :request do
21
21
  admin
22
22
  sign_in(editor)
23
23
 
24
- post require_password_renewal_admin_users_path
24
+ post admin_password_renewal_path
25
25
 
26
26
  expect(admin.reload.password_renewal_required).to be(false)
27
27
  end
@@ -24,7 +24,7 @@ RSpec.describe "Admin sign-in lockout", type: :request do
24
24
 
25
25
  sign_in
26
26
 
27
- expect(response).to have_http_status(:unprocessable_entity)
27
+ expect(response).to have_http_status(:unprocessable_content)
28
28
  end
29
29
 
30
30
  it "answers a locked account as a wrong password, so it can't be told apart" do
@@ -4,6 +4,8 @@ RSpec.describe "Admin sign-in notices", type: :request do
4
4
  include ActiveSupport::Testing::TimeHelpers
5
5
 
6
6
  let(:editor) { users.create(role: :editor) }
7
+ # For examples reading English words, whatever the app's default locale
8
+ let(:english_editor) { users.create(role: :editor, locale: "en") }
7
9
  let(:firefox) { "Mozilla/5.0 (Windows NT 10.0; Win64; x64; rv:131.0) Gecko/20100101 Firefox/131.0" }
8
10
 
9
11
  def sign_in(user, user_agent: firefox)
@@ -43,11 +45,11 @@ RSpec.describe "Admin sign-in notices", type: :request do
43
45
  end
44
46
 
45
47
  it "shows the previous sign-in's date, browser and address on the sessions tab" do
46
- sign_in(editor)
48
+ sign_in(english_editor)
47
49
  sign_out
48
- sign_in(editor)
50
+ sign_in(english_editor)
49
51
 
50
- get admin_user_path(editor)
52
+ get admin_user_path(english_editor)
51
53
 
52
54
  expect(response.body).to include("Firefox on Windows").and include("127.0.0.1")
53
55
  end
@@ -31,7 +31,7 @@ RSpec.describe "Admin sign-in", type: :request do
31
31
  it "refuses a wrong password" do
32
32
  post admin_user_session_path, params: { email: editor.email, password: "not the password" }
33
33
 
34
- expect(response).to have_http_status(:unprocessable_entity)
34
+ expect(response).to have_http_status(:unprocessable_content)
35
35
  end
36
36
 
37
37
  it "keeps the email typed after a wrong password" do
@@ -44,7 +44,7 @@ RSpec.describe "Admin sign-in", type: :request do
44
44
  reader = users.create(role: :reader)
45
45
  post admin_user_session_path, params: { email: reader.email, password: users.password }
46
46
 
47
- expect(response).to have_http_status(:unprocessable_entity)
47
+ expect(response).to have_http_status(:unprocessable_content)
48
48
  end
49
49
 
50
50
  it "answers an unknown email as a wrong password, so it can't be used to find accounts" do
@@ -12,8 +12,19 @@
12
12
  end
13
13
  end
14
14
 
15
- = render Trek::ListComponent.new do |c|
15
+ = render Trek::SearchComponent.new( \
16
+ action: admin_fragments_path,
17
+ value: params[:search],
18
+ )
19
+
20
+ = render Trek::EntriesComponent.new do |entries|
16
21
  ruby:
17
- @objects.each do |object|
18
- c.with_item(object:)
22
+ @objects.each do |fragment|
23
+ entries.with_item(item: fragment) do |entry|
24
+ entry.with_title(href: [:edit, :admin, fragment]) do
25
+ fragment.title.presence || fragment.to_s
26
+ end
27
+ entry.with_detail { tag.code(fragment.to_s) } if fragment.title.present?
28
+ entry.with_detail { truncate(fragment.content_text, length: 80) }
29
+ end
19
30
  end
@@ -14,7 +14,7 @@
14
14
 
15
15
  if allowed_to?(:require_password_renewal?, model)
16
16
  c.with_button(
17
- href: [:require_password_renewal, :admin, :users],
17
+ href: [:admin, :password_renewal],
18
18
  text: t(".require_password_renewal"),
19
19
  data: {
20
20
  turbo_method: :post,
@@ -5,7 +5,7 @@ p
5
5
  ul
6
6
  li = l(@at, format: :long)
7
7
  li = user_agent_summary(@user_agent)
8
- li = @ip
8
+ li = @address
9
9
  p If it was you, there's nothing to do.
10
10
  p
11
11
  | If it wasn't, change your password right away,
@@ -4,7 +4,7 @@ Your <%%= t("application_name") %> account was just signed in to from a browser
4
4
 
5
5
  - <%%= l(@at, format: :long) %>
6
6
  - <%%= user_agent_summary(@user_agent) %>
7
- - <%%= @ip %>
7
+ - <%%= @address %>
8
8
 
9
9
  If it was you, there's nothing to do.
10
10
 
@@ -5,7 +5,7 @@ p
5
5
  ul
6
6
  li = l(@at, format: :long)
7
7
  li = user_agent_summary(@user_agent)
8
- li = @ip
8
+ li = @address
9
9
  p Si c'était vous, il n'y a rien à faire.
10
10
  p
11
11
  | Sinon, changez votre mot de passe tout de suite,
@@ -4,7 +4,7 @@ Votre compte <%%= t("application_name") %> vient d'être connecté depuis un nav
4
4
 
5
5
  - <%%= l(@at, format: :long) %>
6
6
  - <%%= user_agent_summary(@user_agent) %>
7
- - <%%= @ip %>
7
+ - <%%= @address %>
8
8
 
9
9
  Si c'était vous, il n'y a rien à faire.
10
10
 
@@ -16,7 +16,9 @@ module Trek
16
16
  # report, it must be plausible too: a known directive, and a keyword or a host name blocked.
17
17
  #
18
18
  # A violation keeps the page's path, without its query, which may carry a token, and the blocked
19
- # resource's origin.
19
+ # resource's origin. To tell what was blocked, it also keeps where (the source file's URL, without
20
+ # its query, and the line), and the sample: the start of the inline script or style, which browsers
21
+ # only send under `'report-sample'`.
20
22
  module CspReports
21
23
  EXTENSION_SCHEMES = %w[chrome-extension moz-extension safari-extension safari-web-extension ms-browser-extension].freeze
22
24
 
@@ -32,9 +34,13 @@ module Trek
32
34
  SCHEMES = %w[http https ws wss].freeze
33
35
  HOST_NAME = /\A(?=.{1,253}\z)[a-z0-9]([a-z0-9-]*[a-z0-9])?(\.[a-z0-9]([a-z0-9-]*[a-z0-9])?)*\z/i
34
36
 
35
- Violation = Struct.new(:directive, :blocked, :page, :disposition, keyword_init: true) do
37
+ # Browsers send 40 characters at most; a forged report could send any number
38
+ SAMPLE_LENGTH = 40
39
+
40
+ Violation = Struct.new(:directive, :blocked, :page, :disposition, :source, :sample, keyword_init: true) do
36
41
  def to_s
37
- "#{directive} blocked #{blocked} on #{page} (#{disposition})"
42
+ # The sample inspected, as it may hold a line break
43
+ "#{directive} blocked #{blocked} on #{page} (#{disposition})#{" at #{source}" if source}#{": #{sample.inspect}" if sample}"
38
44
  end
39
45
  end
40
46
 
@@ -68,11 +74,23 @@ module Trek
68
74
  directive:,
69
75
  blocked:,
70
76
  page: page.path.presence || "/",
71
- disposition: fields["disposition"] || "enforce"
77
+ disposition: fields["disposition"] || "enforce",
78
+ source: location(source, fields["line-number"] || fields["lineNumber"]),
79
+ sample: (fields["script-sample"] || fields["sample"]).to_s.first(SAMPLE_LENGTH).presence
72
80
  )
73
81
  end
74
82
  private_class_method :violation
75
83
 
84
+ # Where the violation happened: the source file's origin and path, and the line
85
+ def self.location(source, line)
86
+ uri = parse_uri(source)
87
+ return unless uri&.host && (base = origin(source))
88
+
89
+ line = Integer(line, exception: false)
90
+ "#{base}#{uri.path}#{":#{line}" if line}"
91
+ end
92
+ private_class_method :location
93
+
76
94
  # A URL's origin, or the keyword a browser reports instead ("inline", "eval", "data"…); nil when
77
95
  # it's neither
78
96
  def self.origin(value)
data/lib/trek/engine.rb CHANGED
@@ -12,10 +12,10 @@ module Trek
12
12
 
13
13
  config.eager_load_paths = %W[
14
14
  #{root}/app/components
15
+ #{root}/app/content
15
16
  #{root}/app/controllers
16
17
  #{root}/app/controllers/concerns
17
18
  #{root}/app/forms
18
- #{root}/app/formatters
19
19
  #{root}/app/helpers
20
20
  #{root}/app/jobs
21
21
  #{root}/app/models
@@ -26,9 +26,14 @@ module Trek
26
26
  #{root}/app/validators
27
27
  ]
28
28
 
29
- # Lets apps configure Trek's deprecation warnings like Rails' own (Rails 7.1+)
29
+ # Lets apps configure Trek's deprecation warnings like Rails' own
30
30
  initializer "trek.deprecator" do |app|
31
- app.deprecators[:trek] = Trek.deprecator if app.respond_to?(:deprecators)
31
+ app.deprecators[:trek] = Trek.deprecator
32
+ end
33
+
34
+ # The default content schema holds node type classes: rebuild it after code reloading
35
+ config.to_prepare do
36
+ Trek::Content.clear_default_schema
32
37
  end
33
38
 
34
39
  # Off unless ADMIN_ALLOWED_IPS lists addresses or ranges
@@ -6,7 +6,8 @@ module Trek
6
6
  # Shrine's `activerecord` plugin resets every attacher when the record is reloaded, which is
7
7
  # right for an explicit reload but loses a pending attachment when something reloads the record
8
8
  # *during* the save: closure_tree does exactly that in its `after_save` callback when it
9
- # reorders siblings (on create, or when the parent changes) on a numerically ordered tree.
9
+ # reorders siblings (on create, when the parent changes, or since closure_tree 9.8 when the
10
+ # position changes) on a numerically ordered tree.
10
11
  # The attacher is then no longer `changed?` when Shrine's `after_commit` runs, so the file is
11
12
  # never promoted from the temporary `cache` storage to `store` and breaks once the cache is
12
13
  # cleaned up.
@@ -1,20 +1,33 @@
1
+ require "json"
2
+
1
3
  module Trek
2
4
  # `TypographyFormatter` formats strings to enforce French typography rules.
3
5
  #
4
6
  # Supports both plain strings and ProseMirror JSONB hashes. When given
5
7
  # a Hash, it walks the node tree and formats only `text` node values
6
- # in place, leaving the structure intact.
8
+ # in place, leaving the structure intact. A ProseMirror document given
9
+ # as a JSON string, as the content editor submits it, is parsed first,
10
+ # and returned as a Hash.
7
11
  class TypographyFormatter
8
12
  NBSP = [160].pack("U*").freeze
9
13
  NNBSP = [8239].pack("U*").freeze # U+202F narrow no-break space
14
+ # Signs preceded by a non-breaking space, whether one was typed or not
10
15
  SPACE_BEFORE_CHARS = [
11
- [NBSP, %w[: % € \$ » – —]],
16
+ [NBSP, %w[» – —]]
17
+ ].freeze
18
+ # Signs preceded by a non-breaking space when one was typed, or when they end a word: followed by a
19
+ # space, punctuation or the end of the text. Inside a word, as in a time (10:30), a URL
20
+ # (https://example.com/?a=50%25) or a ratio (3:1), they aren't punctuation, and are left alone.
21
+ SPACE_BEFORE_WORD_ENDING_CHARS = [
22
+ [NBSP, %w[: % € \$]],
12
23
  [NNBSP, %w[; ! \?]]
13
24
  ].freeze
25
+ WORD_ENDING_SIGNS = %w[: ; ! \?].freeze
14
26
  NBSP_AFTER_CHARS = %w[« – —].freeze
15
27
  NBSP_BEFORE_UNITS = %w[°C °F g h ha kg km Ko ko kW L l m min ml Mo mo s].freeze
16
28
 
17
29
  def initialize(input)
30
+ input = JSON.parse(input) if prosemirror_json?(input)
18
31
  @source = input
19
32
  @prosemirror = input.is_a?(Hash)
20
33
  @output = @prosemirror ? deep_dup_hash(input) : input.dup
@@ -34,6 +47,11 @@ module Trek
34
47
 
35
48
  private
36
49
 
50
+ # Formatted as plain text, the JSON would get non-breaking spaces before its colons, and no longer parse
51
+ def prosemirror_json?(input)
52
+ input.is_a?(String) && input.start_with?('{"type":"doc"')
53
+ end
54
+
37
55
  def format_string!
38
56
  remove_double_spaces
39
57
  add_nbsp
@@ -79,6 +97,18 @@ module Trek
79
97
  regexp = /(?<=\S)(\p{Zs}?(#{chars.join("|")}))/
80
98
  @output.gsub!(regexp, "#{space}\\2")
81
99
  end
100
+
101
+ word_end = "\\p{Zs}|\\z|[#{WORD_ENDING_SIGNS.join}.,…»”)\\]]"
102
+ # Not after another sign: "Quoi?!" gets one space, before the group
103
+ not_after_sign = "(?<![\\p{Zs}\\s#{WORD_ENDING_SIGNS.join}])"
104
+
105
+ SPACE_BEFORE_WORD_ENDING_CHARS.each do |space, chars|
106
+ signs = chars.join("|")
107
+ # Repairs what earlier versions spaced inside a word: "10 :30", "https ://"
108
+ @output.gsub!(/[#{NBSP}#{NNBSP}](#{signs})(?!#{word_end})/, "\\1")
109
+ @output.gsub!(/(?<=\S)\p{Zs}+(#{signs})(?=#{word_end})/, "#{space}\\1")
110
+ @output.gsub!(/#{not_after_sign}(#{signs})(?=#{word_end})/, "#{space}\\1")
111
+ end
82
112
  end
83
113
 
84
114
  def add_nbsp_before_units
@@ -87,7 +117,7 @@ module Trek
87
117
  end
88
118
 
89
119
  def add_nbsp_after_chars
90
- regexp = /((#{NBSP_AFTER_CHARS.join("|")})\p{Zs}?)(?=\w)/
120
+ regexp = /((#{NBSP_AFTER_CHARS.join("|")})\p{Zs}?)(?=[\p{L}\p{N}])/
91
121
  @output.gsub!(regexp, "\\2#{NBSP}")
92
122
  end
93
123
 
@@ -109,7 +139,8 @@ module Trek
109
139
  end
110
140
 
111
141
  def replace_apostrophes
112
- @output.gsub!(/(?<=\w)'(?=\w)/, "\u2019")
142
+ # Letters with accents too (l'\u00e9t\u00e9), which `\w` doesn't match
143
+ @output.gsub!(/(?<=[\p{L}\p{N}])'(?=[\p{L}\p{N}])/, "\u2019")
113
144
  end
114
145
 
115
146
  def remove_spaces_before_attached_punctuation
data/lib/trek/version.rb CHANGED
@@ -1,5 +1,5 @@
1
1
  # frozen_string_literal: true
2
2
 
3
3
  module Trek
4
- VERSION = "2.4.0"
4
+ VERSION = "2.6.0"
5
5
  end
data/lib/trek.rb CHANGED
@@ -14,7 +14,7 @@ require "kaminari"
14
14
  require "mobility"
15
15
  require "phonelib"
16
16
  require "postmark-rails"
17
- require "prosemirror_to_html"
17
+ require "prosemirror"
18
18
  require "rails-i18n"
19
19
  require "shrine"
20
20
  require "shrine/plugins/blurhash"
data/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "trek",
3
- "version": "2.4.0",
3
+ "version": "2.6.0",
4
4
  "description": "A modern content management & back-office system for Ruby on Rails",
5
5
  "homepage": "https://trek.etamin.studio",
6
6
  "license": "MIT",
@@ -20,16 +20,15 @@
20
20
  },
21
21
  "author": "Etamin Studio",
22
22
  "dependencies": {
23
+ "@floating-ui/dom": "^1.8.0",
23
24
  "@fontsource/inter": "^5.3.0",
24
25
  "@hotwired/stimulus": "^3.2.2",
25
26
  "@hotwired/turbo-rails": "^8.0.20",
26
27
  "@radix-ui/colors": "^3.0.0",
27
- "@tiptap/core": "^2.1.11",
28
- "@tiptap/extension-floating-menu": "^2.1.11",
29
- "@tiptap/extension-link": "^2.1.11",
30
- "@tiptap/extension-placeholder": "^2.1.11",
31
- "@tiptap/pm": "^2.1.11",
32
- "@tiptap/starter-kit": "^2.1.11",
28
+ "@tiptap/core": "^3.32.0",
29
+ "@tiptap/extension-floating-menu": "^3.32.0",
30
+ "@tiptap/pm": "^3.32.0",
31
+ "@tiptap/starter-kit": "^3.32.0",
33
32
  "@uppy/core": "^3.0.4",
34
33
  "@uppy/locales": "^3.0.1",
35
34
  "@uppy/thumbnail-generator": "^3.0.2",
@@ -42,11 +41,13 @@
42
41
  "tom-select": "^2.2.2"
43
42
  },
44
43
  "devDependencies": {
44
+ "@vitest/browser-playwright": "^5.0.5",
45
45
  "esbuild": "^0.28.0",
46
46
  "esbuild-rails": "^1.0.7",
47
47
  "esbuild-style-plugin": "^1.6.3",
48
48
  "eslint": "^8.49.0",
49
49
  "eslint-config-prettier": "^8.10.2",
50
+ "playwright": "^1.64.1",
50
51
  "postcss": "^8.4.30",
51
52
  "postcss-flexbugs-fixes": "^5.0.2",
52
53
  "postcss-import": "^15.1.0",
@@ -57,11 +58,14 @@
57
58
  "stylelint": "^15.11.0",
58
59
  "stylelint-config-standard": "^31.0.0",
59
60
  "stylelint-order": "^6.0.4",
61
+ "vite": "^8.3.5",
60
62
  "vitepress": "^1.6.4",
61
- "vitepress-plugin-llms": "^1.13.1"
63
+ "vitepress-plugin-llms": "^1.13.1",
64
+ "vitest": "^5.0.5"
62
65
  },
63
66
  "packageManager": "yarn@4.18.1",
64
67
  "scripts": {
68
+ "test": "vitest run",
65
69
  "docs:dev": "vitepress dev docs",
66
70
  "docs:build": "vitepress build docs",
67
71
  "docs:preview": "vitepress preview docs"
data/renovate.json CHANGED
@@ -1,6 +1,7 @@
1
1
  {
2
2
  "$schema": "https://docs.renovatebot.com/renovate-schema.json",
3
3
  "extends": ["local>devops/renovate-runner"],
4
+ "addLabels": ["feature::dependencies"],
4
5
  "customManagers": [
5
6
  {
6
7
  "customType": "regex",
data/trek.gemspec CHANGED
@@ -11,7 +11,7 @@ Gem::Specification.new do |spec|
11
11
  spec.summary = "A modern content management & back-office system for Ruby on Rails"
12
12
  spec.homepage = "https://trek.etamin.studio"
13
13
  spec.license = "MIT"
14
- spec.required_ruby_version = ">= 3.1.0"
14
+ spec.required_ruby_version = ">= 3.3.0"
15
15
 
16
16
  spec.metadata["homepage_uri"] = spec.homepage
17
17
  spec.metadata["documentation_uri"] = spec.homepage
@@ -50,8 +50,8 @@ Gem::Specification.new do |spec|
50
50
  spec.add_dependency "mobility", "~> 1.3.2"
51
51
  spec.add_dependency "phonelib", "~> 0.8"
52
52
  spec.add_dependency "postmark-rails"
53
- spec.add_dependency "prosemirror_to_html", "~> 0.2"
54
- spec.add_dependency "rails", [">= 6.0", "< 8.2"]
53
+ spec.add_dependency "prosemirror", ">= 1.0", "< 2"
54
+ spec.add_dependency "rails", [">= 8.0", "< 8.2"]
55
55
  spec.add_dependency "rails-healthcheck"
56
56
  spec.add_dependency "rails-i18n", ">= 6.0"
57
57
  spec.add_dependency "shrine", "~> 3.0"
data/vitest.config.mjs ADDED
@@ -0,0 +1,24 @@
1
+ import { defineConfig } from "vitest/config";
2
+ import { playwright } from "@vitest/browser-playwright";
3
+
4
+ // JavaScript tests (yarn test): the admin's Stimulus controllers, with their libraries, in a headless Chrome.
5
+ export default defineConfig({
6
+ test: {
7
+ include: ["spec/javascript/**/*.test.js"],
8
+ browser: {
9
+ enabled: true,
10
+ headless: true,
11
+ // The Chrome installed on the machine, as the system specs use: Playwright downloads none. CI's image
12
+ // has Debian's Chromium instead, at CHROME_PATH.
13
+ provider: playwright({
14
+ launchOptions: process.env.CHROME_PATH
15
+ ? { executablePath: process.env.CHROME_PATH }
16
+ : { channel: "chrome" },
17
+ }),
18
+ instances: [{ browser: "chromium" }],
19
+ },
20
+ },
21
+ // The components import their CSS, which the tests don't need: without this, Vite would load
22
+ // postcss.config.js, written for the esbuild build.
23
+ css: { postcss: {} },
24
+ });