rails_engine_toolkit 0.6.3

data/spec/rails_engine_toolkit/new_engine_integration_spec.rb

@@ -0,0 +1,59 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+RSpec.describe RailsEngineToolkit::Actions::NewEngine do
+  def config_yaml
+    <<~YAML
+      project:
+        name: "Transport System"
+        slug: "transport_system"
+        url: "https://example.test/repo"
+      author:
+        name: "Juan"
+        email: "juan@example.com"
+      defaults:
+        database: "postgresql"
+        api_only: true
+        mount_routes: true
+        create_ddd_structure: true
+      metadata:
+        license: "MIT"
+        ruby_version: ">= 3.2"
+        rails_version: ">= 8.1.2"
+    YAML
+  end
+
+  it 'inserts the mount line only once and creates DDD folders' do
+    in_tmpdir do |dir|
+      write(dir.join('Gemfile'), "source \"https://rubygems.org\"\n")
+      write(dir.join('config/routes.rb'), "Rails.application.routes.draw do\nend\n")
+      write(dir.join('config/engine_toolkit.yml'), config_yaml)
+
+      input = StringIO.new("\n")
+      output = StringIO.new
+      action = described_class.new(['auth'], stdin: input, stdout: output, stderr: StringIO.new, root: dir)
+
+      allow(RailsEngineToolkit::Utils).to receive(:safe_system) do |*args, **_kwargs|
+        if args[0..4] == %w[bundle exec rails plugin new]
+          FileUtils.mkdir_p(dir.join('engines/auth'))
+          FileUtils.mkdir_p(dir.join('engines/auth/lib/auth'))
+          write(dir.join('engines/auth/Gemfile'), '')
+          write(dir.join('engines/auth/auth.gemspec'), '')
+          write(dir.join('engines/auth/MIT-LICENSE'), '')
+          write(dir.join('engines/auth/README.md'), '')
+        end
+        true
+      end
+
+      action.call
+
+      routes = dir.join('config/routes.rb').read
+      expect(routes.scan('mount Auth::Engine, at: "/auth"').size).to eq(1)
+
+      expect(dir.join('engines/auth/app/use_cases')).to exist
+      expect(dir.join('engines/auth/app/services')).to exist
+      expect(dir.join('engines/auth/app/policies')).to exist
+    end
+  end
+end

data/spec/rails_engine_toolkit/new_engine_spec.rb

@@ -0,0 +1,54 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+RSpec.describe RailsEngineToolkit::Actions::NewEngine do
+  it 'asks to remove broken engine references before creating a new engine' do
+    in_tmpdir do |dir|
+      write(dir.join('Gemfile'), <<~RUBY)
+        source "https://rubygems.org"
+        gem "missing", path: "engines/missing"
+      RUBY
+      write(dir.join('config/routes.rb'), "Rails.application.routes.draw do\nend\n")
+      write(dir.join('config/engine_toolkit.yml'), <<~YAML)
+        project:
+          name: "Transport System"
+          slug: "transport_system"
+          url: "https://example.test/repo"
+        author:
+          name: "Juan"
+          email: "juan@example.com"
+        defaults:
+          database: "postgresql"
+          api_only: true
+          mount_routes: true
+          create_ddd_structure: true
+        metadata:
+          license: "MIT"
+          ruby_version: ">= 3.2"
+          rails_version: ">= 8.1.2"
+      YAML
+
+      input = StringIO.new("y\n\n")
+      output = StringIO.new
+      action = described_class.new(['auth'], stdin: input, stdout: output, stderr: StringIO.new, root: dir)
+
+      allow(RailsEngineToolkit::Utils).to receive(:safe_system) do |*args, **_kwargs|
+        if args[0..4] == %w[bundle exec rails plugin new]
+          FileUtils.mkdir_p(dir.join('engines/auth/lib/auth'))
+          FileUtils.mkdir_p(dir.join('engines/auth'))
+          write(dir.join('engines/auth/Gemfile'), '')
+          write(dir.join('engines/auth/auth.gemspec'), '')
+          write(dir.join('engines/auth/MIT-LICENSE'), '')
+          write(dir.join('engines/auth/README.md'), '')
+        end
+        true
+      end
+
+      action.call
+
+      expect(dir.join('Gemfile').read).not_to include('path: "engines/missing"')
+      expect(dir.join('config/routes.rb').read).to include('mount Auth::Engine, at: "/auth"')
+    end
+  end
+end

