duffy_log 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: df1ca47085a6b83d1df4421f75264659cfd0aaa2dea7228685a1ff1cc553a8cb
+  data.tar.gz: 1c99dc9adfe6f145e79f94d6028bc26d634523b4878a41eccee3de3dda39e863
+SHA512:
+  metadata.gz: b7f8448737deff737c64222318278e694c904d91bc4fa2cd2da23005ea08c0e82784d231a5f43603dfc05e3caafc9f7f2ed92c15feee1beb3cc7c6cec1050f1b
+  data.tar.gz: b09cfff025a1b672b9a4e1e53c28bb4425a335096cf24efdaff929c61dede12c25625ad3cccb446bd8c5ca1c5bd80fedcb6046597710efd9a553e8ced2d3f845

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2020 Jacob Duffy
+
+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,23 @@
+# DuffyLog
+Module to log rake tasks, expensive ETL steps etc.  
+Able to capture and report errors.
+
+## Usage
+Adds a single model `ProcessLog` which has to be used around the code you want to track.
+
+TODO: ADD EXAMPLES
+
+## Installation
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'duffy_log'
+```
+
+And then execute:
+```bash
+$ bundle
+```
+
+## 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,27 @@
+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    = 'DuffyLog'
+  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'
+
+require 'bundler/gem_tasks'
+
+# Set RSpec to run as the default rake task.
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new(:spec)
+task default: :spec

data/app/controllers/process_logs_controller.rb

@@ -0,0 +1,62 @@
+class ProcessLogsController < ApplicationController
+  before_action :set_process_log, only: [:show, :edit, :update, :destroy]
+
+  # GET /process_logs
+  def index
+    @process_logs = ProcessLog.all
+
+    @process_logs = @process_logs.where(key: params[:key]) if ProcessLog.pluck(:key).uniq.include?(params[:key])
+    @process_logs = @process_logs.where(status: params[:status]) if ProcessLog.pluck(:status).uniq.include?(params[:status])
+
+  end
+
+  # GET /process_logs/1
+  def show
+  end
+
+  # GET /process_logs/new
+  def new
+    @process_log = ProcessLog.new
+  end
+
+  # GET /process_logs/1/edit
+  def edit
+  end
+
+  # POST /process_logs
+  def create
+    @process_log = ProcessLog.new(process_log_params)
+
+    if @process_log.save
+      redirect_to @process_log, notice: 'Process log was successfully created.'
+    else
+      render :new
+    end
+  end
+
+  # PATCH/PUT /process_logs/1
+  def update
+    if @process_log.update(process_log_params)
+      redirect_to @process_log, notice: 'Process log was successfully updated.'
+    else
+      render :edit
+    end
+  end
+
+  # DELETE /process_logs/1
+  def destroy
+    @process_log.destroy
+    redirect_to process_logs_url, notice: 'Process log was successfully destroyed.'
+  end
+
+  private
+    # Use callbacks to share common setup or constraints between actions.
+    def set_process_log
+      @process_log = ProcessLog.find(params[:id])
+    end
+
+    # Only allow a trusted parameter "white list" through.
+    def process_log_params
+      params.require(:process_log).permit(:key, :status, :start_time, :end_time, :elapsed, :average_elapsed, :comment, :backtrace)
+    end
+end

data/app/models/process_log.rb

@@ -0,0 +1,91 @@
+class ProcessLog < ApplicationRecord
+
+  validates :key,         presence: true
+  validates :start_time,  presence: true
+  validates :status,      presence: true
+
+  before_validation { self.start_time     ||= Time.now }
+  before_validation { self.status         ||= "Started" }
+  before_save       { self.elapsed          = end_time && end_time - start_time }
+  before_save       { self.average_elapsed  = siblings.completed.sorted.limit(10).average(:elapsed) }
+
+
+  # Scopes
+  scope :completed, -> { where.not(elapsed: nil) }
+  scope :sorted,    -> { order(start_time: :desc) }  # Newest first
+
+
+  # Methods
+
+  def completed?
+    !!elapsed
+  end
+
+  def elapsed
+    super || [(Time.now - start_time).to_i, 86400].min
+  end
+
+  # Fail the Process Log.
+  # Pass in nothing for no comment or backtrace
+  # Pass in the Exception itself to automatically extract.
+  # Pass in comment and/or backtrace to set/overwrite.
+  def fail!(exception = nil, comment: nil, backtrace: nil)
+    self.status = "Fail"
+    self.end_time = Time.now
+
+    unless exception.blank?
+      self.comment = exception.to_s
+      self.backtrace = exception.backtrace.join("\n")
+    end
+
+    # Manually passed named arguments overwrite exception if that was also provided.
+    self.comment    = comment unless comment.blank?
+    self.comment  ||= 'Fail'
+    self.backtrace  = Array(backtrace).join("\n") unless backtrace.blank?
+
+    save
+  end
+
+  def fail?
+    status == "Fail"
+  end
+
+  def local_end
+    end_time&.localtime&.strftime("%F %-l:%M%P")
+  end
+
+  def local_start
+    start_time&.localtime&.strftime("%F %-l:%M%P")
+  end
+
+  def progress
+    success? ? 100 : [99, (100 * elapsed / average_elapsed).to_i].min rescue "?"
+  end
+
+  def siblings
+    ProcessLog.where(key: key)
+  end
+
+  def started?
+    status == "Started"
+  end
+
+  def status
+    elapsed >= 86400 ? "Fail" : super
+  end
+
+  def success!
+    self.status = "Success" unless status == "Fail"
+    self.end_time = Time.now
+    save!
+  end
+
+  def success?
+    status == "Success"
+  end
+
+  def to_s
+    key
+  end
+
+end

data/app/views/process_logs/_form.html.erb

@@ -0,0 +1,57 @@
+<%= form_with(model: process_log, local: true) do |form| %>
+  <% if process_log.errors.any? %>
+    <div id="error_explanation">
+      <h2><%= pluralize(process_log.errors.count, "error") %> prohibited this process_log from being saved:</h2>
+
+      <ul>
+        <% process_log.errors.full_messages.each do |message| %>
+          <li><%= message %></li>
+        <% end %>
+      </ul>
+    </div>
+  <% end %>
+
+  <div class="field">
+    <%= form.label :key %>
+    <%= form.text_field :key %>
+  </div>
+
+  <div class="field">
+    <%= form.label :status %>
+    <%= form.text_field :status %>
+  </div>
+
+  <div class="field">
+    <%= form.label :start_time %>
+    <%= form.datetime_select :start_time %>
+  </div>
+
+  <div class="field">
+    <%= form.label :end_time %>
+    <%= form.datetime_select :end_time %>
+  </div>
+
+  <div class="field">
+    <%= form.label :elapsed %>
+    <%= form.number_field :elapsed %>
+  </div>
+
+  <div class="field">
+    <%= form.label :average_elapsed %>
+    <%= form.number_field :average_elapsed %>
+  </div>
+
+  <div class="field">
+    <%= form.label :comment %>
+    <%= form.text_area :comment %>
+  </div>
+
+  <div class="field">
+    <%= form.label :backtrace %>
+    <%= form.text_area :backtrace %>
+  </div>
+
+  <div class="actions">
+    <%= form.submit %>
+  </div>
+<% end %>

data/app/views/process_logs/edit.html.erb

@@ -0,0 +1,6 @@
+<h1>Editing Process Log</h1>
+
+<%= render 'form', process_log: @process_log %>
+
+<%= link_to 'Show', @process_log %> |
+<%= link_to 'Back', process_logs_path %>

data/app/views/process_logs/index.html.erb

@@ -0,0 +1,30 @@
+<h1><%= link_to 'Process Logs', process_logs_path %></h1>
+
+<table>
+  <thead>
+    <tr>
+      <th>Key</th>
+      <th>Status</th>
+      <th>Start</th>
+      <th>End</th>
+      <th>Elapsed</th>
+      <th>Average</th>
+      <th>Error</th>
+    </tr>
+  </thead>
+
+  <tbody>
+    <% @process_logs.each do |process_log| %>
+      <tr>
+        <td><%= link_to process_log.key, params.permit(:key, :status).merge(key: process_log.key) %></td>
+        <td><%= link_to process_log.status, params.permit(:key, :status).merge(status: process_log.status) %></td>
+        <td><%= process_log.local_start %></td>
+        <td><%= process_log.local_end %></td>
+        <td><%= distance_of_time_in_words(process_log.elapsed) rescue nil %></td>
+        <td><%= distance_of_time_in_words(process_log.average_elapsed) rescue nil %></td>
+        <td><%= link_to_if process_log.comment, process_log.comment, process_log %></td>
+      </tr>
+    <% end %>
+  </tbody>
+</table>
+

data/app/views/process_logs/new.html.erb

@@ -0,0 +1,5 @@
+<h1>New Process Log</h1>
+
+<%= render 'form', process_log: @process_log %>
+
+<%= link_to 'Back', process_logs_path %>

data/app/views/process_logs/show.html.erb

@@ -0,0 +1,42 @@
+<h1><%= @process_log %> - <%= @process_log.local_start %></h1>
+
+<table>
+  <tbody>
+  <tr>
+    <th style="width:160px;">status</th>
+    <td class="<%= 'alert' if @process_log.fail? %>"><%= @process_log.status %></td>
+  </tr>
+  <tr>
+    <th>start time</th>
+    <td><%= @process_log.local_start %></td>
+  </tr>
+  <tr>
+    <th>end time</th>
+    <td><%= @process_log.local_end %></td>
+  </tr>
+  <tr>
+    <th>elapsed</th>
+    <td><%= distance_of_time_in_words(@process_log.elapsed) rescue nil %></td>
+  </tr>
+  <tr>
+    <th nowrap>average elapsed</th>
+    <td><%= distance_of_time_in_words(@process_log.average_elapsed) rescue nil %></td>
+  </tr>
+  <tr>
+    <th>key</th>
+    <td><%= @process_log.key %></td>
+  </tr>
+  <tr>
+    <th style="vertical-align: top;">comment</th>
+    <td style="font-size: 0.9em;"><pre style='margin: 0;'><%= sanitize h(@process_log.comment) %></pre></td>
+  </tr>
+  <tr>
+    <th style="vertical-align: top;">backtrace</th>
+    <td style="max-width: 0; overflow: hidden;
+        text-overflow: ellipsis;
+        white-space: nowrap;
+        font-size: 0.9em;
+    "><pre style='margin: 0;'><%= sanitize h(@process_log.backtrace.to_s.gsub("`", "'")).nl2br %></pre></td>
+  </tr>
+  </tbody>
+</table>

