trek 2.0.1 → 2.2.0

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

@@ -0,0 +1,56 @@
+require "rails/generators/actions"
+require "generators/trek/helpers"
+
+module Trek
+  module Generators
+    module Install
+      class ProsopiteGenerator < Rails::Generators::Base
+        include Trek::Generators::Helpers
+
+        desc "Install Prosopite (N+1 query detection)."
+
+        source_root File.expand_path("../templates", __dir__)
+
+        def add_gems
+          return if in_gemfile?("prosopite")
+
+          gem "prosopite", group: [:development, :test],
+            comment: "N+1 query detection (raises in test, logs in development) [https://github.com/charkost/prosopite]"
+          gem "pg_query", group: [:development, :test]
+          bundle_install
+        end
+
+        def create_initializer
+          return if File.exist?("config/initializers/prosopite.rb")
+
+          create_file "config/initializers/prosopite.rb" do
+            <<~RUBY
+              # N+1 query detection with Prosopite, in development and test only (the gem is not loaded in production).
+              # Every request is scanned by the Rack middleware, which also covers Trek's engine controllers.
+              # Detected N+1s raise Prosopite::NPlusOneQueriesError in test and are logged in development.
+              # Legitimate repeated queries can be wrapped in `Prosopite.pause { … }`.
+              if defined?(Prosopite)
+                require "prosopite/middleware/rack"
+
+                Rails.application.configure do
+                  config.middleware.use(Prosopite::Middleware::Rack)
+                end
+
+                Rails.application.config.after_initialize do
+                  Prosopite.rails_logger = true
+                  Prosopite.raise = Rails.env.test?
+                end
+              end
+            RUBY
+          end
+        end
+
+        def create_smoke_spec
+          return if File.exist?("spec/requests/admin/n_plus_one_spec.rb")
+
+          copy_file "spec/requests/admin/n_plus_one_spec.rb", "spec/requests/admin/n_plus_one_spec.rb"
+        end
+      end
+    end
+  end
+end

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

@@ -5,17 +5,16 @@ module Trek
   module Generators
     module Install
       class ScalingoGenerator < Rails::Generators::Base
+        BUILDPACK_URL = "https://github.com/etaminstudio/trek-buildpack#v0.1.0".freeze
+
         include Trek::Generators::Helpers
 
         desc "Create Scalingo files."
 
-        def create_buildpacks
-          create_file ".buildpacks" do
-            <<~TEXT
-              https://github.com/Scalingo/apt-buildpack.git
-              https://github.com/Scalingo/ruby-buildpack.git
-            TEXT
-          end
+        # The trek-buildpack replaces the apt + ruby buildpack combination. It
+        # pins Node from the .node-version that `rails new` already generates.
+        def remove_buildpacks
+          remove_file ".buildpacks"
         end
 
         def create_aptfile
@@ -37,6 +36,19 @@ module Trek
             TEXT
           end
         end
+
+        def final_instructions
+          say ""
+          say "Configure the Scalingo app environment:"
+          say ""
+          say "    scalingo --app <app> env-set BUILDPACK_URL=#{BUILDPACK_URL}"
+          say "    scalingo --app <app> env-set 'DATABASE_URL=$SCALINGO_POSTGRESQL_URL'"
+          say ""
+          say "and make sure config/database.yml reads DATABASE_URL in production."
+          say ""
+          say "See https://trek.etamin.studio/deploy for details."
+          say ""
+        end
       end
     end
   end

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

@@ -5,7 +5,7 @@ module Trek
   module Generators
     module Install
       class YarnGenerator < Rails::Generators::Base
-        YARN_VERSION = "4.17.0"
+        YARN_VERSION = "4.18.0"
 
         include Trek::Generators::Helpers
 

data/lib/generators/trek/install_generator.rb

@@ -25,6 +25,7 @@ module Trek
         generate "trek:install:postcss"
         generate "trek:install:prettier"
         generate "trek:install:procfiles"
+        generate "trek:install:prosopite"
         generate "trek:install:rubocop"
         generate "trek:install:slim_lint"
         generate "trek:install:stylelint"

