solid_errors 0.3.3 → 0.3.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 042e023f7ef8a19fb20f44b9c6cf044af997a58eab4c15c23030896798738a48
-  data.tar.gz: 7e02ed9572becd8e6563c1f089ca710e4186704b6312edb453b5b12741e2679a
+  metadata.gz: a2eee8c990cddbb820d0e26419c5a08d163552840313b5468d15c9590d07f831
+  data.tar.gz: 578aac9f9b1f58003b50cd1482cedbda43804e54ee1349a52fd47f79acc51f18
 SHA512:
-  metadata.gz: d71b734df7c89c784a01d005fbe41eb31ad7bd07e51aa2e8d1ef7049aeabee94888d9d93c0440445e40d6a179bbb0a60082b81fe7517d576688b1a05a49e5c1b
-  data.tar.gz: 01ee124e9d940f36a0c2b9079bb173ea25fdfb0912991483dd35188984e28ce8a390d8fd9e2c2d10a33ac65e48b203c35eb6fb46a3160a722399dee63605badd
+  metadata.gz: 5ec9d232d8e0b622cfa099b2c2fd16232681b65ca24825411caa95cf91680da02099a0ddb6ce2901ce3857d9489cf2d0cef410aef8609f6cc54ff2ff19821afd
+  data.tar.gz: 61a0e98f22ee56313cb7867452b0ae42945a204cb5736edec59aa429d103d4b136ba223bf28bc7d54f85bb7c00b483d2557e41473c76f38fdff915577c9004a6

data/README.md

@@ -30,22 +30,28 @@ Solid Errors is a DB-based, app-internal exception tracker for Rails application
 ## Installation
 
 Install the gem and add to the application's Gemfile by executing:
-
-    $ bundle add solid_errors
+```bash
+$ bundle add solid_errors
+```
 
 If bundler is not being used to manage dependencies, install the gem by executing:
-
-    $ gem install solid_errors
+```bash
+$ gem install solid_errors
+```
 
 After installing the gem, run the installer:
-
-    $ rails generate solid_errors:install
+```bash
+$ 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"
+Then mount the engine in your `config/routes.rb` file:
+```ruby
+authenticate :user, -> (user) { user.admin? } do
+  mount SolidErrors::Engine, at: "/solid_errors"
+end
+```
 
 > [!NOTE]
 > Be sure to [secure the dashboard](#authentication) in production.
@@ -56,6 +62,8 @@ 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.
 
+There are intentionally few features; you can view and resolve errors. That’s it. The goal is to provide a simple, lightweight, and performant solution for tracking exceptions in your Rails application. If you need more features, you should probably use a 3rd party service like [Honeybadger](https://www.honeybadger.io/), whose MIT-licensed [Ruby agent gem](https://github.com/honeybadger-io/honeybadger-ruby) provided a couple of critical pieces of code for this project.
+
 ### Configuration
 
 You can configure Solid Errors via the Rails configuration object, under the `solid_errors` key. Currently, only 3 configuration options are available:

data/app/models/solid_errors/backtrace.rb

@@ -1,4 +1,5 @@
 module SolidErrors
+  # adapted from: https://github.com/honeybadger-io/honeybadger-ruby/blob/master/lib/honeybadger/backtrace.rb
   class Backtrace
     # Holder for an Array of Backtrace::Line instances.
     attr_reader :lines, :application_lines

data/app/models/solid_errors/backtrace_line.rb

@@ -1,4 +1,5 @@
 module SolidErrors
+  # adapted from: https://github.com/honeybadger-io/honeybadger-ruby/blob/master/lib/honeybadger/backtrace.rb
   class BacktraceLine
     # Backtrace line regexp (optionally allowing leading X: for windows support).
     INPUT_FORMAT = %r{^((?:[a-zA-Z]:)?[^:]+):(\d+)(?::in `([^']+)')?$}.freeze
@@ -28,7 +29,7 @@ module SolidErrors
     attr_reader :file
     attr_reader :number
     attr_reader :method
-    attr_reader :filtered_file, :filtered_number, :filtered_method
+    attr_reader :filtered_file, :filtered_number, :filtered_method, :unparsed_line
 
     # Parses a single line of a given backtrace
     #
@@ -46,13 +47,14 @@ 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))
+        new(unparsed_line, file, number, method, *filtered_args, opts.fetch(:source_radius, 2))
       end
     end
 
