claude-on-rails 0.1.3 → 0.2.0

data/SETUP.md

@@ -0,0 +1,132 @@
+# ClaudeOnRails Setup Guide
+
+This guide covers the complete setup process for ClaudeOnRails, including the optional Rails MCP Server integration.
+
+## Quick Start
+
+```bash
+# Add to your Gemfile
+gem 'claude-on-rails', group: :development
+
+# Install the gem
+bundle install
+
+# Generate swarm configuration (includes optional MCP setup)
+rails generate claude_on_rails:swarm
+# Press Y when prompted to set up Rails MCP Server!
+
+# Start your AI development team
+claude-swarm
+```
+
+## Enhanced Setup with Rails MCP Server
+
+Rails MCP Server provides your AI agents with real-time access to Rails documentation. While optional, it significantly improves the quality and accuracy of generated code.
+
+### Automated Setup
+
+The easiest way is during initial generation - just press Y when prompted!
+
+If you skipped it or want to set it up later:
+
+```bash
+bundle exec rake claude_on_rails:setup_mcp
+```
+
+This interactive command will:
+- Install the Rails MCP Server gem globally
+- Configure your environment for enhanced documentation access
+
+### Manual Setup
+
+If you prefer manual installation:
+
+1. **Install Rails MCP Server**
+   ```bash
+   gem install rails-mcp-server
+   ```
+
+2. **Regenerate Swarm Configuration**
+   ```bash
+   rails generate claude_on_rails:swarm
+   ```
+
+### Checking MCP Status
+
+To verify your Rails MCP Server setup:
+
+```bash
+bundle exec rake claude_on_rails:mcp_status
+```
+
+This shows:
+- Installation status
+- Downloaded resources
+- Missing resources
+
+## Configuration Options
+
+### Generator Options
+
+```bash
+# Skip MCP Server integration
+rails generate claude_on_rails:swarm --no-mcp-server
+
+# API-only application
+rails generate claude_on_rails:swarm --api-only
+
+# Skip test agent
+rails generate claude_on_rails:swarm --skip-tests
+
+# Include GraphQL support
+rails generate claude_on_rails:swarm --graphql
+```
+
+## Troubleshooting
+
+### Rails MCP Server Not Found
+
+If the generator doesn't detect Rails MCP Server:
+
+1. Verify installation: `gem list rails-mcp-server`
+2. Check PATH: `which rails-mcp-server`
+3. Reinstall: `gem install rails-mcp-server`
+
+### Documentation Access
+
+The Rails MCP Server gem includes built-in documentation for:
+- Rails framework and guides
+- Turbo and Stimulus frameworks
+- Kamal deployment tool
+
+No separate download steps are required!
+
+### Multiple Rails Projects
+
+MCP Server resources are shared globally, benefiting all your Rails projects:
+
+```bash
+# Install once
+bundle exec rake claude_on_rails:setup_mcp
+
+# Use in any Rails project
+cd my-rails-app
+rails generate claude_on_rails:swarm
+```
+
+## Getting Help
+
+- Check status: `bundle exec rake claude_on_rails:mcp_status`
+- View logs: `claude-swarm.log`
+- Report issues: [GitHub Issues](https://github.com/obie/claude-on-rails/issues)
+- Documentation: [README.md](./README.md)
+
+## Next Steps
+
+After setup:
+
+1. Review generated `claude-swarm.yml`
+2. Customize agent prompts in `.claude-on-rails/prompts/`
+3. Start building with `claude-swarm`
+4. Describe features in natural language
+5. Let your AI team implement them!

data/lib/claude-on-rails.rb

@@ -0,0 +1,4 @@
+# frozen_string_literal: true
+
+# This file exists to match the gem name for Rails autoloading
+require 'claude_on_rails'

data/lib/claude_on_rails/configuration.rb

@@ -1,14 +1,16 @@
+# frozen_string_literal: true
+
 module ClaudeOnRails
   class Configuration
     attr_accessor :default_model, :vibe_mode, :session_directory, :log_directory
-    
+
     def initialize
-      @default_model = "opus"
+      @default_model = 'opus'
       @vibe_mode = true
-      @session_directory = ".claude-on-rails/sessions"
-      @log_directory = ".claude-on-rails/logs"
+      @session_directory = '.claude-on-rails/sessions'
+      @log_directory = '.claude-on-rails/logs'
     end
-    
+
     def to_h
       {
         default_model: default_model,
@@ -18,4 +20,4 @@ module ClaudeOnRails
       }
     end
   end
-end
+end

data/lib/claude_on_rails/mcp_installer.rb

@@ -0,0 +1,78 @@
+# frozen_string_literal: true
+
+module ClaudeOnRails
+  # Interactive installer for Rails MCP Server
+  class MCPInstaller
+    def run
+      puts "\e[32m🚀 ClaudeOnRails MCP Server Setup\e[0m"
+      puts "\e[32m#{'=' * 50}\e[0m"
+
+      if MCPSupport.available?
+        puts "\e[32m✓ Rails MCP Server is already installed\e[0m"
+      else
+        handle_installation
+      end
+
+      puts "\n\e[32m✅ Setup complete!\e[0m"
+      show_next_steps
+    end
+
+    private
+
+    def handle_installation
+      puts "\n\e[33mRails MCP Server provides your AI agents with:\e[0m"
+      puts "\e[36m  • Real-time Rails documentation access\e[0m"
+      puts "\e[36m  • Version-specific API references\e[0m"
+      puts "\e[36m  • Framework guides (Turbo, Stimulus, Kamal)\e[0m"
+      puts "\e[36m  • Best practices and examples\e[0m"
+
+      if prompt_yes_no?("\nWould you like to install Rails MCP Server? (Y/n)")
+        install_mcp_server
+      else
+        puts "\n\e[33mSkipping Rails MCP Server installation.\e[0m"
+        puts "\e[36mYou can run 'bundle exec rake claude_on_rails:setup_mcp' later to set it up.\e[0m"
+      end
+    end
+
+    def install_mcp_server
+      puts "\n\e[32mInstalling Rails MCP Server globally...\e[0m"
+
+      # Install without documentation to avoid RDoc conflicts
+      if system('gem install rails-mcp-server --no-document')
+        puts "\e[32m✓ Rails MCP Server installed successfully!\e[0m"
+      else
+        puts "\n\e[31m❌ Failed to install Rails MCP Server\e[0m"
+        puts "\e[33mPlease try running manually:\e[0m"
+        puts "\e[36m  gem install rails-mcp-server --no-document\e[0m"
+        exit 1
+      end
+    end
+
+    def show_next_steps
+      puts "\n\e[33mNext steps:\e[0m"
+
+      if MCPSupport.available?
+        puts "\e[36m1. Run the swarm generator to update your configuration:\e[0m"
+        puts "\e[36m   rails generate claude_on_rails:swarm\e[0m"
+        puts "\n\e[36m2. Start your enhanced Rails development swarm:\e[0m"
+        puts "\e[36m   claude-swarm\e[0m"
+        puts "\n\e[32mYour AI agents now have access to Rails documentation! 🎉\e[0m"
+      else
+        puts "\e[36m1. Complete the MCP Server setup when ready:\e[0m"
+        puts "\e[36m   bundle exec rake claude_on_rails:setup_mcp\e[0m"
+        puts "\n\e[36m2. Then run the swarm generator:\e[0m"
+        puts "\e[36m   rails generate claude_on_rails:swarm\e[0m"
+      end
+
+      puts "\n\e[36mFor more information:\e[0m"
+      puts "\e[36m  • Check status: bundle exec rake claude_on_rails:mcp_status\e[0m"
+      puts "\e[36m  • View documentation: https://github.com/obie/claude-on-rails\e[0m"
+    end
+
+    def prompt_yes_no?(question)
+      print "\e[32m#{question} \e[0m"
+      response = $stdin.gets.chomp.downcase
+      response.empty? || response.start_with?('y')
+    end
+  end
+end

data/lib/claude_on_rails/mcp_support.rb

@@ -0,0 +1,80 @@
+# frozen_string_literal: true
+
+module ClaudeOnRails
+  # Support module for Rails MCP Server integration
+  module MCPSupport
+    class << self
+      # Check if Rails MCP Server gem is available on the system
+      def available?
+        # Check if the gem is installed
+        system('gem list -i rails-mcp-server > /dev/null 2>&1') ||
+          # Also check if the executable is available
+          system('which rails-mcp-server > /dev/null 2>&1')
+      rescue StandardError
+        false
+      end
+
+      # Check if a specific resource is downloaded
+      def resource_available?(_resource_name)
+        # Rails MCP Server includes all resources in the gem
+        available?
+      end
+
+      # Get the MCP server configuration for swarm
+      def server_config(rails_env = 'development')
+        {
+          name: 'rails',
+          type: 'stdio',
+          command: 'rails-mcp-server',
+          args: [],
+          env: { 'RAILS_ENV' => rails_env }
+        }
+      end
+
+      # Check if we can download a resource (always true for gem-based server)
+      def download_resource?(_resource_name)
+        return false unless available?
+
+        # Rails MCP Server doesn't require separate resource downloads
+        # Documentation is built-in to the gem
+        true
+      end
+
+      # Get available resources that can be downloaded
+      def available_resources
+        %w[rails turbo stimulus kamal]
+      end
+
+      # Check which resources are currently downloaded
+      def downloaded_resources
+        # All resources are included in the gem
+        available? ? available_resources : []
+      end
+
+      # Check which resources are missing
+      def missing_resources
+        # No resources are missing if the gem is installed
+        available? ? [] : available_resources
+      end
+
+      # Check if common resources are set up
+      def common_resources_setup?
+        # No separate resource setup needed
+        available?
+      end
+
+      # Generate installation instructions
+      def installation_instructions
+        instructions = []
+
+        unless available?
+          instructions << "Install Rails MCP Server:"
+          instructions << "  gem install rails-mcp-server --no-document"
+          instructions << ""
+        end
+
+        instructions
+      end
+    end
+  end
+end

data/lib/claude_on_rails/project_analyzer.rb

@@ -1,159 +1,147 @@
+# frozen_string_literal: true
+
 module ClaudeOnRails
   class ProjectAnalyzer
     attr_reader :root_path
-    
+
     def initialize(root_path)
       @root_path = root_path
     end
-    
+
     def analyze
       {
         api_only: api_only?,
         test_framework: detect_test_framework,
-        has_graphql: has_graphql?,
-        has_turbo: has_turbo?,
-        has_devise: has_devise?,
-        has_sidekiq: has_sidekiq?,
+        has_graphql: graphql?,
+        has_turbo: turbo?,
+        has_devise: devise?,
+        has_sidekiq: sidekiq?,
         javascript_framework: detect_javascript_framework,
         database: detect_database,
         deployment: detect_deployment_method,
         custom_patterns: detect_custom_patterns
       }
     end
-    
+
     private
-    
+
     def api_only?
       application_rb = File.join(root_path, 'config', 'application.rb')
       return false unless File.exist?(application_rb)
-      
+
       File.read(application_rb).include?('config.api_only = true')
     end
-    
+
     def detect_test_framework
       if File.exist?(File.join(root_path, 'spec'))
         'RSpec'
       elsif File.exist?(File.join(root_path, 'test'))
         'Minitest'
-      else
-        nil
       end
     end
-    
-    def has_graphql?
+
+    def graphql?
       gemfile_path = File.join(root_path, 'Gemfile')
       return false unless File.exist?(gemfile_path)
-      
+
       gemfile_content = File.read(gemfile_path)
-      gemfile_content.include?('graphql') || 
+      gemfile_content.include?('graphql') ||
         File.exist?(File.join(root_path, 'app', 'graphql'))
     end
-    
-    def has_turbo?
+
+    def turbo?
       gemfile_path = File.join(root_path, 'Gemfile')
       return false unless File.exist?(gemfile_path)
-      
+
       gemfile_content = File.read(gemfile_path)
-      gemfile_content.include?('turbo-rails') || 
+      gemfile_content.include?('turbo-rails') ||
         gemfile_content.include?('stimulus-rails') ||
         File.exist?(File.join(root_path, 'app', 'javascript', 'controllers'))
     end
-    
-    def has_devise?
+
+    def devise?
       gemfile_path = File.join(root_path, 'Gemfile')
       return false unless File.exist?(gemfile_path)
-      
+
       File.read(gemfile_path).include?('devise')
     end
-    
-    def has_sidekiq?
+
+    def sidekiq?
       gemfile_path = File.join(root_path, 'Gemfile')
       return false unless File.exist?(gemfile_path)
-      
+
       File.read(gemfile_path).include?('sidekiq')
     end
-    
+
     def detect_javascript_framework
       package_json = File.join(root_path, 'package.json')
       return 'importmap' unless File.exist?(package_json)
-      
+
       content = File.read(package_json)
-      case
-      when content.include?('webpack')
+      if content.include?('webpack')
         'webpack'
-      when content.include?('esbuild')
+      elsif content.include?('esbuild')
         'esbuild'
-      when content.include?('vite')
+      elsif content.include?('vite')
         'vite'
       else
         'importmap'
       end
     end
-    
+
     def detect_database
       database_yml = File.join(root_path, 'config', 'database.yml')
       return 'sqlite3' unless File.exist?(database_yml)
-      
+
       content = File.read(database_yml)
-      case
-      when content.include?('postgresql')
+      if content.include?('postgresql')
         'postgresql'
-      when content.include?('mysql2')
+      elsif content.include?('mysql2')
         'mysql'
-      when content.include?('sqlite3')
+      elsif content.include?('sqlite3')
         'sqlite3'
       else
         'unknown'
       end
     end
-    
+
     def detect_deployment_method
       # Check for various deployment configurations
       return 'kubernetes' if File.exist?(File.join(root_path, 'k8s')) ||
-                            File.exist?(File.join(root_path, 'kubernetes'))
+                             File.exist?(File.join(root_path, 'kubernetes'))
       return 'docker' if File.exist?(File.join(root_path, 'Dockerfile'))
       return 'capistrano' if File.exist?(File.join(root_path, 'Capfile'))
       return 'heroku' if File.exist?(File.join(root_path, 'Procfile'))
       return 'kamal' if File.exist?(File.join(root_path, 'config', 'deploy.yml'))
-      
+
       'unknown'
     end
-    
+
     def detect_custom_patterns
       patterns = {}
-      
+
       # Check for service objects
-      if File.directory?(File.join(root_path, 'app', 'services'))
-        patterns[:has_services] = true
-      end
-      
+      patterns[:has_services] = true if File.directory?(File.join(root_path, 'app', 'services'))
+
       # Check for form objects
-      if File.directory?(File.join(root_path, 'app', 'forms'))
-        patterns[:has_forms] = true
-      end
-      
+      patterns[:has_forms] = true if File.directory?(File.join(root_path, 'app', 'forms'))
+
       # Check for presenters/decorators
       if File.directory?(File.join(root_path, 'app', 'presenters')) ||
          File.directory?(File.join(root_path, 'app', 'decorators'))
         patterns[:has_presenters] = true
       end
-      
+
       # Check for query objects
-      if File.directory?(File.join(root_path, 'app', 'queries'))
-        patterns[:has_queries] = true
-      end
-      
+      patterns[:has_queries] = true if File.directory?(File.join(root_path, 'app', 'queries'))
+
       # Check for policies (authorization)
-      if File.directory?(File.join(root_path, 'app', 'policies'))
-        patterns[:has_policies] = true
-      end
-      
+      patterns[:has_policies] = true if File.directory?(File.join(root_path, 'app', 'policies'))
+
       # Check for serializers
-      if File.directory?(File.join(root_path, 'app', 'serializers'))
-        patterns[:has_serializers] = true
-      end
-      
+      patterns[:has_serializers] = true if File.directory?(File.join(root_path, 'app', 'serializers'))
+
       patterns
     end
   end
-end
+end

data/lib/claude_on_rails/railtie.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+require 'rails/railtie'
+
+module ClaudeOnRails
+  # Railtie to load rake tasks in Rails applications
+  class Railtie < Rails::Railtie
+    rake_tasks do
+      load File.expand_path('../tasks/claude_on_rails.rake', __dir__)
+    end
+  end
+end