activejob-status 0.1.6 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6224b3f14c08054d81bc9fbe675a1f120bca7291d7ed20b644b9bcf833c34458
-  data.tar.gz: 3691a1628e4eff782cfdd228ea2bc6eda0f16e970e4c8e8cde479612037d51d3
+  metadata.gz: 409f3ad04e793c5c448ab94bf9abf6adef5caf2b37c48635b1cee46fd638b773
+  data.tar.gz: 9c8add1a5bf84c5d4766ddf115e83d523a13181f84bffb1ee31bdfe90ff8a206
 SHA512:
-  metadata.gz: 1d537c5d9794dcca9eb1171d400cee21958716e89989fd87db61600475929e565d026b10b49fe0778b4e3dbd80d11f907564daa7434c6b47652fe8c7bc573ffb
-  data.tar.gz: 7957e2ee9d3deb2227e2dcef5e9d3945bf89f279afb7b70aa96c6c9838302535e297a0c92e2743b60ecaee5ce15e74695cd5e567d16865275f39d4a45b1f1b20
+  metadata.gz: c78e3c4ff9531cc4a66ba3ca43cad0ccb22b411f7335f5adc61ed71c9da870ebfd651ae1069f5bfccbe809f2ea5bec97b8a1ad3bc8e7b22703cdceae604cf014
+  data.tar.gz: d2fbff1487df100ba0033bbe8e6833fd8660ac77c320c90fe920543fe2e01dc3ee65e31ea770bb9b43c5508c748fa0dea50631d12a53c2da31fd8e6f4d34970a

data/lib/activejob-status/progress.rb

@@ -14,36 +14,37 @@ module ActiveJob
 
       def total=(num)
         @total = num
-        update
+        job_status.update(to_h, force: true)
+        self
       end
 
       def progress=(num)
-        update { num }
+        @progress = num
+        job_status.update(to_h, force: true)
+        self
       end
 
       def increment(num = 1)
-        update { @progress + num }
+        @progress += num
+        job_status.update(to_h)
+        self
       end
 
       def decrement(num = 1)
-        update { @progress - num }
+        @progress -= num
+        job_status.update(to_h)
+        self
       end
 
       def finish
-        update { @total }
+        @progress = @total
+        job_status.update(to_h, force: true)
+        self
       end
 
       def to_h
         { progress: @progress, total: @total }
       end
-
-      private
-
-      def update
-        @progress = yield if block_given?
-        job_status.update(to_h)
-        self
-      end
     end
   end
 end

data/lib/activejob-status/status.rb

@@ -4,29 +4,31 @@ module ActiveJob
       delegate :[], :to_s, :to_json, :inspect, to: :read
       delegate :queued?, :working?, :completed?, :failed?, to: :status_inquiry
 
-      def initialize(job)
-        @job = job
+      def initialize(job, options = {})
+        options  = ActiveJob::Status.options.merge(options)
+        @storage = ActiveJob::Status::Storage.new(options)
+        @job     = job
       end
 
       def []=(key, value)
-        update(key => value)
+        update({ key => value }, force: true)
       end
 
       def read
-        Storage.read(@job)
+        @storage.read(@job)
       end
       alias to_h read
 
-      def update(message)
-        Storage.update(@job, message)
+      def update(message, **options)
+        @storage.update(@job, message, **options)
       end
 
       def delete
-        Storage.delete(@job)
+        @storage.delete(@job)
       end
 
       def job_id
-        Storage.job_id(@job)
+        @storage.job_id(@job)
       end
 
       def status

data/lib/activejob-status/storage.rb

@@ -1,39 +1,45 @@
 module ActiveJob
   module Status
-    module Storage
-      class << self
-        def store
-          ActiveJob::Status.store
-        end
+    class Storage
+      def initialize(options = {})
+        options.assert_valid_keys(:expires_in, :throttle_interval)
 
-        def options
-          ActiveJob::Status.options
-        end
+        @expires_in = options[:expires_in]
+        @throttle   = ActiveJob::Status::Throttle.new(options[:throttle_interval])
+      end
 
-        def job_id(job)
-          job.is_a?(String) ? job : job.job_id
-        end
+      def store
+        @store ||= ActiveJob::Status.store
+      end
 
-        def key(job)
-          "activejob:status:#{job_id(job)}"
-        end
+      def job_id(job)
+        job.is_a?(String) ? job : job.job_id
+      end
 
-        def read(job)
-          store.read(key(job)) || {}
-        end
+      def key(job)
+        "activejob:status:#{job_id(job)}"
+      end
 
-        def write(job, message)
-          store.write(key(job), message, expires_in: options[:expires_in])
-        end
+      def read(job)
+        store.read(key(job)) || {}
+      end
 
-        def update(job, message)
-          write(job, read(job).merge(message))
+      def write(job, message, force: false)
+        @throttle.wrap(force: force) do
+          store.write(key(job), message, expires_in: @expires_in)
         end
+      end
 
-        def delete(job)
-          store.delete(key(job))
+      def update(job, message, force: false)
+        @throttle.wrap(force: force) do
+          message = read(job).merge(message)
+          store.write(key(job), message, expires_in: @expires_in)
         end
       end
+
+      def delete(job)
+        store.delete(key(job))
+      end
     end
   end
 end

data/lib/activejob-status/throttle.rb

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

data/lib/activejob-status/version.rb

@@ -1,5 +1,5 @@
 module ActiveJob
   module Status
-    VERSION = '0.1.6'.freeze
+    VERSION = '0.2.0'.freeze
   end
 end

data/lib/activejob-status.rb

@@ -1,11 +1,17 @@
+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_EXPIRY = 60 * 30
+
+    DEFAULT_OPTIONS  = {
+      expires_in:        60 * 30,
+      throttle_interval: 0
+    }.freeze
 
     included do
       before_enqueue { |job| job.status.update(status: :queued) }
@@ -28,11 +34,12 @@ module ActiveJob
 
     class << self
       def options=(options)
-        @@options = options
+        options.assert_valid_keys(*DEFAULT_OPTIONS.keys)
+        @@options = DEFAULT_OPTIONS.merge(options)
       end
 
       def options
-        @@options ||= { expires_in: DEFAULT_EXPIRY }
+        @@options ||= DEFAULT_OPTIONS
       end
 
       def store=(store)

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: activejob-status
 version: !ruby/object:Gem::Version
-  version: 0.1.6
+  version: 0.2.0
 platform: ruby
 authors:
 - Savater Sebastien
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-04-14 00:00:00.000000000 Z
+date: 2021-09-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activejob
@@ -38,7 +38,7 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '4.2'
-description: 
+description:
 email:
 - savater.sebastien@gmail.com
 executables: []
@@ -49,12 +49,13 @@ files:
 - lib/activejob-status/progress.rb
 - lib/activejob-status/status.rb
 - lib/activejob-status/storage.rb
+- lib/activejob-status/throttle.rb
 - lib/activejob-status/version.rb
 homepage: https://github.com/inkstak/activejob-status
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -69,8 +70,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.6
-signing_key: 
+rubygems_version: 3.1.4
+signing_key:
 specification_version: 4
 summary: Monitor your jobs
 test_files: []