activejob-status 0.1.4 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: '069dbaec9c90cd38b7f3c776c8cb928c69e9e381da44a12859f90be51f2187c6'
-  data.tar.gz: f75d3ba17eb3f9d56d1bc1abdbe343dc2f5b46e269bccc24c652e43dc6b0c618
+  metadata.gz: 409f3ad04e793c5c448ab94bf9abf6adef5caf2b37c48635b1cee46fd638b773
+  data.tar.gz: 9c8add1a5bf84c5d4766ddf115e83d523a13181f84bffb1ee31bdfe90ff8a206
 SHA512:
-  metadata.gz: 6a59ed17b1979cb50b385397f1d316c87e5d4a6563a7ca7f441fff4f8e8411ddfddb835664df7f7f93ad2c558b9bc782a396e9beb6ae6a546b55a9f60746a6fe
-  data.tar.gz: d3be935b39e3685d81adeba2a544496ca8ee506e4b469bd060546d4d7e7114080fb5bae8635039091889afc292da379ebe24f5ac3405201fecce512bfc62568b
+  metadata.gz: c78e3c4ff9531cc4a66ba3ca43cad0ccb22b411f7335f5adc61ed71c9da870ebfd651ae1069f5bfccbe809f2ea5bec97b8a1ad3bc8e7b22703cdceae604cf014
+  data.tar.gz: d2fbff1487df100ba0033bbe8e6833fd8660ac77c320c90fe920543fe2e01dc3ee65e31ea770bb9b43c5508c748fa0dea50631d12a53c2da31fd8e6f4d34970a

data/lib/activejob-status/progress.rb

@@ -1,44 +1,50 @@
-module ActiveJob::Status
-  class Progress
-    delegate :[], :to_s, :to_json, :inspect, to: :hash
-
-    def initialize(job)
-      @job      = job
-      @total    = 100
-      @progress = 0
-    end
-
-    def total=(num)
-      @total = num
-      update
-    end
-
-    def progress=(num)
-      update { num }
-    end
-
-    def increment(num=1)
-      update { @progress + num }
-    end
-
-    def decrement(num=1)
-      update { @progress - num }
-    end
-
-    def finish
-      update { @total }
-    end
-
-  private
-
-    def update
-      @progress = yield if block_given?
-      @job.status.update(hash)
-      self
-    end
-
-    def hash
-      { progress: @progress, total: @total }
+module ActiveJob
+  module Status
+    class Progress
+      attr_reader :job, :total, :progress
+
+      delegate :[], :to_s, :to_json, :inspect, to: :to_h
+      delegate :status, to: :job, prefix: true
+
+      def initialize(job)
+        @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)
+        @progress += num
+        job_status.update(to_h)
+        self
+      end
+
+      def decrement(num = 1)
+        @progress -= num
+        job_status.update(to_h)
+        self
+      end
+
+      def finish
+        @progress = @total
+        job_status.update(to_h, force: true)
+        self
+      end
+
+      def to_h
+        { progress: @progress, total: @total }
+      end
     end
   end
 end

data/lib/activejob-status/status.rb

@@ -1,46 +1,51 @@
-module ActiveJob::Status
-  class Status
-    delegate :[], :to_s, :to_json, :inspect, to: :read
-    delegate :queued?, :working?, :completed?, :failed?, to: :status_inquiry
-
-    def initialize(job)
-      @job = job
-    end
-
-    def []= key, value
-      update(key => value)
-    end
-
-    def read
-      Storage.read(@job)
-    end
-
-    def update(message)
-      Storage.update(@job, message)
-    end
-
-    def delete
-      Storage.delete(@job)
-    end
-
-    def job_id
-      Storage.job_id(@job)
-    end
-
-    def status
-      read[:status]
-    end
-
-    def progress
-      read[:progress].to_f / read[:total].to_f
-    end
-
-    def present?
-      read.present?
-    end
-
-    def status_inquiry
-      status.to_s.inquiry
+module ActiveJob
+  module Status
+    class Status
+      delegate :[], :to_s, :to_json, :inspect, to: :read
+      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
+      end
+
+      def []=(key, value)
+        update({ key => value }, force: true)
+      end
+
+      def read
+        @storage.read(@job)
+      end
+      alias to_h read
+
+      def update(message, **options)
+        @storage.update(@job, message, **options)
+      end
+
+      def delete
+        @storage.delete(@job)
+      end
+
+      def job_id
+        @storage.job_id(@job)
+      end
+
+      def status
+        read[:status]
+      end
+
+      def progress
+        read[:progress].to_f / read[:total].to_f
+      end
+
+      def present?
+        read.present?
+      end
+
+      def status_inquiry
+        status.to_s.inquiry
+      end
     end
   end
 end

