trek 0.1.23 → 0.1.25

data/lib/generators/trek/install/authentication_generator.rb

@@ -6,13 +6,82 @@ module Trek
   module Generators
     module Install
       class AuthenticationGenerator < Rails::Generators::Base
+        USER_MODEL_CLASS_NAME = "User".freeze
+
+        include Rails::Generators::Migration
         include Trek::Generators::Helpers
 
         desc "Setup authentication."
 
         source_root File.expand_path("../templates", __dir__)
 
-        # TODO
+        def add_bcrypt_gem
+          return if in_gemfile?("bcrypt")
+
+          gem "bcrypt", "~> 3.1.7"
+          bundle_install
+        end
+
+        def copy_admin_authentication_concern
+          template "controllers/concerns/trek/authentication.rb",
+            "app/controllers/concerns/trek/authentication.rb"
+        end
+
+        def copy_user_session_model
+          template "models/user_session.rb",
+            "app/models/user_session.rb"
+        end
+
+        def copy_user_sessions_migration
+          return unless defined?(ActiveRecord)
+
+          migration_template("migrations/user_sessions.rb.erb",
+            "db/migrate/trek_user_sessions.rb",
+            migration_class_name:)
+        end
+
+        def inject_authentication_into_user_model
+          inject_into_class user_model_path,
+            USER_MODEL_CLASS_NAME,
+            user_model_injection
+        end
+
+        def add_admin_auth_routes
+          route "resource :user_session, only: %i[new create destroy]", namespace: :admin
+          route "resources :user_password_resets, param: :token, only: %i[new create edit update]", namespace: :admin
+          route 'get :login, to: "user_sessions#new", as: :login', namespace: :admin
+          route 'delete :logout, to: "user_sessions#destroy", as: :logout', namespace: :admin
+        end
+
+        def autocorrect_user_model
+          run "rubocop --autocorrect #{user_model_path}"
+        end
+
+        private
+
+        def user_model_path
+          @user_model_path ||= File.join("app", "models", "#{USER_MODEL_CLASS_NAME.underscore}.rb")
+        end
+
+        def user_model_injection
+          <<-RUBY
+  has_secure_password
+  has_many :user_sessions, dependent: :destroy
+
+  # Both tokens invalidate once the password changes (password_salt). Invites
+  # get a longer window than a password reset, so they are a distinct purpose.
+  generates_token_for :password_reset, expires_in: 15.minutes do
+    password_salt&.last(10)
+  end
+
+  generates_token_for :invite, expires_in: 1.week do
+    password_salt&.last(10)
+  end
+
+  scope :privileged, -> { where(role: Trek::Users::Roles::PRIVILEGED_ROLES) }
+
+          RUBY
+        end
       end
     end
   end

data/lib/generators/trek/install/authorization_generator.rb

@@ -13,8 +13,10 @@ module Trek
         source_root File.expand_path("../templates", __dir__)
 
         def add_gem
-          gem "action_policy" unless in_gemfile?("action_policy")
-          run "bundle install --quiet", abort_on_failure: true
+          return if in_gemfile?("action_policy")
+
+          gem "action_policy"
+          bundle_install
         end
 
         def run_install

data/lib/generators/trek/install/brakeman_generator.rb

@@ -12,8 +12,10 @@ module Trek
         source_root File.expand_path("../../../../", __dir__)
 
         def add_gem
-          gem "brakeman", group: [:development, :test] unless in_gemfile?("brakeman")
-          run "bundle install --quiet", abort_on_failure: true
+          return if in_gemfile?("brakeman")
+
+          gem "brakeman", group: [:development, :test]
+          bundle_install
         end
       end
     end

data/lib/generators/trek/install/bundler_audit_generator.rb

@@ -12,8 +12,10 @@ module Trek
         source_root File.expand_path("../../../../", __dir__)
 
         def add_gem
