trek 2.3.2 → 2.5.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 (221) hide show
  1. checksums.yaml +4 -4
  2. data/.node-version +1 -1
  3. data/.yarn/releases/yarn-4.18.1.cjs +1000 -0
  4. data/.yarnrc.yml +3 -5
  5. data/AGENTS.md +12 -8
  6. data/CHANGELOG.md +73 -0
  7. data/Gemfile.lock +226 -171
  8. data/Makefile +38 -1
  9. data/README.md +2 -2
  10. data/app/assets/icons/trek/passkey.svg +5 -0
  11. data/app/assets/stylesheets/trek/base.css +6 -0
  12. data/app/components/trek/entries/item_component/item_component.css +6 -0
  13. data/app/components/trek/form/image_field_component/image_field_component.html.slim +9 -0
  14. data/app/components/trek/form/image_field_component.rb +1 -5
  15. data/app/components/trek/form/password_strength_component/password_strength_component.css +56 -0
  16. data/app/components/trek/form/password_strength_component/password_strength_component.html.slim +8 -0
  17. data/app/components/trek/form/password_strength_component/password_strength_component.js +74 -0
  18. data/app/components/trek/form/password_strength_component.rb +29 -0
  19. data/app/components/trek/gate_component/gate_component.css +7 -0
  20. data/app/components/trek/icon/sprite_component.rb +3 -2
  21. data/app/components/trek/list/item_component.rb +1 -1
  22. data/app/components/trek/list/tree/item_component.rb +2 -2
  23. data/app/components/trek/search_component/search_component.html.slim +2 -1
  24. data/app/components/trek/search_component.rb +9 -1
  25. data/app/components/trek/section_component/section_component.css +22 -0
  26. data/app/components/trek/section_component/section_component.html.slim +5 -0
  27. data/app/components/trek/section_component/section_component.js +1 -0
  28. data/app/components/trek/section_component.rb +14 -0
  29. data/app/content/trek/content/bullet_list.rb +10 -0
  30. data/app/content/trek/content/document.rb +33 -0
  31. data/app/content/trek/content/image_block.rb +52 -0
  32. data/app/content/trek/content/link_resolver.rb +33 -0
  33. data/app/content/trek/content/list_item.rb +19 -0
  34. data/app/content/trek/content/ordered_list.rb +10 -0
  35. data/app/content/trek/content/paragraph.rb +10 -0
  36. data/app/content/trek/content/prompts_block.rb +22 -0
  37. data/app/content/trek/content.rb +32 -0
  38. data/app/controllers/concerns/trek/auditable.rb +103 -0
  39. data/app/controllers/concerns/trek/filters.rb +2 -0
  40. data/app/controllers/concerns/trek/passkeys.rb +37 -0
  41. data/app/controllers/concerns/trek/reorderable.rb +14 -3
  42. data/app/controllers/trek/csp_reports_controller.rb +59 -0
  43. data/app/controllers/trek/panels/base_controller.rb +3 -0
  44. data/app/controllers/trek/panels/links_controller.rb +1 -1
  45. data/app/controllers/trek/panels/prompts_controller.rb +1 -1
  46. data/app/controllers/trek/resource_controller.rb +7 -1
  47. data/app/helpers/trek/audit_logs_helper.rb +21 -0
  48. data/app/helpers/trek/thumbnail_helper.rb +11 -0
  49. data/app/helpers/trek/user_agents_helper.rb +36 -0
  50. data/app/javascript/controllers/index.js +3 -0
  51. data/app/javascript/controllers/passkey_controller.js +118 -0
  52. data/app/javascript/trek.js +4 -0
  53. data/app/jobs/trek/audit_log/purge_job.rb +18 -0
  54. data/app/jobs/trek/purge_expired_sessions_job.rb +14 -0
  55. data/app/jobs/trek/resolve_session_hostname_job.rb +17 -0
  56. data/app/models/concerns/trek/audit_log.rb +30 -0
  57. data/app/models/concerns/trek/contentable.rb +9 -14
  58. data/app/models/concerns/trek/pageable.rb +10 -1
  59. data/app/models/concerns/trek/users/passkeys.rb +75 -0
  60. data/app/models/concerns/trek/users/password_history.rb +51 -0
  61. data/app/models/concerns/trek/users/password_policy.rb +85 -0
  62. data/app/models/concerns/trek/users/password_renewal.rb +51 -0
  63. data/app/models/concerns/trek/users/session_lifetime.rb +39 -0
  64. data/app/models/concerns/trek/users/sign_in_lockout.rb +67 -0
  65. data/app/models/concerns/trek/users/sign_ins.rb +31 -0
  66. data/app/models/concerns/trek/users/validations.rb +3 -2
  67. data/app/models/trek/feature.rb +6 -0
  68. data/app/models/trek/pwned_passwords.rb +40 -0
  69. data/app/models/trek/user_session.rb +10 -0
  70. data/app/policies/trek/audit_log_policy.rb +34 -0
  71. data/app/policies/trek/user_policy.rb +5 -0
  72. data/app/validators/not_disposable_validator.rb +18 -0
  73. data/app/views/trek/panels/images/_form.html.slim +1 -1
  74. data/app/views/trek/panels/images/create.turbo_stream.slim +1 -1
  75. data/app/views/trek/panels/links/_form.html.slim +1 -1
  76. data/app/views/trek/panels/prompts/_form.html.slim +1 -1
  77. data/config/brakeman.ignore +22 -0
  78. data/config/i18n-tasks.yml +7 -0
  79. data/config/locales/trek.en.yml +167 -39
  80. data/config/locales/trek.fr.yml +168 -40
  81. data/docs/.vitepress/config.mjs +8 -3
  82. data/docs/deploy.md +2 -0
  83. data/docs/getting-started.md +3 -3
  84. data/docs/proxies.md +53 -0
  85. data/docs/reference/components.md +1 -0
  86. data/docs/reference/concerns/contentable.md +2 -1
  87. data/docs/reference/controllers.md +1 -1
  88. data/docs/reference/environment-variables.md +2 -0
  89. data/docs/reference/formatters.md +31 -8
  90. data/docs/reference/generators/admin-user.md +1 -1
  91. data/docs/reference/generators/audit-log.md +113 -0
  92. data/docs/reference/generators/install.md +12 -3
  93. data/docs/reference/generators/security-headers.md +109 -0
  94. data/docs/reference/index.md +3 -0
  95. data/docs/reference/models/fragment.md +1 -0
  96. data/docs/reference/models/tag.md +4 -2
  97. data/docs/reference/models/user.md +123 -3
  98. data/docs/reference/validators.md +94 -0
  99. data/docs/security.md +90 -0
  100. data/docs/what-is-trek.md +4 -4
  101. data/lefthook.yml +8 -0
  102. data/lib/generators/trek/helpers.rb +13 -5
  103. data/lib/generators/trek/install/admin/user_password_resets_generator.rb +5 -0
  104. data/lib/generators/trek/install/admin/user_sessions_generator.rb +5 -0
  105. data/lib/generators/trek/install/admin/users_generator.rb +23 -0
  106. data/lib/generators/trek/install/admin_generator.rb +8 -0
  107. data/lib/generators/trek/install/appsignal_generator.rb +1 -1
  108. data/lib/generators/trek/install/audit_log_generator.rb +56 -0
  109. data/lib/generators/trek/install/authentication_generator.rb +78 -4
  110. data/lib/generators/trek/install/authorization_generator.rb +1 -1
  111. data/lib/generators/trek/install/esbuild_generator.rb +1 -2
  112. data/lib/generators/trek/install/mailer_generator.rb +18 -0
  113. data/lib/generators/trek/install/model_specs_generator.rb +6 -4
  114. data/lib/generators/trek/install/postcss_generator.rb +1 -4
  115. data/lib/generators/trek/install/postmark_generator.rb +2 -2
  116. data/lib/generators/trek/install/security_headers_generator.rb +49 -0
  117. data/lib/generators/trek/install/specs_generator.rb +11 -0
  118. data/lib/generators/trek/install/user_generator.rb +1 -1
  119. data/lib/generators/trek/install/yarn_generator.rb +1 -1
  120. data/lib/generators/trek/install_generator.rb +62 -54
  121. data/lib/generators/trek/scaffold_generator.rb +13 -5
  122. data/lib/generators/trek/taxonomies_generator.rb +5 -0
  123. data/lib/generators/trek/templates/.gitlab-ci.yml +18 -2
  124. data/lib/generators/trek/templates/Makefile +1 -1
  125. data/lib/generators/trek/templates/controllers/admin/active_sessions_controller.rb +21 -0
  126. data/lib/generators/trek/templates/controllers/admin/audit_logs_controller.rb +30 -0
  127. data/lib/generators/trek/templates/controllers/admin/fragments_controller.rb +7 -0
  128. data/lib/generators/trek/templates/controllers/admin/panels/images_controller.rb +8 -0
  129. data/lib/generators/trek/templates/controllers/admin/panels/links_controller.rb +8 -0
  130. data/lib/generators/trek/templates/controllers/admin/panels/prompts_controller.rb +8 -0
  131. data/lib/generators/trek/templates/controllers/admin/passkey_sessions_controller.rb +41 -0
  132. data/lib/generators/trek/templates/controllers/admin/passkeys_controller.rb +37 -0
  133. data/lib/generators/trek/templates/controllers/admin/user_password_resets_controller.rb +4 -4
  134. data/lib/generators/trek/templates/controllers/admin/user_sessions_controller.rb +53 -4
  135. data/lib/generators/trek/templates/controllers/admin/users_controller.rb +20 -0
  136. data/lib/generators/trek/templates/controllers/concerns/trek/authentication.rb +58 -7
  137. data/lib/generators/trek/templates/helpers/application_helper.rb +0 -4
  138. data/lib/generators/trek/templates/initializers/audit_log.rb +11 -0
  139. data/lib/generators/trek/templates/initializers/content_security_policy.rb +49 -0
  140. data/lib/generators/trek/templates/initializers/permissions_policy.rb +19 -0
  141. data/lib/generators/trek/templates/jobs/admin/password_reset_job.rb +9 -0
  142. data/lib/generators/trek/templates/layouts/admin/auth.html.slim +0 -5
  143. data/lib/generators/trek/templates/layouts/admin.html.slim +0 -3
  144. data/lib/generators/trek/templates/mailers/admin/passwords_mailer.rb +1 -1
  145. data/lib/generators/trek/templates/mailers/admin_mailer.rb +28 -1
  146. data/lib/generators/trek/templates/migrations/audit_logs.rb.erb +27 -0
  147. data/lib/generators/trek/templates/migrations/tags.rb.erb +6 -1
  148. data/lib/generators/trek/templates/migrations/user_passkeys.rb.erb +24 -0
  149. data/lib/generators/trek/templates/migrations/user_password_renewal.rb.erb +8 -0
  150. data/lib/generators/trek/templates/migrations/user_previous_passwords.rb.erb +10 -0
  151. data/lib/generators/trek/templates/migrations/user_session_tracking.rb.erb +11 -0
  152. data/lib/generators/trek/templates/migrations/user_sign_in_lockout.rb.erb +7 -0
  153. data/lib/generators/trek/templates/migrations/user_sign_ins.rb.erb +13 -0
  154. data/lib/generators/trek/templates/models/audit_log.rb +3 -0
  155. data/lib/generators/trek/templates/models/fragment.rb +14 -0
  156. data/lib/generators/trek/templates/models/tag_category.rb +2 -1
  157. data/lib/generators/trek/templates/models/user/passkey.rb +17 -0
  158. data/lib/generators/trek/templates/models/user/previous_password.rb +4 -0
  159. data/lib/generators/trek/templates/models/user/session.rb +8 -0
  160. data/lib/generators/trek/templates/policies/audit_log.rb +4 -0
  161. data/lib/generators/trek/templates/spec/mailers/admin/passwords_mailer_spec.rb +16 -0
  162. data/lib/generators/trek/templates/spec/mailers/admin_mailer_spec.rb +51 -0
  163. data/lib/generators/trek/templates/spec/models/audit_log_spec.rb +43 -0
  164. data/lib/generators/trek/templates/spec/models/tag_spec.rb +52 -0
  165. data/lib/generators/trek/templates/spec/models/user/session_spec.rb +68 -0
  166. data/lib/generators/trek/templates/spec/models/user_spec.rb +142 -4
  167. data/lib/generators/trek/templates/spec/requests/admin/active_sessions_spec.rb +120 -0
  168. data/lib/generators/trek/templates/spec/requests/admin/audit_logs_spec.rb +149 -0
  169. data/lib/generators/trek/templates/spec/requests/admin/fragments_spec.rb +26 -2
  170. data/lib/generators/trek/templates/spec/requests/admin/pages_spec.rb +8 -0
  171. data/lib/generators/trek/templates/spec/requests/admin/panels_spec.rb +54 -0
  172. data/lib/generators/trek/templates/spec/requests/admin/passkey_sessions_spec.rb +103 -0
  173. data/lib/generators/trek/templates/spec/requests/admin/passkeys_spec.rb +104 -0
  174. data/lib/generators/trek/templates/spec/requests/admin/password_renewal_spec.rb +83 -0
  175. data/lib/generators/trek/templates/spec/requests/admin/sign_in_lockout_spec.rb +95 -0
  176. data/lib/generators/trek/templates/spec/requests/admin/sign_in_notices_spec.rb +95 -0
  177. data/lib/generators/trek/templates/spec/requests/admin/user_password_resets_spec.rb +43 -6
  178. data/lib/generators/trek/templates/spec/requests/admin/user_sessions_spec.rb +25 -2
  179. data/lib/generators/trek/templates/views/admin/audit_logs/index.html.slim +35 -0
  180. data/lib/generators/trek/templates/views/admin/audit_logs/show.html.slim +50 -0
  181. data/lib/generators/trek/templates/views/admin/fragments/index.html.slim +14 -3
  182. data/lib/generators/trek/templates/views/admin/user_password_resets/edit.html.slim +16 -6
  183. data/lib/generators/trek/templates/views/admin/user_password_resets/new.html.slim +2 -1
  184. data/lib/generators/trek/templates/views/admin/user_sessions/new.html.slim +27 -1
  185. data/lib/generators/trek/templates/views/admin/users/_passkeys.html.slim +67 -0
  186. data/lib/generators/trek/templates/views/admin/users/_properties.html.slim +21 -0
  187. data/lib/generators/trek/templates/views/admin/users/_sessions.html.slim +70 -0
  188. data/lib/generators/trek/templates/views/admin/users/index.html.slim +13 -0
  189. data/lib/generators/trek/templates/views/admin/users/show.html.slim +10 -21
  190. data/lib/generators/trek/templates/views/admin_mailer/new_sign_in.en.html.slim +22 -0
  191. data/lib/generators/trek/templates/views/admin_mailer/new_sign_in.en.text.erb +16 -0
  192. data/lib/generators/trek/templates/views/admin_mailer/new_sign_in.fr.html.slim +22 -0
  193. data/lib/generators/trek/templates/views/admin_mailer/new_sign_in.fr.text.erb +16 -0
  194. data/lib/generators/trek/templates/views/admin_mailer/sign_in_locked.en.html.slim +17 -0
  195. data/lib/generators/trek/templates/views/admin_mailer/sign_in_locked.en.text.erb +10 -0
  196. data/lib/generators/trek/templates/views/admin_mailer/sign_in_locked.fr.html.slim +18 -0
  197. data/lib/generators/trek/templates/views/admin_mailer/sign_in_locked.fr.text.erb +10 -0
  198. data/lib/trek/admin_ip_allowlist.rb +52 -0
  199. data/lib/trek/csp_reports.rb +99 -0
  200. data/lib/trek/data/common_passwords.txt +857 -0
  201. data/lib/trek/data/passkey_providers.json +404 -0
  202. data/lib/trek/disposable_email_domains.rb +53 -0
  203. data/lib/trek/engine.rb +18 -1
  204. data/lib/trek/passkey_providers.rb +19 -0
  205. data/lib/trek/reverse_dns.rb +27 -0
  206. data/lib/trek/saved_attachments_reload.rb +2 -1
  207. data/lib/trek/version.rb +1 -1
  208. data/lib/trek.rb +14 -1
  209. data/package.json +3 -5
  210. data/renovate.json +12 -1
  211. data/trek.gemspec +6 -3
  212. data/yarn.lock +2273 -2573
  213. metadata +160 -17
  214. data/.yarn/plugins/@yarnpkg/plugin-interactive-tools.cjs +0 -541
  215. data/.yarn/releases/yarn-3.8.0.cjs +0 -875
  216. data/app/formatters/prosemirror_to_html/global_id_to_links_formatter.rb +0 -19
  217. data/app/formatters/prosemirror_to_html/nodes/image_block.rb +0 -44
  218. data/app/formatters/prosemirror_to_html/nodes/prompts_block.rb +0 -28
  219. data/app/formatters/prosemirror_to_html/remove_empty_paragraphs_formatter.rb +0 -11
  220. data/app/models/prosemirror.rb +0 -23
  221. data/lib/generators/trek/templates/models/user_session.rb +0 -3
