Ruby 1.8.7 リファレンスマニュアル > ライブラリ一覧 > shell/command-processorライブラリ > Shell::CommandProcessorクラス

class Shell::CommandProcessor

クラスの継承リスト: Shell::CommandProcessor < Object < Kernel

要約

目次

特異メソッド

add_delegate_command_to_shell alias_command alias_map def_builtin_commands def_system_command initialize install_builtin_commands install_system_commands method_added new run_config unalias_command undef_system_command

インスタンスメソッド

[] test append atime basename blockdev? cat chardev? check_point finish_all_jobs chmod chown cmp compare concat copy cp ctime delete rm directory? dirname echo executable? executable_real? exist? exists? expand_path file? find_system_command foreach ftype glob grpowned? identical? install join link lstat makedirs mkpath mkdir move mv mtime notify open out owned? pipe? readable? readable_real? readlink rehash rename rm_f safe_unlink rmdir setgid? setuid? size size? socket? split stat sticky? symlink symlink? syscopy system tee transact truncate unlink utime writable? writable_real? zero?

定数

NoDelegateMethods

特異メソッド

add_delegate_command_to_shell(id)[permalink][rdoc]

[TODO]

Shell 自体を初期化する時に呼び出されるメソッドです。 ユーザが使用することはありません。

[PARAM] id:

メソッド名を指定します。

alias_command(alias, command, *opts) -> self[permalink][rdoc]

alias_command(alias, command, *opts) { ... } -> self

[TODO]

[PARAM] alias:

エイリアスの名前を指定します。

[PARAM] command:

コマンド名を指定します。

[PARAM] opts:

コマンドに与えるオプションを指定します。

[EXCEPTION] SyntaxError:

コマンドのエイリアス作成に失敗した時に発生します。

alias_map -> Hash[permalink][rdoc]

Shell::CommandProcessor.alias_command で定義したエイリアスの一覧を返します。

def_builtin_commands(delegation_class, commands_specs) -> ()[permalink][rdoc]

[TODO]

[PARAM] delegation_class:

処理を委譲したいクラスかモジュールを指定します。

[PARAM] commands_specs:

コマンドの仕様を文字列の配列で指定します。 [[コマンド名, [引数1, 引数2, ...]], ...]

def_system_command(command, path = command) -> ()[permalink][rdoc]

[TODO]

与えられたコマンドをメソッドとして定義します。

[PARAM] command:

定義したいコマンドを指定します。

[PARAM] path:

command のパスを指定します。省略すると環境変数 PATH から command を探します。

initialize -> ()[permalink][rdoc]

[TODO]

このクラスを初期化します。

install_builtin_commands -> ()[permalink][rdoc]

ビルトインコマンドを定義します。

install_system_commands(prefix = "sys_") -> ()[permalink][rdoc]

全てのシステムコマンドをメソッドとして定義します。

既に定義されているコマンドを再定義することはありません。 デフォルトでは全てのコマンドに "sys_" というプレフィクスが付きます。 また、メソッド名として使用できない文字は全て "_" に置換してメソッドを定義します。 このメソッドの実行中に発生した例外は単に無視されます。

[PARAM] prefix:

プレフィクスを指定します。

method_added(id)[permalink][rdoc]

[TODO]

このクラスに定義されたメソッドを Shell にも定義するためのフックです。

[PARAM] id:

メソッド名を指定します。

new(shell)[permalink][rdoc]

[TODO]

run_config -> ()[permalink][rdoc]

ユーザのホームディレクトリに "~/.rb_shell" というファイルが存在すれば、それを Kernel.#load します。

存在しない時は何もしません。

unalias_command(alias) -> self[permalink][rdoc]

エイリアスを削除します。

[PARAM] alias:

削除したいエイリアスを指定します。

undef_system_command(command) -> self[permalink][rdoc]

与えられたコマンドを削除します。

[PARAM] command:

削除したいコマンド名を指定します。

インスタンスメソッド

