ruby-ai-gem-context 0.1.0

data/lib/ruby_ai_gem_context/platforms/llm_txt.rb

@@ -0,0 +1,90 @@
+# frozen_string_literal: true
+
+module RubyAiGemContext
+  module Platforms
+    class LlmTxt < Platform
+      class << self
+        def name
+          "llm.txt"
+        end
+
+        def filename
+          "llm.txt"
+        end
+
+        def description
+          "llm.txt - Universal LLM context file (like robots.txt for AI)"
+        end
+
+        def generation_prompt
+          <<~PROMPT
+            Generate an llm.txt file for this Ruby project. The llm.txt format is like robots.txt but for LLMs - it helps AI systems understand what this project is and how to use it.
+
+            Format the file as:
+
+            # Project Name
+            > Brief one-line description
+
+            ## About
+            Paragraph explaining what this project does, who it's for, and why it exists.
+
+            ## Quick Start
+            The fastest way to get started with this project.
+
+            ## Documentation
+            - Link to or description of where to find docs
+            - Key files to read to understand the project
+
+            ## API
+            Key classes/methods and what they do.
+
+            ## Examples
+            Short, practical code examples.
+
+            ## License
+            License information.
+
+            Keep it concise and scannable. This is meant to be quickly parsed by AI systems.
+          PROMPT
+        end
+
+        def template
+          <<~TEMPLATE
+            # Project Name
+            > One-line description of the project
+
+            ## About
+            Longer description of what this project does, its purpose, and target audience.
+
+            ## Quick Start
+            ```bash
+            gem install project-name
+            ```
+
+            ```ruby
+            require 'project_name'
+            # Minimal usage example
+            ```
+
+            ## Documentation
+            - README.md - Overview and setup
+            - lib/ - Source code
+            - spec/ - Test examples
+
+            ## API
+            - `MainModule` - Entry point
+            - `MainModule.method` - Key functionality
+
+            ## Examples
+            ```ruby
+            # Practical example
+            ```
+
+            ## License
+            MIT License - See LICENSE file
+          TEMPLATE
+        end
+      end
+    end
+  end
+end

data/lib/ruby_ai_gem_context/platforms/windsurf.rb

@@ -0,0 +1,82 @@
+# frozen_string_literal: true
+
+module RubyAiGemContext
+  module Platforms
+    class Windsurf < Platform
+      class << self
+        def name
+          "Windsurf"
+        end
+
+        def filename
+          ".windsurfrules"
+        end
+
+        def description
+          "Windsurf IDE - Project rules file"
+        end
+
+        def generation_prompt
+          <<~PROMPT
+            Generate a .windsurfrules file for this Ruby project. This file tells Windsurf AI how to work with this codebase.
+
+            Structure it as clear rules and guidelines:
+
+            1. Project context - What this project is
+            2. Language and framework details
+            3. Code conventions to follow
+            4. Architecture patterns
+            5. Testing requirements
+            6. Important files and their purposes
+            7. Commands for common tasks
+            8. Pitfalls and things to avoid
+
+            Write in a direct, instructional style. Focus on actionable guidance.
+          PROMPT
+        end
+
+        def template
+          <<~TEMPLATE
+            # Project Context
+            This is a Ruby project. Describe its purpose here.
+
+            # Language & Framework
+            - Ruby 3.x
+            - Add frameworks used (Rails, Sinatra, etc.)
+            - Key gems and their purposes
+
+            # Code Conventions
+            - Follow Ruby style guide
+            - Use snake_case for methods/variables
+            - Use CamelCase for classes/modules
+            - Document public APIs with YARD
+
+            # Architecture
+            - Describe the overall structure
+            - Key patterns used
+            - How components interact
+
+            # Testing
+            - RSpec for unit tests
+            - Run with: bundle exec rspec
+            - Write tests for all new code
+
+            # Important Files
+            - lib/ - Main code
+            - spec/ - Tests
+            - Gemfile - Dependencies
+
+            # Common Commands
+            - bundle install - Install dependencies
+            - bundle exec rspec - Run tests
+            - bundle exec rubocop - Run linter
+
+            # Pitfalls
+            - Things to watch out for
+            - Common mistakes in this codebase
+          TEMPLATE
+        end
+      end
+    end
+  end
+end

