activejob-status 1.0.1 → 1.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 843334651f7e39f88ff267202ef1d7bbe239705be4dd5507e97b5c1dcdcd79b6
-  data.tar.gz: 285ec915bd5eddbd58f83ef557beaf7798a59c9def6b2a7437af1d4a26e9ed58
+  metadata.gz: 42019a7ba3be192f9ced4e1edf6498fb81e26a61ffdbce26a488c13518a08595
+  data.tar.gz: 8587b93b5aa1f16d77a7649efa3d9e4ef3c6cfe9c90642e37e1a662b20731397
 SHA512:
-  metadata.gz: 2d56a7a5b689688deef228d0ec8e7a6ebd68188bf45a9881da5adeddcb7fa2f6ec8baebe7821208c75140015b318b5cb01e23496dd23a7a1baef367b3111f69e
-  data.tar.gz: 35bb63ac0aac832ed79ce3437731b944a3307193ecffdc502d85c2b9b00cdba0769eac511502411b6f7fa81920d621fd624e9b2f4fc3f8a1dbce970910385b8b
+  metadata.gz: bc6ddddeb61c00b4f6ccfe2355b2c4d3f9409362bbd67637169b0ed3b31e2ffc1d33d4643370317f34089870d3e033cc1ad24b6275d45d1537e30893781a5b76
+  data.tar.gz: 828dad588548826ec64114ced09b8c2ba784429fe8fab1496520aa1042a90cadf80fa0a7fee4b7565b432c2602c4d9bab5e5d5c30962bce211e8416cf95943b2

data/README.md

@@ -8,6 +8,24 @@ Simple monitoring status for ActiveJob, independent of your queuing backend or c
 [![Maintainability](https://api.codeclimate.com/v1/badges/a7b1ec1d3769e49021fd/maintainability)](https://codeclimate.com/github/inkstak/activejob-status/maintainability)
 [![Test Coverage](https://api.codeclimate.com/v1/badges/a7b1ec1d3769e49021fd/test_coverage)](https://codeclimate.com/github/inkstak/activejob-status/test_coverage)
 
+## Table of contents
+
+- [Installation](#installation)
+- [Dependencies](#dependencies)
+- [Configuration](#configuration)
+  - [Cache Store](#cache-store)
+  - [Select data to store by default](#select-data-to-store-by-default)
+  - [Expiration time](#expiration-time)
+  - [Throttling](#throttling)
+- [Usage](#usage)
+  - [Updating status](#updating-status)
+  - [Data stored by default](#data-stored-by-default)
+  - [Reading status](#reading-status)
+  - [Serializing status to JSON](#serializing-status-to-json)
+  - [Setting options per job](#setting-options-per-job)
+  - [ActiveJob::Status and exceptions](#activejobstatus-and-exceptions)
+  - [[Beta] Batches](#beta-batches)
+
 ## Installation
 
 ```bash
@@ -324,7 +342,7 @@ class MyJob < ActiveJob::Base
 end
 ```
 
-## ActiveJob::Status and exceptions
+### ActiveJob::Status and exceptions
 
 Internally, ActiveJob::Status uses `ActiveSupport#rescue_from` to catch every `Exception` to apply the `failed` status
 before throwing the exception again.
@@ -384,6 +402,40 @@ class MyJob < ApplicationJob
 end
 ```
 
+### [Beta] Batches
+
+> **Warning** : The Batch API is available on [beta](https://github.com/inkstak/activejob-status/tree/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 (or you might experience performanes issues).
+>
+
+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)

data/lib/activejob-status/status.rb

@@ -44,7 +44,9 @@ module ActiveJob
       end
 
       def progress
-        read[:progress].to_f / read[:total].to_f
+        read.then do |hash|
+          hash[:progress].to_f / hash[:total].to_f
+        end
       end
 
       def present?

data/lib/activejob-status/version.rb

@@ -2,6 +2,6 @@
 
 module ActiveJob
   module Status
-    VERSION = "1.0.1"
+    VERSION = "1.0.2"
   end
 end

metadata

@@ -1,14 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: activejob-status
 version: !ruby/object:Gem::Version
-  version: 1.0.1
+  version: 1.0.2
 platform: ruby
 authors:
 - Savater Sebastien
-autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-01-12 00:00:00.000000000 Z
+date: 2024-04-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activejob
@@ -178,7 +177,6 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-description:
 email: github.60k5k@simplelogin.co
 executables: []
 extensions: []
@@ -196,7 +194,6 @@ homepage: https://github.com/inkstak/activejob-status
 licenses:
 - MIT
 metadata: {}
-post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -211,8 +208,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.6
-signing_key:
+rubygems_version: 3.6.0.dev
 specification_version: 4
 summary: Monitor your jobs
 test_files: []