@@ -0,0 +1,49 @@
1
+ require "rails/generators/actions"
2
+ require "generators/trek/helpers"
3
+
4
+ module Trek
5
+ module Generators
6
+ module Install
7
+ class SecurityHeadersGenerator < Rails::Generators::Base
8
+ include Trek::Generators::Helpers
9
+
10
+ desc "Set up the Content Security Policy (report-only at first) and the Permissions-Policy header."
11
+
12
+ source_root File.expand_path("../templates", __dir__)
13
+
14
+ def copy_content_security_policy
15
+ copy_initializer "content_security_policy.rb"
16
+ end
17
+
18
+ def copy_permissions_policy
19
+ copy_initializer "permissions_policy.rb"
20
+ end
21
+
22
+ # Where browsers send the policy's violations (Trek::CspReportsController)
23
+ def add_reports_route
24
+ route 'post "csp-reports", to: "trek/csp_reports#create", as: :csp_reports'
25
+ end
26
+
27
+ private
28
+
29
+ # Replaces Rails' commented-out example, but not a policy the app wrote: that one is the app's
30
+ # to reconcile with Trek's.
31
+ def copy_initializer(name)
32
+ path = "config/initializers/#{name}"
33
+ existing = File.join(destination_root, path)
34
+
35
+ if File.exist?(existing) && !commented_out?(existing) && File.read(existing) != File.read(find_in_source_paths("initializers/#{name}"))
36
+ say_status :skip, "#{path} has the app's own policy: compare it with Trek's (docs: Security headers)", :yellow
37
+ return
38
+ end
39
+
40
+ template "initializers/#{name}", path, force: true
41
+ end
42
+
43
+ def commented_out?(path)
44
+ File.readlines(path).all? { |line| line.strip.empty? || line.strip.start_with?("#") }
45
+ end
46
+ end
47
+ end
48
+ end
49
+ 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
@@ -5,7 +5,7 @@ module Trek
5
5
  module Generators
