maquina-generators 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ce5b50ab1d409ff8e66103ffd248866536fb97868694f514fc63e622a091d3e9
-  data.tar.gz: 991f0a0f392196b14285b68ec027cf120f4b610f172c6772e095343ff032bf1d
+  metadata.gz: 93ceefd73d3c9ff6cc2672408b697f8bd89557a1d1b069121b3eb4aeb237169a
+  data.tar.gz: 8bf8072079ccbd44ccc74e6ed9278df905704d1826fb442d5fe965880b7184c5
 SHA512:
-  metadata.gz: 0f151ba3435ab5cb9be0cf0ddbe8d864b18d3f59f2c403e08a9653998fbe95b384947d315f99bc155d5337603d931b839d1408aa2b227eb41562490e07082d87
-  data.tar.gz: 1caf6b0eb21b9eefb9ada1806e6af396fd435224edce1bf7dd1a1899a7243164b1baa599eebb28d91c2d142e26e19bcbe66da8db2032abea937804698ca46c26
+  metadata.gz: d09ece2ec179ec0ca30ce5a0b426c52f50f791afee3a8a8ef877fe05779c50f367b341667199d73ea49204420dfd1d94c2bdf3acff45df5a9b695592d8f1e103
+  data.tar.gz: 70698a7c84c71c8a734592262f67f935ccd0cf1daa36820d7e3368878aa7d448a4352d94038db9aba3b71c1beabae38db50d895fc0f75b54b1f8dbb4ca9ed10b

data/README.md

@@ -60,6 +60,52 @@ All generated code lives in your app -- edit it directly:
 - **Email sender:** Edit `app/mailers/verification_mailer.rb`
 - **Translations:** Edit `config/locales/clave.*.yml`
 
