taskinator 0.4.4 → 0.4.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 553051326370b73612679e5e466e4dea25b8ae525c964038ef2300ebd146f869
-  data.tar.gz: 76e6febc439dbacfd81d15cbc691a582704ee1fae7dd414ace676e39b4fd4e63
+  metadata.gz: f4b27d4976ed505d54439b1906801adea0948dd89aa98cc02edcba80bb3be4b6
+  data.tar.gz: a0014b64e79e81ce3265b3c6cb9bc74103e36a0943bff3586616f8904d168f4a
 SHA512:
-  metadata.gz: 7216ab9db50025dc54c25cc00a4d2b696788173dcc2dbe4e8bbc4ccb9088e4c87373b9e6fa237a9ed7888c08af33c38da344ddfb2aa22f4fdc393995e4f22433
-  data.tar.gz: 8e268d20568348320f45fb9252fac13cfa7f7638745f196e49a721d0230fd677562aba760407e8d45e93ed410772323126fd596852959975d5c64079cde042db
+  metadata.gz: 0f02656db786b6455ca0b521d56daac3c3b92d55b699201a6c40a67792b73afcfa06699a9bd9bb92a6f689e63e92a6e997fea058f5218ee4df17274a26d4d261
+  data.tar.gz: aa4b36704cfb5ff3ca9c27d7446ce02aac1adb0e0f38a7c0eccdac6182e5214b5fba1f4f9fff363840e0ee7f9f4894b9575c33da60b273f187ec330533470331

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    taskinator (0.4.4)
+    taskinator (0.4.5)
       builder (>= 3.2.2)
       connection_pool (>= 2.2.0)
       globalid (~> 0.3)
@@ -47,8 +47,8 @@ GEM
       thor (>= 0.19.4, < 2.0)
       tins (~> 1.6)
     crass (1.0.6)
-    delayed_job (4.1.9)
-      activesupport (>= 3.0, < 6.2)
+    delayed_job (4.1.10)
+      activesupport (>= 3.0, < 8.0)
     diff-lcs (1.5.0)
     docile (1.4.0)
     e2mmap (0.1.0)
@@ -57,7 +57,7 @@ GEM
       redis (>= 3.2, < 5.0)
     globalid (0.6.0)
       activesupport (>= 5.0)
-    i18n (1.8.11)
+    i18n (1.9.1)
       concurrent-ruby (~> 1.0)
     json (2.6.1)
     loofah (2.13.0)
@@ -115,15 +115,15 @@ GEM
       rspec-core (~> 3.10.0)
       rspec-expectations (~> 3.10.0)
       rspec-mocks (~> 3.10.0)
-    rspec-core (3.10.1)
+    rspec-core (3.10.2)
       rspec-support (~> 3.10.0)
     rspec-expectations (3.10.2)
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.10.0)
-    rspec-mocks (3.10.2)
+    rspec-mocks (3.10.3)
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.10.0)
-    rspec-rails (5.0.2)
+    rspec-rails (5.1.0)
       actionpack (>= 5.2)
       activesupport (>= 5.2)
       railties (>= 5.2)
@@ -136,7 +136,7 @@ GEM
       sidekiq (>= 2.4.0)
     rspec-support (3.10.3)
     ruby2_keywords (0.0.5)
-    sidekiq (6.3.1)
+    sidekiq (6.4.0)
       connection_pool (>= 2.2.2)
       rack (~> 2.0)
       redis (>= 4.2.0)

data/README.md

@@ -45,6 +45,28 @@ Or install it yourself as:
 
     $ gem install taskinator
 
+If you are using Taskinator within a Rails application, then add an initializer, such as
+`config/initializers/taskinator.rb`, with the following configuration content:
+
+```ruby
+# config/initializers/taskinator.rb
+Taskinator.configure do |config|
+
+  # configure the queue adapter to use
+  # can be :active_job, :delayed_job, :redis or :sidekiq
+  config.queue_adapter = :redis
+
+  # configure redis
+  config.redis = {
+    :url => 'redis://redis.example.com:7372/12',
+    :namespace => 'mynamespace'
+  }
+
+end
+```
+
+See the configuration section below for more configuration details.
+
 ## Usage
 
 ### Definition
@@ -658,17 +680,20 @@ _NOTE:_ The configuration hash _must_ have symbolized keys.
 
 ```ruby
 Taskinator.configure do |config|
- config.redis = {
-   :url => 'redis://redis.example.com:7372/12',
-   :namespace => 'mynamespace'
- }
+
+  # redis configuration
+  config.redis = {
+    :url => 'redis://redis.example.com:7372/12',
+    :namespace => 'mynamespace'
+  }
+
 end
 ```
 
 Or, alternatively, via an `ENV` variable
 
 Set the `REDIS_PROVIDER` environment variable to the Redis server url.
-E.g. On Heroku, with RedisGreen: set REDIS_PROVIDER=REDISGREEN_URL and Taskinator will use the
+E.g. On Heroku, with RedisGreen: set `REDIS_PROVIDER=REDISGREEN_URL` and Taskinator will use the
 value of the `REDISGREEN_URL` environment variable when connecting to Redis.
 
 You may also use the generic `REDIS_URL` which may be set to your own private Redis server.
@@ -679,15 +704,37 @@ wiki page for more information.
 
 ### Queues
 
+To configure the queue adapter to use, set `config.queue_adapter` to one of the following values:
+
+* `:active_job`
+* `:delayed_job`
+* `:redis`
+* `:sidekiq`
+
+As follows:
+
+```ruby
+Taskinator.configure do |config|
+
+  # configure the queue adapter to use
+  # can be :active_job, :delayed_job, :redis or :sidekiq
+  config.queue_adapter = :redis
+
+end
+```
+
 By default the queue names for process and task workers is `default`, however, you can specify
 the queue names as follows:
 
 ```ruby
 Taskinator.configure do |config|
+
+  # queue configuration
   config.queue_config = {
     :process_queue => :default,
     :task_queue => :default
   }
+
 end
 ```
 
@@ -698,7 +745,10 @@ as `ActiveSupport::Notifications`.
 
 ```ruby
 Taskinator.configure do |config|
+
+  # configure instrumenter to use
   config.instrumenter = ActiveSupport::Notifications
+
 end
 ```
 
@@ -706,7 +756,10 @@ Alternatively, you can use the built-in instrumenter for logging to the console
 
 ```ruby
 Taskinator.configure do |config|
+
+  # configure instrumenter to use
   config.instrumenter = Taskinator::ConsoleInstrumenter.new
+
 end
 ```
 

data/lib/taskinator/version.rb

@@ -1,3 +1,3 @@
 module Taskinator
-  VERSION = "0.4.4"
+  VERSION = "0.4.5"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: taskinator
 version: !ruby/object:Gem::Version
-  version: 0.4.4
+  version: 0.4.5
 platform: ruby
 authors:
 - Chris Stefano
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-01-17 00:00:00.000000000 Z
+date: 2022-01-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: redis
@@ -238,7 +238,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.6
+rubygems_version: 3.2.3
 signing_key: 
 specification_version: 4
 summary: A simple orchestration library for running complex processes or workflows