test(command, file1, file2 = nil) -> bool | Time | Integer | nil[permalink][rdoc]

self[command, file1, file2 = nil] -> bool | Time | Integer | nil

Kernel.#test や FileTest のメソッドに処理を委譲します。

[PARAM] command:

数値、またはサイズが 1 の文字列の場合は Kernel.#test に処理委譲します。 2 文字以上の文字列の場合は FileTest のメソッドとして実行します。

[PARAM] file1:

文字列でファイルへのパスを指定します。

[PARAM] file2:

文字列でファイルへのパスを指定します。

require 'shell'
Shell.verbose = false
sh = Shell.new
begin
  sh.mkdir("foo")
rescue
end
p sh[?e, "foo"]         # => true
p sh[:e, "foo"]         # => true
p sh["e", "foo"]        # => true
p sh[:exists?, "foo"]   # => true
p sh["exists?", "foo"]  # => true

[SEE_ALSO] Kernel.#test, FileTest

append(to, filter) -> Shell::AppendFile | Shell::AppendIO[permalink][rdoc]

[TODO]

[PARAM] to:

文字列か IO を指定します。

[PARAM] filter:

Shell::Filter のインスタンスをしています。

atime(filename) -> Time[permalink][rdoc]

File クラスにある同名のクラスメソッドと同じです.

[PARAM] filename:

ファイル名を表す文字列か IO オブジェクトを指定します。

[SEE_ALSO] File.atime

basename(filename, suffix = "") -> String[permalink][rdoc]

File クラスにある同名のクラスメソッドと同じです.

[PARAM] filename:

ファイル名を表す文字列を指定します。

[PARAM] suffix:

サフィックスを文字列で与えます。'.*' という文字列を与えた場合、'*' はワイルドカードとして働き '.' を含まない任意の文字列にマッチします。

[SEE_ALSO] File.basename

blockdev?(file) -> bool[permalink][rdoc]

FileTest モジュールにある同名のクラスメソッドと同じです.

[PARAM] file:

ファイル名を表す文字列か IO オブジェクトを指定します。

[SEE_ALSO] FileTest.#blockdev?

cat(*files) -> Shell::Filter[permalink][rdoc]

実行すると, それらを内容とする Filter オブジェクトを返します.

[PARAM] files:

シェルコマンド cat に与えるファイル名を文字列で指定します。

動作例

require 'shell'
Shell.def_system_command("head")
sh = Shell.new
sh.transact {
  glob("*.txt").to_a.each { |file|
    file.chomp!
    cat(file).each { |l|
      echo(l) | tee(file + ".tee") >> "all.tee"
    }
  }
}

chardev?(file) -> bool[permalink][rdoc]

FileTest モジュールにある同名のクラスメソッドと同じです.

[PARAM] file:

ファイル名を表す文字列か IO オブジェクトを指定します。

[SEE_ALSO] FileTest.#chardev?

check_point[permalink][rdoc]

finish_all_jobs

[TODO]

chmod(mode, *filename) -> Integer[permalink][rdoc]

File クラスにある同名のクラスメソッドと同じです.

[PARAM] filename:

ファイル名を表す文字列を指定します。

[PARAM] mode:

chmod(2) と同様に整数で指定します。

[SEE_ALSO] File.chmod

chown(owner, group, *filename) -> Integer[permalink][rdoc]

File クラスにある同名のクラスメソッドと同じです.

[PARAM] owner:

chown(2) と同様に数値で指定します。nil または -1 を指定することで、オーナーを現在の>ままにすることができます。

[PARAM] group:

chown(2) と同様に数値で指定します。nil または -1 を指定することで、グループを現在の>ままにすることができます。

[PARAM] filename:

ファイル名を表す文字列を指定します。

[SEE_ALSO] File.chown

compare(file1, file2) -> bool[permalink][rdoc]

cmp(file1, file2) -> bool

File クラスにある同名のクラスメソッドと同じです.

[PARAM] file1:

ファイルの名前を文字列で与えます。

[PARAM] file2:

新しいファイル名を文字列で与えます。

[SEE_ALSO] File.compare

concat(*jobs) -> Shell::Concat[permalink][rdoc]

[TODO]

copy(from, to) -> bool[permalink][rdoc]

cp(from, to) -> bool

File クラスにある同名のクラスメソッドと同じです.

[PARAM] from:

ファイルの名前を文字列で与えます。

[PARAM] to:

新しいファイル名を文字列で与えます。

[SEE_ALSO] File.copy

ctime(filename) -> Time[permalink][rdoc]

File クラスにある同名のクラスメソッドと同じです.

[PARAM] filename:

ファイル名を表す文字列か IO オブジェクトを指定します。

[SEE_ALSO] File.ctime

delete(*filename) -> Integer[permalink][rdoc]

rm(*filename) -> Integer

File クラスにある同名のクラスメソッドと同じです.

[PARAM] filename:

ファイル名を表す文字列を指定します。

[SEE_ALSO] File.delete

directory?(file) -> bool[permalink][rdoc]

FileTest モジュールにある同名のクラスメソッドと同じです.

[PARAM] file:

ファイル名を表す文字列か IO オブジェクトを指定します。

[SEE_ALSO] FileTest.#directory?

dirname(filename) -> String[permalink][rdoc]

File クラスにある同名のクラスメソッドと同じです.

[PARAM] filename:

ファイル名を表す文字列を指定します。

[SEE_ALSO] File.dirname

echo(*strings) -> Shell::Filter[permalink][rdoc]

実行すると, それらを内容とする Filter オブジェクトを返します.

[PARAM] strings:

シェルコマンド echo に与える引数を文字列で指定します。

動作例

require 'shell'
Shell.def_system_command("head")
sh = Shell.new
sh.transact {
  glob("*.txt").to_a.each { |file|
    file.chomp!
    cat(file).each { |l|
      echo(l) | tee(file + ".tee") >> "all.tee"
    }
  }
}

executable?(file) -> bool[permalink][rdoc]

FileTest モジュールにある同名のクラスメソッドと同じです.

[PARAM] file:

ファイル名を表す文字列を指定します。

[SEE_ALSO] FileTest.#executable?

executable_real?(file) -> bool[permalink][rdoc]

FileTest モジュールにある同名のクラスメソッドと同じです.

[PARAM] file:

ファイル名を表す文字列を指定します。

[SEE_ALSO] FileTest.#executable_real?

exist?(file) -> bool[permalink][rdoc]

exists?(file) -> bool

FileTest モジュールにある同名のクラスメソッドと同じです.

[PARAM] file:

ファイル名を表す文字列か IO オブジェクトを指定します。

[SEE_ALSO] FileTest.#exist? FileTest.#exists?

expand_path(path) -> String[permalink][rdoc]

Fileクラスにある同名のクラスメソッドと同じです.

[PARAM] path:

ファイル名を表す文字列を指定します。

[SEE_ALSO] File.expand_path

file?(file) -> bool[permalink][rdoc]

FileTest モジュールにある同名のクラスメソッドと同じです.

[PARAM] file:

ファイル名を表す文字列か IO オブジェクトを指定します。

[SEE_ALSO] FileTest.#file?

find_system_command(command)[permalink][rdoc]

[TODO]

foreach(path = nil, &block) -> ()[permalink][rdoc]

pathがファイルなら, File#foreach pathがディレクトリなら, Dir#foreach の動作をします。

[PARAM] path:

ファイルもしくはディレクトリのパスを文字列で指定します。

使用例

require 'shell'
Shell.verbose = false
sh = Shell.new
sh.foreach("/tmp"){|f|
  puts f
}

ftype(filename) -> String[permalink][rdoc]

File クラスにある同名のクラスメソッドと同じです.

[PARAM] filename:

ファイル名を表す文字列を指定します。

[SEE_ALSO] File.ftype

