exception_hunter 0.1.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 461f614a3acb4efa1cabad37cc849850c45b0f186f627b016c5d48d09684b6c4
+  data.tar.gz: fa8c5abe1c5a2020d96ce5be459cacc624e227917eca8a5875046f528a021aa4
+SHA512:
+  metadata.gz: a057aff5a6cea927c804120a39b2c708a6e1d363d08d2707461c9fd0f39a8234bdb4cc7ca6b6e153f56cacf18d657eb88e0bd843c08953beef2aacfa2f721108
+  data.tar.gz: 68eafa484c4350384b5fd8bd38c131462d6634fe9ff344c62ab71c91fcd3995f1b7f8ad4700b5715b7c89ca86741469141364a412887fa5eda680a4f63fd1d30

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2020 Bruno Vezoli
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,45 @@
+# ExceptionHunter
+Short description and motivation.
+
+## Usage
+How to use my plugin.
+
+## Installation
+Add Exception Hunter to your application's Gemfile:
+
+```ruby
+gem 'exception_hunter', '~> 0.1.1'
+```
+
+You may also need to add [Devise](https://github.com/heartcombo/devise) to your Gemfile
+if you haven't already done so and plan to use the gem's built in authentication:
+
+```ruby
+gem 'devise'
+```
+
+After installing the dependencies you'll want to run:
+
+```bash
+$ rails generate exception_hunter:install
+```
+
+This will create an initializer and invoke Devise to
+create an `AdminUser` which will be used for authentication to access the dashboard. If you already
+have this user created (Devise uses the same model) you can run the command with the `--skip-users` flag.
+
+Additionally it should add the 'ExceptionHunter.routes(self)' line to your routes, which means you can go to
+`/exception_hunter/errors` in your browser and start enjoying some good old fashioned exception tracking!
+
+## Contributing
+Contribution directions go here.
+
+## License
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Credits
+
+Exception Hunter is maintained by [Rootstrap](http://www.rootstrap.com) with
+the help of our [contributors](https://github.com/rootstrap/exception_hunter/contributors).
+
+[<img src="https://s3-us-west-1.amazonaws.com/rootstrap.com/img/rs.png" width="100"/>](http://www.rootstrap.com)

data/Rakefile

@@ -0,0 +1,22 @@
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+
+require 'rdoc/task'
+
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'ExceptionHunter'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.md')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+APP_RAKEFILE = File.expand_path('spec/dummy/Rakefile', __dir__)
+load 'rails/tasks/engine.rake'
+
+load 'rails/tasks/statistics.rake'
+
+load 'lib/tasks/code_analysis.rake'

data/app/assets/config/exception_hunter_manifest.js

@@ -0,0 +1,3 @@
+//= link_directory ../stylesheets/exception_hunter .css
+//= link_directory ../images/exception_hunter
+

data/app/assets/stylesheets/exception_hunter/application.css

@@ -0,0 +1,15 @@
+/*
+ * This is a manifest file that'll be compiled into application.css, which will include all the files
+ * listed below.
+ *
+ * Any CSS and SCSS file within this directory, lib/assets/stylesheets, vendor/assets/stylesheets,
+ * or any plugin's vendor/assets/stylesheets directory can be referenced here using a relative path.
+ *
+ * You're free to add application-wide styles to this file and they'll appear at the bottom of the
+ * compiled file so the styles you add here take precedence over styles defined in any other CSS/SCSS
+ * files in this directory. Styles in this file should be added after the last require_* statement.
+ * It is generally better to create a new file per style scope.
+ *
+ *= require_tree .
+ *= require_self
+ */

data/app/assets/stylesheets/exception_hunter/base.css

@@ -0,0 +1,19 @@
+:root {
+    --main-color: #C8193C;
+    --secondary-color: #F4F5F6;
+    --link-color: #158FEF;
+    --border-color: #D1D1D1;
+    --file-name-color: #16AF90
+}
+
+.wrapper {
+    margin: 5.5rem auto auto;
+}
+
+a {
+    color: var(--link-color);
+}
+
+a:hover, a:focus, a:active {
+    color: var(--main-color);
+}

data/app/assets/stylesheets/exception_hunter/errors.css

@@ -0,0 +1,84 @@
+/*
+  Place all the styles related to the matching controller here.
+  They will automatically be included in application.css.
+*/
+
+.row.statistics-row {
+    padding-top: 1rem;
+}
+
+.statistics__cell {
+    color: var(--main-color);
+    background-color: var(--secondary-color);
+    border: 1px solid var(--border-color);
+    height: 5rem;
+    border-radius: 10px;
+    display: flex;
+    align-items: center;
+    justify-content: center;
+    font-size: 2.2rem;
+}
+
+.row.error-row {
+    padding-top: 1rem;
+    padding-bottom: 1rem;
+    border-bottom: 1px solid;
+}
+
+.row.error-row-no-border {
+    padding-top: 1rem;
+    padding-bottom: 1rem;
+}
+
+.error-row.error-row--header {
+    font-weight: bold;
+}
+
+.error-cell.error-cell--highlight {
+    color: var(--main-color);
+}
+
+.error-title {
+    font-size: 20px;
+    border-bottom: 1px solid var(--border-color);
+}
+
+.error-occurred_at {
+    color: var(--main-color);
+    font-size: 14px;
+    margin-top: 0.5em;
+    margin-bottom: 2em;
+}
+
+.tab-content {
+    padding: 1em 0.5em;
+}
+
+.data-title {
+    font-weight: bold;
+    color: var(--main-color);
+}
+
+.backtrace {
+    padding-top: 1em;
+    padding-bottom: 1em;
+    overflow-x: scroll;
+}
+
+.backtrace-line {
+    white-space: nowrap;
+    margin-top: .3em;
+    margin-bottom: .3em;
+    display: flex;
+    font-family: "Courier New", Courier, monospace;
+    font-size: 14px;
+}
+
+.backtrace-line__line-number {
+    margin-right: 5px;
+    color: var(--main-color);
+}
+
+.backtrace-line__file-name {
+    color: var(--file-name-color);
+}

data/app/assets/stylesheets/exception_hunter/navigation.css

@@ -0,0 +1,21 @@
+.nav {
+    background: var(--secondary-color);
+    border-bottom: .1rem solid var(--border-color);
+    display: block;
+    height: 5.2rem;
+    left: 0;
+    max-width: 100%;
+    position: fixed;
+    right: 0;
+    top: 0;
+    width: 100%;
+    z-index: 1;
+}
+.container__nav {
+    display: flex;
+    height: 100%;
+}
+
+.nav__logo img {
+    height: 100%;
+}

data/app/controllers/exception_hunter/application_controller.rb

@@ -0,0 +1,5 @@
+module ExceptionHunter
+  class ApplicationController < ActionController::Base
+    protect_from_forgery with: :exception
+  end
+end

data/app/controllers/exception_hunter/errors_controller.rb

@@ -0,0 +1,24 @@
+require_dependency 'exception_hunter/application_controller'
+
+module ExceptionHunter
+  class ErrorsController < ApplicationController
+    include Pagy::Backend
+
+    def index
+      @errors = ErrorGroup.all.order(created_at: :desc)
+      @errors_count = Error.count
+      @month_errors = Error.in_current_month.count
+    end
+
+    def show
+      @pagy, errors = pagy(most_recent_errors, items: 1)
+      @error = ErrorPresenter.new(errors.first)
+    end
+
+    private
+
+    def most_recent_errors
+      Error.most_recent(params[:id])
+    end
+  end
+end

data/app/helpers/exception_hunter/application_helper.rb

@@ -0,0 +1,5 @@
+module ExceptionHunter
+  module ApplicationHelper
+    include Pagy::Frontend
+  end
+end

data/app/jobs/exception_hunter/application_job.rb

@@ -0,0 +1,4 @@
+module ExceptionHunter
+  class ApplicationJob < ActiveJob::Base
+  end
+end

data/app/mailers/exception_hunter/application_mailer.rb

@@ -0,0 +1,6 @@
+module ExceptionHunter
+  class ApplicationMailer < ActionMailer::Base
+    default from: 'from@example.com'
+    layout 'mailer'
+  end
+end

data/app/models/exception_hunter/application_record.rb

@@ -0,0 +1,5 @@
+module ExceptionHunter
+  class ApplicationRecord < ActiveRecord::Base
+    self.abstract_class = true
+  end
+end

data/app/models/exception_hunter/error.rb

@@ -0,0 +1,26 @@
+module ExceptionHunter
+  class Error < ApplicationRecord
+    validates :class_name, presence: true
+    validates :occurred_at, presence: true
+
+    belongs_to :error_group
+
+    before_validation :set_occurred_at, on: :create
+
+    scope :most_recent, lambda { |error_group_id|
+      where(error_group_id: error_group_id).order(occurred_at: :desc)
+    }
+
+    def self.in_current_month
+      current_month = Date.today.beginning_of_month..Date.today.end_of_month
+
+      where(occurred_at: current_month)
+    end
+
+    private
+
+    def set_occurred_at
+      self.occurred_at ||= Time.now
+    end
+  end
+end

data/app/models/exception_hunter/error_group.rb

@@ -0,0 +1,29 @@
+module ExceptionHunter
+  class ErrorGroup < ApplicationRecord
+    SIMILARITY_THRESHOLD = 0.75
+
+    validates :error_class_name, presence: true
+
+    has_many :grouped_errors, class_name: 'ExceptionHunter::Error'
+
+    scope :most_similar, lambda { |message|
+      quoted_message = ActiveRecord::Base.connection.quote_string(message)
+      where("similarity(exception_hunter_error_groups.message, :message) >= #{SIMILARITY_THRESHOLD}", message: message)
+        .order(Arel.sql("similarity(exception_hunter_error_groups.message, '#{quoted_message}') DESC"))
+    }
+
+    def self.find_matching_group(error)
+      where(error_class_name: error.class_name)
+        .most_similar(error.message.to_s)
+        .first
+    end
+
+    def last_occurrence
+      @last_occurrence ||= grouped_errors.maximum(:occurred_at)
+    end
+
+    def total_occurrences
+      @total_occurrences ||= grouped_errors.count
+    end
+  end
+end

data/app/presenters/exception_hunter/error_presenter.rb

@@ -0,0 +1,34 @@
+module ExceptionHunter
+  class ErrorPresenter
+    delegate_missing_to :error
+
+    BacktraceLine = Struct.new(:path, :file_name, :line_number, :method_call)
+
+    def initialize(error)
+      @error = error
+    end
+
+    def backtrace
+      error.backtrace.map do |line|
+        format_backtrace_line(line)
+      end
+    end
+
+    private
+
+    attr_reader :error
+
+    def format_backtrace_line(line)
+      matches = line.match(%r{(?<path>.*)/(?<file_name>[^:]*):(?<line_number>\d*).*`(?<method_call>.*)'})
+
+      if matches.nil?
+        line
+      else
+        BacktraceLine.new(matches[:path],
+                          matches[:file_name],
+                          matches[:line_number],
+                          matches[:method_call])
+      end
+    end
+  end
+end

data/app/services/exception_hunter/error_creator.rb

@@ -0,0 +1,41 @@
+module ExceptionHunter
+  class ErrorCreator
+    class << self
+      def call(**error_attrs)
+        ActiveRecord::Base.transaction do
+          error_attrs = extract_user_data(error_attrs)
+          error = Error.new(error_attrs)
+          error_group = ErrorGroup.find_matching_group(error) || ErrorGroup.new
+          update_error_group(error_group, error)
+          error.error_group = error_group
+          error.save!
+          error
+        end
+      rescue ActiveRecord::RecordInvalid
+        false
+      end
+
+      private
+
+      def update_error_group(error_group, error)
+        error_group.error_class_name = error.class_name
+        error_group.message = error.message
+
+        error_group.save!
+      end
+
+      def extract_user_data(**error_attrs)
+        user = error_attrs[:user]
+        error_attrs[:user_data] =
+          if user.nil?
+            {}
+          else
+            UserAttributesCollector.collect_attributes(user)
+          end
+
+        error_attrs.delete(:user)
+        error_attrs
+      end
+    end
+  end
+end

data/app/views/exception_hunter/errors/_error_backtrace.erb

@@ -0,0 +1,20 @@
+<% if error.backtrace.empty? %>
+  Unfortunately, no backtrace has been registered for this error.
+<% else %>
+  <div class="backtrace">
+    <% error.backtrace.each do |line| %>
+      <div class="backtrace-line">
+        <% if line.is_a?(String) %>
+          <%= line %>
+        <% else %>
+          <div class="backtrace-line__path"><%= line.path %></div>
+          /
+          <div class="backtrace-line__file-name"><%= line.file_name %></div>
+          :
+          <div class="backtrace-line__line-number"><%= line.line_number %></div>
+          <div class="backtrace-line__method-call"><%= line.method_call %></div>
+        <% end %>
+      </div>
+    <% end %>
+  </div>
+<% end %>

data/app/views/exception_hunter/errors/_error_summary.erb

@@ -0,0 +1,24 @@
+<% if error.environment_data.empty? %>
+  <div class="row error-row-no-border data-title">
+    Unfortunately, no environment information has been registered for this error.
+  </div>
+<% else %>
+  <div class="row error-row-no-border data-title">
+    Environment Data
+  </div>
+  <% error.environment_data.each do |key, value| %>
+    <b><%= key %></b>: <%= value %><br>
+  <% end %>
+<% end %>
+<% if error.custom_data.nil? %>
+  <div class="row error-row-no-border data-title">
+    No custom data included.
+  </div>
+<% else %>
+  <div class="row error-row-no-border data-title">
+    Custom Data
+  </div>
+  <% error.custom_data.each do |key, value| %>
+    <b><%= key %></b>: <%= value || 'None' %> <br>
+  <% end %>
+<% end %>

data/app/views/exception_hunter/errors/_error_user_data.erb

@@ -0,0 +1,11 @@
+<% if error.user_data.empty? %>
+  <div class="data-title">
+    Unfortunately, no user information has been registered for this error.
+  </div>
+<% else %>
+  <% error.user_data.transform_keys(&:to_sym).each do |key, value| %>
+    <div class="column column-15">
+      <b><%= key %></b>: <%= value %>
+    </div>
+  <% end %>
+<% end %>

data/app/views/exception_hunter/errors/index.html.erb

@@ -0,0 +1,36 @@
+<div class="row statistics-row">
+  <div class="column column-offset-50 column-25">
+    <div class="statistics__cell">
+      <%= number_with_delimiter(@errors_count) %> Total errors
+    </div>
+  </div>
+  <div class="column column-25">
+    <div class="statistics__cell">
+      <%= number_with_delimiter(@month_errors) %> Errors this month
+    </div>
+  </div>
+</div>
+
+<div class="row error-row error-row--header">
+  <div class="column column-75">Message</div>
+  <div class="column column-15">Last Occurrence</div>
+  <div class="column column-10">Occurrences</div>
+</div>
+
+<% @errors.each do |error| %>
+  <div class="row error-row">
+    <div class="column column-75 error-cell">
+      <%= link_to error.message, error_path(error.id) %>
+    </div>
+    <div class="column column-15 error-cell error-cell--highlight">
+      <% if error.last_occurrence.present? %>
+        <%= time_ago_in_words(error.last_occurrence) %> ago
+      <% else %>
+        Never
+      <% end %>
+    </div>
+    <div class="column column-10 error-cell error-cell--highlight">
+      <%= error.total_occurrences %>
+    </div>
+  </div>
+<% end %>

data/app/views/exception_hunter/errors/pagy/_pagy_nav.html.erb

@@ -0,0 +1,17 @@
+<% link = pagy_link_proc(pagy) %>
+<nav aria-label="pager" class="pagy_nav pagination" role="navigation">
+  <% if pagy.prev %>
+  <span class="page prev"><%== link.call(pagy.prev, '◄', 'aria-label="previous"') %></span>
+  <% else %>
+    <span class="page prev disabled">
+      ◄
+    </span>
+  <% end %>
+  <% if pagy.next %>
+    <span class="page next"><%== link.call(pagy.next, '►', 'aria-label="next"') %></span>
+  <% else %>
+    <span class="page next disabled">
+      ►
+    </span>
+  <% end %>
+</nav>

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

@@ -0,0 +1,36 @@
+<div class="row">
+  <div class="column column-offset-80 column-20">
+    <%= render partial: 'exception_hunter/errors/pagy/pagy_nav', locals: { pagy: @pagy } %>
+  </div>
+</div>
+
+<div class="error-title">
+  <%= @error.class_name %>: <%= @error.message %>
+</div>
+<div class="error-occurred_at">
+  <%= @error.occurred_at %>
+</div>
+
+<ul data-tabs>
+  <li><a data-tabby-default href="#summary">Summary</a></li>
+  <li><a href="#backtrace">Backtrace</a></li>
+  <li><a href="#user-data">User Data</a></li>
+</ul>
+
+<div class="tab-content">
+  <div id="summary">
+    <%= render partial: 'exception_hunter/errors/error_summary', locals: { error: @error } %>
+  </div>
+
+  <div id="backtrace">
+    <%= render partial: 'exception_hunter/errors/error_backtrace', locals: { error: @error } %>
+  </div>
+
+  <div id="user-data">
+    <%= render partial: 'exception_hunter/errors/error_user_data', locals: { error: @error } %>
+  </div>
+</div>
+
+<script type="text/javascript" charset="utf-8">
+  const tabs = new Tabby('[data-tabs]')
+</script>

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

@@ -0,0 +1,39 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <title>Exception Hunter</title>
+  <%= csrf_meta_tags %>
+  <%= csp_meta_tag %>
+
+  <%= favicon_link_tag 'exception_hunter/logo.png' %>
+
+  <link rel="stylesheet" href="//fonts.googleapis.com/css?family=Roboto:300,300italic,700,700italic">
+  <link rel="stylesheet" href="//cdnjs.cloudflare.com/ajax/libs/normalize/5.0.0/normalize.css">
+  <link rel="stylesheet" href="//cdnjs.cloudflare.com/ajax/libs/milligram/1.3.0/milligram.css">
+
+  <!-- Get patch fixes within a minor version -->
+  <link rel="stylesheet" type="text/css" href="https://cdn.jsdelivr.net/gh/cferdinandi/tabby@12.0/dist/css/tabby-ui.min.css">
+  <script src="https://cdn.jsdelivr.net/gh/cferdinandi/tabby@12.0/dist/js/tabby.polyfills.min.js"></script>
+
+  <%= stylesheet_link_tag "exception_hunter/application", media: "all" %>
+</head>
+<body>
+
+<div class="wrapper">
+  <nav class="nav">
+    <div class="container container__nav">
+      <div class="nav__logo">
+        <%= link_to errors_path do %>
+          <%= image_tag 'exception_hunter/logo.png', alt: 'Logo' %>
+        <% end %>
+      </div>
+    </div>
+  </nav>
+
+  <div class="container">
+    <%= yield %>
+  </div>
+</div>
+
+</body>
+</html>

data/config/initializers/exception_hunter.rb

@@ -0,0 +1,16 @@
+ExceptionHunter.setup do |config|
+  # == Current User
+  #
+  # Exception Hunter will include the user as part of the environment
+  # data, if it was to be available. The default configuration uses devise
+  # :current_user method. You can change it in case
+  #
+  config.current_user_method = :current_user
+
+  # == Current User Attributes
+  #
+  # Exception Hunter will try to include the attributes defined here
+  # as part of the user information that is kept from the request.
+  #
+  config.user_attributes = [:id, :email]
+end

data/config/rails_best_practices.yml

@@ -0,0 +1,42 @@
+AddModelVirtualAttributeCheck: { }
+AlwaysAddDbIndexCheck: { }
+#CheckSaveReturnValueCheck: { }
+#CheckDestroyReturnValueCheck: { }
+DefaultScopeIsEvilCheck: { }
+DryBundlerInCapistranoCheck: { }
+#HashSyntaxCheck: { }
+IsolateSeedDataCheck: { }
+KeepFindersOnTheirOwnModelCheck: { }
+LawOfDemeterCheck: { }
+#LongLineCheck: { max_line_length: 80 }
+MoveCodeIntoControllerCheck: { }
+MoveCodeIntoHelperCheck: { array_count: 3 }
+MoveCodeIntoModelCheck: { use_count: 2 }
+MoveFinderToNamedScopeCheck: { }
+MoveModelLogicIntoModelCheck: { use_count: 4 }
+NeedlessDeepNestingCheck: { nested_count: 2 }
+NotRescueExceptionCheck: { ignored_files: 'request_hunter.rb' }
+NotUseDefaultRouteCheck: { }
+NotUseTimeAgoInWordsCheck: { ignored_files: ['index.html.erb'] }
+OveruseRouteCustomizationsCheck: { customize_count: 3 }
+ProtectMassAssignmentCheck: { }
+RemoveEmptyHelpersCheck: { }
+#RemoveTabCheck: { }
+RemoveTrailingWhitespaceCheck: { }
+RemoveUnusedMethodsInControllersCheck: { except_methods: [] }
+RemoveUnusedMethodsInHelpersCheck: { except_methods: [] }
+RemoveUnusedMethodsInModelsCheck: { except_methods: [] }
+ReplaceComplexCreationWithFactoryMethodCheck: { attribute_assignment_count: 2 }
+ReplaceInstanceVariableWithLocalVariableCheck: { }
+RestrictAutoGeneratedRoutesCheck: { }
+SimplifyRenderInControllersCheck: { }
+SimplifyRenderInViewsCheck: { }
+#UseBeforeFilterCheck: { customize_count: 2 }
+UseModelAssociationCheck: { }
+UseMultipartAlternativeAsContentTypeOfEmailCheck: { }
+#UseParenthesesInMethodDefCheck: { }
+UseObserverCheck: { }
+UseQueryAttributeCheck: { }
+UseSayWithTimeInMigrationsCheck: { }
+UseScopeAccessCheck: { }
+UseTurboSprocketsRails3Check: { }

data/config/routes.rb

@@ -0,0 +1,3 @@
+ExceptionHunter::Engine.routes.draw do
+  resources :errors, only: %i[index show]
+end

data/lib/exception_hunter.rb

@@ -0,0 +1,15 @@
+require 'exception_hunter/engine'
+require 'exception_hunter/railtie'
+require 'exception_hunter/config'
+require 'exception_hunter/user_attributes_collector'
+require 'pagy'
+
+module ExceptionHunter
+  def self.setup(&block)
+    block.call(Config)
+  end
+
+  def self.routes(router)
+    router.mount(ExceptionHunter::Engine, at: 'exception_hunter')
+  end
+end

data/lib/exception_hunter/config.rb

@@ -0,0 +1,5 @@
+module ExceptionHunter
+  class Config
+    cattr_accessor :current_user_method, :user_attributes
+  end
+end

data/lib/exception_hunter/engine.rb

@@ -0,0 +1,16 @@
+module ExceptionHunter
+  class Engine < ::Rails::Engine
+    isolate_namespace ExceptionHunter
+
+    config.generators do |gen|
+      gen.test_framework :rspec
+      gen.fixture_replacement :factory_bot
+      gen.factory_bot dir: 'spec/factories'
+    end
+
+    initializer 'exception_hunter.precompile', group: :all do |app|
+      app.config.assets.precompile << 'exception_hunter/application.css'
+      app.config.assets.precompile << 'exception_hunter/logo.png'
+    end
+  end
+end

data/lib/exception_hunter/railtie.rb

@@ -0,0 +1,11 @@
+require_dependency 'exception_hunter/request_hunter'
+
+module ExceptionHunter
+  class Railtie < Rails::Railtie
+    initializer 'exception_hunter.add_middleware', after: :load_config_initializers do |app|
+      app.config.middleware.insert_after(
+        ActionDispatch::DebugExceptions, ExceptionHunter::RequestHunter
+      )
+    end
+  end
+end

data/lib/exception_hunter/request_hunter.rb

@@ -0,0 +1,41 @@
+module ExceptionHunter
+  class RequestHunter
+    ENVIRONMENT_KEYS =
+      %w[PATH_INFO QUERY_STRING REMOTE_HOST REQUEST_METHOD REQUEST_URI
+         SERVER_PROTOCOL HTTP_HOST HTTP_USER_AGENT].freeze
+
+    def initialize(app)
+      @app = app
+    end
+
+    def call(env)
+      @app.call(env)
+    rescue Exception => exception
+      catch_prey(env, exception)
+      raise exception
+    end
+
+    private
+
+    def catch_prey(env, exception)
+      user = user_from_env(env)
+      ErrorCreator.call(
+        class_name: exception.class.to_s,
+        message: exception.message,
+        environment_data: environment_data(env),
+        backtrace: exception.backtrace,
+        user: user
+      )
+    end
+
+    def environment_data(env)
+      env.select { |key, _value| ENVIRONMENT_KEYS.include?(key) }
+    end
+
+    def user_from_env(env)
+      current_user_method = Config.current_user_method
+      controller = env['action_controller.instance']
+      controller.try(current_user_method)
+    end
+  end
+end

data/lib/exception_hunter/user_attributes_collector.rb

@@ -0,0 +1,15 @@
+module ExceptionHunter
+  module UserAttributesCollector
+    extend self
+
+    def collect_attributes(user)
+      attributes.reduce({}) do |data, attribute|
+        data.merge(attribute => user.try(attribute))
+      end
+    end
+
+    def attributes
+      Config.user_attributes
+    end
+  end
+end

data/lib/exception_hunter/version.rb

@@ -0,0 +1,3 @@
+module ExceptionHunter
+  VERSION = '0.1.1'.freeze
+end

data/lib/generators/exception_hunter/create_users/create_users_generator.rb

@@ -0,0 +1,28 @@
+module ExceptionHunter
+  class CreateUsersGenerator < Rails::Generators::NamedBase
+    argument :name, type: :string, default: 'AdminUser'
+
+    def install_devise
+      begin
+        require 'devise'
+      rescue LoadError
+        log :error, 'Please install devise and require add it to your gemfile or run with --skip-users'
+        exit(false)
+      end
+
+      initializer_file =
+        File.join(destination_root, 'config', 'initializers', 'devise.rb')
+
+      if File.exist?(initializer_file)
+        log :generate, 'No need to install devise, already done.'
+      else
+        log :generate, 'devise:install'
+        invoke 'devise:install'
+      end
+    end
+
+    def create_admin_user
+      invoke 'devise', [name]
+    end
+  end
+end

data/lib/generators/exception_hunter/install/USAGE

@@ -0,0 +1,6 @@
+Description:
+    Generates an initializer and the needed setup to use the ExceptionHunter gem. It also
+    creates a user for developers to access the dashboard by invoking devise.
+
+Example:
+    rails generate exception_hunter:install SuperUser

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

@@ -0,0 +1,30 @@
+require 'rails/generators/active_record'
+
+module ExceptionHunter
+  class InstallGenerator < ActiveRecord::Generators::Base
+    source_root File.expand_path('templates', __dir__)
+
+    argument :name, type: :string, default: 'AdminUser'
+    hook_for :users, default: 'create_users', desc: 'Admin user generator to run. Skip with --skip-users'
+
+    def copy_initializer
+      @underscored_user_name = name.underscore.gsub('/', '_')
+      @use_authentication_method = options[:users].present?
+      template 'exception_hunter.rb.erb', 'config/initializers/exception_hunter.rb'
+    end
+
+    def setup_routes
+      if options[:users]
+        inject_into_file 'config/routes.rb', "\n  ExceptionHunter.routes(self)", after: /devise_for .*/
+      else
+        route 'ExceptionHunter.routes(self)'
+      end
+    end
+
+    def create_migrations
+      migration_template 'create_exception_hunter_error_groups.rb.erb',
+                         'db/migrate/create_exception_hunter_error_groups.rb'
+      migration_template 'create_exception_hunter_errors.rb.erb', 'db/migrate/create_exception_hunter_errors.rb'
+    end
+  end
+end

data/lib/generators/exception_hunter/install/templates/create_exception_hunter_error_groups.rb.erb

@@ -0,0 +1,14 @@
+class CreateExceptionHunterErrorGroups < ActiveRecord::Migration[<%= ActiveRecord::Migration.current_version.to_s %>]
+  def change
+    enable_extension :pg_trgm
+
+    create_table :exception_hunter_error_groups do |t|
+      t.string :error_class_name, null: false
+      t.string :message
+
+      t.timestamps
+
+      t.index :message, opclass: :gin_trgm_ops, using: :gin
+    end
+  end
+end

data/lib/generators/exception_hunter/install/templates/create_exception_hunter_errors.rb.erb

@@ -0,0 +1,19 @@
+class CreateExceptionHunterErrors < ActiveRecord::Migration[<%= ActiveRecord::Migration.current_version.to_s %>]
+  def change
+    create_table :exception_hunter_errors do |t|
+      t.string :class_name, null: false
+      t.string :message
+      t.timestamp :occurred_at, null: false
+      t.json :environment_data
+      t.json :custom_data
+      t.json :user_data
+      t.string :backtrace, array: true, default: []
+
+      t.belongs_to :error_group,
+                   index: true,
+                   foreign_key: { to_table: :exception_hunter_error_groups }
+
+      t.timestamps
+    end
+  end
+end

data/lib/generators/exception_hunter/install/templates/exception_hunter.rb.erb

@@ -0,0 +1,18 @@
+ExceptionHunter.setup do |config|
+  # == Current User
+  #
+  # Exception Hunter will include the user as part of the environment
+  # data, if it was to be available. The default configuration uses devise
+  # :current_user method. You can change it in case you named your user model
+  # in some other way (i.e. Member). You can also remove the configuration if
+  # you don't wish to track user data.
+  #
+  config.current_user_method = :current_user
+
+  # == Current User Attributes
+  #
+  # Exception Hunter will try to include the attributes defined here
+  # as part of the user information that is kept from the request.
+  #
+  config.user_attributes = [:id, :email]
+end

data/lib/tasks/code_analysis.rake

@@ -0,0 +1,7 @@
+desc 'code analysis'
+task :code_analysis do
+  sh 'bundle exec brakeman . -z -q'
+  sh 'bundle exec rubocop app config lib spec'
+  sh 'bundle exec reek app config lib'
+  sh 'bundle exec rails_best_practices .'
+end

data/lib/tasks/exception_hunter_tasks.rake

@@ -0,0 +1,4 @@
+# desc "Explaining what the task does"
+# task :exception_hunter do
+#   # Task goes here
+# end

metadata

@@ -0,0 +1,200 @@
+--- !ruby/object:Gem::Specification
+name: exception_hunter
+version: !ruby/object:Gem::Version
+  version: 0.1.1
+platform: ruby
+authors:
+- Bruno Vezoli
+- Tiziana Romani
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2020-05-17 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: pagy
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.8'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.8'
+- !ruby/object:Gem::Dependency
+  name: brakeman
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.8'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.8'
+- !ruby/object:Gem::Dependency
+  name: factory_bot_rails
+  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'
+- !ruby/object:Gem::Dependency
+  name: pg
+  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'
+- !ruby/object:Gem::Dependency
+  name: rails_best_practices
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.20'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.20'
+- !ruby/object:Gem::Dependency
+  name: reek
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.6'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.80.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.80.1
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.18.5
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.18.5
+description: 
+email:
+- bruno.vezoli@rootstrap.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- MIT-LICENSE
+- README.md
+- Rakefile
+- app/assets/config/exception_hunter_manifest.js
+- app/assets/images/exception_hunter/logo.png
+- app/assets/stylesheets/exception_hunter/application.css
+- app/assets/stylesheets/exception_hunter/base.css
+- app/assets/stylesheets/exception_hunter/errors.css
+- app/assets/stylesheets/exception_hunter/navigation.css
+- app/controllers/exception_hunter/application_controller.rb
+- app/controllers/exception_hunter/errors_controller.rb
+- app/helpers/exception_hunter/application_helper.rb
+- app/jobs/exception_hunter/application_job.rb
+- app/mailers/exception_hunter/application_mailer.rb
+- app/models/exception_hunter/application_record.rb
+- app/models/exception_hunter/error.rb
+- app/models/exception_hunter/error_group.rb
+- app/presenters/exception_hunter/error_presenter.rb
+- app/services/exception_hunter/error_creator.rb
+- app/views/exception_hunter/errors/_error_backtrace.erb
+- app/views/exception_hunter/errors/_error_summary.erb
+- app/views/exception_hunter/errors/_error_user_data.erb
+- app/views/exception_hunter/errors/index.html.erb
+- app/views/exception_hunter/errors/pagy/_pagy_nav.html.erb
+- app/views/exception_hunter/errors/show.html.erb
+- app/views/layouts/exception_hunter/application.html.erb
+- config/initializers/exception_hunter.rb
+- config/rails_best_practices.yml
+- config/routes.rb
+- lib/exception_hunter.rb
+- lib/exception_hunter/config.rb
+- lib/exception_hunter/engine.rb
+- lib/exception_hunter/railtie.rb
+- lib/exception_hunter/request_hunter.rb
+- lib/exception_hunter/user_attributes_collector.rb
+- lib/exception_hunter/version.rb
+- lib/generators/exception_hunter/create_users/create_users_generator.rb
+- lib/generators/exception_hunter/install/USAGE
+- lib/generators/exception_hunter/install/install_generator.rb
+- lib/generators/exception_hunter/install/templates/create_exception_hunter_error_groups.rb.erb
+- lib/generators/exception_hunter/install/templates/create_exception_hunter_errors.rb.erb
+- lib/generators/exception_hunter/install/templates/exception_hunter.rb.erb
+- lib/tasks/code_analysis.rake
+- lib/tasks/exception_hunter_tasks.rake
+homepage: https://github.com/rootstrap/exception_hunter
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.5.5
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.0.8
+signing_key: 
+specification_version: 4
+summary: Exception tracking engine
+test_files: []