rails_claude_skills 0.1.0

data/lib/generators/claude/rule/rule_generator.rb

@@ -0,0 +1,175 @@
+# frozen_string_literal: true
+
+require "rails/generators"
+
+module Claude
+  module Generators
+    class RuleGenerator < Rails::Generators::NamedBase
+      source_root File.expand_path("templates", __dir__)
+
+      class_option :paths, type: :string, default: nil,
+                           desc: "Comma-separated paths where this rule applies (e.g., 'app/models/**/*,db/**/*')"
+      class_option :template, type: :string, default: "generic",
+                              desc: "Template type (generic, testing, security, performance)"
+
+      def create_rule_file
+        template "rule.md.tt", rule_path
+      end
+
+      def show_instructions
+        say "\nRule '#{file_name}' created successfully!", :green
+        say "\nLocation: #{rule_path}", :blue
+        say "\nScope: #{rule_scope}", :yellow
+        say "\nNext steps:", :yellow
+        say "  1. Edit #{rule_path} to add your project rules"
+        say "  2. The rule will be auto-loaded by Claude"
+        say "  3. Claude will follow these rules when working in the specified paths\n"
+      end
+
+      private
+
+      def rule_path
+        ".claude/rules/#{file_name}.md"
+      end
+
+      def rule_scope
+        options[:paths] || "All files"
+      end
+
+      def paths?
+        options[:paths].present?
+      end
+
+      def rule_content
+        case options[:template]
+        when "testing"
+          testing_template_content
+        when "security"
+          security_template_content
+        when "performance"
+          performance_template_content
+        else
+          generic_template_content
+        end
+      end
+
+      def generic_template_content
+        <<~CONTENT
+          Add your project rules and guidelines here.
+
+          ## Overview
+
+          Describe the purpose of these rules and when they apply.
+
+          ## Guidelines
+
+          - Add specific guidelines
+          - Include best practices
+          - Document conventions
+          - Provide examples
+
+          ## Common Patterns
+
+          Show examples of correct patterns to follow.
+
+          ## Anti-Patterns
+
+          Show examples of what to avoid.
+        CONTENT
+      end
+
+      def testing_template_content
+        <<~CONTENT
+          Guidelines for writing and maintaining tests in this project.
+
+          ## Test Structure
+
+          - One test file per source file
+          - Use descriptive test names
+          - Group related tests together
+          - Keep tests focused and independent
+
+          ## Best Practices
+
+          - Write tests before or alongside code
+          - Use appropriate test types (unit, integration, system)
+          - Mock external dependencies
+          - Keep tests fast and reliable
+
+          ## Coverage Requirements
+
+          - Aim for high test coverage
+          - Focus on critical paths
+          - Test edge cases and error conditions
+        CONTENT
+      end
+
+      def security_template_content
+        <<~CONTENT
+          Security guidelines and requirements for this project.
+
+          ## Input Validation
+
+          - Always validate and sanitize user input
+          - Use strong parameters in controllers
+          - Never trust external data
+
+          ## Authentication & Authorization
+
+          - Implement proper authentication
+          - Enforce authorization for sensitive actions
+          - Use secure session management
+
+          ## Common Vulnerabilities
+
+          Protect against:
+          - SQL Injection
+          - XSS (Cross-Site Scripting)
+          - CSRF (Cross-Site Request Forgery)
+          - Mass Assignment
+          - Insecure Direct Object References
+
+          ## Dependencies
+
+          - Keep dependencies up to date
+          - Run security audits regularly
+          - Review security advisories
+        CONTENT
+      end
+
+      def performance_template_content
+        <<~CONTENT
+          Performance optimization guidelines for this project.
+
+          ## Database Queries
+
+          - Avoid N+1 queries (use eager loading)
+          - Add appropriate indexes
+          - Limit data returned from queries
+          - Use database-specific optimizations
+
+          ## Caching
+
+          - Cache expensive operations
+          - Use fragment caching for views
+          - Implement HTTP caching headers
+          - Consider background jobs for slow tasks
+
+          ## Asset Optimization
+
+          - Minimize and compress assets
+          - Use CDN for static assets
+          - Implement lazy loading where appropriate
+          - Optimize images and media files
+
+          ## Monitoring
+
+          - Track performance metrics
+          - Monitor query performance
+          - Set up alerts for slowdowns
+          - Profile code regularly
+        CONTENT
+      end
+    end
+  end
+end

