drbqs 0.0.6 → 0.0.7

data/README.rdoc

@@ -2,6 +2,10 @@
 
 Task queuing system over network that is implemented by dRuby.
 
+== Requirements
+
+DRbQS uses Fiber, so ruby requires version 1.9.
+
 == Usage
 
 === Preparation
@@ -30,21 +34,68 @@ We make server.rb as the following.
 
  require_relative 'sum.rb'
  
- DRbQS.define_server do |server, argv, opts|
+ DRbQS.define_server(:finish_exit => true) do |server, argv, opts|
    10.step(100, 10) do |i|
      task = DRbQS::Task.new(Sum.new(i - 10, i), :exec)
      server.queue.add(task)
    end
- 
-   server.set_finish_hook do |serv|
-     serv.exit
-   end
  end
 
 In terminal, we load server.rb and execute server of drbqs.
 
  drbqs-server server.rb -p 13500
 
+=== Hook of server
+
+We can use two hooks of server: 'empty_queue' and 'finish'.
+
+ DRbQS.define_server do |server, argv, opts|
+   server.add_hook(:empty_queue) do |srv|
+     srm.queue.add( ... )
+   end
+   
+   server.add_hook(:finish) do |srv|
+     srm.exit
+   end
+ end
+
+'finish' hook usually exit server program, but
+an option :finish_exit for DRbQS.define_server or DRbQS.new
+is nearly same.
+
+We can use 'empty_queue' hook for adding tasks
+when task queue is empty.
+
+=== Task generator
+
+Arguments of DRbQS::TaskGenerator.new define instance variables.
+
+ task_generator = DRbQS::TaskGenerator.new(:abc => 'ABC', :def => 123, :data => [1, 2, 3])
+
+The above example defines the following instance variables.
+
+ @abc = 'ABC'
+ @def = 123
+ @data = [1, 2, 3]
+
+Then, DRbQS::TaskGenerator#set method defines generation of tasks.
+The block of the method is evaluated in the context of task_generator.
+For the above example we can use @abc, @def, and @data.
+
+ task_generator.set do
+   @data.each do |i|
+     create_add_task(i, :to_s)
+   end
+ end
+
+DRbQS::TaskGenerator#create_add_task creates a task
+and the task is returned by DRbQS::TaskGenerator#new_tasks.
+The arguments of DRbQS::TaskGenerator#create_add_task is
+the same as DRbQS::Task.new.
+
+To use the generator in DRbQS::Server,
+we set the generator by DRbQS::Server#add_task_generator.
+
 === Start node and connect server
 
 Because nodes needs class Sum,

data/VERSION

@@ -1 +1 @@
-0.0.6
+0.0.7

data/drbqs.gemspec

@@ -5,7 +5,7 @@
 
 Gem::Specification.new do |s|
   s.name = %q{drbqs}
-  s.version = "0.0.6"
+  s.version = "0.0.7"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Takayuki YAMAGUCHI"]
@@ -33,6 +33,7 @@ Gem::Specification.new do |s|
     "example/drbqs-manage-test.rb",
     "example/drbqs-node-test.rb",
     "example/drbqs-server-test.rb",
+    "example/server/server_def.rb",
     "example/sum/server_def.rb",
     "example/sum/sum.rb",
     "lib/drbqs.rb",
@@ -45,6 +46,7 @@ Gem::Specification.new do |s|
     "lib/drbqs/queue.rb",
     "lib/drbqs/server.rb",
     "lib/drbqs/server_define.rb",
+    "lib/drbqs/server_hook.rb",
     "lib/drbqs/task.rb",
     "lib/drbqs/task_client.rb",
     "lib/drbqs/task_generator.rb",
@@ -56,6 +58,7 @@ Gem::Specification.new do |s|
     "spec/node_list_spec.rb",
     "spec/queue_spec.rb",
     "spec/server_define_spec.rb",
+    "spec/server_hook_spec.rb",
     "spec/server_spec.rb",
     "spec/spec_helper.rb",
     "spec/task_client_spec.rb",
