rails-ai-context 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 994a7f4531e3c387086796826815f5b4489107ec50b47d8bd86e46fa208d59ee
-  data.tar.gz: 11dd7dae7425c70d1bff80a43a183b66b4a0863fffa72d2d227093f5d1928b30
+  metadata.gz: f762c8f111cca6b60293f4d3eb26ef68aeb9e1d0c97048b46dcf221ebf7d6069
+  data.tar.gz: 01b9e656715c47aa0a3e67cfb75fb6ac1a5fd7d6444b4ac96837c6202a093487
 SHA512:
-  metadata.gz: 733527414a221eb42d66510eeeeead2d46ec69482998bd79c2b913c87cf34b37ec23160b0a44b22a07689aae7ae1f3bef37094e836c2a2a18b992d7d3620f294
-  data.tar.gz: 1c4dfeb48b4a521631ae339de511dfe62ce2119c19fc8b50bfcee6fa3e8112632652f053e6040b4aa46bbf7ef47db352a90e41ff8dcc882631cb308c1638fa34
+  metadata.gz: a5daa689b56aeee3225f0bfa983580adeabbc195c2184b669f5a3689d1cd2760d115afefcc2c925e14eefafea2b28729893b260f141acd00f5e89a6bcb4fc665
+  data.tar.gz: 7fba10086525e15044867dc4c1b5c5a44fd8eaf5f66c08ffbbd6468dfb1f2831d5b03231ec3e0ca02e2fec2a30a4558cd5567262642edf92c750a4bd8286fdc4

data/.ruby-version

@@ -0,0 +1 @@
+3.4.9

data/CHANGELOG.md

@@ -5,7 +5,21 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
-## [0.1.0] - Unreleased
+## [0.2.0] - 2026-03-18
+
+### Added
+
+- Named rake tasks (`ai:context:claude`, `ai:context:cursor`, etc.) that work without quoting in zsh
+- AI assistant summary table printed after `ai:context` and `ai:inspect`
+- `ENV["FORMAT"]` fallback for `ai:context_for` task
+- Format validation in `ContextFileSerializer` — unknown formats now raise `ArgumentError` with valid options
+
+### Fixed
+
+- `rails ai:context_for[claude]` failing in zsh due to bracket glob interpretation
+- Double introspection in `ai:context` and `ai:context_for` tasks (removed unused `RailsAiContext.introspect` calls)
+
+## [0.1.0] - 2026-03-18
 
 ### Added
 

data/CONTRIBUTING.md

