drbqs 0.0.16 → 0.0.17

data/.gitignore

@@ -0,0 +1,45 @@
+# rcov generated
+coverage
+
+# rdoc generated
+rdoc
+
+# yard generated
+doc
+.yardoc
+
+# bundler
+.bundle
+
+# jeweler generated
+pkg
+
+# Have editor/IDE/OS specific files you need to ignore? Consider using a global gitignore: 
+#
+# * Create a file at ~/.gitignore
+# * Include files you want ignored
+# * Run: git config --global core.excludesfile ~/.gitignore
+#
+# After doing this, these files will be ignored in all your git projects,
+# saving you from having to 'pollute' every project you touch with them
+#
+# Not sure what to needs to be ignored for particular editors/OSes? Here's some ideas to get you started. (Remember, remove the leading # of the line)
+#
+# For MacOS:
+#
+#.DS_Store
+#
+# For TextMate
+#*.tmproj
+#tmtags
+#
+# For emacs:
+*~
+\#*
+.\#*
+
+# For vim:
+#*.swp
+
+Gemfile.lock
+spec/home_for_spec

data/Gemfile

@@ -1,20 +1,4 @@
 source "http://rubygems.org"
-# Add dependencies required to use your gem here.
-# Example:
-#   gem "activesupport", ">= 2.3.5"
 
-# Add dependencies to develop your gem here.
-# Include everything needed to run rake, tests, features, etc.
-group :development do
-  gem "rspec", ">= 2.6.0"
-  gem "yard", ">= 0.7.2"
-  gem "bundler", ">= 1.0.15"
-  gem "jeweler", ">= 1.6.2"
-  gem "rcov", ">= 0"
-  gem "filename", ">= 0.1.0"
-  gem "user_config", ">= 0.0.1"
-  gem "net-ssh", ">= 2.1.4"
-  gem "net-ssh-shell", ">= 0.2.0"
-  gem "net-sftp", ">= 2.0.5"
-  gem "sys-proctable"
-end
+# Specify your gem's dependencies in drbqs.gemspec
+gemspec

data/Rakefile

@@ -1,34 +1,4 @@
-require 'rubygems'
-require 'bundler'
-begin
-  Bundler.setup(:default, :development)
-rescue Bundler::BundlerError => e
-  $stderr.puts e.message
-  $stderr.puts "Run `bundle install` to install missing gems"
-  exit e.status_code
-end
-require 'rake'
-
-require 'jeweler'
-Jeweler::Tasks.new do |gem|
-  # gem is a Gem::Specification... see http://docs.rubygems.org/read/chapter/20 for more options
-  gem.name = "drbqs"
-  gem.homepage = "http://github.com/ytaka/drbqs"
-  gem.license = "GPL3"
-  gem.summary = "dRuby Queueing System"
-  gem.description = "Task queuing system over network that is implemented by dRuby."
-  gem.email = "d@ytak.info"
-  gem.authors = ["Takayuki YAMAGUCHI"]
-  # Include your dependencies below. Runtime dependencies are required when using your gem,
-  # and development dependencies are only needed for development (ie running rake tasks, tests, etc)
-  gem.add_runtime_dependency 'filename', '>= 0.1.0'
-  gem.add_runtime_dependency "user_config", ">= 0.0.2"
-  gem.add_runtime_dependency 'net-ssh', '>= 2.1.3'
-  gem.add_runtime_dependency 'net-ssh-shell', '>= 0.1.0'
-  gem.add_runtime_dependency "net-sftp", ">= 2.0.5"
-  gem.add_runtime_dependency "sys-proctable"
-end
-Jeweler::RubygemsDotOrgTasks.new
+require "bundler/gem_tasks"
 
 desc "Run all specs"
 task 'spec:all' => ['spec:unit', 'spec:integration']
@@ -57,17 +27,6 @@ task :default => 'spec:all'
 require 'yard'
 YARD::Rake::YardocTask.new
 
-desc "Update version of drbqs.rb"
-task "version:constant" do
-  dir = File.dirname(__FILE__)
-  path = File.join(dir, 'lib/drbqs.rb')
-  data = File.read(path)
-  version = File.read(File.join(dir, 'VERSION'))
-  open(path, 'w') do |f|
-    f.print data.sub(/^  VERSION = '.*'$/, "  VERSION = '#{version}'")
-  end
-end
-
 desc "Remove temporary home directory for specs."
 task "clean:temporary" do
   dir = File.join(File.dirname(__FILE__), 'spec', 'home_for_spec')

data/drbqs.gemspec

@@ -1,245 +1,30 @@
-# Generated by jeweler
-# DO NOT EDIT THIS FILE DIRECTLY
-# Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
 # -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "drbqs/version"
 
 Gem::Specification.new do |s|
-  s.name = %q{drbqs}
-  s.version = "0.0.16"
+  s.name        = "drbqs"
+  s.version     = DRbQS::VERSION
+  s.authors     = ["Takayuki YAMAGUCHI"]
+  s.email       = ["d@ytak.info"]
+  s.homepage    = ""
+  s.summary     = "dRuby Queueing System"
+  s.description = "Task queuing system over network that is implemented by dRuby."
 