6
6
  module Install
7
7
  class YarnGenerator < Rails::Generators::Base
8
- YARN_VERSION = "4.18.0"
8
+ YARN_VERSION = "4.18.1"
9
9
 
10
10
  include Trek::Generators::Helpers
11
11
 
@@ -12,25 +12,25 @@ module Trek
12
12
  source_root File.expand_path("templates", __dir__)
13
13
 
14
14
  def install_dotfiles_and_tooling
15
- generate "trek:install:ruby"
16
- generate "trek:install:package_json"
17
- generate "trek:install:yarn"
18
-
19
- generate "trek:install:brakeman"
20
- generate "trek:install:bundler_audit"
21
- generate "trek:install:editorconfig"
22
- generate "trek:install:esbuild"
23
- generate "trek:install:eslint"
24
- generate "trek:install:lefthook"
25
- generate "trek:install:postcss"
26
- generate "trek:install:prettier"
27
- generate "trek:install:procfiles"
28
- generate "trek:install:prosopite"
29
- generate "trek:install:rubocop"
30
- generate "trek:install:slim_lint"
31
- generate "trek:install:stylelint"
32
- generate "trek:install:kaminari"
33
- generate "trek:install:lookbook"
15
+ generate_inline "trek:install:ruby"
16
+ generate_inline "trek:install:package_json"
17
+ generate_inline "trek:install:yarn"
18
+
19
+ generate_inline "trek:install:brakeman"
20
+ generate_inline "trek:install:bundler_audit"
21
+ generate_inline "trek:install:editorconfig"
22
+ generate_inline "trek:install:esbuild"
23
+ generate_inline "trek:install:eslint"
24
+ generate_inline "trek:install:lefthook"
25
+ generate_inline "trek:install:postcss"
26
+ generate_inline "trek:install:prettier"
27
+ generate_inline "trek:install:procfiles"
28
+ generate_inline "trek:install:prosopite"
29
+ generate_inline "trek:install:rubocop"
30
+ generate_inline "trek:install:slim_lint"
31
+ generate_inline "trek:install:stylelint"
32
+ generate_inline "trek:install:kaminari"
33
+ generate_inline "trek:install:lookbook"
34
34
 
