trek 2.5.0 → 2.7.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 (232) hide show
  1. checksums.yaml +4 -4
  2. data/.node-version +1 -1
  3. data/AGENTS.md +18 -14
  4. data/CHANGELOG.md +88 -0
  5. data/Gemfile +5 -0
  6. data/Gemfile.lock +135 -124
  7. data/Makefile +9 -1
  8. data/README.md +17 -21
  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 +9 -8
  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/image_field_component.js +1 -2
  23. data/app/components/trek/form/image_field_component.rb +36 -9
  24. data/app/components/trek/form/password_strength_component/password_strength_component.css +2 -0
  25. data/app/components/trek/form/sound_field_component/sound_field_component.js +1 -2
  26. data/app/components/trek/security_check_component/security_check_component.css +69 -0
  27. data/app/components/trek/security_check_component/security_check_component.html.slim +19 -0
  28. data/app/components/trek/security_check_component/security_check_component.js +15 -0
  29. data/app/components/trek/security_check_component.rb +19 -0
  30. data/app/content/trek/content/cleaner.rb +53 -0
  31. data/app/content/trek/content/document.rb +2 -2
  32. data/app/content/trek/content/list_item.rb +1 -1
  33. data/app/content/trek/content/paragraph.rb +7 -2
  34. data/app/content/trek/content/prompts_block.rb +1 -2
  35. data/app/content/trek/content.rb +6 -0
  36. data/app/controllers/concerns/trek/auditable.rb +5 -2
  37. data/app/controllers/concerns/trek/localization.rb +6 -2
  38. data/app/controllers/concerns/trek/reorderable.rb +24 -6
  39. data/app/controllers/trek/csp_reports_controller.rb +14 -1
  40. data/app/controllers/trek/panels/prompts_controller.rb +1 -1
  41. data/app/controllers/trek/resource_controller.rb +5 -5
  42. data/app/jobs/trek/purge_expired_sessions_job.rb +4 -3
  43. data/app/jobs/trek/purge_expired_sign_in_codes_job.rb +15 -0
  44. data/app/models/concerns/trek/contentable.rb +15 -1
  45. data/app/models/concerns/trek/users/sign_in_code.rb +70 -0
  46. data/app/models/concerns/trek/users/sign_in_lockout.rb +4 -2
  47. data/app/policies/trek/security_check_policy.rb +8 -0
  48. data/app/uploaders/image_uploader.rb +77 -15
  49. data/app/views/trek/panels/links/_form.html.slim +2 -4
  50. data/app/views/trek/panels/prompts/create.turbo_stream.slim +0 -1
  51. data/config/locales/trek.en.yml +97 -11
  52. data/config/locales/trek.fr.yml +97 -11
  53. data/docs/.vitepress/config.mjs +5 -1
  54. data/docs/background-jobs.md +74 -0
  55. data/docs/content-editor.md +219 -0
  56. data/docs/customize.md +2 -0
  57. data/docs/deploy.md +69 -6
  58. data/docs/getting-started.md +16 -18
  59. data/docs/index.md +2 -2
  60. data/docs/personal-data.md +61 -0
  61. data/docs/proxies.md +2 -2
  62. data/docs/reference/components.md +4 -4
  63. data/docs/reference/concerns/contentable.md +10 -4
  64. data/docs/reference/concerns/formattable.md +1 -1
  65. data/docs/reference/concerns/fragmentable.md +12 -6
  66. data/docs/reference/concerns/orderable.md +2 -2
  67. data/docs/reference/concerns/search-engine-optimizable.md +1 -1
  68. data/docs/reference/concerns/searchable.md +14 -1
  69. data/docs/reference/concerns/sectionable.md +7 -3
  70. data/docs/reference/concerns/versionable.md +1 -1
  71. data/docs/reference/controllers.md +33 -1
  72. data/docs/reference/environment-variables.md +3 -2
  73. data/docs/reference/formatters.md +4 -31
  74. data/docs/reference/forms.md +7 -4
  75. data/docs/reference/generators/admin-user.md +1 -1
  76. data/docs/reference/generators/audit-log.md +12 -13
  77. data/docs/reference/generators/install.md +23 -11
  78. data/docs/reference/generators/public-accounts.md +159 -0
  79. data/docs/reference/generators/scaffold.md +28 -9
  80. data/docs/reference/generators/security-headers.md +5 -4
  81. data/docs/reference/generators/taxonomies.md +1 -1
  82. data/docs/reference/icons.md +5 -3
  83. data/docs/reference/index.md +10 -7
  84. data/docs/reference/models/current.md +5 -3
  85. data/docs/reference/models/page-version.md +1 -1
  86. data/docs/reference/models/user.md +7 -8
  87. data/docs/reference/uploaders.md +25 -0
  88. data/docs/reference/validators.md +1 -1
  89. data/docs/security.md +30 -9
  90. data/docs/what-is-trek.md +4 -4
  91. data/lib/generators/trek/USAGE +1 -1
  92. data/lib/generators/trek/audit_log_generator.rb +62 -0
  93. data/lib/generators/trek/helpers.rb +17 -0
  94. data/lib/generators/trek/install/admin/routes_generator.rb +2 -1
  95. data/lib/generators/trek/install/admin/security_check_generator.rb +36 -0
  96. data/lib/generators/trek/install/admin/users_generator.rb +6 -1
  97. data/lib/generators/trek/install/audit_log_generator.rb +9 -45
  98. data/lib/generators/trek/install/ci_generator.rb +19 -0
  99. data/lib/generators/trek/install/good_job_generator.rb +161 -0
  100. data/lib/generators/trek/install/model_specs_generator.rb +3 -3
  101. data/lib/generators/trek/install/postcss_generator.rb +1 -2
  102. data/lib/generators/trek/install/ruby_generator.rb +1 -1
  103. data/lib/generators/trek/install/scalingo_generator.rb +7 -45
  104. data/lib/generators/trek/install/translations_generator.rb +1 -2
  105. data/lib/generators/trek/install_generator.rb +18 -2
  106. data/lib/generators/trek/public_accounts_generator.rb +294 -0
  107. data/lib/generators/trek/scaffold_generator.rb +22 -21
  108. data/lib/generators/trek/scalingo_generator.rb +67 -0
  109. data/lib/generators/trek/templates/.gitlab-ci.yml +10 -1
  110. data/lib/generators/trek/templates/AGENTS.md +2 -2
  111. data/lib/generators/trek/templates/Makefile +1 -0
  112. data/lib/generators/trek/templates/config/i18n-tasks.yml.erb +0 -8
  113. data/lib/generators/trek/templates/controllers/admin/password_renewals_controller.rb +11 -0
  114. data/lib/generators/trek/templates/controllers/admin/security_checks_controller.rb +11 -0
  115. data/lib/generators/trek/templates/controllers/admin/user_sessions_controller.rb +1 -1
  116. data/lib/generators/trek/templates/controllers/admin/users_controller.rb +0 -8
  117. data/lib/generators/trek/templates/controllers/concerns/trek/authentication.rb +13 -4
  118. data/lib/generators/trek/templates/initializers/content_security_policy.rb +3 -2
  119. data/lib/generators/trek/templates/initializers/good_job.rb.tt +40 -0
  120. data/lib/generators/trek/templates/jobs/mail_delivery_job.rb +6 -0
  121. data/lib/generators/trek/templates/layouts/admin.html.slim +10 -0
  122. data/lib/generators/trek/templates/mailers/admin_mailer.rb +4 -2
  123. data/lib/generators/trek/templates/package.json.tt +1 -1
  124. data/lib/generators/trek/templates/policies/security_check.rb +4 -0
  125. data/lib/generators/trek/templates/public_accounts/api/authentication.rb.tt +76 -0
  126. data/lib/generators/trek/templates/public_accounts/api/controllers/accounts_controller.rb.tt +22 -0
  127. data/lib/generators/trek/templates/public_accounts/api/controllers/active_sessions_controller.rb.tt +21 -0
  128. data/lib/generators/trek/templates/public_accounts/api/controllers/base_controller.rb.tt +71 -0
  129. data/lib/generators/trek/templates/public_accounts/api/controllers/email_changes_controller.rb.tt +55 -0
  130. data/lib/generators/trek/templates/public_accounts/api/controllers/email_confirmations_controller.rb.tt +19 -0
  131. data/lib/generators/trek/templates/public_accounts/api/controllers/password_resets_controller.rb.tt +28 -0
  132. data/lib/generators/trek/templates/public_accounts/api/controllers/passwords_controller.rb.tt +17 -0
  133. data/lib/generators/trek/templates/public_accounts/api/controllers/registrations_controller.rb.tt +17 -0
  134. data/lib/generators/trek/templates/public_accounts/api/controllers/sessions_controller.rb.tt +57 -0
  135. data/lib/generators/trek/templates/public_accounts/api/controllers/sign_in_codes_controller.rb.tt +20 -0
  136. data/lib/generators/trek/templates/public_accounts/jobs/sign_in_code_job.rb.tt +23 -0
  137. data/lib/generators/trek/templates/public_accounts/locales/accounts.en.yml.tt +215 -0
  138. data/lib/generators/trek/templates/public_accounts/locales/accounts.fr.yml.tt +215 -0
  139. data/lib/generators/trek/templates/public_accounts/mailers/account_mailer.rb.tt +85 -0
  140. data/lib/generators/trek/templates/public_accounts/migrations/create_accounts.rb.tt +46 -0
  141. data/lib/generators/trek/templates/public_accounts/models/account/session.rb.tt +47 -0
  142. data/lib/generators/trek/templates/public_accounts/models/account/sign_in_code.rb.tt +8 -0
  143. data/lib/generators/trek/templates/public_accounts/models/account.rb.tt +87 -0
  144. data/lib/generators/trek/templates/public_accounts/spec/api/accounts_spec.rb.tt +90 -0
  145. data/lib/generators/trek/templates/public_accounts/spec/api/sign_ins_spec.rb.tt +188 -0
  146. data/lib/generators/trek/templates/public_accounts/spec/models/account/sign_in_code_spec.rb.tt +66 -0
  147. data/lib/generators/trek/templates/public_accounts/spec/models/account_spec.rb.tt +129 -0
  148. data/lib/generators/trek/templates/public_accounts/spec/web/accounts_spec.rb.tt +126 -0
  149. data/lib/generators/trek/templates/public_accounts/spec/web/authentication_spec.rb.tt +43 -0
  150. data/lib/generators/trek/templates/public_accounts/spec/web/sign_ins_spec.rb.tt +237 -0
  151. data/lib/generators/trek/templates/public_accounts/views/mailer/email_change.en.html.slim.tt +10 -0
  152. data/lib/generators/trek/templates/public_accounts/views/mailer/email_change.en.text.erb.tt +8 -0
  153. data/lib/generators/trek/templates/public_accounts/views/mailer/email_change.fr.html.slim.tt +13 -0
  154. data/lib/generators/trek/templates/public_accounts/views/mailer/email_change.fr.text.erb.tt +8 -0
  155. data/lib/generators/trek/templates/public_accounts/views/mailer/email_change_code.en.html.slim.tt +9 -0
  156. data/lib/generators/trek/templates/public_accounts/views/mailer/email_change_code.en.text.erb.tt +11 -0
  157. data/lib/generators/trek/templates/public_accounts/views/mailer/email_change_code.fr.html.slim.tt +11 -0
  158. data/lib/generators/trek/templates/public_accounts/views/mailer/email_change_code.fr.text.erb.tt +11 -0
  159. data/lib/generators/trek/templates/public_accounts/views/mailer/email_confirmation.en.html.slim.tt +10 -0
  160. data/lib/generators/trek/templates/public_accounts/views/mailer/email_confirmation.en.text.erb.tt +8 -0
  161. data/lib/generators/trek/templates/public_accounts/views/mailer/email_confirmation.fr.html.slim.tt +10 -0
  162. data/lib/generators/trek/templates/public_accounts/views/mailer/email_confirmation.fr.text.erb.tt +8 -0
  163. data/lib/generators/trek/templates/public_accounts/views/mailer/password_reset.en.html.slim.tt +10 -0
  164. data/lib/generators/trek/templates/public_accounts/views/mailer/password_reset.en.text.erb.tt +8 -0
  165. data/lib/generators/trek/templates/public_accounts/views/mailer/password_reset.fr.html.slim.tt +13 -0
  166. data/lib/generators/trek/templates/public_accounts/views/mailer/password_reset.fr.text.erb.tt +8 -0
  167. data/lib/generators/trek/templates/public_accounts/views/mailer/sign_in_code.en.html.slim.tt +9 -0
  168. data/lib/generators/trek/templates/public_accounts/views/mailer/sign_in_code.en.text.erb.tt +11 -0
  169. data/lib/generators/trek/templates/public_accounts/views/mailer/sign_in_code.fr.html.slim.tt +9 -0
  170. data/lib/generators/trek/templates/public_accounts/views/mailer/sign_in_code.fr.text.erb.tt +11 -0
  171. data/lib/generators/trek/templates/public_accounts/views/mailer/sign_in_locked.en.html.slim.tt +23 -0
  172. data/lib/generators/trek/templates/public_accounts/views/mailer/sign_in_locked.en.text.erb.tt +14 -0
  173. data/lib/generators/trek/templates/public_accounts/views/mailer/sign_in_locked.fr.html.slim.tt +24 -0
  174. data/lib/generators/trek/templates/public_accounts/views/mailer/sign_in_locked.fr.text.erb.tt +14 -0
  175. data/lib/generators/trek/templates/public_accounts/web/authentication.rb.tt +97 -0
  176. data/lib/generators/trek/templates/public_accounts/web/controllers/accounts_controller.rb.tt +33 -0
  177. data/lib/generators/trek/templates/public_accounts/web/controllers/active_sessions_controller.rb.tt +15 -0
  178. data/lib/generators/trek/templates/public_accounts/web/controllers/base_controller.rb.tt +52 -0
  179. data/lib/generators/trek/templates/public_accounts/web/controllers/email_changes_controller.rb.tt +85 -0
  180. data/lib/generators/trek/templates/public_accounts/web/controllers/email_confirmations_controller.rb.tt +19 -0
  181. data/lib/generators/trek/templates/public_accounts/web/controllers/password_resets_controller.rb.tt +41 -0
  182. data/lib/generators/trek/templates/public_accounts/web/controllers/passwords_controller.rb.tt +23 -0
  183. data/lib/generators/trek/templates/public_accounts/web/controllers/registrations_controller.rb.tt +24 -0
  184. data/lib/generators/trek/templates/public_accounts/web/controllers/sessions_controller.rb.tt +85 -0
  185. data/lib/generators/trek/templates/public_accounts/web/controllers/sign_in_codes_controller.rb.tt +32 -0
  186. data/lib/generators/trek/templates/public_accounts/web/views/_flash.html.slim.tt +5 -0
  187. data/lib/generators/trek/templates/public_accounts/web/views/accounts/show.html.slim.tt +52 -0
  188. data/lib/generators/trek/templates/public_accounts/web/views/email_changes/edit.html.slim.tt +17 -0
  189. data/lib/generators/trek/templates/public_accounts/web/views/email_changes/new.html.slim.tt +15 -0
  190. data/lib/generators/trek/templates/public_accounts/web/views/password_resets/edit.html.slim.tt +29 -0
  191. data/lib/generators/trek/templates/public_accounts/web/views/password_resets/new.html.slim.tt +15 -0
  192. data/lib/generators/trek/templates/public_accounts/web/views/passwords/edit.html.slim.tt +28 -0
  193. data/lib/generators/trek/templates/public_accounts/web/views/registrations/new.html.slim.tt +30 -0
  194. data/lib/generators/trek/templates/public_accounts/web/views/sessions/new.html.slim.tt +40 -0
  195. data/lib/generators/trek/templates/public_accounts/web/views/sign_in_codes/new.html.slim.tt +17 -0
  196. data/lib/generators/trek/templates/spec/jobs/mail_delivery_job_spec.rb +11 -0
  197. data/lib/generators/trek/templates/spec/mailers/admin_mailer_spec.rb +10 -0
  198. data/lib/generators/trek/templates/spec/requests/admin/fragments_spec.rb +1 -1
  199. data/lib/generators/trek/templates/spec/requests/admin/good_job_spec.rb +34 -0
  200. data/lib/generators/trek/templates/spec/requests/admin/pages_spec.rb +12 -1
  201. data/lib/generators/trek/templates/spec/requests/admin/panels_spec.rb +16 -0
  202. data/lib/generators/trek/templates/spec/requests/admin/password_renewal_spec.rb +2 -2
  203. data/lib/generators/trek/templates/spec/requests/admin/security_checks_spec.rb +24 -0
  204. data/lib/generators/trek/templates/spec/requests/admin/sign_in_lockout_spec.rb +1 -1
  205. data/lib/generators/trek/templates/spec/requests/admin/sign_in_notices_spec.rb +33 -0
  206. data/lib/generators/trek/templates/spec/requests/admin/user_sessions_spec.rb +2 -2
  207. data/lib/generators/trek/templates/views/admin/pages/_form.html.slim +1 -1
  208. data/lib/generators/trek/templates/views/admin/security_checks/show.html.slim +9 -0
  209. data/lib/generators/trek/templates/views/admin/user_password_resets/edit.html.slim +6 -1
  210. data/lib/generators/trek/templates/views/admin/user_sessions/new.html.slim +4 -1
  211. data/lib/generators/trek/templates/views/admin/users/index.html.slim +1 -1
  212. data/lib/generators/trek/templates/views/admin_mailer/new_sign_in.en.html.slim +1 -1
  213. data/lib/generators/trek/templates/views/admin_mailer/new_sign_in.en.text.erb +1 -1
  214. data/lib/generators/trek/templates/views/admin_mailer/new_sign_in.fr.html.slim +1 -1
  215. data/lib/generators/trek/templates/views/admin_mailer/new_sign_in.fr.text.erb +1 -1
  216. data/lib/tasks/trek/attachments.rake +12 -0
  217. data/lib/tasks/trek/security.rake +10 -0
  218. data/lib/trek/csp_reports.rb +22 -4
  219. data/lib/trek/disposable_email_domains.rb +9 -20
  220. data/lib/trek/engine.rb +5 -0
  221. data/lib/trek/json_compatibility.rb +20 -0
  222. data/lib/trek/security_check.rb +241 -0
  223. data/lib/trek/stored_image_metadata.rb +88 -0
  224. data/lib/trek/typography_formatter.rb +35 -4
  225. data/lib/trek/version.rb +1 -1
  226. data/lib/trek.rb +2 -1
  227. data/package.json +16 -13
  228. data/postcss.config.js +0 -3
  229. data/trek.gemspec +6 -7
  230. data/vitest.config.mjs +24 -0
  231. data/yarn.lock +1667 -1010
  232. metadata +122 -33
