aigroup-workflow 2.1.2 → 2.2.0

package/skills/ruby/rails-expert/SKILL.md

@@ -0,0 +1,154 @@
+---
+name: rails-expert
+description: Rails 7+ specialist that optimizes Active Record queries with includes/eager_load, implements Turbo Frames and Turbo Streams for partial page updates, configures Action Cable for WebSocket connections, sets up Sidekiq workers for background job processing, and writes comprehensive RSpec test suites. Use when building Rails 7+ web applications with Hotwire, real-time features, or background job processing. Invoke for Active Record optimization, Turbo Frames/Streams, Action Cable, Sidekiq, RSpec Rails.
+license: MIT
+metadata:
+  author: https://github.com/Jeffallan
+  version: "1.1.0"
+  domain: backend
+  triggers: Rails, Ruby on Rails, Hotwire, Turbo Frames, Turbo Streams, Action Cable, Active Record, Sidekiq, RSpec Rails
+  role: specialist
+  scope: implementation
+  output-format: code
+  related-skills: fullstack-guardian, database-optimizer
+---
+
+# Rails Expert
+
+## Core Workflow
+
+1. **Analyze requirements** — Identify models, routes, real-time needs, background jobs
+2. **Scaffold resources** — `rails generate model User name:string email:string`, `rails generate controller Users`
+3. **Run migrations** — `rails db:migrate` and verify schema with `rails db:schema:dump`
+   - If migration fails: inspect `db/schema.rb` for conflicts, rollback with `rails db:rollback`, fix and retry
+4. **Implement** — Write controllers, models, add Hotwire (see Reference Guide below)
+5. **Validate** — `bundle exec rspec` must pass; `bundle exec rubocop` for style
+   - If specs fail: check error output, fix failing examples, re-run with `--format documentation` for detail
+   - If N+1 queries surface during review: add `includes`/`eager_load` (see Common Patterns) and re-run specs
+6. **Optimize** — Audit for N+1 queries, add missing indexes, add caching
+
+## Reference Guide
+
+Load detailed guidance based on context:
+
+| Topic | Reference | Load When |
+|-------|-----------|-----------|
+| Hotwire/Turbo | `references/hotwire-turbo.md` | Turbo Frames, Streams, Stimulus controllers |
+| Active Record | `references/active-record.md` | Models, associations, queries, performance |
+| Background Jobs | `references/background-jobs.md` | Sidekiq, job design, queues, error handling |
+| Testing | `references/rspec-testing.md` | Model/request/system specs, factories |
+| API Development | `references/api-development.md` | API-only mode, serialization, authentication |
+
+## Common Patterns
+
+### N+1 Prevention with includes/eager_load
+
+```ruby
+# BAD — triggers N+1
+posts = Post.all
+posts.each { |post| puts post.author.name }
+
+# GOOD — eager load association
+posts = Post.includes(:author).all
+posts.each { |post| puts post.author.name }
+
+# GOOD — eager_load forces a JOIN (useful when filtering on association)
+posts = Post.eager_load(:author).where(authors: { verified: true })
+```
+
+### Turbo Frame Setup (partial page update)
+
+```erb
+<%# app/views/posts/index.html.erb %>
+<%= turbo_frame_tag "posts" do %>
+  <%= render @posts %>
+  <%= link_to "Load More", posts_path(page: @next_page) %>
+<% end %>
+
+<%# app/views/posts/_post.html.erb %>
+<%= turbo_frame_tag dom_id(post) do %>
+  <h2><%= post.title %></h2>
+  <%= link_to "Edit", edit_post_path(post) %>
+<% end %>
+```
+
+```ruby
+# app/controllers/posts_controller.rb
+def index
+  @posts = Post.includes(:author).page(params[:page])
+  @next_page = @posts.next_page
+end
+```
+
+### Sidekiq Worker Template
+
+```ruby
+# app/jobs/send_welcome_email_job.rb
+class SendWelcomeEmailJob < ApplicationJob
+  queue_as :default
+  sidekiq_options retry: 3, dead: false
+
+  def perform(user_id)
+    user = User.find(user_id)
+    UserMailer.welcome(user).deliver_now
+  rescue ActiveRecord::RecordNotFound => e
+    Rails.logger.warn("SendWelcomeEmailJob: user #{user_id} not found — #{e.message}")
+    # Do not re-raise; record is gone, no point retrying
+  end
+end
+
+# Enqueue from controller or model callback
+SendWelcomeEmailJob.perform_later(user.id)
+```
+
+### Strong Parameters (controller template)
+
+```ruby
+# app/controllers/posts_controller.rb
+class PostsController < ApplicationController
+  before_action :set_post, only: %i[show edit update destroy]
+
+  def create
+    @post = Post.new(post_params)
+    if @post.save
+      redirect_to @post, notice: "Post created."
+    else
+      render :new, status: :unprocessable_entity
+    end
+  end
+
+  private
+
+  def set_post
+    @post = Post.find(params[:id])
+  end
+
+  def post_params
+    params.require(:post).permit(:title, :body, :published_at)
+  end
+end
+```
+
+## Constraints
+
+### MUST DO
+- Prevent N+1 queries with `includes`/`eager_load` on every collection query involving associations
+- Write comprehensive specs targeting >95% coverage
+- Use service objects for complex business logic; keep controllers thin
+- Add database indexes for every column used in `WHERE`, `ORDER BY`, or `JOIN`
+- Offload slow operations to Sidekiq — never run them synchronously in a request cycle
+
+### MUST NOT DO
+- Skip migrations for schema changes
+- Use raw SQL without sanitization (`sanitize_sql` or parameterized queries only)
+- Expose internal IDs in URLs without consideration
+
+## Output Templates
+
+When implementing Rails features, provide:
+1. Migration file (if schema changes needed)
+2. Model file with associations and validations
+3. Controller with RESTful actions and strong parameters
+4. View files or Hotwire setup
+5. Spec files for models and requests
+6. Brief explanation of architectural decisions