35
35
  run "yarn install", abort_on_failure: true
36
36
  end
@@ -60,100 +60,101 @@ module Trek
60
60
  end
61
61
 
62
62
  def setup_config
63
- generate "trek:install:config"
63
+ generate_inline "trek:install:config"
64
+ generate_inline "trek:install:security_headers"
64
65
  end
65
66
 
66
67
  def install_specs
67
- generate "trek:install:specs"
68
+ generate_inline "trek:install:specs"
68
69
  end
69
70
 
70
71
  def install_strip_attributes
71
- generate "trek:install:strip_attributes"
72
+ generate_inline "trek:install:strip_attributes"
72
73
  end
73
74
 
74
75
  def install_emails
75
- generate "trek:install:postmark"
76
- generate "trek:install:mailer"
76
+ generate_inline "trek:install:postmark"
77
+ generate_inline "trek:install:mailer"
77
78
  end
78
79
 
79
80
  def install_monitoring
80
- generate "trek:install:appsignal"
81
+ generate_inline "trek:install:appsignal"
81
82
  end
82
83
 
83
84
  def install_user
84
- generate "trek:install:user"
85
+ generate_inline "trek:install:user"
85
86
  end
86
87
 
87
88
  def install_authentication
88
- generate "trek:install:authentication"
89
+ generate_inline "trek:install:authentication"
89
90
  end
