pseudo-terminal 0.0.2

data/README.md

@@ -0,0 +1,32 @@
+Pseudo Terminal
+===============
+
+[![Travis CI Build Status](http://travis-ci.org/wenzowski/pseudo-terminal.png)](http://travis-ci.org/wenzowski/pseudo-terminal)
+
+This library wraps PTY to ease use of pseudo terminals on unix-based operating systems.
+
+Sample Workflow
+---------------
+
+Create a new pseudo terminal, write a command, process result, and close the process:
+
+    require 'pseudo-terminal'
+    pt = PseudoTerminal.new           # Create a new pseudo terminal.
+    puts pt << 'pwd'                  # Write command & print result.
+    pt.put('pwd') {|l| puts l}        # Write command & print each line when it appears on the pipe.
+    pt.close                          # Close pseudo terminal and halt process.
+
+
+Setup
+-----
+
+    gem install pseudo-terminal
+
+
+Meta
+----
+
+Created by Alexander Wenzowski
+
+
+Released under the [MIT license](http://www.opensource.org/licenses/mit-license.php).

data/bin/pseudo-terminal

@@ -0,0 +1,6 @@
+#!/usr/bin/env ruby
+
+lib = File.expand_path(File.dirname(__FILE__) + '/../lib')
+$LOAD_PATH.unshift(lib) if File.directory?(lib) && !$LOAD_PATH.include?(lib)
+
+require 'pseudo-terminal'

data/lib/pseudo-terminal.rb

@@ -0,0 +1,4 @@
+class PseudoTerminal
+  require 'pseudo-terminal/client'
+  include PseudoTerminal::Client
+end

data/lib/pseudo-terminal/buffer.rb

@@ -0,0 +1,58 @@
+require 'pseudo-terminal/string'
+
+class PseudoTerminal::Buffer
+  attr_accessor :masks, :raw, :lines, :segment
+
+  def initialize str_ready, masks=[]
+    @raw = ''
+    @segment = ''
+    @lines = []
+    @buff_a = []
+    @masks = masks
+    @ready = str_ready.to_s
+  end
+
+  def << str
+    buffer = str.to_s
+    @raw << buffer
+    process_raw(buffer)
+    # lines
+  end
+
+  private
+
+  def process_raw buffer
+    b = lines_from_raw(buffer)
+    b.each {|l| @lines << l}
+  end
+
+  def lines_from buffer
+    buffer.lines.to_a.each {|l| begin l.chomp! end while l.end_with_any? "\r\n".chars }
+  end
+
+  def lines_from_raw buffer
+    lines = lines_from buffer
+    lines = merge_line(lines) if !@segment.empty?
+    @segment << lines.pop if truncated
+    lines.each {|line| line.strip_ansi_escape_sequences!}
+    lines.each_with_index {|line, key| lines.delete_at key if line.match /^#{@ready}/}
+    @masks.each do |mask|
+      lines.each_with_index {|line, key| lines.delete_at key if line.match /^#{mask}/}
+    end
+    lines
+  end
+
+  def new_line
+    "\n"
+  end
+
+  def truncated
+    !@raw.end_with?(new_line) && !@raw.empty?
+  end
+
+  def merge_line buff_a
+    buff_a.first.prepend! @segment if buff_a.first
+    @segment = ''
+    buff_a
+  end
+end

data/lib/pseudo-terminal/client.rb

@@ -0,0 +1,68 @@
+require 'pty'
+require 'pseudo-terminal/buffer'
+
+module PseudoTerminal::Client
+  attr_accessor :r, :w, :b, :timeout
+
+  def initialize opt={}
+    opt[:ready] ||= '> '
+    opt[:sh] ||= "env PS1='#{opt[:ready]}' TERM=dumb sh -i"
+    opt[:timeout] ||= 1
+    @timeout = opt[:timeout]
+    @r, @w, @pid = PTY.spawn opt[:sh]
+    @b = PseudoTerminal::Buffer.new opt[:ready]
+    read
+    @b.masks << @b.lines.pop while @b.lines.empty? == false
+  end
+
+  def << command, &block
+    put command, &block
+  end
+
+  def put command, &block
+    @w.puts command
+    read &block
+  end
+
+  def is_running?
+    begin
+      Process.getpgid @pid
+      true
+    rescue Errno::ESRCH
+      false
+    end
+  end
+
+  def kill!
+    @r.close
+    @w.close
+    begin
+      Process.wait @pid
+    rescue PTY::ChildExited
+    end
+  end
+
+  def read &block
+    begin
+      read_loop &block
+    rescue IO::WaitReadable
+      t = IO.select([@r], nil, nil, @timeout)
+      retry unless t.nil?
+      @b.lines
+    rescue IOError
+      nil
+    end
+  end
+
+  private
+
+  def read_loop &block
+    begin
+      if block_given?
+        (@b << @r.read_nonblock(1024)).each {|line| yield(line)}
+      else
+        @b << @r.read_nonblock(1024)
+      end
+    end while true
+  end
+end

data/lib/pseudo-terminal/string.rb

@@ -0,0 +1,16 @@
+class String
+  def prepend! s
+    self.insert 0, s
+  end
+
+  def end_with_any? arr
+    r = false
+    arr.each {|str| r = true if self.end_with? str }
+    r
+  end
+
+  def strip_ansi_escape_sequences!
+    self.gsub!(/\e\]\d;(.*)\a/, '')
+    self.gsub!(/\e\[[^m]*m/, '')
+  end
+end

data/lib/pseudo-terminal/version.rb

@@ -0,0 +1,3 @@
+class PseudoTerminal
+  VERSION = "0.0.2"
+end

data/spec/pseudo-terminal/buffer_spec.rb

@@ -0,0 +1,50 @@
+require "spec_helper"
+require "pseudo-terminal/buffer"
+
+describe PseudoTerminal::Buffer do
+  it 'should be instantiated without arguments' do
+    lambda { t = PseudoTerminal::Buffer.new(ready='> ') }.should_not raise_error
+    lambda { t = PseudoTerminal::Buffer.new(ready='', mask=[]) }.should_not raise_error
+    lambda { t = PseudoTerminal::Buffer.new }.should raise_error
+  end
+
+  context 'when string appended to buffer' do
+    before :each do
+      @ready='> '
+      @b = PseudoTerminal::Buffer.new @ready
+    end
+
+    it 'is empty' do
+      (@b << '').should be_kind_of(Array)
+      (@b << '').should be_empty
+    end
+
+    it 'is ready' do
+      (@b << @ready).should be_empty
+    end
+
+    it 'has masked lines' do
+      @b.masks = ['error line 1', 'error line 2']
+      masks_str = ''
+      @b.masks.each {|mask| masks_str << "#{mask}\r\n"}
+      (@b << masks_str).should == []
+    end
+
+    it 'contains newline (\r\n)' do
+      (@b << "str\r\n").should == ['str']
+    end
+
+    it 'is truncated' do
+      (@b << '1').should be_empty
+      (@b << '2').should be_empty
+      (@b << "3\r\n").should == ['123']
+    end
+
+    it 'lines are stored' do
+      (@b << "a\r\nb\r\nc\r\n").should == ['a','b','c']
+      (@b << "1\r\n2\r\n3\r\n").should == ['1','2','3']
+      @b.lines.should == ['a','b','c','1','2','3']
+      @b.raw.should == "a\r\nb\r\nc\r\n1\r\n2\r\n3\r\n"
+    end
+  end
+end

data/spec/pseudo-terminal/client_spec.rb

@@ -0,0 +1,45 @@
+require "spec_helper"
+require "pseudo-terminal"
+
+describe PseudoTerminal do
+  it 'should be instantiated without failures' do
+    lambda { t = PseudoTerminal.new; t.kill! }.should_not raise_error
+    lambda { t = PseudoTerminal.new({}); t.kill! }.should_not raise_error
+    lambda { t = PseudoTerminal.new(1); t.kill! }.should raise_error
+    lambda { t = PseudoTerminal.new(''); t.kill! }.should raise_error
+    lambda { t = PseudoTerminal.new([]); t.kill! }.should raise_error
+  end
+
+  context 'terminal' do
+    t = PseudoTerminal.new
+    it 'is running' do
+      t.is_running?.should be_true
+    end
+    it 'is killed' do
+      t.kill!
+      t.is_running?.should be_false
+    end
+  end
+
+  context 'when spawned terminal' do
+    before :each do
+      @t = PseudoTerminal.new timeout: 0.1
+    end
+
+    after :each do
+      @t.kill!
+    end
+
+    it 'has not been written to' do
+      @t.read.should be_empty
+    end
+
+    it 'has a command written to it' do
+      (@t << 'pwd').first.should == Dir.pwd
+    end
+
+    it 'has a command written to it while a block is passed to it' do
+      @t.put('pwd') {|line| line.should == Dir.pwd}
+    end
+  end
+end

data/spec/pseudo-terminal/string_spec.rb

@@ -0,0 +1,30 @@
+require "spec_helper"
+require "pseudo-terminal/string"
+
+describe String do
+  it 'string.prepend!' do
+    s = 'def'
+    s.prepend! 'abc'
+    s.should == 'abcdef'
+  end
+
+  context 'does str end with' do
+    it 'null' do
+      'abc'.end_with_any?([]).should == false
+      ''.end_with_any?(['abc']).should == false
+    end
+    it 'single-character' do
+      'abc'.end_with_any?(['c']).should == true
+      'abc'.end_with_any?(['b']).should == false
+    end
+    it 'multi-character string' do
+      'abc'.end_with_any?(['bc']).should == true
+      'abc'.end_with_any?(['ab']).should == false
+    end
+  end
+  it 'strips ansi escape codes from string' do
+    s = "\e[34mtesting\e[39;49m\e[0m/\r\n\e]7;file://Alexanders-MacBook-Pro.local/private/tmp/refinerycms\a\e]7;file://Alexanders-MacBook-Pro.local/private/tmp/refinerycms\a\e[0;31m4805\e[0m \xE2\x98\x85 \e[1;30m01:13\e[0m \xE2\x98\x85 \e[0;32muser\e[0m@\e[0;32mdomain.com\e[0m:\e[0;36m~/code/pseudo-terminal\e[0m (\e[1;33mmaster\e[0m) \r\r\n\xC2\xBB "
+    s.strip_ansi_escape_sequences!
+    s.should == "testing/\r\n4805 \xE2\x98\x85 01:13 \xE2\x98\x85 user@domain.com:~/code/pseudo-terminal (master) \r\r\n\xC2\xBB "
+  end
+end

data/spec/spec.opts

@@ -0,0 +1 @@
+--color

data/spec/spec_helper.rb

@@ -0,0 +1,18 @@
+require "rubygems"
+require "bundler/setup"
+
+require "simplecov"
+SimpleCov.start do
+  add_filter "/spec/"
+end
+
+require "rspec"
+require "rr"
+require "support/display_message_matcher"
+
+RSpec.configure do |config|
+  config.color_enabled = true
+  config.include DisplayMessageMatcher
+  config.after { RR.reset }
+end
+

data/spec/support/display_message_matcher.rb

@@ -0,0 +1,49 @@
+module DisplayMessageMatcher
+
+  def display_message(command, message)
+    DisplayMessageMatcher::DisplayMessage.new command, message
+  end
+
+  class DisplayMessage
+    def initialize(command, message)
+      @command = command
+      @message = message
+    end
+
+    def matches?(given_proc)
+      displayed_expected_message = false
+      @given_messages = []
+
+      @command.should_receive(:display).
+        any_number_of_times do |message, newline|
+        @given_messages << message
+        displayed_expected_message = displayed_expected_message ||
+          message == @message
+      end
+
+      given_proc.call
+
+      displayed_expected_message
+    end
+
+    def failure_message
+      "expected #{ @command } to display the message #{ @message.inspect } but #{ given_messages }"
+    end
+
+    def negative_failure_message
+      "expected #{ @command } to not display the message #{ @message.inspect } but it was displayed"
+    end
+
+    private
+
+      def given_messages
+        if @given_messages.empty?
+          'no messages were displayed'
+        else
+          formatted_given_messages = @given_messages.map(&:inspect).join ', '
+          "the follow messages were displayed: #{ formatted_given_messages }"
+        end
+      end
+
+  end
+end

metadata

@@ -0,0 +1,58 @@
+--- !ruby/object:Gem::Specification
+name: pseudo-terminal
+version: !ruby/object:Gem::Version
+  version: 0.0.2
+  prerelease: 
+platform: ruby
+authors:
+- Alexander Wenzowski
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2011-08-23 00:00:00.000000000Z
+dependencies: []
+description: Pseudo terminal library to ease interaction with PTY.
+email: alexander@wenzowski.com
+executables:
+- pseudo-terminal
+extensions: []
+extra_rdoc_files: []
+files:
+- README.md
+- bin/pseudo-terminal
+- lib/pseudo-terminal.rb
+- lib/pseudo-terminal/buffer.rb
+- lib/pseudo-terminal/client.rb
+- lib/pseudo-terminal/string.rb
+- lib/pseudo-terminal/version.rb
+- spec/pseudo-terminal/buffer_spec.rb
+- spec/pseudo-terminal/client_spec.rb
+- spec/pseudo-terminal/string_spec.rb
+- spec/spec.opts
+- spec/spec_helper.rb
+- spec/support/display_message_matcher.rb
+homepage: http://github.com/wenzowski/pseudo-terminal
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.6
+signing_key: 
+specification_version: 3
+summary: Pseudo terminal built on PTY.
+test_files: []