-          gem "bundler-audit", group: [:development, :test] unless in_gemfile?("bundler-audit")
-          run "bundle install --quiet", abort_on_failure: true
+          return if in_gemfile?("bundler-audit")
+
+          gem "bundler-audit", group: [:development, :test]
+          bundle_install
         end
       end
     end

data/lib/generators/trek/install/config_generator.rb

@@ -22,6 +22,10 @@ module Trek
               Rails.application.routes.default_url_options[:protocol] = Rails.application.config.force_ssl ? "https" : "http"
               Rails.application.routes.default_url_options[:host] = ENV.fetch("DEFAULT_HOSTNAME", "localhost:3000")
               Rails.application.config.canonical_url = "\#{Rails.application.routes.default_url_options[:protocol]}://\#{Rails.application.routes.default_url_options[:host]}"
+
+              # Mailers run outside a request, so in production they need the same host for
+              # link helpers. Development and test keep the host from their environment files.
+              ActionMailer::Base.default_url_options = Rails.application.routes.default_url_options if Rails.env.production?
             RUBY
           end
         end

data/lib/generators/trek/install/healthcheck_generator.rb

@@ -12,8 +12,10 @@ module Trek
         source_root File.expand_path("../templates", __dir__)
 
         def add_gem
-          gem "rails-healthcheck" unless in_gemfile?("rails-healthcheck")
-          run "bundle install --quiet", abort_on_failure: true
+          return if in_gemfile?("rails-healthcheck")
+
+          gem "rails-healthcheck"
+          bundle_install
         end
 
         def add_initializer

data/lib/generators/trek/install/kaminari_generator.rb

@@ -10,8 +10,10 @@ module Trek
         desc "Install Kaminari."
 
         def add_gem
-          gem "kaminari" unless in_gemfile?("kaminari")
-          run "bundle install --quiet", abort_on_failure: true
+          return if in_gemfile?("kaminari")
+
+          gem "kaminari"
+          bundle_install
         end
       end
     end

data/lib/generators/trek/install/locales_generator.rb

@@ -12,16 +12,19 @@ module Trek
 
         source_root File.expand_path("../templates", __dir__)
 
-        def ask_locales
-          loop do
-            @locales = ENV["TREK_LOCALES"] || ask("What locales do you want to use? (e.g. en, fr)")
+        class_option :locales, type: :string,
+          desc: "Comma-separated locales to enable, e.g. en,fr (default: en)"
 
-            break if valid_locales?(@locales)
+        def set_locales
+          raw = options[:locales] || ENV["TREK_LOCALES"] || "en"
+          @locales = raw.split(",").map(&:strip)
 
-            Rails.logger.debug "Invalid locales entered."
-          end
+          invalid = @locales.reject { |locale| valid_locales?(locale) }
+          return if invalid.empty?
 
-          @locales = @locales.split(",").map(&:strip)
+          say "Ignoring unavailable locales: #{invalid.join(", ")}", :yellow
+          @locales -= invalid
+          @locales = ["en"] if @locales.empty?
         end
 
         def create_locales_initializer

data/lib/generators/trek/install/lookbook_generator.rb

@@ -13,11 +13,13 @@ module Trek
         source_root File.expand_path("../../../../", __dir__)
 
         def add_gem
+          install_needed = %w[lookbook listen actioncable].any? { |name| !in_gemfile?(name) }
+
           gem "lookbook", ">= 2.3.13", group: :development unless in_gemfile?("lookbook")
           gem "listen", group: :development unless in_gemfile?("listen")
           gem "actioncable", group: :development unless in_gemfile?("actioncable")
 
-          run "bundle install --quiet", abort_on_failure: true
+          bundle_install if install_needed
         end
       end
     end

data/lib/generators/trek/install/mailer_generator.rb

@@ -19,25 +19,30 @@ module Trek
             "app/views/layouts/mailer.html.slim"
         end
 