90
91
 
91
92
  def install_authorization
92
- generate "trek:install:authorization"
93
+ generate_inline "trek:install:authorization"
93
94
  end
94
95
 
95
96
  def install_healthcheck
96
- generate "trek:install:healthcheck"
97
+ generate_inline "trek:install:healthcheck"
97
98
  end
98
99
 
99
100
  def install_translations
100
- generate "trek:install:translations"
101
+ generate_inline "trek:install:translations"
101
102
  end
102
103
 
103
104
  def add_locales_generator
104
- generate "trek:install:locales"
105
+ generate_inline "trek:install:locales"
105
106
  end
106
107
 
107
108
  def install_attachments
108
- generate "trek:install:attachments"
109
- generate "trek:install:uploaders"
109
+ generate_inline "trek:install:attachments"
110
+ generate_inline "trek:install:uploaders"
110
111
  end
111
112
 
112
113
  def install_models
113
- generate "trek:install:page"
114
- generate "trek:install:current"
115
- generate "trek:install:fragment"
116
- generate "trek:install:menu_node"
117
- generate "trek:install:external_link"
118
- generate "trek:install:model_specs"
114
+ generate_inline "trek:install:page"
115
+ generate_inline "trek:install:current"
116
+ generate_inline "trek:install:fragment"
117
+ generate_inline "trek:install:menu_node"
118
+ generate_inline "trek:install:external_link"
119
+ generate_inline "trek:install:model_specs"
119
120
  end
120
121
 
121
122
  def install_ci
122
- generate "trek:install:ci"
123
+ generate_inline "trek:install:ci"
123
124
  end
124
125
 
125
126
  def install_makefile
126
- generate "trek:install:makefile"
127
+ generate_inline "trek:install:makefile"
127
128
  end
128
129
 
129
130
  def install_readme
130
- generate "trek:install:readme"
131
+ generate_inline "trek:install:readme"
131
132
  end
