rask 0.0.0

data/History.txt

@@ -0,0 +1,4 @@
+=== 0.0.0 2010-02-11
+
+* 1 major enhancement:
+  * Initial release

data/README.rdoc

@@ -0,0 +1,105 @@
+= rask
+
+* http://github.com/mewlist/Rask
+
+== DESCRIPTION:
+ 
+ Rask を使うと、タスク処理をシンプルに記述できます。
+ 
+ タスクの実行状態が自動的に永続化されるので、
+ タスクの中断、復帰が容易です。
+ これらの処理は、web のように処理がまばらな環境での利用を想定しています。
+ また、膨大な時間がかかる計算処理などでの利用も考えられます。
+ 
+ 
+ 
+== FEATURES/PROBLEMS:
+
+* ステートマシンの記述 (Act As State Machine と似てる)
+* タスク状態の永続化
+
+== SYNOPSIS:
+
+* タスクの定義 (countup.rb)
+ require 'rubygems'
+ require 'rask'
+ #
+ # 数値のカウントアップ 10 までカウントする
+ # タスクの定義
+ #
+ class CountupTask < Rask::Task
+   define_state :start,   :initial => true       # 初期状態
+   define_state :running                         # 実行
+   define_state :finish,  :from    => [:running] # 終了 (遷移元は:runningからのみ)
+   
+   def start
+     @count = 0
+     p "start"
+     transition_to_running # :running へ遷移
+   end
+   
+   def running
+     p "running count => #{@count+=1}"
+     transition_to_finish if @count>=10 # :finish へ遷移
+   end
+   
+   def finish
+     p "finished"
+     destroy # タスクの破棄
+   end
+ end
+ 
+ 
+  # タスクを動かす
+  if __FILE__ == $0
+    task = CountupTask.new # タスクの作成
+    Rask.insert task       # タスクの登録
+  end
+ 
+ 
+* タスクを実行するデーモン(daemon.rb)
+ require 'rubygems'
+ require 'rask'
+ 
+ # バックグラウンドタスクの実行
+ Rask.daemon(:sleep=>0.1)
+
+
+デーモンを実行しておくと、Rask.insert を行うだけで
+タスクが自動的に実行されていきます。
+
+ $ ruby daemon.rb
+ $ ruby countup.rb
+
+== REQUIREMENTS:
+
+ ruby1.8.7で作ってる
+
+== INSTALL:
+
+ gem install rask
+
+== LICENSE:
+
+ (The MIT License)
+ 
+ Copyright (c) 2010 mewlist / Hidenori Doi
+ 
+ Permission is hereby granted, free of charge, to any person obtaining
+ a copy of this software and associated documentation files (the
+ 'Software'), to deal in the Software without restriction, including
+ without limitation the rights to use, copy, modify, merge, publish,
+ distribute, sublicense, and/or sell copies of the Software, and to
+ permit persons to whom the Software is furnished to do so, subject to
+ the following conditions:
+ 
+ The above copyright notice and this permission notice shall be
+ included in all copies or substantial portions of the Software.
+ 
+ THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND,
+ EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+ MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
+ IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
+ CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
+ TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
+ SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/lib/rask/state_machine.rb

@@ -0,0 +1,90 @@
+#
+# Rask
+# StateMachinelibrary
+# (c)2010 mewlist
+#
+require 'thread'
+
+
+
+module Rask
+  
+  module StateMachine
+    attr_accessor :state
+    
+    
+    def initialize
+      @state = initial_state
+    end
+    
+    
+    def initial_state
+      nil
+    end
+    
+    
+    def transition(to)
+      @state = to
+    end
+    
+    
+    def destroy
+      transition nil
+    end
+    
+    
+    def destroy?
+      @state == nil
+    end
+    
+    
+    
+    
+    
+    
+    
+    
+    def self.included(base)
+      base.extend(ClassMethods)
+    end
+    
+    
+    
+    
+    
+    
+    module ClassMethods
+      def define_state(name, *args)
+        
+        self.instance_eval{
+          define_method(name){
+          }
+          define_method("transition_to_#{name}"){
+            if args[0].is_a?(Hash)
+              self.state = name if args[0][:from] && args[0][:from].include?(state)
+            else
+              self.state = name
+            end
+          }
+          define_method("#{name}?"){
+            self.state == name
+          }
+          if !method_defined?(name) || ( args[0].is_a?(Hash) && args[0][:initial] )
+            define_method("initial_state") {
+              name
+            }
+          end
+        }
+      end
+    end
+  end
+  
+  
+  
+  
+end
+
+
+
+
+