@@ -0,0 +1,76 @@
+# Contributing to rails-ai-context
+
+Thanks for your interest in contributing! This guide covers everything you need to get started.
+
+## Development Setup
+
+```bash
+git clone https://github.com/crisnahine/rails-ai-context.git
+cd rails-ai-context
+bundle install
+bundle exec rspec
+bundle exec rubocop --parallel
+```
+
+The test suite uses [Combustion](https://github.com/pat/combustion) to boot a minimal Rails app in `spec/internal/`. No external database required — tests run against an in-memory SQLite database.
+
+## Project Structure
+
+```
+lib/rails_ai_context/
+├── introspectors/     # One class per data source (schema, models, routes, etc.)
+├── tools/             # MCP tool definitions (one per introspector)
+├── serializers/       # Output formatters (markdown, JSON, context files)
+├── server.rb          # MCP server setup (stdio + HTTP)
+├── engine.rb          # Rails Engine for auto-integration
+└── configuration.rb   # User-facing config options
+```
+
+## Adding a New Introspector
+
+1. Create `lib/rails_ai_context/introspectors/your_introspector.rb`
+2. Implement `#initialize(app)` and `#call` → returns a Hash (never raises)
+3. Register it in `lib/rails_ai_context/introspector.rb` (the `INTROSPECTOR_MAP`)
+4. Add the key to `Configuration#introspectors` default list
+5. Write specs in `spec/lib/rails_ai_context/your_introspector_spec.rb`
+
+## Adding a New MCP Tool
+
+1. Create `lib/rails_ai_context/tools/your_tool.rb` inheriting from `BaseTool`
+2. Define `tool_name`, `description`, `input_schema`, and `annotations`
+3. Implement `def self.call(...)` returning `text_response(string)`
+4. Register in `Server::TOOLS`
+5. Add `require_relative` in `lib/rails_ai_context.rb`
+6. Write specs in `spec/lib/rails_ai_context/tools/your_tool_spec.rb`
+
+## Code Style
+
+- Follow `rubocop-rails-omakase` style (run `bundle exec rubocop`)
+- Ruby 3.2+ features welcome (pattern matching, etc.)
+- Every introspector must return a Hash and never raise — wrap errors in `{ error: msg }`
+- MCP tools return `MCP::Tool::Response` objects
+- All tools must be prefixed with `rails_` and annotated as read-only
+
+## Running Tests
+
+```bash
+bundle exec rspec              # Full test suite
+bundle exec rspec spec/lib/    # Just lib specs
+bundle exec rubocop --parallel # Lint check
+```
+
+## Pull Request Process
+
+1. Fork the repo and create your branch from `main`
+2. Add tests for any new functionality
+3. Ensure `bundle exec rspec` and `bundle exec rubocop` pass
+4. Update CHANGELOG.md under an `## [Unreleased]` section
+5. Open a PR with a clear title and description
+
+## Reporting Bugs
+
+Open an issue at https://github.com/crisnahine/rails-ai-context/issues with:
+- Ruby and Rails versions
+- Gem version
+- Steps to reproduce
+- Expected vs actual behavior

data/README.md

@@ -150,16 +150,34 @@ end
 
 ---
 
+## Supported AI Assistants
+
+| AI Assistant | Context File | Command |
+|--------------|-------------|---------|
+| Claude Code | `CLAUDE.md` | `rails ai:context:claude` |
+| Cursor | `.cursorrules` | `rails ai:context:cursor` |
+| Windsurf | `.windsurfrules` | `rails ai:context:windsurf` |
+| GitHub Copilot | `.github/copilot-instructions.md` | `rails ai:context:copilot` |
+| JSON (generic) | `.ai-context.json` | `rails ai:context:json` |
+
+---
+
 ## Rake Tasks
 
 | Command | Description |
 |---------|-------------|
 | `rails ai:context` | Generate all context files (CLAUDE.md, .cursorrules, etc.) |
-| `rails ai:context_for[claude]` | Generate for a specific format |
+| `rails ai:context:claude` | Generate CLAUDE.md only |
+| `rails ai:context:cursor` | Generate .cursorrules only |
+| `rails ai:context:windsurf` | Generate .windsurfrules only |
+| `rails ai:context:copilot` | Generate .github/copilot-instructions.md only |
+| `rails ai:context:json` | Generate .ai-context.json only |
 | `rails ai:serve` | Start MCP server (stdio, for Claude Code) |
 | `rails ai:serve_http` | Start MCP server (HTTP, for remote clients) |
 | `rails ai:inspect` | Print introspection summary to stdout |
 
+> **zsh users:** The bracket syntax `rails ai:context_for[claude]` requires quoting in zsh (`rails 'ai:context_for[claude]'`). The named tasks above (`rails ai:context:claude`) work without quoting in any shell.
+
 ---
 
 ## Works Without a Database

data/lib/generators/rails_ai_context/install/install_generator.rb

@@ -71,9 +71,17 @@ module RailsAiContext
         say "=" * 50, :cyan
         say ""
         say "Quick start:", :yellow
-        say "  rails ai:context     # Regenerate context files"
-        say "  rails ai:serve       # Start MCP server (stdio)"
-        say "  rails ai:inspect     # Print introspection summary"
+        say "  rails ai:context         # Generate all context files"
+        say "  rails ai:context:claude   # Generate CLAUDE.md only"
+        say "  rails ai:context:cursor   # Generate .cursorrules only"
+        say "  rails ai:serve           # Start MCP server (stdio)"
+        say "  rails ai:inspect         # Print introspection summary"
+        say ""
+        say "Supported AI assistants:", :yellow
+        say "  Claude Code        → CLAUDE.md                        (rails ai:context:claude)"
+        say "  Cursor             → .cursorrules                     (rails ai:context:cursor)"
+        say "  Windsurf           → .windsurfrules                   (rails ai:context:windsurf)"
+        say "  GitHub Copilot     → .github/copilot-instructions.md  (rails ai:context:copilot)"
         say ""
         say "For Claude Code, add to your claude_desktop_config.json:", :yellow
         say '  { "mcpServers": { "rails": { "command": "rails", "args": ["ai:serve"], "cwd": "/path/to/your/app" } } }'

data/lib/rails_ai_context/serializers/context_file_serializer.rb

@@ -29,7 +29,10 @@ module RailsAiContext
 
         formats.each do |fmt|
           filename = FORMAT_MAP[fmt]
-          next unless filename
+          unless filename
+            valid = FORMAT_MAP.keys.map(&:to_s).join(", ")
+            raise ArgumentError, "Unknown format: #{fmt}. Valid formats: #{valid}"
+          end
 
           filepath = File.join(output_dir, filename)
 

data/lib/rails_ai_context/tasks/rails_ai_context.rake

@@ -1,12 +1,21 @@
 # frozen_string_literal: true
 
+ASSISTANT_TABLE = <<~TABLE
+  AI Assistant       Context File                          Command
+  --                 --                                    --
+  Claude Code        CLAUDE.md                             rails ai:context:claude
+  Cursor             .cursorrules                          rails ai:context:cursor
+  Windsurf           .windsurfrules                        rails ai:context:windsurf
+  GitHub Copilot     .github/copilot-instructions.md       rails ai:context:copilot
+  JSON (generic)     .ai-context.json                      rails ai:context:json
+TABLE
+
 namespace :ai do
   desc "Generate AI context files (CLAUDE.md, .cursorrules, .windsurfrules, .github/copilot-instructions.md)"
   task context: :environment do
     require "rails_ai_context"
 
     puts "🔍 Introspecting #{Rails.application.class.module_parent_name}..."
-    context = RailsAiContext.introspect
 
     puts "📝 Writing context files..."
     files = RailsAiContext.generate_context(format: :all)
@@ -15,15 +24,16 @@ namespace :ai do
     puts ""
     puts "Done! Your AI assistants now understand your Rails app."
     puts "Commit these files so your whole team benefits."
+    puts ""
+    puts ASSISTANT_TABLE
   end
 
   desc "Generate AI context in a specific format (claude, cursor, windsurf, copilot, json)"
   task :context_for, [:format] => :environment do |_t, args|
     require "rails_ai_context"
 
-    format = (args[:format] || "claude").to_sym
+    format = (args[:format] || ENV["FORMAT"] || "claude").to_sym
     puts "🔍 Introspecting #{Rails.application.class.module_parent_name}..."
-    context = RailsAiContext.introspect
 
     puts "📝 Writing #{format} context file..."
     files = RailsAiContext.generate_context(format: format)
@@ -31,6 +41,24 @@ namespace :ai do
     files.each { |f| puts "  ✅ #{f}" }
   end
 
+  namespace :context do
+    { claude: "CLAUDE.md", cursor: ".cursorrules", windsurf: ".windsurfrules",
+      copilot: ".github/copilot-instructions.md", json: ".ai-context.json" }.each do |fmt, file|
+      desc "Generate #{file} context file"
+      task fmt => :environment do
+        require "rails_ai_context"
+
+        puts "🔍 Introspecting #{Rails.application.class.module_parent_name}..."
+        puts "📝 Writing #{file}..."
+        files = RailsAiContext.generate_context(format: fmt)
+
+        files.each { |f| puts "  ✅ #{f}" }
+        puts ""
+        puts "Tip: Run `rails ai:context` to generate all formats at once."
+      end
+    end
+  end
+
   desc "Start the MCP server (stdio transport, for Claude Code / Cursor)"
   task serve: :environment do
     require "rails_ai_context"
@@ -83,6 +111,8 @@ namespace :ai do
       puts "🏛️  Architecture: #{arch.join(', ')}" if arch.any?
     end
 
+    puts ""
+    puts ASSISTANT_TABLE
     puts ""
     puts "Run `rails ai:context` to generate context files."
   end

data/lib/rails_ai_context/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module RailsAiContext
-  VERSION = "0.1.0"
+  VERSION = "0.2.0"
 end

data/rails-ai-context.gemspec

@@ -8,7 +8,7 @@ Gem::Specification.new do |spec|
   spec.authors       = ["crisnahine"]
   spec.email         = ["crisjosephnahine@gmail.com"]
 
-  spec.summary       = "Turn any Rails app into an AI-ready codebase — one gem install."
+  spec.summary       = "Auto-expose Rails app structure to AI via MCP (Model Context Protocol) — zero config."
   spec.description   = <<~DESC
     rails-ai-context automatically introspects your Rails application and exposes
     models, routes, schema, jobs, mailers, and conventions through the Model Context
@@ -21,11 +21,22 @@ Gem::Specification.new do |spec|
 
   spec.required_ruby_version = ">= 3.2.0"
 
-  spec.metadata["homepage_uri"]    = spec.homepage
-  spec.metadata["source_code_uri"] = spec.homepage
-  spec.metadata["changelog_uri"]   = "#{spec.homepage}/blob/main/CHANGELOG.md"
+  spec.metadata["homepage_uri"]      = spec.homepage
+  spec.metadata["source_code_uri"]   = spec.homepage
+  spec.metadata["changelog_uri"]     = "#{spec.homepage}/blob/main/CHANGELOG.md"
+  spec.metadata["documentation_uri"] = "#{spec.homepage}#readme"
+  spec.metadata["bug_tracker_uri"]   = "#{spec.homepage}/issues"
+  spec.metadata["funding_uri"]       = "https://github.com/sponsors/crisnahine"
   spec.metadata["rubygems_mfa_required"] = "true"
 
+  spec.post_install_message = <<~MSG
+    rails-ai-context installed! Quick start:
+      rails generate rails_ai_context:install
+      rails ai:context         # generate all context files
+      rails ai:context:claude  # generate CLAUDE.md only (zsh-friendly)
+      rails ai:serve           # start MCP server for Claude Code / Cursor
+  MSG
+
   spec.files = Dir.chdir(__dir__) do
     `git ls-files -z`.split("\x0").reject do |f|
       (File.expand_path(f) == __FILE__) ||

metadata

@@ -1,14 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: rails-ai-context
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - crisnahine
-autorequire:
 bindir: exe
 cert_chain: []
-date: 2026-03-18 00:00:00.000000000 Z
+date: 1980-01-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: mcp
@@ -162,7 +161,9 @@ extra_rdoc_files: []
 files:
 - ".rspec"
 - ".rubocop.yml"
+- ".ruby-version"
 - CHANGELOG.md
+- CONTRIBUTING.md
 - LICENSE
 - README.md
 - Rakefile
@@ -200,8 +201,16 @@ metadata:
   homepage_uri: https://github.com/crisnahine/rails-ai-context
   source_code_uri: https://github.com/crisnahine/rails-ai-context
   changelog_uri: https://github.com/crisnahine/rails-ai-context/blob/main/CHANGELOG.md
+  documentation_uri: https://github.com/crisnahine/rails-ai-context#readme
+  bug_tracker_uri: https://github.com/crisnahine/rails-ai-context/issues
+  funding_uri: https://github.com/sponsors/crisnahine
   rubygems_mfa_required: 'true'
-post_install_message:
+post_install_message: |
+  rails-ai-context installed! Quick start:
+    rails generate rails_ai_context:install
+    rails ai:context         # generate all context files
+    rails ai:context:claude  # generate CLAUDE.md only (zsh-friendly)
+    rails ai:serve           # start MCP server for Claude Code / Cursor
 rdoc_options: []
 require_paths:
 - lib
@@ -216,8 +225,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.7
-signing_key:
+rubygems_version: 3.6.9
 specification_version: 4
-summary: Turn any Rails app into an AI-ready codebase — one gem install.
+summary: Auto-expose Rails app structure to AI via MCP (Model Context Protocol) —
+  zero config.
 test_files: []