132
133
 
133
134
  def install_agents
134
- generate "trek:install:agents"
135
+ generate_inline "trek:install:agents"
135
136
  end
136
137
 
137
138
  def install_admin
138
- generate "trek:install:admin"
139
- generate "trek:install:admin:routes"
140
- generate "trek:install:admin:fragments"
141
- generate "trek:install:admin:pages"
142
- generate "trek:install:admin:user_password_resets"
143
- generate "trek:install:admin:user_sessions"
144
- generate "trek:install:admin:users"
139
+ generate_inline "trek:install:admin"
140
+ generate_inline "trek:install:admin:routes"
141
+ generate_inline "trek:install:admin:fragments"
142
+ generate_inline "trek:install:admin:pages"
143
+ generate_inline "trek:install:admin:user_password_resets"
144
+ generate_inline "trek:install:admin:user_sessions"
145
+ generate_inline "trek:install:admin:users"
145
146
  end
146
147
 
147
148
  def install_assets
148
- generate "trek:install:assets"
149
+ generate_inline "trek:install:assets"
149
150
  end
150
151
 
151
152
  def install_component_index
152
- generate "trek:install:component"
153
+ generate_inline "trek:install:component"
153
154
  end
154
155
 
155
156
  def install_application_files
156
- generate "trek:install:application"
157
+ generate_inline "trek:install:application"
157
158
  end
158
159
 
159
160
  def run_migrations
@@ -173,7 +174,7 @@ module Trek
173
174
  say ""
174
175
  say "Create an admin user with:"
175
176
  say ""
176
- say " rails g trek:admin:user --email admin@example.com --password azerty123"
177
+ say " rails g trek:admin:user --email admin@example.com --password ************"
177
178
  say ""
178
179
  say "Then start the server:"
179
180
  say ""
@@ -183,6 +184,13 @@ module Trek
183
184
 
184
185
  private
185
186
 
187
+ # Runs a generator in this process rather than in a new `rails generate`, which boots the app
188
+ # again: for Trek's 50-odd generators, that took about two minutes. Other gems' generators keep
189
+ # their own process (`generate`), as they may need a gem this run just added to the Gemfile.
190
+ def generate_inline(name)
191
+ generate name, inline: true
192
+ end
193
+
186
194
  def ascii_art
187
195
  <<~ASCII
188
196
  ██████▌ ██████▌
@@ -1,3 +1,4 @@
1
+ require "shellwords"
1
2
  require "rails/generators/actions"
2
3
  require "rails/generators/migration"
3
4
  require "rails/generators/resource_helpers"
@@ -15,6 +16,13 @@ module Trek
15
16
 
16
17
  source_root File.expand_path("templates", __dir__)
17
18
 
19
+ def initialize(args, *)
20
+ # The attributes as given, for the model generator: once parsed, `attributes` loses their indexes,
21
+ # references' options or decimals' precision
22
+ @given_attributes = args.drop(1)
23
+ super
24
+ end
25
+
18
26
  # `rails g model Shop::Product` writes app/models/shop.rb as a `module Shop`
19
27
  # namespace file; if a `Shop` model already lives there, it gets replaced.
20
28
  def warn_about_shadowed_models
@@ -28,14 +36,15 @@ module Trek
28
36
  end
29
37
 
30
38
  def create_model
31
- generate :model, class_name, attributes.map { |a| "#{a.name}:#{a.type}" }
39
+ # Escaped for the shell `generate` runs: it would expand `price:decimal{10,2}`'s braces
40
+ generate :model, class_name, @given_attributes.map { Shellwords.escape(it) }
32
41
  end
33
42
 
34
43
  def inject_trek_to_model
35
44
  inject_into_class model_file_path,
36
45
  class_name,
37
46
  model_injection
38
- run "rubocop --autocorrect #{model_file_path}", abort_on_failure: true
47
+ rubocop_autocorrect model_file_path
39
48
  end
40
49
 
41
50
  def add_model_message
@@ -61,7 +70,7 @@ module Trek
61
70
  inject_into_file dashboard_file_path,
62
71
  "\n::#{class_name},",
63
72
  after: "MODELS_IN_MENU = ["
64
- run "rubocop --autocorrect #{dashboard_file_path}", abort_on_failure: true
73
+ rubocop_autocorrect dashboard_file_path
65
74
  end
66
75
 
67
76
  def add_routes
@@ -134,8 +143,7 @@ module Trek
134
143
  # without re-indenting the body; the indentation cops are forced with
135
144
  # --only because rubocop-rails-omakase leaves them disabled.
136
145
  def reindent(path)
137
- run "rubocop --autocorrect --only Layout/IndentationWidth,Layout/IndentationConsistency #{path}",
138
- abort_on_failure: true
146
+ rubocop_autocorrect path, only: "Layout/IndentationWidth,Layout/IndentationConsistency"
139
147
  end
140
148
 
141
149
  def controller_file_path