@@ -0,0 +1,28 @@
1
+ = render "<%= accounts_path %>/flash"
2
+
3
+ h1 = t(".title")
4
+ ruby:
5
+ rules = {
6
+ min: @<%= file_name %>.password_min_length,
7
+ passphrase: @<%= file_name %>.passphrase_length
8
+ }
9
+ p = t(".intro", **rules)
10
+
11
+ / Without Turbo: password managers offer to save the password in an element they add to the
12
+ next page's body, which a Turbo visit would replace
13
+ = form_with model: @<%= file_name %>, url: <%= route_prefix %>_password_path, method: :patch,
14
+ data: { turbo: false } do |f|
15
+ - if @<%= file_name %>.errors.any?
16
+ ul(role="alert")
17
+ - @<%= file_name %>.errors.full_messages.each do |message|
18
+ li = message
19
+ = f.label :password
20
+ = f.password_field :password,
21
+ required: true,
22
+ autofocus: true,
23
+ autocomplete: "new-password",
24
+ maxlength: 72,
25
+ minlength: @<%= file_name %>.password_min_length
26
+ = f.submit t(".submit")
27
+
28
+ p = link_to t(".back"), <%= route_prefix %>_account_path
@@ -0,0 +1,30 @@
1
+ = render "<%= accounts_path %>/flash"
2
+
3
+ h1 = t(".title")
4
+
5
+ / Without Turbo: password managers offer to save the password in an element they add to the
6
+ next page's body, which a Turbo visit would replace
7
+ = form_with model: @<%= file_name %>, url: <%= route_prefix %>_sign_up_path, data: { turbo: false } do |f|
8
+ - if @<%= file_name %>.errors.any?
9
+ ul(role="alert")
10
+ - @<%= file_name %>.errors.full_messages.each do |message|
11
+ li = message
12
+ = f.label :email
13
+ = f.email_field :email, required: true, autofocus: true, autocomplete: "email"
14
+ = f.label :name
15
+ = f.text_field :name, autocomplete: "name"
16
+ = f.label :password
17
+ ruby:
18
+ rules = {
19
+ min: @<%= file_name %>.password_min_length,
20
+ passphrase: @<%= file_name %>.passphrase_length
21
+ }
22
+ p = t(".rules", **rules)
23
+ = f.password_field :password,
24
+ required: true,
25
+ autocomplete: "new-password",
26
+ maxlength: 72,
27
+ minlength: @<%= file_name %>.password_min_length
28
+ = f.submit t(".submit")
29
+
30
+ p = link_to t(".sign_in"), <%= route_prefix %>_sign_in_path
@@ -0,0 +1,40 @@
1
+ = render "<%= accounts_path %>/flash"
2
+
3
+ h1 = t(".title")
4
+ <% if code? -%>
5
+ - validity = distance_of_time_in_words(0, <%= class_name %>::SignInCode.validity)
6
+ p = t(".intro", email: @email, validity:)
7
+
8
+ = form_with url: <%= route_prefix %>_sign_in_code_path do |f|
9
+ = f.label :otp, t(".code")
10
+ = f.text_field :otp,
11
+ required: true,
12
+ autofocus: true,
13
+ autocomplete: "one-time-code",
14
+ inputmode: "numeric",
15
+ pattern: "[0-9 ]*",
16
+ maxlength: 7
17
+ = f.submit t(".submit")
18
+
19
+ p = link_to t(".other_email"), <%= route_prefix %>_sign_in_path
20
+ <% else -%>
21
+
22
+ / Without Turbo: password managers offer to save the password in an element they add to the
23
+ next page's body, which a Turbo visit would replace
24
+ = form_with url: <%= route_prefix %>_sign_in_path, data: { turbo: false } do |f|
25
+ = f.label :email, <%= class_name %>.human_attribute_name(:email)
26
+ = f.email_field :email,
27
+ value: @email,
28
+ required: true,
29
+ autofocus: true,
30
+ autocomplete: "username"
31
+ = f.label :password, <%= class_name %>.human_attribute_name(:password)
32
+ = f.password_field :password,
33
+ required: true,
34
+ autocomplete: "current-password",
35
+ maxlength: 72
36
+ = f.submit t(".submit")
37
+
38
+ p = link_to t(".forgot_password"), new_<%= route_prefix %>_password_reset_path
39
+ p = link_to t(".sign_up"), <%= route_prefix %>_sign_up_path
40
+ <% end -%>
@@ -0,0 +1,17 @@
1
+ = render "<%= accounts_path %>/flash"
2
+
3
+ h1 = t(".title")
4
+ p = t(".intro")
5
+
6
+ = form_with url: <%= route_prefix %>_sign_in_path do |f|
7
+ = f.label :email, <%= class_name %>.human_attribute_name(:email)
8
+ = f.email_field :email,
9
+ value: @email,
10
+ required: true,
11
+ autofocus: true,
12
+ autocomplete: "email"
13
+ = f.submit t(".submit")
14
+ <% if password? -%>
15
+
16
+ p = link_to t(".password"), <%= route_prefix %>_password_sign_in_path
17
+ <% end -%>
@@ -0,0 +1,11 @@
1
+ require "rails_helper"
2
+
3
+ RSpec.describe MailDeliveryJob, type: :job do
4
+ it "delivers the mail enqueued by deliver_later" do
5
+ expect(ActionMailer::Base.delivery_job).to eq(described_class)
6
+ end
7
+
8
+ it "retries a failed delivery instead of discarding it" do
9
+ expect(described_class.rescue_handlers.map(&:first)).to include("StandardError")
10
+ end
11
+ end
@@ -15,6 +15,9 @@ RSpec.describe AdminMailer do
15
15
  end