-        def user_mailer
-          template "mailers/user_mailer.rb",
-            "app/mailers/user_mailer.rb"
+        def admin_mailer
+          template "mailers/admin_mailer.rb",
+            "app/mailers/admin_mailer.rb"
         end
 
-        def copy_views_invite_email_user_mailer
+        def passwords_mailer
+          template "mailers/admin/passwords_mailer.rb",
+            "app/mailers/admin/passwords_mailer.rb"
+        end
+
+        def copy_views_admin_mailer_invite
           extensions.each do |extension|
             locales.each do |lang|
-              template "views/user_mailer/invite_email.#{lang}#{extension}",
-                "app/views/user_mailer/invite_email.#{lang}#{extension}"
+              template "views/admin_mailer/invite.#{lang}#{extension}",
+                "app/views/admin_mailer/invite.#{lang}#{extension}"
             end
           end
         end
 
-        def copy_views_reset_password_user_mailer
+        def copy_views_passwords_mailer_reset
           extensions.each do |extension|
             locales.each do |lang|
-              template "views/user_mailer/reset_password_email.#{lang}#{extension}",
-                "app/views/user_mailer/reset_password_email.#{lang}#{extension}"
+              template "views/admin/passwords_mailer/reset.#{lang}#{extension}",
+                "app/views/admin/passwords_mailer/reset.#{lang}#{extension}"
             end
           end
         end

data/lib/generators/trek/install/page_generator.rb

@@ -55,8 +55,10 @@ module Trek
         end
 
         def install_closure_tree
-          gem "closure_tree", "~> 9.0" unless in_gemfile?("closure_tree")
-          run "bundle install --quiet", abort_on_failure: true
+          unless in_gemfile?("closure_tree")
+            gem "closure_tree", "~> 9.0"
+            bundle_install
+          end
           rails_command "db:migrate" # `pages` table must exist
           generate "closure_tree:migration Page"
         end

data/lib/generators/trek/install/postmark_generator.rb

@@ -13,8 +13,10 @@ module Trek
         source_root File.expand_path("../templates", __dir__)
 
         def add_gem
-          gem "postmark-rails" unless in_gemfile?("postmark-rails")
-          run "bundle install --quiet", abort_on_failure: true
+          return if in_gemfile?("postmark-rails")
+
+          gem "postmark-rails"
+          bundle_install
         end
 
         def inject_postmark_to_application_mailer
@@ -28,7 +30,7 @@ module Trek
         def inject_postmark_to_config
           inject_into_file "config/environments/production.rb",
             config_injection,