data/lib/activejob-status/storage.rb

@@ -1,12 +1,15 @@
-module ActiveJob::Status
-  module Storage
-    class << self
-      def store
-        ActiveJob::Status.store
+module ActiveJob
+  module Status
+    class Storage
+      def initialize(options = {})
+        options.assert_valid_keys(:expires_in, :throttle_interval)
+
+        @expires_in = options[:expires_in]
+        @throttle   = ActiveJob::Status::Throttle.new(options[:throttle_interval])
       end
 
-      def options
-        ActiveJob::Status.options
+      def store
+        @store ||= ActiveJob::Status.store
       end
 
       def job_id(job)
@@ -21,12 +24,17 @@ module ActiveJob::Status
         store.read(key(job)) || {}
       end
 
-      def write(job, message)
-        store.write(key(job), message, expires_in: options[:expires_in])
+      def write(job, message, force: false)
+        @throttle.wrap(force: force) do
+          store.write(key(job), message, expires_in: @expires_in)
+        end
       end
 
-      def update(job, message)
-        write(job, read(job).merge(message))
+      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)

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.4'
+    VERSION = '0.2.0'.freeze
   end
 end

data/lib/activejob-status.rb

@@ -1,50 +1,59 @@
+require 'active_support/core_ext/hash'
 require 'activejob-status/storage'
 require 'activejob-status/status'
 require 'activejob-status/progress'
-
-module ActiveJob::Status
-  extend ActiveSupport::Concern
-  DEFAULT_EXPIRY = 60 * 30
-
-  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) }
-
-    rescue_from(Exception) do |e|
-      self.status.update(status: :failed)
-      raise e
+require 'activejob-status/throttle'
+
+module ActiveJob
+  module Status
+    extend ActiveSupport::Concern
+
+    DEFAULT_OPTIONS  = {
+      expires_in:        60 * 30,
+      throttle_interval: 0
+    }.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) }
+
+      rescue_from(Exception) do |e|
+        status.update(status: :failed)
+        raise e
+      end
     end
-  end
-
-  def status
-    @status ||= Status.new(self)
-  end
 
-  def progress
-    @progress ||= Progress.new(self)
-  end
-
-  class << self
-    def options= options
-      @@options = options
+    def status
+      @status ||= Status.new(self)
     end
 
-    def options
-      @@options ||= { expires_in: DEFAULT_EXPIRY }
+    def progress
+      @progress ||= Progress.new(self)
     end
 
-    def store= store
-      store = ActiveSupport::Cache.lookup_store(store) if store.is_a?(Symbol)
-      @@store = store
-    end
+    class << self
+      def options=(options)
+        options.assert_valid_keys(*DEFAULT_OPTIONS.keys)
+        @@options = DEFAULT_OPTIONS.merge(options)
+      end
 
-    def store
-      @@store ||= (defined?(Rails) && Rails.cache)
-    end
+      def options
+        @@options ||= DEFAULT_OPTIONS
+      end
+
+      def store=(store)
+        store = ActiveSupport::Cache.lookup_store(store) if store.is_a?(Symbol)
+        @@store = store
+      end
+
+      def store
+        @@store ||= (defined?(Rails) && Rails.cache)
+      end
 
-    def get(id)
-      Status.new(id)
+      def get(id)
+        Status.new(id)
+      end
     end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: activejob-status
 version: !ruby/object:Gem::Version
-  version: 0.1.4
+  version: 0.2.0
 platform: ruby
 authors:
 - Savater Sebastien
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2018-06-28 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,11 +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: 
-licenses: []
+homepage: https://github.com/inkstak/activejob-status
+licenses:
+- MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -68,9 +70,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.7
-signing_key: 
+rubygems_version: 3.1.4
+signing_key:
 specification_version: 4
 summary: Monitor your jobs
 test_files: []