activejob-status 1.0.0 → 1.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3a87cf9049d2e78bf3374c506ba99606dc7770a8e263fc12b1f74b64c7a67fab
-  data.tar.gz: 2ae8982bdf6e66bf2002e02fe2df89bf8082ed5d765ca3f49864869b516fc14c
+  metadata.gz: 42019a7ba3be192f9ced4e1edf6498fb81e26a61ffdbce26a488c13518a08595
+  data.tar.gz: 8587b93b5aa1f16d77a7649efa3d9e4ef3c6cfe9c90642e37e1a662b20731397
 SHA512:
-  metadata.gz: 894b7c42328e39fc9c822edf12f32cb9d9c0e95b248e08dcdcfa19ad8151c9192561866e23185797cd7e6a21b811cb8c751fb884ed9143f698dcc13c6872f82f
-  data.tar.gz: 1a7629d6f18764117de7bcb6643baad9f98c76b1ff91b7964cb6aa3b2d6197ebee49bb75cd38c9f9ac1a5dcd7576bf7bf7c0d91b442bda3ed7580d3d54b5aea8
+  metadata.gz: bc6ddddeb61c00b4f6ccfe2355b2c4d3f9409362bbd67637169b0ed3b31e2ffc1d33d4643370317f34089870d3e033cc1ad24b6275d45d1537e30893781a5b76
+  data.tar.gz: 828dad588548826ec64114ced09b8c2ba784429fe8fab1496520aa1042a90cadf80fa0a7fee4b7565b432c2602c4d9bab5e5d5c30962bce211e8416cf95943b2

data/LICENSE

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

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
@@ -20,12 +38,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
 
@@ -327,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.
@@ -387,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)
@@ -403,20 +452,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/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.0"
+    VERSION = "1.0.2"
   end
 end

data/lib/activejob-status.rb

@@ -54,7 +54,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,13 @@
 --- !ruby/object:Gem::Specification
 name: activejob-status
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.0.2
 platform: ruby
 authors:
 - Savater Sebastien
-autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-03-03 00:00:00.000000000 Z
+date: 2024-04-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activejob
@@ -156,14 +155,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
@@ -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: []