-            after: "# Specify outgoing SMTP server. Remember to add smtp/* credentials via bin/rails credentials:edit.\n"
+            after: %r{# Specify outgoing SMTP server\. Remember to add smtp/\* credentials via (?:bin/)?rails credentials:edit\.\n}
           run "rubocop --autocorrect config/environments/production.rb", abort_on_failure: true
         end
 

data/lib/generators/trek/install/rubocop_generator.rb

@@ -12,8 +12,10 @@ module Trek
         source_root File.expand_path("../../../../", __dir__)
 
         def add_gem
-          gem "rubocop-rspec", group: [:development, :test], require: false unless in_gemfile?("rubocop-rspec")
-          run "bundle install --quiet", abort_on_failure: true
+          return if in_gemfile?("rubocop-rspec")
+
+          gem "rubocop-rspec", group: [:development, :test], require: false
+          bundle_install
         end
 
         def copy_rubocop_config

data/lib/generators/trek/install/scalingo_generator.rb

@@ -21,8 +21,9 @@ module Trek
         def create_aptfile
           create_file "Aptfile" do
             <<~TEXT
-              libwebp-dev
+              libjemalloc2
               libvips-tools --no-install-recommends
+              libwebp-dev
             TEXT
           end
         end

data/lib/generators/trek/install/slim_lint_generator.rb

@@ -12,8 +12,10 @@ module Trek
         source_root File.expand_path("../../../../", __dir__)
 
         def add_gem
-          gem "slim_lint", group: [:development, :test] unless in_gemfile?("slim_lint")
-          run "bundle install --quiet", abort_on_failure: true
+          return if in_gemfile?("slim_lint")
+
+          gem "slim_lint", group: [:development, :test]
+          bundle_install
         end
 
         def copy_slim_lint_config

data/lib/generators/trek/install/specs_generator.rb

@@ -13,13 +13,14 @@ module Trek
         source_root File.expand_path("../templates", __dir__)
 
         def add_gems
+          install_needed = %w[rspec-rails capybara rspec_junit_formatter rspec-html-matchers simplecov].any? { |name| !in_gemfile?(name) }
+
           gem "rspec-rails", "~> 8.0", group: [:development, :test] unless in_gemfile?("rspec-rails")
           gem "capybara", "~> 3.38", group: [:test] unless in_gemfile?("capybara")
           gem "rspec_junit_formatter", "~> 0.6.0", group: [:test] unless in_gemfile?("rspec_junit_formatter")
           gem "rspec-html-matchers", "~> 0.10.0", group: [:test] unless in_gemfile?("rspec-html-matchers")
           gem "simplecov", "~> 0.22.0", group: [:test] unless in_gemfile?("simplecov")
-
-          run "bundle install --quiet", abort_on_failure: true
+          bundle_install if install_needed
         end
 
         def run_install

data/lib/generators/trek/install/strip_attributes_generator.rb

@@ -12,8 +12,10 @@ module Trek
         source_root File.expand_path("../templates", __dir__)
 
         def add_gem
-          gem "strip_attributes" unless in_gemfile?("strip_attributes")
-          run "bundle install --quiet", abort_on_failure: true
+          return if in_gemfile?("strip_attributes")
+
+          gem "strip_attributes"
+          bundle_install
         end
       end
     end

data/lib/generators/trek/install/translations_generator.rb

@@ -13,11 +13,13 @@ module Trek
         source_root File.expand_path("../templates", __dir__)
 
         def add_gem
+          install_needed = %w[rails-i18n i18n-tasks deepl-rb mobility].any? { |name| !in_gemfile?(name) }
+
           gem "rails-i18n", ">= 6.0.0" unless in_gemfile?("rails-i18n")
           gem "i18n-tasks", "~> 1.0" unless in_gemfile?("i18n-tasks")
           gem "deepl-rb", "~> 3.0" unless in_gemfile?("deepl-rb")
           gem "mobility", "~> 1.3.2" unless in_gemfile?("mobility")
-          run "bundle install --quiet", abort_on_failure: true
+          bundle_install if install_needed
         end
 
         def run_install

data/lib/generators/trek/install/user_generator.rb

@@ -15,11 +15,25 @@ module Trek
 
         source_root File.expand_path("../templates", __dir__)
 
+        def create_user_model
+          return if user_model_existed?
+
+          template "models/user.rb", user_model_path
+        end
+
+        def create_users_migration
+          return unless defined?(ActiveRecord)
+          return if user_model_existed?
+
+          migration_template("migrations/create_users.rb.erb",
+            "db/migrate/trek_create_users.rb",
+            migration_class_name:)
+        end
+
         def inject_trek_to_user_model
           inject_into_class user_model_path,
             USER_MODEL_CLASS_NAME,
             user_model_injection
-          run "rubocop --autocorrect #{user_model_path}", abort_on_failure: true
         end
 
         def copy_migration_files
@@ -30,12 +44,24 @@ module Trek
             migration_class_name:)
         end
 
+        def autocorrect_user_model
+          run "rubocop --autocorrect #{user_model_path}"
+        end
+
         private
 
         def tableized_model_class
           USER_MODEL_CLASS_NAME.gsub("::", "").tableize
         end
 
+        # Memoizes whether the User model existed *before* this generator ran, so the
+        # value stays stable after `create_user_model` writes the file.
+        def user_model_existed?
+          return @user_model_existed unless @user_model_existed.nil?
+
+          @user_model_existed = File.exist?(user_model_path)
+        end
+
         def user_model_path
           @user_model_path ||= File.join("app", "models", "#{user_file_path}.rb")
         end