16
16
 
17
17
  describe "the new sign-in email" do
18
+ # No DNS lookup in specs: an address without a host name, unless an example gives one
19
+ before { allow(Trek::ReverseDns).to receive(:hostname).and_return(nil) }
20
+
18
21
  # In English whatever the app's default locale: the examples read English words
19
22
  let(:user) { users.create(role: :editor, locale: "en") }
20
23
  let(:mail) do
@@ -30,6 +33,13 @@ RSpec.describe AdminMailer do
30
33
  expect(mail.text_part.body.to_s).to include("Firefox on Windows").and include("203.0.113.7")
31
34
  end
32
35
 
36
+ it "names the address's host, as the active sessions do", :aggregate_failures do
37
+ allow(Trek::ReverseDns).to receive(:hostname).with("203.0.113.7").and_return("host.example.net")
38
+
39
+ expect(mail.text_part.body.to_s).to include("203.0.113.7 (host.example.net)")
40
+ expect(mail.html_part.body.to_s).to include("203.0.113.7 (host.example.net)")
41
+ end
42
+
33
43
  it "links to the active sessions and to a password reset" do
34
44
  expect(mail.html_part.body.to_s).to include("#sessions").and include("user_password_resets/new")
35
45
  end
@@ -53,7 +53,7 @@ RSpec.describe "Admin fragments", type: :request do
53
53
  it "refuses a key already used in the namespace" do
