ruby_job 0.1.1 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 821db9053dac5262bc2a34f6bdf8f4b3ff71e7d2dca2e857068f69707aa30602
-  data.tar.gz: 0ec3c26d522afdc40261a9a028daf51335223ceae8ec98fd431b0f9ec19521e7
+  metadata.gz: e009f73864ad315c45ebbb3d85d1c06ef6e60753f592b79e0256af8b1ce11c2c
+  data.tar.gz: f7b6559ed2d8ba30b2aaf7736622d9bd7c2fe2710d743b09c3167765cea8c35b
 SHA512:
-  metadata.gz: 8ccde94161aee53d05f78174c6456fe62e7508cadab821e8f5fc65780ce608a54f086e02250e7e4c0e9028d9010b9fd3fae4c2474d7466de6adf4db359369708
-  data.tar.gz: ad087c00ad272865d782267d69f03d766eeacfd698aa848022c48b20e938b80fa7329e91eec0362d929af7382e8d3ccbc0e354959795049b3a644cb3f96e40bb
+  metadata.gz: f7a4091bc07e2834818a8014a217fdd2621697218bde9eb8212e9c46d383611d6d11998f18e6964d98aa5fca25a191b8dad1403137f541ada0d3ed0b85d48001
+  data.tar.gz: dbb80928d879c59b35c595b5d2d1230987d25a43b1617dad210871aed8513871f24dc86ecb0febb0d0114101725bc8f29f1f0af6f0b7022b478cf01bdc6a9ed3

data/.ruby-version

@@ -1 +1 @@
-2.7.0
+2.5.7

data/.travis.yml

@@ -10,6 +10,8 @@ language: ruby
 os: linux
 
 rvm:
+  - 2.5.7
+  - 2.6.5
   - 2.7.0
 
 before_install:

data/README.md

