maquina-generators 0.3.0 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 93ceefd73d3c9ff6cc2672408b697f8bd89557a1d1b069121b3eb4aeb237169a
-  data.tar.gz: 8bf8072079ccbd44ccc74e6ed9278df905704d1826fb442d5fe965880b7184c5
+  metadata.gz: a581a9d09b983644b89ffae641f2fe08678a6a6d0f71125937f05354624a4887
+  data.tar.gz: 1b002af208c383174877f552055e64435099709fbfd997d228aca8ec15df39aa
 SHA512:
-  metadata.gz: d09ece2ec179ec0ca30ce5a0b426c52f50f791afee3a8a8ef877fe05779c50f367b341667199d73ea49204420dfd1d94c2bdf3acff45df5a9b695592d8f1e103
-  data.tar.gz: 70698a7c84c71c8a734592262f67f935ccd0cf1daa36820d7e3368878aa7d448a4352d94038db9aba3b71c1beabae38db50d895fc0f75b54b1f8dbb4ca9ed10b
+  metadata.gz: a7319c61cce5ffcef0376b918f4ff706170c678309f79814379a2ef89ffa15a77c71e9e369fda32168842c514cd1303403acf1a8542194fbd1394c0937f2cd3d
+  data.tar.gz: 17634bc69f8cb7acb1eb0b1a2ec28e79461daeb480ad869c41731c6c6334fcf4840574711e8ce4c75da459419b30a70f020a8cd053fc940f562276fc5acb44cf

data/README.md

@@ -36,7 +36,6 @@ rails g maquina:clave
 Then:
 
 ```bash
-bundle install    # Install bcrypt
 rails db:migrate  # Run migrations
 ```
 
@@ -84,6 +83,7 @@ rails g maquina:registration
 Then:
 
 ```bash
+bundle install    # Install bcrypt
 rails db:migrate  # Run migrations
 ```
 
