solid_errors 0.2.17 → 0.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 335f924071f33fa526763f11b5c6512824cfbc2b3f66e5d71a732c497a7fbaf0
-  data.tar.gz: 8300d7c0f0db903ca91edcb821ac476cd9ed786dcbf92814530ec6d826d6d75c
+  metadata.gz: 4287723f04052a3d778c3d867c85d18891d0fef3a0fc88bdb8bc68051b809c75
+  data.tar.gz: f8c7880279550637834e8d6ddbfbf70473ad7c849c8ffc67aa100ff03f8261a5
 SHA512:
-  metadata.gz: dd452b7c2ca0b0673ef5924d0e7aae0764cae8fdbcaf14d0f5bb913238d23b1bfab4c16570687d90bfb091a45881ead9b6940777e849d21acb0806ccf14b99df
-  data.tar.gz: b30cad238e2afb5a4522d3c9dc6266e9276199389966b5a84b5a1d5db8123d8d41f62d7610946e7b98b91d1cd702e7420c8cf8df1ff29eaa0f95ec5aaa83cb10
+  metadata.gz: 03ec744d7c5c169aba544ad9b6c5c7669720a1a4d09ea8c1d9c4947e2ff29fb2139e5684929dd6a929dff7162752e0b9654dcb38afb6ba9da5b72e1d254e0543
+  data.tar.gz: 3ca9e7d6a603903c18f1338e0efa7c800935ecf136bbee650862e9c425fb9d82b0c861304a93a2c06d8d9950fb56ee1905b9b626e3f50f462f6f2db8978af0e9

data/README.md