-  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
-  s.authors = [%q{Takayuki YAMAGUCHI}]
-  s.date = %q{2011-08-03}
-  s.description = %q{Task queuing system over network that is implemented by dRuby.}
-  s.email = %q{d@ytak.info}
-  s.executables = [%q{drbqs-execute}, %q{drbqs-manage}, %q{drbqs-node}, %q{drbqs-server}, %q{drbqs-ssh}]
-  s.extra_rdoc_files = [
-    "LICENSE.txt",
-    "README.md"
-  ]
-  s.files = [
-    ".document",
-    ".rspec",
-    "Gemfile",
-    "LICENSE.txt",
-    "README.md",
-    "Rakefile",
-    "VERSION",
-    "bin/drbqs-execute",
-    "bin/drbqs-manage",
-    "bin/drbqs-node",
-    "bin/drbqs-server",
-    "bin/drbqs-ssh",
-    "docs/FormatExecute.md",
-    "docs/GettingStarted.md",
-    "drbqs.gemspec",
-    "example/README.md",
-    "example/command/server_def.rb",
-    "example/error_server/error.rb",
-    "example/error_server/server_def.rb",
-    "example/error_task/error.rb",
-    "example/error_task/server_def.rb",
-    "example/execute/execute.rb",
-    "example/execute/server.rb",
-    "example/execute/task.rb",
-    "example/mandelbrot/README.md",
-    "example/mandelbrot/execute.rb",
-    "example/mandelbrot/mandelbrot.rb",
-    "example/mandelbrot/server.rb",
-    "example/server/server.rb",
-    "example/simple/README.md",
-    "example/simple/execute.rb",
-    "example/simple/server.rb",
-    "example/simple/task.rb",
-    "example/sum/server_def.rb",
-    "example/sum/sum.rb",
-    "example/sum2/execute_def.rb",
-    "example/sum2/server_def.rb",
-    "example/sum2/sum.rb",
-    "example/transfer/file.rb",
-    "example/transfer/server_def.rb",
-    "lib/drbqs.rb",
-    "lib/drbqs/command_line/argument.rb",
-    "lib/drbqs/command_line/command_base.rb",
-    "lib/drbqs/command_line/command_execute.rb",
-    "lib/drbqs/command_line/command_line.rb",
-    "lib/drbqs/command_line/command_manage.rb",
-    "lib/drbqs/command_line/command_node.rb",
-    "lib/drbqs/command_line/command_server.rb",
-    "lib/drbqs/command_line/command_ssh.rb",
-    "lib/drbqs/command_line/option_setting.rb",
-    "lib/drbqs/config/config.rb",
-    "lib/drbqs/config/process_list.rb",
-    "lib/drbqs/config/ssh_host.rb",
-    "lib/drbqs/execute/execute_node.rb",
-    "lib/drbqs/execute/process_define.rb",
-    "lib/drbqs/execute/register.rb",
-    "lib/drbqs/execute/server_define.rb",
-    "lib/drbqs/ext/task.rb",
-    "lib/drbqs/ext/task/command_task.rb",
-    "lib/drbqs/manage/manage.rb",
-    "lib/drbqs/manage/send_signal.rb",
-    "lib/drbqs/manage/ssh_execute.rb",
-    "lib/drbqs/manage/ssh_shell.rb",
-    "lib/drbqs/node/connection.rb",
-    "lib/drbqs/node/node.rb",
-    "lib/drbqs/node/state.rb",
-    "lib/drbqs/node/task_client.rb",
-    "lib/drbqs/server/acl_file.rb",
-    "lib/drbqs/server/check_alive.rb",
-    "lib/drbqs/server/history.rb",
-    "lib/drbqs/server/message.rb",
-    "lib/drbqs/server/node_list.rb",
-    "lib/drbqs/server/queue.rb",
-    "lib/drbqs/server/server.rb",
-    "lib/drbqs/server/server_hook.rb",
-    "lib/drbqs/server/test/node.rb",
-    "lib/drbqs/server/test/prof.rb",
-    "lib/drbqs/server/test/server.rb",
-    "lib/drbqs/server/transfer_setting.rb",
-    "lib/drbqs/setting/base.rb",
-    "lib/drbqs/setting/data_container.rb",
-    "lib/drbqs/setting/execute.rb",
-    "lib/drbqs/setting/manage.rb",
-    "lib/drbqs/setting/node.rb",
-    "lib/drbqs/setting/server.rb",
-    "lib/drbqs/setting/setting.rb",
-    "lib/drbqs/setting/source.rb",
-    "lib/drbqs/setting/ssh.rb",
-    "lib/drbqs/task/registrar.rb",
-    "lib/drbqs/task/task.rb",
-    "lib/drbqs/task/task_generator.rb",
-    "lib/drbqs/utility/misc.rb",
-    "lib/drbqs/utility/temporary.rb",
-    "lib/drbqs/utility/transfer/transfer.rb",
-    "lib/drbqs/utility/transfer/transfer_client.rb",
-    "lib/drbqs/utility/transfer/transfer_client_connect.rb",
-    "lib/drbqs/utility/transfer/transfer_file_list.rb",
-    "spec/command_line/command_base_spec.rb",
-    "spec/command_line/commands_spec.rb",
-    "spec/command_line/option_setting_spec.rb",
-    "spec/config/config_spec.rb",
-    "spec/config/process_list_spec.rb",
-    "spec/config/ssh_host_spec.rb",
-    "spec/execute/def/execute1.rb",
-    "spec/execute/def/execute2.rb",
-    "spec/execute/def/no_def.rb",
-    "spec/execute/process_define_spec.rb",
-    "spec/execute/register_spec.rb",
-    "spec/execute/server_define_spec.rb",
-    "spec/ext/task/command_task_spec.rb",
-    "spec/integration_test/01_basic_usage_spec.rb",
-    "spec/integration_test/02_use_generator_spec.rb",
-    "spec/integration_test/03_use_temporary_file_spec.rb",
-    "spec/integration_test/04_use_unix_domain_spec.rb",
-    "spec/integration_test/05_server_exit_signal_spec.rb",
-    "spec/integration_test/06_node_exit_after_task_spec.rb",
-    "spec/integration_test/07_command_server_with_node_spec.rb",
-    "spec/integration_test/08_shutdown_unused_nodes_spec.rb",
-    "spec/integration_test/09_server_process_data_spec.rb",
-    "spec/integration_test/10_test_server_spec.rb",
-    "spec/integration_test/definition/server01.rb",
-    "spec/integration_test/definition/server02.rb",
-    "spec/integration_test/definition/task_obj_definition.rb",
-    "spec/manage/manage_spec.rb",
-    "spec/manage/send_signal_spec.rb",
-    "spec/manage/ssh_shell_spec.rb",
-    "spec/node/connection_spec.rb",
-    "spec/node/node_spec.rb",
-    "spec/node/state_spec.rb",
-    "spec/node/task_client_spec.rb",
-    "spec/server/acl_file_spec.rb",
-    "spec/server/check_alive_spec.rb",
-    "spec/server/data/acl.txt",
-    "spec/server/history_spec.rb",
-    "spec/server/message_spec.rb",
-    "spec/server/node_list_spec.rb",
-    "spec/server/queue_spec.rb",
-    "spec/server/server_hook_spec.rb",
-    "spec/server/server_spec.rb",
-    "spec/server/transfer_setting_spec.rb",
-    "spec/setting/base_spec.rb",
-    "spec/setting/data_container_spec.rb",
-    "spec/setting/execute_spec.rb",
-    "spec/setting/manage_spec.rb",
-    "spec/setting/node_spec.rb",
-    "spec/setting/server_spec.rb",
-    "spec/setting/source_spec.rb",
-    "spec/spec_helper.rb",
-    "spec/task/registrar_spec.rb",
-    "spec/task/task_generator_spec.rb",
-    "spec/task/task_spec.rb",
-    "spec/utility/argument_spec.rb",
-    "spec/utility/misc_spec.rb",
-    "spec/utility/temporary_spec.rb",
-    "spec/utility/transfer/transfer_client_connect_spec.rb",
-    "spec/utility/transfer/transfer_file_list_spec.rb",
-    "spec/utility/transfer/transfer_spec.rb"
-  ]
-  s.homepage = %q{http://github.com/ytaka/drbqs}
-  s.licenses = [%q{GPL3}]
-  s.require_paths = [%q{lib}]
-  s.rubygems_version = %q{1.8.5}
-  s.summary = %q{dRuby Queueing System}
+  s.rubyforge_project = "drbqs"
 
-  if s.respond_to? :specification_version then
-    s.specification_version = 3
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
 
-    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
-      s.add_development_dependency(%q<rspec>, [">= 2.6.0"])
-      s.add_development_dependency(%q<yard>, [">= 0.7.2"])
-      s.add_development_dependency(%q<bundler>, [">= 1.0.15"])
-      s.add_development_dependency(%q<jeweler>, [">= 1.6.2"])
-      s.add_development_dependency(%q<rcov>, [">= 0"])
-      s.add_development_dependency(%q<filename>, [">= 0.1.0"])
-      s.add_development_dependency(%q<user_config>, [">= 0.0.1"])
-      s.add_development_dependency(%q<net-ssh>, [">= 2.1.4"])
-      s.add_development_dependency(%q<net-ssh-shell>, [">= 0.2.0"])
-      s.add_development_dependency(%q<net-sftp>, [">= 2.0.5"])
-      s.add_development_dependency(%q<sys-proctable>, [">= 0"])
-      s.add_runtime_dependency(%q<filename>, [">= 0.1.0"])
-      s.add_runtime_dependency(%q<user_config>, [">= 0.0.2"])
-      s.add_runtime_dependency(%q<net-ssh>, [">= 2.1.3"])
-      s.add_runtime_dependency(%q<net-ssh-shell>, [">= 0.1.0"])
-      s.add_runtime_dependency(%q<net-sftp>, [">= 2.0.5"])
-      s.add_runtime_dependency(%q<sys-proctable>, [">= 0"])
-    else
-      s.add_dependency(%q<rspec>, [">= 2.6.0"])
-      s.add_dependency(%q<yard>, [">= 0.7.2"])
-      s.add_dependency(%q<bundler>, [">= 1.0.15"])
-      s.add_dependency(%q<jeweler>, [">= 1.6.2"])
-      s.add_dependency(%q<rcov>, [">= 0"])
-      s.add_dependency(%q<filename>, [">= 0.1.0"])
-      s.add_dependency(%q<user_config>, [">= 0.0.1"])
-      s.add_dependency(%q<net-ssh>, [">= 2.1.4"])
-      s.add_dependency(%q<net-ssh-shell>, [">= 0.2.0"])
-      s.add_dependency(%q<net-sftp>, [">= 2.0.5"])
-      s.add_dependency(%q<sys-proctable>, [">= 0"])
-      s.add_dependency(%q<filename>, [">= 0.1.0"])
-      s.add_dependency(%q<user_config>, [">= 0.0.2"])
-      s.add_dependency(%q<net-ssh>, [">= 2.1.3"])
-      s.add_dependency(%q<net-ssh-shell>, [">= 0.1.0"])
-      s.add_dependency(%q<net-sftp>, [">= 2.0.5"])
-      s.add_dependency(%q<sys-proctable>, [">= 0"])
-    end
-  else
-    s.add_dependency(%q<rspec>, [">= 2.6.0"])
-    s.add_dependency(%q<yard>, [">= 0.7.2"])
-    s.add_dependency(%q<bundler>, [">= 1.0.15"])
-    s.add_dependency(%q<jeweler>, [">= 1.6.2"])
-    s.add_dependency(%q<rcov>, [">= 0"])
-    s.add_dependency(%q<filename>, [">= 0.1.0"])
-    s.add_dependency(%q<user_config>, [">= 0.0.1"])
-    s.add_dependency(%q<net-ssh>, [">= 2.1.4"])
-    s.add_dependency(%q<net-ssh-shell>, [">= 0.2.0"])
-    s.add_dependency(%q<net-sftp>, [">= 2.0.5"])
-    s.add_dependency(%q<sys-proctable>, [">= 0"])
-    s.add_dependency(%q<filename>, [">= 0.1.0"])
-    s.add_dependency(%q<user_config>, [">= 0.0.2"])
-    s.add_dependency(%q<net-ssh>, [">= 2.1.3"])
-    s.add_dependency(%q<net-ssh-shell>, [">= 0.1.0"])
-    s.add_dependency(%q<net-sftp>, [">= 2.0.5"])
-    s.add_dependency(%q<sys-proctable>, [">= 0"])
-  end
+  # specify any dependencies here; for example:
+  s.add_development_dependency "rspec", ">= 2.6.0"
+  s.add_development_dependency "yard", ">= 0.7.2"
+  s.add_runtime_dependency 'filename', '>= 0.1.0'
+  s.add_runtime_dependency "user_config", ">= 0.0.2"
+  s.add_runtime_dependency 'net-ssh', '>= 2.1.0'
+  s.add_runtime_dependency 'net-ssh-shell', '>= 0.2.0'
+  s.add_runtime_dependency "net-sftp", ">= 2.0.5"
+  s.add_runtime_dependency "sys-proctable"
 end
-

data/lib/drbqs.rb

@@ -9,6 +9,7 @@ require 'fileutils'
 
 require 'filename'
 
+require 'drbqs/version'
 require 'drbqs/execute/server_define'
 require 'drbqs/utility/misc'
 
@@ -19,6 +20,4 @@ module DRbQS
   autoload :Setting, 'drbqs/setting/setting'
 
   ROOT_DEFAULT_PORT = 13500
-
-  VERSION = '0.0.16'
 end

data/lib/drbqs/config/process_list.rb

@@ -17,6 +17,8 @@ module DRbQS
 
       # If +file+ exists then this method returns false.
       # Otherwise, return true.
+      # @param [String] file Set path under the data directory.
+      # @param [Object] data Set the save data that is converted to YAML.
       def save_file(file, data)
         path = path_under_directory(file)
         if File.exist?(path)

data/lib/drbqs/config/ssh_host.rb

@@ -28,7 +28,7 @@ module DRbQS
         name.size > 0 && find_file(name)
       end
 
-      # +name+ is file name without extension.
+      # @param [String] name File name without extension.
       def get_options(name)
         if path = get_path(name)
           return [path, YAML.load_file(path)]

data/lib/drbqs/execute/register.rb

@@ -91,7 +91,7 @@ module DRbQS
       # 
       # @param [Symbol,String] name Server name
       # @param [Hash] opts The options of server
-      # @option opts [true,false] :template Template for other servers to load, not actual server
+      # @option opts [Boolean] :template Template for other servers to load, not actual server
       # @option opts [Symbol] :load Inherit definition of other server
       # 
       # @example A server on localhost
@@ -173,9 +173,9 @@ module DRbQS
       # 
       # @param [Symbol,String] name Node name
       # @param [Hash] opts The options of node
-      # @option opts [true,false] :template Template for other nodes to load, not actual node
+      # @option opts [Boolean] :template Template for other nodes to load, not actual node
       # @option opts [Symbol] :load Inherit definition of other node
-      # @option opts [true,false] :group Define the group of node
+      # @option opts [Boolean] :group Define the group of node
       # 
       # @example Nodes on localhost
       #  node :node_local do |nd|

data/lib/drbqs/manage/ssh_shell.rb

@@ -4,17 +4,19 @@ require 'net/ssh/shell'
 module DRbQS
   class Manage
     # Requirements:
-    #   bash
+    # 
+    # * bash
     class SSHShell
       class RubyEnvironment
         DEFAULT_RVM_SCRIPT = '$HOME/.rvm/scripts/rvm'
 
         attr_reader :directory, :rvm, :rvm_init, :env
 
-        # :directory
-        # :rvm
-        # :rvm_init
-        # :env
+        # @param [Hash] opts The options of ruby environment.
+        # @option opts [String] :directory Directory when we execute commands.
+        # @option opts [String] :rvm       Set ruby implementation on rvm.
+        # @option opts [String] :rvm_init  Set the path of init script of rvm.
+        # @option opts [Hash]   :env       Set pair of environmental variables and their values.
         def initialize(opts = {})
           @directory = opts[:directory]
           @rvm = opts[:rvm]
@@ -54,20 +56,24 @@ module DRbQS
 
       attr_reader :user, :host, :port, :keys
 
-      # :shell     shell to use
-      # :env       a hash of environmental variables and their values
-      # :dir       base directory of ssh server
-      # :rvm       version of ruby on rvm
-      # :rvm_init  path of script to initialize rvm
-      # :keys      path of a ssh key
-      # :io        IO to output results of commands
+      DEFAULT_SHELL = 'bash'
+
+      # @param [String] dest Destination of SSH.
+      # @param [Hash] opts The options of SSH shell.
+      # @option opts [String] :shell     The shell to use.
+      # @option opts [String] :keys      Path of a ssh key.
+      # @option opts [IO]     :io        IO to output results of commands.
+      # @option opts [Hash]   :env       Same as options DRbQS::Manage::SSHShell::RubyEnvironment.
+      # @option opts [String] :directory Same as options DRbQS::Manage::SSHShell::RubyEnvironment.
+      # @option opts [String] :rvm       Same as options DRbQS::Manage::SSHShell::RubyEnvironment.
+      # @option opts [String] :rvm_init  Same as options DRbQS::Manage::SSHShell::RubyEnvironment.
       def initialize(dest, opts = {})
         @user, @host, @port = split_destination(dest)
         if !(@host && @user)
           raise ArgumentError, "Invalid ssh server: host=#{@host.inspect}, user=#{@user.inspect}."
         end
         @keys = opts.delete(:keys)
-        @shell = opts[:shell] || 'bash'
+        @shell = opts.delete(:shell) || DEFAULT_SHELL
         @ruby_environment = DRbQS::Manage::SSHShell::RubyEnvironment.new(opts)
         @out = opts[:io]
         @ssh = nil
@@ -163,7 +169,9 @@ module DRbQS
         @ssh = nil
       end
 
-      # :check
+      # @param [Array] commands An array of list of commands.
+      # @param [Hash]  opts     Options
+      # @option opts [Boolean] :check Check exit codes of commands.
       def execute_all(commands, opts = {})
         results = []
         start do |ssh_shell|

data/lib/drbqs/node/state.rb

@@ -1,7 +1,7 @@
 module DRbQS
   class Node
-    # Value of state is :sleep, :wait, or :calculate.
     class State
+      # Value of state is :sleep, :wait, or :calculate.
       attr_reader :state
 
       ALL_STATES = [:sleep, :wait, :calculate]

data/lib/drbqs/server/acl_file.rb

@@ -3,10 +3,10 @@ module DRbQS
     module ACLFile
 
       # Create ACL object from file.
-      # The example of file is the following:
-      # deny all
-      # allow localhost
-      # allow 127.0.0.1
+      # @example Deny hosts except for localhost
+      #  deny all
+      #  allow localhost
+      #  allow 127.0.0.1
       def self.load(path)
         ACL.new(File.read(path).split)
       end

data/lib/drbqs/server/message.rb

@@ -11,14 +11,17 @@ module DRbQS
         @logger = logger
       end
 
-      # Returned values:
-      # [:exit_server, nil]
-      # [:request_status, nil]
-      # [:request_history, nil]
-      # [:exit_after_task, node_id]
-      # [:wake_node, node_id]
-      # [:sleep_node, node_id]
-      # [:node_error, [node_id, error_message]]
+      # One of the following messages is returned.
+      # 
+      # * [:exit_server, nil]
+      # * [:request_status, nil]
+      # * [:request_history, nil]
+      # * [:exit_after_task, node_id]
+      # * [:wake_node, node_id]
+      # * [:sleep_node, node_id]
+      # * [:node_error, [node_id, error_message]]
+      # 
+      # @return [Array] Message array
       def get_message
         begin
           mes = @message.take([:server, Symbol, nil], 0)

data/lib/drbqs/server/queue.rb

@@ -21,8 +21,7 @@ module DRbQS
       end
       private :queue_task
 
-      # &hook take two arguments: a DRbQS::Server::Queue object and a result of task.
-      # Return task ID (for debug).
+      # @return [Fixnum] task ID (for debug)
       def add(task)
         @task_id += 1
         @logger.info("New task: #{@task_id}")

data/lib/drbqs/server/test/server.rb

@@ -30,7 +30,7 @@ module DRbQS
             end
           end
         rescue Exception => err
-          $stdout.puts "*** Error occurs in calculation roop ***"
+          $stdout.puts "*** Error occurs in calculation loop ***"
           b = err.backtrace
           $stdout.puts "#{b[0]}: #{err.to_s} (#{err.class})"
           $stdout.puts b[1..-1].join("\n") if b.size > 1

data/lib/drbqs/setting/base.rb

@@ -14,7 +14,10 @@ module DRbQS
 
       attr_reader :source
 
-      # The keys of options are :all_keys_defined, :log_level, and :daemon
+      # The keys of options are
+      # @option opts [Boolean] :all_keys_defined Check existences of keys on setting values.
+      # @option opts [Boolean] :log_level Use the option of log level.
+      # @option opts [Boolean] :daemon Use the option of daemon.
       def initialize(opts = {}, &block)
         @source = DRbQS::Setting::Source.new(opts[:all_keys_defined])
         @source.register_key(:debug, :bool => true)

data/lib/drbqs/setting/manage.rb

@@ -103,7 +103,7 @@ module DRbQS
       end
       private :command_status
 
-      def command_history
+      def command_history(io)
         request_to_server(io, :get_history)
       end
       private :command_history

data/lib/drbqs/setting/source.rb

@@ -100,10 +100,11 @@ module DRbQS
       end
       private :parse_condition
 
-      # :check
-      # :add
-      # :bool
-      # :default
+      # @param [String,Symbol] key Set a key of a parameter value.
+      # @option opts [Array,Fixnum] :check Set the condition of value.
+      # @option opts [Boolean] :add The value is an array to set multiple values.
+      # @option opts [Boolean] :bool If opts[:bool] is true then the value is boolean.
+      # @option opts [Array] :default Set the default value.
       def register_key(key, opts = {})
         k = key.intern
         if registered_key?(k)

data/lib/drbqs/task/task.rb

@@ -27,6 +27,7 @@ module DRbQS
     # @option opts [Symbol] :hook Method name for hook
     #  that takes two arguments server and the result object.
     # @param [Proc] hook A server execute hook as a callback when the server receive the result
+    #  hook take two arguments: a DRbQS::Server object and a result of task.
     # @note Changes of obj on a node are not sent to a server.
     #  That is, opts[:hook] must not depend on changes of instance variables on a node.
     def initialize(obj, method_name, opts = {}, &hook)

data/lib/drbqs/task/task_generator.rb

@@ -20,6 +20,7 @@ module DRbQS
         @wait
       end
 
+      # Specify how to generate tasks.
       # @param [Hash] opts The options of task generation
       # @option opts [Fixnum] :generate Set the number of tasks per one generation
       # @option opts [Fixnum] :collect The generator creates a task set consisting of opts[:collect] tasks.
@@ -37,7 +38,7 @@ module DRbQS
             begin
               @registrar.instance_eval(&block)
             rescue => err
-              new_err = self.class.new("Error on generating tasks: #{err.to_s} (#{err.class})")
+              new_err = err.class.new("Error on generating tasks: #{err.to_s} (#{err.class})")
               new_err.set_backtrace(err.backtrace)
               raise new_err
             end

data/lib/drbqs/utility/misc.rb

@@ -16,9 +16,10 @@ module DRbQS
       end
     end
 
-    # :port
-    # :host
-    # :unix
+    # @param [Hash] opts The arguments of URI of server
+    # @option opts [Fixnum] :port Port number of a server
+    # @option opts [String] :host Hostname of a server
+    # @option opts [String] :unix Path for unix domain socket of a server 
     def create_uri(opts = {})
       if opts[:port] || !opts[:unix]
         port = opts[:port] || ROOT_DEFAULT_PORT
@@ -73,6 +74,7 @@ module DRbQS
 
     # If process of +pid+ does not exist or its state is zombie then the method return false.
     # If +pid+ is invalid then the method also returns false.
+    # @param [Fixnum] pid PID of process
     def process_running_normally?(pid)
       Integer === pid && (ps_table = Sys::ProcTable.ps(pid)) && (ps_table.state != 'Z')
     end

data/lib/drbqs/utility/temporary.rb

@@ -9,7 +9,7 @@ module DRbQS
     def self.filename
       unless @@filename
         pid = Process.pid
-        @@root = File.join(Dir.tmpdir, sprintf("drbqs_%d_%d", pid, rand(10000)))
+        @@root = File.join(Dir.tmpdir, sprintf("drbqs_%s_%d_%d", ENV['USER'], pid, rand(10000)))
         FileUtils.mkdir_p(@@root, :mode => 0700)
         @@filename = FileName.new(File.join(@@root, sprintf("temp_%d_%d", pid, rand(10000))))
       end

data/lib/drbqs/utility/transfer/transfer.rb

@@ -8,34 +8,38 @@ module DRbQS
       # Add path to queue of which files is going to be transfered to server.
       # @param [String] path The file path that we want to send to a server.
       # @param [Hash] opts The options for transfering a file.
-      # @option opts [true,false] :compress Compress the file by gzip before transfering.
+      # @option opts [Boolean] :compress Compress the file by gzip before transfering.
       # @option opts [String] :rename Change basename to the specified name.
       def enqueue(path, opts = {})
-        if opts[:rename]
-          new_path = FileName.create(File.join(File.dirname(path), opts[:rename]), :directory => :parent)
-          FileUtils.mv(path, new_path)
-          path = new_path
-        end
-        if opts[:compress]
-          if File.directory?(path)
-            gz_path = "#{path.sub(/\/$/, '')}.tar.gz"
-            cmd = "tar czf #{gz_path} -C #{File.dirname(path)} #{File.basename(path)} > /dev/null 2>&1"
-          else
-            gz_path = path + '.gz'
-            cmd = "gzip --best #{path} > /dev/null 2>&1"
+        if File.exist?(path)
+          if opts[:rename]
+            new_path = FileName.create(File.join(File.dirname(path), opts[:rename]), :directory => :parent)
+            FileUtils.mv(path, new_path)
+            path = new_path
           end
-          if File.exist?(gz_path)
-            raise "File has already existed: #{gz_path}"
-          elsif !system(cmd)
-            raise "Can not compress: #{path}"
+          if opts[:compress]
+            if File.directory?(path)
+              gz_path = "#{path.sub(/\/$/, '')}.tar.gz"
+              cmd = "tar czf #{gz_path} -C #{File.dirname(path)} #{File.basename(path)} > /dev/null 2>&1"
+            else
+              gz_path = path + '.gz'
+              cmd = "gzip --best #{path} > /dev/null 2>&1"
+            end
+            if File.exist?(gz_path)
+              raise "File has already existed: #{gz_path}"
+            elsif !system(cmd)
+              raise "Can not compress: #{path}"
+            end
+            FileUtils.rm_r(path) if File.exist?(path)
+            path_to_send = gz_path
+          else
+            path_to_send = path
           end
-          FileUtils.rm_r(path) if File.exist?(path)
-          path_to_send = gz_path
+          @files.enq(path_to_send)
+          File.basename(path_to_send)
         else
-          path_to_send = path
+          nil
         end
-        @files.enq(path_to_send)
-        File.basename(path_to_send)
       end
 
       def compress_enqueue(path)

data/lib/drbqs/version.rb

@@ -0,0 +1,3 @@
+module DRbQS
+  VERSION = '0.0.17'
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: drbqs
 version: !ruby/object:Gem::Version
-  version: 0.0.16
+  version: 0.0.17
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2011-08-03 00:00:00.000000000 Z
+date: 2011-08-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &20439060 !ruby/object:Gem::Requirement
+  requirement: &18201460 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,10 +21,10 @@ dependencies:
         version: 2.6.0
   type: :development
   prerelease: false
-  version_requirements: *20439060
+  version_requirements: *18201460
 - !ruby/object:Gem::Dependency
   name: yard
-  requirement: &20437420 !ruby/object:Gem::Requirement
+  requirement: &18200180 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -32,109 +32,10 @@ dependencies:
         version: 0.7.2
   type: :development
   prerelease: false
-  version_requirements: *20437420
-- !ruby/object:Gem::Dependency
-  name: bundler
-  requirement: &20436000 !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: 1.0.15
-  type: :development
-  prerelease: false
-  version_requirements: *20436000
-- !ruby/object:Gem::Dependency
-  name: jeweler
-  requirement: &20434800 !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: 1.6.2
-  type: :development
-  prerelease: false
-  version_requirements: *20434800
-- !ruby/object:Gem::Dependency
-  name: rcov
-  requirement: &20460380 !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: *20460380
-- !ruby/object:Gem::Dependency
-  name: filename
-  requirement: &20456860 !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: 0.1.0
-  type: :development
-  prerelease: false
-  version_requirements: *20456860
-- !ruby/object:Gem::Dependency
-  name: user_config
-  requirement: &20455420 !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: 0.0.1
-  type: :development
-  prerelease: false
-  version_requirements: *20455420
-- !ruby/object:Gem::Dependency
-  name: net-ssh
-  requirement: &20472680 !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: 2.1.4
-  type: :development
-  prerelease: false
-  version_requirements: *20472680
-- !ruby/object:Gem::Dependency
-  name: net-ssh-shell
-  requirement: &20470220 !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: 0.2.0
-  type: :development
-  prerelease: false
-  version_requirements: *20470220
-- !ruby/object:Gem::Dependency
-  name: net-sftp
-  requirement: &20466740 !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: 2.0.5
-  type: :development
-  prerelease: false
-  version_requirements: *20466740
-- !ruby/object:Gem::Dependency
-  name: sys-proctable
-  requirement: &19983300 !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: *19983300
+  version_requirements: *18200180
 - !ruby/object:Gem::Dependency
   name: filename
-  requirement: &19981400 !ruby/object:Gem::Requirement
+  requirement: &18199300 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -142,10 +43,10 @@ dependencies:
         version: 0.1.0
   type: :runtime
   prerelease: false
-  version_requirements: *19981400
+  version_requirements: *18199300
 - !ruby/object:Gem::Dependency
   name: user_config
-  requirement: &19979460 !ruby/object:Gem::Requirement
+  requirement: &18216600 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -153,32 +54,32 @@ dependencies:
         version: 0.0.2
   type: :runtime
   prerelease: false
-  version_requirements: *19979460
+  version_requirements: *18216600
 - !ruby/object:Gem::Dependency
   name: net-ssh
-  requirement: &19976500 !ruby/object:Gem::Requirement
+  requirement: &18214620 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
-        version: 2.1.3
+        version: 2.1.0
   type: :runtime
   prerelease: false
-  version_requirements: *19976500
+  version_requirements: *18214620
 - !ruby/object:Gem::Dependency
   name: net-ssh-shell
-  requirement: &20054800 !ruby/object:Gem::Requirement
+  requirement: &18213260 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
-        version: 0.1.0
+        version: 0.2.0
   type: :runtime
   prerelease: false
-  version_requirements: *20054800
+  version_requirements: *18213260
 - !ruby/object:Gem::Dependency
   name: net-sftp
-  requirement: &20050920 !ruby/object:Gem::Requirement
+  requirement: &18212080 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -186,10 +87,10 @@ dependencies:
         version: 2.0.5
   type: :runtime
   prerelease: false
-  version_requirements: *20050920
+  version_requirements: *18212080
 - !ruby/object:Gem::Dependency
   name: sys-proctable
-  requirement: &20048980 !ruby/object:Gem::Requirement
+  requirement: &18210980 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -197,9 +98,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *20048980
+  version_requirements: *18210980
 description: Task queuing system over network that is implemented by dRuby.
-email: d@ytak.info
+email:
+- d@ytak.info
 executables:
 - drbqs-execute
 - drbqs-manage
@@ -207,17 +109,15 @@ executables:
 - drbqs-server
 - drbqs-ssh
 extensions: []
-extra_rdoc_files:
-- LICENSE.txt
-- README.md
+extra_rdoc_files: []
 files:
-- .document
+- .gitignore
 - .rspec
+- .yardopts
 - Gemfile
 - LICENSE.txt
 - README.md
 - Rakefile
-- VERSION
 - bin/drbqs-execute
 - bin/drbqs-manage
 - bin/drbqs-node
@@ -308,6 +208,7 @@ files:
 - lib/drbqs/utility/transfer/transfer_client.rb
 - lib/drbqs/utility/transfer/transfer_client_connect.rb
 - lib/drbqs/utility/transfer/transfer_file_list.rb
+- lib/drbqs/version.rb
 - spec/command_line/command_base_spec.rb
 - spec/command_line/commands_spec.rb
 - spec/command_line/option_setting_spec.rb
@@ -368,9 +269,8 @@ files:
 - spec/utility/transfer/transfer_client_connect_spec.rb
 - spec/utility/transfer/transfer_file_list_spec.rb
 - spec/utility/transfer/transfer_spec.rb
-homepage: http://github.com/ytaka/drbqs
-licenses:
-- GPL3
+homepage: ''
+licenses: []
 post_install_message: 
 rdoc_options: []
 require_paths:
@@ -381,9 +281,6 @@ required_ruby_version: !ruby/object:Gem::Requirement
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
-      segments:
-      - 0
-      hash: -870409089664405769
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -391,8 +288,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 1.8.5
+rubyforge_project: drbqs
+rubygems_version: 1.8.10
 signing_key: 
 specification_version: 3
 summary: dRuby Queueing System

data/VERSION

@@ -1 +0,0 @@
-0.0.16