data/lib/ruby_ai_gem_context/railtie.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+require "rails/railtie"
+
+module RubyAiGemContext
+  class Railtie < Rails::Railtie
+    rake_tasks do
+      load File.expand_path("tasks/ruby_ai_gem_context.rake", __dir__)
+    end
+
+    initializer "ruby_ai_gem_context.configure" do |app|
+      # Allow Rails config to override gem configuration
+      if app.config.respond_to?(:ruby_ai_gem_context)
+        RubyAiGemContext.configure do |config|
+          rails_config = app.config.ruby_ai_gem_context
+
+          config.model = rails_config.model if rails_config.respond_to?(:model) && rails_config.model
+          config.temperature = rails_config.temperature if rails_config.respond_to?(:temperature)
+          config.max_tokens = rails_config.max_tokens if rails_config.respond_to?(:max_tokens)
+        end
+      end
+    end
+  end
+end

data/lib/ruby_ai_gem_context/tasks/ruby_ai_gem_context.rake

@@ -0,0 +1,311 @@
+# frozen_string_literal: true
+
+namespace :ai_context do
+  desc "Setup: Generate boilerplate context files for selected AI platforms"
+  task :setup do
+    require "ruby_ai_gem_context"
+
+    ui = RubyAiGemContext::Interactive.new
+    config_file = RubyAiGemContext::ConfigFile.new
+
+    ui.header("AI Context Setup")
+
+    # Ask which platforms to generate for
+    selected = ui.select_platforms
+
+    if selected.empty?
+      ui.warning("No platforms selected. Exiting.")
+      exit 0
+    end
+
+    ui.info("Selected: #{selected.map { |k| RubyAiGemContext.platform(k).name }.join(', ')}")
+
+    # Process each platform
+    selected.each do |platform_key|
+      platform = RubyAiGemContext.platform(platform_key)
+
+      if platform.exists?
+        action = ui.handle_collision(platform)
+
+        case action
+        when :skip
+          ui.info("Skipping #{platform.filename}")
+          next
+        when :backup
+          backup_path = platform.backup
+          ui.info("Backed up to #{backup_path}")
+        when :diff
+          existing = platform.read
+          action = ui.show_diff(existing, platform.template)
+          case action
+          when :skip
+            ui.info("Keeping existing #{platform.filename}")
+            next
+          when :backup
+            backup_path = platform.backup
+            ui.info("Backed up to #{backup_path}")
+          end
+        when :overwrite
+          # Continue to write
+        end
+      end
+
+      # Write the template
+      path = platform.write(platform.template)
+      config_file.record_generated(platform_key, model: "template")
+      ui.success("Created #{path}")
+    end
+
+    puts
+    ui.info("Boilerplate files created!")
+    ui.info("Next step: Run `rake ai_context:generate` to fill them with AI-generated content")
+    ui.info("Or edit the files manually with your project's specific information")
+  end
+
+  desc "Generate: Fill context files with AI-generated content from your project"
+  task :generate do
+    require "ruby_ai_gem_context"
+
+    ui = RubyAiGemContext::Interactive.new
+    config_file = RubyAiGemContext::ConfigFile.new
+
+    ui.header("AI Context Generation")
+
+    # Check which platforms have been set up
+    existing_platforms = config_file.generated_platforms
+
+    if existing_platforms.empty?
+      ui.warning("No context files have been set up yet.")
+      ui.info("Run `rake ai_context:setup` first to create boilerplate files.")
+      exit 0
+    end
+
+    # Ask which to regenerate
+    selected = ui.select_platforms_to_regenerate(existing_platforms)
+
+    if selected.empty?
+      ui.warning("No platforms selected. Exiting.")
+      exit 0
+    end
+
+    # Ask about source folders
+    folders = ui.select_source_folders
+
+    # Show what will be scanned
+    collector = RubyAiGemContext::FileCollector.new(Dir.pwd, folders: folders)
+    summary = collector.summary
+
+    unless ui.confirm_source_folders(folders, summary)
+      ui.info("Generation cancelled.")
+      exit 0
+    end
+
+    # Record source folders
+    config_file.record_source_folders(folders)
+
+    # Show model info
+    model = RubyAiGemContext.configuration.model
+    ui.info("Using model: #{model}")
+    ui.info("(Change in config or set RUBY_LLM_MODEL env var)")
+    puts
+
+    # Generate for each platform
+    selected.each do |platform_key|
+      platform = RubyAiGemContext.platform(platform_key)
+
+      content = ui.with_spinner("Generating #{platform.name} context...") do
+        generator = RubyAiGemContext::Generator.new(
+          platform: platform,
+          file_collector: collector,
+          model: model
+        )
+        generator.generate
+      end
+
+      # Handle existing file
+      if platform.exists?
+        action = ui.handle_collision(platform)
+
+        case action
+        when :skip
+          ui.info("Skipping #{platform.filename}")
+          next
+        when :backup
+          platform.backup
+        when :diff
+          existing = platform.read
+          action = ui.show_diff(existing, content)
+          case action
+          when :skip
+            next
+          when :backup
+            platform.backup
+          end
+        end
+      end
+
+      path = platform.write(content)
+      config_file.record_generated(platform_key, model: model)
+      ui.success("Generated #{path}")
+    end
+
+    ui.review_reminder
+  end
+
+  desc "Generate context for a third-party gem: rake ai_context:generate_for_gem[gem_name]"
+  task :generate_for_gem, [:gem_name] do |_t, args|
+    require "ruby_ai_gem_context"
+
+    ui = RubyAiGemContext::Interactive.new
+
+    ui.header("Generate Context for Gem")
+
+    # Get gem name
+    gem_name = args[:gem_name] || ui.ask_gem_name
+
+    # Find the gem
+    begin
+      spec = Gem::Specification.find_by_name(gem_name)
+    rescue Gem::MissingSpecError
+      ui.error("Gem '#{gem_name}' not found. Is it installed?")
+      exit 1
+    end
+
+    ui.info("Found: #{spec.name} v#{spec.version}")
+    ui.info("Location: #{spec.gem_dir}")
+    puts
+
+    # Ask which platforms to generate for
+    selected = ui.select_platforms
+
+    if selected.empty?
+      ui.warning("No platforms selected. Exiting.")
+      exit 0
+    end
+
+    # Collect files from the gem
+    collector = RubyAiGemContext::FileCollector.new(spec.gem_dir)
+    summary = collector.summary
+
+    ui.info("Gem has #{summary[:total_files]} files (#{format_size(summary[:total_size])})")
+
+    unless ui.prompt.yes?("Generate context for this gem?")
+      ui.info("Generation cancelled.")
+      exit 0
+    end
+
+    # Create output directory
+    output_dir = File.join(Dir.pwd, ".ai_context", "gems", gem_name)
+    FileUtils.mkdir_p(output_dir)
+
+    model = RubyAiGemContext.configuration.model
+    ui.info("Using model: #{model}")
+    puts
+
+    # Generate for each platform
+    selected.each do |platform_key|
+      platform = RubyAiGemContext.platform(platform_key)
+
+      content = ui.with_spinner("Generating #{platform.name} context for #{gem_name}...") do
+        generator = RubyAiGemContext::Generator.new(
+          platform: platform,
+          file_collector: collector,
+          model: model
+        )
+        generator.generate
+      end
+
+      output_path = File.join(output_dir, platform.filename)
+      File.write(output_path, content)
+      ui.success("Generated #{output_path}")
+    end
+
+    puts
+    ui.info("Context files saved to: #{output_dir}/")
+    ui.info("You can copy these to your project or reference them as needed.")
+    ui.review_reminder
+  end
+
+  desc "List generated context files"
+  task :list do
+    require "ruby_ai_gem_context"
+
+    config_file = RubyAiGemContext::ConfigFile.new
+    config = config_file.load
+
+    puts "AI Context Files"
+    puts "=" * 40
+
+    generated = config["generated"] || {}
+
+    if generated.empty?
+      puts "No context files have been generated yet."
+      puts "Run `rake ai_context:setup` to get started."
+    else
+      generated.each do |platform_key, info|
+        platform = RubyAiGemContext.platform(platform_key)
+        exists = platform.exists? ? "✓" : "✗ (missing)"
+        puts
+        puts "#{platform.name}"
+        puts "  File: #{info['path']} #{exists}"
+        puts "  Model: #{info['model']}"
+        puts "  Generated: #{info['created_at']}"
+      end
+    end
+
+    if config["source_folders"]
+      puts
+      puts "Source folders: #{config['source_folders'].join(', ')}"
+    end
+  end
+
+  desc "Clear all generated context files"
+  task :clear do
+    require "ruby_ai_gem_context"
+
+    ui = RubyAiGemContext::Interactive.new
+    config_file = RubyAiGemContext::ConfigFile.new
+
+    platforms = config_file.generated_platforms
+
+    if platforms.empty?
+      ui.info("No context files to clear.")
+      exit 0
+    end
+
+    ui.warning("This will delete the following files:")
+    platforms.each do |key|
+      platform = RubyAiGemContext.platform(key)
+      puts "  - #{platform.path}" if platform.exists?
+    end
+    puts
+
+    unless ui.prompt.yes?("Are you sure you want to delete these files?")
+      ui.info("Cancelled.")
+      exit 0
+    end
+
+    platforms.each do |key|
+      platform = RubyAiGemContext.platform(key)
+      if platform.exists?
+        File.delete(platform.full_path)
+        ui.success("Deleted #{platform.path}")
+      end
+    end
+
+    # Clear config
+    config_dir = File.join(Dir.pwd, RubyAiGemContext.configuration.config_dir)
+    FileUtils.rm_rf(config_dir)
+    ui.success("Cleared #{config_dir}/")
+  end
+end
+
+def format_size(bytes)
+  if bytes < 1024
+    "#{bytes} B"
+  elsif bytes < 1024 * 1024
+    "#{(bytes / 1024.0).round(1)} KB"
+  else
+    "#{(bytes / (1024.0 * 1024)).round(1)} MB"
+  end
+end