data/spec/rails_engine_toolkit/project_spec.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+RSpec.describe RailsEngineToolkit::Project do
+  it 'detects broken engine references from Gemfile' do
+    in_tmpdir do |dir|
+      write(dir.join('Gemfile'), <<~RUBY)
+        source "https://rubygems.org"
+        gem "auth", path: "engines/auth"
+        gem "billing", path: "engines/billing"
+      RUBY
+      FileUtils.mkdir_p(dir.join('engines/auth'))
+
+      project = described_class.new(dir)
+      expect(project.broken_engine_references).to eq(['billing'])
+    end
+  end
+end

data/spec/rails_engine_toolkit/remove_engine_integration_spec.rb

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+RSpec.describe RailsEngineToolkit::Actions::RemoveEngine do
+  def build_project(dir, routes_content:)
+    write(dir.join('Gemfile'), <<~RUBY)
+      source "https://rubygems.org"
+      gem "auth", path: "engines/auth"
+    RUBY
+    write(dir.join('config/routes.rb'), routes_content)
+    write(dir.join('engines/auth/README.md'), "# Auth\n")
+  end
+
+  it 'removes all supported mount variants when present in multiple lines' do
+    in_tmpdir do |dir|
+      build_project(dir, routes_content: <<~RUBY)
+        Rails.application.routes.draw do
+          mount Auth::Engine, at: "/auth"
+          mount(Auth::Engine, at: "/auth")
+          mount Auth::Engine => "/auth"
+        end
+      RUBY
+
+      input = StringIO.new("auth\n")
+      output = StringIO.new
+      action = described_class.new(['auth'], stdin: input, stdout: output, stderr: StringIO.new, root: dir)
+      allow(RailsEngineToolkit::Utils).to receive(:safe_system).and_return(true)
+
+      action.call
+
+      routes = dir.join('config/routes.rb').read
+      expect(routes).not_to include('mount Auth::Engine, at: "/auth"')
+      expect(routes).not_to include('mount(Auth::Engine, at: "/auth")')
+      expect(routes).not_to include('mount Auth::Engine => "/auth"')
+      expect(dir.join('engines/auth')).not_to exist
+      expect(dir.join('Gemfile').read).not_to include('path: "engines/auth"')
+    end
+  end
+end

data/spec/rails_engine_toolkit/remove_engine_spec.rb

@@ -0,0 +1,72 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+RSpec.describe RailsEngineToolkit::Actions::RemoveEngine do
+  def build_action(dir, routes_content:)
+    write(dir.join('Gemfile'), <<~RUBY)
+      source "https://rubygems.org"
+      gem "auth", path: "engines/auth"
+    RUBY
+    write(dir.join('config/routes.rb'), routes_content)
+    write(dir.join('engines/auth/README.md'), "# Auth\n")
+
+    described_class.new(
+      ['auth'],
+      stdin: StringIO.new("auth\n"),
+      stdout: StringIO.new,
+      stderr: StringIO.new,
+      root: dir
+    )
+  end
+
+  it 'removes standard mount lines' do
+    in_tmpdir do |dir|
+      routes_content = <<~RUBY
+        Rails.application.routes.draw do
+          mount Auth::Engine, at: "/auth"
+        end
+      RUBY
+      action = build_action(dir, routes_content: routes_content)
+      allow(RailsEngineToolkit::Utils).to receive(:safe_system)
+
+      action.call
+
+      expect(dir.join('config/routes.rb').read).not_to include('mount Auth::Engine, at: "/auth"')
+      expect(dir.join('Gemfile').read).not_to include('path: "engines/auth"')
+      expect(dir.join('engines/auth')).not_to exist
+    end
+  end
+
+  it 'removes hash rocket mount lines' do
+    in_tmpdir do |dir|
+      routes_content = <<~RUBY
+        Rails.application.routes.draw do
+          mount Auth::Engine => "/auth"
+        end
+      RUBY
+      action = build_action(dir, routes_content: routes_content)
+      allow(RailsEngineToolkit::Utils).to receive(:safe_system)
+
+      action.call
+
+      expect(dir.join('config/routes.rb').read).not_to include('mount Auth::Engine => "/auth"')
+    end
+  end
+
+  it 'removes parenthesized mount lines' do
+    in_tmpdir do |dir|
+      routes_content = <<~RUBY
+        Rails.application.routes.draw do
+          mount(Auth::Engine, at: "/auth")
+        end
+      RUBY
+      action = build_action(dir, routes_content: routes_content)
+      allow(RailsEngineToolkit::Utils).to receive(:safe_system)
+
+      action.call
+
+      expect(dir.join('config/routes.rb').read).not_to include('mount(Auth::Engine, at: "/auth")')
+    end
+  end
+end