+### Registration -- Password-Based Authentication with Accounts
+
+**Registration** generates a password-based authentication system with multi-tenant account support. It builds on top of the Rails 8 authentication generator, adding an Account model (tenant), user roles, and a registration flow.
+
+#### What it generates
+
+- **Runs Rails authentication generator** first (`bin/rails generate authentication`)
+- **Account model:** `Account` with `name` field and `has_many :users`
+- **Updated User model:** Adds `belongs_to :account`, `role` enum (admin/member), `name` field
+- **Updated Current model:** Adds `account` delegation through the user
+- **Registration controller:** Creates Account + User (admin role) together in a transaction
+- **Views:** Tailwind-styled registration form and updated login form with indigo color scheme
+- **Locale files:** English and Spanish translations
+- **Migrations:** `create_accounts` and `add_account_fields_to_users`
+
+#### Usage
+
+```bash
+rails g maquina:registration
+```
+
+Then:
+
+```bash
+rails db:migrate  # Run migrations
+```
+
+#### Options
+
+```bash
+rails g maquina:registration                # Full install
+rails g maquina:registration --skip-views   # Skip view templates
+```
+
+#### Customization
+
+All generated code lives in your app -- edit it directly:
+
+- **Account fields:** Edit `app/models/account.rb` to add more tenant fields
+- **User roles:** Edit `app/models/user.rb` to customize the role enum
+- **Registration flow:** Edit `app/controllers/registrations_controller.rb`
+- **Colors/styling:** Edit view templates (default: indigo)
+- **Translations:** Edit `config/locales/registration.*.yml`
+
+---
+
 ### Solid Errors -- Error Tracking Dashboard
 
 **Solid Errors** installs the [solid_errors](https://github.com/fractaledmind/solid_errors) gem with HTTP authentication and engine mounting.
@@ -78,7 +124,7 @@ rails g maquina:solid_errors --prefix /admin
 rails g maquina:solid_errors --prefix /admin --copy-views   # Include custom views
 ```
 
-The generator automatically runs `bundle install` and `solid_errors:install`. After running, execute `bin/rails db:migrate`.
+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`.
 
 #### Options
 
@@ -133,6 +179,34 @@ Credentials are resolved in order:
 
 ---
 
+### Solid Queue -- Background Job Processing
+
+**Solid Queue** installs the [solid_queue](https://github.com/rails/solid_queue) gem as the Active Job backend with configuration and Procfile.dev integration.
+
+#### What it generates
+
+- **Config:** `config/solid_queue.yml` with default dispatcher/worker settings
+- **Application config:** Sets `config.active_job.queue_adapter = :solid_queue` (skipped in test environment)
+- **Procfile.dev:** Appends `solid_queue: bin/rails solid_queue:start`
+- **Migrations:** Runs `solid_queue:install:migrations`
+
+#### Usage
+
+```bash
+rails g maquina:solid_queue
+```
+
+The generator automatically runs `bundle install` and installs migrations.
+
+#### Options
+
+```bash
+rails g maquina:solid_queue                      # Default (sqlite3)
+rails g maquina:solid_queue --database postgresql # PostgreSQL
+```
+
+---
+
 ### Rack Attack -- Request Protection
 
 **Rack Attack** installs the [rack-attack](https://github.com/rack/rack-attack) gem with default security rules to block common vulnerability scans and throttle abusive requests.
@@ -160,6 +234,51 @@ Customize rules in `config/initializers/rack_attack.rb`.
 
 ---
 
+### App -- Full Application Setup (Orchestrator)
+
+**App** is a meta-generator that sets up a complete Rails application in one command. Run it after `rails new myapp --css tailwind`.
+
+#### What it does
+
+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`
+
+#### Usage
+
+```bash
+rails g maquina:app
+rails g maquina:app --prefix /backstage --port 3100
+rails g maquina:app --auth registration
+```
+
+#### Options
+
+- `--prefix` (default: `/admin`) -- Base path prefix for backstage tools (Solid Errors, Mission Control Jobs)
+- `--port` (default: `3000`) -- Default port for the development server
+- `--auth` (default: `none`) -- Authentication type: `none`, `clave`, or `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
+```
+
+---
+
 ## Adding New Generators
 
 Create a new folder under `lib/generators/maquina/`:

data/lib/generators/maquina/app/USAGE

@@ -0,0 +1,11 @@
+Description:
+  Sets up a complete Rails application with standard development tools,
+  Solid Queue, Mission Control Jobs, Solid Errors, Rack Attack, and
+  maquina_components.
+
+  Run this after `rails new myapp --css tailwind`.
+
+Examples:
+  rails g maquina:app
+
+  rails g maquina:app --prefix /backstage --port 3100

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

@@ -0,0 +1,290 @@
+require "rails/generators"
+
+module Maquina
+  module Generators
+    class AppGenerator < Rails::Generators::Base
+      source_root File.expand_path("templates", __dir__)
+
+      class_option :prefix, type: :string, default: "/admin",
+        desc: "Base path prefix for backstage tools"
+      class_option :port, type: :string, default: "3000",
+        desc: "Default port for development server"
+      class_option :auth, type: :string, default: "none",
+        desc: "Authentication type: none, clave, or registration"
+
+      # 1. Add gems
+      def add_gems
+        gemfile_path = File.join(destination_root, "Gemfile")
+        return unless File.exist?(gemfile_path)
+
+        content = File.read(gemfile_path)
+
+        dev_gems = {"brakeman" => nil, "bundle-audit" => nil, "letter_opener" => nil, "standard" => nil}
+        runtime_gems = {"rails-i18n" => nil, "maquina_components" => nil}
+        production_gems = {"aws-sdk-s3" => nil}
+
+        dev_gems.each do |gem_name, _|
+          unless content.include?("gem \"#{gem_name}\"")
+            append_to_file "Gemfile", "\ngem \"#{gem_name}\", group: :development\n"
+          end
+        end
+
+        runtime_gems.each do |gem_name, _|
+          unless content.include?("gem \"#{gem_name}\"")
+            append_to_file "Gemfile", "\ngem \"#{gem_name}\"\n"
+          end
+        end
+
+        production_gems.each do |gem_name, _|
+          unless content.include?("gem \"#{gem_name}\"")
+            append_to_file "Gemfile", "\ngem \"#{gem_name}\", group: :production\n"
+          end
+        end
+
+        return unless rails_app?
+
+        Bundler.with_unbundled_env do
+          system("bundle install", chdir: destination_root)
+        end
+      end
+
+      # 2. Create Procfile.dev
+      def create_procfile
+        template "Procfile.dev.tt", "Procfile.dev"
+      end
+
+      # 3. Config files
+      def create_config_files
+        copy_file ".rubocop.yml", ".rubocop.yml"
+        copy_file ".standard.yml", ".standard.yml"
+
+        gitignore_path = File.join(destination_root, ".gitignore")
+        if File.exist?(gitignore_path)
+          content = File.read(gitignore_path)
+          unless content.include?("config/database.yml")
+            append_to_file ".gitignore", "\n# Ignore database configuration\nconfig/database.yml\n"
+          end
+        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
+      def create_initializers
+        copy_file "config/initializers/generators.rb",
+          "config/initializers/generators.rb"
+      end
+
+      # 6. Configure environments
+      def configure_environments
+        configure_development
+        configure_production
+      end
+
+      # 7. Configure application
+      def configure_application
+        application_file = File.join(destination_root, "config/application.rb")
+        return unless File.exist?(application_file)
+
+        content = File.read(application_file)
+
+        unless content.include?("field_error_proc")
+          inject_into_file "config/application.rb",
+            after: /class Application < Rails::Application\n/ do
+            <<~RUBY.indent(4)
+
+              # Don't wrap form fields with errors in an extra div
+              config.action_view.field_error_proc = proc { |html_tag, _instance| html_tag }
+            RUBY
+          end
+        end
+      end
+
+      # 8. Install Rails features
+      def install_rails_features
+        return unless rails_app?
+
+        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
+
+      # 9. Setup JavaScript
+      def setup_javascript
+        return unless rails_app?
+
+        importmap_path = File.join(destination_root, "config/importmap.rb")
+        if File.exist?(importmap_path)
+          content = File.read(importmap_path)
+          unless content.include?("activestorage")
+            append_to_file "config/importmap.rb",
+              "\npin \"@rails/activestorage\", to: \"activestorage.esm.js\"\n"
+          end
+        end
+
+        js_path = File.join(destination_root, "app/javascript/application.js")
+        if File.exist?(js_path)
+          content = File.read(js_path)
+          unless content.include?("ActiveStorage")
+            append_to_file "app/javascript/application.js", <<~JS
+
+              import * as ActiveStorage from "@rails/activestorage"
+              ActiveStorage.start()
+            JS
+          end
+        end
+      end
+
+      # 10. Setup layout
+      def setup_layout
+        layout_path = File.join(destination_root, "app/views/layouts/application.html.erb")
+        return unless File.exist?(layout_path)
+
+        content = File.read(layout_path)
+
+        unless content.include?("yield :head")
+          gsub_file "app/views/layouts/application.html.erb",
+            "</head>",
+            "    <%= yield :head %>\n  </head>"
+        end
+
+        unless content.include?("data-turbo-refresh-method")
+          gsub_file "app/views/layouts/application.html.erb",
+            "<body>",
+            '<body data-turbo-refresh-method="morph" data-turbo-refresh-scroll="preserve">'
+        end
+      end
+
+      # 11. Install authentication
+      def install_authentication
+        return unless rails_app?
+
+        case options[:auth]
+        when "clave"
+          generate "maquina:clave"
+        when "registration"
+          generate "maquina:registration"
+        end
+      end
+
+      # 12. Install maquina generators
+      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]
+
+        Bundler.with_unbundled_env do
+          system("bin/rails maquina_components:install", chdir: destination_root)
+        end
+      end
+
+      # 13. Create home page
+      def create_home_page
+        template "app/controllers/home_controller.rb",
+          "app/controllers/home_controller.rb"
+        template "app/views/home/index.html.erb",
+          "app/views/home/index.html.erb"
+
+        route_file = File.join(destination_root, "config/routes.rb")
+        if File.exist?(route_file)
+          content = File.read(route_file)
+          unless content.include?("root")
+            route 'root "home#index"'
+          end
+        end
+      end
+
+      # 14. Create README
+      def create_readme
+        template "README.md.erb", "README.md"
+      end
+
+      # 15. Create database.yml.example
+      def create_database_sample
+        db_config = File.join(destination_root, "config/database.yml")
+        if File.exist?(db_config)
+          copy_file db_config, "config/database.yml.example"
+        end
+      end
+
+      # 16. Post-install message
+      def show_post_install
+        say ""
+        say "Your Rails app is ready!", :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 "     backstage:"
+        say "       username: your_user"
+        say "       password: your_password"
+        say "  4. Start the app: bin/dev"
+        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"
+        end
+        say ""
+      end
+
+      private
+
+      def rails_app?
+        File.exist?(File.join(destination_root, "bin/rails"))
+      end
+
+      def configure_development
+        dev_file = File.join(destination_root, "config/environments/development.rb")
+        return unless File.exist?(dev_file)
+
+        content = File.read(dev_file)
+
+        unless content.include?("letter_opener")
+          inject_into_file "config/environments/development.rb",
+            before: /^end/ do
+            <<~RUBY.indent(2)
+
+              # Use letter_opener for email delivery
+              config.action_mailer.delivery_method = :letter_opener
+              config.action_mailer.perform_deliveries = true
+              config.action_mailer.default_url_options = {host: "localhost", port: #{options[:port]}}
+            RUBY
+          end
+        end
+      end
+
+      def configure_production
+        prod_file = File.join(destination_root, "config/environments/production.rb")
+        return unless File.exist?(prod_file)
+
+        content = File.read(prod_file)
+
+        unless content.include?("APPLICATION_HOST")
+          inject_into_file "config/environments/production.rb",
+            before: /^end/ do
+            <<~RUBY.indent(2)
+
+              # Set host for URL generation
+              config.action_mailer.default_url_options = {host: ENV.fetch("APPLICATION_HOST", "example.com")}
+            RUBY
+          end
+        end
+      end
+    end
+  end
+end

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

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

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

@@ -0,0 +1,32 @@
+# <%= File.basename(destination_root).titleize %>
+
+## Getting Started
+
+```bash
+bin/setup
+bin/dev
+```
+
+## Development
+
+- **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
+
+## Scripts
+
+- `bin/setup` — Install dependencies and prepare database
+- `bin/ci` — Run full CI suite (lint, security, tests)
+- `bin/dev` — Start all processes (web, css, solid_queue)
+
+## Credentials
+
+```bash
+bin/rails credentials:edit
+```
+
+```yaml
+backstage:
+  username: your_user
+  password: your_password
+```

data/lib/generators/maquina/app/templates/app/controllers/home_controller.rb

@@ -0,0 +1,6 @@
+class HomeController < ApplicationController
+  allow_unauthenticated_access if respond_to?(:allow_unauthenticated_access)
+
+  def index
+  end
+end

data/lib/generators/maquina/app/templates/app/views/home/index.html.erb

@@ -0,0 +1,4 @@
+<div class="max-w-2xl mx-auto py-16 px-4 text-center">
+  <h1 class="text-4xl font-bold text-gray-900 mb-4">Welcome</h1>
+  <p class="text-lg text-gray-600">Your application is running.</p>
+</div>

data/lib/generators/maquina/app/templates/bin/ci

@@ -0,0 +1,16 @@
+#!/usr/bin/env bash
+set -e
+
+echo "== Running Standard Ruby =="
+bundle exec standardrb
+
+echo "== Running Brakeman =="
+bundle exec brakeman --no-pager -q
+
+echo "== Running Bundle Audit =="
+bundle exec bundle-audit check --update
+
+echo "== Running tests =="
+bin/rails test
+
+echo "== All checks passed =="

data/lib/generators/maquina/app/templates/bin/setup.tt

@@ -0,0 +1,22 @@
+#!/usr/bin/env ruby
+require "fileutils"
+
+APP_ROOT = File.expand_path("..", __dir__)
+
+def system!(*args)
+  system(*args, exception: true)
+end
+
+FileUtils.chdir APP_ROOT do
+  puts "== Installing dependencies =="
+  system! "gem install bundler --conservative"
+  system("bundle check") || system!("bundle install")
+
+  puts "\n== Preparing database =="
+  system! "bin/rails db:prepare"
+
+  puts "\n== Removing old logs and tempfiles =="
+  system! "bin/rails log:clear tmp:clear"
+
+  puts "\n== Done! Start the app with: bin/dev =="
+end

data/lib/generators/maquina/app/templates/config/initializers/generators.rb

@@ -0,0 +1,4 @@
+Rails.application.config.generators do |g|
+  g.stylesheets false
+  g.helper false
+end

data/lib/generators/maquina/mission_control_jobs/mission_control_jobs_generator.rb

@@ -48,7 +48,9 @@ module Maquina
       def run_bundle_install
         return unless rails_app?
 
-        run "bundle install", capture: true
+        Bundler.with_unbundled_env do
+          system("bundle install", chdir: destination_root)
+        end
       end
 
       # 6. Post-install message

data/lib/generators/maquina/mission_control_jobs/templates/config/initializers/mission_control.rb.tt

@@ -1,7 +1,8 @@
 # frozen_string_literal: true
 
 Rails.application.configure do
-  config.mission_control.jobs.base_controller_class = "BackstageController"
+  MissionControl::Jobs.base_controller_class = "BackstageController"
+  MissionControl::Jobs.adapters = [:solid_queue]
 
   backstage = Rails.application.credentials.backstage || {}
 

data/lib/generators/maquina/rack_attack/rack_attack_generator.rb

@@ -26,7 +26,9 @@ module Maquina
       def run_bundle_install
         return unless rails_app?
 
-        run "bundle install", capture: true
+        Bundler.with_unbundled_env do
+          system("bundle install", chdir: destination_root)
+        end
       end
 
       # 4. Post-install message

data/lib/generators/maquina/registration/USAGE

@@ -0,0 +1,10 @@
+Description:
+  Generates password-based authentication with account registration.
+
+  Runs the Rails authentication generator first, then adds an Account model
+  (tenant), updates the User model with account association and roles, and
+  creates a registration controller with Tailwind-styled views.
+
+Examples:
+  rails g maquina:registration                # Full install
+  rails g maquina:registration --skip-views   # No view templates (API-only or custom views)