Class: Shell
- Inherits:
-
Object
- Object
- Shell
- Extended by:
- Exception2MessageMapper, Forwardable
- Includes:
- Error
- Defined in:
- lib/shell.rb,
lib/shell/error.rb,
lib/shell/filter.rb,
lib/shell/version.rb,
lib/shell/system-command.rb,
lib/shell/builtin-command.rb,
lib/shell/command-processor.rb,
lib/shell/process-controller.rb
Overview
version.rb - shell version definition file
$Release Version: 0.7$
$Revision$
by Keiju ISHITSUKA([email protected])
–
Defined Under Namespace
Modules: Error Classes: AppendFile, AppendIO, BuiltInCommand, Cat, CommandProcessor, Concat, Echo, Filter, Glob, ProcessController, SystemCommand, Tee, Void
Constant Summary collapse
- VERSION =
:nodoc:
"0.8.1"
Class Attribute Summary collapse
-
.cascade ⇒ Object
Returns the value of attribute cascade.
-
.debug ⇒ Object
(also: debug?)
Returns the value of attribute debug.
-
.verbose ⇒ Object
(also: verbose?)
Returns the value of attribute verbose.
Instance Attribute Summary collapse
-
#command_processor ⇒ Object
readonly
Returns the value of attribute command_processor.
-
#cwd ⇒ Object
(also: #dir, #getwd, #pwd)
readonly
Returns the current working directory.
-
#debug ⇒ Object
(also: #debug?)
Returns the value of attribute debug.
-
#dir_stack ⇒ Object
(also: #dirs)
readonly
Returns the value of attribute dir_stack.
-
#process_controller ⇒ Object
readonly
Returns the value of attribute process_controller.
-
#record_separator ⇒ Object
Returns the value of attribute record_separator.
-
#system_path ⇒ Object
Returns the command search path in an array.
-
#umask ⇒ Object
Returns the umask.
-
#verbose ⇒ Object
(also: #verbose?)
Returns the value of attribute verbose.
Class Method Summary collapse
-
.alias_command(ali, command, *opts, &block) ⇒ Object
call-seq: alias_command(alias, command, *opts, &block).
-
.cd(path) ⇒ Object
call-seq: Shell.cd(path).
-
.def_system_command(command, path = command) ⇒ Object
call-seq: def_system_command(command, path = command).
- .default_record_separator ⇒ Object
- .default_record_separator=(rs) ⇒ Object
-
.default_system_path ⇒ Object
Returns the directories in the current shell’s PATH environment variable as an array of directory names.
-
.default_system_path=(path) ⇒ Object
Sets the system_path that new instances of Shell should have as their initial system_path.
-
.install_system_commands(pre = "sys_") ⇒ Object
call-seq: install_system_commands(pre = “sys_”).
- .notify(*opts) ⇒ Object
-
.unalias_command(ali) ⇒ Object
Convenience method for Shell::CommandProcessor.unalias_command.
-
.undef_system_command(command) ⇒ Object
Convenience method for Shell::CommandProcessor.undef_system_command.
Instance Method Summary collapse
-
#chdir(path = nil, verbose = @verbose) ⇒ Object
(also: #cd)
call-seq: Shell.chdir(path).
- #expand_path(path) ⇒ Object
-
#initialize(pwd = Dir.pwd, umask = nil) ⇒ Shell
constructor
call-seq: Shell.new(pwd, umask) -> obj.
- #inspect ⇒ Object
-
#jobs ⇒ Object
Returns a list of scheduled jobs.
-
#kill(sig, command) ⇒ Object
call-seq: kill(signal, job).
-
#popdir ⇒ Object
(also: #popd)
Pops a directory from the directory stack, and sets the current directory to it.
-
#pushdir(path = nil, verbose = @verbose) ⇒ Object
(also: #pushd)
call-seq: pushdir(path) pushdir(path) { &block }.
Constructor Details
#initialize(pwd = Dir.pwd, umask = nil) ⇒ Shell
call-seq:
Shell.new(pwd, umask) -> obj
Creates a Shell object which current directory is set to the process current directory, unless otherwise specified by the pwd
argument.
185 186 187 188 189 190 191 192 193 194 195 196 197 198 |
# File 'lib/shell.rb', line 185 def initialize(pwd = Dir.pwd, umask = nil) @cwd = File.(pwd) @dir_stack = [] @umask = umask @system_path = Shell.default_system_path @record_separator = Shell.default_record_separator @command_processor = CommandProcessor.new(self) @process_controller = ProcessController.new(self) @verbose = Shell.verbose @debug = Shell.debug end |
Class Attribute Details
.cascade ⇒ Object
Returns the value of attribute cascade.
109 110 111 |
# File 'lib/shell.rb', line 109 def cascade @cascade end |
.debug ⇒ Object Also known as: debug?
Returns the value of attribute debug.
110 111 112 |
# File 'lib/shell.rb', line 110 def debug @debug end |
.verbose ⇒ Object Also known as: verbose?
Returns the value of attribute verbose.
109 110 111 |
# File 'lib/shell.rb', line 109 def verbose @verbose end |
Instance Attribute Details
#command_processor ⇒ Object (readonly)
Returns the value of attribute command_processor.
226 227 228 |
# File 'lib/shell.rb', line 226 def command_processor @command_processor end |
#cwd ⇒ Object (readonly) Also known as: dir, getwd, pwd
Returns the current working directory.
246 247 248 |
# File 'lib/shell.rb', line 246 def cwd @cwd end |
#debug ⇒ Object Also known as: debug?
Returns the value of attribute debug.
216 217 218 |
# File 'lib/shell.rb', line 216 def debug @debug end |
#dir_stack ⇒ Object (readonly) Also known as: dirs
Returns the value of attribute dir_stack.
251 252 253 |
# File 'lib/shell.rb', line 251 def dir_stack @dir_stack end |
#process_controller ⇒ Object (readonly)
Returns the value of attribute process_controller.
227 228 229 |
# File 'lib/shell.rb', line 227 def process_controller @process_controller end |
#record_separator ⇒ Object
Returns the value of attribute record_separator.
214 215 216 |
# File 'lib/shell.rb', line 214 def record_separator @record_separator end |
#system_path ⇒ Object
Returns the command search path in an array
201 202 203 |
# File 'lib/shell.rb', line 201 def system_path @system_path end |
#umask ⇒ Object
Returns the umask
213 214 215 |
# File 'lib/shell.rb', line 213 def umask @umask end |
#verbose ⇒ Object Also known as: verbose?
Returns the value of attribute verbose.
215 216 217 |
# File 'lib/shell.rb', line 215 def verbose @verbose end |
Class Method Details
.alias_command(ali, command, *opts, &block) ⇒ Object
call-seq:
alias_command(alias, command, *opts, &block)
Convenience method for Shell::CommandProcessor.alias_command. Defines an instance method which will execute a command under an alternative name.
Shell.def_system_command('date')
Shell.alias_command('date_in_utc', 'date', '-u')
Shell.new.date_in_utc # => Sat Jan 25 16:59:57 UTC 2014
395 396 397 |
# File 'lib/shell.rb', line 395 def Shell.alias_command(ali, command, *opts, &block) CommandProcessor.alias_command(ali, command, *opts, &block) end |
.cd(path) ⇒ Object
call-seq:
Shell.cd(path)
Creates a new Shell instance with the current working directory set to path
.
127 128 129 |
# File 'lib/shell.rb', line 127 def cd(path) new(path) end |
.def_system_command(command, path = command) ⇒ Object
call-seq:
def_system_command(command, path = command)
Convenience method for Shell::CommandProcessor.def_system_command. Defines an instance method which will execute the given shell command. If the executable is not in Shell.default_system_path, you must supply the path to it.
Shell.def_system_command('hostname')
Shell.new.hostname # => localhost
# How to use an executable that's not in the default path
Shell.def_system_command('run_my_program', "~/hello")
Shell.new.run_my_program # prints "Hello from a C program!"
375 376 377 |
# File 'lib/shell.rb', line 375 def Shell.def_system_command(command, path = command) CommandProcessor.def_system_command(command, path) end |
.default_record_separator ⇒ Object
160 161 162 163 164 165 166 |
# File 'lib/shell.rb', line 160 def default_record_separator if @default_record_separator @default_record_separator else $/ end end |
.default_record_separator=(rs) ⇒ Object
168 169 170 |
# File 'lib/shell.rb', line 168 def default_record_separator=(rs) @default_record_separator = rs end |
.default_system_path ⇒ Object
Returns the directories in the current shell’s PATH environment variable as an array of directory names. This sets the system_path for all instances of Shell.
Example: If in your current shell, you did:
$ echo $PATH
/usr/bin:/bin:/usr/local/bin
Running this method in the above shell would then return:
["/usr/bin", "/bin", "/usr/local/bin"]
144 145 146 147 148 149 150 |
# File 'lib/shell.rb', line 144 def default_system_path if @default_system_path @default_system_path else ENV["PATH"].split(":") end end |
.default_system_path=(path) ⇒ Object
Sets the system_path that new instances of Shell should have as their initial system_path.
path
should be an array of directory name strings.
156 157 158 |
# File 'lib/shell.rb', line 156 def default_system_path=(path) @default_system_path = path end |
.install_system_commands(pre = "sys_") ⇒ Object
call-seq:
install_system_commands(pre = "sys_")
Convenience method for Shell::CommandProcessor.install_system_commands. Defines instance methods representing all the executable files found in Shell.default_system_path, with the given prefix prepended to their names.
Shell.install_system_commands
Shell.new.sys_echo("hello") # => hello
415 416 417 |
# File 'lib/shell.rb', line 415 def Shell.install_system_commands(pre = "sys_") CommandProcessor.install_system_commands(pre) end |
.notify(*opts) ⇒ Object
428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 |
# File 'lib/shell.rb', line 428 def self.notify(*opts) Shell::debug_output_synchronize do if opts[-1].kind_of?(String) yorn = verbose? else yorn = opts.pop end return unless yorn if @debug_display_thread_id if @debug_display_process_id prefix = "shell(##{Process.pid}:#{Thread.current.to_s.sub("Thread", "Th")}): " else prefix = "shell(#{Thread.current.to_s.sub("Thread", "Th")}): " end else prefix = "shell: " end _head = true STDERR.print opts.collect{|mes| mes = mes.dup yield mes if block_given? if _head _head = false prefix + mes else " "* prefix.size + mes end }.join("\n")+"\n" end end |
.unalias_command(ali) ⇒ Object
Convenience method for Shell::CommandProcessor.unalias_command
400 401 402 |
# File 'lib/shell.rb', line 400 def Shell.unalias_command(ali) CommandProcessor.unalias_command(ali) end |
.undef_system_command(command) ⇒ Object
Convenience method for Shell::CommandProcessor.undef_system_command
380 381 382 |
# File 'lib/shell.rb', line 380 def Shell.undef_system_command(command) CommandProcessor.undef_system_command(command) end |
Instance Method Details
#chdir(path = nil, verbose = @verbose) ⇒ Object Also known as: cd
call-seq:
Shell.chdir(path)
Creates a Shell object which current directory is set to path
.
If a block is given, it restores the current directory when the block ends.
If called as iterator, it restores the current directory when the block ends.
263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 |
# File 'lib/shell.rb', line 263 def chdir(path = nil, verbose = @verbose) check_point if block_given? notify("chdir(with block) #{path}") if verbose cwd_old = @cwd begin chdir(path, nil) yield ensure chdir(cwd_old, nil) end else notify("chdir #{path}") if verbose path = "~" unless path @cwd = (path) notify "current dir: #{@cwd}" rehash Void.new(self) end end |
#expand_path(path) ⇒ Object
229 230 231 |
# File 'lib/shell.rb', line 229 def (path) File.(path, @cwd) end |
#inspect ⇒ Object
420 421 422 423 424 425 426 |
# File 'lib/shell.rb', line 420 def inspect if debug.kind_of?(Integer) && debug > 2 super else to_s end end |
#jobs ⇒ Object
Returns a list of scheduled jobs.
347 348 349 |
# File 'lib/shell.rb', line 347 def jobs @process_controller.jobs end |
#kill(sig, command) ⇒ Object
call-seq:
kill(signal, job)
Sends the given signal
to the given job
355 356 357 |
# File 'lib/shell.rb', line 355 def kill(sig, command) @process_controller.kill_job(sig, command) end |
#popdir ⇒ Object Also known as: popd
Pops a directory from the directory stack, and sets the current directory to it.
331 332 333 334 335 336 337 338 339 340 341 342 343 |
# File 'lib/shell.rb', line 331 def popdir check_point notify("popdir") if pop = @dir_stack.pop chdir pop notify "dir stack: [#{@dir_stack.join ', '}]" self else Shell.Fail DirStackEmpty end Void.new(self) end |
#pushdir(path = nil, verbose = @verbose) ⇒ Object Also known as: pushd
call-seq:
pushdir(path)
pushdir(path) { &block }
Pushes the current directory to the directory stack, changing the current directory to path
.
If path
is omitted, it exchanges its current directory and the top of its directory stack.
If a block is given, it restores the current directory when the block ends.
297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 |
# File 'lib/shell.rb', line 297 def pushdir(path = nil, verbose = @verbose) check_point if block_given? notify("pushdir(with block) #{path}") if verbose pushdir(path, nil) begin yield ensure popdir end elsif path notify("pushdir #{path}") if verbose @dir_stack.push @cwd chdir(path, nil) notify "dir stack: [#{@dir_stack.join ', '}]" self else notify("pushdir") if verbose if pop = @dir_stack.pop @dir_stack.push @cwd chdir pop notify "dir stack: [#{@dir_stack.join ', '}]" self else Shell.Fail DirStackEmpty end end Void.new(self) end |