data/spec/rails_engine_toolkit/route_inspector_spec.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+RSpec.describe RailsEngineToolkit::RouteInspector do
+  it 'detects supported mount variants' do
+    content = <<~RUBY
+      Rails.application.routes.draw do
+        mount Auth::Engine, at: "/auth"
+        mount(Auth::Engine, at: "/auth")
+        mount Auth::Engine => "/auth"
+      end
+    RUBY
+
+    inspector = described_class.new(content)
+    expect(inspector.syntax_valid?).to be(true)
+    expect(inspector.mounts.size).to eq(3)
+    expect(inspector.includes_mount?('Auth', '/auth')).to be(true)
+  end
+end

data/spec/rails_engine_toolkit/routes_rewriter_spec.rb

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+RSpec.describe RailsEngineToolkit::RoutesRewriter do
+  it 'adds a mount only once' do
+    in_tmpdir do |dir|
+      path = dir.join('config/routes.rb')
+      write(path, "Rails.application.routes.draw do\nend\n")
+
+      rewriter = described_class.new(path)
+      expect(rewriter.add_mount(engine_class: 'Auth', mount_path: '/auth')).to be(true)
+      expect(rewriter.add_mount(engine_class: 'Auth', mount_path: '/auth')).to be(false)
+
+      content = path.read
+      expect(content.scan('mount Auth::Engine, at: "/auth"').size).to eq(1)
+    end
+  end
+
+  it 'removes all supported mount variants for one engine path' do
+    in_tmpdir do |dir|
+      path = dir.join('config/routes.rb')
+      write(path, <<~RUBY)
+        Rails.application.routes.draw do
+          mount Auth::Engine, at: "/auth"
+          mount(Auth::Engine, at: "/auth")
+          mount Auth::Engine => "/auth"
+        end
+      RUBY
+
+      rewriter = described_class.new(path)
+      expect(rewriter.remove_mount(engine_class: 'Auth', mount_path: '/auth')).to be(true)
+      expect(path.read).not_to include('mount Auth::Engine')
+    end
+  end
+end

data/spec/rails_engine_toolkit/uninstall_engine_migrations_spec.rb

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+RSpec.describe RailsEngineToolkit::Actions::UninstallEngineMigrations do
+  it 'removes copied root migration files matching one engine' do
+    in_tmpdir do |dir|
+      write(dir.join('Gemfile'), "source \"https://rubygems.org\"\n")
+      write(dir.join('engines/auth/db/migrate/20260101000000_create_auth_credentials.rb'),
+            'class CreateAuthCredentials; end')
+      root_file = dir.join('db/migrate/20260102000000_create_auth_credentials.rb')
+      write(root_file, 'class CreateAuthCredentials; end')
+
+      input = StringIO.new("auth\n")
+      out = StringIO.new
+      described_class.new(['auth'], stdin: input, stdout: out, stderr: StringIO.new, root: dir).call
+
+      expect(root_file).not_to exist
+      expect(out.string).to include('does NOT rollback the database automatically')
+    end
+  end
+
+  it 'does nothing when there are no installed root migrations for that engine' do
+    in_tmpdir do |dir|
+      write(dir.join('Gemfile'), "source \"https://rubygems.org\"\n")
+      write(dir.join('engines/auth/db/migrate/20260101000000_create_auth_credentials.rb'),
+            'class CreateAuthCredentials; end')
+
+      out = StringIO.new
+      described_class.new(['auth'], stdin: StringIO.new, stdout: out, stderr: StringIO.new, root: dir).call
+
+      expect(out.string).to include('No installed root migrations found')
+    end
+  end
+end