@@ -11,7 +11,7 @@ only supports an [In-Memory Job Store](https://github.com/mimperatore/ruby_job/b
 implemented through a fast [Fibonacci Heap](https://github.com/mudge/fibonacci_heap).
 
 The initial version, which supports only a single queue, runs **200% faster than Sucker Punch**, capable of processing **1,000,000** simple jobs in **28 seconds**
-vs. Sucker Punch's 59 seconds (measured on on a MacBook Pro 2.3GHz with 16GB of RAM).
+vs. Sucker Punch's 59 seconds (measured on a MacBook Pro 2.3GHz with 16GB of RAM).
 
 Additional features are in the works, including:
 - Support for multiple queues & queue priorities
@@ -102,6 +102,27 @@ To do so:
 job.dequeue
 ```
 
+### Job arguments
+Your Job class' `#perform` method signature is:
+```ruby
+  def perform(*args)
+  end
+```
+
+When you invoke `#perform_async` (or similar methods), the arguments passed in will get sent to `#perform`.
+
+For example, `MyWorker.perform_async(1, 'hello world!', x: 7)` will end up calling `perform(1, 'hello world!', x: 7)` when the job runs.
+
+**Note**: Whether and how the arguments are serialized depends on the JobStore being used.  `RubyJob::InMemoryJobStore`, the only JobStore
+currently shipped out of the box with this gem, has no need to serialize the arguments, given that everything runs in a single operating system
+process.  However, keep in mind that the `Job` class, which is used to represent instances of jobs to run, defines methods `#to_json` and
+`.json_create(hash)` which use `JSON.dump` and `JSON.parse`, respectively, to marshall the arguments.  If you're going to implement
+your own JobStore, feel free to avail yourself of these methods.
+
+**Pro Tip**: In order to ensure your job code is portable across different JobStore implementations (e.g. in case at some point you think
+you'll need a persistent backing store such as Redis or Cassandra to keep track of your mission critical jobs), ensure the arguments
+you pass serialize and deserialize as you'd expect.
+
 ### Schedule a Job for execution (asynchronously)
 
 **Note:** Jobs are scheduled to nearest **millisecond** of the specified start time.
@@ -135,12 +156,13 @@ server = RubyJob::ThreadedServer.new(num_threads: 10, jobstore: MyWorker.jobstor
 
 #### Server options
 ```ruby
-server.set(wait: true)
+server.set(wait: true, wait_delay: 0.5)
 ```
 
-- `wait`[boolean]: determines whether the server should exit when there aren't any processable jobs in the queue.  Defaults to `true`.
-- `wait_delay`[float]: number of seconds to wait (sleep).  Defaults to `0.5`.
+- `wait`[boolean]: determines whether the server should wait or exit when there aren't any processable jobs in the queue.  Defaults to `true`.
+- `wait_delay`[float]: if the server is going to wait, the number of seconds to delay before looking for jobs again.  Defaults to `0.5`.
 
+**Note:** The `wait`/`wait_delay` parameters apply independently to each worker thread.
 
 #### Starting the server
 Queued jobs will only run when a Server, attached to the JobStore the jobs have been enqueued to, has been started.
@@ -180,15 +202,15 @@ that's been halted for a significant amount of time will pick up old jobs that m
 ensure you take that into account in your job processing code if you care about this situation.
 
 ### Retries
-Jobs will be not be retried by default.  To have jobs retry, the worker class must define a `retry?` method that
-returns a tuple indicating whether the job should be retried, and how long the retry delay should be: [do_retry, retry_delay]
+By default, jobs that raise errors will be not be retried by default.  To have jobs retry, the worker class must define a `retry?` method that
+returns a tuple indicating whether the job should be retried, and how long the retry delay should be: `[do_retry, retry_delay]`
 ```ruby
   MAX_RETRIES = 5
   INITIAL_RETRY_DELAY = 0.5
 
   def retry?(attempt:, error:)
     # determine whether a retry is required, based on the attempt number and error passed in
-    do_retry = error.is_a?(RetriableError) && (attempt < MAX_RETRIES)
+    do_retry = error.is_a?(MyRetriableError) && (attempt < MAX_RETRIES)
 
     [do_retry, INITIAL_RETRY_DELAY * 2**(attempt-1)] # exponential backoff
   end

data/lib/ruby_job/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module RubyJob
-  VERSION = '0.1.1'
+  VERSION = '0.1.2'
 end

data/ruby_job.gemspec

@@ -5,6 +5,7 @@ $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require 'ruby_job/version'
 
 Gem::Specification.new do |spec|
+  spec.required_ruby_version = '>= 2.5.7'
   spec.name          = 'ruby_job'
   spec.version       = RubyJob::VERSION
   spec.authors       = ['Marco Imperatore']
@@ -26,8 +27,9 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ['lib']
 
+  spec.add_dependency 'fibonacci_heap'
+
   spec.add_development_dependency 'bundler', '~> 2.1'
-  spec.add_development_dependency 'byebug', '~> 11.0'
   spec.add_development_dependency 'codecov', '~> 0.1'
   spec.add_development_dependency 'guard', '~> 2.16'
   spec.add_development_dependency 'guard-rspec', '~> 4.7'
@@ -35,5 +37,4 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency 'rspec', '~> 3.9'
   spec.add_development_dependency 'rubocop', '~> 0.78'
   spec.add_development_dependency 'timecop', '~> 0.9'
-  spec.add_dependency 'fibonacci_heap'
 end

metadata

@@ -1,43 +1,43 @@
 --- !ruby/object:Gem::Specification
 name: ruby_job
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.2
 platform: ruby
 authors:
 - Marco Imperatore
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-01-10 00:00:00.000000000 Z
+date: 2020-01-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: bundler
+  name: fibonacci_heap
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '2.1'
-  type: :development
+        version: '0'
+  type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '2.1'
+        version: '0'
 - !ruby/object:Gem::Dependency
-  name: byebug
+  name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '11.0'
+        version: '2.1'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '11.0'
+        version: '2.1'
 - !ruby/object:Gem::Dependency
   name: codecov
   requirement: !ruby/object:Gem::Requirement
@@ -136,20 +136,6 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0.9'
-- !ruby/object:Gem::Dependency
-  name: fibonacci_heap
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
 description: 'RubyJob is a framework for running jobs.
 
   '
@@ -198,7 +184,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 2.5.7
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="