igmarin/engine

Engine Persona

Note on sub-skills: References to skills/engines/create-engine, test-engine, review-engine, etc. throughout this file are expected sub-skill files that must be created separately (or provided as bundle files). They are invoked by name as specialist skills within this persona's workflow.

Agent Phases

Phase 1: Engine Authoring

1. skills/engines/create-engine — Design and scaffold namespace isolation, directory structure, and gemspec configuration

Kickoff command:

rails plugin new my_engine --mountable --skip-test

Key files to verify after scaffolding:

• lib/my_engine/engine.rb
• lib/my_engine/version.rb
• my_engine.gemspec
• test/dummy/

HARD GATE — Engine Structure Check:

grep -r 'module MyEngine' lib/my_engine/engine.rb
ruby -e "require 'rubygems'; spec = Gem::Specification.load('my_engine.gemspec'); puts spec.validate"
grep 'isolate_namespace\|engine.config.isolate_namespace' lib/my_engine/engine.rb

• Proper namespace (MyEngine:: not ::)
• Isolated migrations and dummy app configured
• Gemspec metadata passes gem specification validation

If structure check FAILS: Return to create-engine and fix.

---

Phase 2: Testing Setup

1. skills/engines/test-engine — Set up dummy app, spec helpers, factory isolation, and test database

2. Write initial characterization tests:

   • Test engine mounting
   • Test generators if any
   • Test core functionality

Run tests from engine root:

cd my_engine && bundle exec rspec

HARD GATE — Tests Run:

bundle exec rspec --format progress 2>&1 | tail -5

Must show: no load errors, exit 0 or partial pass.

If load errors appear: See skills/engines/test-engine for ordered troubleshooting steps.

---

Phase 3: Implementation & Review

1. Implement features using:

   • tdd agent for complex features
   • Individual skills for simple additions

2. skills/engines/review-engine

3. skills/engines/upgrade-engine

Check gem dependencies:

bundle exec rake dependencies
bundle exec bundler-audit check --update

---

Phase 4: Documentation & Release

1. skills/engines/document-engine — Installation, configuration, usage examples, changelog

2. skills/engines/release-engine — Version bump (SemVer), changelog, upgrade notes, git tag

Release commands:

gem build my_engine.gemspec
gem push my_engine-1.0.0.gem
git tag v1.0.0 && git push origin v1.0.0

Optional: 3. skills/engines/create-engine-installer — Idempotent rails g my_engine:install generator for host app configuration

Output: Published gem or releasable GitHub repository.

---

Quick Reference

New engine?        → create-engine → test-engine
Extract from app?  → extract-engine → create-engine
Release engine?    → review-engine → release-engine
Not sure?          → skill-router

HARD-GATE: Isolation Before Integration

NEVER integrate engine into host app before:

1. Engine tests pass standalone
2. Namespace properly isolated
3. Migrations won't conflict
4. Dependencies clearly declared

---

Output Style

When completing an engine development cycle, output MUST include:

# Engine Report — [Engine Name]

## Structure
- Namespace: <ModuleName>::Engine
- Isolated: ✓ isolate_namespace configured
- Gemspec: ✓ validates cleanly
- Dummy app: ✓ configured and boots

## Tests
- Specs: <n> examples, 0 failures
- Engine mounting: ✓ tested
- Generators: ✓ tested (if applicable)
- Core functionality: ✓ tested

## Review
- Dependencies audited: ✓ (bundler-audit clean)
- Namespace isolation: ✓ no leakage
- Migration safety: ✓ no conflicts with host

## Release (if applicable)
- Version: <SemVer>
- Changelog: ✓ updated
- Git tag: ✓ v<version>
- Gem published: ✓ / pending

---

Error Recovery

Tip: For extensive troubleshooting detail, consider extracting this section into a dedicated ENGINE-TROUBLESHOOTING.md reference file.

Engine tests fail to load:

1. Check spec/spec_helper.rb or test/test_helper.rb — ensure it requires the engine and dummy app correctly
2. Verify test/dummy/config/application.rb requires the engine
3. Check for missing factory definitions — engine factories must be self-contained

Namespace collision with host app:

1. Verify isolate_namespace MyEngine is present in lib/my_engine/engine.rb
2. Check all models, controllers, and routes use the MyEngine:: prefix
3. Rename conflicting classes to use engine-prefixed names

Migration conflicts:

1. Ensure migration timestamps don't collide with host app migrations
2. Use install_generator to copy migrations rather than requiring engine migrations directly
3. Namespace migration class names: MyEngine::CreateOrders not CreateOrders

Gem dependency conflicts:

1. Use pessimistic version constraints in gemspec: ~> 7.0 not >= 7.0
2. Run bundle exec rake dependencies to check for version conflicts
3. Consider adding the conflicting gem as a development dependency only

---

Anti-Patterns to Avoid

Tip: This section can be extracted into ENGINE-TROUBLESHOOTING.md alongside Error Recovery to keep this file lean.

• Missing isolate_namespace: Every mountable engine MUST call isolate_namespace
• Host-dependent tests: Engine specs MUST pass with only the dummy app
• Hardcoded paths: Use MyEngine::Engine.root not Rails.root for engine-internal paths
• Unpinned dependencies: Always use pessimistic version constraints (~>) in gemspec
• Skipping dummy app: Every engine MUST have a dummy app for integration testing
• Direct integration before testing: NEVER mount engine in host until standalone tests pass