rails-metro 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 7984159d5d4815a8dd34c8e801453a681891477cd7462dc9ca2bc17a7afac16e
+  data.tar.gz: 76fb628dbd3ffb5ba2c903ce1939255529ba3e6b09b3fac2e8d518002d783f20
+SHA512:
+  metadata.gz: af5c65587ee121c14352822e51500702c8eb6fb6573b8a07c9c6fe2124ec7cbe958a1b49f461037fcd379206c8ae8a995d1392cbd40b2a31fd523d40bc95dedf
+  data.tar.gz: 43d8d9d05da67ee9bed0fdad6c42d47d58cf7e9802c3034758c3a0dfcae77d9c7e44c4a8c75828ed8858dc832426c4f84e00627f9c2596ac736e350854dca243

data/CHANGELOG.md

@@ -0,0 +1,17 @@
+# Changelog
+
+## [0.1.0] - 2026-03-31
+
+### Added
+
+- **130 feature packs** across 11 categories: admin, analytics, api, core, data, notifications, ops, payments, seo, testing, ui
+- **`metro new`** CLI command — create a Rails app with selected packs (`--packs`, `--database`, `--rails_args`)
+- **`metro tui`** — interactive 4-step wizard: app name → database → pack selection → review (requires `gem install bubbletea`)
+- **`metro template`** — generate a template `.rb` file without running `rails new`
+- **`metro from_config`** — generate from a saved `metro.yml` config file
+- **`metro packs`** — list all available packs by category
+- **FeatureRegistry** with topological dependency resolution, conflict detection, and circular dependency detection
+- **TemplateCompiler** producing deterministic Rails Application Templates
+- **Config** with YAML round-trip serialization (`metro.yml`)
+- **Web API**: `FeatureRegistry#as_catalog` and `#validate_selection` for consumption by web UIs
+- **67 tests**: unit, TUI step, golden file, and integration (actually runs `rails new` end-to-end)

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 rails-metro contributors
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

data/README.md