data/lib/generators/claude/rule/templates/rule.md.tt

@@ -0,0 +1,7 @@
+<% if paths? %>---
+paths: <%= options[:paths] %>
+---
+
+<% end %># <%= file_name.titleize %> Rules
+
+<%= rule_content %>

data/lib/generators/claude/rules_library/code-style.md

@@ -0,0 +1,37 @@
+# Code Style Rules
+
+This project follows Rails conventions and Ruby best practices.
+
+## Key Principles
+
+- **Convention over Configuration**: Prefer Rails defaults and conventions
+- **Readability**: Code should be clear and self-documenting
+- **Consistency**: Follow established patterns in the codebase
+
+## Ruby Style
+
+- Use 2 spaces for indentation (not tabs)
+- Prefer double quotes for strings
+- Use modern Ruby syntax (Ruby 3.0+)
+- Prefer `&.` safe navigation over conditional checks
+- Use trailing commas in multi-line arrays and hashes
+
+## Rails Conventions
+
+- Follow RESTful routing patterns
+- Keep controllers skinny, models organized
+- Use `before_action` callbacks for common controller setup
+- Prefer strong parameters for mass assignment protection
+- Use ActiveRecord query methods over raw SQL
+
+## Naming
+
+- Use snake_case for variables, methods, and file names
+- Use PascalCase for class and module names
+- Be descriptive: `user_signed_in?` not `signed_in?`
+- Prefix predicate methods with `?` (e.g., `published?`)
+- Prefix dangerous methods with `!` (e.g., `publish!`)
+
+## Auto-Fixing
+
+Run `bundle exec rubocop -a` to automatically fix style violations before committing.

data/lib/generators/claude/rules_library/database.md

@@ -0,0 +1,47 @@
+---
+paths: db/**/*,app/models/**/*
+---
+
+# Database Rules
+
+Guidelines for working with the database and ActiveRecord models.
+
+## Migration Best Practices
+
+- Always make migrations reversible
+- Add indexes for foreign keys
+- Use `change` method instead of up/down when possible
+- Add null/default constraints at database level
+- Include comments for complex migrations
+
+## Migration Safety
+
+- Never modify migrations that have been deployed to production
+- Use background migrations for large data changes
+- Consider downtime for destructive changes
+- Test migrations in development first
+- Keep migrations focused on one change
+
+## Model Design
+
+- Keep business logic in models
+- Use concerns for shared behavior
+- Implement proper associations
+- Add database-level validations
+- Use scopes for common queries
+
+## Query Optimization
+
+- Use `includes` to avoid N+1 queries
+- Add appropriate indexes
+- Use `select` to limit columns when needed
+- Leverage database-specific features when appropriate
+- Monitor query performance
+
+## Schema Integrity
+
+- Use foreign key constraints
+- Add appropriate indexes
+- Set null constraints appropriately
+- Use enums for fixed sets of values
+- Maintain referential integrity

data/lib/generators/claude/rules_library/hotwire.md

@@ -0,0 +1,56 @@
+---
+paths: app/views/**/*,app/controllers/**/*
+---
+
+# Hotwire Rules
+
+Guidelines for using Turbo and Stimulus in this Rails application.
+
+## Turbo Principles
+
+- **Turbo Drive**: Automatically handles link clicks and form submissions
+- **Turbo Frames**: Use for independent page segments
+- **Turbo Streams**: Use for real-time updates and multiple page updates
+
+## When to Use What
+
+### Turbo Frames
+- Independent sections of a page
+- Inline editing
+- Lazy-loaded content
+- Modal dialogs
+
+### Turbo Streams
+- Real-time updates (via WebSocket)
+- Multiple simultaneous page updates
+- Optimistic UI updates
+- Background job results
+
+### Stimulus
+- Client-side interactivity
+- Form validation
+- UI enhancements
+- When Turbo alone isn't sufficient
+
+## Best Practices
+
+- Prefer Turbo over custom JavaScript
+- Keep Stimulus controllers small and focused
+- Use semantic HTML with Turbo
+- Follow progressive enhancement
+- Test Turbo interactions
+
+## Common Patterns
+
+- Use `data-turbo-frame` for targeting frames
+- Use `turbo_stream_from` for real-time updates
+- Respond with `turbo_stream` format in controllers
+- Use Stimulus for UI state management
+- Leverage Turbo's morphing for smooth updates
+
+## Performance
+
+- Lazy load Turbo Frames when appropriate
+- Cache Turbo Frame responses
+- Use Turbo Stream broadcasts efficiently
+- Minimize JavaScript controller complexity

