session 2.4.0 → 3.1.0

data/lib/session.rb

@@ -5,8 +5,8 @@ require 'yaml'
 require 'tempfile'
 
 module Session 
-#--{{{
-  VERSION = '2.4.0'
+  VERSION = '3.1.0'
+  def self.version() VERSION end
 
   @track_history = ENV['SESSION_HISTORY'] || ENV['SESSION_TRACK_HISTORY']
   @use_spawn     = ENV['SESSION_USE_SPAWN']
@@ -14,43 +14,33 @@ module Session
   @debug         = ENV['SESSION_DEBUG']
 
   class << self
-#--{{{
     attr :track_history, true
     attr :use_spawn, true
     attr :use_open3, true
     attr :debug, true
     def new(*a, &b)
-#--{{{
       Sh::new(*a, &b)
-#--}}}
     end
     alias [] new
-#--}}}
   end
 
   class PipeError < StandardError; end
   class ExecutionError < StandardError; end
 
   class History
-#--{{{
     def initialize; @a = []; end
     def method_missing(m,*a,&b); @a.send(m,*a,&b); end
     def to_yaml(*a,&b); @a.to_yaml(*a,&b); end
     alias to_s to_yaml 
     alias to_str to_yaml 
-#--}}}
   end # class History
   class Command
-#--{{{
     class << self
-#--{{{
       def cmdno; @cmdno ||= 0; end
       def cmdno= n; @cmdno = n; end
-#--}}}
     end
 
     # attributes
-#--{{{
     attr :cmd
     attr :cmdno
     attr :out,true
@@ -64,10 +54,8 @@ module Session
     attr :end_err
     attr :begin_err_pat
     attr :end_err_pat
-#--}}}
 
     def initialize(command)
-#--{{{
       @cmd = command.to_s
       @cmdno = self.class.cmdno
       self.class.cmdno += 1
@@ -82,30 +70,21 @@ module Session
       @end_err = "__CMD_ERR_%s_END__" % cid
       @begin_err_pat = %r/#{ Regexp.escape(@begin_err) }/
       @end_err_pat = %r/#{ Regexp.escape(@end_err) }/
-#--}}}
     end
     def to_hash
-#--{{{
       %w(cmdno cmd out err cid).inject({}){|h,k| h.update k => send(k) }
-#--}}}
     end
     def to_yaml(*a,&b)
-#--{{{
       to_hash.to_yaml(*a,&b)
-#--}}}
     end
     alias to_s to_yaml 
     alias to_str to_yaml 
-#--}}}
   end # class Command
   class AbstractSession 
-#--{{{
 
   # class methods
     class << self
-#--{{{
       def default_prog
-#--{{{
         return @default_prog if defined? @default_prog and @default_prog
         if defined? self::DEFAULT_PROG
           return @default_prog = self::DEFAULT_PROG 
@@ -113,34 +92,27 @@ module Session
           @default_prog = ENV["SESSION_#{ self }_PROG"]
         end
         nil
-#--}}}
       end
       def default_prog= prog
-#--{{{
         @default_prog = prog 
-#--}}}
       end
       attr :track_history, true
       attr :use_spawn, true
       attr :use_open3, true
       attr :debug, true
       def init
-#--{{{
         @track_history = nil
         @use_spawn = nil
         @use_open3 = nil
         @debug = nil
-#--}}}
       end
       alias [] new
-#--}}}
     end
 
   # class init
     init
 
   # attributes
-#--{{{
     attr :opts
     attr :prog
     attr :stdin
@@ -158,11 +130,9 @@ module Session
     attr :debug, true
     alias debug? debug
     attr :threads
-#--}}}
 
   # instance methods
     def initialize(*args)
-#--{{{
       @opts = hashify(*args)
 
       @prog = getopt('prog', opts, getopt('program', opts, self.class::default_prog))
@@ -180,10 +150,14 @@ module Session
       @use_spawn = self.class::use_spawn unless self.class::use_spawn.nil?
       @use_spawn = getopt('use_spawn', opts) if hasopt('use_spawn', opts)
 
-      @use_open3 = nil
-      @use_open3 = Session::use_open3 unless Session::use_open3.nil?
-      @use_open3 = self.class::use_open3 unless self.class::use_open3.nil?
-      @use_open3 = getopt('use_open3', opts) if hasopt('use_open3', opts) 
+      if defined? JRUBY_VERSION
+        @use_open3 = true
+      else
+        @use_open3 = nil
+        @use_open3 = Session::use_open3 unless Session::use_open3.nil?
+        @use_open3 = self.class::use_open3 unless self.class::use_open3.nil?
+        @use_open3 = getopt('use_open3', opts) if hasopt('use_open3', opts)
+      end
 
       @debug = nil
       @debug = Session::debug unless Session::debug.nil?