@@ -44,6 +44,11 @@ module Trek
44
44
  "app/policies/admin/tag_category_policy.rb"
45
45
  end
46
46
 
47
+ def copy_model_specs
48
+ template "spec/models/tag_spec.rb",
49
+ "spec/models/tag_spec.rb"
50
+ end
51
+
47
52
  def copy_policy_specs
48
53
  template "spec/policies/admin/tag_policy_spec.rb",
49
54
  "spec/policies/admin/tag_policy_spec.rb"
@@ -158,6 +158,22 @@ bundler-audit:
158
158
  script:
159
159
  - bundle exec bundle-audit check --update
160
160
 
161
+ # Software Bill of Materials (CycloneDX): the gems and npm packages in the lockfiles, with their licenses.
162
+ # Uncomment the job when a client asks for one.
163
+ # GitLab keeps each branch's latest one by default, past `expire_in`: hand over the one of the production branch.
164
+ # cdxgen runs with an empty environment (env -i), so neither it nor its dependencies see the CI's tokens.
165
+ # sbom:
166
+ # <<: *security_definition
167
+ # script:
168
+ # - env -i PATH="$PATH" HOME="$HOME" FETCH_LICENSE=true npx --yes @cyclonedx/cdxgen@12.8.6 --type ruby --type js --no-recurse --output sbom.cdx.json .
169
+ # artifacts:
170
+ # name: "sbom-${CI_COMMIT_REF_SLUG}"
171
+ # expire_in: 1 month
172
+ # paths:
173
+ # - sbom.cdx.json
174
+ # reports:
175
+ # cyclonedx: sbom.cdx.json
176
+
161
177
  #
162
178
  # Deploy
163
179
  #
@@ -173,7 +189,7 @@ bundler-audit:
173
189
  # - main
174
190
  # environment:
175
191
  # name: qa
176
- # url: https://qa.temoanadiving.com
192
+ # url: https://qa.example.com
177
193
  # script:
178
194
  # - curl $HATCHBOX_WEBHOOK_QA -X POST
179
195
 
@@ -183,6 +199,6 @@ bundler-audit:
183
199
  # - production
184
200
  # environment:
185
201
  # name: preprod
186
- # url: https://temoanadiving.com
202
+ # url: https://example.com
187
203
  # script:
188
204
  # - curl $HATCHBOX_WEBHOOK_PROD -X POST
@@ -15,7 +15,7 @@ admin:
15
15
 
16
16
  lint:
17
17
  bundle exec rubocop
18
- bundle exec slim-lint app/**/*.slim
18
+ bundle exec slim-lint "app/**/*.slim"
19
19
  yarn eslint "app/**/*.js"
20
20
  yarn stylelint "app/**/*.css"
21
21
  yarn prettier --check "{app,config,lib,spec}/**/*.{css,js,json,md,yml}"
@@ -0,0 +1,21 @@
1
+ module Admin
2
+ # Signs out browsers signed in as the current user, listed on their profile's sessions tab. Only
3
+ # theirs: every query goes through Current.user.sessions.
4
+ class ActiveSessionsController < Admin::BaseController
5
+ def destroy
6
+ Current.user.sessions.find(params[:id]).destroy
7
+ redirect_to sessions_tab, notice: t(".success")
8
+ end
9
+
10
+ def destroy_others
11
+ Current.user.sessions.where.not(id: Current.session.id).destroy_all
12
+ redirect_to sessions_tab, notice: t(".success")
13
+ end
14
+
15
+ private
16
+
17
+ def sessions_tab
18
+ admin_user_path(Current.user, anchor: "sessions")
19
+ end
20
+ end
21
+ end
@@ -0,0 +1,30 @@
1
+ module Admin
2
+ class AuditLogsController < Trek::ResourceController
3
+ include Trek::Filters
4
+ include Trek::Pagination
5
+ include Trek::Scopes
6
+
7
+ helper Trek::AuditLogsHelper
8
+
9
+ def index
10
+ super
11
+ @objects = @objects.includes(:actor, :auditable)
12
+ apply_filters!
13
+ apply_scopes!
14
+ end
15
+
16
+ private
17
+
18
+ def model
19
+ AuditLog
20
+ end
21
+
22
+ def available_filters
23
+ %i[action actor_type actor_id auditable_type auditable_id]
24
+ end
25
+
26
+ def available_scopes
27
+ %i[failures]
28
+ end
29
+ end
30
+ end
@@ -1,5 +1,12 @@
1
1
  module Admin
2
2
  class FragmentsController < Trek::ResourceController
3
+ include Trek::Search
4
+
5
+ def index
6
+ super
7
+ search_in_objects!
8
+ end
9
+
3
10
  private
4
11
 
5
12
  def model