-    def initialize(file, number, method, filtered_file = file,
+    def initialize(unparsed_line, file, number, method, filtered_file = file,
       filtered_number = number, filtered_method = method,
       source_radius = 2)
+      self.unparsed_line = unparsed_line
       self.filtered_file = filtered_file
       self.filtered_number = filtered_number
       self.filtered_method = filtered_method
@@ -86,7 +88,7 @@ module SolidErrors
 
     private
 
-    attr_writer :file, :number, :method, :filtered_file, :filtered_number, :filtered_method
+    attr_writer :file, :number, :method, :filtered_file, :filtered_number, :filtered_method, :unparsed_line
 
     attr_accessor :source_radius
 

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

@@ -1093,6 +1093,13 @@
       <%= content_for?(:content) ? yield(:content) : yield %>
     </main>
 
+    <footer class="container mx-auto py-4 mt-24 text-base flex justify-between items-center border-t">
+      <p>
+        <code><strong>Solid</strong> <em>Errors</em></code>&nbsp;&nbsp;|&nbsp;
+        Made by <a href="https://twitter.com/fractaledmind" class="text-blue-500 hover:underline decoration-blue-500">@fractaledmind</a> and <a href="https://github.com/fractaledmind/solid_errors/graphs/contributors" class="text-blue-500 hover:underline decoration-blue-500">friends</a>! Want to help? It's <a href="https://github.com/fractaledmind/solid_errors" class="text-blue-500 hover:underline decoration-blue-500">open source</a>!
+      </p>
+    </footer>
+
     <div class="fixed top-0 left-0 right-0 text-center py-2">
       <% if notice.present? %>
         <p id="notice"

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

@@ -27,9 +27,13 @@
             <% backtrace.lines.each_with_index do |line, i| %>
               <%= tag.details open: line.application? || i.zero? do %>
                 <summary class="hover:bg-gray-50 px-2 py-1 rounded cursor-pointer">
-                  <span class="text-gray-500"><%= File.dirname(line.filtered_file) %>/</span><span class="text-blue-500 font-medium"><%= File.basename(line.filtered_file) %></span>:<span class="text-gray-900 font-medium"><%= line.filtered_number %></span>
-                  <span class="text-gray-500">in</span>
-                  <code class="text-green-500 font-medium"><%= line.filtered_method %></code>
+                  <% if line.filtered_file %>
+                    <span class="text-gray-500"><%= File.dirname(line.filtered_file) %>/</span><span class="text-blue-500 font-medium"><%= File.basename(line.filtered_file) %></span>:<span class="text-gray-900 font-medium"><%= line.filtered_number %></span>
+                    <span class="text-gray-500">in</span>
+                    <code class="text-green-500 font-medium"><%= line.filtered_method %></code>
+                  <% else %>
+                    <span class="text-gray-500"><%= line.unparsed_line %>
+                  <% end %>
                 </summary>
                 <div><pre class="flex overflow-auto rounded-b-lg bg-slate-800 p-4 text-sm leading-normal text-white sm:rounded-t-lg"><code class="flex flex-col min-h-full min-w-content px-0"><% line.source.each do |n, code| %>
                   <div class="line"><span class="mr-2 text-right select-none text-gray-600"><%= n %></span><span><%= code %></span></div>

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

@@ -3,9 +3,9 @@
 class CreateSolidErrorsTables < ActiveRecord::Migration<%= migration_version %>
   def change
     create_table :solid_errors do |t|
-      t.string :exception_class, null: false
+      t.string :exception_class, null: false, limit: 200
       t.string :message, null: false
-      t.string :severity, null: false
+      t.string :severity, null: false, limit: 25
       t.string :source
       t.datetime :resolved_at, index: true
 

data/lib/solid_errors/sanitizer.rb

@@ -80,7 +80,7 @@ module SolidErrors
     end
 
     def sanitize_string(string)
-      string.gsub!(/#<(.*?):0x.*?>/, '#<\1>') # remove object_id
+      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

data/lib/solid_errors/version.rb

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

data/lib/solid_errors.rb

@@ -7,20 +7,20 @@ require_relative "solid_errors/engine"
 
 module SolidErrors
   mattr_accessor :connects_to
-  mattr_accessor :username
-  mattr_accessor :password
+  mattr_writer :username
+  mattr_writer :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"]
+      @username ||= ENV["SOLIDERRORS_USERNAME"] || @@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"]
+      @password ||= ENV["SOLIDERRORS_PASSWORD"] || @@password
     end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: solid_errors
 version: !ruby/object:Gem::Version
-  version: 0.3.3
+  version: 0.3.5
 platform: ruby
 authors:
 - Stephen Margheim
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-01-28 00:00:00.000000000 Z
+date: 2024-02-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -55,6 +55,7 @@ files:
 - app/models/solid_errors/occurrence.rb
 - app/models/solid_errors/record.rb
 - app/views/layouts/solid_errors/application.html.erb
+- app/views/solid_errors/error_mailer/error_occurred.text.erb
 - app/views/solid_errors/errors/_actions.html.erb
 - app/views/solid_errors/errors/_error.html.erb
 - app/views/solid_errors/errors/index.html.erb