54
54
  post admin_fragments_path, params: { fragment: { key: "footer", namespace: "layout", title: "Another footer" } }
55
55
 
56
- expect(response).to have_http_status(:unprocessable_entity)
56
+ expect(response).to have_http_status(:unprocessable_content)
57
57
  end
58
58
 
59
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
@@ -34,7 +34,7 @@ RSpec.describe "Admin pages", type: :request do
34
34
  it "refuses a page without a title" do
35
35
  post admin_pages_path, params: { page: { title: "" } }
36
36
 
37
- expect(response).to have_http_status(:unprocessable_entity)
37
+ expect(response).to have_http_status(:unprocessable_content)
38
38
  end
39
39
 
40
40
  it "renders the edit form" do
@@ -43,6 +43,17 @@ RSpec.describe "Admin pages", type: :request do
43
43
  expect(response).to have_http_status(:ok)
44
44
  end
45
45
 
46
+ it "renders the edit form of a page made of sections, without versions" do
47
+ page = pages.create(title: "Our offices", sectioned: true)
48
+ # Sections are the app's own Section model, which Trek doesn't generate: none here
49
+ page.define_singleton_method(:sections_instances) { [] }
50
+ allow(Page).to receive(:find).and_return(page)
51
+
52
+ get edit_admin_page_path(page)
53
+
54
+ expect(response).to have_http_status(:ok)
55
+ end
56
+
46
57
  it "updates a page" do
