rails_rules 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ad3a7a8f20ef19b59318636327c5011cceabdbb3c8142f2903f8c38e9f22196b
-  data.tar.gz: 0ff5347624eb8571a9bb90ab5590f1e14a7353e4ed875e7a604a9b0a94637bb7
+  metadata.gz: a9be68c0ccba503fc0e42a71a14673463a20af8ffd94a914fb6102b5eb13262e
+  data.tar.gz: ea19c7d51efcca0cdeae7cb271eba93eb9a2be96c3d990d2202ba63855f1160c
 SHA512:
-  metadata.gz: 62b861c5be2529311b5cae394ce1657d4541e95acf6f3e38ad84854510abb2970923951477e3c805b8237733a53630a712532602cf9d45e401502ad0da4d5a06
-  data.tar.gz: cf701583412aaed050a585b23a2c8d027b78aec6b499ebe9e037d9b629b7ddc7a12635dd624ea8d1e094892d1017742278a203147b8f8a6f0bae12e2e513478e
+  metadata.gz: 526d14c32a134a30ba92f58277549b3f624892a96928b4b1e9249fcfef7b703e3d05b752c62d1b123e5e578a4b25fbfb194c3c08b0de124902abc27ce48597ac
+  data.tar.gz: 230209de40658d6ec600028ed9b3ef14382b2439edd0ff86df0f9f140bd1980e0785b6c85738de7ee8dcae5048a9c27f88180b793e3e316576e93eb7fd285974

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright Andy Waite
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -1,8 +1,10 @@
 # RailsRules
 