@@ -0,0 +1,8 @@
1
+ module Admin
2
+ module Panels
3
+ # The content editor's image panel, served under the app's routes: Trek's isolated engine only gives
4
+ # its own controllers the engine's routes, which can't reach the admin's.
5
+ class ImagesController < Trek::Panels::ImagesController
6
+ end
7
+ end
8
+ end
@@ -0,0 +1,8 @@
1
+ module Admin
2
+ module Panels
3
+ # The content editor's link panel, served under the app's routes: Trek's isolated engine only gives
4
+ # its own controllers the engine's routes, which can't reach the admin's.
5
+ class LinksController < Trek::Panels::LinksController
6
+ end
7
+ end
8
+ end
@@ -0,0 +1,8 @@
1
+ module Admin
2
+ module Panels
3
+ # The content editor's prompt panel, served under the app's routes: Trek's isolated engine only gives
4
+ # its own controllers the engine's routes, which can't reach the admin's.
5
+ class PromptsController < Trek::Panels::PromptsController
6
+ end
7
+ end
8
+ end
@@ -0,0 +1,41 @@
1
+ module Admin
2
+ # Signing in with a passkey instead of a password, from the sign-in form
3
+ class PasskeySessionsController < ApplicationController
4
+ include Trek::Authentication
5
+ include Trek::Passkeys
6
+
7
+ allow_unauthenticated_access
8
+ rate_limit to: 10, within: 3.minutes, only: :create, with: -> { redirect_to new_admin_user_session_path, alert: t("notices.rate_limited") }
9
+
10
+ # What the browser needs to offer the site's passkeys, fetched when the sign-in form opens
11
+ def options
12
+ render_passkey_options User.passkey_request_options(passkey_relying_party)
13
+ end
14
+
15
+ def create
16
+ @user = User.privileged.authenticate_by_passkey(passkey_relying_party, params[:credential], challenge: take_passkey_challenge)
17
+
18
+ if @user
19
+ # A passkey proves it's them: failed passwords no longer lock them out
20
+ @user.record_successful_sign_in!
21
+ start_new_session_for @user
22
+ record_sign_in_of @user
23
+ redirect_to after_authentication_url, notice: sign_in_notice(@user)
24
+ else
25
+ redirect_to new_admin_user_session_path, alert: t(".failure")
26
+ end
27
+ end
28
+
29
+ private
30
+
31
+ # In the user's language: this request isn't signed in yet, so it's still in the app's default one.
32
+ def sign_in_notice(user)
33
+ I18n.with_locale(user.locale || I18n.default_locale) { t("admin.user_sessions.create.success") }
34
+ end
35
+
36
+ # For the audit log (Trek::Auditable): the account signed in to
37
+ def audit_target
38
+ @user
39
+ end
40
+ end
41
+ end
@@ -0,0 +1,37 @@
1
+ module Admin
2
+ # Passkeys the current user adds and deletes, on their profile's passkeys tab. Only theirs: every
3
+ # query goes through Current.user.passkeys.
4
+ class PasskeysController < Admin::BaseController
5
+ include Trek::Passkeys
6
+
7
+ helper Trek::UserAgentsHelper
8
+
9
+ # What the browser needs to create a passkey, fetched when the user adds one
10
+ def options
11
+ render_passkey_options Current.user.passkey_creation_options(passkey_relying_party)
12
+ end
13
+
14
+ def create
15
+ # Shown when Trek doesn't know the passkey's provider
16
+ browser = helpers.user_agent_summary(request.user_agent)
17
+ passkey = Current.user.add_passkey(passkey_relying_party, params[:credential], challenge: take_passkey_challenge, name: browser)
18
+
19
+ if passkey
20
+ redirect_to passkeys_tab, notice: t(".success")
21
+ else
22
+ redirect_to passkeys_tab, alert: t(".failure")
23
+ end
24
+ end
25
+
26
+ def destroy
27
+ Current.user.passkeys.find(params[:id]).destroy
28
+ redirect_to passkeys_tab, notice: t(".success"), status: :see_other
29
+ end
30
+
31
+ private
32
+
33
+ def passkeys_tab
34
+ admin_user_path(Current.user, anchor: "passkeys")
35
+ end
36
+ end
37
+ end
@@ -18,9 +18,9 @@ module Admin
18
18
  end
19
19
 
20
20
  def create
21
- if user = User.privileged.find_by(email: params[:email])
22
- Admin::PasswordsMailer.reset(user).deliver_later
23
- end
21
+ # Queued whatever the email, and answered the same: the response doesn't tell whether an
22
+ # account exists.
23
+ Admin::PasswordResetJob.perform_later(params[:email].to_s)
24
24
 
25
25
  redirect_to new_admin_user_session_path, notice: t(".success")
26
26
  end
@@ -37,7 +37,7 @@ module Admin
37
37
  end
38
38
 
39
39
  @user.update!(params.permit(:password))
40
- @user.user_sessions.destroy_all
40
+ @user.sessions.destroy_all
41
41
  redirect_to new_admin_user_session_path, notice: t(".success")
42
42
  rescue ActiveRecord::RecordInvalid
43
43
  redirect_to edit_admin_user_password_reset_path(@token), alert: @user.errors.full_messages.join(", ")