data/lib/rask.rb

@@ -0,0 +1,158 @@
+#
+# Rask library
+# (c)2010 mewlist
+#
+require 'fileutils'
+require 'thread'
+
+require File.dirname(__FILE__) + '/rask/state_machine'
+
+
+module Rask
+  
+  class Task
+    include StateMachine
+    attr_accessor :task_id
+    attr_accessor :group
+    
+    def initialize(_group=nil)
+      group = _group
+      super()
+    end
+    
+    
+    def run
+      if @state
+        eval @state.to_s
+      end
+    end
+    
+    
+    def transition(to)
+      @state = to
+    end
+    
+    
+    def destroy
+      transition nil
+    end
+    
+    
+    def destroy?
+      @state == nil
+    end
+    
+  end
+  
+  
+  @@base_dir  = '/tmp/rask'
+  @@threading = false
+  
+  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
+  
+  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}"
+    task.task_id = task_id
+    FileUtils.touch(task_path(task_id)) unless File.exists? task_path(task_id)
+    f = File.open(task_path(task_id), 'w')
+    f.flock(File::LOCK_EX)
+    Marshal.dump(task, f)
+    f.flock(File::LOCK_UN)
+    f.close
+  end
+  
+  
+  def self.run(task_path)
+    f = File.open(task_path, 'r+')
+    f.flock(File::LOCK_EX)
+    
+    task = Marshal.restore(f)
+    yield task
+    
+    f.truncate(0)
+    f.pos = 0
+    Marshal.dump(task, f)
+    f.flock(File::LOCK_UN)
+    f.close
+    FileUtils.rm(task_path) 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
+  end
+  
+  def self.tasks(options = { :class=>nil, :group=>nil })
+    target = task_dir
+    target += '/' if options[:class] || options[:group]
+    target += "#{safe_class_name(options[:class])}" if options[:class]
+    target += "-#{options[:group]}-" if options[:group]
+    
+    task_list = []
+    Dir.glob(task_dir+"/*.task") { |d|
+      if target.empty? || /#{target}/ =~ d
+        task_list.push d
+      end
+    }
+    task_list
+  end
+  
+  def self.task_dir
+    @@base_dir
+  end
+  
+  def self.task_path(task_id)
+    task_dir+"/#{task_id}.task"
+  end
+  
+  def self.initialize_storage
+    unless File.exists? @@base_dir
+      FileUtils.makedirs @@base_dir
+    end
+  end
+  
+  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=>1 })
+    exit if fork
+    Process.setsid
+    open(task_dir+"/Rask.pid","w"){|f| f.write Process.pid}
+    while true
+      Rask.each { |task|
+        task.run
+      }
+      sleep(options[:sleep])
+    end
+  end
+  
+  
+end
+
+
+
+
+

data/test/test_helper.rb

@@ -0,0 +1,3 @@
+require 'stringio'
+require 'test/unit'
+require File.dirname(__FILE__) + '/../lib/rask'

data/test/test_rask.rb

@@ -0,0 +1,11 @@
+require File.dirname(__FILE__) + '/test_helper.rb'
+
+class TestRask < Test::Unit::TestCase
+
+  def setup
+  end
+  
+  def test_truth
+    assert true
+  end
+end

metadata

@@ -0,0 +1,63 @@
+--- !ruby/object:Gem::Specification 
+name: rask
+version: !ruby/object:Gem::Version 
+  version: 0.0.0
+platform: ruby
+authors: 
+- mewlist / Hidenori Doi
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-02-11 00:00:00 +09:00
+default_executable: 
+dependencies: []
+
+description: 
+email: mewlist@mewlist.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- README.rdoc
+files: 
+- test/test_helper.rb
+- test/test_rask.rb
+- lib/rask.rb
+- lib/rask/state_machine.rb
+- README.rdoc
+- History.txt
+has_rdoc: true
+homepage: http://mewlist.com/
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --main
+- README.rdoc
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.5
+signing_key: 
+specification_version: 3
+summary: !binary |
+  44K/44K544Kv44Op44Kk44OW44Op44Oq
+
+test_files: []
+