activejob-status 1.0.0 → 1.1.0.beta.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3a87cf9049d2e78bf3374c506ba99606dc7770a8e263fc12b1f74b64c7a67fab
-  data.tar.gz: 2ae8982bdf6e66bf2002e02fe2df89bf8082ed5d765ca3f49864869b516fc14c
+  metadata.gz: c2126b98461087723d25a787999e46ad568131c528d8b38d49d437700e9ee640
+  data.tar.gz: 3cfa5a8c5783b0efef3f6f7db766681afe65ecad74ff2622b2104e1810c525cd
 SHA512:
-  metadata.gz: 894b7c42328e39fc9c822edf12f32cb9d9c0e95b248e08dcdcfa19ad8151c9192561866e23185797cd7e6a21b811cb8c751fb884ed9143f698dcc13c6872f82f
-  data.tar.gz: 1a7629d6f18764117de7bcb6643baad9f98c76b1ff91b7964cb6aa3b2d6197ebee49bb75cd38c9f9ac1a5dcd7576bf7bf7c0d91b442bda3ed7580d3d54b5aea8
+  metadata.gz: 98dd6128baae8b40dba1e6de09f4d71b3ea2eb0d41764cca7f58b0d5f2672ff7d8e71ffd9b8e670eb71adb91772eb763b2e06c55becd7404d9640611e130e072
+  data.tar.gz: 8340c579dbc672a62ca3821f9ded8c8f7a736ec87d476134fa96ed936c2988d83a2c3e612dca842f61cd5189e2385ca9022acce5a47696f411f59ea3a1fb3ca2

data/LICENSE

@@ -1,4 +1,4 @@
-Copyright (c) 2023 Savater Sebastien
+Copyright (c) 2016-2024 Savater Sebastien
 
 MIT License
 

data/README.md

@@ -20,12 +20,9 @@ bundle add activejob-status
 
 ## Dependencies
 
-In future releases, `ActiveJob::Status` won't support [EOL versions](https://endoflife.date/rails) of `ActiveJob` & `ActiveSupport`.
-
-* Version `1.x` requires `ActiveSupport >= 6.0`
-
-If you're still using older Rails version, see [#24](https://github.com/inkstak/activejob-status/issues/24#issuecomment-1436046173).
+ActiveJob::Status 1.x requires `ActiveSupport >= 6.0`
 
+If you're still using an older version of Rails, see [v0.5.0](https://github.com/inkstak/activejob-status/releases/tag/v0.5.0).
 
 ## Configuration
 
@@ -387,6 +384,40 @@ class MyJob < ApplicationJob
 end
 ```
 
+### [Beta] Batches
+
+> **Warning** : The Batch API is available in beta:
+>
+> ```bash
+> gem install activejob-status --pre
+> # or
+> bundle add activejob-status --version "~> 1.1.0.beta.0"
+> ```
+>
+> It doesn't provide all features implemented by backends
+> like [Sidekiq](https://github.com/sidekiq/sidekiq/wiki/Batches)
+> or [GoodJob](https://github.com/bensheldon/good_job?tab=readme-ov-file#batches).  
+> Moreover, it wasn't designed to support batches with hundreds of jobs.  
+>
+
+ActiveJob::Status provides a naïve implementation of batches:
+
+```ruby
+job_1 = MyJob.perform_later
+job_2 = MyJob.perform_later
+
+batch = ActiveJob::Status::Batch.new([job_1, job_2])
+batch.status # => "working"
+```
+
+The batch status is considered:
+
+* `queued` if **all** of the jobs are `queued`
+* `failed` if **one** of the jobs is `failed`
+* `completed` if **all** of the jobs are `completed`
+* `working` in all other circumstances
+
+
 ## Contributing
 
 1. Don't hesitate to submit your feature/idea/fix in [issues](https://github.com/inkstak/activejob-status)
@@ -403,20 +434,20 @@ bundle exec rubocop
 bundle exec standardrb
 ```
 
-All of them can be run with:
-
+To run RSpec against various version of Rails dependencies:
 ```bash
-bundle exec rake
+bundle exec appraisal install
+bundle exec appraisal rspec
 ```
 
-To run test suite against various version of Rails dependencies:
+All of them can be run with:
+
 ```bash
-bundle exec appraisal install
-bundle exec appraisal
+bundle exec rake
 ```
 
 ## License & credits
 
-Please see [LICENSE](https://github.com/inkstak/coverart/blob/main/LICENSE) for further details.
+Please see [LICENSE](https://github.com/inkstak/activejob-status/blob/main/LICENSE) for further details.
 
-Contributors: [./graphs/contributors](https://github.com/inkstak/coverart/graphs/contributors)
+Contributors: [./graphs/contributors](https://github.com/inkstak/activejob-status/graphs/contributors)

data/lib/activejob-status/batch.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+module ActiveJob
+  module Status
+    class Batch
+      def initialize(jobs)
+        @jobs = jobs
+        @storage = ActiveJob::Status::Storage.new
+      end
+
+      def status
+        statuses = read.values.pluck(:status)
+
+        if statuses.include?(:failed)
+          :failed
+        elsif statuses.all?(:queued)
+          :queued
+        elsif statuses.all?(:completed)
+          :completed
+        else
+          :working
+        end
+      end
+
+      def read
+        @storage.read_multi(@jobs)
+      end
+      alias_method :to_h, :read
+    end
+  end
+end

data/lib/activejob-status/storage.rb

@@ -26,6 +26,12 @@ module ActiveJob
         store.read(key(job)) || {}
       end
 
+      def read_multi(jobs)
+        keys = jobs.map { |job| key(job) }
+        data = store.read_multi(*keys)
+        keys.index_with { |k| data.fetch(k, {}) }
+      end
+
       def write(job, message, force: false)
         @throttle.wrap(force: force) do
           store.write(key(job), message, expires_in: @expires_in)

data/lib/activejob-status/version.rb

@@ -2,6 +2,6 @@
 
 module ActiveJob
   module Status
-    VERSION = "1.0.0"
+    VERSION = "1.1.0.beta.0"
   end
 end

data/lib/activejob-status.rb

@@ -8,6 +8,7 @@ require "activejob-status/storage"
 require "activejob-status/status"
 require "activejob-status/progress"
 require "activejob-status/throttle"
+require "activejob-status/batch"
 
 module ActiveJob
   module Status
@@ -54,7 +55,7 @@ module ActiveJob
       end
 
       def store
-        @@store ||= (defined?(Rails) && Rails.cache)
+        @@store ||= (Rails.cache if defined?(Rails))
       end
 
       def get(id)

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: activejob-status
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.1.0.beta.0
 platform: ruby
 authors:
 - Savater Sebastien
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-03-03 00:00:00.000000000 Z
+date: 2024-02-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activejob
@@ -156,14 +156,14 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '1.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '1.0'
 - !ruby/object:Gem::Dependency
   name: timecop
   requirement: !ruby/object:Gem::Requirement
@@ -187,6 +187,7 @@ files:
 - LICENSE
 - README.md
 - lib/activejob-status.rb
+- lib/activejob-status/batch.rb
 - lib/activejob-status/progress.rb
 - lib/activejob-status/status.rb
 - lib/activejob-status/storage.rb
@@ -207,11 +208,11 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - ">"
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 1.3.1
 requirements: []
-rubygems_version: 3.1.6
+rubygems_version: 3.4.6
 signing_key:
 specification_version: 4
 summary: Monitor your jobs