rask 0.0.1 → 0.0.2

data/lib/rask.rb

@@ -7,37 +7,67 @@ require 'thread'
 
 require File.dirname(__FILE__) + '/rask/state_machine'
 
-
+#Authors::   mewlist / Hidenori Doi
+#Copyright:: Copyright (C) 2010 mewlist / Hidenori Doi
+#License::   The MIT License
+#
+#== Rask is terminatable task engine
+#
 module Rask
   
+  #
+  #===Task base class
+  #To define new Task you must inherit this base-class
+  #* sample code
+  # class NewTask < Rask::Task
+  #   define_state :initial, :initial => true
+  #   define_state :finish
+  #   def initial
+  #     transition :finish
+  #   end
+  #   def finish
+  #     destroy
+  #   end
+  # end
   class Task
     include StateMachine
     attr_accessor :task_id
     attr_accessor :group
+    attr_reader   :state
     
+    #
+    #====If group option is given, the task is classified by group name.
+    #
+    #==== _group
+    # group name to classify
     def initialize(_group=nil)
-      group = _group
+      self.group = _group
       super()
     end
     
-    
+    #
+    #====automatically callbacked from task engine.
+    #
     def run
       if @state
         eval @state.to_s
       end
     end
     
-    
+    #
+    #====Transition to new state. In the state function.
+    # Usually you should call generated transition_to_[state name] function
     def transition(to)
       @state = to
     end
     
     
+    #
     def destroy
       transition nil
     end
     
-    
+    #
     def destroy?
       @state == nil
     end
@@ -46,42 +76,41 @@ module Rask
   
   
   @@base_dir         = '/tmp/rask'
-  @@threading        = false
   @@thread_max_count = 5
   @@thread_count     = 0
   @@terminated       = false
   @@queue            = Queue.new
   @@processing       = []
   @@locker           = Mutex::new
- 
+  
+  #
+  #====Set base storage directory
+  #default is '/tmp/rask'
+  #
   def self.base_directory=(new_directory)
     @@base_dir = new_directory
   end
   
-  def self.enable_thread
-    @@threading = true
-  end
-  
-  def self.disable_thread
-    @@threading = false
-  end
-  
+  #
+  #====Set max count of worker thread
+  #
   def self.thread_max_count=(count)
     @@thread_max_count = count
   end
   
+  #
   def self.task_path(task_id)
     @@base_dir+"/#{task_id}.task"
   end
   
-  def self.task_path(task_id)
-    @@base_dir+"/#{task_id}.task"
-  end
-  
+  #
   def self.pid_path
     @@base_dir+"/#{File.basename($0)}.pid"
   end
   
+  #
+  #====Insert new task 
+  # Rask::insert NewTask.new
   def self.insert(task)
     initialize_storage
     task_id = "#{safe_class_name(task.class.name)}-#{task.group.to_s}-#{Time.now.to_i}-#{Time.now.usec}"
@@ -95,8 +124,9 @@ module Rask
   end
   
   
-  def self.run(task_path)
-    f = File.open(task_path, 'r+') rescue return
+  #
+  def self.run(task_id)
+    f = File.open(task_path(task_id), 'r+') rescue return
     f.flock(File::LOCK_EX)
     
     task = Marshal.restore(f)
@@ -107,51 +137,67 @@ module Rask
     Marshal.dump(task, f)
     f.flock(File::LOCK_UN)
     f.close
-    FileUtils.rm(task_path) if task.destroy?
+    FileUtils.rm(task_path(task_id)) if task.destroy?
   end
   
-  def self.each(options = { :class=>nil, :group=>nil }, &blk)
-    threads = []
-    tasks(options).each { |d|
-      if @@threading
-        threads << Thread::new(d) { |task_path| run(task_path, &blk) }
-      else
-        run(d, &blk)
-      end
-    }
-    threads.each { |t| t.join } if @@threading
+  #
+  def self.read(task_id)
+    f = File.open(task_path(task_id), 'r+') rescue return
+    f.flock(File::LOCK_EX)
+    task = Marshal.restore(f)
+    f.flock(File::LOCK_UN)
+    f.close
+    task
   end
   
