ask-solid_errors 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f5fc53842cb442db8d1ca3b2545515ad9d4763bcdeec8dc93c375f3901c2b12f
-  data.tar.gz: 9f024d03059f3c96864991ef633d9d98ef86808c569d5c21094804f3a6d420c5
+  metadata.gz: 9bc92f1121f81b6a0ed87e8e141a698a13257e12fa6306fbc564032b964c2b2c
+  data.tar.gz: f25b7fe3b53975150dd5880ca08f1c188b5d2f19d957414a87a186c26c521f82
 SHA512:
-  metadata.gz: 7f48fdce7fe85b1b43f74d9c6720e159541984a1f9ce8cf4855cfa9fecbf97302d12d5c355bab1110d850ea674b1537ee59bbbde7f6eaf7fe760f8cac12c1431
-  data.tar.gz: 34bd2e2cbcb8ba7049c09de62c5bd60c4fd9ad858b79afe1aa647af0cfe1f158765b7cb86189e46e47bf9b14e7d2b04567e07d54e5183c56232e1cf1f1ad44af
+  metadata.gz: 61aa60d118cd6f17e7604af52673b5f6e56d1606c31f65edce8145fe9d24e32f34c0c186e780aeb85559bc7e9daa3b6588586cf035bef7166a5703637c21da20
+  data.tar.gz: 4e5727509ea785da77c7bf989124cec2b1d6a11551fd2cc9536b80a35fc7be7fbf3d2d3a7f6800e3acd44cc2647442a122e4ffca95ae41510fdd2bfc46600a83

data/README.md

@@ -8,11 +8,52 @@ SolidErrors — error tracking stored in your Rails database
 gem "ask-solid_errors"
 ```
 
+## Prerequisites
+
+This gem requires the `solid_errors` gem to be installed and configured in your Rails app:
+
+```ruby
+gem "solid_errors"
+```
+
+Run the SolidErrors migration:
+
+```bash
+bin/rails solid_errors:install:migrations
+bin/rails db:migrate
+```
+
 ## Usage
 
 ```ruby
+# Recent errors
+errors = Ask::SolidErrors.recent(limit: 10)
+errors.map { |e| { id: e.id, class: e.exception_class, message: e.message.truncate(200) } }
+
+# Find by ID
+error = Ask::SolidErrors.find(42)
+error.backtrace
+error.context
+error.occurrences
+
+# Filter by status
+Ask::SolidErrors.unresolved   # errors needing attention
+Ask::SolidErrors.resolved     # previously resolved errors
+
+# Filter by class or severity
+Ask::SolidErrors.by_class("ActiveRecord::RecordNotFound")
+Ask::SolidErrors.by_severity("error")
+
+# Search messages
+Ask::SolidErrors.search("timeout")
+
+# Occurrence count
+Ask::SolidErrors.occurrence_count(error)
+Ask::SolidErrors.occurrence_count(42)
+
+# Low-level client for custom queries
 client = Ask::SolidErrors.client
-# ... use the client according to its API
+client.where(exception_class: "RuntimeError").order(created_at: :desc)
 ```
 
 ## Development

data/lib/ask/skills/solid_errors.use_solid_errors/SKILL.md

@@ -0,0 +1,88 @@
+---
+name: solid_errors.use_solid_errors
+description: How to navigate SolidErrors — query errors, occurrences, and backtraces in your Rails database
+---
+
+Use this skill when you need to review application errors stored in your Rails
+database via the SolidErrors engine.
+
+## Step 1: Understand the Difference
+
+Unlike other service gems, SolidErrors has **no external API** — errors are
+stored in your Rails database. `Ask::SolidErrors.client` returns a proxy
+to `ActiveRecord::Relation` objects from `SolidErrors::Error`.
+
+## Step 2: Explore the Context
+
+```ruby
+Ask::SolidErrors::Context::QUICK_START  # Query examples
+```
+
+## Step 3: Use Convenience Helpers
+
+The gem ships with helpers for common queries:
+
+```ruby
+# Most recent errors
+errors = Ask::SolidErrors.recent(limit: 10)
+
+# Find by ID with occurrences
+error = Ask::SolidErrors.find(id)
+puts error.exception_class
+puts error.message
+puts error.backtrace
+puts error.context
+
+# Unresolved errors
+unresolved = Ask::SolidErrors.unresolved
+
+# Resolved errors
+resolved = Ask::SolidErrors.resolved
+
+# Filter by exception class
+not_founds = Ask::SolidErrors.by_class("ActiveRecord::RecordNotFound")
+
+# Filter by severity
+warnings = Ask::SolidErrors.by_severity("warning")
+
+# Search by message text
+results = Ask::SolidErrors.search("timeout")
+```
+
+## Step 4: Chaining Queries like ActiveRecord
+
+Since the proxy returns `ActiveRecord::Relation` objects, you can chain:
+
+```ruby
+# Count
+Ask::SolidErrors.unresolved.count
+
+# Order and limit
+Ask::SolidErrors.by_class("NoMethodError").order(created_at: :desc).limit(5)
+
+# Get occurrences for a specific error
+error = Ask::SolidErrors.find(id)
+error.occurrences.each do |occ|
+  occ.parsed_backtrace.each do |trace_line|
+    puts "#{trace_line['file']}:#{trace_line['line_number']}"
+  end
+end
+```
+
+## Step 5: Common Issues
+
+- **Table doesn't exist**: Run `bin/rails solid_errors:install:migrations db:migrate`
+- **No database configured**: SolidErrors requires a Rails database connection
+- **No errors found**: The app may not have encountered errors yet, or the
+  table may be empty — check `Ask::SolidErrors.recent` first to confirm
+- **Occurrence details**: Each error has multiple occurrences (the same error
+  happening multiple times). Use `error.occurrences` to get individual events
+
+## Step 6: Fallback Strategy
+
+1. SolidErrors uses standard ActiveRecord — any valid ActiveRecord query works
+2. Call `Ask::SolidErrors.client.methods(false)` to see all available methods
+3. The underlying `SolidErrors::Error` model has columns like `exception_class`,
+   `message`, `severity`, `backtrace`, `context`, `created_at`
+4. For custom queries not covered by helpers, use `Ask::SolidErrors.client`
+   directly — it delegates to `SolidErrors::Error`

data/lib/ask/solid_errors/version.rb

@@ -2,6 +2,6 @@
 
 module Ask
   module SolidErrors
-    VERSION = "0.1.0"
+    VERSION = "0.1.1"
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: ask-solid_errors
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Kaka Ruto
@@ -75,6 +75,7 @@ files:
 - LICENSE
 - README.md
 - lib/ask-solid_errors.rb
+- lib/ask/skills/solid_errors.use_solid_errors/SKILL.md
 - lib/ask/solid_errors/client.rb
 - lib/ask/solid_errors/context.rb
 - lib/ask/solid_errors/error_guide.rb