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
@@ -2,6 +2,8 @@
2
2
 
3
3
  The host application's `User` model, into which Trek injects authentication (`has_secure_password` and database-backed sessions), roles, theme & locale preferences and the invitation workflow.
4
4
 
5
+ It is the admin's account. The site's or the mobile app's users (customers, members…) get a model of their own, apart from it: see [Public accounts](/reference/generators/public-accounts).
6
+
5
7
  ## Columns added by Trek
6
8
 
7
9
  | Column | Type | Notes |
@@ -68,7 +70,7 @@ Users see their **active sessions** in a tab of their own profile: browser and s
68
70
  `Trek::Users::SignIns` helps users spot a sign-in that wasn't theirs:
69
71
 
70
72
  - the **Active sessions** tab of their profile shows their **previous sign-in**: its date, browser and IP address. It's kept on the user (`last_sign_in_at`, `last_sign_in_ip`, `last_sign_in_user_agent`, with their `current_sign_in_*` counterparts), as sessions are deleted when they end;
71
- - a sign-in from a **browser that never signed in as the user** emails them (`AdminMailer#new_sign_in`): date, browser, IP address, with links to change their password and to their active sessions. A browser is recognized by a signed cookie, kept for years, listing the users who signed in from it. Their very first sign-in sends nothing.
73
+ - a sign-in from a **browser that never signed in as the user** emails them (`AdminMailer#new_sign_in`): date, browser, IP address and its host name (as on the active sessions), with links to change their password and to their active sessions. A browser is recognized by a signed cookie, kept for years, listing the users who signed in from it. Their very first sign-in sends nothing.
72
74
 
73
75
  Set `self.new_sign_in_email = false` in the `User` model to turn the email off.
74
76
 
