ask-rails 0.2.0 → 0.2.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: e69600ee0def0363ad6aa80623bb2e6c160a5991bb8acf680a18d05eda8c9544
4
- data.tar.gz: 558d9750d94d02b7de5ab05fcfe8edef68c33f28c6f5a7adf4e0e659856cc0d0
3
+ metadata.gz: 5853a59ba85a4d0de9f171ddce9934c5928f45bbc3acc5f5c95940a6779b03d6
4
+ data.tar.gz: 5a65227d1e17a2525010c96dbb34b8e77ab0fe9a54b03ced8a9149b21880af90
5
5
  SHA512:
6
- metadata.gz: 40bc9bef781a02d9e020772846393ab0dcce0980b236739f532c87c06a7d7fd2fa24a13118d248a378236a2efc841cae130d61bcfc45230a02aac434626f743e
7
- data.tar.gz: 3916e3a64be0401e75ff9a00a6febc537aa4d930db9696da1491f18aa0e99d89674aea97b778d1a0c2ca3fe48199e35ba49ff63a11e812d501ddb12590cd173c
6
+ metadata.gz: 6123792315516dee1f33f6ea34586d40c8fb62e4b0c1981b892326d3eb1abc59757115f84b5cf242cad572bb31673b29aff9c92a036e6910e7af85b6a72d39ae
7
+ data.tar.gz: 801c37b5ab3969c36480814263d8a6373faca69f1d06cfa24bce21b53ac6ecd49a3989c2909626fb11ea233c99ecf7c4f66c259e8b5a8854e64197bef5ee9a16
@@ -21,7 +21,7 @@ module Ask
21
21
  )
22
22
  end
23
23
 
24
- if Rails.env.production? && !sql.match?(/\A\s*SELECT\b/i)
24
+ if ::Rails.env.production? && !sql.match?(/\A\s*SELECT\b/i)
25
25
  return Ask::Result.failure(
26
26
  "Only SELECT queries are allowed in the production environment."
27
27
  )
@@ -14,14 +14,14 @@ module Ask
14
14
 
15
15
  MAX_LINES = 500
16
16
  LEVEL_PATTERNS = {
17
- "ERROR" => /\bERROR\b/,
18
- "WARN" => /\bWARN\b/,
19
- "INFO" => /\bINFO\b/,
20
- "DEBUG" => /\bDEBUG\b/
17
+ "ERROR" => /\bERROR\b/i,
18
+ "WARN" => /\bWARN\b/i,
19
+ "INFO" => /\bINFO\b/i,
20
+ "DEBUG" => /\bDEBUG\b/i
21
21
  }.freeze
22
22
 
23
23
  def execute(lines: 50, level: nil, search: nil, file: nil)
24
- lines = [lines.to_i, MAX_LINES].min
24
+ max_lines = [lines.to_i, MAX_LINES].min
25
25
  log_path = resolve_log_path(file)
26
26
 
27
27
  unless log_path.exist?
@@ -30,13 +30,11 @@ module Ask
30
30
  )
31
31
  end
32
32
 
33
- content = read_tail(log_path, MAX_LINES * 2)
34
- return { lines: [], total_lines: 0, path: log_path.to_s } if content.empty?
35
-
36
- raw_lines = content.lines
33
+ raw_lines = read_all_log_files(log_path)
34
+ return { lines: [], total_lines: 0, path: log_path.to_s } if raw_lines.empty?
37
35
 
38
36
  filtered = apply_filters(raw_lines, level: level, search: search)
39
- recent = filtered.last(lines).map(&:chomp)
37
+ recent = filtered.last(max_lines).map(&:chomp)
40
38
 
