error_radar 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 017c3eb241a062270368e74bf4a38e52caaf303ddfdc1848c3e1f88d0ea8219a
-  data.tar.gz: '08d6b0982d7cfae71bdde4c466948b0091e1c000091030a8c6c5507139c32136'
+  metadata.gz: 2914a57eb370a3b003c69d8ab3e9899826dade79b35f62bffc97e8fed40748bf
+  data.tar.gz: f0f0772a121489558626b8780c1d10f3d1d08fb1e71b067c0a422c5da5eab709
 SHA512:
-  metadata.gz: 887a6d150b9e3bbcade9f208f80b0ef89755b229716cf1d2798bd72fb1feb4b13a8feb480178fda95bf36e9b291426895066e5043ea22a48ac830f86887d8de6
-  data.tar.gz: 67e779feaef2bafc575a3aa6b52c1d8af20e907d22edc1b4e769a5cab6a88969984503b74c9a1f6df70b51367d98ed5d7cb254b2ea405741bef4c09600057179
+  metadata.gz: e9ddda42dc56d8512da27db0fa371639b08925af149200fd4a016904eb2fdc2ee8fc7d4febb5b008db2b1f3e3b689acda1c068c1883d55f38fa833201346cb12
+  data.tar.gz: e76130935b55369dbb16d839a3d4e29fbe6c2cb28390915ffc43cee00bd8bb9c5ebc1585cecbbd656cfaf2a22d91465eb41e8529ee17ba91fae86023cf89563d

data/CHANGELOG.md

@@ -2,6 +2,20 @@
 
 All notable changes to this project will be documented in this file.
 
+## [0.2.0] - 2026-07-02
+
+### Added
+- Host-configurable error categories. The `category` enum is no longer fixed:
+  register app-specific categories with `config.register_category(:name, int)`
+  or replace the map with `config.categories = {...}` (built-in defaults are
+  merged in first). Stored integers are treated as a schema and must stay
+  stable once data exists.
+
+### Notes
+- Backward compatible: with no configuration the six built-in categories
+  (`application`, `external_api`, `background_job`, `syntax`, `database`,
+  `network`) behave exactly as in 0.1.0.
+
 ## [0.1.0] - 2026-06-18
 
 ### Added

data/README.md

@@ -65,6 +65,26 @@ ErrorRadar.configure do |config|
 end
 ```
 
+### Custom categories
+
+The `category` enum ships with six built-ins — `application`, `external_api`,
+`background_job`, `syntax`, `database`, `network` — but is **not fixed**. Register
+your own without touching the gem:
+
+```ruby
+ErrorRadar.configure do |config|
+  config.register_category(:instagram_api, 6)   # add one
+  # or replace the whole map (defaults are merged in first):
+  config.categories = { instagram_api: 6, payments_api: 7 }
+end
+```
+
+The integer is the value stored in the `category` column, so treat it as a
+schema: keep it stable once you have data, and don't reuse a number for two
+names (a collision raises at boot). Custom categories work everywhere a built-in
+does — `capture`/`notify` calls, the `categorize` rules, the dashboard charts
+and the RailsAdmin board.
+
 ## Use
 
 ```ruby

data/app/models/error_radar/error_log.rb

@@ -6,14 +6,11 @@ module ErrorRadar
   # One row per distinct failure (collapsed by fingerprint). Doubles as a task
   # on the triage board. Table: error_radar_error_logs.
   class ErrorLog < ApplicationRecord
-    enum category: {
-      application:  0, # generic Ruby/Rails runtime error
-      external_api: 1, # any 3rd-party API error
-      background_job: 2, # uncategorised background-job failure
-      syntax:       3, # SyntaxError / NameError / NoMethodError / ArgumentError / TypeError
-      database:     4, # ActiveRecord / DB level
-      network:      5  # timeouts, connection resets, DNS, ...
-    }, _prefix: :category
+    # Category map is host-configurable (built-in defaults + anything the app
+    # registers via ErrorRadar.config). Read at class-load, which happens after
+    # the host's initializer has run `ErrorRadar.configure`, so custom
+    # categories are already merged in. See ErrorRadar::Configuration.
+    enum category: ErrorRadar.config.categories, _prefix: :category
 
     enum severity: { info: 0, warning: 1, error: 2, critical: 3 }, _prefix: :severity
 