-  def self.tasks(options = { :class=>nil, :group=>nil })
+  #
+  #====Get all file path of task list
+  #
+  def self.task_ids(options = { :class=>nil, :group=>nil })
     target = @@base_dir
-    target += '/' if options[:class] || options[:group]
-    target += "#{safe_class_name(options[:class])}" if options[:class]
+    target += '/'
+    if options[:class]
+      target += "#{safe_class_name(options[:class])}"
+    else
+      target += "[^-]+"
+    end
     target += "-#{options[:group]}-" if options[:group]
     
-    task_list = []
+    task_id_list = []
     Dir.glob(@@base_dir+"/*.task") { |d|
       if target.empty? || /#{target}/ =~ d
-        task_list.push d
+        task_id_list.push File.basename(d, ".*")
       end
     }
-    task_list
+    task_id_list
   end
   
+  #
   def self.initialize_storage
     unless File.exists? @@base_dir
       FileUtils.makedirs @@base_dir
     end
   end
   
+  #
+  #====force destroy the task
+  #
   def self.destroy(task)
     FileUtils.rm(task_path(task.task_id)) if File.exists? task_path(task.task_id)
   end
   
+  #
   def self.safe_class_name(c)
     c.gsub(/[:]/,'@')
   end
-
-  def self.daemon(options = { :class=>nil, :group=>nil, :sleep=>0.1 })
+  
+  #
+  #====Start daemon process
+  #It is possible to specify the the task group.
+  # Rask.daemon(:group=>'TaskGroup')
+  #
+  def self.daemon(options = {})
+    options = { :sleep=>0.1 }.merge(options)
     print "daemon start\n"
     exit if fork
     Process.setsid
@@ -190,7 +236,7 @@ module Rask
     Signal.trap(:TERM) {safe_exit}
     
     while true
-      task_list = Rask.tasks(options)
+      task_list = Rask.task_ids(options)
       task_list.each { |d|
         @@locker.synchronize do
           unless @@processing.include?(d)
@@ -203,6 +249,7 @@ module Rask
     end
   end
   
+  #
   def self.safe_exit
     print "daemon terminated"
     @@terminated = true

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: rask
 version: !ruby/object:Gem::Version 
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors: 
 - mewlist / Hidenori Doi
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-02-26 00:00:00 +09:00
+date: 2010-02-28 00:00:00 +09:00
 default_executable: 
 dependencies: []
 
@@ -26,6 +26,39 @@ files:
 - test/test_rask.rb
 - lib/rask.rb
 - lib/rask/state_machine.rb
+- doc/rdoc.css
+- doc/js/darkfish.js
+- doc/js/jquery.js
+- doc/js/quicksearch.js
+- doc/js/thickbox-compressed.js
+- doc/images/brick.png
+- doc/images/brick_link.png
+- doc/images/bug.png
+- doc/images/bullet_black.png
+- doc/images/bullet_toggle_minus.png
+- doc/images/bullet_toggle_plus.png
+- doc/images/date.png
+- doc/images/find.png
+- doc/images/loadingAnimation.gif
+- doc/images/macFFBgHack.png
+- doc/images/package.png
+- doc/images/page_green.png
+- doc/images/page_white_text.png
+- doc/images/page_white_width.png
+- doc/images/plugin.png
+- doc/images/ruby.png
+- doc/images/tag_green.png
+- doc/images/wrench.png
+- doc/images/wrench_orange.png
+- doc/images/zoom.png
+- doc/index.html
+- doc/Rask.html
+- doc/Rask/StateMachine.html
+- doc/Rask/StateMachine/ClassMethods.html
+- doc/Rask/Task.html
+- doc/lib/rask_rb.html
+- doc/lib/rask/state_machine_rb.html
+- doc/created.rid
 - README.rdoc
 - History.txt
 has_rdoc: true