@@ -68,7 +71,7 @@ Gem::Specification.new do |s|
   s.homepage = %q{http://github.com/ytaka/drbqs}
   s.licenses = ["GPL3"]
   s.require_paths = ["lib"]
-  s.rubygems_version = %q{1.3.7}
+  s.rubygems_version = %q{1.6.1}
   s.summary = %q{dRuby Queueing System}
   s.test_files = [
     "spec/acl_file_spec.rb",
@@ -78,6 +81,7 @@ Gem::Specification.new do |s|
     "spec/node_list_spec.rb",
     "spec/queue_spec.rb",
     "spec/server_define_spec.rb",
+    "spec/server_hook_spec.rb",
     "spec/server_spec.rb",
     "spec/spec_helper.rb",
     "spec/task_client_spec.rb",
@@ -89,7 +93,6 @@ Gem::Specification.new do |s|
   ]
 
   if s.respond_to? :specification_version then
-    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
     s.specification_version = 3
 
     if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then

data/example/server/server_def.rb

@@ -0,0 +1,12 @@
+task_generator = DRbQS::TaskGenerator.new(:iterate => 3)
+task_generator.set do
+  5.times do |i|
+    create_add_task(i, :to_s)
+  end
+end
+
+server = DRbQS::Server.new(:port => 13501, :finish_exit => true)
+server.add_task_generator(task_generator)
+server.set_signal_trap
+server.start
+server.wait

data/example/sum/server_def.rb

@@ -21,7 +21,7 @@ DRbQS.define_server do |server, argv, opts|
     server.queue.add(task)
   end
 
-  server.set_finish_hook do |serv|
+  server.add_hook(:finish) do |serv|
     serv.exit
   end
 end

data/lib/drbqs/server.rb

@@ -1,6 +1,7 @@
 require 'drbqs/message'
 require 'drbqs/queue'
 require 'drbqs/acl_file'
+require 'drbqs/server_hook'
 
 module DRbQS
   class CheckAlive
@@ -24,10 +25,19 @@ module DRbQS
     attr_reader :queue
 
     # :port
+    #   Set the port of server.
     # :acl
+    #   Set the ACL instance.
     # :log_file
+    #   Set the path of log files.
     # :log_level
+    #   Set the level of logging.
     # :check_alive
+    #   Set the time interval of checking alive nodes.
+    # :finish_exit
+    #   Exit programs in finish_hook.
+    # :signal_trap
+    #   Set trapping signal.
     def initialize(opts = {})
       @port = opts[:port] || ROOT_DEFAULT_PORT
       @acl = acl_init(opts[:acl])
@@ -46,7 +56,8 @@ module DRbQS
       @queue= QueueServer.new(@ts[:queue], @ts[:result], @logger)
       @check_alive = CheckAlive.new(opts[:check_alive])
       @task_generator = []
-      @empty_queue_hook = nil
+      hook_init(opts[:finish_exit])
+      set_signal_trap if opts[:signal_trap]
     end
 
     def acl_init(acl_arg)
@@ -61,6 +72,12 @@ module DRbQS
     end
     private :acl_init
 
+    def hook_init(finish_exit)
+      @hook = DRbQS::ServerHook.new
+      @hook.set_finish_exit { self.exit } if finish_exit
+    end
+    private :hook_init
+
     def start
       DRb.install_acl(@acl) if @acl
       uri = "druby://:#{@port}"
@@ -77,7 +94,7 @@ module DRbQS
     end
     private :check_connection
 
-    def set_task_generator(task_generator)
+    def add_task_generator(task_generator)
       @task_generator << task_generator
     end
 
@@ -101,33 +118,25 @@ module DRbQS
       @message.set_initialization(task)
     end
 
+    # +key+ is :empty_queue or :finish_exit.
     # &block takes self as an argument.
-    def set_empty_queue_hook(&block)
-      if block_given?
-        @empty_queue_hook = block
-      else
-        @empty_queue_hook = nil
-      end
+    def add_hook(key, name = nil, &block)
+      @hook.add(key, name, &block)
     end
 
-    # &block takes self as an argument.
-    def set_finish_hook(&block)
-      if block_given?
-        @finish_hook = block
-      else
-        @finish_hook = nil
-      end
+    def delete_hook(key, name = nil)
+      @hook.delete(key, name)
     end
 
     def exec_hook
-      if @empty_queue_hook && @queue.empty?
+      if @queue.empty?
         @logger.info("Execute empty queue hook.") if @logger
-        @empty_queue_hook.call(self)
+        @hook.exec(:empty_queue, self)
       end
       add_tasks_from_generator
-      if @finish_hook && @queue.finished?
+      if @queue.finished?
         @logger.info("Execute finish hook.") if @logger
-        @finish_hook.call(self)
+        @hook.exec(:finish, self)
       end
     end
     private :exec_hook

data/lib/drbqs/server_hook.rb

@@ -0,0 +1,67 @@
+module DRbQS
+  class ServerHook
+    def initialize
+      @hook = Hash.new { |h, k| h[k] = Array.new }
+      @argument_number = {}
+      @finish_exit = nil
+      set_argument_number(:empty_queue, 1)
+      set_argument_number(:finish, 1)
+    end
+
+    def set_argument_number(key, num)
+      @argument_number[key] = num
+    end
+    private :set_argument_number
+
+    def create_proc_name(key)
+      name = "#{key.to_s}#{rand(1000)}"
+      if @hook.has_key?(name)
+        create_proc_name(key)
+      else
+        name
+      end
+    end
+    private :create_proc_name
+
+    def add(key, name = nil, &block)
+      if (n = @argument_number[key]) && (block.arity != n)
+        raise ArgumentError, "Invalid argument number of hook of #{key.inspect}."
+      end
+      name ||= create_proc_name(key)
+      @hook[key] << [name, block]
+      name
+    end
+
+    def delete(key, name = nil)
+      if name
+        @hook[key].delete_if { |ary| ary[0] == name }
+      else
+        @hook[key].clear
+      end
+    end
+
+    def specific_proc(key)
+      case key
+      when :finish
+        @finish_exit.call if @finish_exit
+      end
+    end
+    private :specific_proc
+
+    def hook_names(key)
+      @hook[key].map { |a| a[0] }
+    end
+
+    def exec(key, *args)
+      @hook[key].each do |ary|
+        ary[1].call(*args)
+      end
+      specific_proc(key)
+    end
+
+    def set_finish_exit(&block)
+      @finish_exit = block
+    end
+  end
+
+end

data/lib/drbqs/task_generator.rb

@@ -13,6 +13,17 @@ module DRbQS
       !!@__fiber__
     end
 
+    def add_task(arg)
+      case arg
+      when DRbQS::Task
+        Fiber.yield(arg)
+      when Array
+        arg.each { |t| Fiber.yield(t) }
+      else
+        raise "Invalid type of an argument."
+      end
+    end
+
     def create_add_task(*args, &block)
       Fiber.yield(DRbQS::Task.new(*args, &block))
     end
@@ -28,7 +39,7 @@ module DRbQS
     end
 
     def init
-      @__fiber_init__.call
+      @__fiber_init__.call if @__fiber_init__
     end
 
     # Return an array of new tasks.
@@ -57,18 +68,20 @@ module DRbQS
       nil
     end
 
-    # Create all tasks for test and return true if all tasks created properly.
+    # Create all tasks for test and return [group_number, task_number] if all tasks created properly.
     def debug_all_tasks(limit = nil)
-      i = 0
+      group_number = 0
+      task_number = 0
       while ary = new_tasks
-        ary.each? do |t|
-          unless DRbQS::TaskGenerator === t
-            raise "Invalid task by #{i}th generation: #{t.inspect}"
+        ary.each do |t|
+          unless DRbQS::Task === t
+            raise "Invalid #{i}th task: #{t.inspect}"
           end
+          task_number += 1
         end
-        i += 1
+        group_number += 1
       end
-      true
+      [group_number, task_number]
     end
   end
 end

data/spec/manage_spec.rb

@@ -15,7 +15,7 @@ describe DRbQS do
         server.queue.add(task)
       end
 
-      server.set_finish_hook do |serv|
+      server.add_hook(:finish) do |serv|
         serv.exit
       end
 

data/spec/server_define_spec.rb

@@ -9,7 +9,7 @@ describe DRbQS::ServerDefinition do
     it "should define server" do
       @server_definition.should_receive(:define_server)
       DRbQS.define_server do |server, argv, opts|
-        server.set_finish_hook do |serv|
+        server.add_hook(:finish) do |serv|
           serv.exit
         end
       end

data/spec/server_hook_spec.rb

@@ -0,0 +1,72 @@
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+
+require 'drbqs/server_hook'
+
+describe DRbQS::ServerHook do
+  subject { DRbQS::ServerHook.new }
+
+  it "should add hook" do
+    subject.add(:finish) do |server|
+      3 + 4
+    end.should match(/^finish\d+/)
+  end
+
+  it "should add hook with name" do
+    name = 'hello'
+    subject.add(:finish, name) do |server|
+      3 + 4
+    end.should == name
+  end
+
+  it "should raise error" do
+    lambda do
+      subject.add(:finish) do |a, b|
+        a + b
+      end    
+    end.should raise_error
+  end
+
+  it "should delete hook" do
+    name = subject.add(:finish) do |server|
+      3 + 4
+    end
+    subject.hook_names(:finish).should have(1).items
+    subject.hook_names(:finish).should include(name)
+    subject.delete(:finish, name)
+    subject.hook_names(:finish).should be_empty
+  end
+
+  it "should delete all hooks" do
+    name = subject.add(:finish) do |server|
+      3 + 4
+    end
+    name = subject.add(:finish) do |server|
+      5 + 6
+    end
+    subject.hook_names(:finish).should have(2).items
+    subject.delete(:finish)
+    subject.hook_names(:finish).should be_empty
+  end
+
+  it "should execute hooks" do
+    exec_flag = {}
+    subject.add(:finish) do |server|
+      exec_flag[:first] = true
+    end
+    subject.add(:finish) do |server|
+      exec_flag[:second] = true
+    end
+    subject.exec(:finish)
+    exec_flag[:first].should be_true
+    exec_flag[:second].should be_true
+  end
+
+  it "should execute finish_exit" do
+    execute = nil
+    subject.set_finish_exit do
+      execute = true
+    end
+    subject.exec(:finish)
+    execute.should be_true
+  end
+end

data/spec/task_generator_spec.rb

@@ -21,12 +21,21 @@ describe DRbQS::TaskGenerator do
         create_add_task(i, :to_s)
       end
     end
+    subject.init
     check_task_ary(subject.new_tasks, 2)
     check_task_ary(subject.new_tasks, 1)
     subject.new_tasks.should be_nil
   end
 
   it "should debug generator" do
-    subject.debug_all_tasks.should be_true
+    subject.set(2) do
+      @data.each do |i|
+        create_add_task(i, :to_s)
+      end
+    end
+    subject.init
+    group_number, task_number = subject.debug_all_tasks
+    group_number.should == 2
+    task_number.should == 3
   end
 end

data/spec/test1_spec.rb

@@ -16,7 +16,7 @@ describe DRbQS do
         server.queue.add(task)
       end
 
-      server.set_finish_hook do |serv|
+      server.add_hook(:finish) do |serv|
         serv.exit
       end
 

data/spec/test2_spec.rb

@@ -13,14 +13,8 @@ describe DRbQS do
       end
     end
     @process_id = fork do
-      server = DRbQS::Server.new(:port => 13501)
-
-      server.set_task_generator(@task_generator)
-
-      server.set_finish_hook do |serv|
-        serv.exit
-      end
-
+      server = DRbQS::Server.new(:port => 13501, :finish_exit => true)
+      server.add_task_generator(@task_generator)
       server.set_signal_trap
       server.start
       server.wait

metadata

@@ -1,94 +1,72 @@
 --- !ruby/object:Gem::Specification
 name: drbqs
 version: !ruby/object:Gem::Version
-  version: 0.0.6
-  segments:
-  - 0
-  - 0
-  - 6
-  prerelease: false
+  version: 0.0.7
+  prerelease: 
 platform: ruby
 authors:
 - Takayuki YAMAGUCHI
-autorequire: !!null 
+autorequire: 
 bindir: bin
 cert_chain: []
 date: 2011-03-08 00:00:00.000000000 +09:00
-default_executable: !!null 
+default_executable: 
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &80686930 !ruby/object:Gem::Requirement
+  requirement: &84782980 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: 2.5.0
-        segments:
-        - 2
-        - 5
-        - 0
   type: :development
   prerelease: false
-  version_requirements: *80686930
+  version_requirements: *84782980
 - !ruby/object:Gem::Dependency
   name: yard
-  requirement: &80685380 !ruby/object:Gem::Requirement
+  requirement: &84782720 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
         version: 0.6.0
-        segments:
-        - 0
-        - 6
-        - 0
   type: :development
   prerelease: false
-  version_requirements: *80685380
+  version_requirements: *84782720
 - !ruby/object:Gem::Dependency
   name: bundler
-  requirement: &80628260 !ruby/object:Gem::Requirement
+  requirement: &84782460 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
         version: 1.0.0
-        segments:
-        - 1
-        - 0
-        - 0
   type: :development
   prerelease: false
-  version_requirements: *80628260
+  version_requirements: *84782460
 - !ruby/object:Gem::Dependency
   name: jeweler
-  requirement: &80626510 !ruby/object:Gem::Requirement
+  requirement: &84782210 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
         version: 1.5.2
-        segments:
-        - 1
-        - 5
-        - 2
   type: :development
   prerelease: false
-  version_requirements: *80626510
+  version_requirements: *84782210
 - !ruby/object:Gem::Dependency
   name: rcov
-  requirement: &80624530 !ruby/object:Gem::Requirement
+  requirement: &84781940 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
-        segments:
-        - 0
   type: :development
   prerelease: false
-  version_requirements: *80624530
+  version_requirements: *84781940
 description: Task queuing system over network that is implemented by dRuby.
 email: d@ytak.info
 executables:
@@ -115,6 +93,7 @@ files:
 - example/drbqs-manage-test.rb
 - example/drbqs-node-test.rb
 - example/drbqs-server-test.rb
+- example/server/server_def.rb
 - example/sum/server_def.rb
 - example/sum/sum.rb
 - lib/drbqs.rb
@@ -127,6 +106,7 @@ files:
 - lib/drbqs/queue.rb
 - lib/drbqs/server.rb
 - lib/drbqs/server_define.rb
+- lib/drbqs/server_hook.rb
 - lib/drbqs/task.rb
 - lib/drbqs/task_client.rb
 - lib/drbqs/task_generator.rb
@@ -138,6 +118,7 @@ files:
 - spec/node_list_spec.rb
 - spec/queue_spec.rb
 - spec/server_define_spec.rb
+- spec/server_hook_spec.rb
 - spec/server_spec.rb
 - spec/spec_helper.rb
 - spec/task_client_spec.rb
@@ -150,7 +131,7 @@ has_rdoc: true
 homepage: http://github.com/ytaka/drbqs
 licenses:
 - GPL3
-post_install_message: !!null 
+post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
@@ -162,19 +143,17 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 394819887
+      hash: -184598193
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
-      segments:
-      - 0
 requirements: []
-rubyforge_project: !!null 
-rubygems_version: 1.3.7
-signing_key: !!null 
+rubyforge_project: 
+rubygems_version: 1.6.1
+signing_key: 
 specification_version: 3
 summary: dRuby Queueing System
 test_files:
@@ -185,6 +164,7 @@ test_files:
 - spec/node_list_spec.rb
 - spec/queue_spec.rb
 - spec/server_define_spec.rb
+- spec/server_hook_spec.rb
 - spec/server_spec.rb
 - spec/spec_helper.rb
 - spec/task_client_spec.rb