data/lib/generators/claude/rules_library/security.md

@@ -0,0 +1,54 @@
+# Security Rules
+
+Security is a top priority in this Rails application.
+
+## Input Validation
+
+- Always use strong parameters in controllers
+- Validate and sanitize user input
+- Use ActiveRecord validations
+- Never trust user input
+
+## Authentication & Authorization
+
+- Implement proper authentication (Devise, has_secure_password, etc.)
+- Use authorization gems (Pundit, CanCanCan) for complex permissions
+- Protect sensitive actions with before_action filters
+- Use secure session configuration
+
+## Database Security
+
+- Never commit database credentials
+- Use environment variables for sensitive configuration
+- Prevent SQL injection by using ActiveRecord query methods
+- Add database-level constraints when appropriate
+
+## CSRF Protection
+
+- Keep CSRF protection enabled (default in Rails)
+- Use `protect_from_forgery` in ApplicationController
+- Include authenticity tokens in forms
+
+## Common Vulnerabilities
+
+Protect against:
+- SQL Injection: Use parameterized queries
+- XSS: Sanitize output, use content_tag helpers
+- Mass Assignment: Use strong parameters
+- CSRF: Use Rails default protections
+- Insecure Direct Object References: Authorize resource access
+
+## Dependency Management
+
+- Keep gems up to date
+- Run `bundle audit` regularly
+- Use Dependabot or similar tools
+- Review security advisories
+
+## Best Practices
+
+- Follow OWASP Top 10 guidelines
+- Use HTTPS in production
+- Implement rate limiting for APIs
+- Log security events
+- Regular security audits with Brakeman

data/lib/generators/claude/rules_library/testing.md

@@ -0,0 +1,47 @@
+---
+paths: spec/**/*,test/**/*
+---
+
+# Testing Rules
+
+This project values comprehensive test coverage.
+
+## Test Structure
+
+- One test file per model/controller/component
+- Use descriptive test names
+- Group related tests with clear organization
+- Keep tests focused and independent
+
+## Test Types
+
+### Model Tests
+- Test validations
+- Test associations
+- Test custom methods
+- Test scopes and queries
+
+### Controller Tests
+- Test HTTP responses (200, 302, 404, etc.)
+- Test authentication/authorization
+- Test parameter handling
+- Avoid testing view rendering details
+
+### System/Integration Tests
+- Test critical user workflows end-to-end
+- Test JavaScript/Hotwire behavior
+- Keep tests for happy paths and critical features
+
+## Best Practices
+
+- Write tests before or alongside code (TDD/BDD)
+- Use factories or fixtures for test data
+- Mock external services
+- Keep tests fast and isolated
+- Test edge cases and error conditions
+
+## Running Tests
+
+- Run full suite regularly
+- Run specific tests during development
+- Ensure tests pass before committing

data/lib/generators/claude/skill/skill_generator.rb

