error_ready 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 54c1d662e9dc0e27d2c488f68e32a26bba5182884dcb6937bcf470bc61db8662
+  data.tar.gz: 7a72b704734f9ae5644442df7d589571bff00488a705c0261d0daaf45964c2de
+SHA512:
+  metadata.gz: 2fd231f46958d06ec1aef6421e52113b6172ae3470e9f93fd3e2134224be7a3c7ddadd102a30c95cd928ef85e4a96c81d7ea476fa3c31a3a35c12f2b1c739b8d
+  data.tar.gz: bcaa37cfcbf86880a73fac9eb7de3b0795f867520eb56137b14bf2e9af1bc2606c8f8a638c4ccf5af2b0622c33e655ba9bf910f72339f2f336aa5bbcd7de98e8

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2022 Moses Gathuku
+
+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,30 @@
+# ErrorReady
+A plugin thats records errors and store them in the database you already have.
+
+![Showcase image](app/assets/images/error_ready/showcase.png)
+
+## Usage
+coming soon
+
+## Installation
+Add this line to your application's Gemfile:
+
+```ruby
+gem "error_ready"
+```
+
+And then execute:
+```bash
+$ bundle
+```
+
+Or install it yourself as:
+```bash
+$ gem install error_ready
+```
+
+## 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).

data/Rakefile

@@ -0,0 +1,8 @@
+require "bundler/setup"
+
+APP_RAKEFILE = File.expand_path("test/dummy/Rakefile", __dir__)
+load "rails/tasks/engine.rake"
+
+load "rails/tasks/statistics.rake"
+
+require "bundler/gem_tasks"

data/app/assets/config/error_ready_manifest.js

@@ -0,0 +1 @@
+//= link_directory ../stylesheets/error_ready .css

data/app/assets/stylesheets/error_ready/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/controllers/error_ready/application_controller.rb

@@ -0,0 +1,4 @@
+module ErrorReady
+  class ApplicationController < ActionController::Base
+  end
+end

data/app/controllers/error_ready/problems_controller.rb

@@ -0,0 +1,26 @@
+module ErrorReady
+  class ProblemsController < ApplicationController
+    before_action :set_problem, only: %i[ show destroy ]
+
+    # GET /problems
+    def index
+      @problems = Problem.latest_first
+    end
+
+    # GET /problems/1
+    def show
+    end
+
+    # DELETE /problems/1
+    def destroy
+      @problem.destroy
+      redirect_to problems_url, notice: "Problem was successfully destroyed."
+    end
+
+    private
+      # Use callbacks to share common setup or constraints between actions.
+      def set_problem
+        @problem = Problem.find(params[:id])
+      end
+  end
+end

data/app/helpers/error_ready/application_helper.rb

@@ -0,0 +1,4 @@
+module ErrorReady
+  module ApplicationHelper
+  end
+end

data/app/helpers/error_ready/problems_helper.rb

@@ -0,0 +1,4 @@
+module ErrorReady
+  module ProblemsHelper
+  end
+end

data/app/jobs/error_ready/application_job.rb

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

data/app/mailers/error_ready/application_mailer.rb

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

data/app/models/error_ready/application_record.rb

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

data/app/models/error_ready/notice.rb

@@ -0,0 +1,5 @@
+module ErrorReady
+  class Notice < ApplicationRecord
+    belongs_to :problem, foreign_key: "error_ready_problem_id"
+  end
+end

data/app/models/error_ready/problem.rb

@@ -0,0 +1,15 @@
+module ErrorReady
+  class Problem < ApplicationRecord
+
+    has_many :notices, foreign_key: "error_ready_problem_id"
+
+    attribute :first_notice_at, :datetime, default: Time.current
+    attribute :last_notice_at, :datetime, default: Time.current
+    attribute :notices_count, :integer, default: 0
+
+    scope :resolved, -> { where.not(resolved_at: nil) }
+    scope :unresolved,  -> { where(resolved_at: nil) }
+    scope :latest_first, -> { order(last_notice_at: :desc)}
+
+  end
+end

data/app/views/error_ready/problems/_problem.html.erb