data/spec/rails_engine_toolkit/update_engine_readme_spec.rb

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+RSpec.describe RailsEngineToolkit::Actions::UpdateEngineReadme do
+  it 'updates owned tables using migrations only' do
+    in_tmpdir do |dir|
+      write(dir.join('Gemfile'), "source \"https://rubygems.org\"\n")
+      write(dir.join('engines/auth/README.md'), <<~MD)
+        # Auth
+
+        ## Owned tables
+        - None defined yet.
+
+        ## Public endpoints
+        - None defined yet.
+      MD
+      write(dir.join('engines/auth/db/migrate/20260101000000_create_auth_credentials.rb'), <<~RB)
+        class CreateAuthCredentials < ActiveRecord::Migration[8.1]
+          def change
+            create_table :auth_credentials do |t|
+            end
+          end
+        end
+      RB
+
+      described_class.new(['auth'], stdin: StringIO.new, stdout: StringIO.new, stderr: StringIO.new, root: dir).call
+
+      expect(dir.join('engines/auth/README.md').read).to include('- auth_credentials')
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+require 'tmpdir'
+require 'fileutils'
+require 'stringio'
+require 'yaml'
+
+require 'rails_engine_toolkit'
+
+RSpec.configure do |config|
+  config.order = :random
+  Kernel.srand config.seed
+end
+
+module SpecHelpers
+  def in_tmpdir
+    Dir.mktmpdir do |dir|
+      Dir.chdir(dir) { yield Pathname(dir) }
+    end
+  end
+
+  def write(path, content)
+    FileUtils.mkdir_p(File.dirname(path))
+    File.write(path, content)
+  end
+end
+
+RSpec.configure do |config|
+  config.include SpecHelpers
+end

data/test/fixtures/host_app/Gemfile

@@ -0,0 +1,5 @@
+source "https://rubygems.org"
+
+gem "rails", ">= 8.1.2"
+gem "sqlite3"
+gem "rails_engine_toolkit"

data/test/fixtures/host_app/config/application.rb

@@ -0,0 +1,11 @@
+require_relative "boot"
+
+require "rails/all"
+
+Bundler.require(*Rails.groups)
+
+module HostApp
+  class Application < Rails::Application
+    config.load_defaults 8.1
+  end
+end

data/test/fixtures/host_app/config/boot.rb

@@ -0,0 +1,3 @@
+ENV["BUNDLE_GEMFILE"] ||= File.expand_path("../Gemfile", __dir__)
+
+require "bundler/setup"

data/test/fixtures/host_app/config/environment.rb

@@ -0,0 +1,3 @@
+require_relative "application"
+
+Rails.application.initialize!

data/test/fixtures/host_app/config/routes.rb

@@ -0,0 +1,2 @@
+Rails.application.routes.draw do
+end

metadata