data/lib/ruby_ai_gem_context/version.rb

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

data/lib/ruby_ai_gem_context.rb

@@ -0,0 +1,60 @@
+# frozen_string_literal: true
+
+require "fileutils"
+require "yaml"
+require "time"
+
+require_relative "ruby_ai_gem_context/version"
+require_relative "ruby_ai_gem_context/configuration"
+require_relative "ruby_ai_gem_context/platform"
+require_relative "ruby_ai_gem_context/platforms/claude"
+require_relative "ruby_ai_gem_context/platforms/cursor"
+require_relative "ruby_ai_gem_context/platforms/windsurf"
+require_relative "ruby_ai_gem_context/platforms/codex"
+require_relative "ruby_ai_gem_context/platforms/llm_txt"
+require_relative "ruby_ai_gem_context/config_file"
+require_relative "ruby_ai_gem_context/file_collector"
+require_relative "ruby_ai_gem_context/generator"
+require_relative "ruby_ai_gem_context/interactive"
+
+module RubyAiGemContext
+  class Error < StandardError; end
+
+  # All supported platforms
+  PLATFORMS = {
+    claude: Platforms::Claude,
+    cursor: Platforms::Cursor,
+    windsurf: Platforms::Windsurf,
+    codex: Platforms::Codex,
+    llm_txt: Platforms::LlmTxt
+  }.freeze
+
+  class << self
+    attr_writer :configuration
+
+    def configuration
+      @configuration ||= Configuration.new
+    end
+
+    def configure
+      yield(configuration)
+    end
+
+    def reset_configuration!
+      @configuration = Configuration.new
+    end
+
+    # Get platform class by key
+    def platform(key)
+      PLATFORMS[key.to_sym] || raise(Error, "Unknown platform: #{key}")
+    end
+
+    # List all platform keys
+    def platform_keys
+      PLATFORMS.keys
+    end
+  end
+end
+
+# Load Rails integration if Rails is defined
+require_relative "ruby_ai_gem_context/railtie" if defined?(Rails::Railtie)