@@ -220,10 +194,8 @@ module Session
       end
 
       return self
-#--}}}
     end
     def getopt opt, hash, default = nil
-#--{{{
       key = opt
       return hash[key] if hash.has_key? key
       key = "#{ key }"
@@ -231,10 +203,8 @@ module Session
       key = key.intern
       return hash[key] if hash.has_key? key
       return default
-#--}}}
     end
     def hasopt opt, hash
-#--{{{
       key = opt
       return key if hash.has_key? key
       key = "#{ key }"
@@ -242,10 +212,8 @@ module Session
       key = key.intern
       return key if hash.has_key? key
       return false 
-#--}}}
     end
     def __popen3(*cmd)
-#--{{{
       pw = IO::pipe   # pipe[0] for read, pipe[1] for write
       pr = IO::pipe
       pe = IO::pipe
@@ -283,10 +251,8 @@ module Session
         end
       end
       pi
-#--}}}
     end
     def __fork(*a, &b)
-#--{{{
       verbose = $VERBOSE
       begin
         $VERBOSE = nil 
@@ -294,62 +260,44 @@ module Session
       ensure
         $VERBOSE = verbose
       end
-#--}}}
     end
 
   # abstract methods
     def clear
-#--{{{
       raise NotImplementedError
-#--}}}
     end
     alias flush clear
     def path 
-#--{{{
       raise NotImplementedError
-#--}}}
     end
     def path= 
-#--{{{
       raise NotImplementedError
-#--}}}
     end
     def send_command cmd
-#--{{{
       raise NotImplementedError
-#--}}}
     end
 
   # concrete methods
     def track_history= bool
-#--{{{
       @history ||= History::new
       @track_history = bool
-#--}}}
     end
     def ready?
-#--{{{
       (stdin and stdout and stderr) and
       (IO === stdin and IO === stdout and IO === stderr) and
       (not (stdin.closed? or stdout.closed? or stderr.closed?))
-#--}}}
     end
     def close!
-#--{{{
       [stdin, stdout, stderr].each{|pipe| pipe.close}
       stdin, stdout, stderr = nil, nil, nil
       true
-#--}}}
     end
     alias close close!
     def hashify(*a)
-#--{{{
       a.inject({}){|o,h| o.update(h)}
-#--}}}
     end
     private :hashify
     def execute(command, redirects = {})
-#--{{{
       $session_command = command if @debug
 
       raise(PipeError, command) unless ready? 
@@ -485,12 +433,9 @@ module Session
       out = err = iodat = nil
 
       return [cmd.out, cmd.err]
-#--}}}
     end
-#--}}}
   end # class AbstractSession
   class Sh < AbstractSession
-#--{{{
     DEFAULT_PROG    = 'sh'
     ECHO            = 'echo'
 
@@ -499,17 +444,14 @@ module Session
     alias exitstatus status
 
     def clear
-#--{{{
       stdin.puts "#{ ECHO } __clear__ 1>&2"
       stdin.puts "#{ ECHO } __clear__"
       stdin.flush
       while((line = stderr.gets) and line !~ %r/__clear__/o); end
       while((line = stdout.gets) and line !~ %r/__clear__/o); end
       self
-#--}}}
     end
     def send_command cmd
-#--{{{
       stdin.printf "%s '%s' 1>&2\n", ECHO, cmd.begin_err
       stdin.printf "%s '%s' \n", ECHO, cmd.begin_out
  
@@ -520,26 +462,20 @@ module Session
       stdin.printf "%s '%s' \n", ECHO, cmd.end_out
  
       stdin.flush
-#--}}}
     end
     def get_status
-#--{{{
       @status = get_var '__exit_status__' 
       unless @status =~ /^\s*\d+\s*$/o
         raise ExecutionError, "could not determine exit status from <#{ @status.inspect }>"
       end
 
       @status = Integer @status
-#--}}}
     end
     def set_var name, value
-#--{{{
       stdin.puts "export #{ name }=#{ value }"
       stdin.flush
-#--}}}
     end
     def get_var name
-#--{{{
       stdin.puts "#{ ECHO } \"#{ name }=${#{ name }}\""
       stdin.flush
 
@@ -554,16 +490,12 @@ module Session
       end
 
       var
-#--}}}
     end
     def path 
-#--{{{
       var = get_var 'PATH'
       var.strip.split %r/:/o
-#--}}}
     end
     def path= arg 
-#--{{{
       case arg
         when Array
           arg = arg.join ':'
@@ -573,10 +505,8 @@ module Session
 
       set_var 'PATH', "'#{ arg }'"
       self.path
-#--}}}
     end
     def execute(command, redirects = {}, &block)