@@ -0,0 +1,196 @@
+# frozen_string_literal: true
+
+require "rails/generators"
+
+module Claude
+  module Generators
+    class SkillGenerator < Rails::Generators::NamedBase
+      source_root File.expand_path("templates", __dir__)
+
+      class_option :description, type: :string, default: nil,
+                                 desc: "Skill description"
+      class_option :with_references, type: :boolean, default: false,
+                                     desc: "Create references directory"
+      class_option :template, type: :string, default: "generic",
+                              desc: "Template type (generic, model, controller, frontend)"
+
+      def create_skill_directory
+        empty_directory skill_path
+      end
+
+      def create_skill_file
+        template "SKILL.md.tt", "#{skill_path}/SKILL.md"
+      end
+
+      def create_references_directory
+        return unless options[:with_references]
+
+        empty_directory "#{skill_path}/references"
+        create_file "#{skill_path}/references/.keep", ""
+      end
+
+      def show_instructions
+        say "\nSkill '#{file_name}' created successfully!", :green
+        say "\nLocation: #{skill_path}/", :blue
+        say "\nNext steps:", :yellow
+        say "  1. Edit #{skill_path}/SKILL.md to add your skill content"
+        say "  2. Add reference files in #{skill_path}/references/ (optional)" if options[:with_references]
+        say "  3. The skill will be auto-loaded by Claude\n"
+      end
+
+      private
+
+      def skill_path
+        ".claude/skills/#{file_name}"
+      end
+
+      def skill_description
+        options[:description] || "Custom skill for #{file_name.titleize}"
+      end
+
+      def skill_tags
+        case options[:template]
+        when "model"
+          %w[activerecord models database]
+        when "controller"
+          %w[controllers routing actions]
+        when "frontend"
+          %w[views frontend ui]
+        else
+          ["custom"]
+        end
+      end
+
+      def template_sections
+        case options[:template]
+        when "model"
+          model_template_sections
+        when "controller"
+          controller_template_sections
+        when "frontend"
+          frontend_template_sections
+        else
+          generic_template_sections
+        end
+      end
+
+      def generic_template_sections
+        <<~SECTIONS
+          ## Quick Reference
+
+          | Command | Purpose |
+          |---------|---------|
+          | TODO    | Add commands here |
+
+          ## Overview
+
+          #{skill_description}
+
+          ## Usage
+
+          Add usage examples and patterns here.
+
+          ## Common Patterns
+
+          Add frequently used code patterns here.
+
+          ## Best Practices
+
+          Add best practices and conventions here.
+        SECTIONS
+      end
+
+      def model_template_sections
+        <<~SECTIONS
+          ## Quick Reference
+
+          | Pattern | Example |
+          |---------|---------|
+          | Define Model | `class #{file_name.classify} < ApplicationRecord` |
+          | Validation | `validates :field, presence: true` |
+          | Association | `has_many :items` |
+
+          ## Overview
+
+          #{skill_description}
+
+          ## Validations
+
+          Add validation patterns here.
+
+          ## Associations
+
+          Add association patterns here.
+
+          ## Scopes and Queries
+
+          Add query patterns here.
+
+          ## Callbacks
+
+          Add callback patterns here.
+        SECTIONS
+      end
+
+      def controller_template_sections
+        <<~SECTIONS
+          ## Quick Reference
+
+          | Action | Purpose |
+          |--------|---------|
+          | index  | List resources |
+          | show   | Display single resource |
+          | new    | Form for creating |
+          | create | Save new resource |
+          | edit   | Form for editing |
+          | update | Save changes |
+          | destroy| Delete resource |
+
+          ## Overview
+
+          #{skill_description}
+
+          ## Standard Actions
+
+          Add standard CRUD action patterns here.
+
+          ## Custom Actions
+
+          Add custom action patterns here.
+
+          ## Filters and Callbacks
+
+          Add before_action and other filter patterns here.
+        SECTIONS
+      end
+
+      def frontend_template_sections
+        <<~SECTIONS
+          ## Quick Reference
+
+          | Pattern | Usage |
+          |---------|-------|
+          | Partial | `<%= render 'partial' %>` |
+          | Helper  | `<%= helper_method %>` |
+          | Link    | `<%= link_to 'Text', path %>` |
+
+          ## Overview
+
+          #{skill_description}
+
+          ## Templates
+
+          Add view template patterns here.
+
+          ## Helpers
+
+          Add helper method patterns here.
+
+          ## Components
+
+          Add component patterns here.
+        SECTIONS
+      end
+    end
+  end
+end

data/lib/generators/claude/skill/templates/SKILL.md.tt

@@ -0,0 +1,27 @@
+---
+name: <%= file_name %>
+description: <%= skill_description %>
+version: 1.0.0
+rails_version: ">= 7.0"
+tags:
+<% skill_tags.each do |tag| -%>
+  - <%= tag %>
+<% end -%>
+---
+
+# <%= file_name.titleize %>
+
+<%= template_sections %>
+
+## Troubleshooting
+
+Add common issues and solutions here.
+
+## References
+
+- [Add external documentation links]
+- [Add related resources]
+
+---
+
+*Generated with rails_claude_skills v<%= RailsClaudeSkills::VERSION %>*