activejob-status 0.2.1 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d578a534198cba31b4b8bbf48fb9d20625c630bca3f011985a08d570bb46fd3e
-  data.tar.gz: 78f27c54c8d486dd0332b6135cd43ca2fef7fb57414ebaca33d15941b45f9d77
+  metadata.gz: caa59f53f6175aea2f38a219adfd4a707fc3fb8460265aeff78adc7b09a494f2
+  data.tar.gz: f8775e045b684ba6cc1215e2e7570ba8e7b4f10ad889d7fb5d78bea44a5b62f1
 SHA512:
-  metadata.gz: 8f4519d605117f1df429a46f04fc2d670719adca040d3822260c4565d898e4f6c386cda28676df55a1b76f2177ad58606e0b3c7b1b0701621fea9f154590f57a
-  data.tar.gz: 6250e8d76b10e8b8fcc0e719456c1ad6f34fb5fb5d92973bc2b09990fb56f7c0337ac345b96e9fbf9402dbc1aa631273ee7b05cec997b5f3cd6cd6339d5e7235
+  metadata.gz: a15529aeaab2bf3e25a5a56fab998e867f9af6fd3f835b788a84f001f9f4be4f974c8e7e2d3d40f8f45b6d764b40984af69a11cc95c9edece1e6e987c8e5dee8
+  data.tar.gz: 48fa3e3ee20a768007b830b5f5019d958594c4ec26ffd8d0bdb8bcd7d0dbdbd8d6da63408df591bda657b5de93bc991f08f84b7b8076cf699ed86385671d72e2

data/lib/activejob-status/progress.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module ActiveJob
   module Status
     class Progress
@@ -7,21 +9,19 @@ module ActiveJob
       delegate :status, to: :job, prefix: true
 
       def initialize(job)
-        @job      = job
-        @total    = 100
+        @job = job
+        @total = 100
         @progress = 0
       end
 
       def total=(num)
         @total = num
         job_status.update(to_h, force: true)
-        self
       end
 
       def progress=(num)
         @progress = num
         job_status.update(to_h, force: true)
-        self
       end
 
       def increment(num = 1)
@@ -43,7 +43,7 @@ module ActiveJob
       end
 
       def to_h
-        { progress: @progress, total: @total }
+        {progress: @progress, total: @total}
       end
     end
   end

data/lib/activejob-status/status.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module ActiveJob
   module Status
     class Status
@@ -5,22 +7,26 @@ module ActiveJob
       delegate :queued?, :working?, :completed?, :failed?, to: :status_inquiry
 
       def initialize(job, options = {})
-        options  = ActiveJob::Status.options.merge(options)
-        @storage = ActiveJob::Status::Storage.new(options)
-        @job     = job
+        options = ActiveJob::Status.options.merge(options)
+        @defaults = options.fetch(:includes, [])
+        @storage = ActiveJob::Status::Storage.new(options.without(:includes))
+        @job = job
       end
 
       def []=(key, value)
-        update({ key => value }, force: true)
+        update({key => value}, force: true)
       end
 
       def read
         @storage.read(@job)
       end
-      alias to_h read
+      alias_method :to_h, :read
+
+      def update(payload, options = {})
+        @job.progress.instance_variable_set(:@progress, payload[:progress]) if payload.include?(:progress)
+        @job.progress.instance_variable_set(:@total, payload[:total]) if payload.include?(:total)
 
-      def update(message, options = {})
-        @storage.update(@job, message, **options)
+        @storage.update(@job, payload, **options)
       end
 
       def delete
@@ -46,6 +52,23 @@ module ActiveJob
       def status_inquiry
         status.to_s.inquiry
       end
+
+      # Update default data
+
+      def update_defaults(status_key)
+        payload = {}
+        payload[:status] = status_key if @defaults.include?(:status)
+        payload[:serialized_job] = @job.serialize if @defaults.include?(:serialized_job)
+        update(payload, force: true)
+      end
+
+      def catch_exception(e)
+        payload = {}
+        payload[:status] = :failed if @defaults.include?(:status)
+        payload[:serialized_job] = @job.serialize if @defaults.include?(:serialized_job)
+        payload[:exception] = {class: e.class.name, message: e.message} if @defaults.include?(:exception)
+        update(payload, force: true)
+      end
     end
   end
 end

data/lib/activejob-status/storage.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module ActiveJob
   module Status
     class Storage
@@ -5,7 +7,7 @@ module ActiveJob
         options.assert_valid_keys(:expires_in, :throttle_interval)
 
         @expires_in = options[:expires_in]
-        @throttle   = ActiveJob::Status::Throttle.new(options[:throttle_interval])
+        @throttle = ActiveJob::Status::Throttle.new(options[:throttle_interval])
       end
 
       def store

data/lib/activejob-status/throttle.rb

@@ -1,16 +1,17 @@
+# frozen_string_literal: true
 
 module ActiveJob
   module Status
     class Throttle
       def initialize(interval)
-        @interval   = interval
+        @interval = interval
         @started_at = Time.current
       end
 
       def wrap(force: false)
         return yield if force || @interval.nil? || @interval.zero?
 
-        now     = Time.current
+        now = Time.current
         elasped = now - @started_at
         return if @interval > elasped
 

data/lib/activejob-status/version.rb

@@ -1,5 +1,7 @@
+# frozen_string_literal: true
+
 module ActiveJob
   module Status
-    VERSION = '0.2.1'.freeze
+    VERSION = "0.3.0"
   end
 end

data/lib/activejob-status.rb

@@ -1,25 +1,29 @@
-require 'active_support/core_ext/hash'
-require 'activejob-status/storage'
-require 'activejob-status/status'
-require 'activejob-status/progress'
-require 'activejob-status/throttle'
+# frozen_string_literal: true
+
+require "active_support/concern"
+require "active_support/core_ext/hash"
+require "activejob-status/storage"
+require "activejob-status/status"
+require "activejob-status/progress"
+require "activejob-status/throttle"
 
 module ActiveJob
   module Status
     extend ActiveSupport::Concern
 
-    DEFAULT_OPTIONS  = {
-      expires_in:        60 * 30,
-      throttle_interval: 0
+    DEFAULT_OPTIONS = {
+      expires_in: 60 * 30,
+      throttle_interval: 0,
+      includes: %i[status]
     }.freeze
 
     included do
-      before_enqueue { |job| job.status.update(status: :queued) }
-      before_perform { |job| job.status.update(status: :working) }
-      after_perform  { |job| job.status.update(status: :completed) }
+      before_enqueue { |job| job.status.update_defaults(:queued) }
+      before_perform { |job| job.status.update_defaults(:working) }
+      after_perform { |job| job.status.update_defaults(:completed) }
 
       rescue_from(Exception) do |e|
-        status.update(status: :failed)
+        status.catch_exception(e)
         raise e
       end
     end
@@ -43,7 +47,7 @@ module ActiveJob
       end
 
       def store=(store)
-        store   = ActiveSupport::Cache.lookup_store(*store) if store.is_a?(Array) || store.is_a?(Symbol)
+        store = ActiveSupport::Cache.lookup_store(*store) if store.is_a?(Array) || store.is_a?(Symbol)
         @@store = store
       end
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: activejob-status
 version: !ruby/object:Gem::Version
-  version: 0.2.1
+  version: 0.3.0
 platform: ruby
 authors:
 - Savater Sebastien
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-09-19 00:00:00.000000000 Z
+date: 2022-11-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activejob
@@ -70,7 +70,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.3
+rubygems_version: 3.3.7
 signing_key:
 specification_version: 4
 summary: Monitor your jobs