taskflow-ar 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: a33ff609e69514be13b1a44c437dc07c326df59b
-  data.tar.gz: 8a24e0a9757af8093448ba9eca9cdf86c27c8206
+  metadata.gz: 92e77f59dd6ec8be300d270e69189e2c68f727fa
+  data.tar.gz: d5913563fa164f2450f1bd680506dcadbd523c83
 SHA512:
-  metadata.gz: dd77850cf8b06856229b1b5d474ebeaf04dd44156fcb911c4604ee4f49377da31dd101cb6df3fe54e89abc2998fe80eb07373440d1329590d285a631d0bc5247
-  data.tar.gz: d34dbd51ae6db1ba05b9b73cc3446e6b317392e42ddf3ec227063ad59a01173ef5ab39ff6a78e001270314f710df033010b66baceec2ddc1b92a1067984c8f69
+  metadata.gz: 0fb4942ce1e6cc098717a2bd3dacc6b7e436aa38fd73e1a6f100f3a8b4715714b51436a19056239d91d346e8c33836165b25568ae9580293bffb2bcdd3147b32
+  data.tar.gz: a28a7db985ef5ba68de88951bff811554b1e15d58805aea212d6036ea22e5e16502f3a0704ce4da59348219d6682dd5caa013f1cb845bc80f6e5d725eeb36452

data/README.md

@@ -1,8 +1,6 @@
 # Taskflow
 
-Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/taskflow`. To experiment with that code, run `bin/console` for an interactive prompt.
-
-TODO: Delete this and the text above, and describe your gem
+Taskflow is a cool rails plugin for creating and schedule task flows. NOTE: taskflow is based sidekiq, and use ActiveRecord/Mongoid as its database adapter, choose the right gem(another version taskflow is also available on my github) for your project.
 
 ## Installation
 
@@ -20,9 +18,17 @@ Or install it yourself as:
 
     $ gem install taskflow-ar
 
+Generate database migration file:
+
+    $ rails g taskflow migration
+    $ rake db:migrate
+
+Tips: if you want use taskflow outside rails, you can just copy these migration files out and creat database table according to the files.
+
 ## Usage
 
-example:
+Let's see an example first, the 'PlayFlow' has 7 task in total. When we start the flow, the t1(PendingTask) runs first, after t1 finishes, t2,t3,t4 would run in parallel; When t4 is done, the t5(OkTask) begins, when t2,t3,t5 are all done, the SummaryTask start to run, then run the last OkTask.
+
 ```ruby
 class PlayFlow < Taskflow::Flow
     NAME = "Play FLow"
@@ -147,6 +153,133 @@ After checking out the repo, run `bin/setup` to install dependencies. You can al
 
 To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
 