47
58
  patch admin_page_path(pages.team), params: { page: { title: "The team" } }
48
59
 
@@ -51,4 +51,20 @@ RSpec.describe "Admin content editor panels", type: :request do
51
51
 
52
52
  expect(response).to have_http_status(:ok)
53
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
54
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
@@ -0,0 +1,24 @@
1
+ require "rails_helper"
2
+
3
+ RSpec.describe "Admin security check", type: :request do
4
+ def sign_in(user)
5
+ post admin_user_session_path, params: { email: user.email, password: users.password }
6
+ end
7
+
8
+ it "checks the settings, and this request, for an admin" do
9
+ sign_in(users.create(role: :admin))
10
+
11
+ get admin_security_check_path
12
+
13
+ # The test request comes over HTTP, as no proxy forwards the scheme
14
+ expect(response.body).to include("X-Forwarded-Proto")
15
+ end
16
+
17
+ it "is closed to an editor" do
18
+ sign_in(users.create(role: :editor))
19
+
20
+ get admin_security_check_path
21
+
22
+ expect(response).to redirect_to(admin_root_path)
23
+ end
24
+ 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
@@ -16,6 +16,12 @@ RSpec.describe "Admin sign-in notices", type: :request do
16
16
  delete admin_user_session_path
17
17
  end