glob(patten) -> Shell::Filter[permalink][rdoc]

実行すると, それらを内容とする Filter オブジェクトを返します.

[PARAM] patten:

シェルコマンド glob に与えるパターンを指定します。 パターンの書式については、Dir.[]を参照してください。

動作例

require 'shell'
Shell.def_system_command("head")
sh = Shell.new
sh.transact {
  glob("*.txt").to_a.each { |file|
    file.chomp!
    cat(file).each { |l|
      echo(l) | tee(file + ".tee") >> "all.tee"
    }
  }
}

[SEE_ALSO] Dir.[]

grpowned?(file) -> bool[permalink][rdoc]

FileTest モジュールにある同名のクラスメソッドと同じです.

[PARAM] file:

ファイル名を表す文字列か IO オブジェクトを指定します。

[SEE_ALSO] FileTest.#grpowned?

identical?[permalink][rdoc]

[TODO]

install(from, to, mode = nil, verbose = false) -> ()[permalink][rdoc]

File クラスにある同名のクラスメソッドと同じです.

[PARAM] from:

コピー元のファイル。

[PARAM] to:

コピー先のファイル。

[PARAM] mode:

ファイルのアクセスモード。8進数で指定します。

[PARAM] verbose:

真を指定すると詳細を表示します。

[SEE_ALSO] File.install

join(*item) -> String[permalink][rdoc]

File クラスにある同名のクラスメソッドと同じです.

[PARAM] item:

連結したいディレクトリ名やファイル名を文字列で与えます。

[SEE_ALSO] File.join

link(old, new) -> 0[permalink][rdoc]

File クラスにある同名のクラスメソッドと同じです.

[PARAM] old:

ファイル名を表す文字列を指定します。

[PARAM] new:

ファイル名を表す文字列を指定します。

[SEE_ALSO] File.link

lstat(filename) -> File::Stat[permalink][rdoc]

File クラスにある同名のクラスメソッドと同じです.

[PARAM] filename:

ファイル名を表す文字列を指定します。

[SEE_ALSO] File.lstat

makedirs(*dirs) -> Array[permalink][rdoc]

mkpath(*dirs) -> Array

File クラスにある同名のクラスメソッドと同じです.

[PARAM] dirs:

作成するディレクトリを指定します。

[SEE_ALSO] File.makedirs

mkdir(*path) -> Array[permalink][rdoc]

Dir.mkdirと同じです。 (複数可)

[PARAM] path:

作成するディレクトリ名を文字列で指定します。

[RETURN]

作成するディレクトリの一覧の配列を返します。

使用例

require 'shell'
Shell.verbose = false
sh = Shell.new
begin
  p sh.mkdir("foo") #=> ["foo"]
rescue => err
  puts err
end

move(from, to) -> bool[permalink][rdoc]

mv(from, to) -> bool

File クラスにある同名のクラスメソッドと同じです.

[PARAM] from:

ファイルの名前を文字列で与えます。

[PARAM] to:

新しいファイル名を文字列で与えます。

[SEE_ALSO] File.move

mtime(filename) -> Time[permalink][rdoc]

File クラスにある同名のクラスメソッドと同じです.

[PARAM] filename:

ファイル名を表す文字列か IO オブジェクトを指定します。

[SEE_ALSO] File.mtime

notify(*opts) { ... } -> ()[permalink][rdoc]

[TODO]

open(path, mode) -> File | Dir[permalink][rdoc]

path がファイルなら、 File.open path がディレクトリなら、 Dir.open の動作をします。

[PARAM] path:

開きたいパスを指定します。

[PARAM] mode:

アクセスモードを指定します。path がディレクトリの場合は無視されます。

[SEE_ALSO] File.open, Dir.open

out(dev = STDOUT, &block) -> ()[permalink][rdoc]

Shell#transact を呼び出しその結果を dev に出力します。

[PARAM] dev:

出力先をIO オブジェクトなどで指定します。

[PARAM] block:

