serially 0.2.0 → 0.3.0

checksums.yaml

@@ -1,15 +1,15 @@
 ---
 !binary "U0hBMQ==":
   metadata.gz: !binary |-
-    ZDI4ZDNhOGNmOWY5NzdmZDQ2ZmQ0MTk0YmRiMTcxZDVkZWIwNDg0Mw==
+    YjA2NDZjZjI3YTYzYzUzODg2N2IzYTlhNjc4MzNlNDQzZWRmNzkxMA==
   data.tar.gz: !binary |-
-    ZGMwODc1M2I1NWU5ZWQ4NTcyODlmM2I5ZTg3ZDI4OTU3ZjdhZjY2Mg==
+    ZjRiNjU3YWJkM2I3MzE0NmQ3YzBjZGFiODE0ZTg5NmY3MTU4NjFjMA==
 SHA512:
   metadata.gz: !binary |-
-    MTZiMjE0YzQwYTQxNzUyNWQwOThkMDc0MjA4OWU1MGM0YjllMzVjZjc1NjFk
-    Y2Q0MGI2MWMxYjFmY2RhNDI3MTYyNTIwZmE0M2NiMDU5NWY2M2QxMDdmYjFi
-    NTIzMTcyZmQzNjAzODAzMjFkNmQwZTJlMjEwYWUyZWNjZGU0OTA=
+    YmE3N2M3MWZlNmUwMTYyYjk4YmY3MTFlNmUzYzZkYjU5ZjRjN2Y0NjRiMWFk
+    NmMyMDJhZTY4M2YwZDNhMzAwNDgyZjI2NjdiYjA2MWMyYzY3ZTEwZGRmN2Uz
+    NmEzZTdlNzEyZTcwZjBiYWRmMGE0NzQ1Y2M5YzI2ZGEyMDkxMjg=
   data.tar.gz: !binary |-
-    MmFmZWYxM2M4ODYxODRjNTYzNTE0ZDI3ZDE4MmI4MDU4ZjQ2N2E1OTAyYWZm
-    N2JiMWEyZjExMmU2MjJmOGFhNzNkZmMzZGM3NjNjMWFjZTQ2NGUzMmUwYzRi
-    ZmEyYTZmMjE2YzI3MGZhZjgxNjA5MzBjNzg5ZDMxM2Y3MmFkOTY=
+    ODFjZGRhZjc5YmE1ZTA5MDUwMDQxZjNhOGY2MDVhMjA4MzA1OWY3YjI4ODZj
+    MzM5OTJmNjIwZTQ0ODI2NzgxZGYxMDVhNjFiNTY4OTEyNzVmZjljY2QxNzI2
+    ZWU3ZDkwMjJhZTAxYjZkMjhjNjUwZjRlMDQwOTljOTNkODQyMzA=

data/.pryrc

@@ -1 +1,21 @@
-require './spec/active_record_helper'
+require './spec/active_record_helper'
+
+class SimpleModel < ActiveRecord::Base
+  include Serially
+
+  self.table_name =  'simple_items'
+
+  serially do
+    task :model_step1 do |instance|
+      true
+    end
+    task :model_step2 do |instance|
+      ["OK", 'step 2 finished ok']
+    end
+    task :model_step3
+  end
+
+  def model_step3
+    [false, 'step 3 failed']
+  end
+end

data/README.md

@@ -3,14 +3,14 @@
 [![Build Status](https://circleci.com/gh/mikemarsian/serially.svg?&style=shield&circle-token=93a8f2925ebdd64032108118ef6e17eb3848d767)](https://circleci.com/gh/mikemarsian/serially)
 [![Code Climate](https://codeclimate.com/github/mikemarsian/serially/badges/gpa.svg)](https://codeclimate.com/github/mikemarsian/serially)
 
-Have you ever had a class that required a series of background tasks to run serially, strictly one after another? Than Serially is for you.
+Have you ever had a class that required a series of background tasks to run serially, strictly one after another? Then Serially is for you.
 Declare the tasks using a simple DSL in the order you want them to to run. Serially will wrap them in a single job, and schedule it using Resque
-in a queue you specify (or a default one). The next task will run only if previous one finished successfully. All task runs are written to DB and can be inspected (if
-your class is an ActiveRecord object).
+in a queue you specify (or a default one). The next task will run only if the previous one has finished successfully. All task run results are written to DB and can be inspected (that is if
+your class is an ActiveRecord model).
 
 Check [this demo app][1] to see how Serially may be used in a Rails app.
 
-Note: Serially is under active development. If there is anything you miss in it, please let me know!
+Note: Serially is under active development. If there is anything you miss in it, let me know!
 
 Twitter: @mikepolis     Email: mike AT polischuk DOT net
 
@@ -70,8 +70,9 @@ class Post < ActiveRecord::Base
      end
    end
 ```
+### Start for Instance
 
-After creating a Post, you can run `post.serially.start!` to schedule your Post tasks to run serially. They will run one after the other in the scope of the same `Serially::Job`
+After creating an instance of a Post, you can run `post.serially.start!` to schedule your Post tasks to run serially. They will run one after the other in the scope of the same `Serially::Job`
 in the default `serially` queue.
 An example run:
 ```ruby
@@ -89,6 +90,11 @@ Post 1 not published - bibliography is missing
 Post 2 reviewed by staff
 Post 2 not published - bibliography is missing
 ```
+### Start for Batch
+If you want to schedule serially tasks for multiple instances, you can do it in a single call:
+```ruby
+Post.start_batch!([post1.id, post2.id, post3.id])
+```
 
 ### Task Return Values
 
@@ -133,7 +139,7 @@ class Post
      end
 end
 ```
-`Serially::Job`'s of different instances of Post will all be scheduled in 'posts' queue, without any interference to each other.
+Jobs for different instances of Post will all be scheduled in 'posts' queue, without any interference to each other.
 
 ### Blocks
 In addition to instance methods, you can pass a block as a task callback, and you can mix both syntaxes in your class:
@@ -164,7 +170,7 @@ end
 ## Customize Plain Ruby Class Instantiation
 Before the first task runs, Serially creates an instance of your class, on which your task callbacks are then called. By default, instances of plain ruby classes
 are created using simple `new`. If your class has a custom `initialize` method that you want to be called when creating instance of your class, it's easy to achieve. All you need to do is to implement
-`instance_id` method that can return any number of arguments, which will be passed as-is to 'initialize`.
+`instance_id` method that can return any number of arguments, which will be passed as-is to your `initialize`.
 
 ```ruby
 class Post
@@ -229,4 +235,4 @@ Copyright (c) 2015-2016 Mike Polischuk
 
 The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
 
-[1]: https://github.com/mikemarsian/serially-demo
+[1]: https://github.com/mikemarsian/serially-demo

data/lib/serially/serially.rb

@@ -35,6 +35,13 @@ module Serially
         @serially
       end
 
+      def start_batch!(instance_ids)
+        queue = Serially::TaskManager[self].queue
+        instance_ids.each do |instance_id|
+          Serially::Job.enqueue(self, instance_id, queue)
+        end
+      end
+
       def is_active_record?
         self < ActiveRecord::Base
       end

data/lib/serially/version.rb

@@ -1,3 +1,3 @@
 module Serially
-  VERSION = "0.2.0"
+  VERSION = "0.3.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: serially
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors:
 - Mike Polischuk
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-01-04 00:00:00.000000000 Z
+date: 2016-01-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: resque