session 2.4.0 → 3.1.0

data/LICENSE

@@ -0,0 +1,3 @@
+same as Ruby's
+
+http://www.ruby-lang.org/en/LICENSE.txt

data/README

@@ -0,0 +1,168 @@
+URLS: |
+
+  http://raa.ruby-lang.org/project/session/
+  http://www.codeforpeople.com/lib/ruby/session/
+
+
+NAME: |
+
+  Session
+    ::Sh
+    ::Bash
+    ::Shell
+    ::IDL
+
+SYNOPSIS: |
+
+  Session::* offers a set of classes built upon Open3::popen3 for driving
+  external progams via pipes.  It offers a significant abstraction over
+  Open3::popen in that the stdout/stderr of each command sent can be deliniated:
+
+    open3:
+
+        i,o,e = Open3::popen3 '/bin/sh'
+
+        i.puts 'ls'
+        i.puts 'echo 42'
+
+    now, how to determine the boundry between the output from 'ls' and 'echo'?
+    the only (simple) way is start a process for each command
+
+        i,o,e = Open3::popen3 '/bin/sh'
+        i.puts 'ls'
+        i.close
+        stdout, stderr = o.read, e.read
+
+        i,o,e = Open3::popen3 '/bin/sh'
+        i.puts 'echo 42'
+        i.close
+        stdout, stderr = o.read, e.read
+
+    session:
+
+      sh = Session::new
+
+      stdout, stderr = sh.execute 'ls'
+      stdout, stderr = sh.execute 'echo 42'
+
+  Both stderr and stdout can be redirected, and the exit_status of each command
+  is made available:
+
+      bash = Session::Bash.new
+      stdout, stderr = StringIO::new, StringIO::new
+
+      bash.execute 'ls', :stdout => stdout, :stderr => stderr
+      # bash.execute 'ls', 1 => stdout, 2 => stderr           # same thing
+      # bash.execute 'ls', :o => stdout, :e => stderr         # same thing
+
+      exit_status = bash.exit_status
+
+  A block form can be used to specify a callback to be invoked whenever output
+  has become availible:
+
+    bash = Session::Bash.new
+
+    bash.execute( 'long_running_command.exe' ) do |out, err|
+      logger << out if out
+      elogger << err if err
+    end
+
+  Sessions are Thread safe (in the sense that they do not block on io
+  operations) allowing commands spawned from guis to update widgets with output
+  while running in the background.
+
+    button.configure 'action' => lambda do
+      sh = Session::new
+      sh.execute(cmd) do |o,e|
+        out_widget.update o if o
+        err_widget.update e if e
+      end
+    end
+
+SAMPLES: |
+
+  see samples/*
+
+HISTORY: |
+  3.1.0:
+    - patches from @headius
+
+  3.0.0
+    - move to github
+
+  2.4.0:
+    - added ability to specify stdin for Session::Bash and Session::Sh
+
+        sh = Session::new
+
+        sh.execute 'cat', :stdin => io
+        sh.execute 'cat', :stdin => string
+        sh.execute 'cat', :stdin => stringio
+
+  2.3.0:
+    - fixed warning of @debug being un-initialized
+
+  2.2.0:
+    - added a private munged version of Open3::open3.  the builtin one causes
+      the child process to become a child of init, this was very inconvenient
+      because it was sometimes hard to crawl proces trees - the parent was lost.
+      now the seesion is a child process that has been detached using
+      Process::detach.  this results in less suprising behaviour; for instance
+      sending signal TERM to a process results in any sessions it had open dying
+      as well.  you can use Session::use_open3=true or
+      ENV['SESSION_USE_OPEN3']='1' for the old behaviour if you need it.
+    - added Session::Bash::Login class.  this class opens a session which has
+      all the normal settings of a bash loging shell (.bashrc is sourced).  this
+      if often convenient as paths, aliases, etc. are set as normal.
+    - moved the Spawn module inside the Session module.  now the Session module
+      is the namespace for everything so using session pollutes namespace less.
+
+  2.1.9:
+    - fixed bug where setting track history after creation caused later failure in
+      execute (@history =[] only in ctor).  thanks leon breedt
+      <bitserf@gmail.com>!
+    - updates to README
+    - included session-x.x.x.rpa file - thanks batsman <batsman.geo@yahoo.com>
+    - to_str/to_s/to_yaml for History/Command is now valid yaml (updated samples
+      to reflect this)
+    - inspect for History/Command is now ruby's default 
+
+  2.1.8:
+    - greatly simplified read loop using two reader threads, one for stderr and
+      one for stdout alongside a mutex to protect data.  this streamlined the code
+      alot vs. the old select method including allowing removal of the linbuffer
+      class.  the interface remains exactly as before however.
+
+  2.1.7:
+    - improved thread safe non-blocking read method
+    - gemspec 
+
+  2.1.6:
+    - wrapped send_command in a Thread (send async) so output processing can
+      commend immeadiately.  this was o.k. before, but had strange behaviour when
+      using popen3 from threads.  thanks to tanaka akira for this suggestion.
+    - iff ENV['SESSION_USE_SPAWN'] is set Session uses Spawn::spawn instead of
+      Open3::popen3.  also noted that spawn seems to be a bit faster.
+    - added tests for threads.
+    - run 'sh SESSION_USE_SPAWN=1 ruby test/session.rb' to test using spawn
+    - added test for idl so it's test is not run if system doesn't have it, all
+      that should be required for 'ruby test/session.rb' is should be sh'
+    - removed sample/tcsh and note about Tcsh and Csh in README - stderr
+      redirection/separation is flaky in those shells
+
+  2.1.5:
+    - added Session.use_spawn=, AbstractSession.use_spawn=, and an :use_session=>
+      option to AbstractSession#initialize.  if any of them are set the code uses
+      Spawn::spawn to create external processes instead of Open3::popen3.
+      Spawn::spawn uses named pipes (fifos) for IPC instead of forking and pipes.
+      the fork used in popen3 can cause strange behaviour with multi-threaded apps
+      (like a tk app).  see source for details
+
+  2.1.4:
+    - added Thread.exclusive{} wrapper when io is read to works in multi
+      threaded apps
+
+
+AUTHOR: |
+
+  ara.t.howard@noaa.gov

data/Rakefile

@@ -0,0 +1,233 @@
+
+This.rubyforge_project = 'codeforpeople'
+This.author = "Ara T. Howard"
+This.email = "ara.t.howard@gmail.com"
+This.homepage = "http://github.com/ahoward/#{ This.lib }/tree/master"
+
+
+task :default do
+  puts(Rake::Task.tasks.map{|task| task.name} - ['default'])
+end
+
+
+task :gemspec do
+  ignore_extensions = 'git', 'svn', 'tmp', /sw./, 'bak', 'gem'
+  ignore_directories = 'pkg'
+  ignore_files = 'test/log'
+
+  shiteless = 
+    lambda do |list|
+      list.delete_if do |entry|
+        next unless test(?e, entry)
+        extension = File.basename(entry).split(%r/[.]/).last
+        ignore_extensions.any?{|ext| ext === extension}
+      end
+      list.delete_if do |entry|
+        next unless test(?d, entry)
+        dirname = File.expand_path(entry)
+        ignore_directories.any?{|dir| File.expand_path(dir) == dirname}
+      end
+      list.delete_if do |entry|
+        next unless test(?f, entry)
+        filename = File.expand_path(entry)
+        ignore_files.any?{|file| File.expand_path(file) == filename}
+      end
+    end
+
+  lib         = This.lib
+  object      = This.object
+  version     = This.version
+  files       = shiteless[Dir::glob("**/**")]
+  executables = shiteless[Dir::glob("bin/*")].map{|exe| File.basename(exe)}
+  has_rdoc    = true #File.exist?('doc')
+  test_files  = "test/#{ lib }.rb" if File.file?("test/#{ lib }.rb")
+  summary     = object.respond_to?(:summary) ? object.summary : "summary: #{ lib } kicks the ass"
+  description = object.respond_to?(:description) ? object.description : "description: #{ lib } kicks the ass"
+
+  extensions = This.extensions
+  if extensions.nil?
+    %w( Makefile configure extconf.rb ).each do |ext|
+      extensions << ext if File.exists?(ext)
+    end
+  end
+  extensions = [extensions].flatten.compact
+
+  template = 
+    if test(?e, 'gemspec.erb')
+      Template{ IO.read('gemspec.erb') }
+    else
+      Template {
+        <<-__
+          ## #{ lib }.gemspec
+          #
+
+          Gem::Specification::new do |spec|
+            spec.name = #{ lib.inspect }
+            spec.version = #{ version.inspect }
+            spec.platform = Gem::Platform::RUBY
+            spec.summary = #{ lib.inspect }
+            spec.description = #{ description.inspect }
+
+            spec.files = #{ files.inspect }
+            spec.executables = #{ executables.inspect }
+            
+            spec.require_path = "lib"
+
+            spec.has_rdoc = #{ has_rdoc.inspect }
+            spec.test_files = #{ test_files.inspect }
+            #spec.add_dependency 'lib', '>= version'
+            spec.add_dependency 'fattr'
+
+            spec.extensions.push(*#{ extensions.inspect })
+
+            spec.rubyforge_project = #{ This.rubyforge_project.inspect }
+            spec.author = #{ This.author.inspect }
+            spec.email = #{ This.email.inspect }
+            spec.homepage = #{ This.homepage.inspect }
+          end
+        __
+      }
+    end
+
+  open("#{ lib }.gemspec", "w"){|fd| fd.puts template}
+  This.gemspec = "#{ lib }.gemspec"
+end
+
+task :gem => [:clean, :gemspec] do
+  Fu.mkdir_p This.pkgdir
+  before = Dir['*.gem']
+  cmd = "gem build #{ This.gemspec }"
+  `#{ cmd }`
+  after = Dir['*.gem']
+  gem = ((after - before).first || after.first) or abort('no gem!')
+  Fu.mv gem, This.pkgdir
+  This.gem = File.basename(gem)
+end
+
+task :readme do
+  samples = ''
+  prompt = '~ > '
+  lib = This.lib
+  version = This.version
+
+  Dir['sample*/*'].sort.each do |sample|
+    samples << "\n" << "  <========< #{ sample } >========>" << "\n\n"
+
+    cmd = "cat #{ sample }"
+    samples << Util.indent(prompt + cmd, 2) << "\n\n"
+    samples << Util.indent(`#{ cmd }`, 4) << "\n"
+
+    cmd = "ruby #{ sample }"
+    samples << Util.indent(prompt + cmd, 2) << "\n\n"
+
+    cmd = "ruby -e'STDOUT.sync=true; exec %(ruby -I ./lib #{ sample })'"
+    samples << Util.indent(`#{ cmd } 2>&1`, 4) << "\n"
+  end
+
+  template = 
+    if test(?e, 'readme.erb')
+      Template{ IO.read('readme.erb') }
+    else
+      Template {
+        <<-__
+          NAME
+            #{ lib }
+
+          DESCRIPTION
+
+          INSTALL
+            gem install #{ lib }
+
+          SAMPLES
+            #{ samples }
+        __
+      }
+    end
+
+  open("README", "w"){|fd| fd.puts template}
+end
+
+
+task :clean do
+  Dir[File.join(This.pkgdir, '**/**')].each{|entry| Fu.rm_rf(entry)}
+end
+
+
+task :release => [:clean, :gemspec, :gem] do
+  gems = Dir[File.join(This.pkgdir, '*.gem')].flatten
+  raise "which one? : #{ gems.inspect }" if gems.size > 1
+  raise "no gems?" if gems.size < 1
+  cmd = "rubyforge login && rubyforge add_release #{ This.rubyforge_project } #{ This.lib } #{ This.version } #{ This.pkgdir }/#{ This.gem }"
+  puts cmd
+  system cmd
+end
+
+
+
+
+
+BEGIN {
+  $VERBOSE = nil
+
+  require 'ostruct'
+  require 'erb'
+  require 'fileutils'
+
+  Fu = FileUtils
+
+  This = OpenStruct.new
+
+  This.file = File.expand_path(__FILE__)
+  This.dir = File.dirname(This.file)
+  This.pkgdir = File.join(This.dir, 'pkg')
+
+  lib = ENV['LIB']
+  unless lib
+    lib = File.basename(Dir.pwd)
+  end
+  This.lib = lib
+
+  version = ENV['VERSION']
+  unless version
+    require "./lib/#{ This.lib }"
+    This.name = lib.capitalize
+    This.object = eval(This.name)
+    version = This.object.send(:version)
+  end
+  This.version = version
+
+  abort('no lib') unless This.lib
+  abort('no version') unless This.version
+
+  module Util
+    def indent(s, n = 2)
+      s = unindent(s)
+      ws = ' ' * n
+      s.gsub(%r/^/, ws)
+    end
+
+    def unindent(s)
+      indent = nil
+      s.each do |line|
+      next if line =~ %r/^\s*$/
+      indent = line[%r/^\s*/] and break
+    end
+    indent ? s.gsub(%r/^#{ indent }/, "") : s
+  end
+    extend self
+  end
+
+  class Template
+    def initialize(&block)
+      @block = block
+      @template = block.call.to_s
+    end
+    def expand(b=nil)
+      ERB.new(Util.unindent(@template)).result(b||@block)
+    end
+    alias_method 'to_s', 'expand'
+  end
+  def Template(*args, &block) Template.new(*args, &block) end
+
+  Dir.chdir(This.dir)
+}

data/gemspec.rb

@@ -0,0 +1,62 @@
+#! /usr/bin/env ruby
+
+lib, version, *ignored = ARGV
+
+unless lib
+  lib = File.basename(Dir.pwd)
+end
+
+unless version
+  mod = lib.capitalize
+  require "./lib/#{ lib }"
+  version = eval(mod).send(:version)
+end
+
+abort('no lib') unless lib
+abort('no version') unless version
+
+puts "### gemspec: #{ lib }-#{ version }"
+
+$VERBOSE = nil
+
+shiteless = lambda{|list| list.delete_if{|file| file =~ %r/\.(git|svn|tmp|sw.|bak)$/}}
+
+files       = shiteless[Dir::glob("**/**")]
+executables = shiteless[Dir::glob("bin/*")].map{|exe| File.basename(exe)}
+has_rdoc    = true #File.exist?('doc')
+test_files  = "test/#{ lib }.rb" if File.file?("test/#{ lib }.rb")
+
+extensions = []
+%w( Makefile configure extconf.rb rakefile Rakefile mkrf_conf ).each do |ext|
+  extensions << ext if File.exists?(ext)
+end
+
+template = <<-__
+
+  Gem::Specification::new do |spec|
+    spec.name = #{ lib.inspect }
+    spec.version = #{ version.inspect }
+    spec.platform = Gem::Platform::RUBY
+    spec.summary = #{ lib.inspect }
+
+    spec.files = #{ files.inspect }
+    spec.executables = #{ executables.inspect }
+    
+    spec.require_path = "lib"
+
+    spec.has_rdoc = #{ has_rdoc.inspect }
+    spec.test_files = #{ test_files.inspect }
+    #spec.add_dependency 'lib', '>= version'
+    #spec.add_dependency 'fattr'
+
+    spec.extensions.push(*#{ extensions.inspect })
+
+    spec.rubyforge_project = 'codeforpeople'
+    spec.author = "Ara T. Howard"
+    spec.email = "ara.t.howard@gmail.com"
+    spec.homepage = "http://github.com/ahoward/#{ lib }/tree/master"
+  end
+
+__
+
+puts template