data/lib/generators/trek/scaffold_generator.rb

@@ -15,6 +15,18 @@ module Trek
 
       source_root File.expand_path("templates", __dir__)
 
+      # `rails g model Shop::Product` writes app/models/shop.rb as a `module Shop`
+      # namespace file; if a `Shop` model already lives there, it gets replaced.
+      def warn_about_shadowed_models
+        model_namespaces.each do |ns|
+          path = "app/models/#{ns}.rb"
+          next unless File.exist?(path) && File.read(path).match?(/^class #{ns.camelize}\b/)
+
+          say_status :warning, "#{path} defines the #{ns.camelize} model, which the #{ns.camelize} namespace " \
+            "would replace — answer 'n' below to keep it, or move the model first", :red
+        end
+      end
+
       def create_model
         generate :model, class_name, attributes.map { |a| "#{a.name}:#{a.type}" }
       end
@@ -32,7 +44,8 @@ module Trek
 
       def create_controller
         template "controllers/admin/scaffold_controller.rb",
-          "app/controllers/admin/#{namespaced_plural}_controller.rb"
+          controller_file_path
+        reindent controller_file_path
       end
 
       def create_views
@@ -42,9 +55,11 @@ module Trek
         end
       end
 
+      # Top-level qualified: once an Admin::Shop namespace exists (scaffolded
+      # controller/policy), a bare `Shop` under `module Admin` resolves to it.
       def add_models_to_menu
         inject_into_file dashboard_file_path,
-          "\n#{class_name},",
+          "\n::#{class_name},",
           after: "MODELS_IN_MENU = ["
         run "rubocop --autocorrect #{dashboard_file_path}", abort_on_failure: true
       end
@@ -67,7 +82,8 @@ module Trek
 
       def add_policy
         template "policies/admin/scaffold_policy.rb",
-          "app/policies/admin/#{file_path}_policy.rb"
+          policy_file_path
+        reindent policy_file_path
       end
 
       def add_default_locale_files
@@ -114,6 +130,22 @@ module Trek
         "app/models/admin/dashboard.rb"
       end
 
+      # The templates wrap the class in one `module` per namespace segment
+      # without re-indenting the body; the indentation cops are forced with
+      # --only because rubocop-rails-omakase leaves them disabled.
+      def reindent(path)
+        run "rubocop --autocorrect --only Layout/IndentationWidth,Layout/IndentationConsistency #{path}",
+          abort_on_failure: true
+      end
+
+      def controller_file_path
+        "app/controllers/admin/#{namespaced_plural}_controller.rb"
+      end
+
+      def policy_file_path
+        "app/policies/admin/#{file_path}_policy.rb"
+      end
+
       def model_injection
         <<~RUBY
           # TODO: uncomment to format some attributes, or remove if not needed
@@ -160,12 +192,12 @@ module Trek
         "config/locales/admin/#{file_path}.#{locale}.yml"
       end
 
-      # Returns namespace segments from file_path (e.g., ["missive"] for "missive/list")
+      # Returns namespace segments from file_path (e.g., ["shop"] for "shop/product")
       def model_namespaces
         file_path.split("/")[0...-1]
       end
 
-      # Returns the pluralized path preserving namespaces (e.g., "missive/lists" for "missive/list")
+      # Returns the pluralized path preserving namespaces (e.g., "shop/products" for "shop/product")
       def namespaced_plural
         parts = file_path.split("/")
         parts[-1] = parts[-1].pluralize

data/lib/generators/trek/templates/controllers/admin/scaffold_controller.rb.tt

@@ -2,13 +2,13 @@ module Admin
 <% model_namespaces.each do |ns| -%>
   module <%= ns.camelize %>
 <% end -%>
-  class <%= controller_class_name %>Controller < Trek::ResourceController
+  class <%= controller_class_name.demodulize %>Controller < Trek::ResourceController
     # include Trek::Pagination
 
     private
 
     def model
-      <%= class_name %>
+      ::<%= class_name %>
     end
   end
 <% model_namespaces.each do |_ns| -%>

data/lib/generators/trek/templates/locales/scaffold/model.en.yml.tt

@@ -2,10 +2,11 @@ en:
   activerecord:
     models:
       <%= file_path %>:
-        gender: 'n'
+        gender: "n"
         one: <%= human_name %>
         other: <%= plural_name.humanize %>
     attributes:
-      <%= file_path %>:<%- attributes.each do |attr| %>
+      <%= file_path %>:
+<%- attributes.each do |attr| -%>
         <%= attr.name %>: <%= attr.name.humanize -%>
-      <% end %>
+<%- end -%>

data/lib/generators/trek/templates/spec/requests/admin/n_plus_one_spec.rb

@@ -0,0 +1,28 @@
+require "rails_helper"
+
+# Smoke test for Prosopite (config/initializers/prosopite.rb): each admin page below is rendered
+# as an admin, and any N+1 query raises Prosopite::NPlusOneQueriesError.
+#
+# TODO: add the other admin routes (index and edit pages of scaffolded models in particular), and
+# create a few records first so the per-row queries have something to loop over — an empty list
+# can't reveal an N+1.
+RSpec.describe "Admin pages N+1 queries", type: :request do
+  let(:password) { "secret-password-123" }
+  let(:admin) { User.create!(email: "admin@example.com", password:, role: "admin") }
+
+  before do
+    post admin_user_session_path, params: { email: admin.email, password: }
+  end
+
+  {
+    "dashboard" => -> { admin_root_path },
+    "pages index" => -> { admin_pages_path },
+    "fragments index" => -> { admin_fragments_path }
+  }.each do |page, path|
+    it "renders the #{page} without N+1 queries" do
+      get instance_exec(&path)
+
+      expect(response).to have_http_status(:ok)
+    end
+  end
+end

data/lib/generators/trek/templates/views/admin/scaffold/show.html.slim.tt

@@ -3,8 +3,8 @@
 = render Trek::TabsComponent.new do |c|
   - c.with_item(id: :content, label: t("admin.content"))
     = render Trek::PropertiesComponent.new(model:) do |p|
-<% attributes.each do |attribute| -%>
+<% attributes.each_with_index do |attribute, i| -%>
+<%= "\n" unless i.zero? -%>
       = p.with_item :<%= attribute.column_name %>
         = @object.<%= attribute.column_name %>
-
 <% end -%>

data/lib/generators/trek/upgrade/v2_generator.rb

@@ -1,5 +1,6 @@
 require "rails/generators/actions"
 require "generators/trek/helpers"
+require "generators/trek/install/yarn_generator"
 require "yaml"
 
 module Trek
@@ -66,10 +67,28 @@ module Trek
             "and the etaminstudio scope manually.", :yellow
         end
 
+        def upgrade_yarn
+          return if yarn_major_version >= 4
+
+          # The npmPreapprovedPackages setting below requires Yarn 4 (Yarn 3
+          # hard-errors on it), so apply the 0.1.26 upgrade note as part of the
+          # migration: bump Yarn and drop the interactive-tools plugin, whose
+          # upgrade-interactive command is built into Yarn 4.
+          if File.exist?(".yarnrc.yml") && File.read(".yarnrc.yml").include?("plugin-interactive-tools")
+            run "yarn plugin remove @yarnpkg/plugin-interactive-tools"
+          end
+          run "yarn set version #{Install::YarnGenerator::YARN_VERSION}", abort_on_failure: true
+          @yarn_version = nil
+        end
+
         def preapprove_npm_package
           return unless File.exist?(".yarnrc.yml")
           return if File.read(".yarnrc.yml").include?("npmPreapprovedPackages")
 
+          # Defensive: never write the (Yarn 4-only) setting under Yarn 3,
+          # where it is a hard error that breaks every yarn command.
+          return if yarn_major_version < 4
+
           append_to_file ".yarnrc.yml", <<~YAML
 
             # Trek is our own package — exempt it from Yarn's package gates
@@ -98,6 +117,18 @@ module Trek
               * Revoke this project's Trek deploy token on GitLab.
           SUMMARY
         end
+
+        private
+
+        def yarn_version
+          @yarn_version ||= `yarn --version`.strip
+        rescue Errno::ENOENT
+          @yarn_version = "0"
+        end
+
+        def yarn_major_version
+          yarn_version.to_i
+        end
       end
     end
   end

data/lib/trek/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Trek
-  VERSION = "2.0.1"
+  VERSION = "2.2.0"
 end

data/package.json

@@ -1,6 +1,6 @@
 {
   "name": "trek",
-  "version": "2.0.1",
+  "version": "2.2.0",
   "description": "A modern content management & back-office system for Ruby on Rails",
   "homepage": "https://trek.etamin.studio",
   "license": "MIT",

data/vendor/tom_select/css/tom-select.custom.css

@@ -459,4 +459,3 @@
 .ts-dropdown .optgroup:first-child {
   border-top: 0 none;
 }
-/*# sourceMappingURL=tom-select.default.css.map */

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: trek
 version: !ruby/object:Gem::Version
-  version: 2.0.1
+  version: 2.2.0
 platform: ruby
 authors:
 - Mohamed Bengrich
@@ -434,6 +434,7 @@ files:
 - ".eslintrc.json"
 - ".node-version"
 - ".npmignore"
+- ".prettierignore"
 - ".rspec"
 - ".rubocop.yml"
 - ".slim-lint.yml"
@@ -453,6 +454,7 @@ files:
 - app/assets/icons/trek/add.svg
 - app/assets/icons/trek/arrow-bar-left.svg
 - app/assets/icons/trek/arrow-bar-right.svg
+- app/assets/icons/trek/audit.svg
 - app/assets/icons/trek/bold.svg
 - app/assets/icons/trek/check.svg
 - app/assets/icons/trek/chevron-double-left.svg
@@ -476,6 +478,7 @@ files:
 - app/assets/icons/trek/logout.svg
 - app/assets/icons/trek/paragraph.svg
 - app/assets/icons/trek/pic.svg
+- app/assets/icons/trek/print.svg
 - app/assets/icons/trek/profile.svg
 - app/assets/icons/trek/quotation.svg
 - app/assets/icons/trek/rating.svg
@@ -509,6 +512,10 @@ files:
 - app/components/trek/dashboard/analytics_component/analytics_component.css
 - app/components/trek/dashboard/analytics_component/analytics_component.html.slim
 - app/components/trek/dashboard/analytics_component/analytics_component.js
+- app/components/trek/dashboard/chart_component.rb
+- app/components/trek/dashboard/chart_component/chart_component.css
+- app/components/trek/dashboard/chart_component/chart_component.html.slim
+- app/components/trek/dashboard/chart_component/chart_component.js
 - app/components/trek/dashboard/section_component.rb
 - app/components/trek/dashboard/section_component/section_component.css
 - app/components/trek/dashboard/section_component/section_component.html.slim
@@ -737,6 +744,7 @@ files:
 - docs/.vitepress/theme/index.js
 - docs/.vitepress/theme/style.css
 - docs/customize.md
+- docs/deploy.md
 - docs/getting-started.md
 - docs/index.md
 - docs/public/logo.svg
@@ -821,6 +829,7 @@ files:
 - lib/generators/trek/install/postmark_generator.rb
 - lib/generators/trek/install/prettier_generator.rb
 - lib/generators/trek/install/procfiles_generator.rb
+- lib/generators/trek/install/prosopite_generator.rb
 - lib/generators/trek/install/readme_generator.rb
 - lib/generators/trek/install/rubocop_generator.rb
 - lib/generators/trek/install/ruby_generator.rb
@@ -902,6 +911,7 @@ files:
 - lib/generators/trek/templates/policies/page.rb
 - lib/generators/trek/templates/policies/preview.rb
 - lib/generators/trek/templates/policies/user.rb
+- lib/generators/trek/templates/spec/requests/admin/n_plus_one_spec.rb
 - lib/generators/trek/templates/views/admin/dashboards/index.html.slim
 - lib/generators/trek/templates/views/admin/fragments/_form.html.slim
 - lib/generators/trek/templates/views/admin/fragments/_fragment.json.jb