active_job_log 0.1.0

data/active_job_log.gemspec

@@ -0,0 +1,32 @@
+$:.push File.expand_path("../lib", __FILE__)
+
+# Maintain your gem"s version:
+require "active_job_log/version"
+
+# Describe your gem and declare its dependencies:
+Gem::Specification.new do |s|
+  s.name          = "active_job_log"
+  s.version       = ActiveJobLog::VERSION
+  s.authors       = ["Platanus", "Leandro Segovia"]
+  s.email         = ["rubygems@platan.us", "ldlsegovia@gmail.com"]
+  s.homepage      = "https://github.com/platanus/active_job_log"
+  s.summary       = "Rails engine to keep jobs history"
+  s.description   = "Rails engine to register jobs history, adding: job state, error feedback, duration, etc."
+  s.license       = "MIT"
+
+  s.files = `git ls-files`.split($/).reject { |fn| fn.start_with? "spec" }
+  s.bindir = "exe"
+  s.executables = s.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  s.test_files = Dir["spec/**/*"]
+
+  s.add_dependency "rails", ">= 4.2.0"
+  s.add_dependency "enumerize", ">= 1.0"
+
+  s.add_development_dependency "pry"
+  s.add_development_dependency "pry-rails"
+  s.add_development_dependency "sqlite3"
+  s.add_development_dependency "rspec-rails"
+  s.add_development_dependency "guard-rspec"
+  s.add_development_dependency "factory_bot_rails"
+  s.add_development_dependency "coveralls"
+end

data/app/assets/config/active_job_log_manifest.js

@@ -0,0 +1,2 @@
+//= link_directory ../javascripts/active_job_log .js
+//= link_directory ../stylesheets/active_job_log .css

data/app/assets/javascripts/active_job_log/application.js

@@ -0,0 +1,13 @@
+// This is a manifest file that'll be compiled into application.js, which will include all the files
+// listed below.
+//
+// Any JavaScript/Coffee file within this directory, lib/assets/javascripts, vendor/assets/javascripts,
+// or any plugin's vendor/assets/javascripts directory can be referenced here using a relative path.
+//
+// It's not advisable to add code directly here, but if you do, it'll appear at the bottom of the
+// compiled file. JavaScript code in this file should be added after the last require_* statement.
+//
+// Read Sprockets README (https://github.com/rails/sprockets#sprockets-directives) for details
+// about supported directives.
+//
+//= require_tree .

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

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

data/app/helpers/active_job_log/application_helper.rb

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

data/app/jobs/active_job_log/application_job.rb

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

data/app/mailers/active_job_log/application_mailer.rb

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

data/app/models/active_job_log/application_record.rb

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

data/app/models/active_job_log/job.rb

@@ -0,0 +1,68 @@
+module ActiveJobLog
+  class Job < ApplicationRecord
+    extend Enumerize
+
+    STATUSES = %i{queued pending finished failed}
+
+    validates :job_id, presence: true
+
+    enumerize :status, in: STATUSES, scope: true
+
+    serialize :params, Array
+    serialize :stack_trace, Array
+
+    before_save :set_queued_duration
+    before_save :set_execution_duration
+    before_save :set_total_duration
+
+    def self.update_job!(job_id, status, params = {})
+      params.merge!(status_to_params(status))
+      job = Job.find_or_create_by(job_id: job_id)
+      job.update_attributes!(params)
+      job
+    end
+
+    class << self
+      private
+
+      def status_to_params(status)
+        time_attr = infer_duration_attr_from_status(status)
+        {
+          time_attr => DateTime.current,
+          status: status
+        }
+      end
+
+      def infer_duration_attr_from_status(status)
+        case status
+        when :queued
+          :queued_at
+        when :pending
+          :started_at
+        when :finished, :failed
+          :ended_at
+        else
+          fail "invalid status"
+        end
+      end
+    end
+
+    private
+
+    def set_queued_duration
+      return if queued_at.blank? || started_at.blank?
+      self.queued_duration = (started_at.to_f - queued_at.to_f).to_i
+    end
+
+    def set_execution_duration
+      return if started_at.blank? || ended_at.blank?
+      self.execution_duration = (ended_at.to_f - started_at.to_f).to_i
+    end
+
+    def set_total_duration
+      from = queued_at || started_at
+      return if from.blank? || ended_at.blank?
+      self.total_duration = (ended_at.to_f - from.to_f).to_i
+    end
+  end
+end

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

@@ -0,0 +1,14 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <title>Active job log</title>
+  <%= stylesheet_link_tag    "active_job_log/application", media: "all" %>
+  <%= javascript_include_tag "active_job_log/application" %>
+  <%= csrf_meta_tags %>
+</head>
+<body>
+
+<%= yield %>
+
+</body>
+</html>

data/bin/rails

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+# This command will automatically be run when you run "rails" with Rails gems
+# installed from the root of your application.
+
+ENGINE_ROOT = File.expand_path('../..', __FILE__)
+ENGINE_PATH = File.expand_path('../../lib/active_job_log/engine', __FILE__)
+APP_PATH = File.expand_path('../../spec/dummy/config/application', __FILE__)
+
+# Set up gems listed in the Gemfile.
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path('../../Gemfile', __FILE__)
+require 'bundler/setup' if File.exist?(ENV['BUNDLE_GEMFILE'])
+
+require 'rails/all'
+require 'rails/engine/commands'

data/config/routes.rb

@@ -0,0 +1,2 @@
+ActiveJobLog::Engine.routes.draw do
+end

data/db/migrate/20180511184635_create_active_job_log_jobs.rb

@@ -0,0 +1,22 @@
+class CreateActiveJobLogJobs < ActiveRecord::Migration[5.2]
+  def change
+    create_table :active_job_log_jobs do |t|
+      t.string :job_id, index: true
+      t.text :params
+      t.string :status
+      t.string :job_class
+      t.string :error
+      t.text :stack_trace
+      t.datetime :queued_at
+      t.datetime :started_at
+      t.datetime :ended_at
+      t.integer :queued_duration
+      t.integer :execution_duration
+      t.integer :total_duration
+      t.integer :executions
+      t.string :queue_name
+
+      t.timestamps
+    end
+  end
+end

data/lib/active_job_log.rb

@@ -0,0 +1,26 @@
+require "active_job_log/engine"
+require "enumerize"
+
+module ActiveJobLog
+  extend self
+
+  # You can add, in this module, your own configuration options as in the example below...
+  #
+  # attr_writer :my_option
+  #
+  # def my_option
+  #   return "Default Value" unless @my_option
+  #   @my_option
+  # end
+  #
+  # Then, you can customize the default behaviour (typically in a Rails initializer) like this:
+  #
+  # ActiveJobLog.setup do |config|
+  #   config.root_url = "Another value"
+  # end
+
+  def setup
+    yield self
+    require "active_job_log"
+  end
+end

data/lib/active_job_log/engine.rb

@@ -0,0 +1,14 @@
+module ActiveJobLog
+  class Engine < ::Rails::Engine
+    isolate_namespace ActiveJobLog
+
+    config.generators do |g|
+      g.test_framework :rspec, fixture: false
+      g.fixture_replacement :factory_bot, dir: "spec/factories"
+    end
+
+    initializer "initialize" do
+      require_relative "./log_ext"
+    end
+  end
+end

data/lib/active_job_log/log_ext.rb

@@ -0,0 +1,43 @@
+module ActiveJobLog
+  module LogExt
+    extend ActiveSupport::Concern
+
+    included do
+      before_enqueue { |job| enqueue_job(job) }
+      before_perform { |job| execute_job(job) }
+      after_perform { |job| finish_job(job) }
+
+      rescue_from(Exception) do |exception|
+        fail_job(exception)
+        raise exception
+      end
+
+      def enqueue_job(job)
+        Job.update_job!(job.job_id, :queued, init_params(job))
+      end
+
+      def execute_job(job)
+        Job.update_job!(job.job_id, :pending, init_params(job))
+      end
+
+      def finish_job(job)
+        Job.update_job!(job.job_id, :finished)
+      end
+
+      def fail_job(exception)
+        Job.update_job!(job_id, :failed, error: exception.message, stack_trace: exception.backtrace)
+      end
+
+      def init_params(job)
+        {
+          job_class: self.class.name,
+          params: job.arguments,
+          executions: job.try(:executions),
+          queue_name: job.queue_name
+        }
+      end
+    end
+  end
+end
+
+ActiveJob::Base.send(:include, ActiveJobLog::LogExt)

