active_job_log 0.1.0

data/spec/dummy/spec/support/test_helpers.rb

@@ -0,0 +1,5 @@
+module TestHelpers
+  def helper_example
+    puts "Add your custom helpers here: #{File.dirname(__FILE__)}"
+  end
+end

data/spec/factories/active_job_log_jobs.rb

@@ -0,0 +1,7 @@
+FactoryBot.define do
+  factory :active_job_log_job, class: 'ActiveJobLog::Job' do
+    sequence(:job_id) { |n| "job##{n}" }
+    status :pending
+    job_class "MyJob"
+  end
+end

data/spec/lib/active_job_log/log_ext_spec.rb

@@ -0,0 +1,84 @@
+require 'rails_helper'
+
+RSpec.describe ActiveJobLog::LogExt do
+  def remove_job_class
+    Object.send(:remove_const, :TestJob)
+  rescue
+    nil
+  end
+
+  def perform_now
+    TestJob.perform_now(*job_params)
+  rescue
+    nil
+  end
+
+  let(:job_params) do
+    [
+      "p1",
+      "p2"
+    ]
+  end
+
+  before { remove_job_class }
+
+  it { expect(ActiveJobLog::Job.count).to eq(0) }
+
+  context "with successful job" do
+    before do
+      class TestJob < ActiveJob::Base
+        def perform(param1, param2)
+          "success with #{param1} and #{param2}"
+        end
+      end
+
+      perform_now
+      @job = ActiveJobLog::Job.last
+    end
+
+    it { expect(ActiveJobLog::Job.count).to eq(1) }
+    it { expect(@job.job_id).not_to be_nil }
+    it { expect(@job.params).to eq(job_params) }
+    it { expect(@job.status).to eq(:finished) }
+    it { expect(@job.job_class).to eq("TestJob") }
+    it { expect(@job.queue_name).to eq("default") }
+    it { expect(@job.error).to be_nil }
+    it { expect(@job.stack_trace).to eq([]) }
+    it { expect(@job.queued_at).to be_nil }
+    it { expect(@job.started_at).not_to be_nil }
+    it { expect(@job.ended_at).not_to be_nil }
+    it { expect(@job.queued_duration).to be_nil }
+    it { expect(@job.execution_duration).not_to be_nil }
+    it { expect(@job.total_duration).not_to be_nil }
+    it { expect(@job.executions).to eq(0) }
+  end
+
+  context "with failed job" do
+    before do
+      class TestJob < ActiveJob::Base
+        def perform(_param1, _param2)
+          raise "error"
+        end
+      end
+
+      perform_now
+      @job = ActiveJobLog::Job.last
+    end
+
+    it { expect(ActiveJobLog::Job.count).to eq(1) }
+    it { expect(@job.job_id).not_to be_nil }
+    it { expect(@job.params).to eq(job_params) }
+    it { expect(@job.status).to eq(:failed) }
+    it { expect(@job.job_class).to eq("TestJob") }
+    it { expect(@job.queue_name).to eq("default") }
+    it { expect(@job.error).to eq("error") }
+    it { expect(@job.stack_trace.any?).to eq(true) }
+    it { expect(@job.queued_at).to be_nil }
+    it { expect(@job.started_at).not_to be_nil }
+    it { expect(@job.ended_at).not_to be_nil }
+    it { expect(@job.queued_duration).to be_nil }
+    it { expect(@job.execution_duration).not_to be_nil }
+    it { expect(@job.total_duration).not_to be_nil }
+    it { expect(@job.executions).to eq(0) }
+  end
+end

data/spec/models/active_job_log/job_spec.rb

@@ -0,0 +1,187 @@
+require 'rails_helper'
+
+RSpec.describe ActiveJobLog::Job, type: :model do
+  it "has a valid factory" do
+    expect(create(:active_job_log_job)).to be_valid
+  end
+
+  describe "Validations" do
+    it { is_expected.to enumerize(:status).in(:queued, :pending, :finished, :failed) }
+  end
+
+  describe "#params" do
+    let(:job) { create(:active_job_log_job) }
+    let(:params) { [1, 2] }
+
+    it { expect(job.params).to eq([]) }
+    it { expect { job.params = params }.to change(job, :params).from([]).to(params) }
+  end
+
+  describe "#stack_trace" do
+    let(:job) { create(:active_job_log_job) }
+    let(:stack) { [1, 2] }
+
+    it { expect(job.stack_trace).to eq([]) }
+    it { expect { job.stack_trace = stack }.to change(job, :stack_trace).from([]).to(stack) }
+  end
+
+  describe "#set_queued_duration" do
+    let(:job) { build(:active_job_log_job, queued_at: queued_at, started_at: started_at) }
+
+    context "with defined started_at and queued_at" do
+      let(:queued_at) { started_at - 2.days }
+      let(:started_at) { DateTime.current }
+
+      it { expect { job.save! }.to change(job, :queued_duration).from(nil).to(172800) }
+    end
+
+    context "with nil started_at" do
+      let(:queued_at) { DateTime.current }
+      let(:started_at) { nil }
+
+      it { expect { job.save! }.not_to change(job, :queued_duration) }
+    end
+
+    context "with nil queued_at" do
+      let(:queued_at) { nil }
+      let(:started_at) { DateTime.current }
+
+      it { expect { job.save! }.not_to change(job, :queued_duration) }
+    end
+  end
+
+  describe "#set_execution_duration" do
+    let(:job) { build(:active_job_log_job, started_at: started_at, ended_at: ended_at) }
+
+    context "with defined ended_at and started_at" do
+      let(:started_at) { ended_at - 2.days }
+      let(:ended_at) { DateTime.current }
+
+      it { expect { job.save! }.to change(job, :execution_duration).from(nil).to(172800) }
+    end
+
+    context "with nil ended_at" do
+      let(:started_at) { DateTime.current }
+      let(:ended_at) { nil }
+
+      it { expect { job.save! }.not_to change(job, :execution_duration) }
+    end
+
+    context "with nil started_at" do
+      let(:started_at) { nil }
+      let(:ended_at) { DateTime.current }
+
+      it { expect { job.save! }.not_to change(job, :execution_duration) }
+    end
+  end
+
+  describe "#set_total_duration" do
+    let(:job) do
+      build(:active_job_log_job, queued_at: queued_at, started_at: started_at, ended_at: ended_at)
+    end
+
+    let(:queued_at) { ended_at - 3.days }
+    let(:started_at) { ended_at - 2.days }
+    let(:ended_at) { DateTime.current }
+
+    it { expect { job.save! }.to change(job, :total_duration).from(nil).to(259200) }
+
+    context "with undefined queued_at" do
+      let(:queued_at) { nil }
+
+      it { expect { job.save! }.to change(job, :total_duration).from(nil).to(172800) }
+    end
+
+    context "with undefined started_at" do
+      let(:started_at) { nil }
+
+      it { expect { job.save! }.to change(job, :total_duration).from(nil).to(259200) }
+    end
+
+    context "with undefined ended_at" do
+      let(:queued_at) { DateTime.current - 3.days }
+      let(:started_at) { DateTime.current - 2.days }
+      let(:ended_at) { nil }
+
+      it { expect { job.save! }.not_to change(job, :total_duration) }
+    end
+
+    context "with undefined queued_at and started_at" do
+      let(:queued_at) { nil }
+      let(:started_at) { nil }
+      let(:ended_at) { DateTime.current }
+
+      it { expect { job.save! }.not_to change(job, :total_duration) }
+    end
+  end
+
+  describe "#update_job!" do
+    let(:job_id) { "x" }
+    let(:status) { :queued }
+    let(:perform) { described_class.update_job!(job_id, status, params) }
+
+    let(:params) do
+      {
+        params: [1],
+        stack_trace: [2],
+        error: "error",
+        job_class: "MyJob"
+      }
+    end
+
+    it { expect { perform }.to change(ActiveJobLog::Job, :count).from(0).to(1) }
+
+    context "with existent job" do
+      let!(:job) { create(:active_job_log_job, job_id: job_id) }
+
+      it { expect { perform }.not_to change(ActiveJobLog::Job, :count) }
+    end
+
+    context "with queued status" do
+      before { @job = perform }
+
+      it { expect(@job.job_id).to eq(job_id) }
+      it { expect(@job.error).to eq("error") }
+      it { expect(@job.params).to eq([1]) }
+      it { expect(@job.stack_trace).to eq([2]) }
+      it { expect(@job.job_class).to eq("MyJob") }
+      it { expect(@job.status).to eq(:queued) }
+      it { expect(@job.queued_at).not_to be_nil }
+      it { expect(@job.started_at).to be_nil }
+      it { expect(@job.ended_at).to be_nil }
+    end
+
+    context "with pending status" do
+      let(:status) { :pending }
+
+      before { @job = perform }
+
+      it { expect(@job.status).to eq(:pending) }
+      it { expect(@job.queued_at).to be_nil }
+      it { expect(@job.started_at).not_to be_nil }
+      it { expect(@job.ended_at).to be_nil }
+    end
+
+    context "with finished status" do
+      let(:status) { :finished }
+
+      before { @job = perform }
+
+      it { expect(@job.status).to eq(:finished) }
+      it { expect(@job.queued_at).to be_nil }
+      it { expect(@job.started_at).to be_nil }
+      it { expect(@job.ended_at).not_to be_nil }
+    end
+
+    context "with failed status" do
+      let(:status) { :failed }
+
+      before { @job = perform }
+
+      it { expect(@job.status).to eq(:failed) }
+      it { expect(@job.queued_at).to be_nil }
+      it { expect(@job.started_at).to be_nil }
+      it { expect(@job.ended_at).not_to be_nil }
+    end
+  end
+end

data/spec/rails_helper.rb

@@ -0,0 +1,48 @@
+require 'simplecov'
+require 'coveralls'
+
+formatters = [SimpleCov::Formatter::HTMLFormatter, Coveralls::SimpleCov::Formatter]
+SimpleCov.formatter = SimpleCov::Formatter::MultiFormatter::new(formatters)
+
+SimpleCov.start do
+  add_filter do |src|
+    r = [
+      src.filename =~ /lib/,
+      src.filename =~ /models/,
+      src.filename =~ /controllers/
+    ].uniq
+    r.count == 1 && r.first.nil?
+  end
+
+  add_filter "engine.rb"
+  add_filter "spec.rb"
+end
+
+ENV["RAILS_ENV"] ||= "test"
+require File.expand_path("../../spec/dummy/config/environment", __FILE__)
+abort("The Rails environment is running in production mode!") if Rails.env.production?
+require "pry"
+require "spec_helper"
+require "rspec/rails"
+require "factory_bot_rails"
+
+ActiveRecord::Migration.maintain_test_schema!
+
+Dir[::Rails.root.join("spec/support/**/*.rb")].each { |f| require f }
+
+RSpec.configure do |config|
+  config.fixture_path = "#{::Rails.root}/spec/assets"
+  config.use_transactional_fixtures = true
+  config.infer_spec_type_from_file_location!
+  config.filter_rails_from_backtrace!
+
+  config.filter_run :focus
+  config.run_all_when_everything_filtered = true
+
+  FactoryBot.definition_file_paths = ["#{::Rails.root}/spec/factories"]
+  FactoryBot.find_definitions
+
+  config.include FactoryBot::Syntax::Methods
+  config.include ActionDispatch::TestProcess
+  config.include TestHelpers
+end

data/spec/spec_helper.rb

@@ -0,0 +1,9 @@
+RSpec.configure do |config|
+  config.expect_with :rspec do |expectations|
+    expectations.include_chain_clauses_in_custom_matcher_descriptions = true
+  end
+
+  config.mock_with :rspec do |mocks|
+    mocks.verify_partial_doubles = true
+  end
+end

metadata