data/lib/error_radar/configuration.rb

@@ -4,6 +4,17 @@ module ErrorRadar
   # Holds every host-app-specific decision so the engine stays decoupled.
   # Configure from an initializer (see the install generator's template).
   class Configuration
+    # Built-in categories (name => stored integer). Hosts can override the whole
+    # map (`config.categories = {...}`) or add their own (`register_category`).
+    DEFAULT_CATEGORIES = {
+      application:    0, # generic Ruby/Rails runtime error
+      external_api:   1, # any 3rd-party API error
+      background_job: 2, # uncategorised background-job failure
+      syntax:         3, # SyntaxError / NameError / NoMethodError / ArgumentError / TypeError
+      database:       4, # ActiveRecord / DB level
+      network:        5  # timeouts, connection resets, DNS, ...
+    }.freeze
+
     # Master switch — set false (e.g. in test env) to make capture a no-op.
     attr_accessor :enabled
 
@@ -43,6 +54,11 @@ module ErrorRadar
     # `->(controller) { "who@acted" }` — stamped onto resolved errors.
     attr_accessor :current_user
 
+    # The category name => integer map backing ErrorLog's `category` enum.
+    # Read-only accessor; mutate through `categories=` or `register_category`
+    # so the built-in defaults are always preserved.
+    attr_reader :categories
+
     def initialize
       @enabled            = true
       @backtrace_lines    = 30
@@ -65,6 +81,32 @@ module ErrorRadar
       @expected_servers   = []
       @authenticate       = nil
       @current_user       = nil
+      @categories         = DEFAULT_CATEGORIES.dup
+    end
+
+    # Replace the category map. The built-in defaults are merged in first, so a
+    # host only needs to list what it adds or renumbers:
+    #   config.categories = { instagram_api: 6, background_job: 7 }
+    # Stored integers must stay stable once data exists — treat them as a schema.
+    def categories=(hash)
+      merged = DEFAULT_CATEGORIES.merge(hash.transform_keys(&:to_sym))
+      assert_unique_values!(merged)
+      @categories = merged
+    end
+
+    # Add a single custom category without disturbing the rest:
+    #   config.register_category(:instagram_api, 6)
+    def register_category(name, value)
+      name = name.to_sym
+      value = Integer(value)
+      if @categories[name] && @categories[name] != value
+        raise ArgumentError, "category #{name.inspect} already mapped to #{@categories[name]}"
+      end
+      existing = @categories.key(value)
+      if existing && existing != name
+        raise ArgumentError, "category value #{value} already used by #{existing.inspect}"
+      end
+      @categories = @categories.merge(name => value)
     end
 
     # Convenience DSL inside `configure`:
@@ -77,5 +119,14 @@ module ErrorRadar
     def extract_details(&block)
       @detail_extractors << block
     end
+
+    private
+
+    def assert_unique_values!(map)
+      dupes = map.values.tally.select { |_, n| n > 1 }.keys
+      return if dupes.empty?
+
+      raise ArgumentError, "category values must be unique; collisions on #{dupes.inspect}"
+    end
   end
 end

data/lib/error_radar/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module ErrorRadar
-  VERSION = '0.1.0'
+  VERSION = '0.2.0'
 end

data/lib/generators/error_radar/install/templates/initializer.rb

@@ -17,6 +17,15 @@ ErrorRadar.configure do |config|
   # config.authenticate = ->(controller) { controller.send(:authenticate_admin!) }
   # config.current_user = ->(controller) { controller.current_admin&.email }
 
+  # --- Custom categories (optional) ---
+  # Built-in categories: application, external_api, background_job, syntax,
+  # database, network. Add your own app-specific ones here. The stored integer
+  # is a schema — keep it stable once you have data. Add lightly:
+  # config.register_category(:instagram_api, 6)
+  #
+  # Or replace the whole map at once (defaults are merged in first):
+  # config.categories = { instagram_api: 6, payments_api: 7 }
+
   # --- Custom classification ---
   # Map your own exception types to a category. First non-nil wins.
   # config.categorize { |e| :external_api if e.is_a?(MyApi::Error) }

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: error_radar
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - chienbn9x
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2026-06-18 00:00:00.000000000 Z
+date: 2026-07-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails