active_job_log 0.1.0 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 885892cec8f03e18212d7007f1c68a7e0d4afa88138d2b43b022108e7c21d362
-  data.tar.gz: a636f27b11735eb31fcbff1646179fdc3ffa7e800bdfead02d1901b4f87e5bc1
+  metadata.gz: 1f1818ddd9d4d8fa579bdb5a4486f6d25ab66405c756de6624d809b1cf080978
+  data.tar.gz: f9bac28b1eeed244318904ae769c3f310208e162cae60c6d198969e1bdc259d8
 SHA512:
-  metadata.gz: daa6aa8c8ac55e37a0d598f271e33e21d942b13d2cdebb0565f73e3d7f4a97be27deb8edd077152480835e5c75b565c98d04f2b650631479510865ee7637a52a
-  data.tar.gz: 24dea753b7fce617c926fd3ea208d10ca3236a8ae2d14816cf210aeb737ccd332d214f28efab5f2b2c83de1334814a1742a0217667a4a474d94a23f503cfd010
+  metadata.gz: 75e5518a0358f84f69871f4b4db2f11885bcc20184980a7009778020cb92c88c9a410276d4e4cc271f3586dca075be22d04aa6671ee36a896d29cb6d6cec9c85
+  data.tar.gz: fb5200fea9ab357547feeea42d22ccdc43e77351d50ea2b86100c343302bcd1b8ff40325d1451de0c2066d96b819c167c55e28799ec7455f425845e701e7ab41

data/.travis.yml

@@ -5,6 +5,7 @@ rvm:
 script:
 - RAILS_ENV=test bundle exec rake db:create db:migrate
 - bundle exec rspec spec
+before_install: gem install bundler -v 1.16.3
 deploy:
   provider: rubygems
   api_key:

data/CHANGELOG.md

@@ -2,6 +2,30 @@
 All notable changes to this project will be documented in this file.
 This project adheres to [Semantic Versioning](http://semver.org/).
 
+### v1.2.0
+
+#### Changed
+
+* Use update instead of deprecated update_attributes.
+
+### v1.0.0
+
+#### Changed
+
+* Copy Job model into app.
+
+### v0.2.1
+
+#### Fixed
+
+* Change error type from string to text.
+
+### v0.2.0
+
+#### Added
+
+* New Job instance by retry.
+
 ### v0.1.0
 
 * Initial release.

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    active_job_log (0.1.0)
+    active_job_log (1.2.0)
       enumerize (>= 1.0)
       rails (>= 4.2.0)
 
@@ -62,7 +62,7 @@ GEM
     crass (1.0.4)
     diff-lcs (1.3)
     docile (1.1.5)
-    enumerize (2.2.2)
+    enumerize (2.4.0)
       activesupport (>= 3.2)
     erubi (1.7.1)
     factory_bot (4.8.2)
@@ -70,51 +70,26 @@ GEM
     factory_bot_rails (4.8.2)
       factory_bot (~> 4.8.2)
       railties (>= 3.0.0)
-    ffi (1.9.23)
-    formatador (0.2.5)
-    globalid (0.4.1)
+    globalid (0.4.2)
       activesupport (>= 4.2.0)
-    guard (2.14.2)
-      formatador (>= 0.2.4)
-      listen (>= 2.7, < 4.0)
-      lumberjack (>= 1.0.12, < 2.0)
-      nenv (~> 0.1)
-      notiffany (~> 0.0)
-      pry (>= 0.9.12)
-      shellany (~> 0.0)
-      thor (>= 0.18.1)
-    guard-compat (1.2.1)
-    guard-rspec (4.7.3)
-      guard (~> 2.1)
-      guard-compat (~> 1.1)
-      rspec (>= 2.99.0, < 4.0)
     i18n (1.0.1)
       concurrent-ruby (~> 1.0)
     json (2.1.0)
-    listen (3.1.5)
-      rb-fsevent (~> 0.9, >= 0.9.4)
-      rb-inotify (~> 0.9, >= 0.9.7)
-      ruby_dep (~> 1.2)
     loofah (2.2.2)
       crass (~> 1.0.2)
       nokogiri (>= 1.5.9)
-    lumberjack (1.0.13)
-    mail (2.7.0)
+    mail (2.7.1)
       mini_mime (>= 0.1.1)
-    marcel (0.3.2)
+    marcel (0.3.3)
       mimemagic (~> 0.3.2)
     method_source (0.9.0)
-    mimemagic (0.3.2)
-    mini_mime (1.0.0)
+    mimemagic (0.3.5)
+    mini_mime (1.0.2)
     mini_portile2 (2.3.0)
     minitest (5.11.3)
-    nenv (0.3.0)
-    nio4r (2.3.1)
+    nio4r (2.5.2)
     nokogiri (1.8.2)
       mini_portile2 (~> 2.3.0)
-    notiffany (0.1.1)
-      nenv (~> 0.1)
-      shellany (~> 0.0)
     pry (0.11.3)
       coderay (~> 1.1.0)
       method_source (~> 0.9.0)
@@ -148,13 +123,6 @@ GEM
       rake (>= 0.8.7)
       thor (>= 0.18.1, < 2.0)
     rake (12.3.1)
-    rb-fsevent (0.10.3)
-    rb-inotify (0.9.10)
-      ffi (>= 0.5.0, < 2)
-    rspec (3.7.0)
-      rspec-core (~> 3.7.0)
-      rspec-expectations (~> 3.7.0)
-      rspec-mocks (~> 3.7.0)
     rspec-core (3.7.1)
       rspec-support (~> 3.7.0)
     rspec-expectations (3.7.0)
@@ -172,17 +140,15 @@ GEM
       rspec-mocks (~> 3.7.0)
       rspec-support (~> 3.7.0)
     rspec-support (3.7.1)
-    ruby_dep (1.5.0)
-    shellany (0.0.1)
     simplecov (0.14.1)
       docile (~> 1.1.0)
       json (>= 1.8, < 3)
       simplecov-html (~> 0.10.0)
     simplecov-html (0.10.2)
-    sprockets (3.7.1)
+    sprockets (3.7.2)
       concurrent-ruby (~> 1.0)
       rack (> 1, < 3)
-    sprockets-rails (3.2.1)
+    sprockets-rails (3.2.2)
       actionpack (>= 4.0)
       activesupport (>= 4.0)
       sprockets (>= 3.0.0)
@@ -194,9 +160,9 @@ GEM
     tins (1.16.3)
     tzinfo (1.2.5)
       thread_safe (~> 0.1)
-    websocket-driver (0.7.0)
+    websocket-driver (0.7.3)
       websocket-extensions (>= 0.1.0)
-    websocket-extensions (0.1.3)
+    websocket-extensions (0.1.5)
 
 PLATFORMS
   ruby
@@ -205,11 +171,10 @@ DEPENDENCIES
   active_job_log!
   coveralls
   factory_bot_rails
-  guard-rspec
   pry
   pry-rails
   rspec-rails
   sqlite3
 
 BUNDLED WITH
-   1.16.1
+   2.1.4

data/README.md

@@ -1,5 +1,9 @@
 # Active Job Log
 
+[![Gem Version](https://badge.fury.io/rb/active_job_log.svg)](https://badge.fury.io/rb/active_job_log)
+[![Build Status](https://travis-ci.org/platanus/active_job_log.svg?branch=master)](https://travis-ci.org/platanus/active_job_log)
+[![Coverage Status](https://coveralls.io/repos/github/platanus/active_job_log/badge.svg?branch=master)](https://coveralls.io/github/platanus/active_job_log?branch=master)
+
 Rails engine to register jobs history, adding: job state, error feedback, duration, etc.
 
 ## Installation

data/active_job_log.gemspec

@@ -26,7 +26,6 @@ Gem::Specification.new do |s|
   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/db/migrate/20180511184635_create_active_job_log_jobs.rb

@@ -5,7 +5,7 @@ class CreateActiveJobLogJobs < ActiveRecord::Migration[5.2]
       t.text :params
       t.string :status
       t.string :job_class
-      t.string :error
+      t.text :error
       t.text :stack_trace
       t.datetime :queued_at
       t.datetime :started_at

data/lib/active_job_log/engine.rb

@@ -9,6 +9,7 @@ module ActiveJobLog
 
     initializer "initialize" do
       require_relative "./log_ext"
+      require_relative "./loggeable"
     end
   end
 end

data/lib/active_job_log/loggeable.rb

@@ -0,0 +1,72 @@
+module ActiveJobLog
+  module Loggeable
+    extend ActiveSupport::Concern
+
+    included do
+      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 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
+
+    module ClassMethods
+      def update_job!(job_id, status, params = {})
+        params.merge!(status_to_params(status))
+        job = find_or_create_job(job_id)
+        job.update!(params)
+        job
+      end
+
+      def find_or_create_job(job_id)
+        where(job_id: job_id).where.not(status: :failed).last || create(job_id: job_id)
+      end
+
+      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
+  end
+end

data/lib/active_job_log/version.rb

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

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

@@ -13,6 +13,10 @@ class ActiveJobLog::InstallGenerator < Rails::Generators::Base
     end
   end
 
+  def copy_job_model
+    copy_file "job_model.rb", "app/models/active_job_log/job.rb"
+  end
+
   def copy_engine_migrations
     rake "railties:install:migrations"
   end

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

@@ -0,0 +1,5 @@
+module ActiveJobLog
+  class Job < ApplicationRecord
+    include Loggeable
+  end
+end

data/spec/dummy/app/models/active_job_log/job.rb

@@ -0,0 +1,5 @@
+module ActiveJobLog
+  class Job < ApplicationRecord
+    include Loggeable
+  end
+end

data/spec/dummy/db/schema.rb

@@ -16,7 +16,7 @@ ActiveRecord::Schema.define(version: 2018_05_11_184635) do
     t.text "params"
     t.string "status"
     t.string "job_class"
-    t.string "error"
+    t.text "error"
     t.text "stack_trace"
     t.datetime "queued_at"
     t.datetime "started_at"

data/spec/models/active_job_log/job_spec.rb

@@ -117,71 +117,62 @@ RSpec.describe ActiveJobLog::Job, type: :model do
 
   describe "#update_job!" do
     let(:job_id) { "x" }
-    let(:status) { :queued }
-    let(:perform) { described_class.update_job!(job_id, status, params) }
+    let(:params) { {} }
 
-    let(:params) do
-      {
-        params: [1],
-        stack_trace: [2],
-        error: "error",
-        job_class: "MyJob"
-      }
+    def perform(status)
+      described_class.update_job!(job_id, status, params)
     end
 
-    it { expect { perform }.to change(ActiveJobLog::Job, :count).from(0).to(1) }
+    context "with params" do
+      let(:params) do
+        {
+          params: [1],
+          stack_trace: [2],
+          error: "error",
+          job_class: "MyJob"
+        }
+      end
 
-    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 }
+      before { @job = perform(:queued) }
 
       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") }
+    end
+
+    context "with queued status" do
+      before { @job = perform(:queued) }
+
       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 }
+      it { expect { perform(:pending) }.not_to change(described_class, :count) }
     end
 
     context "with pending status" do
-      let(:status) { :pending }
-
-      before { @job = perform }
+      before { @job = perform(:pending) }
 
       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 }
+      it { expect { perform(:failed) }.not_to change(described_class, :count) }
+      it { expect { perform(:finished) }.not_to change(described_class, :count) }
     end
 
     context "with finished status" do
-      let(:status) { :finished }
-
-      before { @job = perform }
+      before { @job = perform(:finished) }
 
       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 }
+      before { @job = perform(:failed) }
 
       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 }
+      it { expect { perform(:queued) }.to change(described_class, :count).from(1).to(2) }
+      it { expect { perform(:pending) }.to change(described_class, :count).from(1).to(2) }
     end
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: active_job_log
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 1.2.0
 platform: ruby
 authors:
 - Platanus
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-05-18 00:00:00.000000000 Z
+date: 2021-01-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -95,20 +95,6 @@ dependencies:
     - - ">="
       - !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
@@ -170,7 +156,6 @@ files:
 - 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
@@ -178,10 +163,12 @@ files:
 - lib/active_job_log.rb
 - lib/active_job_log/engine.rb
 - lib/active_job_log/log_ext.rb
+- lib/active_job_log/loggeable.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/generators/active_job_log/install/templates/job_model.rb
 - lib/tasks/active_job_log_tasks.rake
 - spec/dummy/Rakefile
 - spec/dummy/app/assets/config/manifest.js
@@ -194,6 +181,7 @@ files:
 - 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/active_job_log/job.rb
 - spec/dummy/app/models/application_record.rb
 - spec/dummy/app/views/layouts/application.html.erb
 - spec/dummy/app/views/layouts/mailer.html.erb
@@ -261,68 +249,68 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.7
+rubygems_version: 3.0.8
 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/spec_helper.rb
+- spec/dummy/app/mailers/application_mailer.rb
+- spec/dummy/app/channels/application_cable/connection.rb
+- spec/dummy/app/channels/application_cable/channel.rb
+- spec/dummy/app/views/layouts/application.html.erb
+- spec/dummy/app/views/layouts/mailer.text.erb
+- spec/dummy/app/views/layouts/mailer.html.erb
+- spec/dummy/app/jobs/application_job.rb
+- spec/dummy/app/models/application_record.rb
+- spec/dummy/app/models/active_job_log/job.rb
+- spec/dummy/app/helpers/application_helper.rb
 - 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/assets/config/manifest.js
 - 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/Rakefile
+- spec/dummy/bin/yarn
+- spec/dummy/bin/update
+- spec/dummy/bin/rake
 - 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/spec/support/test_helpers.rb
+- spec/dummy/spec/assets/image.png
+- spec/dummy/spec/assets/video.mp4
+- spec/dummy/public/404.html
+- spec/dummy/public/500.html
+- spec/dummy/public/apple-touch-icon-precomposed.png
+- spec/dummy/public/422.html
+- spec/dummy/public/apple-touch-icon.png
+- spec/dummy/public/favicon.ico
 - spec/dummy/config.ru
+- spec/dummy/db/schema.rb
+- spec/dummy/config/routes.rb
+- spec/dummy/config/environment.rb
+- spec/dummy/config/spring.rb
+- spec/dummy/config/cable.yml
+- spec/dummy/config/secrets.yml
 - 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/test.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/config/initializers/wrap_parameters.rb
+- spec/dummy/config/initializers/mime_types.rb
+- spec/dummy/config/initializers/filter_parameter_logging.rb
+- spec/dummy/config/initializers/assets.rb
+- spec/dummy/config/initializers/application_controller_renderer.rb
+- spec/dummy/config/initializers/inflections.rb
+- spec/dummy/config/initializers/cookies_serializer.rb
+- spec/dummy/config/initializers/backtrace_silencers.rb
+- spec/dummy/config/database.yml
 - 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/factories/active_job_log_jobs.rb
 - spec/rails_helper.rb
-- spec/spec_helper.rb

data/app/models/active_job_log/job.rb

@@ -1,68 +0,0 @@
-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