activejob-status 0.1.5 → 0.2.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d2c2f5a9c1c18e978423df936f1df40e5ac10e97ec28782260fb3980edac85a8
-  data.tar.gz: f77a7dabc7c43e311af942ddb0218b9f044ebee1284190a37eb810e49da462c2
+  metadata.gz: 8f631add9a816c630d494258c0c62b8357f04d6cf1dcb4c8681646f294b1af1e
+  data.tar.gz: 1bf02e33cfc7ae8e5ffddfd72466efd181d241cab6cfa1a07b75094fd241c18c
 SHA512:
-  metadata.gz: 2db433d26e44683e749a86b8dae4ea426e002d2f3ef3c06aa36a731e75fb2ec7255ec81b36f4daa8c476326f4e45834c180b6d13c600ecd511a05bba800f23dc
-  data.tar.gz: 0a36fb9aa42f326a9d63c203f8c263c69b11f2d92ab438eaf59072aac20c994c655b6125c0d52496fedf9588d44135bcc4c12dbeef2e39f42246d43288de64eb
+  metadata.gz: 71af5a019d4004e27400abc14ee1b3d5c83a794d86096f0dd821a5f8fd52782b303beaac6b31533b6b50e74e44c2254d7e9bbed52d3439556f79aff6fa349ad9
+  data.tar.gz: b5ab17ba47d02f4a0493fc92b34684b261c1720da1da18627a050a7746129febdbcc30e750970d356948b738ab306a4fc8cecb2ca7dc35ccbf1a9c477a46dea8

data/lib/activejob-status/progress.rb

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

data/lib/activejob-status/status.rb

@@ -1,31 +1,39 @@
+# frozen_string_literal: true
+
 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)
+      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_method :to_h, :read
+
+      def update(message, options = {})
+        @job.progress.instance_variable_set(:@progress, message[:progress]) if message.include?(:progress)
+        @job.progress.instance_variable_set(:@total, message[:total]) if message.include?(:total)
 
-      def update(message)
-        Storage.update(@job, message)
+        @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,47 @@
+# frozen_string_literal: true
+
 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,23 @@
+# frozen_string_literal: true
+
+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,7 @@
+# frozen_string_literal: true
+
 module ActiveJob
   module Status
-    VERSION = '0.1.5'.freeze
+    VERSION = "0.2.2"
   end
 end

data/lib/activejob-status.rb

@@ -1,19 +1,28 @@
-require 'activejob-status/storage'
-require 'activejob-status/status'
-require 'activejob-status/progress'
+# 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_EXPIRY = 60 * 30
+
+    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) }
+      before_enqueue { |job| job.status[:status] = :queued }
+      before_perform { |job| job.status[:status] = :working }
+      after_perform { |job| job.status[:status] = :completed }
 
       rescue_from(Exception) do |e|
-        status.update(status: :failed)
+        status[:status] = :failed
         raise e
       end
     end
@@ -28,15 +37,16 @@ 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)
-        store = ActiveSupport::Cache.lookup_store(store) if 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.1.5
+  version: 0.2.2
 platform: ruby
 authors:
 - Savater Sebastien
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2018-06-28 00:00:00.000000000 Z
+date: 2021-09-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activejob
@@ -38,7 +38,119 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '4.2'
-description: 
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.20'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.20'
+- !ruby/object:Gem::Dependency
+  name: rubocop-performance
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.11'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.11'
+- !ruby/object:Gem::Dependency
+  name: rubocop-rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '2.4'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '2.4'
+- !ruby/object:Gem::Dependency
+  name: rubocop-rake
+  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: standard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.3.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.3.0
+description:
 email:
 - savater.sebastien@gmail.com
 executables: []
@@ -49,12 +161,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,9 +182,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: []