@@ -0,0 +1,33 @@
+   <li>
+      <%= link_to problem_path(problem), class:"block hover:bg-gray-50" do %>
+        <div class="flex items-center py-4 ">
+          <div class="min-w-0 flex-1 sm:flex sm:items-center sm:justify-between">
+            <div class="truncate">
+              <div class="flex text-sm">
+                <p class="truncate font-medium text-indigo-600"><%= problem.err_class %></p>
+                <p class="ml-1 flex-shrink-0 font-normal text-gray-500">in <%= problem.environment %></p>
+              </div>
+              <div class="mt-2">
+                <div class="flex items-center text-sm text-gray-500">
+                  <!-- Heroicon name: mini/calendar -->
+                  <svg class="mr-1.5 h-5 w-5 flex-shrink-0 text-gray-400" xmlns="http://www.w3.org/2000/svg" viewBox="0 0 20 20" fill="currentColor" aria-hidden="true">
+                    <path fill-rule="evenodd" d="M5.75 2a.75.75 0 01.75.75V4h7V2.75a.75.75 0 011.5 0V4h.25A2.75 2.75 0 0118 6.75v8.5A2.75 2.75 0 0115.25 18H4.75A2.75 2.75 0 012 15.25v-8.5A2.75 2.75 0 014.75 4H5V2.75A.75.75 0 015.75 2zm-1 5.5c-.69 0-1.25.56-1.25 1.25v6.5c0 .69.56 1.25 1.25 1.25h10.5c.69 0 1.25-.56 1.25-1.25v-6.5c0-.69-.56-1.25-1.25-1.25H4.75z" clip-rule="evenodd" />
+                  </svg>
+                  <p>
+                    Last notice on
+                    <time datetime="2020-01-07"><%= problem.last_notice_at %></time>
+                  </p>
+                </div>
+                <div class="mt-2">
+                  <span class="text-gray-700 text-sm truncate"><%= problem.message %></span>
+                </div>
+              </div>
+            </div>
+            
+          </div>
+          <div class="ml-5 flex-shrink-0 text-green-600">
+            <svg class="w-6 h-6" fill="none" stroke="currentColor" viewBox="0 0 24 24" xmlns="http://www.w3.org/2000/svg"><path stroke-linecap="round" stroke-linejoin="round" stroke-width="2" d="M9 12l2 2 4-4m6 2a9 9 0 11-18 0 9 9 0 0118 0z"></path></svg>
+          </div>
+        </div>
+      <% end %>
+    </li>

data/app/views/error_ready/problems/index.html.erb

@@ -0,0 +1,10 @@
+<p style="color: green"><%= notice %></p>
+<div class="mt-3">
+  <h1 class="font-bold text-gray-700 leading-tight text-2xl">Problems</h1>
+
+  <div id="problems" class="mt-3">
+    <ul class="divide-y">
+     <%= render @problems %>
+    </ul>
+  </div>
+</div>

data/app/views/error_ready/problems/show.html.erb

@@ -0,0 +1,28 @@
+
+<div class="mt-6">
+ <div class="flex justify-between items-center">
+    <span class="font-bold text-gray-700 text-xl"><%= @problem.err_class %></span>
+    <span class="bg-gray-200 rounded-md p-2 text-gray-800">Resolve</span>
+ </div>
+
+ <div>
+  <span class="block font-semibold">message:</span>
+  <%= @problem.message %>
+ </div>
+
+ <div class="mt-3">
+  <span class="font-semibold">Context:</span>
+  <% @problem.notices.first.context.each do |k,v| %>
+    <span class="block"><%= k.gsub('_', ' ').capitalize %>: <%= v %></span>
+  <% end %>
+ </div>
+
+ <div class="mt-3">
+  <span class="font-semibold">Backtrace:</span>
+  <div class="text-sm bg-gray-200 p-2">
+   <% @problem.notices.first.backtrace.each do |trace| %>
+   <span class="block"><%= trace %></span>
+   <% end %>
+  </div>
+ </div>
+</div>

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

@@ -0,0 +1,16 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <title>Error ready | <%= Rails.application.class.module_parent_name %></title>
+  <%= csrf_meta_tags %>
+  <%= csp_meta_tag %>
+
+  <%= stylesheet_link_tag    "error_ready/application", media: "all" %>
+  <script src="https://cdn.tailwindcss.com"></script>
+</head>
+<body class="min-h-screen">
+  <div class="mx-auto md:max-w-4xl">
+    <%= yield %>
+  </div>
+</body>
+</html>

data/config/routes.rb

@@ -0,0 +1,3 @@
+ErrorReady::Engine.routes.draw do
+  resources :problems
+end

data/db/migrate/20221005120809_create_error_ready_problems.rb

@@ -0,0 +1,16 @@
+class CreateErrorReadyProblems < ActiveRecord::Migration[7.0]
+  def change
+    create_table :error_ready_problems do |t|
+      t.text :message
+      t.string :err_class
+      t.string :environment
+      t.string :severity
+      t.datetime :first_notice_at
+      t.datetime :last_notice_at
+      t.integer :notices_count
+      t.datetime :resolved_at
+
+      t.timestamps
+    end
+  end
+end

data/db/migrate/20221005135120_create_error_ready_notices.rb

@@ -0,0 +1,11 @@
+class CreateErrorReadyNotices < ActiveRecord::Migration[7.0]
+  def change
+    create_table :error_ready_notices do |t|
+      t.references :error_ready_problem, null: false, foreign_key: true
+      t.json :backtrace
+      t.json :context
+
+      t.timestamps
+    end
+  end
+end

data/lib/error_ready/engine.rb

@@ -0,0 +1,11 @@
+module ErrorReady
+  class Engine < ::Rails::Engine
+    isolate_namespace ErrorReady
+
+    initializer "error_subscribe.error_ready" do |app|
+      Rails.error.subscribe(Subscriber.new)
+      # register midddleware
+      app.config.middleware.use(RackMiddleware)
+    end
+  end
+end