@@ -0,0 +1,267 @@
+# rails-metro
+
+The ultimate Rails app scaffolding tool. Pick the features you need -- authentication, analytics, payments, background jobs, and 120+ more -- and get a production-ready Rails app in one command.
+
+rails-metro compiles your selections into a [Rails Application Template](https://guides.rubyonrails.org/rails_application_templates.html), runs `rails new`, and hands you a standard Rails app with **no runtime dependency** on this gem.
+
+## Installation
+
+```bash
+gem install rails-metro
+
+# For the interactive TUI (optional)
+gem install bubbletea
+```
+
+## Quick Start
+
+```bash
+# Interactive mode (recommended)
+metro tui
+
+# CLI mode
+metro new myapp --packs=authentication,posthog,background_jobs,deployment --database=postgresql
+
+# Just generate the template file
+metro template myapp --packs=posthog,blazer --output=template.rb
+
+# Generate from a saved config
+metro from_config metro.yml
+```
+
+## Commands
+
+| Command | Description |
+|---------|-------------|
+| `metro tui` | Interactive TUI for configuring your app |
+| `metro new APP_NAME` | Create a new Rails app with selected packs |
+| `metro template APP_NAME` | Generate a template file without running rails new |
+| `metro from_config PATH` | Generate from a saved `metro.yml` config |
+| `metro packs` | List all available feature packs |
+| `metro version` | Show version |
+
+### CLI Options
+
+```bash
+metro new myapp \
+  --database=postgresql \        # sqlite3, postgresql, mysql2
+  --packs=auth,posthog,deploy \  # comma-separated pack names
+  --rails_args="--api"           # pass-through to rails new
+```
+
+## Interactive TUI
+
+The TUI walks you through four steps:
+
+1. **App name** -- validates format
+2. **Database** -- sqlite3, postgresql, or mysql2
+3. **Pack selection** -- browse by category, search with `/`, toggle with Space
+4. **Review** -- generate the app, export config, or export template
+
+Dependencies are auto-resolved and conflicts are blocked inline.
+
+Requires the `bubbletea` gem (`gem install bubbletea`).
+
+## Feature Packs (130)
+
+### Admin
+- **activeadmin** -- ActiveAdmin -- classic, battle-tested admin framework
+- **administrate** -- Administrate -- Thoughtbot's lightweight admin framework
+- **avo** -- Avo -- modern, customizable admin panel framework
+- **madmin** -- Madmin -- a modern admin framework by Chris Oliver (GoRails)
+
+### Analytics
+- **ahoy** -- Ahoy for visit and event tracking (first-party analytics)
+- **amplitude** -- Amplitude for product analytics, funnels, and retention
+- **blazer** -- SQL analytics dashboards with Blazer
+- **clicky** -- Clicky for real-time web analytics
+- **fathom** -- Fathom -- simple, privacy-focused website analytics
+- **google_analytics** -- Google Analytics 4 (GA4) for web analytics
+- **google_tag_manager** -- Google Tag Manager for managing analytics and marketing tags
+- **heap** -- Heap for auto-captured product analytics
+- **matomo** -- Matomo -- self-hosted open-source web analytics
+- **mixpanel** -- Mixpanel for event-based product analytics
+- **plausible** -- Plausible -- privacy-focused analytics (no cookies, GDPR compliant)
+- **posthog** -- PostHog product analytics (server-side + JS snippet)
+- **statcounter** -- StatCounter for visitor stats and web analytics
+
+### API
+- **api_cors** -- Rack CORS for cross-origin API requests
+- **api_docs** -- Rswag for Swagger/OpenAPI documentation from tests
+- **api_guard** -- API Guard for JWT authentication
+- **api_serialization** -- Alba for fast, flexible JSON serialization
+- **doorkeeper** -- Doorkeeper for OAuth2 provider
+- **graphql** -- GraphQL API with graphql-ruby
+- **webhooks** -- Incoming and outgoing webhook handling
+
+### Core
+- **authentication** -- authentication-zero (2FA, recovery codes, you own the code)
+- **authorization** -- Action Policy for authorization
+- **background_jobs** -- Solid Queue + Mission Control Jobs (no Redis)
+- **caching** -- Solid Cache (database-backed caching)
+- **devise** -- Devise for full-featured authentication
+- **faraday** -- Faraday for composable HTTP requests
+- **good_job** -- GoodJob for Postgres-backed background jobs
+- **invisible_captcha** -- Invisible Captcha for honeypot spam prevention
+- **mobility** -- Mobility for translatable model attributes
+- **multitenancy** -- acts_as_tenant for row-based multi-tenancy
+- **omniauth** -- OmniAuth for social/OAuth login
+- **passwordless** -- Passwordless for magic-link authentication
+- **pundit** -- Pundit for simple, policy-based authorization
+- **r2_storage** -- Cloudflare R2 for Active Storage (no egress fees)
+- **rails_i18n** -- Rails I18n locale data for 100+ languages
+- **recaptcha** -- reCAPTCHA v3 for bot protection
+- **rolify** -- Rolify for role management
+- **s3_storage** -- AWS S3 for Active Storage
+- **scheduling** -- Recurring tasks with Solid Queue _(requires: background_jobs)_
+- **sidekiq** -- Sidekiq for Redis-backed background jobs
+- **websockets** -- Solid Cable (database-backed ActionCable)
+
+### Data
+- **aasm** -- AASM for state machines
+- **ab_testing** -- Split for A/B testing
+- **activity_feed** -- Public Activity for timelines
+- **acts_as_list** -- Acts As List for sortable records
+- **acts_as_votable** -- Acts As Votable for likes/upvotes
+- **annotate** -- Annotate models with schema info
+- **audit_trail** -- PaperTrail for model versioning
+- **counter_culture** -- Counter Culture for counter caches
+- **data_migrate** -- Data Migrate for data migrations
+- **elasticsearch** -- Searchkick for Elasticsearch search
+- **encryption** -- Lockbox for field encryption
+- **event_sourcing** -- Rails Event Store for event sourcing/CQRS
+- **geocoder** -- Geocoder for address lookup and distance
+- **kredis** -- Kredis for structured Redis types
+- **meilisearch** -- Meilisearch for fast full-text search
+- **scenic** -- Scenic for versioned database views
+- **search** -- pg_search for PostgreSQL full-text search
+- **soft_deletes** -- Discard for soft deletes
+- **storage_validations** -- Active Storage file validations
+- **strong_migrations** -- Catch unsafe migrations before they run
+- **tagging** -- Acts As Taggable On
+
+### Notifications
+- **aws_ses** -- Amazon SES for email delivery
+- **mailgun** -- Mailgun for transactional email
+- **notifications** -- Noticed for multi-channel notifications
+- **postmark** -- Postmark for transactional email
+- **resend** -- Resend for email delivery
+- **sendgrid** -- SendGrid for email delivery
+- **sent_dm** -- Sent.dm for multi-channel messaging
+- **slack_notifier** -- Slack webhook notifications
+- **twilio** -- Twilio for SMS, voice, and WhatsApp
+- **web_push** -- Web Push for browser notifications
+
+### Ops
+- **after_party** -- AfterParty for one-time post-deploy tasks
+- **app_linting** -- Standard Ruby + ERB Lint
+- **circuit_breaker** -- Circuitbox for circuit breaking
+- **datadog** -- Datadog APM for tracing and metrics
+- **deployment** -- Kamal for zero-downtime deploys
+- **dotenv** -- Dotenv for .env files in development
+- **error_tracking** -- Sentry for error tracking
+- **feature_flags** -- Flipper for feature flags
+- **health_check** -- OkComputer for health check endpoints
+- **honeybadger** -- Honeybadger for error tracking
+- **hotwire_livereload** -- Hotwire LiveReload for dev
+- **letter_opener** -- Letter Opener for email preview (dev)
+- **letter_opener_web** -- Letter Opener Web UI _(requires: letter_opener)_
+- **logging** -- Lograge for structured request logs
+- **maintenance_mode** -- Turnout for maintenance pages
+- **maintenance_tasks** -- Maintenance Tasks (Shopify)
+- **newrelic** -- New Relic APM
+- **performance** -- Rack Mini Profiler + Bullet
+- **pghero** -- PgHero for Postgres performance dashboard
+- **pretender** -- Pretender for user impersonation
+- **profiling** -- Stackprof + memory_profiler
+- **rack_timeout** -- Rack::Timeout for request protection
+- **rate_limiting** -- Rack::Attack for throttling
+- **rollbar** -- Rollbar for error tracking
+- **security** -- Brakeman + bundler-audit
+
+### Payments
+- **lemon_squeezy** -- Lemon Squeezy (merchant of record)
+- **mollie** -- Mollie for European payments
+- **paddle** -- Paddle (merchant of record)
+- **payments** -- Pay + Stripe for subscriptions
+- **paypal** -- PayPal for payments and checkout
+- **revenuecat** -- RevenueCat for subscription management
+- **solidus** -- Solidus for full e-commerce
+
+### SEO
+- **seo** -- meta-tags + sitemap_generator
+
+### Testing
+- **shoulda_matchers** -- Shoulda Matchers for one-liner assertions
+- **simplecov** -- SimpleCov for code coverage
+- **test_mocking** -- VCR + WebMock for HTTP recording
+- **testing** -- FactoryBot + Faker + Capybara
+
+### UI
+- **action_text** -- Action Text for rich text editing
+- **breadcrumbs** -- Gretel for breadcrumb navigation
+- **charting** -- Chartkick + Groupdate for charts
+- **cloudinary** -- Cloudinary for image/video management
+- **components** -- ViewComponent for component-based views
+- **friendly_id** -- FriendlyId for URL slugs
+- **icons** -- Lucide Rails for SVG icons
+- **markdown** -- Redcarpet for Markdown rendering
+- **pagination** -- Pagy for pagination
+- **pdf** -- Grover for PDF generation
+- **qr_code** -- RQRCode for QR code generation
+- **ransack** -- Ransack for search/filter forms
+- **simple_calendar** -- Simple Calendar for calendar views
+- **simple_form** -- Simple Form for form building
+- **spreadsheets** -- Caxlsx for Excel generation
+- **stimulus_components** -- Pre-built Stimulus controllers
+- **vite_rails** -- Vite Rails for frontend bundling with HMR
+
+## Dependencies and Conflicts
+
+Packs can declare dependencies and conflicts:
+
+- **Dependencies** are auto-resolved. Selecting `scheduling` automatically adds `background_jobs`.
+- **Conflicts** are mutually exclusive. You can't select both `authentication` and `devise`, or both `sidekiq` and `good_job`.
+
+## How It Works
+
+1. You select packs via the TUI, CLI flags, or a `metro.yml` config file
+2. rails-metro resolves dependencies and validates conflicts
+3. A Rails Application Template is compiled from your selections
+4. `rails new` runs with that template
+5. You get a standard Rails app -- no runtime dependency on rails-metro
+
+## Config File
+
+Export and reuse configurations:
+
+```yaml
+# metro.yml
+app_name: myapp
+database: postgresql
+selected_packs:
+  - authentication
+  - posthog
+  - background_jobs
+  - deployment
+rails_args: ""
+```
+
+```bash
+metro from_config metro.yml
+```
+
+## Development
+
+```bash
+bundle install
+bundle exec rake test          # Unit + golden file tests
+bundle exec rake test:tui      # TUI step tests
+bundle exec rake test:integration  # End-to-end (runs rails new)
+bundle exec rake test:all      # Everything
+bundle exec rake standard      # Lint
+```
+
+## License
+
+MIT

data/exe/metro

@@ -0,0 +1,3 @@
+#!/usr/bin/env ruby
+require "rails/metro"
+Rails::Metro::CLI.start(ARGV)

data/lib/rails/metro/cli.rb

@@ -0,0 +1,162 @@
+require "thor"
+
+module Rails
+  module Metro
+    class CLI < Thor
+      def self.exit_on_failure?
+        true
+      end
+
+      desc "new APP_NAME", "Create a new Rails app with selected feature packs"
+      option :database, type: :string, default: "sqlite3", desc: "Database adapter (sqlite3, postgresql, mysql2)"
+      option :packs, type: :string, default: "", desc: "Comma-separated list of feature packs to enable"
+      option :rails_args, type: :string, default: "", desc: "Additional arguments passed through to rails new"
+      def new(app_name)
+        selected_packs = options[:packs].split(",").map(&:strip).reject(&:empty?)
+
+        config = Config.new(
+          app_name: app_name,
+          database: options[:database],
+          selected_packs: selected_packs,
+          rails_args: options[:rails_args]
+        )
+
+        registry = FeatureRegistry.default
+        resolved_packs = registry.resolve(config.selected_packs)
+
+        compiler = TemplateCompiler.new(config: config, packs: resolved_packs)
+        template_path = compiler.compile_to_file
+
+        say "rails-metro v#{VERSION}", :green
+        say "Packs: #{resolved_packs.map(&:pack_name).join(", ")}", :cyan unless resolved_packs.empty?
+        say "Template: #{template_path}", :cyan
+        say ""
+
+        rails_cmd = build_rails_command(app_name, config, template_path)
+        say "Running: #{rails_cmd}", :yellow
+        system(rails_cmd)
+
+        notes = compiler.post_install_notes
+        if notes.any?
+          say ""
+          say "Post-install notes:", :green
+          notes.each { |note| say "  - #{note}" }
+        end
+      ensure
+        File.unlink(template_path) if template_path && File.exist?(template_path)
+      end
+
+      desc "packs", "List available feature packs"
+      def packs
+        registry = FeatureRegistry.default
+        registry.categories.sort.each do |category, pack_classes|
+          say category, :green
+          pack_classes.sort_by(&:pack_name).each do |pack|
+            deps = pack.depends_on.any? ? " (requires: #{pack.depends_on.join(", ")})" : ""
+            say "  #{pack.pack_name} - #{pack.description}#{deps}"
+          end
+          say ""
+        end
+      end
+
+      desc "template APP_NAME", "Generate a Rails template file without running rails new"
+      option :packs, type: :string, default: "", desc: "Comma-separated list of feature packs to enable"
+      option :output, type: :string, default: nil, desc: "Output file path (default: stdout)"
+      def template(app_name)
+        selected_packs = options[:packs].split(",").map(&:strip).reject(&:empty?)
+
+        config = Config.new(
+          app_name: app_name,
+          selected_packs: selected_packs
+        )
+
+        registry = FeatureRegistry.default
+        resolved_packs = registry.resolve(config.selected_packs)
+        compiler = TemplateCompiler.new(config: config, packs: resolved_packs)
+        content = compiler.compile
+
+        if options[:output]
+          File.write(options[:output], content)
+          say "Template written to #{options[:output]}", :green
+        else
+          puts content
+        end
+      end
+
+      desc "tui", "Launch interactive TUI for configuring your Rails app"
+      def tui
+        require_relative "tui"
+        config, action = Tui.run
+
+        return unless action
+
+        case action
+        when "g"
+          generate_from_config(config)
+        when "e"
+          path = "metro.yml"
+          File.write(path, config.to_yaml)
+          say "Config saved to #{path}", :green
+        when "t"
+          registry = FeatureRegistry.default
+          resolved_packs = config.selected_packs.empty? ? [] : registry.resolve(config.selected_packs)
+          compiler = TemplateCompiler.new(config: config, packs: resolved_packs)
+          path = "template.rb"
+          File.write(path, compiler.compile)
+          say "Template saved to #{path}", :green
+        end
+      end
+
+      desc "from_config PATH", "Generate a Rails app from a metro.yml config file"
+      def from_config(path)
+        unless File.exist?(path)
+          say "File not found: #{path}", :red
+          exit 1
+        end
+
+        config = Config.from_yaml(File.read(path))
+        generate_from_config(config)
+      end
+
+      desc "version", "Show rails-metro version"
+      def version
+        say "rails-metro v#{VERSION}"
+      end
+
+      private
+
+      def generate_from_config(config)
+        registry = FeatureRegistry.default
+        resolved_packs = config.selected_packs.empty? ? [] : registry.resolve(config.selected_packs)
+
+        compiler = TemplateCompiler.new(config: config, packs: resolved_packs)
+        template_path = compiler.compile_to_file
+
+        say "rails-metro v#{VERSION}", :green
+        say "Config: #{config.summary}", :cyan
+        say ""
+
+        rails_cmd = build_rails_command(config.app_name, config, template_path)
+        say "Running: #{rails_cmd}", :yellow
+        system(rails_cmd)
+
+        notes = compiler.post_install_notes
+        if notes.any?
+          say ""
+          say "Post-install notes:", :green
+          notes.each { |note| say "  - #{note}" }
+        end
+      ensure
+        File.unlink(template_path) if template_path && File.exist?(template_path)
+      end
+
+      def build_rails_command(app_name, config, template_path)
+        parts = ["rails", "new", app_name]
+        parts += ["--database=#{config.database}"] unless config.database == "sqlite3"
+        parts += ["-m", template_path]
+        parts += config.rails_args.split unless config.rails_args.empty?
+        parts.join(" ")
+      end
+    end
+  end
+end

data/lib/rails/metro/config.rb

@@ -0,0 +1,40 @@
+require "yaml"
+
+module Rails
+  module Metro
+    class Config
+      attr_accessor :app_name, :database, :selected_packs, :rails_args
+
+      def initialize(app_name: nil, database: "sqlite3", selected_packs: [], rails_args: "")
+        @app_name = app_name
+        @database = database
+        @selected_packs = selected_packs
+        @rails_args = rails_args
+      end
+
+      def to_yaml
+        {
+          "app_name" => app_name,
+          "database" => database,
+          "selected_packs" => selected_packs,
+          "rails_args" => rails_args
+        }.to_yaml
+      end
+
+      def self.from_yaml(yaml_string)
+        data = YAML.safe_load(yaml_string)
+        new(
+          app_name: data["app_name"],
+          database: data.fetch("database", "sqlite3"),
+          selected_packs: data.fetch("selected_packs", []),
+          rails_args: data.fetch("rails_args", "")
+        )
+      end
+
+      def summary
+        packs_label = selected_packs.empty? ? "none" : selected_packs.join(", ")
+        "#{app_name} (#{database}) packs: #{packs_label}"
+      end
+    end
+  end
+end

data/lib/rails/metro/feature_pack.rb

@@ -0,0 +1,59 @@
+module Rails
+  module Metro
+    class FeaturePack
+      class << self
+        def pack_name(name = nil)
+          if name
+            @pack_name = name.to_s
+          else
+            @pack_name
+          end
+        end
+
+        def description(desc = nil)
+          if desc
+            @description = desc
+          else
+            @description || ""
+          end
+        end
+
+        def category(cat = nil)
+          if cat
+            @category = cat.to_s
+          else
+            @category || "general"
+          end
+        end
+
+        def depends_on(*pack_names)
+          if pack_names.any?
+            @dependencies = pack_names.map(&:to_s)
+          else
+            @dependencies || []
+          end
+        end
+
+        def conflicts_with(*pack_names)
+          if pack_names.any?
+            @conflicts = pack_names.map(&:to_s)
+          else
+            @conflicts || []
+          end
+        end
+      end
+
+      def gems
+        []
+      end
+
+      def template_lines
+        []
+      end
+
+      def post_install_notes
+        []
+      end
+    end
+  end
+end