package/skills/ruby/rails-expert/references/active-record.md

@@ -0,0 +1,244 @@
+# Active Record Patterns
+
+## Model Associations
+
+```ruby
+# app/models/user.rb
+class User < ApplicationRecord
+  has_many :posts, dependent: :destroy
+  has_many :comments, dependent: :destroy
+  has_many :commented_posts, through: :comments, source: :post
+
+  has_one :profile, dependent: :destroy
+  has_one_attached :avatar
+  has_many_attached :documents
+
+  validates :email, presence: true, uniqueness: true
+  validates :username, presence: true, length: { minimum: 3, maximum: 50 }
+
+  before_save :normalize_email
+
+  private
+
+  def normalize_email
+    self.email = email.downcase.strip
+  end
+end
+
+# app/models/post.rb
+class Post < ApplicationRecord
+  belongs_to :user
+  has_many :comments, dependent: :destroy
+  has_many :taggings, dependent: :destroy
+  has_many :tags, through: :taggings
+
+  scope :published, -> { where(published: true) }
+  scope :recent, -> { order(created_at: :desc) }
+  scope :by_user, ->(user) { where(user: user) }
+
+  validates :title, presence: true, length: { maximum: 200 }
+  validates :body, presence: true
+end
+```
+
+## Query Optimization
+
+Prevent N+1 queries:
+
+```ruby
+# Bad - N+1 query
+@posts = Post.all
+@posts.each { |post| puts post.user.name }
+
+# Good - eager loading
+@posts = Post.includes(:user)
+@posts.each { |post| puts post.user.name }
+
+# Multiple associations
+@posts = Post.includes(:user, :comments, :tags)
+
+# Nested associations
+@posts = Post.includes(comments: :user)
+
+# Use joins when you don't need the associated records
+@posts = Post.joins(:user).where(users: { active: true })
+```
+
+Query scopes:
+
+```ruby
+class Post < ApplicationRecord
+  scope :published, -> { where(published: true) }
+  scope :recent, ->(limit = 10) { order(created_at: :desc).limit(limit) }
+  scope :by_tag, ->(tag) { joins(:tags).where(tags: { name: tag }) }
+  scope :search, ->(query) { where("title ILIKE ?", "%#{sanitize_sql_like(query)}%") }
+
+  # Class method for complex logic
+  def self.trending(days = 7)
+    where("created_at > ?", days.days.ago)
+      .joins(:comments)
+      .group(:id)
+      .order("COUNT(comments.id) DESC")
+  end
+end
+
+# Usage
+Post.published.recent(5)
+Post.by_tag("rails").search("hotwire")
+```
+
+## Advanced Queries
+
+```ruby
+# Select specific columns
+Post.select(:id, :title, :created_at)
+
+# Count and group
+User.joins(:posts).group(:id).count
+User.joins(:posts).group("users.id").select("users.*, COUNT(posts.id) as posts_count")
+
+# Pluck for arrays
+User.pluck(:email)
+User.pluck(:id, :email) # Returns array of arrays
+
+# Find by SQL
+Post.find_by_sql("SELECT * FROM posts WHERE title ILIKE '%rails%'")
+
+# Exists?
+Post.where(published: true).exists?
+
+# Batch processing
+User.find_each(batch_size: 1000) do |user|
+  user.process_something
+end
+```
+
+## Callbacks
+
+```ruby
+class User < ApplicationRecord
+  before_validation :normalize_email
+  after_validation :log_errors
+
+  before_create :generate_token
+  after_create :send_welcome_email
+
+  before_save :update_slug
+  after_save :clear_cache
+
+  before_destroy :cleanup_associations
+  after_destroy :log_deletion
+
+  # Avoid callbacks for business logic - use service objects instead
+
+  private
+
+  def normalize_email
+    self.email = email.downcase.strip if email.present?
+  end
+
+  def generate_token
+    self.token = SecureRandom.hex(32)
+  end
+end
+```
+
+## Validations
+
+```ruby
+class Article < ApplicationRecord
+  validates :title, presence: true, length: { minimum: 5, maximum: 200 }
+  validates :slug, uniqueness: { case_sensitive: false }
+  validates :published_at, comparison: { greater_than: Time.current }, if: :published?
+
+  validates :email, format: { with: URI::MailTo::EMAIL_REGEXP }
+  validates :age, numericality: { greater_than_or_equal_to: 18 }
+
+  validate :validate_future_date
+
+  private
+
+  def validate_future_date
+    if published_at.present? && published_at < Time.current
+      errors.add(:published_at, "must be in the future")
+    end
+  end
+end
+```
+
+## Migrations
+
+```ruby
+# db/migrate/20231214_create_posts.rb
+class CreatePosts < ActiveRecord::Migration[7.1]
+  def change
+    create_table :posts do |t|
+      t.string :title, null: false
+      t.text :body, null: false
+      t.boolean :published, default: false, null: false
+      t.references :user, null: false, foreign_key: true
+
+      t.timestamps
+    end
+
+    add_index :posts, :published
+    add_index :posts, [:user_id, :created_at]
+  end
+end
+
+# Adding columns
+class AddSlugToPosts < ActiveRecord::Migration[7.1]
+  def change
+    add_column :posts, :slug, :string
+    add_index :posts, :slug, unique: true
+  end
+end
+
+# Data migration
+class BackfillUsernames < ActiveRecord::Migration[7.1]
+  def up
+    User.where(username: nil).find_each do |user|
+      user.update_column(:username, "user_#{user.id}")
+    end
+  end
+
+  def down
+    # Usually not needed for data migrations
+  end
+end
+```
+
+## Concerns
+
+```ruby
+# app/models/concerns/sluggable.rb
+module Sluggable
+  extend ActiveSupport::Concern
+
+  included do
+    before_validation :generate_slug
+    validates :slug, presence: true, uniqueness: true
+  end
+
+  private
+
+  def generate_slug
+    self.slug ||= title.parameterize if title.present?
+  end
+end
+
+# Usage in model
+class Post < ApplicationRecord
+  include Sluggable
+end
+```
+
+## Performance Tips
+
+- Add database indexes for frequently queried columns
+- Use `counter_cache` for associations
+- Use `select` to limit columns returned
+- Use `pluck` instead of `map` for single attributes
+- Use `find_each` for batch processing large datasets
+- Use database views for complex queries
+- Consider materialized views for expensive aggregations