data/lib/active_job_log/version.rb

@@ -0,0 +1,3 @@
+module ActiveJobLog
+  VERSION = '0.1.0'
+end

data/lib/generators/active_job_log/install/USAGE

@@ -0,0 +1,5 @@
+Description:
+    Install the engine in host app.
+
+Example:
+    rails generate active_job_log:install

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

@@ -0,0 +1,19 @@
+class ActiveJobLog::InstallGenerator < Rails::Generators::Base
+  source_root File.expand_path('../templates', __FILE__)
+
+  def create_initializer
+    template "initializer.rb", "config/initializers/active_job_log.rb"
+  end
+
+  def mount_routes
+    line = "Rails.application.routes.draw do\n"
+    inject_into_file "config/routes.rb", after: line do <<-"HERE".gsub(/^ {4}/, '')
+      mount ActiveJobLog::Engine => "/active_job_log"
+    HERE
+    end
+  end
+
+  def copy_engine_migrations
+    rake "railties:install:migrations"
+  end
+end

data/lib/generators/active_job_log/install/templates/initializer.rb

@@ -0,0 +1,2 @@
+ActiveJobLog.setup do |config|
+end

data/lib/tasks/active_job_log_tasks.rake

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

data/spec/dummy/Rakefile

@@ -0,0 +1,6 @@
+# Add your own tasks in files placed in lib/tasks ending in .rake,
+# for example lib/tasks/capistrano.rake, and they will automatically be available to Rake.
+
+require_relative 'config/application'
+
+Rails.application.load_tasks

data/spec/dummy/app/assets/config/manifest.js

@@ -0,0 +1,5 @@
+
+//= link_tree ../images
+//= link_directory ../javascripts .js
+//= link_directory ../stylesheets .css
+//= link active_job_log_manifest.js

data/spec/dummy/app/assets/javascripts/application.js

@@ -0,0 +1,13 @@
+// This is a manifest file that'll be compiled into application.js, which will include all the files
+// listed below.
+//
+// Any JavaScript/Coffee file within this directory, lib/assets/javascripts, vendor/assets/javascripts,
+// or any plugin's vendor/assets/javascripts directory can be referenced here using a relative path.
+//
+// It's not advisable to add code directly here, but if you do, it'll appear at the bottom of the
+// compiled file. JavaScript code in this file should be added after the last require_* statement.
+//
+// Read Sprockets README (https://github.com/rails/sprockets#sprockets-directives) for details
+// about supported directives.
+//
+//= require_tree .

data/spec/dummy/app/assets/javascripts/cable.js

@@ -0,0 +1,13 @@
+// Action Cable provides the framework to deal with WebSockets in Rails.
+// You can generate new channels where WebSocket features live using the `rails generate channel` command.
+//
+//= require action_cable
+//= require_self
+//= require_tree ./channels
+
+(function() {
+  this.App || (this.App = {});
+
+  App.cable = ActionCable.createConsumer();
+
+}).call(this);

data/spec/dummy/app/assets/stylesheets/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/spec/dummy/app/channels/application_cable/channel.rb

@@ -0,0 +1,4 @@
+module ApplicationCable
+  class Channel < ActionCable::Channel::Base
+  end
+end

data/spec/dummy/app/channels/application_cable/connection.rb

@@ -0,0 +1,4 @@
+module ApplicationCable
+  class Connection < ActionCable::Connection::Base
+  end
+end

data/spec/dummy/app/controllers/application_controller.rb

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

data/spec/dummy/app/helpers/application_helper.rb

@@ -0,0 +1,2 @@
+module ApplicationHelper
+end

data/spec/dummy/app/jobs/application_job.rb

@@ -0,0 +1,2 @@
+class ApplicationJob < ActiveJob::Base
+end