-#--{{{
     # setup redirect on stdin
       rin = redirects[:i] || redirects[:in] || redirects[:stdin] || 
              redirects['stdin'] || redirects['i'] || redirects['in'] ||
@@ -611,27 +541,21 @@ module Session
       else
         super
       end
-#--}}}
     end
-#--}}}
   end # class Sh
   class Bash < Sh
-#--{{{
     DEFAULT_PROG = 'bash'
     class Login < Bash
       DEFAULT_PROG = 'bash --login'
     end
-#--}}}
   end # class Bash
   class Shell < Bash; end
   # IDL => interactive data language - see http://www.rsinc.com/
   class IDL < AbstractSession
-#--{{{
     class LicenseManagerError < StandardError; end
     DEFAULT_PROG = 'idl'
     MAX_TRIES = 32 
     def initialize(*args)
-#--{{{
       tries = 0 
       ret = nil
       begin
@@ -646,10 +570,8 @@ module Session
         end
       end
       ret
-#--}}}
     end
     def clear
-#--{{{
       stdin.puts "retall"
       stdin.puts "printf, -2, '__clear__'"
       stdin.puts "printf, -1, '__clear__'"
@@ -661,10 +583,8 @@ module Session
         raise LicenseManagerError, line if line =~ %r/license\s*manager/io
       end
       self
-#--}}}
     end
     def send_command cmd
-#--{{{
       stdin.printf "printf, -2, '%s'\n", cmd.begin_err
       stdin.printf "printf, -1, '%s'\n", cmd.begin_out
 
@@ -674,16 +594,12 @@ module Session
       stdin.printf "printf, -2, '%s'\n", cmd.end_err
       stdin.printf "printf, -1, '%s'\n", cmd.end_out
       stdin.flush
-#--}}}
     end
     def path 
-#--{{{
       stdout, stderr = execute "print, !path"
       stdout.strip.split %r/:/o
-#--}}}
     end
     def path= arg 
-#--{{{
       case arg
         when Array
           arg = arg.join ':'
@@ -693,15 +609,11 @@ module Session
       stdout, stderr = execute "!path='#{ arg }'"
 
       self.path
-#--}}}
     end
-#--}}}
   end # class IDL
   module Spawn
-#--{{{
     class << self
       def spawn command
-#--{{{
         ipath = tmpfifo
         opath = tmpfifo
         epath = tmpfifo
@@ -714,10 +626,8 @@ module Session
         e = open epath, 'r'
 
         [i,o,e]
-#--}}}
       end
       def tmpfifo
-#--{{{
         path = nil
         42.times do |i|
           tpath = File::join(Dir::tmpdir, "#{ $$ }.#{ rand }.#{ i }")
@@ -735,10 +645,7 @@ module Session
         end
         raise "could not generate tmpfifo" unless path
         path
-#--}}}
       end
     end
-#--}}}
   end # module Spawn
-#--}}}
 end # module Session

data/sample/bash.rb

@@ -0,0 +1,60 @@
+#!/usr/bin/env ruby
+$:.unshift '.', '..', 'lib', File.join('..','lib')
+
+require 'session'
+
+
+bash = Session::Bash.new
+
+
+puts "======== ======== ======== ========"
+puts "#1"
+puts "======== ======== ======== ========"
+
+stdout, stderr = bash.execute 'ls'
+
+puts "STDOUT:\n#{ stdout }"
+puts "STDERR:\n#{ stderr }"
+
+puts "STATUS: #{ bash.status }"
+puts "======== ======== ======== ========"
+
+
+puts "======== ======== ======== ========"
+puts "#2"
+puts "======== ======== ======== ========"
+
+bash.execute 'ls' do |stdout, stderr|
+  puts "STDOUT:\n#{ stdout }"
+  puts "STDERR:\n#{ stderr }"
+end
+
+puts "STATUS: #{ bash.status }"
+puts "======== ======== ======== ========"
+
+
+puts "======== ======== ======== ========"
+puts "#3"
+puts "======== ======== ======== ========"
+
+stdout, stderr = '', ''
+bash.execute 'ls', :stdout => stdout, :stderr => stderr
+
+puts "STDOUT:\n#{ stdout }"
+puts "STDERR:\n#{ stderr }"
+
+puts "STATUS: #{ bash.status }"
+puts "======== ======== ======== ========"
+
+
+puts "======== ======== ======== ========"
+puts "#4"
+puts "======== ======== ======== ========"
+
+bash.outproc = lambda{|out| puts "#{ out }"}
+bash.errproc = lambda{|err| raise err}
+
+bash.execute('while test 1; do echo 42; sleep 1; done') # => 42 ... 42 ... 42 
+puts "======== ======== ======== ========"
+
+