18
18
 
19
+ # A cookie jar reading, or writing, the browser's trek_known_users cookie as the app does
20
+ def cookie_jar(value = nil)
21
+ env = Rails.application.env_config.merge("HTTP_COOKIE" => value ? "trek_known_users=#{Rack::Utils.escape(value)}" : "")
22
+ ActionDispatch::Request.new(env).cookie_jar
23
+ end
24
+
19
25
  describe "the previous sign-in" do
20
26
  it "keeps the sign-in notice short" do
21
27
  sign_in(editor)
@@ -84,6 +90,33 @@ RSpec.describe "Admin sign-in notices", type: :request do
84
90
  expect { sign_in(editor) }.to have_enqueued_mail(AdminMailer, :new_sign_in)
85
91
  end
86
92
 
93
+ it "is sent from a browser that didn't sign in for 13 months" do
94
+ sign_in(editor)
95
+ sign_out
96
+ travel 13.months + 1.day
97
+
98
+ expect { sign_in(editor) }.to have_enqueued_mail(AdminMailer, :new_sign_in)
99
+ end
100
+
101
+ # The browser's users can't read who else signed in from it, e.g. on a shared computer
102
+ it "remembers the browser's users in an encrypted cookie" do
103
+ sign_in(editor)
104
+
105
+ expect(cookie_jar(cookies["trek_known_users"]).encrypted[:trek_known_users]).to eq [editor.id]
106
+ end
107
+
108
+ # The cookie was signed only before it was encrypted. Its value isn't escaped: the test's cookie
109
+ # jar sends it as it is, and the app wouldn't unescape the "=" a user id of two digits or more
110
+ # pads it with.
111
+ it "isn't sent from a browser remembered by its signed cookie" do
112
+ sign_in(editor)
113
+ sign_out
114
+ jar = cookie_jar.tap { |writer| writer.signed[:trek_known_users] = [editor.id] }
115
+ cookies["trek_known_users"] = jar["trek_known_users"]
116
+
117
+ expect { sign_in(editor) }.not_to have_enqueued_mail(AdminMailer, :new_sign_in)
118
+ end
119
+
87
120
  it "isn't sent when the app turns it off" do