data/lib/generators/trek/install/yarn_generator.rb

@@ -45,6 +45,14 @@ module Trek
           run "yarn plugin import interactive-tools"
         end
 
+        # The default bin/setup (generated by `rails new -j esbuild`) runs
+        # `yarn install --check-files`, but `--check-files` is not a valid flag
+        # under Yarn berry (the version we pin above), so it breaks `bin/setup`
+        # in CI. Drop the flag.
+        def fix_bin_setup
+          gsub_file "bin/setup", "yarn install --check-files", "yarn install"
+        end
+
         private
 
         def yarnrc_content

data/lib/generators/trek/install_generator.rb

@@ -52,6 +52,9 @@ module Trek
           <<~GITIGNORE
 
             .DS_Store
+
+            # Keep the .env template tracked (Rails ignores all /.env* files).
+            !/.env.example
           GITIGNORE
       end
 
@@ -72,6 +75,10 @@ module Trek
         generate "trek:install:mailer"
       end
 
+      def install_user
+        generate "trek:install:user"
+      end
+
       def install_authentication
         generate "trek:install:authentication"
       end
@@ -84,10 +91,6 @@ module Trek
         generate "trek:install:healthcheck"
       end
 
-      def install_user
-        generate "trek:install:user"
-      end
-
       def install_translations
         generate "trek:install:translations"
       end
@@ -121,6 +124,10 @@ module Trek
         generate "trek:install:readme"
       end
 
+      def install_agents
+        generate "trek:install:agents"
+      end
+
       def install_admin
         generate "trek:install:admin"
         generate "trek:install:admin:routes"

data/lib/generators/trek/templates/.gitlab-ci.yml

@@ -3,7 +3,7 @@
 
 # Variables
 variables:
-  POSTGRES_DB: "project_test"
+  POSTGRES_DB: "<%= application_name %>_test"
   POSTGRES_HOST_AUTH_METHOD: "trust"
   DATABASE_URL: "postgresql://postgres:postgres@postgres:5432/$POSTGRES_DB"
   RAILS_ENV: "test"

data/lib/generators/trek/templates/AGENTS.md

@@ -0,0 +1,36 @@
+# AGENTS.md
+
+Guidance for AI coding agents working in this repository.
+
+## About this project
+
+This is a Ruby on Rails application whose back-office/admin is built with **Trek**, a Rails CMS engine. Trek was installed via `rails g trek:install` and provides the admin UI, authentication, authorization, attachments, and base content models. Project-specific work lives in `app/` — admin controllers under `app/controllers/admin/`, plus your own models, policies, and components. Prefer Trek's generators (`rails g trek:scaffold`, `rails g trek:admin:user`, …) over hand-writing admin plumbing.
+
+## Commands
+
+    make setup    # install dependencies (yarn + bin/setup)
+    make dev      # start the server (overmind)
+    make admin    # create an admin user
+    make seed     # seed the database
+    make test     # run the RSpec suite (alias: make spec)
+    make lint     # rubocop + slim-lint + eslint + stylelint + prettier
+    make fix      # auto-correct lint/format issues
+    make scan     # brakeman + bundle-audit
+
+## Conventions
+
+- **Ruby**: RuboCop with rubocop-rails-omakase — double-quoted strings, 120-col lines.
+- **Views**: Slim templates + ViewComponents (linted with slim-lint).
+- **Assets**: esbuild + PostCSS; Stimulus/Turbo (Hotwired).
+- **i18n**: keep every locale file in `config/locales/` in sync across languages.
+- **Git hooks**: lefthook auto-formats staged files on pre-commit — let it run.
+
+## Upgrading Trek
+
+**Whenever you bump the `trek` gem — and its companion `@etaminstudio/trek` npm package — always:**
+
+1. **Read Trek's `CHANGELOG.md`** for every version between the installed and target version, not just the latest.
+2. **Apply every "Upgrade note".** These are the manual steps host apps must perform (config tweaks, new initializers, regenerated files, data migrations). Do not skip them — the upgrade is not complete until each is applied.
+3. **Remove now-redundant local code.** Where the changelog says a Trek change lets host apps drop or simplify a local patch, monkey-patch, or custom implementation, delete that code as part of the upgrade.
+4. **Keep versions aligned**: the `trek` gem version and the `@etaminstudio/trek` npm version must match.
+5. **Verify**: run `make lint` and `make test` before committing the upgrade.