data/config/routes.rb

@@ -0,0 +1,3 @@
+Rails.application.routes.draw do
+  resources :process_logs
+end

data/db/migrate/20200515191840_create_process_logs.rb

@@ -0,0 +1,16 @@
+class CreateProcessLogs < ActiveRecord::Migration[6.0]
+  def change
+    create_table :process_logs do |t|
+      t.string :key
+      t.string :status
+      t.datetime :start_time
+      t.datetime :end_time
+      t.integer :elapsed
+      t.integer :average_elapsed
+      t.text :comment
+      t.text :backtrace
+
+      t.timestamps
+    end
+  end
+end

data/lib/duffy_log.rb

@@ -0,0 +1,5 @@
+require "duffy_log/engine"
+
+module DuffyLog
+  # Your code goes here...
+end

data/lib/duffy_log/engine.rb

@@ -0,0 +1,30 @@
+module DuffyLog
+  class Engine < ::Rails::Engine
+
+
+    # Append DFM Auth's migrations to the host application
+    # http://pivotallabs.com/leave-your-migrations-in-your-rails-engines/
+    initializer :append_migrations do |app|
+      unless app.root.to_s.match root.to_s
+        config.paths["db/migrate"].expanded.each do |expanded_path|
+          app.config.paths["db/migrate"] << expanded_path
+        end
+      end
+    end
+  end
+end
+
+# Wrapper for task
+# * Automatically creates a ProcessLog
+# * Captures any errors with stack trace
+def logged_task(*args, &block)
+  task *args do |task|
+    log = ProcessLog.create(key: task.to_s)
+    begin
+      yield
+      log.success!
+    rescue StandardError => e
+      log.fail!(e)
+    end
+  end
+end