data/docs/what-is-trek.md CHANGED
@@ -9,7 +9,7 @@ Trek ships as a Rails engine (a gem plus an NPM package) that integrates into yo
9
9
  - **A complete admin panel** — layout, navigation, search, pagination, light & dark themes, all built with [ViewComponent](https://viewcomponent.org), [Stimulus](https://stimulus.hotwired.dev) and [Turbo](https://turbo.hotwired.dev).
10
10
  - **Pages** — hierarchical, translatable pages with version history, SEO metadata and stable, redirect-aware URL paths.
11
11
  - **Fragments** — reusable chunks of content (a footer text, a hero tagline…) editable from the admin and usable anywhere in your views.
12
- - **A rich text editor** — based on [Tiptap](https://tiptap.dev), with image uploads (Uppy), link insertion and content stored as structured ProseMirror JSON.
12
+ - **A content editor** — based on [Tiptap](https://tiptap.dev), with image uploads (Uppy), link insertion and content stored as structured ProseMirror JSON and rendered safely to HTML (see [Content editor](/content-editor)).
13
13
  - **Authentication & authorization** — sign in built on Rails' [`has_secure_password`](https://api.rubyonrails.org/classes/ActiveModel/SecurePassword/ClassMethods.html) with database-backed sessions, password resets, invitations, and [ActionPolicy](https://actionpolicy.evilmartians.io) policies with `admin`, `editor`, `user`, `reader` and `guest` roles.
14
14
  - **Internationalization** — content translations with [Mobility](https://github.com/shioyama/mobility), locale management with [i18n-tasks](https://github.com/glebm/i18n-tasks), and optional automatic translation through DeepL.
15
15
  - **File uploads** — [Shrine](https://shrinerb.com)-backed attachments with S3 or local storage, image processing via libvips, and blurhash placeholders.
@@ -27,11 +27,11 @@ Trek follows the Rails way:
27
27
 
28
28
  | Dependency | Version |
29
29
  | --- | --- |
30
- | Ruby | 3.1+ |
31
- | Rails | 7.0+ |
30
+ | Ruby | 3.3+ |
31
+ | Rails | 8.0+ |
32
32
  | PostgreSQL | 12+ |
33
- | Node | 20+ |
34
- | Yarn | 3.x |
33
+ | Node | 22+ |
34
+ | Yarn | 4.x |
35
35
  | libvips | — |
36
36
 
37
37
  Ready to try it? Head over to the [quick start](/getting-started).
@@ -0,0 +1,54 @@
1
+ require "rails/generators/actions"
2
+ require "rails/generators/migration"
3
+ require "generators/trek/helpers"
4
+
5
+ module Trek
6
+ module Generators
7
+ class AuditLogGenerator < Rails::Generators::Base
8
+ include Rails::Generators::Migration
9
+ include Trek::Generators::Helpers
10
+
11
+ desc "Create the AuditLog model, record the admin's requests, and list them in the admin."
12
+
13
+ source_root File.expand_path("templates", __dir__)
14
+
15
+ def copy_model
16
+ template "models/audit_log.rb", "app/models/audit_log.rb"
17
+ end
18
+
19
+ def copy_migration_file
20
+ return unless defined?(ActiveRecord)
21
+
22
+ migration_template("migrations/audit_logs.rb.erb",
23
+ "db/migrate/trek_audit_logs.rb",
24
+ migration_class_name:)
25
+ end
26
+
27
+ def copy_initializer
28
+ template "initializers/audit_log.rb", "config/initializers/audit_log.rb"
29
+ end
30
+
31
+ def copy_controller
32
+ template "controllers/admin/audit_logs_controller.rb",
33
+ "app/controllers/admin/audit_logs_controller.rb"
34
+ end
35
+
36
+ def copy_views
37
+ directory "views/admin/audit_logs", "app/views/admin/audit_logs"
38
+ end
39
+
40
+ def copy_policy
41
+ template "policies/audit_log.rb", "app/policies/admin/audit_log_policy.rb"
42
+ end
43
+
44
+ def add_routes
45
+ route "resources :audit_logs, only: %i[index show]", namespace: :admin
46
+ end
47
+
48
+ def copy_specs
49
+ template "spec/models/audit_log_spec.rb", "spec/models/audit_log_spec.rb"
50
+ template "spec/requests/admin/audit_logs_spec.rb", "spec/requests/admin/audit_logs_spec.rb"
51
+ end
52
+ end
53
+ end
54
+ end
@@ -30,11 +30,7 @@ module Trek
30
30
  end
31
31
 
32
32
  def migration_class_name
33
- if Rails::VERSION::MAJOR >= 5
34
- "ActiveRecord::Migration[#{Rails::VERSION::MAJOR}.#{Rails::VERSION::MINOR}]"
35
- else
36
- "ActiveRecord::Migration"
37
- end
33
+ "ActiveRecord::Migration[#{Rails::VERSION::MAJOR}.#{Rails::VERSION::MINOR}]"
38
34
  end
39
35
 
40
36
  def in_gemfile?(gem_name)
@@ -60,6 +56,18 @@ module Trek
60
56
  copy_file filename, filename
61
57
  end
62
58
 
59
+ # Runs `rubocop --autocorrect` on the files a step just changed. Quiet unless an offense is left
60
+ # uncorrected, which stops the generator: the offenses it corrects are the expected result of
61
+ # injecting code.
62
+ def rubocop_autocorrect(paths, only: nil)
63
+ return unless behavior == :invoke
64
+
65
+ say_status :autocorrect, paths
66
+ command = "rubocop --autocorrect --format quiet --display-only-fail-level-offenses"
67
+ command += " --only #{only}" if only
68
+ run "#{command} #{paths}", abort_on_failure: true, verbose: false
69
+ end
70
+
63
71
  def install_npm_dependencies(dependencies, dev: false)
64
72
  run "yarn add #{dependencies.map { |name, version| "#{name}@#{version}" }.join(" ")} #{dev ? "--dev" : ""}", abort_on_failure: true
65
73
  end
@@ -25,10 +25,10 @@ module Trek
25
25
  get :options, on: :collection
26
26
  end
27
27
  RUBY
28
+ route "resource :password_renewal, only: :create", namespace: :admin
28
29
  route <<~RUBY, namespace: :admin
29
30
  resources :users do
30
31
  patch :theme, on: :collection
31
- post :require_password_renewal, on: :collection
32
32
  end
33
33
  RUBY
34
34
  end
@@ -52,6 +52,11 @@ module Trek
52
52
  template "controllers/admin/passkeys_controller.rb",
53
53
  "app/controllers/admin/passkeys_controller.rb"
54
54
  end
55
+
56
+ def copy_password_renewals
57
+ template "controllers/admin/password_renewals_controller.rb",
58
+ "app/controllers/admin/password_renewals_controller.rb"
59
+ end
55
60
  end
56
61
  end
57
62
  end
@@ -53,6 +53,14 @@ module Trek
53
53
  template "controllers/admin/uploads_controller.rb",
54
54
  "app/controllers/admin/uploads_controller.rb"
55
55
  end
56
+
57
+ # The content editor's panels, which the admin routes point to (trek:install:admin:routes)
58
+ def add_panels_controllers
59
+ %w[links images prompts].each do |panel|
60
+ template "controllers/admin/panels/#{panel}_controller.rb",
61
+ "app/controllers/admin/panels/#{panel}_controller.rb"
62
+ end
63
+ end
56
64
  end
57
65
  end
58
66
  end
@@ -64,7 +64,7 @@ module Trek
64
64
  inject_into_class "app/controllers/application_controller.rb",
65
65
  "ApplicationController",
66
66
  " include AppsignalContext\n"
67
- run "rubocop --autocorrect app/controllers/application_controller.rb", abort_on_failure: true
67
+ rubocop_autocorrect "app/controllers/application_controller.rb"
68
68
  end
69
69
 
70
70
  def include_context_in_trek_controllers
@@ -1,54 +1,18 @@
1
- require "rails/generators/actions"
2
- require "rails/generators/migration"
3
- require "generators/trek/helpers"
1
+ require "generators/trek/audit_log_generator"
4
2
 
5
3
  module Trek
6
4
  module Generators
7
5
  module Install
8
- class AuditLogGenerator < Rails::Generators::Base
9
- include Rails::Generators::Migration
10
- include Trek::Generators::Helpers
6
+ # The audit log's generator under its former name: `trek:install` doesn't run it, so it's `trek:audit_log` now.
7
+ # Removed in Trek 3.
8
+ class AuditLogGenerator < Trek::Generators::AuditLogGenerator
9
+ hide!
11
10
 
12
- desc "Create the AuditLog model, record the admin's requests, and list them in the admin."
11
+ # Not inherited: Rails derives it from the generator's own path.
12
+ source_root Trek::Generators::AuditLogGenerator.source_root
13
13
 
14
- source_root File.expand_path("../templates", __dir__)
15
-
16
- def copy_model
17
- template "models/audit_log.rb", "app/models/audit_log.rb"
18
- end
19
-
20
- def copy_migration_file
21
- return unless defined?(ActiveRecord)
22
-
23
- migration_template("migrations/audit_logs.rb.erb",
24
- "db/migrate/trek_audit_logs.rb",
25
- migration_class_name:)
26
- end
27
-
28
- def copy_initializer
29
- template "initializers/audit_log.rb", "config/initializers/audit_log.rb"
30
- end
31
-
32
- def copy_controller
33
- template "controllers/admin/audit_logs_controller.rb",
34
- "app/controllers/admin/audit_logs_controller.rb"
35
- end
36
-
37
- def copy_views
38
- directory "views/admin/audit_logs", "app/views/admin/audit_logs"
39
- end
40
-
41
- def copy_policy
42
- template "policies/audit_log.rb", "app/policies/admin/audit_log_policy.rb"
43
- end
44
-
45
- def add_routes
46
- route "resources :audit_logs, only: %i[index show]", namespace: :admin
47
- end
48
-
49
- def copy_specs
50
- template "spec/models/audit_log_spec.rb", "spec/models/audit_log_spec.rb"
51
- template "spec/requests/admin/audit_logs_spec.rb", "spec/requests/admin/audit_logs_spec.rb"
14
+ def deprecation_warning
15
+ say "`trek:install:audit_log` is deprecated and will be removed in Trek 3: run `trek:audit_log`.", :yellow
52
16
  end
53
17
  end
54
18
  end
@@ -117,7 +117,7 @@ module Trek
117
117
  end
118
118
 
119
119
  def autocorrect_user_model
120
- run "rubocop --autocorrect #{user_model_path}"
120
+ rubocop_autocorrect user_model_path
121
121
  end
122
122
 
123
123
  private
@@ -27,7 +27,7 @@ module Trek
27
27
  inject_into_class application_policy_file_path,
28
28
  "ApplicationPolicy",
29
29
  application_policy_injection
30
- run "rubocop --autocorrect #{application_policy_file_path}", abort_on_failure: true
30
+ rubocop_autocorrect application_policy_file_path
31
31
  end
32
32
 
33
33
  def copy_policy_files
@@ -0,0 +1,161 @@
1
+ require "rails/generators/actions"
2
+ require "generators/trek/helpers"
3
+
4
+ module Trek
5
+ module Generators
6
+ module Install
7
+ # Replaces the Solid Queue backend `rails new` sets up with GoodJob: one PostgreSQL
8
+ # database instead of two, jobs running inside Puma, and a dashboard in the admin.
9
+ class GoodJobGenerator < Rails::Generators::Base
10
+ GOOD_JOB_VERSION = "~> 4.13".freeze
11
+ GEM_COMMENT = "Active Job backend on PostgreSQL, with a dashboard [https://github.com/bensheldon/good_job]".freeze
12
+
13
+ # The line `rails new` writes to size the connection pool: `max_connections` since
14
+ # Rails 8.1, `pool` before it. Whichever it is, it keeps its name.
15
+ POOL_LINE = /^(\s*)(max_connections|pool): <%= ENV\.fetch\("RAILS_MAX_THREADS"\)[^\n]*%>\n/
16
+
17
+ include Trek::Generators::Helpers
18
+
19
+ desc "Install GoodJob as the Active Job backend."
20
+
21
+ source_root File.expand_path("../templates", __dir__)
22
+
23
+ def swap_gems
24
+ return if in_gemfile?("good_job")
25
+
26
+ # Solid Queue wants a second database, which a Trek app does not provision (Solid
27
+ # Cache stays: its table lives in the primary database). GoodJob takes over its line,
28
+ # under the Active Job adapter comment it belongs to.
29
+ if in_gemfile?("solid_queue")
30
+ gsub_file "Gemfile", /^gem "solid_queue".*\n/,
31
+ %(# #{GEM_COMMENT}\ngem "good_job", "#{GOOD_JOB_VERSION}"\n)
32
+ else
33
+ gem "good_job", GOOD_JOB_VERSION, comment: GEM_COMMENT
34
+ end
35
+ bundle_install
36
+ end
37
+
38
+ def remove_solid_queue_files
39
+ %w[config/queue.yml config/recurring.yml db/queue_schema.rb bin/jobs].each do |file|
40
+ remove_file file
41
+ end
42
+ end
43
+
44
+ def remove_solid_queue_from_puma
45
+ gsub_file "config/puma.rb",
46
+ /^(?:#[^\n]*Solid Queue[^\n]*\n)?plugin :solid_queue if ENV\["SOLID_QUEUE_IN_PUMA"\]\n\n?/,
47
+ ""
48
+ end
49
+
50
+ def remove_queue_database
51
+ gsub_file "config/database.yml", /^ queue:\n(?: [^\n]*\n)+/, ""
52
+ end
53
+
54
+ # GoodJob runs in the web container's process, so its threads need connections of their
55
+ # own — the pool `rails new` sizes for the web threads alone would starve them.
56
+ def size_connection_pool
57
+ gsub_file "config/database.yml", POOL_LINE, <<~'YAML'
58
+ \1# Web threads and job threads each check out their own connections, plus one for
59
+ \1# GoodJob's LISTEN/NOTIFY listener. GOOD_JOB_MAX_THREADS falls back to
60
+ \1# RAILS_MAX_THREADS inside GoodJob, so both shares match unless it is set.
61
+ \1\2: <%= web = ENV.fetch("RAILS_MAX_THREADS", 5).to_i; 1 + web + ENV.fetch("GOOD_JOB_MAX_THREADS", web).to_i %>
62
+ YAML
63
+ end
64
+
65
+ # Kamal's file is not what a Trek app deploys with, but leaving Solid Queue's variables
66
+ # in it would describe a backend the app no longer runs.
67
+ def clean_kamal_deploy_file
68
+ return unless File.exist?("config/deploy.yml")
69
+
70
+ gsub_file "config/deploy.yml",
71
+ /^(?:[ \t]*#[^\n]*\n)*([ \t]*)SOLID_QUEUE_IN_PUMA: true\n/,
72
+ <<~'YAML'
73
+ \1# Jobs run inside Puma (config.good_job.execution_mode = :async), so there is no
74
+ \1# separate job process to start. GOOD_JOB_MAX_THREADS sizes its thread pool.
75
+ \1# GOOD_JOB_MAX_THREADS: 5
76
+ YAML
77
+ gsub_file "config/deploy.yml",
78
+ /^[ \t]*# Set number of processes dedicated to Solid Queue[^\n]*\n[ \t]*# JOB_CONCURRENCY:[^\n]*\n\n?/,
79
+ ""
80
+ end
81
+
82
+ def configure_adapter
83
+ return if File.read("config/application.rb").include?("queue_adapter = :good_job")
84
+
85
+ inject_into_file "config/application.rb", adapter_configuration,
86
+ after: /^\s*config\.load_defaults [^\n]*\n/
87
+ end
88
+
89
+ # Active Job's test helper only swaps in its test adapter for a job class with no adapter
90
+ # configured, and config/application.rb now sets GoodJob: give the specs the test adapter
91
+ # back, for have_enqueued_job and the like.
92
+ def configure_test_adapter
93
+ return unless File.exist?("config/environments/test.rb")
94
+ return if File.read("config/environments/test.rb").include?("queue_adapter = :test")
95
+
96
+ inject_into_file "config/environments/test.rb", <<-RUBY, after: /^Rails\.application\.configure do\n/
97
+ # Jobs go to Active Job's test adapter, not GoodJob (config/application.rb), so specs can check
98
+ # what was enqueued.
99
+ config.active_job.queue_adapter = :test
100
+
101
+ RUBY
102
+ end
103
+
104
+ def configure_production
105
+ gsub_file "config/environments/production.rb", /^\s*config\.solid_queue\.connects_to[^\n]*\n/, ""
106
+ gsub_file "config/environments/production.rb",
107
+ /^(\s*)(?:# )?config\.active_job\.queue_adapter\s*=[^\n]*\n/,
108
+ <<~'RUBY'
109
+ \1# Jobs run in the web container's own threads: no worker process to pay for, and a
110
+ \1# deploy that drains them (shutdown_timeout) rather than dropping them.
111
+ \1config.good_job.execution_mode = :async
112
+ \1config.good_job.shutdown_timeout = 25
113
+ RUBY
114
+ end
115
+
116
+ def create_initializer
117
+ template "initializers/good_job.rb.tt", "config/initializers/good_job.rb"
118
+ end
119
+
120
+ def create_mail_delivery_job
121
+ copy_file "jobs/mail_delivery_job.rb", "app/jobs/mail_delivery_job.rb"
122
+ end
123
+
124
+ def mount_dashboard
125
+ route 'mount GoodJob::Engine => "good_job"', namespace: :admin
126
+ end
127
+
128
+ def create_migration
129
+ generate "good_job:install"
130
+ end
131
+
132
+ def create_specs
133
+ return unless File.directory?("spec")
134
+
135
+ copy_file "spec/requests/admin/good_job_spec.rb", "spec/requests/admin/good_job_spec.rb"
136
+ copy_file "spec/jobs/mail_delivery_job_spec.rb", "spec/jobs/mail_delivery_job_spec.rb"
137
+ end
138
+
139
+ private
140
+
141
+ # The model of a signed-in browser, which the dashboard's guard looks the session cookie up
142
+ # in: User::Session, or UserSession in an app generated before Trek nested it.
143
+ def session_model
144
+ File.exist?("app/models/user_session.rb") ? "UserSession" : "User::Session"
145
+ end
146
+
147
+ def adapter_configuration
148
+ <<-RUBY
149
+
150
+ # Use GoodJob as the Active Job backend (see config/initializers/good_job.rb).
151
+ config.active_job.queue_adapter = :good_job
152
+
153
+ # Every `deliver_later` email goes through MailDeliveryJob, which retries a failed
154
+ # delivery — GoodJob discards a failed job (see app/jobs/mail_delivery_job.rb).
155
+ config.action_mailer.delivery_job = "MailDeliveryJob"
156
+ RUBY
157
+ end
158
+ end
159
+ end
160
+ end
161
+ end
@@ -51,11 +51,11 @@ module Trek
51
51
  directory "db/seeds", "db/seeds"
52
52
  end
53
53
 
54
- # The audit log's specs come with it, from `trek:install:audit_log`, and the tags' (model and policies) from
55
- # `trek:taxonomies`.
54
+ # The audit log's specs come with it, from `trek:audit_log`, the GoodJob dashboard's from
55
+ # `trek:install:good_job`, and the tags' (model and policies) from `trek:taxonomies`.
56
56
  def copy_specs
57
57
  directory "spec/models", "spec/models", exclude_pattern: /audit_log|tag_spec/
58
- directory "spec/requests", "spec/requests", exclude_pattern: /audit_log/
58
+ directory "spec/requests", "spec/requests", exclude_pattern: /audit_log|good_job_spec/
59
59
  directory "spec/mailers", "spec/mailers"
60
60
  directory "spec/fixtures", "spec/fixtures"
61
61
  directory "spec/policies", "spec/policies", exclude_pattern: /tag(_category)?_policy_spec/
@@ -24,7 +24,7 @@ module Trek
24
24
  "ApplicationMailer",
25
25
  application_mailer_injection,
26
26
  after: ' layout "mailer"\n'
27
- run "rubocop --autocorrect app/mailers/application_mailer.rb", abort_on_failure: true
27
+ rubocop_autocorrect "app/mailers/application_mailer.rb"
28
28
  end
29
29
 
30
30
  def inject_postmark_to_config
@@ -33,7 +33,7 @@ module Trek
33
33
  inject_into_file "config/environments/production.rb",
34
34
  config_injection,
35
35
  after: %r{# Specify outgoing SMTP server\. Remember to add smtp/\* credentials via (?:bin/)?rails credentials:edit\.\n}
36
- run "rubocop --autocorrect config/environments/production.rb", abort_on_failure: true
36
+ rubocop_autocorrect "config/environments/production.rb"
37
37
  end
38
38
 
39
39
  def inject_postmark_to_credentials
@@ -5,7 +5,7 @@ module Trek
5
5
  module Generators
6
6
  module Install
7
7
  class RubyGenerator < Rails::Generators::Base
8
- RUBY_VERSION = "4.0.7"
8
+ RUBY_VERSION = "4.0.9"
9
9
 
10
10
  include Trek::Generators::Helpers
11
11
 
@@ -1,53 +1,15 @@
1
- require "rails/generators/actions"
2
- require "generators/trek/helpers"
1
+ require "generators/trek/scalingo_generator"
3
2
 
4
3
  module Trek
5
4
  module Generators
6
5
  module Install
7
- class ScalingoGenerator < Rails::Generators::Base
8
- BUILDPACK_URL = "https://github.com/etaminstudio/trek-buildpack/archive/refs/tags/v0.1.0.tar.gz".freeze
6
+ # The Scalingo generator under its former name: `trek:install` doesn't run it, so it's `trek:scalingo` now.
7
+ # Removed in Trek 3.
8
+ class ScalingoGenerator < Trek::Generators::ScalingoGenerator
9
+ hide!
9
10
 
10
- include Trek::Generators::Helpers
11
-
12
- desc "Create Scalingo files."
13
-
14
- # The trek-buildpack replaces the apt + ruby buildpack combination. It
15
- # pins Node from the .node-version that `rails new` already generates.
16
- def remove_buildpacks
17
- remove_file ".buildpacks"
18
- end
19
-
20
- def create_aptfile
21
- create_file "Aptfile" do
22
- <<~TEXT
23
- libjemalloc2
24
- libvips-tools --no-install-recommends
25
- libwebp-dev
26
- TEXT
27
- end
28
- end
29
-
30
- def create_procfile
31
- create_file "Procfile" do
32
- <<~TEXT
33
- web: bundle exec rails server -p $PORT -e $RAILS_ENV -b 0.0.0.0
34
- # worker: bundle exec sidekiq -C config/sidekiq.yml
35
- postdeploy: bundle exec rails db:migrate
36
- TEXT
37
- end
38
- end
39
-
40
- def final_instructions
41
- say ""
42
- say "Configure the Scalingo app environment:"
43
- say ""
44
- say " scalingo --app <app> env-set BUILDPACK_URL=#{BUILDPACK_URL}"
45
- say " scalingo --app <app> env-set 'DATABASE_URL=$SCALINGO_POSTGRESQL_URL'"
46
- say ""
47
- say "and make sure config/database.yml reads DATABASE_URL in production."
48
- say ""
49
- say "See https://trek.etamin.studio/deploy for details."
50
- say ""
11
+ def deprecation_warning
12
+ say "`trek:install:scalingo` is deprecated and will be removed in Trek 3: run `trek:scalingo`.", :yellow
51
13
  end
52
14
  end
53
15
  end
@@ -27,6 +27,17 @@ module Trek
27
27
  generate "rspec:install"
28
28
  end
29
29
 
30
+ # `have_tag` and `with_tag`, from the rspec-html-matchers gem added above
31
+ def include_html_matchers
32
+ rails_helper = File.join(destination_root, "spec/rails_helper.rb")
33
+ return unless File.exist?(rails_helper)
34
+ return if File.read(rails_helper).include?("RSpecHtmlMatchers")
35
+
36
+ inject_into_file "spec/rails_helper.rb",
37
+ " config.include RSpecHtmlMatchers\n",
38
+ after: /^RSpec\.configure do \|config\|\n/
39
+ end
40
+
30
41
  def create_rspec_config
31
42
  create_file ".rspec", <<~TEXT
32
43
  --format documentation
@@ -45,7 +45,7 @@ module Trek
45
45
  end
46
46
 
47
47
  def autocorrect_user_model
48
- run "rubocop --autocorrect #{user_model_path}"
48
+ rubocop_autocorrect user_model_path
49
49
  end
50
50
 
51
51
  private
@@ -72,6 +72,11 @@ module Trek
72
72
  generate_inline "trek:install:strip_attributes"
73
73
  end
74
74
 
75
+ # Before the emails: the mailer configuration points at MailDeliveryJob.
76
+ def install_jobs
77
+ generate_inline "trek:install:good_job"
78
+ end
79
+
75
80
  def install_emails
76
81
  generate_inline "trek:install:postmark"
77
82
  generate_inline "trek:install:mailer"
@@ -180,6 +185,16 @@ module Trek
180
185
  say ""
181
186
  say " make dev"
182
187
  say ""
188
+ say "More generators, to run when the app needs them:"
189
+ say ""
190
+ say " rails g trek:scaffold Book title intro:text # a model and its admin panel"
191
+ say " rails g trek:taxonomies # tags and their categories"
192
+ say " rails g trek:audit_log # a log of the admin's requests"
193
+ say " rails g trek:public_accounts Customer # accounts for the site's users, apart from the admin's"
194
+ say " rails g trek:scalingo # the files deploying to Scalingo"
195
+ say ""
196
+ say "All of Trek's generators and their options: https://trek.etamin.studio/reference/#generators"
197
+ say ""
183
198
  end
184
199
 
185
200
  private