@@ -0,0 +1,328 @@
+--- !ruby/object:Gem::Specification
+name: active_job_log
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Platanus
+- Leandro Segovia
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2018-05-18 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.2.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.2.0
+- !ruby/object:Gem::Dependency
+  name: enumerize
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: pry
+  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: pry-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: 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'
+- !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: guard-rspec
+  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: coveralls
+  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: 'Rails engine to register jobs history, adding: job state, error feedback,
+  duration, etc.'
+email:
+- rubygems@platan.us
+- ldlsegovia@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".coveralls.yml"
+- ".gitignore"
+- ".hound.yml"
+- ".rspec"
+- ".rubocop.yml"
+- ".ruby-version"
+- ".travis.yml"
+- CHANGELOG.md
+- Gemfile
+- Gemfile.lock
+- Guardfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- active_job_log.gemspec
+- app/assets/config/active_job_log_manifest.js
+- app/assets/images/active_job_log/.keep
+- app/assets/javascripts/active_job_log/application.js
+- app/assets/stylesheets/active_job_log/application.css
+- app/controllers/active_job_log/application_controller.rb
+- app/helpers/active_job_log/application_helper.rb
+- app/jobs/active_job_log/application_job.rb
+- app/mailers/active_job_log/application_mailer.rb
+- app/models/active_job_log/application_record.rb
+- app/models/active_job_log/job.rb
+- app/views/layouts/active_job_log/application.html.erb
+- bin/rails
+- config/routes.rb
+- db/migrate/20180511184635_create_active_job_log_jobs.rb
+- lib/active_job_log.rb
+- lib/active_job_log/engine.rb
+- lib/active_job_log/log_ext.rb
+- lib/active_job_log/version.rb
+- lib/generators/active_job_log/install/USAGE
+- lib/generators/active_job_log/install/install_generator.rb
+- lib/generators/active_job_log/install/templates/initializer.rb
+- lib/tasks/active_job_log_tasks.rake
+- spec/dummy/Rakefile
+- spec/dummy/app/assets/config/manifest.js
+- spec/dummy/app/assets/javascripts/application.js
+- spec/dummy/app/assets/javascripts/cable.js
+- spec/dummy/app/assets/stylesheets/application.css
+- spec/dummy/app/channels/application_cable/channel.rb
+- spec/dummy/app/channels/application_cable/connection.rb
+- spec/dummy/app/controllers/application_controller.rb
+- spec/dummy/app/helpers/application_helper.rb
+- spec/dummy/app/jobs/application_job.rb
+- spec/dummy/app/mailers/application_mailer.rb
+- spec/dummy/app/models/application_record.rb
+- spec/dummy/app/views/layouts/application.html.erb
+- spec/dummy/app/views/layouts/mailer.html.erb
+- spec/dummy/app/views/layouts/mailer.text.erb
+- spec/dummy/bin/bundle
+- spec/dummy/bin/rails
+- spec/dummy/bin/rake
+- spec/dummy/bin/setup
+- spec/dummy/bin/update
+- spec/dummy/bin/yarn
+- spec/dummy/config.ru
+- spec/dummy/config/application.rb
+- spec/dummy/config/boot.rb
+- spec/dummy/config/cable.yml
+- spec/dummy/config/database.yml
+- spec/dummy/config/environment.rb
+- spec/dummy/config/environments/development.rb
+- spec/dummy/config/environments/production.rb
+- spec/dummy/config/environments/test.rb
+- spec/dummy/config/initializers/application_controller_renderer.rb
+- spec/dummy/config/initializers/assets.rb
+- spec/dummy/config/initializers/backtrace_silencers.rb
+- spec/dummy/config/initializers/cookies_serializer.rb
+- spec/dummy/config/initializers/filter_parameter_logging.rb
+- spec/dummy/config/initializers/inflections.rb
+- spec/dummy/config/initializers/mime_types.rb
+- spec/dummy/config/initializers/wrap_parameters.rb
+- spec/dummy/config/locales/en.yml
+- spec/dummy/config/puma.rb
+- spec/dummy/config/routes.rb
+- spec/dummy/config/secrets.yml
+- spec/dummy/config/spring.rb
+- spec/dummy/db/schema.rb
+- spec/dummy/package.json
+- spec/dummy/public/404.html
+- spec/dummy/public/422.html
+- spec/dummy/public/500.html
+- spec/dummy/public/apple-touch-icon-precomposed.png
+- spec/dummy/public/apple-touch-icon.png
+- spec/dummy/public/favicon.ico
+- spec/dummy/spec/assets/image.png
+- spec/dummy/spec/assets/video.mp4
+- spec/dummy/spec/support/test_helpers.rb
+- spec/factories/active_job_log_jobs.rb
+- spec/lib/active_job_log/log_ext_spec.rb
+- spec/models/active_job_log/job_spec.rb
+- spec/rails_helper.rb
+- spec/spec_helper.rb
+homepage: https://github.com/platanus/active_job_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: []
+rubyforge_project: 
+rubygems_version: 2.7.7
+signing_key: 
+specification_version: 4
+summary: Rails engine to keep jobs history
+test_files:
+- spec/dummy/Rakefile
+- spec/dummy/app/assets/config/manifest.js
+- spec/dummy/app/assets/javascripts/application.js
+- spec/dummy/app/assets/javascripts/cable.js
+- spec/dummy/app/assets/stylesheets/application.css
+- spec/dummy/app/channels/application_cable/channel.rb
+- spec/dummy/app/channels/application_cable/connection.rb
+- spec/dummy/app/controllers/application_controller.rb
+- spec/dummy/app/helpers/application_helper.rb
+- spec/dummy/app/jobs/application_job.rb
+- spec/dummy/app/mailers/application_mailer.rb
+- spec/dummy/app/models/application_record.rb
+- spec/dummy/app/views/layouts/application.html.erb
+- spec/dummy/app/views/layouts/mailer.html.erb
+- spec/dummy/app/views/layouts/mailer.text.erb
+- spec/dummy/bin/bundle
+- spec/dummy/bin/rails
+- spec/dummy/bin/rake
+- spec/dummy/bin/setup
+- spec/dummy/bin/update
+- spec/dummy/bin/yarn
+- spec/dummy/config.ru
+- spec/dummy/config/application.rb
+- spec/dummy/config/boot.rb
+- spec/dummy/config/cable.yml
+- spec/dummy/config/database.yml
+- spec/dummy/config/environment.rb
+- spec/dummy/config/environments/development.rb
+- spec/dummy/config/environments/production.rb
+- spec/dummy/config/environments/test.rb
+- spec/dummy/config/initializers/application_controller_renderer.rb
+- spec/dummy/config/initializers/assets.rb
+- spec/dummy/config/initializers/backtrace_silencers.rb
+- spec/dummy/config/initializers/cookies_serializer.rb
+- spec/dummy/config/initializers/filter_parameter_logging.rb
+- spec/dummy/config/initializers/inflections.rb
+- spec/dummy/config/initializers/mime_types.rb
+- spec/dummy/config/initializers/wrap_parameters.rb
+- spec/dummy/config/locales/en.yml
+- spec/dummy/config/puma.rb
+- spec/dummy/config/routes.rb
+- spec/dummy/config/secrets.yml
+- spec/dummy/config/spring.rb
+- spec/dummy/db/schema.rb
+- spec/dummy/package.json
+- spec/dummy/public/404.html
+- spec/dummy/public/422.html
+- spec/dummy/public/500.html
+- spec/dummy/public/apple-touch-icon-precomposed.png
+- spec/dummy/public/apple-touch-icon.png
+- spec/dummy/public/favicon.ico
+- spec/dummy/spec/assets/image.png
+- spec/dummy/spec/assets/video.mp4
+- spec/dummy/spec/support/test_helpers.rb
+- spec/factories/active_job_log_jobs.rb
+- spec/lib/active_job_log/log_ext_spec.rb
+- spec/models/active_job_log/job_spec.rb
+- spec/rails_helper.rb
+- spec/spec_helper.rb