data/lib/duffy_log/version.rb

@@ -0,0 +1,3 @@
+module DuffyLog
+  VERSION = '1.0.0'
+end

data/lib/tasks/duffy_log_tasks.rake

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

metadata

@@ -0,0 +1,143 @@
+--- !ruby/object:Gem::Specification
+name: duffy_log
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Jacob Duffy
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2020-05-22 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '6.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '6.0'
+- !ruby/object:Gem::Dependency
+  name: amazing_print
+  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: 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: rspec-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: simplecov
+  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: 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:
+- duffy.jp@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- MIT-LICENSE
+- README.md
+- Rakefile
+- app/controllers/process_logs_controller.rb
+- app/models/process_log.rb
+- app/views/process_logs/_form.html.erb
+- app/views/process_logs/edit.html.erb
+- app/views/process_logs/index.html.erb
+- app/views/process_logs/new.html.erb
+- app/views/process_logs/show.html.erb
+- config/routes.rb
+- db/migrate/20200515191840_create_process_logs.rb
+- lib/duffy_log.rb
+- lib/duffy_log/engine.rb
+- lib/duffy_log/version.rb
+- lib/tasks/duffy_log_tasks.rake
+homepage: https://github.com/duffyjp/duffy_log
+licenses:
+- MIT
+metadata: {}
+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.1.2
+signing_key: 
+specification_version: 4
+summary: Log long running tasks with status.
+test_files: []