41
39
  {
42
40
  lines: recent,
@@ -54,6 +52,43 @@ module Ask
54
52
  rails_root.join("log", "#{Rails.env}.log")
55
53
  end
56
54
 
55
+ # Read from rotated archives too: log/production.log, .1, .2.gz, etc.
56
+ def read_all_log_files(log_path)
57
+ all_content = +""
58
+ rotated_files(log_path).each do |path|
59
+ content = read_file_content(path)
60
+ all_content.prepend(content) if content
61
+ end
62
+ all_content.lines
63
+ end
64
+
65
+ def rotated_files(log_path)
66
+ dir = log_path.dirname
67
+ base = log_path.basename.to_s
68
+ # Primary file, then rotated files in reverse order (oldest first, then primary last)
69
+ pattern = File.join(dir, "#{base}.*")
70
+ rotations = Dir[pattern].sort_by { |f| extract_rotation_number(f) }
71
+ # Primary file is read last (most recent)
72
+ rotations + [log_path.to_s]
73
+ end
74
+
75
+ def extract_rotation_number(path)
76
+ File.basename(path).sub(/.*\.(\d+)(\.gz)?$/, '\1').to_i
77
+ rescue
78
+ 0
79
+ end
80
+
81
+ def read_file_content(path)
82
+ if path.to_s.end_with?(".gz")
83
+ Zlib::GzipReader.open(path.to_s) { |gz| gz.read }
84
+ else
85
+ File.read(path.to_s)
86
+ end
87
+ rescue => e
88
+ warn "[ReadLog] Could not read #{path}: #{e.message}"
89
+ nil
90
+ end
91
+
57
92
  def read_tail(path, max_bytes)
58
93
  return "" unless path.exist?
59
94
 
@@ -73,7 +108,7 @@ module Ask
73
108
 
74
109
  def apply_filters(lines, level: nil, search: nil)
75
110
  filtered = lines
76
- filtered = filtered.select { |l| LEVEL_PATTERNS.fetch(level) { |_| // }.match?(l) } if level
111
+ filtered = filtered.select { |l| LEVEL_PATTERNS.fetch(level) { // }.match?(l) } if level
77
112
  filtered = filtered.select { |l| l.downcase.include?(search.downcase) } if search
78
113
  filtered
79
114
  end
@@ -8,7 +8,7 @@ module Ask
8
8
  "scopes, and indexes. Returns structured data the agent can act on."
9
9
 
10
10
  param :name, type: :string, desc: "Model class name (e.g. 'User', 'Blog::Post')", required: true
11
- param :detail, type: :string, desc: "Which details: 'all' (default), 'columns', 'associations', 'validations'", required: false
11
+ param :detail, type: :string, desc: "Which details: 'all' (default), 'columns', 'associations', 'validations', 'scopes'", required: false
12
12
 
13
13
  def execute(name:, detail: "all")
14
14
  klass = safe_constantize(name)
@@ -38,6 +38,12 @@ module Ask
38
38
  }
39
39
  end
40
40
 
41
+ if %w[all scopes].include?(detail) && klass.respond_to?(:all)
42
+ result[:scopes] = klass.methods(false)
43
+ .reject { |m| m.to_s.end_with?("=", "!", "?") || %i[new allocate inspect to_s].include?(m) }
44
+ .map(&:to_s).sort
45
+ end
46
+
41
47
  if %w[all validations].include?(detail)
42
48
  result[:validators] = klass.validators.map { |v|
43
49
  {
@@ -2,6 +2,6 @@
2
2
 
3
3
  module Ask
4
4
  module Rails
5
- VERSION = "0.2.0"
5
+ VERSION = "0.2.1"
6
6
  end
7
7
  end
@@ -0,0 +1,118 @@
1
+ ---
2
+ name: rails.db_debug
3
+ description: Step-by-step methodology for debugging database performance issues in Rails
4
+ ---
5
+
6
+ Use this skill when investigating slow queries, N+1 problems, missing indexes, or
7
+ general database performance issues in a Rails application.
8
+
9
+ ## Step 1: Identify the Slow Queries
10
+
11
+ Use `ReadLog.new.call(lines: 200, search: "SELECT")` to find recent database
12
+ queries in the application log. Look for:
13
+
14
+ - Queries taking > 100ms (look for "duration:" or "↳" markers in Rails logs)
15
+ - Repetitive queries with the same structure (potential N+1)
16
+ - Queries running in loops (same query, different IDs)
17
+
18
+ If you need more detail, narrow the search: `ReadLog.new.call(lines: 500, level: "WARN")`.
19
+
20
+ ## Step 2: Understand the Schema
21
+
22
+ For each model involved in the slow queries, inspect it:
23
+
24
+ ```ruby
25
+ ReadModel.new.call(name: "User")
26
+ ReadModel.new.call(name: "Post")
27
+ ```
28
+
29
+ Focus on:
30
+ - **Columns** — are there columns that look like foreign keys without indexes?
31
+ - **Associations** — what associations exist and what `class_name` do they use?
32
+ - **Validators** — any database-level constraints that could be missing?
33
+
34
+ Run `ReadModel.new.call(name: "User", detail: "columns")` if you only need columns.
35
+
36
+ ## Step 3: Check for Missing Indexes
37
+
38
+ Query the database for actual indexes:
39
+
40
+ ```ruby
41
+ QueryDatabase.new.call(
42
+ sql: "SELECT tablename, indexname, indexdef FROM pg_indexes WHERE schemaname = 'public' ORDER BY tablename, indexname",
43
+ limit: 200
44
+ )
45
+ ```
46
+
47
+ Look for:
48
+ - Foreign key columns that lack indexes (e.g. `user_id` without index)
49
+ - Columns used in `WHERE` clauses without indexes
50
+ - Composite indexes that could cover multiple query patterns
51
+
52
+ If an index is missing, check if adding one would help:
53
+ ```ruby
54
+ QueryDatabase.new.call(
55
+ sql: "EXPLAIN ANALYZE SELECT * FROM posts WHERE user_id = 1",
56
+ limit: 10
57
+ )
58
+ ```
59
+
60
+ ## Step 4: Detect N+1 Queries
61
+
62
+ N+1 manifests as the same query repeated with different IDs:
63
+
64
+ ```ruby
65
+ # Search for repetitive query patterns
66
+ ReadLog.new.call(lines: 500, search: "WHERE.*IN")
67
+ ```
68
+
69
+ Common N+1 patterns:
70
+ - Loading `Post.all` then accessing `post.comments` individually
71
+ - Loading `User.all` then accessing `user.profile` individually
72
+ - Serializing associations in views without eager loading
73
+
74
+ Fix with `.includes(:association)`, `.eager_load(:association)`, or
75
+ `.preload(:association)`.
76
+
77
+ ## Step 5: Profile Slow Queries with EXPLAIN
78
+
79
+ For any identified slow query, get the execution plan:
80
+
81
+ ```ruby
82
+ QueryDatabase.new.call(
83
+ sql: "EXPLAIN (ANALYZE, BUFFERS) SELECT posts.* FROM posts WHERE posts.user_id = 1 ORDER BY posts.created_at DESC LIMIT 20",
84
+ limit: 10
85
+ )
86
+ ```
87
+
88
+ What to look for in explain output:
89
+ - **Sequential scans** (`Seq Scan`) — missing index
90
+ - **Sort operations** — missing index on sort column
91
+ - **Nested loop joins** with high row counts — missing composite index
92
+ - **Bitmap heap scans** with high costs — index may be suboptimal
93
+
94
+ If `ANALYZE` takes too long, use `EXPLAIN (BUFFERS)` without `ANALYZE` for cost estimates.
95
+
96
+ ## Step 6: Check Bulk Loading and Batch Operations
97
+
98
+ If the issue involves importing or updating many records:
99
+
100
+ ```ruby
101
+ QueryDatabase.new.call(
102
+ sql: "SELECT schemaname, tablename, seq_scan, seq_tup_read, idx_scan, idx_tup_fetch FROM pg_stat_user_tables ORDER BY seq_scan DESC",
103
+ limit: 20
104
+ )
105
+ ```
106
+
107
+ High `seq_scan` counts compared to `idx_scan` indicate tables where indexes
108
+ are missing and sequential scans are happening frequently.
109
+
110
+ ## Failure Mode Guide
111
+
112
+ | Symptom | Likely Cause | Action |
113
+ |---------|-------------|--------|
114
+ | Query takes >1s | Missing index on WHERE column | Check pg_indexes, add index |
115
+ | Same query 50x in log | N+1 in controller/view | Add `.includes()` |
116
+ | Query slow AFTER adding index | Wrong index type or order | Verify index column order matches query |
117
+ | `EXPLAIN ANALYZE` hanging | Table lock or very large table | Use `EXPLAIN (BUFFERS)` without ANALYZE |
118
+ | Missing `pg_indexes` output | Not Postgres | Use `SHOW INDEX FROM <table>` for MySQL |
@@ -0,0 +1,125 @@
1
+ ---
2
+ name: rails.deploy_pipeline
3
+ description: Pre-deployment checklist for Rails applications — migrations, assets, credentials, jobs, and logs
4
+ ---
5
+
6
+ Use this skill before or during a Rails deployment to ensure nothing is missed.
7
+ Follow the steps in order — each builds on the previous.
8
+
9
+ ## Step 1: Check Pending Migrations
10
+
11
+ Before deploying, always check for unapplied migrations:
12
+
13
+ ```ruby
14
+ RunCommand.new.call(command: "bin/rails db:migrate:status | grep 'down'")
15
+ ```
16
+
17
+ If there are pending migrations:
18
+ 1. Review them with `ReadFile.new.call(path: "db/migrate/<TIMESTAMP>_migration_name.rb")`
19
+ 2. Verify they're reversible: check `change`, `up`/`down`, or `reversible` blocks
20
+ 3. Check for data migrations (e.g., backfills) that should run separately
21
+ 4. Estimate execution time — large tables may need locking strategy
22
+
23
+ ## Step 2: Verify Assets Pipeline
24
+
25
+ For Rails with assets (Sprockets or Propshaft):
26
+
27
+ ```ruby
28
+ # Precompile locally to catch errors early
29
+ RunCommand.new.call(command: "bin/rails assets:precompile 2>&1")
30
+ ```
31
+
32
+ Check for:
33
+ - Missing asset references (SCSS variables, image references)
34
+ - JavaScript compilation errors
35
+ - Asset fingerprint changes (manifold fingerprints if CSS changed)
36
+
37
+ For importmap or esbuild/vite setups:
38
+
39
+ ```ruby
40
+ # Check build config
41
+ ReadFile.new.call(path: "package.json")
42
+ ReadFile.new.call(path: "vite.config.ts") if File.exist?("Rails.root.join('vite.config.ts')")
43
+ ```
44
+
45
+ ## Step 3: Review Credentials and Secrets
46
+
47
+ Verify that all required credentials exist in the target environment:
48
+
49
+ ```ruby
50
+ # For production credentials
51
+ RunCommand.new.call(command: "bin/rails credentials:show --environment production 2>&1")
52
+ ```
53
+
54
+ Check for common secrets that may need updating:
55
+ - `secret_key_base`
56
+ - `database_password`
57
+ - Third-party API keys (AWS, Stripe, SendGrid, etc.)
58
+ - JWT signing keys
59
+ - Any env vars referenced in `config/` files that aren't in credentials
60
+
61
+ ## Step 4: Check Background Jobs
62
+
63
+ Review sidekiq/active job configuration before deploy:
64
+
65
+ ```ruby
66
+ # Check job files for any that need queue configuration
67
+ Glob.new.call(pattern: "app/jobs/**/*.rb")
68
+ ```
69
+
70
+ For any new or modified jobs:
71
+ 1. Verify the queue adapter is configured in `production.rb`
72
+ 2. Check for job retry logic that might affect rollback
73
+ 3. Review `ReadFile.new.call(path: "config/sidekiq.yml")` if using Sidekiq
74
+ 4. Verify scheduled/cron jobs if using `sidekiq-cron` or `whenever`
75
+
76
+ ## Step 5: Review Production Log for Pre-deploy Issues
77
+
78
+ Check that the current production environment is healthy before deploying:
79
+
80
+ ```ruby
81
+ ReadLog.new.call(lines: 100, level: "ERROR")
82
+ ```
83
+
84
+ If there are recent errors, investigate before deploying more changes.
85
+
86
+ ## Step 6: Verify Dependencies and Gem Versions
87
+
88
+ Check for critical gem updates or changes:
89
+
90
+ ```ruby
91
+ # Review Gemfile for new/modified gems
92
+ RunCommand.new.call(command: "git diff HEAD -- Gemfile")
93
+ ```
94
+
95
+ If adding a gem that needs system dependencies or native extensions:
96
+ ```ruby
97
+ RunCommand.new.call(command: "bundle platform")
98
+ ```
99
+
100
+ ## Step 7: Config File Checklist
101
+
102
+ Verify configuration files for the target environment:
103
+
104
+ ```ruby
105
+ ReadFile.new.call(path: "config/environments/production.rb")
106
+ ReadFile.new.call(path: "config/database.yml")
107
+ ReadFile.new.call(path: "config/cable.yml") if File.exist?("config/cable.yml")
108
+ ReadFile.new.call(path: "config/storage.yml") if File.exist?("config/storage.yml")
109
+ ```
110
+
111
+ Key production checks:
112
+ - `config.force_ssl = true`
113
+ - `config.consider_all_requests_local = false`
114
+ - Proper cache store configured (`:mem_cache_store`, `:redis_cache_store`)
115
+ - Active Storage service configured for production
116
+
117
+ ## Step 8: Quick Rollback Checklist
118
+
119
+ Before deploying, know how to roll back:
120
+
121
+ 1. **Database**: `RunCommand.new.call(command: "bin/rails db:migrate:down VERSION=<previous>")`
122
+ 2. **Code**: Git revert the deploy commit
123
+ 3. **Assets**: Previous version's assets should still be cached
124
+ 4. **Jobs**: Check if backward-incompatible changes won't replay failed jobs
125
+ 5. **Feature flags**: If using flipper or similar, toggle off new features first
@@ -0,0 +1,127 @@
1
+ ---
2
+ name: rails.route_trouble
3
+ description: Step-by-step methodology for debugging routing issues in Rails
4
+ ---
5
+
6
+ Use this skill when a route is returning 404, you're getting route matching errors,
7
+ or routes aren't behaving as expected in a Rails application.
8
+
9
+ ## Step 1: Read the Routes File
10
+
11
+ Start by examining the routes configuration:
12
+
13
+ ```ruby
14
+ ReadRoutes.new.call
15
+ ```
16
+
17
+ This reads `config/routes.rb` — the source of truth for all route definitions.
18
+
19
+ Look for:
20
+ - The overall structure (namespaced, nested, shallow routes?)
21
+ - Resources that might be missing
22
+ - Constraints or conditions that could block matching
23
+ - Route ordering (more specific routes should come before less specific)
24
+
25
+ ## Step 2: Check the Compiled Routes
26
+
27
+ Rails routes have a specific matching order. Use `RunCommand` to inspect the live routes:
28
+
29
+ ```ruby
30
+ RunCommand.new.call(command: "bin/rails routes")
31
+ ```
32
+
33
+ If you know the path you're trying to match, grep for it:
34
+
35
+ ```ruby
36
+ RunCommand.new.call(command: "bin/rails routes | grep users")
37
+ ```
38
+
39
+ For a specific route name:
40
+
41
+ ```ruby
42
+ RunCommand.new.call(command: "bin/rails routes --grep user_profile")
43
+ ```
44
+
45
+ ## Step 3: Check Route Parameters and Constraints
46
+
47
+ Routes often fail because of parameter mismatches or constraints. Check for:
48
+
49
+ **Required parameters:** Does the route define `:id` but the URL doesn't include it?
50
+
51
+ **Format constraints:** Routes with `:format` (like `.json`, `.html`) constraints
52
+ can fail silently. Check if there's a default format:
53
+
54
+ ```ruby
55
+ # In routes.rb:
56
+ resources :posts, defaults: { format: :json }
57
+ ```
58
+
59
+ **Constraint classes:** Custom route constraints like `subdomain` or request-based
60
+ constraints can prevent matching:
61
+
62
+ ```ruby
63
+ # In routes.rb:
64
+ get "admin", to: "admin/dashboard#show", constraints: ->(req) { req.subdomain == "admin" }
65
+ ```
66
+
67
+ Check the constraints against the actual request parameters.
68
+
69
+ ## Step 4: Trace the Match
70
+
71
+ For a failing request, trace how Rails would match it:
72
+
73
+ ```ruby
74
+ RunCommand.new.call(
75
+ command: "bin/rails runner \"puts Rails.application.routes.recognize_path('/users/1/edit', method: :get)\""
76
+ )
77
+ ```
78
+
79
+ This will raise `ActionController::RoutingError` if no route matches — the
80
+ error message tells you what routes were tried before failing.
81
+
82
+ If the route exists but the controller isn't found:
83
+
84
+ ```ruby
85
+ ReadFile.new.call(path: "app/controllers/users_controller.rb")
86
+ ```
87
+
88
+ ## Step 5: Check Namespace and Module Nesting
89
+
90
+ Routes in namespaced controllers fail when the controller file is in the wrong
91
+ directory or the module is misnamed:
92
+
93
+ ```ruby
94
+ # Route:
95
+ namespace :admin do
96
+ resources :users
97
+ end
98
+
99
+ # Expects:
100
+ # app/controllers/admin/users_controller.rb
101
+ # class Admin::UsersController < ApplicationController
102
+ ```
103
+
104
+ Use `Glob` to verify the controller exists:
105
+
106
+ ```ruby
107
+ # Via RunCommand:
108
+ RunCommand.new.call(command: "ls app/controllers/admin/")
109
+ ```
110
+
111
+ ## Step 6: Verify Helper Paths and Named Routes
112
+
113
+ If you're debugging a `No route matches` error from a view (link_to, form_with):
114
+
115
+ 1. Check the route name: `RunCommand.new.call(command: "bin/rails routes | grep user_path")`
116
+ 2. Verify the route helper: `RunCommand.new.call(command: "bin/rails routes --grep user")`
117
+ 3. Check for route helper overrides in custom constraints or defaults
118
+
119
+ ## Failure Mode Guide
120
+
121
+ | Symptom | Likely Cause | Action |
122
+ |---------|-------------|--------|
123
+ | 404 for existing route | Route constraint blocking | Check `constraints:` block in routes.rb |
124
+ | `No route matches` | Missing resource definition | Add `resources :model_name` |
125
+ | Route works in dev, not prod | Different route ordering | Check routes file isn't conditionally loaded |
126
+ | `Missing controller` | Wrong namespace or filename | Verify file path matches module structure |
127
+ | Path helper not responding | Wrong route name or params mismatch | Check `bin/rails routes --grep helper_name` |
metadata CHANGED
@@ -1,7 +1,7 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: ask-rails
3
3
  version: !ruby/object:Gem::Version
4
- version: 0.2.0
4
+ version: 0.2.1
5
5
  platform: ruby
6
6
  authors:
7
7
  - Kaka Ruto
@@ -160,6 +160,9 @@ files:
160
160
  - lib/ask/rails/tools/run_command.rb
161
161
  - lib/ask/rails/tools/search_codebase.rb
162
162
  - lib/ask/rails/version.rb
163
+ - lib/ask/skills/rails.db_debug/SKILL.md
164
+ - lib/ask/skills/rails.deploy_pipeline/SKILL.md
165
+ - lib/ask/skills/rails.route_trouble/SKILL.md
163
166
  - lib/generators/ask/rails/install/install_generator.rb
164
167
  - lib/generators/ask/rails/install/templates/initializer.rb
165
168
  - lib/generators/ask/rails/install/templates/migration.rb