88
121
  allow(User).to receive(:new_sign_in_email).and_return(false)
89
122
  sign_in(editor)
@@ -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
@@ -36,7 +36,7 @@
36
36
  = f.image_field :image
37
37
 
38
38
  - if @object.sectioned?
39
- - vf.object.sections_instances.each do |section|
39
+ - @object.sections_instances.each do |section|
40
40
  = render Trek::Form::FieldsetComponent.new( \
41
41
  title: "#{section.position}. #{section.model_name.human}",
42
42
  classnames: "section",
@@ -0,0 +1,9 @@
1
+ = render Trek::HeadingComponent.new( \
2
+ title: t(".title"),
3
+ intro: t(".intro",
4
+ time: l(@checked_at, format: :long),
5
+ trek: Trek::VERSION,
6
+ rails: Rails.version),
7
+ )
8
+
9
+ = render Trek::SecurityCheckComponent.new(results: @check.results)
@@ -1,5 +1,10 @@
1
1
  = render Trek::GateComponent.new
2
- = form_with url: admin_user_password_reset_path(@token), method: :put do |f|
2
+ / Without Turbo: password managers offer to save the password in an
3
+ element they add to the next page's body, which a Turbo visit would
4
+ replace
5
+ = form_with url: admin_user_password_reset_path(@token),
6
+ method: :put,
7
+ data: { turbo: false } do |f|
3
8
  ruby:
4
9
  rules = t(
5
10
  ".rules",
@@ -1,5 +1,8 @@
1
1
  = render Trek::GateComponent.new
2
- = form_with url: admin_user_session_path do |f|
2
+ / Without Turbo: password managers offer to save the credentials in an
3
+ element they add to the next page's body, which a Turbo visit would
4
+ replace
5
+ = form_with url: admin_user_session_path, data: { turbo: false } do |f|
3
6
  = f.group :email, model_name: User.model_name
4
7
  / "webauthn" offers the site's passkeys in the field's autofill
5
8
  = f.email_field :email,
@@ -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
 
@@ -14,5 +14,17 @@ namespace :trek do
14
14
 
15
15
  puts statuses.empty? ? "No attachment left in the cache storage." : statuses.map { "#{_2} #{_1}" }.join(", ")
16
16
  end
17
+
18
+ desc "Strip the metadata of the images stored before ImageUploader stripped it (DRY_RUN=1 only lists them)"
19
+ task strip_image_metadata: :environment do
20
+ statuses = Hash.new(0)
21
+
22
+ Trek::StoredImageMetadata.new.strip(dry_run: ENV["DRY_RUN"].present?) do |entry|
23
+ statuses[entry.status] += 1
24
+ puts [entry.status, entry.id].join("\t")
25
+ end
26
+
27
+ puts statuses.empty? ? "No stored image carries metadata." : statuses.map { "#{_2} #{_1}" }.join(", ")
28
+ end
17
29
  end
18
30
  end
@@ -0,0 +1,10 @@
1
+ namespace :trek do
2
+ namespace :security do
3
+ desc "Check the app's configuration against Trek's security recommendations (exits 1 on a failure)"
4
+ task check: :environment do
5
+ check = Trek::SecurityCheck.new
6
+ print check.to_text
7
+ exit 1 if check.failed?
8
+ end
9
+ end
10
+ end
@@ -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)
@@ -1,9 +1,9 @@
1
1
  # frozen_string_literal: true
2
2
 
3
3
  module Trek
4
- # The disposable email domains of the valid_email2 gem, which keeps them up to date. Its file,
5
- # sorted and one domain per line, is kept as a single String (2.6 MB) and searched by bisection:
6
- # valid_email2's own Set of its 180,000 domains grows the process by about 35 MB.
4
+ # The disposable email domains of the valid_email2 gem, which keeps them up to date. They are
5
+ # searched in its sorted file (ValidEmail2::SortedDomainList, about 3 MB) rather than in its own
6
+ # Set of 180,000 domains, which grows the process by about 35 MB.
7
7
  module DisposableEmailDomains
8
8
  # Labels of the longest parent domain checked, as in valid_email2: an address at
9
9
  # inbox.mailinator.com is refused because mailinator.com is listed.
@@ -15,13 +15,17 @@ module Trek
15
15
  domain = domain.to_s.downcase.strip
16
16
  return false if domain.empty? || allowed?(domain)
17
17
 
18
- candidates(domain).any? { |candidate| listed?(candidate) }
18
+ candidates(domain).any? { |candidate| list.include?(candidate) }
19
19
  end
20
20
 
21
21
  private
22
22
 
23
+ # valid_email2's own list when the app chose the sorted one too
24
+ # (ValidEmail2.disposable_domains_lookup = :sorted_list), rather than a second copy
23
25
  def list
24
- @list ||= File.binread(ValidEmail2::DISPOSABLE_FILE).freeze
26
+ return ValidEmail2.disposable_domains if ValidEmail2.disposable_domains_lookup == :sorted_list
27
+
28
+ @list ||= ValidEmail2::SortedDomainList.new(ValidEmail2::DISPOSABLE_FILE)
25
29
  end
26
30
 
27
31
  # The domain and its parents with two labels or more, up to MAX_DEPTH labels
@@ -33,21 +37,6 @@ module Trek
33
37
  def allowed?(domain)
34
38
  candidates(domain).any? { |candidate| ValidEmail2.allow_list.include?(candidate) }
35
39
  end
36
-
37
- def listed?(domain)
38
- domain = domain.b
39
- low, high = 0, list.bytesize
40
- while low < high
41
- middle = (low + high) / 2
42
- start = (list.rindex("\n", middle - 1) || -1) + 1
43
- stop = list.index("\n", start) || list.bytesize
44
- line = list.byteslice(start, stop - start)
45
- return true if line == domain
46
-
47
- line < domain ? low = stop + 1 : high = start
48
- end
49
- false
50
- end
51
40
  end
52
41
  end
53
42
  end
data/lib/trek/engine.rb CHANGED
@@ -31,6 +31,11 @@ module Trek
31
31
  app.deprecators[:trek] = Trek.deprecator
32
32
  end
33
33
 
34
+ # json 3 breaks ActiveSupport before Rails 8.1.4: fail at boot with what to do, not later
35
+ initializer "trek.json_compatibility" do
36
+ Trek::JsonCompatibility.check!
37
+ end
38
+
34
39
  # The default content schema holds node type classes: rebuild it after code reloading
35
40
  config.to_prepare do
36
41
  Trek::Content.clear_default_schema
@@ -0,0 +1,20 @@
1
+ # frozen_string_literal: true
2
+
3
+ module Trek
4
+ # json 3's `JSON.parse` takes keyword options only and rejects unknown ones, so `ActiveSupport::JSON.decode`
5
+ # raises with it before Rails 8.1.4: 8.0 passes `quirks_mode: true`, 8.1.0 to 8.1.3.1 a positional hash. Among
6
+ # what breaks, `db/schema.rb` for jsonb columns with a default. Checked when the app boots, as a gemspec can't
7
+ # make the json it accepts depend on the app's Rails.
8
+ module JsonCompatibility
9
+ class Error < StandardError; end
10
+
11
+ FIRST_RAILS = Gem::Version.new("8.1.4")
12
+
13
+ def self.check!(json: JSON::VERSION, active_support: ActiveSupport.version)
14
+ return if Gem::Version.new(json).segments.first < 3 || Gem::Version.new(active_support) >= FIRST_RAILS
15
+
16
+ raise Error, "json #{json} needs Rails #{FIRST_RAILS} or later (this app has #{active_support}): " \
17
+ "upgrade Rails, or add `gem \"json\", \"< 3\"` to the Gemfile and run `bundle update json`."
18
+ end
19
+ end
20
+ end