-# This is a placeholder - the gem does not yet have any functionality.
+This gem provides a set of [rules](https://docs.cursor.com/context/rules) files for working with AI tooling.
 
-This gem helps with creating and managing [rules](https://docs.cursor.com/context/rules) files for tools such as Cursor.
+At this early stage, the functionality is limited to creating `.cursor/rules` files for [Cursor](https://www.cursor.com).
+
+The rules files were originally created by [Kieran Klaassen](https://github.com/kieranklaassen) and contributed to [Jumpstart Pro Rails](jumpstartrails.com), and are reproduced with permission.
 
 ## Installation
 

data/Rakefile

@@ -1,10 +1,3 @@
-# frozen_string_literal: true
+require "bundler/setup"
 
 require "bundler/gem_tasks"
-require "minitest/test_task"
-
-Minitest::TestTask.create
-
-require "standard/rake"
-
-task default: %i[test standard]

data/lib/generators/default/USAGE

@@ -0,0 +1,7 @@
+Description:
+    Create rules files for AI tooling
+
+Example:
+    bin/rails generate rails_rules:default
+
+    This will create set of files within `.rules/cursor`.

data/lib/generators/rails_rules/default_generator.rb

@@ -0,0 +1,25 @@
+module RailsRules
+  class DefaultGenerator < Rails::Generators::Base
+    TARGET_PATH = ".cursor/rules"
+    source_root File.expand_path("templates", __dir__)
+    def create_rules_cursor_directory
+      empty_directory TARGET_PATH unless Dir.exist?(TARGET_PATH)
+    end
+
+    def copy_files
+      directory_path = "lib/generators/default/templates"
+      files = [
+        "000-cursor-rules.mdc",
+        "1000-rails-general.mdc",
+        "1001-rails-controllers.mdc",
+        "1002-rails-models.mdc",
+        "1003-rails-views.mdc",
+        "1004-javascript-stimulus.mdc",
+        "1005-service-objects.mdc",
+        "1006-testing.mdc",
+        "1007-tailwindcss.mdc"
+      ]
+      files.each { |file| copy_file file, File.join(TARGET_PATH, File.basename(file)) }
+    end
+  end
+end

data/lib/generators/rails_rules/templates/000-cursor-rules.mdc

@@ -0,0 +1,113 @@
+---
+description: Use ALWAYS when asked to CREATE A RULE or UPDATE A RULE or taught a lesson from the user that should be retained as a new rule for Cursor
+globs: [".cursor/rules/*.mdc"]
+---
+# Cursor Rules Format
+## Core Structure
+
+```mdc
+---
+description: ACTION when TRIGGER to OUTCOME
+globs: *.mdc
+---
+
+# Rule Title
+
+## Context
+- When to apply this rule
+- Prerequisites or conditions
+
+## Requirements
+- Concise, actionable items
+- Each requirement must be testable
+
+## Examples
+<example>
+Good concise example with explanation
+</example>
+
+<example type="invalid">
+Invalid concise example with explanation
+</example>
+```
+
+## File Organization
+
+### Location
+- Path: `.cursor/rules/`
+- Extension: `.mdc`
+
+### Naming Convention
+PREFIX-name.mdc where PREFIX is:
+- 0XX: Core standards
+- 1XX: Tool configs
+- 3XX: Testing standards
+- 1XXX: Language rules
+- 2XXX: Framework rules
+- 8XX: Workflows
+- 9XX: Templates
+- _name.mdc: Private rules
+
+### Glob Pattern Examples
+Common glob patterns for different rule types:
+- Core standards: .cursor/rules/*.mdc
+- Language rules: src/**/*.{js,ts}
+- Testing standards: **/*.test.{js,ts}
+- React components: src/components/**/*.tsx
+- Documentation: docs/**/*.md
+- Configuration files: *.config.{js,json}
+- Build artifacts: dist/**/*
+- Multiple extensions: src/**/*.{js,jsx,ts,tsx}
+- Multiple files: dist/**/*, docs/**/*.md
+
+## Required Fields
+
+### Frontmatter
+- description: ACTION TRIGGER OUTCOME format
+- globs: `glob pattern for files and folders`
+
+### Body
+- <version>X.Y.Z</version>
+- context: Usage conditions
+- requirements: Actionable items
+- examples: Both valid and invalid
+
+## Formatting Guidelines
+
+- Use Concise Markdown primarily
+- XML tags limited to:
+  - <example>
+  - <danger>
+  - <required>
+  - <rules>
+  - <rule>
+  - <critical>
+  - <version>
+- Always indent content within XML or nested XML tags by 2 spaces
+- Keep rules as short as possbile
+- Use Mermaid syntax if it will be shorter or clearer than describing a complex rule
+- Use Emojis where appropriate to convey meaning that will improve rule understanding by the AI Agent
+- Keep examples as short as possible to clearly convey the positive or negative example
+
+## AI Optimization Tips
+
+1. Use precise, deterministic ACTION TRIGGER OUTCOME format in descriptions
+2. Provide concise positive and negative example of rule application in practice
+3. Optimize for AI context window efficiency
+4. Remove any non-essential or redundant information
+5. Use standard glob patterns without quotes (e.g., *.js, src/**/*.ts)
+
+## AI Context Efficiency
+
+1. Keep frontmatter description under 120 characters (or less) while maintaining clear intent for rule selection by AI AGent
+2. Limit examples to essential patterns only
+3. Use hierarchical structure for quick parsing
+4. Remove redundant information across sections
+5. Maintain high information density with minimal tokens
+6. Focus on machine-actionable instructions over human explanations
+
+<critical>
+  - NEVER include verbose explanations or redundant context that increases AI token overhead
+  - Keep file as short and to the point as possible BUT NEVER at the expense of sacrificing rule impact and usefulness for the AI Agent.
+  - the front matter can ONLY have the fields description and globs.
+</critical>

data/lib/generators/rails_rules/templates/1000-rails-general.mdc

@@ -0,0 +1,87 @@
+---
+description: Follow general Rails 8.0 conventions and patterns
+globs: ["**/*.rb", "app/**/*.erb"]
+---
+
+# General Rails 8.0 Conventions
+
+## Context
+
+- In Ruby on Rails 8.0 application
+- Using modern Rails features and patterns
+- Follows Ruby style conventions
+
+## Requirements
+
+- Follow Ruby style guidelines (2 spaces for indentation, snake_case for variables/methods)
+- Use Service Objects for complex business logic
+- Use concerns for shared functionality
+- Use modules for namespacing and code organization
+- Use class Module::ClassName instead of nested module/class definitions
+- Add YARD documentation to methods and classes
+- Use positional arguments in enums and other Rails 8.0 features
+- Use credentials with Rails.application.credentials syntax
+- Pass models to jobs, not IDs (they'll be serialized automatically)
+- Use has_prefix_id for models with UUIDs
+- Use ActiveRecord conventions for database operations
+- Follow RESTful conventions for controllers
+- Use Tailwind CSS for styling views
+- Make all UI components responsive and support dark mode
+- Use Hotwire (Turbo, Stimulus) for JavaScript functionality
+- Ensure accessibility in all UI components
+
+## Examples
+
+<example>
+```ruby
+# Good - Using Rails 8.0 credentials
+api_key = Rails.application.credentials.anthropic[:api_key]
+
+# Good - Using Service Object
+
+user = CreateUserService.new(user_params).run
+
+# Good - Using positional arguments in enum
+
+class Article < ApplicationRecord enum status: [:draft, :published, :archived] end
+
+# Good - Class namespacing
+
+class Api::V1::UsersController < ApplicationController
+
+# ...
+
+end
+
+````
+</example>
+
+<example type="invalid">
+```ruby
+# Bad - Using outdated credentials pattern
+api_key = Rails.application.secrets.anthropic_api_key
+
+# Bad - Complex logic in controller
+def create
+  @user = User.new(user_params)
+  if @user.save
+    # Complex business logic here
+  end
+end
+
+# Bad - Using hash for enum
+class Article < ApplicationRecord
+  enum status: { draft: 0, published: 1, archived: 2 }
+end
+
+# Bad - Nested modules
+module Api
+  module V1
+    class UsersController < ApplicationController
+      # ...
+    end
+  end
+end
+````
+
+</example>

data/lib/generators/rails_rules/templates/1001-rails-controllers.mdc

@@ -0,0 +1,82 @@
+---
+description: Follow Rails 8.0 controller standards and patterns when creating or editing controllers
+globs: ["app/controllers/**/*.rb"]
+---
+
+# Rails Controller Standards
+
+## Context
+
+- In Ruby on Rails 8.0 controllers
+- Controllers should follow RESTful conventions
+- Comment style includes HTTP verb and path
+
+## Requirements
+
+- Add controller method comments with HTTP verb and full path
+- Use resource-based naming
+- Use before_action for common setup
+- Namespace API controllers under Api::V1
+- Use respond_to for format handling (HTML/JSON)
+- Use pagy for pagination: `@pagy, @resources = pagy(Resource.sort_by_params(params[:sort], sort_direction))`
+- Use `status: :see_other` for redirects after DELETE
+- Use `status: :unprocessable_entity` for failed creates/updates
+- Return 404 for records not found with `rescue ActiveRecord::RecordNotFound`
+- Use `params.expect(:resource)` instead of `params.require`
+- Include authentication callbacks where needed
+
+## Examples
+
+<example>
+```ruby
+class CategoriesController < ApplicationController
+  before_action :set_category, only: [:show, :edit, :update, :destroy]
+
+# GET /categories
+
+def index @pagy, @categories = pagy(Category.sort_by_params(params[:sort], sort_direction)) end
+
+# POST /categories
+
+def create @category = Category.new(category_params)
+
+    respond_to do |format|
+      if @category.save
+        format.html { redirect_to @category, notice: "Category was successfully created." }
+        format.json { render :show, status: :created, location: @category }
+      else
+        format.html { render :new, status: :unprocessable_entity }
+        format.json { render json: @category.errors, status: :unprocessable_entity }
+      end
+    end
+
+end
+
+private
+
+def set_category @category = Category.find(params.expect(:id)) rescue ActiveRecord::RecordNotFound redirect_to categories_path end
+
+def category_params params.expect(category: [:name, :description]) end end
+
+````
+</example>
+
+<example type="invalid">
+```ruby
+class CategoriesController < ApplicationController
+  def index
+    @categories = Category.all
+  end
+
+  def create
+    @category = Category.new(params.permit(:name, :description))
+    if @category.save
+      redirect_to @category
+    else
+      render :new
+    end
+  end
+end
+````
+
+</example>

data/lib/generators/rails_rules/templates/1002-rails-models.mdc

@@ -0,0 +1,105 @@
+---
+description: Follow Rails 8.0 model standards and patterns when creating or modifying models
+globs: ["app/models/**/*.rb"]
+---
+
+# Rails Model Standards
+
+## Context
+
+- In Ruby on Rails 8.0 models
+- Use modern Rails patterns like store_accessor, concerns, and modules
+- Add YARD documentation
+
+## Requirements
+
+- Add YARD documentation to all methods
+- Use positional arguments in enums
+- Include a separate module for specific roles, validations, or other functionality
+- Define constants at the top of the file
+- Use has_prefix_id for models with UUIDs
+- Use strong typing with attribute declarations
+- Use normalizes for attribute normalization
+- Include Searchable concern for models that need search
+- Use counter_cache for belongs_to relationships that need counts
+- Use store_accessor for models with JSON columns
+- Use acts_as_tenant for multi-tenant models
+- Include validation for uploaded files with resizable_image
+- Pass models to jobs, not IDs (they will be serialized)
+- Use strong typing in models with `attribute` declarations
+
+## Examples
+
+<example>
+```ruby
+# frozen_string_literal: true
+
+class Plan < ApplicationRecord has_prefix_id :plan
+
+INTERVALS = [:month, :year].freeze
+
+# Store JSON attributes in the details column
+
+# @return [Array<String>] List of features for this plan
+
+store_accessor :details, :features, :stripe_tax
+
+# Define default attributes
+
+attribute :currency, default: "usd"
+
+# Normalize attributes before saving
+
+normalizes :currency, with: ->(currency) { currency.downcase }
+
+# Validations
+
+validates :name, :amount, :interval, presence: true validates :currency, presence: true, format: {with: /\A[a-zA-Z]{3}\z/, message: "must be a 3-letter ISO currency code"} validates :interval, inclusion: INTERVALS validates :trial_period_days, numericality: {only_integer: true} validates :unit_label, presence: {if: :charge_per_unit?}
+
+# Scopes
+
+scope :hidden, -> { where(hidden: true) } scope :visible, -> { where(hidden: [nil, false]) } scope :monthly, -> { where(interval: :month) } scope :yearly, -> { where(interval: :year) } scope :sorted, -> { order(amount: :asc) }
+
+# Returns a list of features for this plan
+
+# @return [Array<String>] List of features
+
+def features Array.wrap(super) end
+
+# Checks if this plan has a trial period
+
+# @return [Boolean] True if the plan has a trial
+
+def has_trial? trial_period_days > 0 end
+
+# Checks if this plan is a monthly plan
+
+# @return [Boolean] True if the plan is monthly
+
+def monthly? interval == "month" end end
+
+````
+</example>
+
+<example type="invalid">
+```ruby
+class Plan < ApplicationRecord
+  def self.free
+    where(name: "Free").first_or_initialize
+  end
+
+  def features
+    super
+  end
+
+  def has_trial?
+    self.trial_period_days > 0
+  end
+
+  def self.get_all
+    all
+  end
+end
+````
+
+</example>

data/lib/generators/rails_rules/templates/1003-rails-views.mdc

@@ -0,0 +1,107 @@
+---
+description: Follow Rails 8.0 view standards with Tailwind CSS in ERB templates
+globs: ["app/views/**/*.html.erb"]
+---
+
+# Rails View Standards with Tailwind
+
+## Context
+
+- In Ruby on Rails 8.0 views
+- Using Tailwind CSS for styling
+- ERB templates with responsive design
+- Support for dark mode
+
+## Requirements
+
+- Always use Tailwind CSS classes for styling
+- Make all views responsive with breakpoints (sm:, md:, lg:, xl:, 2xl:)
+- Add dark mode support (dark: prefix for Tailwind classes)
+- For forms:
+  - Add autofocus: true on first input for new records
+  - Add asterisks (\*) for required fields
+  - Use HTML5 validation
+  - Use form-group, form-control classes
+  - For buttons use btn btn-primary, btn-small, btn-block, etc.
+  - Use f.button instead of f.submit
+  - Add proper disable_with for buttons showing loading state: disable_with: "Saving..."
+- Use content_for :title for page titles
+- For components like cards, alerts, navigation:
+  - Use corresponding Tailwind component classes
+- Use Turbo Stream for real-time updates
+- Use dom_id for HTML element IDs
+- Use partials for reusable components
+- Use proper spacing with Tailwind (mt-4, mb-4, py-2, etc.)
+- Implement proper aria attributes for accessibility
+
+## Examples
+
+<example>
+```erb
+<% content_for :title, "Edit Profile" %>
+
+<div class="container px-4 mx-auto my-8">
+  <div class="flex items-center justify-between mb-4">
+    <h1 class="h3">Edit Profile</h1>
+  </div>
+
+  <div class="p-8 bg-white dark:bg-gray-900 dark:border dark:border-gray-700 rounded shadow">
+    <%= form_with(model: @user, local: true) do |f| %>
+      <div class="form-group">
+        <%= f.label :name, "Name *" %>
+        <%= f.text_field :name, class: "form-control", autofocus: true, required: true %>
+      </div>
+
+      <div class="form-group">
+        <%= f.label :email, "Email *" %>
+        <%= f.email_field :email, class: "form-control", required: true %>
+      </div>
+
+      <div class="form-group">
+        <%= f.label :avatar %>
+        <div class="file-input-group">
+          <label for="avatar" class="btn btn-tertiary">
+            <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" fill="currentColor" class="w-5 h-5 mr-1">
+              <path fill-rule="evenodd" d="M1.5 6a2.25 2.25 0 0 1 2.25-2.25h16.5A2.25 2.25 0 0 1 22.5 6v12a2.25 2.25 0 0 1-2.25 2.25H3.75A2.25 2.25 0 0 1 1.5 18V6ZM3 16.06V18c0 .414.336.75.75.75h16.5A.75.75 0 0 0 21 18v-1.94l-2.69-2.689a1.5 1.5 0 0 0-2.12 0l-.88.879.97.97a.75.75 0 1 1-1.06 1.06l-5.16-5.159a1.5 1.5 0 0 0-2.12 0L3 16.061Zm10.125-7.81a1.125 1.125 0 1 1 2.25 0 1.125 1.125 0 0 1-2.25 0Z" clip-rule="evenodd" />
+            </svg>
+            <span>Upload Avatar</span>
+          </label>
+          <%= f.file_field :avatar, id: "avatar" %>
+        </div>
+      </div>
+
+      <div class="mt-6">
+        <%= f.button button_text("Save Changes", disable_with: "Saving..."), class: "btn btn-primary" %>
+      </div>
+    <% end %>
+
+  </div>
+</div>
+```
+</example>
+
+<example type="invalid">
+```erb
+<h1>Edit Profile</h1>
+
+<div>
+  <%= form_with(model: @user, local: true) do |f| %>
+    <div>
+      <%= f.label :name %>
+      <%= f.text_field :name %>
+    </div>
+
+    <div>
+      <%= f.label :email %>
+      <%= f.email_field :email %>
+    </div>
+
+    <div>
+      <%= f.submit "Save Changes" %>
+    </div>
+
+<% end %>
+
+</div>
+```
+</example>

data/lib/generators/rails_rules/templates/1004-javascript-stimulus.mdc

@@ -0,0 +1,90 @@
+---
+description: Follow JavaScript and Stimulus controller standards when creating or modifying JS files
+globs: ["app/javascript/**/*.js"]
+---
+
+# JavaScript and Stimulus Controller Standards
+
+## Context
+
+- In Ruby on Rails 8.0 JavaScript
+- Using Stimulus.js for interactive components
+- Using ES6 features
+- Using TailwindCSS Stimulus Components
+
+## Requirements
+
+- Use ES6 syntax (arrow functions, destructuring, etc.)
+- Add comments at the top of Stimulus controllers explaining their purpose and usage examples
+- Follow Stimulus controller naming conventions
+- Use data-controller, data-action, and data-[controller]-target attributes
+- Define static targets, values, and classes at the top of controller classes
+- Initialize connections in the connect() lifecycle method
+- Clean up resources in the disconnect() lifecycle method
+- Use the tailwindcss-stimulus-components library for common components:
+  - Alert, Dropdown, Modal, Tabs, Popover, Toggle, Slideover
+- Keep controller actions focused on a single responsibility
+- Use event delegation where appropriate
+- Document values properties with their types and defaults
+- Avoid DOM manipulation where possible, prefer toggling classes
+
+## Examples
+
+<example>
+```javascript
+// Example usage:
+// <div data-controller="tooltip" data-tooltip-content-value="Hello world"></div>
+
+import { Controller } from "@hotwired/stimulus" import { autoUpdate, autoPlacement, computePosition, offset, arrow } from "@floating-ui/dom"
+
+export default class extends Controller { // Define expected properties and their types static values = { content: String, placement: String, offset: { type: Number, default: 6 }, allowHtml: { type: Boolean, default: true } }
+
+// Initialize on connection connect() { this.createTooltipElements() this.cleanup = autoUpdate(this.element, this.tooltip, this.updatePosition.bind(this)) this.addEvents() }
+
+// Clean up resources on disconnect disconnect() { this.removeEvents() this.tooltip?.remove() this.cleanup?.() }
+
+// Creates DOM elements for the tooltip createTooltipElements() { this.tooltip = document.createElement("div") this.tooltip.className = "tooltip" this.tooltip.setAttribute("role", "tooltip")
+
+    this.tooltipContent = document.createElement("div")
+    this.tooltipContent.className = "tooltip-content"
+
+    this.tooltipArrow = document.createElement("div")
+    this.tooltipArrow.className = "tooltip-arrow"
+
+    this.tooltip.appendChild(this.tooltipContent)
+    this.tooltip.appendChild(this.tooltipArrow)
+    document.body.appendChild(this.tooltip)
+
+    this.updateContent()
+
+}
+
+// Updates tooltip content when content value changes contentValueChanged() { this.updateContent() } }
+
+````
+</example>
+
+<example type="invalid">
+```javascript
+import { Controller } from "@hotwired/stimulus"
+
+export default class extends Controller {
+  connect() {
+    var self = this
+    var tooltip = document.createElement("div")
+    tooltip.className = "tooltip"
+    tooltip.innerHTML = this.data.get("content")
+    document.body.appendChild(tooltip)
+
+    this.element.addEventListener("mouseenter", function() {
+      tooltip.style.display = "block"
+    })
+
+    this.element.addEventListener("mouseleave", function() {
+      tooltip.style.display = "none"
+    })
+  }
+}
+````
+
+</example>

data/lib/generators/rails_rules/templates/1005-service-objects.mdc

@@ -0,0 +1,129 @@
+---
+description: Follow service object standards when creating or modifying service classes
+globs: ["app/services/**/*.rb"]
+---
+
+# Service Object Standards
+
+## Context
+
+- In Ruby on Rails 8.0 service objects
+- Used to encapsulate business logic
+- Follows PORO (Plain Old Ruby Object) principles
+
+## Requirements
+
+- Create service objects in app/services directory
+- Name services with verb + noun format ending with "Service" (e.g., CreateUserService)
+- Use class Service::ClassName instead of nested module class
+- Use initialize method to accept parameters
+- Include YARD documentation for all methods
+- Implement a run (or call, perform, execute) method that performs the service's main action
+- Return a result object or the expected return value
+- Keep service objects focused on a single responsibility
+- Validate parameters in initialize or a separate validate method
+- Handle errors gracefully, either through exceptions or a result object
+- Make services testable with Minitest
+- Only modify state through explicit interfaces, not by relying on side effects
+
+## Examples
+
+<example>
+```ruby
+# frozen_string_literal: true
+
+# Service for creating a new user with account
+
+#
+
+# @example
+
+# service = CreateUserService.new(email: "test@example.com", name: "Test User")
+
+# user = service.run
+
+#
+
+class CreateUserService
+
+# Initialize the service with user attributes
+
+#
+
+# @param [Hash] attributes The user attributes
+
+# @option attributes [String] :email User's email
+
+# @option attributes [String] :name User's name
+
+# @option attributes [String] :password User's password
+
+def initialize(attributes) @attributes = attributes @account_name = attributes.delete(:account_name) || "My Account" end
+
+# Runs the service to create a user and account
+
+#
+
+# @return [User] The created user
+
+# @raise [ActiveRecord::RecordInvalid] If validation fails
+
+def run User.transaction do create_user create_account create_account_user end
+
+    @user
+
+end
+
+private
+
+# Creates a new user with the provided attributes
+
+#
+
+# @return [User] The new user
+
+def create_user @user = User.create!(@attributes) end
+
+# Creates a new account for the user
+
+#
+
+# @return [Account] The new account
+
+def create_account @account = Account.create!(name: @account_name, owner: @user) end
+
+# Creates the account user relationship
+
+#
+
+# @return [AccountUser] The account user relationship
+
+def create_account_user AccountUser.create!( account: @account, user: @user, admin: true ) end end
+
+````
+</example>
+
+<example type="invalid">
+```ruby
+module Services
+  module Users
+    class Create
+      def initialize(email, name, password)
+        @email = email
+        @name = name
+        @password = password
+      end
+
+      def call
+        user = User.new(email: @email, name: @name, password: @password)
+        user.save
+        account = Account.create(name: "My Account")
+        AccountUser.create(user: user, account: account)
+        return user
+      end
+    end
+  end
+end
+````
+
+</example>

data/lib/generators/rails_rules/templates/1006-testing.mdc

@@ -0,0 +1,71 @@
+---
+description: Follow testing standards when creating or modifying tests
+globs: ["test/**/*.rb"]
+---
+
+# Testing Standards
+
+## Context
+
+- In Ruby on Rails 8.0 test files
+- Using Minitest for testing
+- Tests should be thorough and maintainable
+
+## Requirements
+
+- Use Minitest for all tests
+- Write tests for models, controllers, services, and other components
+- Use fixtures for test data
+- Organize tests into appropriate test classes
+- Use descriptive test names with test\_ prefix (e.g., test_valid_user_can_login)
+- Use assertions that best match what you're testing
+- Keep tests focused on a single concern
+- Use setup/teardown methods for common setup code
+- Use test helpers for reusable test code
+- Test both happy and sad paths
+- Test edge cases and boundary conditions
+- Avoid testing the framework itself
+- Keep tests independent and idempotent
+- Don't pipe test output into cat (`bin/rails test` not `bin/rails test | cat`)
+
+## Examples
+
+<example>
+```ruby
+require "test_helper"
+
+class UserTest < ActiveSupport::TestCase setup do @user = users(:one) @account = accounts(:one) end
+
+test "valid user" do assert @user.valid? end
+
+test "invalid without email" do @user.email = nil refute @user.valid? assert_not_nil @user.errors[:email] end
+
+test "can be assigned to account" do account_user = AccountUser.new(user: @user, account: @account) assert account_user.valid? end
+
+test "can have admin role" do account_user = AccountUser.new(user: @user, account: @account, admin: true) assert account_user.admin? assert_includes account_user.active_roles, :admin end end
+
+````
+</example>
+
+<example type="invalid">
+```ruby
+require "test_helper"
+
+class UserTest < ActiveSupport::TestCase
+  def setup
+    @user = User.new(name: "Test User", email: "test@example.com")
+  end
+
+  def test_it_works
+    @user.save
+    assert_equal 1, User.count
+    User.all.each do |u|
+      assert u.valid?
+    end
+    @user.update(email: nil)
+    assert_equal false, @user.valid?
+  end
+end
+````
+
+</example>

data/lib/generators/rails_rules/templates/1007-tailwindcss.mdc

@@ -0,0 +1,204 @@
+---
+name: tailwind_v4
+description: Guide for using Tailwind CSS v4 instead of v3.x
+globs: ["**/*.{js,css,erb,rb}"]
+tags:
+  - tailwind
+  - css
+---
+
+# Tailwind CSS v4
+
+## Core Changes
+
+- **CSS-first configuration**: Configuration is now done in CSS instead of JavaScript
+  - Use `@theme` directive in CSS instead of `tailwind.config.js`
+  - Example:
+    ```css
+    @import "tailwindcss";
+
+    @theme {
+      --font-display: "Satoshi", "sans-serif";
+      --breakpoint-3xl: 1920px;
+      --color-avocado-500: oklch(0.84 0.18 117.33);
+      --ease-fluid: cubic-bezier(0.3, 0, 0, 1);
+    }
+    ```
+- Legacy `tailwind.config.js` files can still be imported using the `@config` directive:
+  ```css
+  @import "tailwindcss";
+  @config "../../tailwind.config.js";
+  ```
+- **CSS import syntax**: Use `@import "tailwindcss"` instead of `@tailwind` directives
+  - Old: `@tailwind base; @tailwind components; @tailwind utilities;`
+  - New: `@import "tailwindcss";`
+
+- **Package changes**:
+  - PostCSS plugin is now `@tailwindcss/postcss` (not `tailwindcss`)
+  - CLI is now `@tailwindcss/cli`
+  - Vite plugin is `@tailwindcss/vite`
+  - No need for `postcss-import` or `autoprefixer` anymore
+
+- **Native CSS cascade layers**: Uses real CSS `@layer` instead of Tailwind's custom implementation
+
+## Theme Configuration
+
+- **CSS theme variables**: All design tokens are available as CSS variables
+  - Namespace format: `--category-name` (e.g., `--color-blue-500`, `--font-sans`)
+  - Access in CSS: `var(--color-blue-500)`
+  - Available namespaces:
+    - `--color-*` : Color utilities like `bg-red-500` and `text-sky-300`
+    - `--font-*` : Font family utilities like `font-sans`
+    - `--text-*` : Font size utilities like `text-xl`
+    - `--font-weight-*` : Font weight utilities like `font-bold`
+    - `--tracking-*` : Letter spacing utilities like `tracking-wide`
+    - `--leading-*` : Line height utilities like `leading-tight`
+    - `--breakpoint-*` : Responsive breakpoint variants like `sm:*`
+    - `--container-*` : Container query variants like `@sm:*` and size utilities like `max-w-md`
+    - `--spacing-*` : Spacing and sizing utilities like `px-4` and `max-h-16`
+    - `--radius-*` : Border radius utilities like `rounded-sm`
+    - `--shadow-*` : Box shadow utilities like `shadow-md`
+    - `--inset-shadow-*` : Inset box shadow utilities like `inset-shadow-xs`
+    - `--drop-shadow-*` : Drop shadow filter utilities like `drop-shadow-md`
+    - `--blur-*` : Blur filter utilities like `blur-md`
+    - `--perspective-*` : Perspective utilities like `perspective-near`
+    - `--aspect-*` : Aspect ratio utilities like `aspect-video`
+    - `--ease-*` : Transition timing function utilities like `ease-out`
+    - `--animate-*` : Animation utilities like `animate-spin`
+  
+
+- **Simplified theme configuration**: Many utilities no longer need theme configuration
+  - Utilities like `grid-cols-12`, `z-40`, and `opacity-70` work without configuration
+  - Data attributes like `data-selected:opacity-100` don't need configuration
+
+- **Dynamic spacing scale**: Derived from a single spacing value
+  - Default: `--spacing: 0.25rem`
+  - Every multiple of the base value is available (e.g., `mt-21` works automatically)
+
+- **Overriding theme namespaces**:
+  - Override entire namespace: `--font-*: initial;`
+  - Override entire theme: `--*: initial;`
+
+
+## New Features
+
+- **Container query support**: Built-in now, no plugin needed
+  - `@container` for container context
+  - `@sm:`, `@md:`, etc. for container-based breakpoints
+  - `@max-md:` for max-width container queries
+  - Combine with `@min-md:@max-xl:hidden` for ranges
+
+- **3D transforms**:
+  - `transform-3d` enables 3D transforms
+  - `rotate-x-*`, `rotate-y-*`, `rotate-z-*` for 3D rotation
+  - `scale-z-*` for z-axis scaling
+  - `translate-z-*` for z-axis translation
+  - `perspective-*` utilities (`perspective-near`, `perspective-distant`, etc.)
+  - `perspective-origin-*` utilities
+  - `backface-visible` and `backface-hidden`
+
+- **Gradient enhancements**:
+  - Linear gradient angles: `bg-linear-45` (renamed from `bg-gradient-*`)
+  - Gradient interpolation: `bg-linear-to-r/oklch`, `bg-linear-to-r/srgb`
+  - Conic and radial gradients: `bg-conic`, `bg-radial-[at_25%_25%]`
+
+- **Shadow enhancements**:
+  - `inset-shadow-*` and `inset-ring-*` utilities
+  - Can be composed with regular `shadow-*` and `ring-*`
+
+- **New CSS property utilities**:
+  - `field-sizing-content` for auto-resizing textareas
+  - `scheme-light`, `scheme-dark` for `color-scheme` property
+  - `font-stretch-*` utilities for variable fonts
+
+## New Variants
+
+- **Composable variants**: Chain variants together
+  - Example: `group-has-data-potato:opacity-100`
+
+- **New variants**:
+  - `starting` variant for `@starting-style` transitions
+  - `not-*` variant for `:not()` pseudo-class
+  - `inert` variant for `inert` attribute
+  - `nth-*` variants (`nth-3:`, `nth-last-5:`, `nth-of-type-4:`, `nth-last-of-type-6:`)
+  - `in-*` variant (like `group-*` but without adding `group` class)
+  - `open` variant now supports `:popover-open`
+  - `**` variant for targeting all descendants
+
+## Custom Extensions
+
+- **Custom utilities**: Use `@utility` directive
+  ```css
+  @utility tab-4 {
+    tab-size: 4;
+  }
+  ```
+
+- **Custom variants**: Use `@variant` directive
+  ```css
+  @variant pointer-coarse (@media (pointer: coarse));
+  @variant theme-midnight (&:where([data-theme="midnight"] *));
+  ```
+
+- **Plugins**: Use `@plugin` directive
+  ```css
+  @plugin "@tailwindcss/typography";
+  ```
+
+## Breaking Changes
+
+- **Removed deprecated utilities**:
+  - `bg-opacity-*` → Use `bg-black/50` instead
+  - `text-opacity-*` → Use `text-black/50` instead
+  - And others: `border-opacity-*`, `divide-opacity-*`, etc.
+
+- **Renamed utilities**:
+  - `shadow-sm` → `shadow-xs` (and `shadow` → `shadow-sm`)
+  - `drop-shadow-sm` → `drop-shadow-xs` (and `drop-shadow` → `drop-shadow-sm`)
+  - `blur-sm` → `blur-xs` (and `blur` → `blur-sm`)
+  - `rounded-sm` → `rounded-xs` (and `rounded` → `rounded-sm`)
+  - `outline-none` → `outline-hidden` (for the old behavior)
+
+- **Default style changes**:
+  - Default border color is now `currentColor` (was `gray-200`)
+  - Default `ring` width is now 1px (was 3px)
+  - Placeholder text now uses current color at 50% opacity (was `gray-400`)
+  - Hover styles only apply on devices that support hover (`@media (hover: hover)`)
+
+- **Syntax changes**:
+  - CSS variables in arbitrary values: `bg-(--brand-color)` instead of `bg-[--brand-color]`
+  - Stacked variants now apply left-to-right (not right-to-left)
+  - Use CSS variables instead of `theme()` function 
+
+## Advanced Configuration
+
+- **Using a prefix**:
+  ```css
+  @import "tailwindcss" prefix(tw);
+  ```
+  - Results in classes like `tw:flex`, `tw:bg-red-500`, `tw:hover:bg-red-600`
+
+- **Source detection**:
+  - Automatic by default (ignores `.gitignore` files and binary files)
+  - Add sources: `@source "../node_modules/@my-company/ui-lib";`
+  - Disable automatic detection: `@import "tailwindcss" source(none);`
+
+- **Legacy config files**:
+  ```css
+  @import "tailwindcss";
+  @config "../../tailwind.config.js";
+  ```
+
+- **Dark mode configuration**:
+  ```css
+  @import "tailwindcss";
+  @variant dark (&:where(.dark, .dark *));
+  ```
+
+- **Container customization**: Extend with `@utility`
+  ```css
+  @utility container {
+    margin-inline: auto;
+    padding-inline: 2rem;
+  }
+  ```

data/lib/rails_rules/railtie.rb

@@ -0,0 +1,4 @@
+module RailsRules
+  class Railtie < ::Rails::Railtie
+  end
+end

data/lib/rails_rules/version.rb

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

data/lib/rails_rules.rb

@@ -1,8 +1,6 @@
-# frozen_string_literal: true
-
-require_relative "rails_rules/version"
+require "rails_rules/version"
+require "rails_rules/railtie"
 
 module RailsRules
-  class Error < StandardError; end
   # Your code goes here...
 end

data/lib/tasks/rails_rules_tasks.rake

@@ -0,0 +1,4 @@
+# desc "Explaining what the task does"
+# task :rails_rules do
+#   # Task goes here
+# end

metadata

@@ -1,27 +1,52 @@
 --- !ruby/object:Gem::Specification
 name: rails_rules
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Andy Waite
-bindir: exe
+bindir: bin
 cert_chain: []
 date: 2025-05-09 00:00:00.000000000 Z
-dependencies: []
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '7'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '7'
 email:
 - andyw8@users.noreply.github.com
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- ".standard.yml"
-- LICENSE.txt
+- MIT-LICENSE
 - README.md
 - Rakefile
+- lib/generators/default/USAGE
+- lib/generators/rails_rules/default_generator.rb
+- lib/generators/rails_rules/templates/000-cursor-rules.mdc
+- lib/generators/rails_rules/templates/1000-rails-general.mdc
+- lib/generators/rails_rules/templates/1001-rails-controllers.mdc
+- lib/generators/rails_rules/templates/1002-rails-models.mdc
+- lib/generators/rails_rules/templates/1003-rails-views.mdc
+- lib/generators/rails_rules/templates/1004-javascript-stimulus.mdc
+- lib/generators/rails_rules/templates/1005-service-objects.mdc
+- lib/generators/rails_rules/templates/1006-testing.mdc
+- lib/generators/rails_rules/templates/1007-tailwindcss.mdc
 - lib/rails_rules.rb
+- lib/rails_rules/railtie.rb
 - lib/rails_rules/version.rb
-- sig/rails_rules.rbs
+- lib/tasks/rails_rules_tasks.rake
 homepage: https://github.com/andyw8/rails_rules
 licenses:
 - MIT
@@ -36,7 +61,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 3.1.0
+      version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="

data/.standard.yml

@@ -1,3 +0,0 @@
-# For available configuration options, see:
-#   https://github.com/standardrb/standard
-ruby_version: 3.1

data/LICENSE.txt

@@ -1,21 +0,0 @@
-The MIT License (MIT)
-
-Copyright (c) 2025 Andy Waite
-
-Permission is hereby granted, free of charge, to any person obtaining a copy
-of this software and associated documentation files (the "Software"), to deal
-in the Software without restriction, including without limitation the rights
-to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-copies of the Software, and to permit persons to whom the Software is
-furnished to do so, subject to the following conditions:
-
-The above copyright notice and this permission notice shall be included in
-all copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
-THE SOFTWARE.

data/sig/rails_rules.rbs

@@ -1,4 +0,0 @@
-module RailsRules
-  VERSION: String
-  # See the writing guide of rbs: https://github.com/ruby/rbs#guides
-end