+## Documentations
+### Taskflow state diagram
+flow state
+![output](https://raw.githubusercontent.com/qjpcpu/taskflow-ar/master/images/flow-state.png)
+
+### the Taskflow::Flow
+First, you should create your taskflow by inherit `Taskflow::Flow`, and you *must implement the `configure` method* to tell taskflow engine the detail info.
+
+In `configure` method, you can use the keyword `run` to define task:
+
+```ruby
+# the keyword run
+run Task_Class, name: 'task_name'
+# task1 would run before another_task_obj
+run Task_Class, name: 'task1',:before=>another_task_obj
+# task2 would run after another_task_obj
+run Task_Class, name: 'task2',:after=>another_task_obj
+# the wait_task would run after task3,task4,task5 all done
+run Task_Class, name: 'wait_task',:after=>[task3,task4,task5]
+# pass some parameter to task, the params would set as task's input
+run Task_Class, name: 'params_task',params: { :param1=>'abc' }
+```
+
+You can use `after` or `before` to specify the schedule order for certain task, if there's no after or before, the current task would just run after the previous task.
+
+#### 0. config taskflow
+You can config taskflow worker run in which sidekiq queue(default is `default`), forexample in `config/environments/production.rb`:
+```ruby
+Taskflow.configure do |config|
+    config.worker_options = { queue: 'workflow' }
+end
+```
+
+#### 1. launch taskflow
+```ruby
+# the params would be set as taskflow's input field
+Taskflow::Flow.launch 'PlayFlow',:params=>{word: 'hello'},:launched_by=>'Jason',:workflow_description=>'description'
+# check whether can launch taskflow, if there's already a taskflow which has the some taskflow_klass and params, return false
+Taskflow::Flow.can_launch? 'PlayFlow',:params=>{word: 'hello'},:launched_by=>'Jason',:workflow_description=>'description'
+```
+
+#### 2. taskflow control
+```ruby
+# Taskflow::Flow#stop! stop taskflow
+flow.stop!
+flow.stop! 'tom' # => stopped by tom
+# Taskflow::Flow#resume, resume paused flow
+flow.resume
+```
+
+### the Taskflow::Task
+Define your own taskflow task. Inherit the class `Taskflow::Task`, and *implement go method*.
+
+```ruby
+def go(logger)
+# write your task code here
+end
+```
+
+#### 1.Sidekiq logger
+the parameter `logger` of `Taskflow::Task#go` is sidekiq logger, so you can use it to log to sidekiq log file for debug.
+
+#### 2.taskflow logger
+There's another logger in `Taskflow::Task#go` : `tflogger`, `tflogger` can write log information to database. for example:
+
+```ruby
+def go(logger)
+  tflogger.info 'the info message would write to database'
+  tflogger.error 'this error message would write to database,too'
+end
+```
+
+#### 3. input & output
+There's a very cool feature. Every task has its own `input` and `ouput`.
+```ruby
+def go(logger)
+  puts input # => the input hash
+  puts input[:some_key] # => get the input value of the key 'some_key'
+  puts upstream.first.ouput # => get the first upstream's ouput, also is a hash
+end
+```
+
+You have the `set/append_xxx` to modify the input and output.
+```ruby
+def go(log)
+  set_output :some_key=>'value' # => set the output to { :some_key=> 'value'}
+  append_output :some_key2=>'value2' # => add { :some_key2=>'value2' } to output
+end
+```
+
+#### 4. data
+Every task has its own data. After the task is done, the data would be cleanned.
+```ruby
+def go(log)
+  puts data # => print data
+  puts data[:key] # => access data
+  set_data :key=>'value'
+  append_data :key=>'value'
+end
+```
+
+#### 5. relationship
+In the task, you can access its upstream and downstream.
+```ruby
+def go(log)
+  upstream.each{|task| puts task.name }
+  upstream.each{|task| puts task.output }
+  puts downstream.first.name
+end
+```
+
+#### 6. task control
+```ruby
+task.resume # => resume paused task
+task.wakeup(hash_data) # => wakeup suspend task with some hash data
+task.wakeup # => just wakeup
+task.skip # => skip paused task
+```
+And, in `Taskflow::Task#go`, you can use keyword `suspend` to suspend current task, then the task result would convert to `suspend`,state would be `paused`.
+```ruby
+def go(log)
+  log.info 'before suspend'
+  suspend  # => the task would be suspend right now.
+  log.info 'never print me'
+end
+```
+
 ## Contributing
 
 Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/taskflow. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](contributor-covenant.org) code of conduct.

data/lib/taskflow.rb

@@ -11,4 +11,13 @@ module Taskflow
     def self.table_name_prefix
         'taskflow_'
     end
+
+    def self.worker_options=(opts)
+        orig = HashWithIndifferentAccess.new(Worker.sidekiq_options_hash || {})
+        Worker.sidekiq_options_hash = orig.merge(opts).merge(retry: false)
+    end
+    
+    def self.configure
+        yield self
+    end
 end

data/lib/taskflow/version.rb

@@ -1,3 +1,3 @@
 module Taskflow
-  VERSION = "0.1.0"
+  VERSION = "0.1.1"
 end

data/lib/taskflow/worker.rb

@@ -1,7 +1,6 @@
 # coding: utf-8
 class Taskflow::Worker
     include ::Sidekiq::Worker
-    sidekiq_options :retry => false
 
     def perform(task_flow_id,job_id,opts={})
         flow = Taskflow::Flow.find task_flow_id

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: taskflow-ar
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - qujianping
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2015-07-05 00:00:00.000000000 Z
+date: 2015-07-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -95,6 +95,7 @@ files:
 - Rakefile
 - bin/console
 - bin/setup
+- images/flow-state.png
 - lib/generators/taskflow/taskflow_generator.rb
 - lib/generators/templates/create_taskflow_flows.rb
 - lib/generators/templates/create_taskflow_loggers.rb