data/lib/generators/trek/templates/controllers/admin/base_controller.rb

@@ -6,6 +6,7 @@ module Admin
 
     helper Trek::I18nHelper
     helper Trek::ThemeHelper
+    helper ApplicationHelper
 
     layout "admin"
 

data/lib/generators/trek/templates/controllers/admin/user_password_resets_controller.rb

@@ -2,9 +2,10 @@ module Admin
   class UserPasswordResetsController < ApplicationController
     include Trek::Authentication
 
-    skip_before_action :require_login
-    before_action :set_user, only: %i[edit update]
-    before_action :redirect_if_logged_in
+    allow_unauthenticated_access
+    before_action :set_token, only: %i[edit update]
+    before_action :set_user_by_token, only: %i[edit update]
+    rate_limit to: 5, within: 3.minutes, only: :create, with: -> { redirect_to new_admin_user_session_path, alert: t("notices.rate_limited") }
 
     helper Trek::I18nHelper
     helper Trek::ThemeHelper
@@ -14,44 +15,42 @@ module Admin
     default_form_builder Trek::FormBuilder
 
     def new
-      @user_password_reset = Trek::UserPasswordReset.new
-    end
-
-    def edit
     end
 
     def create
-      @user_password_reset = Trek::UserPasswordReset.new(user_password_reset_params)
+      if user = User.privileged.find_by(email: params[:email])
+        Admin::PasswordsMailer.reset(user).deliver_later
+      end
 
-      @user = @user_password_reset.user
-      @user&.deliver_reset_password_instructions!
+      redirect_to new_admin_user_session_path, notice: t(".success")
+    end
 
-      redirect_to(%i[admin login], notice: t(".success"))
+    def edit
     end
 
     def update
-      if @user.change_password(params[:user][:new_password])
-        redirect_to(%i[admin login], notice: t(".success"))
-      else
-        render action: "edit"
-      end
+      @user.update!(params.permit(:password))
+      @user.user_sessions.destroy_all
+      redirect_to new_admin_user_session_path, notice: t(".success")
+    rescue ActiveRecord::RecordInvalid
+      redirect_to edit_admin_user_password_reset_path(@token), alert: @user.errors.full_messages.join(", ")
     end
 
     private
 
-    def set_user
-      @token = params[:id]
-      @user = User.load_from_reset_password_token(params[:id])
-
-      not_authenticated if @user.blank?
-    end
-
-    def user_password_reset_params
-      params.require(:user_password_reset).permit(:email)
+    def set_token
+      @token = params[:token]
     end
 
-    def redirect_if_logged_in
-      redirect_to %i[admin root] if logged_in?
+    # The same edit/update flow is reached from a password-reset email and from
+    # an invitation email, which carry different token purposes (and expiries).
+    def set_user_by_token
+      @user = User.privileged.find_by_token_for(:invite, @token) ||
+        User.privileged.find_by_token_for!(:password_reset, @token)
+    rescue ActiveRecord::RecordNotFound
+      redirect_to new_admin_user_session_path, alert: t("admin.user_password_resets.not_found")
+    rescue ActiveSupport::MessageVerifier::InvalidSignature
+      redirect_to new_admin_user_password_reset_path, alert: t("admin.user_password_resets.not_found")
     end
   end
 end