@@ -115,13 +115,16 @@ All generated code lives in your app -- edit it directly:
 - **BackstageController:** Inherits from `ActionController::Base` (bypasses app's ApplicationController concerns)
 - **Initializer:** Credentials-first auth with ENV variable fallback, database connection config
 - **Route:** Mounts `SolidErrors::Engine` under a configurable prefix
-- **Custom views:** Optionally copies custom Tailwind-styled views to override the gem defaults
+- **Admin navigation:** Shared navigation bar linking Solid Errors and Mission Control Jobs dashboards
+- **Custom layout:** Tailwind-styled layout with admin navigation and toast flash messages
+- **Stimulus controllers:** `clipboard_controller.js` and `backtrace_filter_controller.js`
+- **Custom views:** Tailwind-styled views to override the gem defaults (included by default, use `--no-copy-views` to skip)
 
 #### Usage
 
 ```bash
 rails g maquina:solid_errors --prefix /admin
-rails g maquina:solid_errors --prefix /admin --copy-views   # Include custom views
+rails g maquina:solid_errors --prefix /admin --no-copy-views   # Skip custom views
 ```
 
 The generator automatically runs `bundle install`. After running, execute `bin/rails generate solid_errors:install` (decline the initializer overwrite to keep your config), then `bin/rails db:migrate`.
@@ -129,8 +132,8 @@ The generator automatically runs `bundle install`. After running, execute `bin/r
 #### Options
 
 ```bash
-rails g maquina:solid_errors --prefix /admin                          # Default env vars
-rails g maquina:solid_errors --prefix /admin --copy-views             # With custom views
+rails g maquina:solid_errors --prefix /admin                          # Default (with custom views)
+rails g maquina:solid_errors --prefix /admin --no-copy-views          # Without custom views
 rails g maquina:solid_errors --prefix /backstage \
   --user-env-var ADMIN_USER --password-env-var ADMIN_PASSWORD         # Custom env vars
 ```
@@ -150,14 +153,19 @@ Credentials are resolved in order:
 
 #### What it generates
 
-- **BackstageController:** Inherits from `ActionController::Base` (bypasses app's ApplicationController concerns)
+- **BackstageController:** Inherits from `ActionController::Base` with maquina_components helpers (bypasses app's ApplicationController concerns)
+- **Helper:** `MissionControlHelper` with `job_status_badge_variant` and `nav_icon_for_section`
 - **Initializer:** Sets base controller class, credentials-first auth with ENV variable fallback
 - **Route:** Mounts `MissionControl::Jobs::Engine` under a configurable prefix
+- **Admin navigation:** Shared navigation bar linking Solid Errors and Mission Control Jobs dashboards
+- **Custom layout:** Tailwind-styled layout with admin navigation, toast flash messages, application/server selection, and tab navigation
+- **Custom views:** Tailwind-styled views for jobs, queues, workers, and recurring tasks (included by default, use `--no-copy-views` to skip)
 
 #### Usage
 
 ```bash
 rails g maquina:mission_control_jobs --prefix /admin
+rails g maquina:mission_control_jobs --prefix /admin --no-copy-views   # Skip custom views
 ```
 
 The generator automatically runs `bundle install`.
@@ -165,7 +173,8 @@ The generator automatically runs `bundle install`.
 #### Options
 
 ```bash
-rails g maquina:mission_control_jobs --prefix /admin                  # Default env vars
+rails g maquina:mission_control_jobs --prefix /admin                  # Default (with custom views)
+rails g maquina:mission_control_jobs --prefix /admin --no-copy-views  # Without custom views
 rails g maquina:mission_control_jobs --prefix /backstage \
   --user-env-var ADMIN_USER --password-env-var ADMIN_PASSWORD         # Custom env vars
 ```
@@ -240,19 +249,23 @@ Customize rules in `config/initializers/rack_attack.rb`.
 
 #### What it does
 
-1. Adds development, runtime, and production gems (brakeman, standard, rails-i18n, maquina_components, aws-sdk-s3, etc.)
+1. Adds development, runtime, and production gems (brakeman, standard, rails-i18n, maquina-components, aws-sdk-s3, etc.)
 2. Creates `Procfile.dev`
 3. Creates `.rubocop.yml`, `.standard.yml`, appends to `.gitignore`
-4. Creates `bin/setup` and `bin/ci` scripts
-5. Creates `config/initializers/generators.rb`
-6. Configures development (letter_opener) and production (APPLICATION_HOST) environments
-7. Configures `field_error_proc` in application
-8. Installs Action Text and Active Storage
-9. Sets up ActiveStorage JavaScript imports
-10. Adds turbo morphing and `yield :head` to layout
-11. Invokes sub-generators: `maquina:rack_attack`, `maquina:solid_queue`, `maquina:mission_control_jobs`, `maquina:solid_errors`, `maquina_components:install`
-12. Creates a HomeController with root route
-13. Generates a README and `database.yml.example`
+4. Creates `config/initializers/generators.rb`
+5. Configures development (letter_opener) and production (APPLICATION_HOST) environments
+6. Configures `field_error_proc` and Solid Queue in `application.rb`
+7. Installs Action Text and Active Storage
+8. Sets up ActiveStorage JavaScript imports
+9. Adds turbo morphing, `yield :head`, and simplifies `<main>` tag in layout
+10. Optionally installs authentication (`maquina:clave` or `maquina:registration`)
+11. Invokes sub-generators: `maquina:rack_attack`, `maquina:mission_control_jobs`, `maquina:solid_errors`
+12. Runs external installers: `solid_queue:install`, `solid_errors:install`, `solid_cache:install`, `solid_cable:install`, `maquina_components:install`
+13. Restores custom layouts overwritten by gem installers
+14. Configures multi-database `database.yml` (primary, queue, cache, cable, errors)
+15. Creates a HomeController with root route
+16. Generates a README and `database.yml.example`
+17. Runs `db:prepare`
 
 #### Usage
 
@@ -271,8 +284,6 @@ rails g maquina:app --auth registration
 #### After running
 
 ```bash
-bin/rails generate solid_errors:install   # decline initializer overwrite
-bin/rails db:migrate
 bin/rails credentials:edit                # set backstage username/password
 bin/dev
 ```

data/lib/generators/maquina/app/app_generator.rb

@@ -19,10 +19,15 @@ module Maquina
 
         content = File.read(gemfile_path)
 
+        remove_gems = ["rubocop-rails-omakase"]
         dev_gems = {"brakeman" => nil, "bundle-audit" => nil, "letter_opener" => nil, "standard" => nil}
-        runtime_gems = {"rails-i18n" => nil, "maquina_components" => nil}
+        runtime_gems = {"rails-i18n" => nil, "maquina-components" => nil}
         production_gems = {"aws-sdk-s3" => nil}
 
+        remove_gems.each do |gem_name|
+          gsub_file "Gemfile", /^\s*gem\s+["']#{gem_name}["'].*\n/, ""
+        end
+
         dev_gems.each do |gem_name, _|
           unless content.include?("gem \"#{gem_name}\"")
             append_to_file "Gemfile", "\ngem \"#{gem_name}\", group: :development\n"
@@ -67,15 +72,7 @@ module Maquina
         end
       end
 
-      # 4. Scripts
-      def create_scripts
-        template "bin/setup.tt", "bin/setup"
-        copy_file "bin/ci", "bin/ci"
-        chmod "bin/setup", 0o755
-        chmod "bin/ci", 0o755
-      end
-
-      # 5. Initializers
+      # 4. Initializers
       def create_initializers
         copy_file "config/initializers/generators.rb",
           "config/initializers/generators.rb"
@@ -104,6 +101,18 @@ module Maquina
             RUBY
           end
         end
+
+        unless content.include?("solid_queue")
+          inject_into_file "config/application.rb",
+            after: /class Application < Rails::Application\n/ do
+            <<~RUBY.indent(4)
+
+              # Use Solid Queue as the Active Job backend in all environments except test
+              config.active_job.queue_adapter = :solid_queue unless Rails.env.test?
+              config.solid_queue.connects_to = {database: {writing: :queue}}
+            RUBY
+          end
+        end
       end
 
       # 8. Install Rails features
@@ -113,7 +122,6 @@ module Maquina
         Bundler.with_unbundled_env do
           system("bin/rails action_text:install", chdir: destination_root)
           system("bin/rails active_storage:install", chdir: destination_root)
-          system("bin/rails db:migrate", chdir: destination_root)
         end
       end
 
@@ -161,6 +169,12 @@ module Maquina
             "<body>",
             '<body data-turbo-refresh-method="morph" data-turbo-refresh-scroll="preserve">'
         end
+
+        if content.include?('class="container mx-auto mt-28 px-5 flex"')
+          gsub_file "app/views/layouts/application.html.erb",
+            '<main class="container mx-auto mt-28 px-5 flex">',
+            "<main>"
+        end
       end
 
       # 11. Install authentication
@@ -169,9 +183,9 @@ module Maquina
 
         case options[:auth]
         when "clave"
-          generate "maquina:clave"
+          generate "maquina:clave", "--quiet"
         when "registration"
-          generate "maquina:registration"
+          generate "maquina:registration", "--quiet"
         end
       end
 
@@ -179,17 +193,40 @@ module Maquina
       def install_maquina_generators
         return unless rails_app?
 
-        generate "maquina:rack_attack"
-        generate "maquina:solid_queue"
-        generate "maquina:mission_control_jobs", "--prefix", options[:prefix]
-        generate "maquina:solid_errors", "--prefix", options[:prefix]
+        generate "maquina:rack_attack", "--quiet"
+        generate "maquina:mission_control_jobs", "--prefix", options[:prefix], "--quiet"
+        generate "maquina:solid_errors", "--prefix", options[:prefix], "--quiet"
 
         Bundler.with_unbundled_env do
-          system("bin/rails maquina_components:install", chdir: destination_root)
+          system("bin/rails generate solid_queue:install", chdir: destination_root)
+          system("bin/rails generate solid_errors:install", chdir: destination_root)
+          system("bin/rails generate solid_cache:install", chdir: destination_root)
+          system("bin/rails generate solid_cable:install", chdir: destination_root)
+          system("bin/rails generate maquina_components:install", chdir: destination_root)
+        end
+      end
+
+      # 13. Restore custom layouts overwritten by gem installers
+      def restore_custom_layouts
+        return unless rails_app?
+
+        solid_errors_layout = File.expand_path(
+          "../solid_errors/templates/app/views/layouts/solid_errors/application.html.erb",
+          __dir__
+        )
+
+        if File.exist?(solid_errors_layout)
+          create_file "app/views/layouts/solid_errors/application.html.erb",
+            File.read(solid_errors_layout), force: true
         end
       end
 
-      # 13. Create home page
+      # 14. Configure multiple databases (after installers so we overwrite their database.yml)
+      def configure_databases
+        template "config/database.yml.tt", "config/database.yml", force: true
+      end
+
+      # 15. Create home page
       def create_home_page
         template "app/controllers/home_controller.rb",
           "app/controllers/home_controller.rb"
@@ -199,18 +236,18 @@ module Maquina
         route_file = File.join(destination_root, "config/routes.rb")
         if File.exist?(route_file)
           content = File.read(route_file)
-          unless content.include?("root")
+          unless content.match?(/^\s*root\s/)
             route 'root "home#index"'
           end
         end
       end
 
-      # 14. Create README
+      # 16. Create README
       def create_readme
         template "README.md.erb", "README.md"
       end
 
-      # 15. Create database.yml.example
+      # 17. Create database.yml.example
       def create_database_sample
         db_config = File.join(destination_root, "config/database.yml")
         if File.exist?(db_config)
@@ -218,26 +255,43 @@ module Maquina
         end
       end
 
-      # 16. Post-install message
+      # 18. Run all migrations
+      def run_migrations
+        return unless rails_app?
+
+        Bundler.with_unbundled_env do
+          system("bin/rails db:prepare", chdir: destination_root)
+        end
+      end
+
+      # 19. Post-install message
       def show_post_install
         say ""
+        say "=" * 60, :green
         say "Your Rails app is ready!", :green
+        say "=" * 60, :green
         say ""
-        say "Manual steps:", :yellow
-        say "  1. bin/rails generate solid_errors:install"
-        say "     (decline initializer overwrite to keep your config)"
-        say "  2. bin/rails db:migrate"
-        say "  3. Set credentials: bin/rails credentials:edit"
+        say "Next steps:", :yellow
+        say "  1. Set credentials: bin/rails credentials:edit"
         say "     backstage:"
         say "       username: your_user"
         say "       password: your_password"
-        say "  4. Start the app: bin/dev"
+        say "  2. Start the app: bin/dev"
+        say ""
+        say "Installed components:", :yellow
+        say "  - Rack::Attack: rate limiting and blocklists (config/initializers/rack_attack.rb)"
+        say "  - Solid Queue: background jobs (config/solid_queue.yml)"
+        say "  - Mission Control Jobs: job dashboard at #{options[:prefix]}/mission_control_jobs"
+        say "  - Solid Errors: error tracking at #{options[:prefix]}/solid_errors"
+        say "  - Maquina Components: UI components"
         if options[:auth] != "none"
           say ""
           say "Authentication (#{options[:auth]}):", :yellow
-          say "  - Run bin/rails db:migrate if you haven't already"
-          say "  - Visit /registrations/new to sign up" if options[:auth] == "registration"
           say "  - Visit /session/new to sign in"
+          say "  - Visit /registrations/new to sign up" if options[:auth] == "registration"
+          say "  - Visit /registration/new to sign up" if options[:auth] == "clave"
+          say "  - Customize: app/controllers/concerns/authentication.rb"
+          say "  - Locales: config/locales/"
         end
         say ""
       end

data/lib/generators/maquina/app/templates/.rubocop.yml

@@ -0,0 +1,5 @@
+require:
+  - standard
+
+inherit_gem:
+  standard: config/base.yml

data/lib/generators/maquina/app/templates/.standard.yml

@@ -0,0 +1 @@
+ruby_version: 3.2

data/lib/generators/maquina/app/templates/Procfile.dev.tt

@@ -1,2 +1,3 @@
 web: bin/rails server -p <%= options[:port] %>
 css: bin/rails tailwindcss:watch
+solid_queue: bin/rails solid_queue:start

data/lib/generators/maquina/app/templates/README.md.erb

@@ -1,32 +1,98 @@
 # <%= File.basename(destination_root).titleize %>
 
+Built with [maquina.app](https://maquina.app) — production-tested tools for developers who ship alone.
+
 ## Getting Started
 
+### Prerequisites
+
+- Ruby 3.2+
+- Rails 8+
+- PostgreSQL (or SQLite for development)
+
+### Setup
+
 ```bash
-bin/setup
-bin/dev
+bin/setup    # Install dependencies and prepare databases
+bin/dev      # Start all processes (web, css, solid_queue)
 ```
 
-## Development
+Your app will be running at **http://localhost:<%= options[:port] %>**.
+
+## What's Included
 
-- **Server:** http://localhost:<%= options[:port] %>
-- **Jobs dashboard:** http://localhost:<%= options[:port] %><%= options[:prefix] %>/mission_control_jobs
-- **Errors dashboard:** http://localhost:<%= options[:port] %><%= options[:prefix] %>/solid_errors
+| Feature | Description |
+|---------|-------------|
+<% if options[:auth] != "none" -%>
+| **Authentication** | <%= options[:auth] == "clave" ? "Clave passwordless email-code authentication" : "Registration-based email/password authentication" %> |
+<% end -%>
+| **Background Jobs** | Solid Queue with Mission Control Jobs dashboard |
+| **Error Tracking** | Solid Errors with custom UI |
+| **Rate Limiting** | Rack::Attack with sensible defaults |
+| **UI Components** | Maquina Components (ERB partials + Tailwind + Stimulus) |
+| **Caching** | Solid Cache |
+| **WebSockets** | Solid Cable |
+| **Rich Text** | Action Text |
+| **File Storage** | Active Storage (S3-ready in production) |
+| **Multi-database** | Separate databases for queue, cache, cable, and errors |
+
+## Development URLs
+
+| URL | Description |
+|-----|-------------|
+| http://localhost:<%= options[:port] %> | Application |
+| http://localhost:<%= options[:port] %><%= options[:prefix] %>/mission_control_jobs | Jobs dashboard |
+| http://localhost:<%= options[:port] %><%= options[:prefix] %>/solid_errors | Errors dashboard |
+<% if options[:auth] != "none" -%>
+| http://localhost:<%= options[:port] %>/session/new | Sign in |
+<% if options[:auth] == "registration" -%>
+| http://localhost:<%= options[:port] %>/registrations/new | Sign up |
+<% elsif options[:auth] == "clave" -%>
+| http://localhost:<%= options[:port] %>/registration/new | Sign up |
+<% end -%>
+<% end -%>
 
 ## Scripts
 
-- `bin/setup` — Install dependencies and prepare database
-- `bin/ci` — Run full CI suite (lint, security, tests)
+- `bin/setup` — Install dependencies and prepare databases
 - `bin/dev` — Start all processes (web, css, solid_queue)
 
 ## Credentials
 
+Edit credentials with:
+
 ```bash
 bin/rails credentials:edit
 ```
 
+Add backstage credentials for the jobs and errors dashboards:
+
 ```yaml
 backstage:
   username: your_user
   password: your_password
 ```
+
+## Maquina Ecosystem
+
+### UI Components
+
+[Maquina Components](https://maquina.app/documentation/components/) — a library of ERB partials, Tailwind CSS styles, and Stimulus controllers for building consistent, accessible UIs in Rails.
+
+### AI Tools
+
+Maquina provides a suite of AI-powered tools to accelerate your Rails development:
+
+- **Rails MCP Server** — Model Context Protocol server for Rails applications
+- **Rails Simplifier** — simplify and refine Rails code following 37signals patterns
+- **Rails Upgrade Assistant** — comprehensive Rails upgrade reports and migration guides
+- **Maquina UI Standards** — build consistent UIs using maquina_components
+- **Neovim MCP Server** — MCP server for Neovim integration
+
+Learn more at [maquina.app/documentation/ai-tools](https://maquina.app/documentation/ai-tools/).
+
+## Learn More
+
+Visit [maquina.app](https://maquina.app) for full documentation.
+
+Maquina is built for the one-person framework philosophy: production-first, standard Rails, designed to scale with a small team.