@@ -1,28 +1,125 @@
-# SolidErrors
+# Solid Errors
+
+<p>
+  <a href="https://rubygems.org/gems/solid_errors">
+    <img alt="GEM Version" src="https://img.shields.io/gem/v/solid_errors?color=168AFE&include_prereleases&logo=ruby&logoColor=FE1616">
+  </a>
+  <a href="https://rubygems.org/gems/solid_errors">
+    <img alt="GEM Downloads" src="https://img.shields.io/gem/dt/solid_errors?color=168AFE&logo=ruby&logoColor=FE1616">
+  </a>
+  <a href="https://github.com/testdouble/standard">
+    <img alt="Ruby Style" src="https://img.shields.io/badge/style-standard-168AFE?logo=ruby&logoColor=FE1616" />
+  </a>
+  <a href="https://github.com/fractaledmind/solid_errors/actions/workflows/main.yml">
+    <img alt="Tests" src="https://github.com/fractaledmind/solid_errors/actions/workflows/main.yml/badge.svg" />
+  </a>
+  <a href="https://github.com/sponsors/fractaledmind">
+    <img alt="Sponsors" src="https://img.shields.io/github/sponsors/fractaledmind?color=eb4aaa&logo=GitHub%20Sponsors" />
+  </a>
+  <a href="https://ruby.social/@fractaledmind">
+    <img alt="Ruby.Social Follow" src="https://img.shields.io/mastodon/follow/109291299520066427?domain=https%3A%2F%2Fruby.social&label=%40fractaledmind&style=social">
+  </a>
+  <a href="https://twitter.com/fractaledmind">
+    <img alt="Twitter Follow" src="https://img.shields.io/twitter/url?label=%40fractaledmind&style=social&url=https%3A%2F%2Ftwitter.com%2Ffractaledmind">
+  </a>
+</p>
+
+
+Solid Errors is a DB-based, app-internal exception tracker for Rails applications, designed with simplicity and performance in mind. It uses the new [Rails error reporting API](https://guides.rubyonrails.org/error_reporting.html) to store uncaught exceptions in the database, and provides a simple UI for viewing and managing exceptions.
 
-Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/solid_errors`. To experiment with that code, run `bin/console` for an interactive prompt.
+## Installation
 
-TODO: Delete this and the text above, and describe your gem
+Install the gem and add to the application's Gemfile by executing:
 
-## Installation
+    $ bundle add solid_errors
+
+If bundler is not being used to manage dependencies, install the gem by executing:
+
+    $ gem install solid_errors
+
+After installing the gem, run the installer:
+
+    $ rails generate solid_errors:install
+
+This will copy the required migration over to your app.
+
+Then mount the engine in your config/routes.rb file
+
+    mount SolidErrors::Engine, at: "/solid_errors"
+
+> [!NOTE]
+> Be sure to [secure the dashboard](#authentication) in production.
+
+## Usage
+
+All exceptions are recorded automatically. No additional code required.
+
+Please consult the [official guides](https://guides.rubyonrails.org/error_reporting.html) for an introduction to the error reporting API.
+
+### Configuration
+
+You can configure Solid Errors via the Rails configuration object, under the `solid_errors` key. Currently, only 3 configuration options are available:
+
+* `connects_to` - The database configuration to use for the Solid Errors database. See [Database Configuration](#database-configuration) for more information.
+* `username` - The username to use for HTTP authentication. See [Authentication](#authentication) for more information.
+* `password` - The password to use for HTTP authentication. See [Authentication](#authentication) for more information.
+
+#### Database Configuration
+
+`config.solid_errors.connects_to` takes a custom database configuration hash that will be used in the abstract `SolidErrors::Record` Active Record model. This is required to use a different database than the main app. For example:
 
-Add this line to your application's Gemfile:
+```ruby
+# Use a single separate DB for Solid Errors
+config.solid_errors.connects_to = { database: { writing: :solid_errors, reading: :solid_errors } }
+```
+
+or
 
 ```ruby
-gem 'solid_errors'
+# Use a separate primary/replica pair for Solid Errors
+config.solid_errors.connects_to = { database: { writing: :solid_errors_primary, reading: :solid_errors_replica } }
 ```
 
-And then execute:
+#### Authentication
 
-    $ bundle install
+Solid Errors does not restrict access out of the box. You must secure the dashboard yourself. However, it does provide basic HTTP authentication that can be used with basic authentication or Devise. All you need to do is setup a username and password.
 
-Or install it yourself as:
+There are two ways to setup a username and password. First, you can use the `SOLIDERRORS_USERNAME` and `SOLIDERRORS_PASSWORD` environment variables:
 
-    $ gem install solid_errors
+```ruby
+ENV["SOLIDERRORS_USERNAME"] = "frodo"
+ENV["SOLIDERRORS_PASSWORD"] = "ikeptmysecrets"
+```
 
-## Usage
+Second, you can set the `SolidErrors.username` and `SolidErrors.password` variables in an initializer:
+
+```ruby
+# Set authentication credentials for Solid Errors
+config.solid_errors.username = Rails.application.credentials.solid_errors.username
+config.solid_errors.password = Rails.application.credentials.solid_errors.password
+```
+
+Either way, if you have set a username and password, Solid Errors will use basic HTTP authentication. If you have not set a username and password, Solid Errors will not require any authentication to view the dashboard.
+
+If you use Devise for authenctication in your app, you can also restrict access to the dashboard by using their `authenticate` contraint in your routes file:
+
+```ruby
+authenticate :user, -> (user) { user.admin? } do
+  mount SolidErrors::Engine, at: "/solid_errors"
+end
+```
+
+### Examples
+
+There are only two screens in the dashboard.
+
+* the index view of all unresolved errors:
+
+![image description](images/index-screenshot.png)
+
+* and the show view of a particular error:
 
-TODO: Write usage instructions here
+![image description](images/show-screenshot.png)
 
 ## Development
 
@@ -32,7 +129,7 @@ To install this gem onto your local machine, run `bundle exec rake install`. To
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/solid_errors. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/[USERNAME]/solid_errors/blob/main/CODE_OF_CONDUCT.md).
+Bug reports and pull requests are welcome on GitHub at https://github.com/fractaledmind/solid_errors. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/fractaledmind/solid_errors/blob/main/CODE_OF_CONDUCT.md).
 
 ## License
 
@@ -40,4 +137,4 @@ The gem is available as open source under the terms of the [MIT License](https:/
 
 ## Code of Conduct
 
-Everyone interacting in the SolidErrors project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/solid_errors/blob/main/CODE_OF_CONDUCT.md).
+Everyone interacting in the SolidErrors project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/fractaledmind/solid_errors/blob/main/CODE_OF_CONDUCT.md).

data/app/controllers/solid_errors/application_controller.rb

@@ -1,4 +1,7 @@
 module SolidErrors
   class ApplicationController < ActionController::Base
+    protect_from_forgery with: :exception
+
+    http_basic_authenticate_with name: SolidErrors.username, password: SolidErrors.password if SolidErrors.password
   end
 end

data/app/controllers/solid_errors/errors_controller.rb

@@ -1,6 +1,6 @@
 module SolidErrors
   class ErrorsController < ApplicationController
-    before_action :set_error, only: %i[ show update ]
+    before_action :set_error, only: %i[show update]
 
     # GET /errors
     def index
@@ -8,10 +8,10 @@ module SolidErrors
       occurrences_table = Occurrence.arel_table
 
       @errors = Error.unresolved
-                     .joins(:occurrences)
-                     .select(errors_table[Arel.star], occurrences_table[:created_at].maximum.as('recent_occurrence'))
-                     .group(errors_table[:id])
-                     .order(recent_occurrence: :desc)
+        .joins(:occurrences)
+        .select(errors_table[Arel.star], occurrences_table[:created_at].maximum.as("recent_occurrence"))
+        .group(errors_table[:id])
+        .order(recent_occurrence: :desc)
     end
 
     # GET /errors/1
@@ -25,13 +25,14 @@ module SolidErrors
     end
 
     private
-      # Only allow a list of trusted parameters through.
-      def error_params
-        params.require(:error).permit(:resolved_at)
-      end
 
-      def set_error
-        @error = Error.find(params[:id])
-      end
+    # Only allow a list of trusted parameters through.
+    def error_params
+      params.require(:error).permit(:resolved_at)
+    end
+
+    def set_error
+      @error = Error.find(params[:id])
+    end
   end
 end

data/app/models/solid_errors/backtrace.rb

@@ -10,7 +10,7 @@ module SolidErrors
         BacktraceLine.parse(unparsed_line.to_s, opts)
       end.compact
 
-      instance = new(lines)
+      new(lines)
     end
 
     def initialize(lines)
@@ -22,9 +22,9 @@ module SolidErrors
     #
     # Returns array containing backtrace lines.
     def to_ary
-      lines.take(1000).map { |l| { :number => l.filtered_number, :file => l.filtered_file, :method => l.filtered_method, :source => l.source } }
+      lines.take(1000).map { |l| {number: l.filtered_number, file: l.filtered_file, method: l.filtered_method, source: l.source} }
     end
-    alias :to_a :to_ary
+    alias_method :to_a, :to_ary
 
     # JSON support.
     #

data/app/models/solid_errors/backtrace_line.rb

@@ -2,14 +2,14 @@ module SolidErrors
   class BacktraceLine
     # Backtrace line regexp (optionally allowing leading X: for windows support).
     INPUT_FORMAT = %r{^((?:[a-zA-Z]:)?[^:]+):(\d+)(?::in `([^']+)')?$}.freeze
-    STRING_EMPTY = ''.freeze
-    GEM_ROOT = '[GEM_ROOT]'.freeze
-    PROJECT_ROOT = '[PROJECT_ROOT]'.freeze
+    STRING_EMPTY = "".freeze
+    GEM_ROOT = "[GEM_ROOT]".freeze
+    PROJECT_ROOT = "[PROJECT_ROOT]".freeze
     PROJECT_ROOT_CACHE = {}
     GEM_ROOT_CACHE = {}
     RELATIVE_ROOT = Regexp.new('^\.\/').freeze
     RAILS_ROOT = ::Rails.root.to_s.dup.freeze
-    ROOT_REGEXP = Regexp.new("^#{ Regexp.escape(RAILS_ROOT) }").freeze
+    ROOT_REGEXP = Regexp.new("^#{Regexp.escape(RAILS_ROOT)}").freeze
     BACKTRACE_FILTERS = [
       lambda { |line|
         return line unless defined?(Gem)
@@ -47,21 +47,19 @@ module SolidErrors
         file, number, method = match[1], match[2], match[3]
         filtered_args = [fmatch[1], fmatch[2], fmatch[3]]
         new(file, number, method, *filtered_args, opts.fetch(:source_radius, 2))
-      else
-        nil
       end
     end
 
     def initialize(file, number, method, filtered_file = file,
-                    filtered_number = number, filtered_method = method,
-                    source_radius = 2)
-      self.filtered_file   = filtered_file
+      filtered_number = number, filtered_method = method,
+      source_radius = 2)
+      self.filtered_file = filtered_file
       self.filtered_number = filtered_number
       self.filtered_method = filtered_method
-      self.file            = file
-      self.number          = number
-      self.method          = method
-      self.source_radius   = source_radius
+      self.file = file
+      self.number = number
+      self.method = method
+      self.source_radius = source_radius
     end
 
     # Reconstructs the line in a readable fashion.
@@ -74,7 +72,7 @@ module SolidErrors
     end
 
     def inspect
-      "<Line:#{to_s}>"
+      "<Line:#{self}>"
     end
 
     # Determines if this line is part of the application trace or not.
@@ -105,8 +103,11 @@ module SolidErrors
 
       l = 0
       File.open(file) do |f|
-        start.times { f.gets ; l += 1 }
-        return Hash[duration.times.map { (line = f.gets) ? [(l += 1), line] : nil }.compact]
+        start.times {
+          f.gets
+          l += 1
+        }
+        return duration.times.map { (line = f.gets) ? [(l += 1), line] : nil }.compact.to_h
       end
     end
   end

data/app/models/solid_errors/error.rb

@@ -27,7 +27,7 @@ module SolidErrors
     end
 
     def badge_classes
-      "px-2 inline-flex text-[.75em] font-semibold rounded-md #{SEVERITY_TO_BADGE_CLASSES[severity.to_sym]}"
+      "px-2 inline-flex text-sm font-semibold rounded-md #{SEVERITY_TO_BADGE_CLASSES[severity.to_sym]}"
     end
   end
 end

data/app/models/solid_errors/occurrence.rb

@@ -14,8 +14,8 @@ module SolidErrors
 
     private
 
-      def parse_backtrace(backtrace)
-        Backtrace.parse(backtrace)
-      end
+    def parse_backtrace(backtrace)
+      Backtrace.parse(backtrace)
+    end
   end
 end

data/app/models/solid_errors/record.rb

@@ -4,7 +4,7 @@ module SolidErrors
   class Record < ActiveRecord::Base
     self.abstract_class = true
 
-    connects_to **SolidErrors.connects_to if SolidErrors.connects_to
+    connects_to(**SolidErrors.connects_to) if SolidErrors.connects_to
   end
 end
 

data/app/views/layouts/solid_errors/application.html.erb

@@ -95,8 +95,8 @@
       */
 
       abbr:where([title]) {
-        -webkit-text-decoration: underline dotted;
-        text-decoration:underline dotted
+        text-decoration-line: underline;
+        text-decoration-style: dotted;
       }
 
       /*
@@ -578,12 +578,6 @@
         }
       }
 
-      .bi {
-        fill: currentColor;
-        stroke-width: 0.5;
-        stroke: currentColor;
-      }
-
       .sr-only{
         position: absolute;
         width: 1px;
@@ -596,14 +590,26 @@
         border-width: 0
       }
 
-      .static{
-        position: static
+      .fixed{
+        position: fixed
       }
 
       .relative{
         position: relative
       }
 
+      .left-0{
+        left: 0px
+      }
+
+      .right-0{
+        right: 0px
+      }
+
+      .top-0{
+        top: 0px
+      }
+
       .-mx-2{
         margin-left: -0.5rem;
         margin-right: -0.5rem
@@ -618,10 +624,6 @@
         margin-bottom: 0.75rem
       }
 
-      .mb-36{
-        margin-bottom: 9rem
-      }
-
       .ml-6{
         margin-left: 1.5rem
       }
@@ -634,37 +636,8 @@
         margin-top: 1rem
       }
 
-      .min-h-full{
-        min-height: 100%
-      }
-
-      .select-none{
-        user-select: none
-      }
-
-      .overflow-auto{
-        overflow: auto
-      }
-
-      .rounded-b-lg{
-        border-bottom-right-radius: 0.5rem;
-        border-bottom-left-radius: 0.5rem
-      }
-
-      .leading-normal{
-        line-height: 1.5
-      }
-
-      .mt-4{
-        margin-top: 1rem
-      }
-
-      .\!block{
-        display: block !important
-      }
-
-      .block{
-        display: block
+      .inline-block{
+        display: inline-block
       }
 
       .flex{
@@ -675,10 +648,6 @@
         display: inline-flex
       }
 
-      .flex-col{
-        flex-direction: column
-      }
-
       .table{
         display: table
       }
@@ -687,12 +656,8 @@
         display: grid
       }
 
-      .hidden{
-        display: none
-      }
-
-      .w-full{
-        width: 100%
+      .min-h-full{
+        min-height: 100%
       }
 
       .min-w-full{
@@ -719,10 +684,18 @@
         grid-template-columns: repeat(2, minmax(0, 1fr))
       }
 
+      .flex-col{
+        flex-direction: column
+      }
+
       .flex-wrap{
         flex-wrap: wrap
       }
 
+      .items-start{
+        align-items: flex-start
+      }
+
       .items-center{
         align-items: center
       }
@@ -780,10 +753,18 @@
         border-color: rgb(209 213 219 / var(--tw-divide-opacity))
       }
 
+      .overflow-auto{
+        overflow: auto
+      }
+
       .whitespace-nowrap{
         white-space: nowrap
       }
 
+      .whitespace-pre-wrap{
+        white-space: pre-wrap
+      }
+
       .rounded{
         border-radius: 0.25rem
       }
@@ -792,8 +773,9 @@
         border-radius: 0.5rem
       }
 
-      .rounded-md{
-        border-radius: 0.375rem
+      .rounded-b-lg{
+        border-bottom-right-radius: 0.5rem;
+        border-bottom-left-radius: 0.5rem
       }
 
       .border{
@@ -804,14 +786,14 @@
         border-bottom-width: 1px
       }
 
-      .border-gray-300{
+      .border-blue-500{
         --tw-border-opacity: 1;
-        border-color: rgb(209 213 219 / var(--tw-border-opacity))
+        border-color: rgb(59 130 246 / var(--tw-border-opacity))
       }
 
-      .border-blue-500{
+      .border-gray-300{
         --tw-border-opacity: 1;
-        border-color: rgb(59 130 246 / var(--tw-border-opacity))
+        border-color: rgb(209 213 219 / var(--tw-border-opacity))
       }
 
       .bg-gray-100{
@@ -819,18 +801,14 @@
         background-color: rgb(243 244 246 / var(--tw-bg-opacity))
       }
 
-      .bg-gray-200{
+      .bg-green-50{
         --tw-bg-opacity: 1;
-        background-color: rgb(229 231 235 / var(--tw-bg-opacity))
+        background-color: rgb(240 253 244 / var(--tw-bg-opacity))
       }
 
-      .bg-transparent{
-        background-color: transparent
-      }
-
-      .bg-white{
+      .bg-red-50{
         --tw-bg-opacity: 1;
-        background-color: rgb(255 255 255 / var(--tw-bg-opacity))
+        background-color: rgb(254 242 242 / var(--tw-bg-opacity))
       }
 
       .bg-slate-800{
@@ -838,34 +816,17 @@
         background-color: rgb(30 41 59 / var(--tw-bg-opacity))
       }
 
-      .bg-blue-100{
-        --tw-bg-opacity: 1;
-        background-color: rgb(219 234 254 / var(--tw-bg-opacity))
-      }
-
-      .bg-red-100{
-        --tw-bg-opacity: 1;
-        background-color: rgb(254 226 226 / var(--tw-bg-opacity))
+      .bg-transparent{
+        background-color: transparent
       }
 
-      .bg-yellow-100{
+      .bg-white{
         --tw-bg-opacity: 1;
-        background-color: rgb(254 249 195 / var(--tw-bg-opacity))
-      }
-
-      .text-blue-800{
-        --tw-text-opacity: 1;
-        color: rgb(30 64 175 / var(--tw-text-opacity))
-      }
-
-      .text-red-800{
-        --tw-text-opacity: 1;
-        color: rgb(153 27 27 / var(--tw-text-opacity))
+        background-color: rgb(255 255 255 / var(--tw-bg-opacity))
       }
 
-      .text-yellow-800{
-        --tw-text-opacity: 1;
-        color: rgb(133 77 14 / var(--tw-text-opacity))
+      .p-2{
+        padding: 0.5rem
       }
 
       .p-4{
@@ -877,10 +838,6 @@
         padding-right: 0px
       }
 
-      .p-2{
-        padding: 0.5rem
-      }
-
       .px-2{
         padding-left: 0.5rem;
         padding-right: 0.5rem
@@ -901,6 +858,11 @@
         padding-bottom: 0.25rem
       }
 
+      .py-2{
+        padding-top: 0.5rem;
+        padding-bottom: 0.5rem
+      }
+
       .py-3{
         padding-top: 0.75rem;
         padding-bottom: 0.75rem
@@ -940,10 +902,18 @@
         padding-top: 1.75rem
       }
 
+      .rounded-md{
+        border-radius: 0.375rem
+      }
+
       .text-left{
         text-align: left
       }
 
+      .text-center{
+        text-align: center
+      }
+
       .text-right{
         text-align: right
       }
@@ -957,10 +927,6 @@
         line-height: 2rem
       }
 
-      .text-\[\.75em\]{
-        font-size: .75em
-      }
-
       .text-base{
         font-size: 1rem;
         line-height: 1.5rem
@@ -983,9 +949,23 @@
         font-weight: 600
       }
 
-      .text-white{
-        --tw-text-opacity: 1;
-        color: rgb(255 255 255 / var(--tw-text-opacity))
+      .leading-normal{
+        line-height: 1.5
+      }
+
+      .bg-blue-100{
+        --tw-bg-opacity: 1;
+        background-color: rgb(219 234 254 / var(--tw-bg-opacity))
+      }
+
+      .bg-red-100{
+        --tw-bg-opacity: 1;
+        background-color: rgb(254 226 226 / var(--tw-bg-opacity))
+      }
+
+      .bg-yellow-100{
+        --tw-bg-opacity: 1;
+        background-color: rgb(254 249 195 / var(--tw-bg-opacity))
       }
 
       .text-blue-400{
@@ -1008,11 +988,6 @@
         color: rgb(75 85 99 / var(--tw-text-opacity))
       }
 
-      .text-gray-800{
-        --tw-text-opacity: 1;
-        color: rgb(31 41 55 / var(--tw-text-opacity))
-      }
-
       .text-gray-900{
         --tw-text-opacity: 1;
         color: rgb(17 24 39 / var(--tw-text-opacity))
@@ -1023,10 +998,45 @@
         color: rgb(34 197 94 / var(--tw-text-opacity))
       }
 
+      .text-red-500{
+        --tw-text-opacity: 1;
+        color: rgb(239 68 68 / var(--tw-text-opacity))
+      }
+
+      .text-blue-800{
+        --tw-text-opacity: 1;
+        color: rgb(30 64 175 / var(--tw-text-opacity))
+      }
+
+      .text-red-800{
+        --tw-text-opacity: 1;
+        color: rgb(153 27 27 / var(--tw-text-opacity))
+      }
+
+      .text-yellow-800{
+        --tw-text-opacity: 1;
+        color: rgb(133 77 14 / var(--tw-text-opacity))
+      }
+
+      .text-white{
+        --tw-text-opacity: 1;
+        color: rgb(255 255 255 / var(--tw-text-opacity))
+      }
+
       .underline{
         text-decoration-line: underline
       }
 
+      .transition-opacity{
+        transition-property: opacity;
+        transition-timing-function: cubic-bezier(0.4, 0, 0.2, 1);
+        transition-duration: 150ms
+      }
+
+      .opacity-0{
+        opacity: 0
+      }
+
       .even\:bg-gray-50:nth-child(even){
         --tw-bg-opacity: 1;
         background-color: rgb(249 250 251 / var(--tw-bg-opacity))
@@ -1043,14 +1053,14 @@
         box-shadow: var(--tw-ring-offset-shadow), var(--tw-ring-shadow), var(--tw-shadow, 0 0 #0000)
       }
 
-      .hover\:ring-gray-200:hover{
+      .hover\:ring-blue-200:hover{
         --tw-ring-opacity: 1;
-        --tw-ring-color: rgb(229 231 235 / var(--tw-ring-opacity))
+        --tw-ring-color: rgb(191 219 254 / var(--tw-ring-opacity))
       }
 
-      .hover\:ring-blue-200:hover{
+      .hover\:ring-gray-200:hover{
         --tw-ring-opacity: 1;
-        --tw-ring-color: rgb(191 219 254 / var(--tw-ring-opacity))
+        --tw-ring-color: rgb(229 231 235 / var(--tw-ring-opacity))
       }
 
       @media (min-width: 640px){
@@ -1101,21 +1111,20 @@
       <% end %>
     </div>
 
-    <script>
-      var element = document.querySelector('[data-controller="fade"]');
-      function fadeOut(el) {
-        var opacity = 1; // Initial opacity
-        var interval = setInterval(function() {
-            if (opacity > 0) {
-              opacity -= 0.1;
-              el.style.opacity = opacity;
-            } else {
-              clearInterval(interval); // Stop the interval when opacity reaches 0
-              el.style.display = 'none'; // Hide the element
-            }
-        }, 50);
-      }
-      fadeOut(element);
+    <script nonce="<%= content_security_policy_nonce %>">
+      function fadeOut(element) {
+        element.classList.add('transition-opacity')
+        setTimeout(
+          () => {
+            element.classList.add('opacity-0')
+            element.remove()
+          },
+          2000
+        )
+      }
+      document.querySelectorAll('[data-controller="fade"]').forEach(element => {
+        fadeOut(element);
+      });
     </script>
   </body>
 </html>

data/app/views/solid_errors/errors/_error.html.erb

@@ -8,7 +8,7 @@
       from
       <em><code><%= error.source %></code></em>
     </div>
-    <pre class="ml-6 mt-4"><%= error.message %></pre>
+    <pre class="whitespace-pre-wrap ml-6 mt-4"><%= error.message %></pre>
   </td>
   <td scope="col" class="whitespace-nowrap px-3 py-4 pt-7 text-gray-500 text-right">
     <%= error.occurrences.size %>

data/app/views/solid_errors/errors/show.html.erb

@@ -99,7 +99,8 @@
   <%= render "solid_errors/errors/actions", error: @error %>
 <% end %>
 
-<hr class="mt-4 pb-4">
+<br>
+<br>
 
 <%= render "solid_errors/occurrences/collection",
       occurrences: @error.occurrences,

data/app/views/solid_errors/occurrences/_occurrence.html.erb

@@ -10,12 +10,12 @@
     <div class="">
       <dl class="ml-6">
         <% occurrence.context&.each do |key, value| %>
-          <div class="flex items-center justify-between flex-wrap gap-x-2">
+          <div class="flex items-center justify-start flex-wrap gap-x-2">
             <dt class="font-bold">
               <%= SolidErrors::Occurrence.human_attribute_name(key) %>
             </dt>
             <dd class="">
-              <%= value %>
+              <code><%= value %></code>
             </dd>
           </div>
         <% end %>

data/config/routes.rb

@@ -1,5 +1,5 @@
 SolidErrors::Engine.routes.draw do
-  get "/" => "errors#index", as: :root
+  get "/" => "errors#index", :as => :root
 
   resources :errors, only: [:index, :show, :update], path: ""
 end

data/lib/generators/solid_errors/install/install_generator.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
-require 'rails/generators'
-require 'rails/generators/active_record'
+require "rails/generators"
+require "rails/generators/active_record"
 
 module SolidErrors
   #
@@ -13,14 +13,14 @@ module SolidErrors
 
     source_root File.expand_path("templates", __dir__)
 
-    class_option :database, type: :string, aliases: %i(--db), desc: "The database for your migration. By default, the current environment's primary database is used."
+    class_option :database, type: :string, aliases: %i[--db], desc: "The database for your migration. By default, the current environment's primary database is used."
     class_option :skip_migrations, type: :boolean, default: nil, desc: "Skip migrations"
 
     # Generates monolithic migration file that contains all database changes.
     def create_migration_file
       return if options[:skip_migrations]
 
-      migration_template 'create_solid_errors_tables.rb.erb', File.join(db_migrate_path, "create_solid_errors_tables.rb")
+      migration_template "create_solid_errors_tables.rb.erb", File.join(db_migrate_path, "create_solid_errors_tables.rb")
     end
 
     private

data/lib/generators/solid_errors/install/templates/create_solid_errors_tables.rb.erb

@@ -11,11 +11,11 @@ class CreateSolidErrorsTables < ActiveRecord::Migration<%= migration_version %>
 
       t.timestamps
 
-      t.index [:exception_class, :message, :severity, :source], unique: true
+      t.index [:exception_class, :message, :severity, :source], unique: true, name: "solid_error_uniqueness_index"
     end
 
     create_table :solid_errors_occurrences do |t|
-      t.belongs_to :error, null: false, foreign_key: true
+      t.belongs_to :solid_error, null: false, foreign_key: true
       t.text :backtrace
       t.json :context
 

data/lib/solid_errors/sanitizer.rb

@@ -1,11 +1,11 @@
 module SolidErrors
   # adapted from: https://github.com/honeybadger-io/honeybadger-ruby/blob/master/lib/honeybadger/util/sanitizer.rb
   class Sanitizer
-    BASIC_OBJECT = '#<BasicObject>'.freeze
-    DEPTH = '[DEPTH]'.freeze
-    RAISED = '[RAISED]'.freeze
-    RECURSION = '[RECURSION]'.freeze
-    TRUNCATED = '[TRUNCATED]'.freeze
+    BASIC_OBJECT = "#<BasicObject>".freeze
+    DEPTH = "[DEPTH]".freeze
+    RAISED = "[RAISED]".freeze
+    RECURSION = "[RECURSION]".freeze
+    TRUNCATED = "[TRUNCATED]".freeze
     MAX_STRING_SIZE = 65536
 
     def self.sanitize(data)
@@ -21,7 +21,7 @@ module SolidErrors
       return BASIC_OBJECT if basic_object?(data)
 
       if recursive?(data)
-        return RECURSION if stack && stack.include?(data.object_id)
+        return RECURSION if stack&.include?(data.object_id)
 
         stack = stack ? stack.dup : Set.new
         stack << data.object_id
@@ -33,8 +33,8 @@ module SolidErrors
 
         new_hash = {}
         data.each do |key, value|
-          key = key.kind_of?(Symbol) ? key : sanitize(key, depth+1, stack)
-          value = sanitize(value, depth+1, stack)
+          key = key.is_a?(Symbol) ? key : sanitize(key, depth + 1, stack)
+          value = sanitize(value, depth + 1, stack)
           new_hash[key] = value
         end
         new_hash
@@ -42,7 +42,7 @@ module SolidErrors
         return DEPTH if depth >= max_depth
 
         data.to_a.map do |value|
-          sanitize(value, depth+1, stack)
+          sanitize(value, depth + 1, stack)
         end
       when Numeric, TrueClass, FalseClass, NilClass
         data
@@ -64,28 +64,29 @@ module SolidErrors
     end
 
     private
-      attr_reader :max_depth
-
-      def basic_object?(object)
-        object.respond_to?(:to_s)
-        false
-      rescue
-        # BasicObject doesn't respond to `#respond_to?`.
-        true
-      end
 
-      def recursive?(data)
-        data.is_a?(Hash) || data.is_a?(Array) || data.is_a?(Set)
-      end
+    attr_reader :max_depth
 
-      def sanitize_string(string)
-        string.gsub!(/#<(.*?):0x.*?>/, '#<\1>') # remove object_id
-        return string unless string.respond_to?(:size) && string.size > MAX_STRING_SIZE
-        string[0...MAX_STRING_SIZE] + TRUNCATED
-      end
+    def basic_object?(object)
+      object.respond_to?(:to_s)
+      false
+    rescue
+      # BasicObject doesn't respond to `#respond_to?`.
+      true
+    end
 
-      def inspected?(string)
-        String(string) =~ /#<.*>/
-      end
+    def recursive?(data)
+      data.is_a?(Hash) || data.is_a?(Array) || data.is_a?(Set)
+    end
+
+    def sanitize_string(string)
+      string.gsub!(/#<(.*?):0x.*?>/, '#<\1>') # remove object_id
+      return string unless string.respond_to?(:size) && string.size > MAX_STRING_SIZE
+      string[0...MAX_STRING_SIZE] + TRUNCATED
+    end
+
+    def inspected?(string)
+      String(string) =~ /#<.*>/
+    end
   end
 end

data/lib/solid_errors/subscriber.rb

@@ -1,26 +1,25 @@
 module SolidErrors
   class Subscriber
-    IGNORED_ERRORS = ['ActionController::RoutingError',
-                      'AbstractController::ActionNotFound',
-                      'ActionController::MethodNotAllowed',
-                      'ActionController::UnknownHttpMethod',
-                      'ActionController::NotImplemented',
-                      'ActionController::UnknownFormat',
-                      'ActionController::InvalidAuthenticityToken',
-                      'ActionController::InvalidCrossOriginRequest',
-                      'ActionDispatch::Http::Parameters::ParseError',
-                      'ActionController::BadRequest',
-                      'ActionController::ParameterMissing',
-                      'ActiveRecord::RecordNotFound',
-                      'ActionController::UnknownAction',
-                      'ActionDispatch::Http::MimeNegotiation::InvalidType',
-                      'Rack::QueryParser::ParameterTypeError',
-                      'Rack::QueryParser::InvalidParameterError',
-                      'CGI::Session::CookieStore::TamperedWithCookie',
-                      'Mongoid::Errors::DocumentNotFound',
-                      'Sinatra::NotFound',
-                      'Sidekiq::JobRetry::Skip'].map(&:freeze).freeze
-
+    IGNORED_ERRORS = ["ActionController::RoutingError",
+      "AbstractController::ActionNotFound",
+      "ActionController::MethodNotAllowed",
+      "ActionController::UnknownHttpMethod",
+      "ActionController::NotImplemented",
+      "ActionController::UnknownFormat",
+      "ActionController::InvalidAuthenticityToken",
+      "ActionController::InvalidCrossOriginRequest",
+      "ActionDispatch::Http::Parameters::ParseError",
+      "ActionController::BadRequest",
+      "ActionController::ParameterMissing",
+      "ActiveRecord::RecordNotFound",
+      "ActionController::UnknownAction",
+      "ActionDispatch::Http::MimeNegotiation::InvalidType",
+      "Rack::QueryParser::ParameterTypeError",
+      "Rack::QueryParser::InvalidParameterError",
+      "CGI::Session::CookieStore::TamperedWithCookie",
+      "Mongoid::Errors::DocumentNotFound",
+      "Sinatra::NotFound",
+      "Sidekiq::JobRetry::Skip"].map(&:freeze).freeze
 
     def report(error, handled:, severity:, context:, source: nil)
       return if ignore_by_class?(error.class.name)

data/lib/solid_errors/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module SolidErrors
-  VERSION = "0.2.17"
+  VERSION = "0.3.1"
 end

data/lib/solid_errors.rb

@@ -7,4 +7,20 @@ require_relative "solid_errors/engine"
 
 module SolidErrors
   mattr_accessor :connects_to
+  mattr_accessor :username
+  mattr_accessor :password
+
+  class << self
+    # use method instead of attr_accessor to ensure
+    # this works if variable set after SolidErrors is loaded
+    def username
+      @username ||= ENV["SOLIDERRORS_USERNAME"]
+    end
+
+    # use method instead of attr_accessor to ensure
+    # this works if variable set after SolidErrors is loaded
+    def password
+      @password ||= ENV["SOLIDERRORS_PASSWORD"]
+    end
+  end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: solid_errors
 version: !ruby/object:Gem::Version
-  version: 0.2.17
+  version: 0.3.1
 platform: ruby
 authors:
 - Stephen Margheim
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-01-15 00:00:00.000000000 Z
+date: 2024-01-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -24,6 +24,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '7.0'
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 description:
 email:
 - stephen.margheim@gmail.com