data/ruby-ai-gem-context.gemspec

@@ -0,0 +1,41 @@
+# frozen_string_literal: true
+
+require_relative "lib/ruby_ai_gem_context/version"
+
+Gem::Specification.new do |spec|
+  spec.name = "ruby-ai-gem-context"
+  spec.version = RubyAiGemContext::VERSION
+  spec.authors = ["Your Name"]
+  spec.email = ["your.email@example.com"]
+
+  spec.summary = "Generate AI context files for Ruby projects"
+  spec.description = "Interactive rake tasks to generate context files for AI coding assistants " \
+                     "(Claude, Cursor, Windsurf, Codex, llm.txt). Uses RubyLLM to analyze your " \
+                     "codebase and create platform-specific context that helps AI understand your project."
+  spec.homepage = "https://github.com/AAlvAAro/ruby-ai-gem-context"
+  spec.license = "MIT"
+  spec.required_ruby_version = ">= 3.0.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.files = Dir.chdir(__dir__) do
+    `git ls-files -z`.split("\x0").reject do |f|
+      (File.expand_path(f) == __FILE__) ||
+        f.start_with?(*%w[bin/ test/ spec/ features/ .git .github appveyor Gemfile])
+    end
+  end
+  spec.bindir = "exe"
+  spec.executables = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  # Core dependencies
+  spec.add_dependency "ruby_llm", ">= 1.0"      # AI generation via multiple providers
+  spec.add_dependency "tty-prompt", "~> 0.23"   # Interactive terminal prompts
+  spec.add_dependency "tty-spinner", "~> 0.9"   # Progress spinners
+
+  spec.add_development_dependency "bundler", ">= 2.0"
+  spec.add_development_dependency "rake", "~> 13.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+end