transact 内部で実行するシェルを指定します。

使用例:

require 'shell'
Shell.def_system_command("head")
sh = Shell.new
File.open("out.txt", "w"){ |fp|
  sh.out(fp) {
    system("ls", "-l") | head("-n 3")
  }
}

owned?(file) -> bool[permalink][rdoc]

FileTest モジュールにある同名のクラスメソッドと同じです.

[PARAM] file:

ファイル名を表す文字列か IO オブジェクトを指定します。

[SEE_ALSO] FileTest.#owned?

pipe?(file) -> bool[permalink][rdoc]

FileTest モジュールにある同名のクラスメソッドと同じです.

[PARAM] file:

ファイル名を表す文字列か IO オブジェクトを指定します。

[SEE_ALSO] FileTest.#pipe?

readable?(file) -> bool[permalink][rdoc]

FileTest モジュールにある同名のクラスメソッドと同じです.

[PARAM] file:

ファイル名を表す文字列を指定します。

[SEE_ALSO] FileTest.#readable?

readable_real?(file) -> bool[permalink][rdoc]

FileTest モジュールにある同名のクラスメソッドと同じです.

[PARAM] file:

ファイル名を表す文字列を指定します。

[SEE_ALSO] FileTest.#readable_real?

readlink(path) -> String[permalink][rdoc]

File クラスにある同名のクラスメソッドと同じです.

[PARAM] path:

シンボリックリンクを表す文字列を指定します。

[SEE_ALSO] File.readlink

rehash -> {}[permalink][rdoc]

登録されているシステムコマンドの情報をクリアします。 通常、使うことはありません。

rename(from, to) -> 0[permalink][rdoc]

File クラスにある同名のクラスメソッドと同じです.

[PARAM] from:

ファイルの名前を文字列で与えます。

[PARAM] to:

新しいファイル名を文字列で与えます。

[SEE_ALSO] File.rename

safe_unlink(*filenames) -> Array[permalink][rdoc]

rm_f(*filenames) -> Array

File クラスにある同名のクラスメソッドと同じです.

[PARAM] filenames:

削除するファイルを指定します。

[SEE_ALSO] File.safe_unlink

rmdir(*path) -> ()[permalink][rdoc]

Dir.rmdirと同じです。 (複数可)

[PARAM] path:

削除するディレクトリ名を文字列で指定します。

setgid?(file) -> bool[permalink][rdoc]

FileTest モジュールにある同名のクラスメソッドと同じです.

[PARAM] file:

ファイル名を表す文字列を指定します。

[SEE_ALSO] FileTest.#setgid?

setuid?(file) -> bool[permalink][rdoc]

FileTest モジュールにある同名のクラスメソッドと同じです.

[PARAM] file:

ファイル名を表す文字列を指定します。

[SEE_ALSO] FileTest.#setuid?

size(file) -> Integer[permalink][rdoc]

size?(file) -> Integer | nil

FileTest モジュールにある同名のクラスメソッドと同じです.

[PARAM] file:

ファイル名を表す文字列を指定します。

[SEE_ALSO] FileTest.#size FileTest.#size?

socket?(file) -> bool[permalink][rdoc]

FileTest モジュールにある同名のクラスメソッドと同じです.

[PARAM] file:

ファイル名を表す文字列を指定します。

[SEE_ALSO] FileTest.#socket?

split(pathname) -> [String][permalink][rdoc]

File クラスにある同名のクラスメソッドと同じです.

[PARAM] pathname:

パス名を表す文字列を指定します。

[SEE_ALSO] File.split

stat(filename) -> File::Stat[permalink][rdoc]

File クラスにある同名のクラスメソッドと同じです.

[PARAM] filename:

ファイル名を表す文字列を指定します。

[SEE_ALSO] File.stat

sticky?(file) -> bool[permalink][rdoc]

FileTest モジュールにある同名のクラスメソッドと同じです.

[PARAM] file:

ファイル名を表す文字列を指定します。