@@ -0,0 +1,140 @@
+--- !ruby/object:Gem::Specification
+name: rails_engine_toolkit
+version: !ruby/object:Gem::Version
+  version: 0.6.3
+platform: ruby
+authors:
+- Your Name
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2026-03-13 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: railties
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 8.1.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 8.1.0
+- !ruby/object:Gem::Dependency
+  name: thor
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.3'
+description: Creates and manages internal Rails engines with configurable conventions,
+  safe file mutations, parser-assisted route inspection, engine-specific migration
+  installation, and Rails install generators.
+email:
+- you@example.com
+executables:
+- engine-toolkit
+extensions: []
+extra_rdoc_files: []
+files:
+- ".github/workflows/ci.yml"
+- ".github/workflows/release.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- docs/ARCHITECTURE.md
+- docs/COMPATIBILITY.md
+- docs/CONTRIBUTING.md
+- docs/END_TO_END.md
+- docs/PUBLISHING.md
+- docs/RELEASE.md
+- docs/RELEASE_CHECKLIST.md
+- docs/TESTING.md
+- exe/engine-toolkit
+- lib/rails_engine_toolkit.rb
+- lib/rails_engine_toolkit/actions/delete_engine_migration.rb
+- lib/rails_engine_toolkit/actions/init.rb
+- lib/rails_engine_toolkit/actions/install_engine_migrations.rb
+- lib/rails_engine_toolkit/actions/new_engine.rb
+- lib/rails_engine_toolkit/actions/new_engine_migration.rb
+- lib/rails_engine_toolkit/actions/new_engine_model.rb
+- lib/rails_engine_toolkit/actions/remove_engine.rb
+- lib/rails_engine_toolkit/actions/uninstall_engine_migrations.rb
+- lib/rails_engine_toolkit/actions/update_engine_readme.rb
+- lib/rails_engine_toolkit/cli.rb
+- lib/rails_engine_toolkit/config.rb
+- lib/rails_engine_toolkit/errors.rb
+- lib/rails_engine_toolkit/file_editor.rb
+- lib/rails_engine_toolkit/generators/install/install_generator.rb
+- lib/rails_engine_toolkit/project.rb
+- lib/rails_engine_toolkit/railtie.rb
+- lib/rails_engine_toolkit/route_inspector.rb
+- lib/rails_engine_toolkit/routes_rewriter.rb
+- lib/rails_engine_toolkit/templates.rb
+- lib/rails_engine_toolkit/templates/engine_readme.erb
+- lib/rails_engine_toolkit/templates/engine_toolkit_yml.erb
+- lib/rails_engine_toolkit/templates/gemspec.erb
+- lib/rails_engine_toolkit/templates/license.erb
+- lib/rails_engine_toolkit/utils.rb
+- lib/rails_engine_toolkit/version.rb
+- rails_engine_toolkit.gemspec
+- spec/rails_engine_toolkit/cli_spec.rb
+- spec/rails_engine_toolkit/config_spec.rb
+- spec/rails_engine_toolkit/file_editor_spec.rb
+- spec/rails_engine_toolkit/install_engine_migrations_spec.rb
+- spec/rails_engine_toolkit/install_generator_spec.rb
+- spec/rails_engine_toolkit/new_engine_integration_spec.rb
+- spec/rails_engine_toolkit/new_engine_spec.rb
+- spec/rails_engine_toolkit/project_spec.rb
+- spec/rails_engine_toolkit/remove_engine_integration_spec.rb
+- spec/rails_engine_toolkit/remove_engine_spec.rb
+- spec/rails_engine_toolkit/route_inspector_spec.rb
+- spec/rails_engine_toolkit/routes_rewriter_spec.rb
+- spec/rails_engine_toolkit/uninstall_engine_migrations_spec.rb
+- spec/rails_engine_toolkit/update_engine_readme_spec.rb
+- spec/spec_helper.rb
+- test/fixtures/host_app/Gemfile
+- test/fixtures/host_app/config/application.rb
+- test/fixtures/host_app/config/boot.rb
+- test/fixtures/host_app/config/environment.rb
+- test/fixtures/host_app/config/routes.rb
+homepage: https://github.com/your-org/rails_engine_toolkit
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/your-org/rails_engine_toolkit
+  source_code_uri: https://github.com/your-org/rails_engine_toolkit
+  changelog_uri: https://github.com/your-org/rails_engine_toolkit/releases
+  rubygems_mfa_required: 'true'
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '3.2'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.4.1
+signing_key:
+specification_version: 4
+summary: Reusable CLI and generators for Rails engines
+test_files: []