data/lib/error_ready/formatter.rb

@@ -0,0 +1,23 @@
+module ErrorReady
+  class Formatter
+    def initialize(error:, handled:, severity:, context:, source: nil)
+      @error = error 
+      @handled = handled
+      @severity = severity
+      @context = context
+      @source = source
+    end
+
+    def format
+      {
+        message: @error.message,
+        err_class: @error.class.to_s,
+        backtrace: @error.backtrace,
+        severity: @severity.to_s,
+        context: @context.transform_values(&:to_s),
+        source: @source,
+        environment: Rails.env
+      }
+    end
+  end
+end

data/lib/error_ready/notifiers/database.rb

@@ -0,0 +1,33 @@
+module ErrorReady
+  class Database
+    def initialize(formatted_error)
+      @error = formatted_error
+    end
+    
+    def call
+      problem = ErrorReady::Problem.find_or_create_by(
+        message: @error[:message],
+        err_class: @error[:err_class],
+        environment: @error[:environment],
+        severity: @error[:severity]
+      )
+      
+      create_notice(problem)
+    end
+
+    def create_notice(problem)
+      ActiveRecord::Base.transaction do
+        ErrorReady::Notice.create(
+          problem: problem,
+          backtrace: @error[:backtrace],
+          context: @error[:context]
+        )
+
+        problem.update(
+          notices_count: problem.notices_count + 1,
+          last_notice_at: Time.current,
+        )
+      end
+    end
+  end
+end

data/lib/error_ready/rack_middleware.rb

@@ -0,0 +1,19 @@
+module ErrorReady
+  class RackMiddleware
+    def initialize(app)
+      @app = app
+    end
+
+    def call(env)
+      Rails.error.set_context(
+        server_name: env["SERVER_NAME"],
+        http_host: env["HTTP_HOST"],
+        http_user_agent: env["HTTP_USER_AGENT"]
+      )
+
+      Rails.error.record do
+        @app.call(env)
+      end
+    end
+  end
+end

data/lib/error_ready/subscriber.rb

@@ -0,0 +1,16 @@
+module ErrorReady
+  class Subscriber
+    def report(error, handled:, severity:, context:, source: nil)
+      formatted_error = Formatter.new(
+        error: error, 
+        handled: handled,
+        severity: severity,
+        context: context, 
+        source: source
+      ).format
+
+      # Save to database
+      Database.new(formatted_error).call
+    end
+  end
+end

data/lib/error_ready/version.rb

@@ -0,0 +1,3 @@
+module ErrorReady
+  VERSION = "0.1.0"
+end

data/lib/error_ready.rb

@@ -0,0 +1,11 @@
+require "error_ready/version"
+require "error_ready/engine"
+
+module ErrorReady
+  autoload :Subscriber, "error_ready/subscriber"
+  autoload :RackMiddleware, "error_ready/rack_middleware"
+  autoload :Formatter, 'error_ready/formatter'
+
+  # notifiers
+  autoload :Database, "error_ready/notifiers/database"
+end

data/lib/tasks/error_ready_tasks.rake

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

metadata

@@ -0,0 +1,91 @@
+--- !ruby/object:Gem::Specification
+name: error_ready
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Moses Gathuku
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2022-10-07 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 7.0.4
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 7.0.4
+description: Description of ErrorReady.
+email:
+- mosesgathuku95@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- MIT-LICENSE
+- README.md
+- Rakefile
+- app/assets/config/error_ready_manifest.js
+- app/assets/images/error_ready/showcase.png
+- app/assets/stylesheets/error_ready/application.css
+- app/controllers/error_ready/application_controller.rb
+- app/controllers/error_ready/problems_controller.rb
+- app/helpers/error_ready/application_helper.rb
+- app/helpers/error_ready/problems_helper.rb
+- app/jobs/error_ready/application_job.rb
+- app/mailers/error_ready/application_mailer.rb
+- app/models/error_ready/application_record.rb
+- app/models/error_ready/notice.rb
+- app/models/error_ready/problem.rb
+- app/views/error_ready/problems/_problem.html.erb
+- app/views/error_ready/problems/index.html.erb
+- app/views/error_ready/problems/show.html.erb
+- app/views/layouts/error_ready/application.html.erb
+- config/routes.rb
+- db/migrate/20221005120809_create_error_ready_problems.rb
+- db/migrate/20221005135120_create_error_ready_notices.rb
+- lib/error_ready.rb
+- lib/error_ready/engine.rb
+- lib/error_ready/formatter.rb
+- lib/error_ready/notifiers/database.rb
+- lib/error_ready/rack_middleware.rb
+- lib/error_ready/subscriber.rb
+- lib/error_ready/version.rb
+- lib/tasks/error_ready_tasks.rake
+homepage: https://github.com/gathuku
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+  homepage_uri: https://github.com/gathuku
+  source_code_uri: https://github.com/gathuku
+  changelog_uri: https://github.com/gathuku
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.3.7
+signing_key:
+specification_version: 4
+summary: Summary of ErrorReady.
+test_files: []