[SEE_ALSO] FileTest.#sticky?

symlink(old, new) -> 0[permalink][rdoc]

File クラスにある同名のクラスメソッドと同じです.

[PARAM] old:

ファイル名を表す文字列を指定します。

[PARAM] new:

シンボリックリンクを表す文字列を指定します。

[SEE_ALSO] File.symlink

symlink?(file) -> bool[permalink][rdoc]

FileTest モジュールにある同名のクラスメソッドと同じです.

[PARAM] file:

ファイル名を表す文字列を指定します。

[SEE_ALSO] FileTest.#symlink?

syscopy(from, to) -> bool[permalink][rdoc]

File クラスにある同名のクラスメソッドと同じです.

[PARAM] from:

ファイルの名前を文字列で与えます。

[PARAM] to:

新しいファイル名を文字列で与えます。

[SEE_ALSO] File.syscopy

system(command, *opts) -> Shell::SystemCommand[permalink][rdoc]

command を実行する.

[PARAM] command:

実行するコマンドのパスを文字列で指定します。

[PARAM] opts:

command のオプションを文字列で指定します。複数可。

使用例:

require 'shell'
Shell.verbose = false
sh = Shell.new

print sh.system("ls", "-l")
Shell.def_system_command("head")
sh.system("ls", "-l") | sh.head("-n 3") > STDOUT

tee(file) -> Shell::Filter[permalink][rdoc]

実行すると, それらを内容とする Filter オブジェクトを返します.

[PARAM] file:

シェルコマンドtee に与えるファイル名を文字列で指定します。

動作例

require 'shell'
Shell.def_system_command("head")
sh = Shell.new
sh.transact {
  glob("*.txt").to_a.each { |file|
    file.chomp!
    cat(file).each { |l|
      echo(l) | tee(file + ".tee") >> "all.tee"
    }
  }
}

transact { ... } -> object[permalink][rdoc]

ブロック中で shell を self として実行します。

例:

require 'shell'
Shell.def_system_command("head")
sh = Shell.new
sh.transact{
  system("ls", "-l") | head > STDOUT
  # transact の中では、
  # sh.system("ls", "-l") | sh.head > STDOUT と同じとなる。
}

truncate(path, length) -> 0[permalink][rdoc]

File クラスにある同名のクラスメソッドと同じです.

[PARAM] path:

パスを表す文字列を指定します。

[PARAM] length:

変更したいサイズを整数で与えます。

[SEE_ALSO] File.truncate

unlink(path) -> self[permalink][rdoc]

path がファイルなら File.unlink、path がディレクトリなら Dir.unlink の動作をします。

[PARAM] path:

削除したいパスを指定します。

[SEE_ALSO] File.unlink, Dir.unlink

utime(atime, mtime, *filename) -> Integer[permalink][rdoc]

File クラスにある同名のクラスメソッドと同じです.

[PARAM] filename:

ファイル名を表す文字列を指定します。

[PARAM] atime:

最終アクセス時刻を Time か、起算時からの経過秒数を数値で指定します。

[PARAM] utime:

更新時刻を Time か、起算時からの経過秒数を数値で指定します。

[SEE_ALSO] File.utime

writable?(file) -> bool[permalink][rdoc]

FileTest モジュールにある同名のクラスメソッドと同じです.

[PARAM] file:

ファイル名を表す文字列を指定します。

[SEE_ALSO] FileTest.#writable?

writable_real?(file) -> bool[permalink][rdoc]

FileTest モジュールにある同名のクラスメソッドと同じです.

[PARAM] file:

ファイル名を表す文字列を指定します。

[SEE_ALSO] FileTest.#writable_real?

zero?(file) -> bool[permalink][rdoc]

FileTest モジュールにある同名のクラスメソッドと同じです.

[PARAM] file:

ファイル名を表す文字列を指定します。

[SEE_ALSO] FileTest.#zero?

定数

NoDelegateMethods -> [String][permalink][rdoc]

内部で使用する定数です。