scriptty 1.1.0-java → 1.2.0-java

data/VERSION

@@ -1 +1 @@
-1.1.0
+1.2.0

data/lib/scriptty/expect.rb

@@ -29,13 +29,17 @@ module ScripTTY
   class Expect
 
     # Methods to export to Evaluator
-    EXPORTED_METHODS = Set.new [:basedir, :init_term, :term, :connect, :screen, :expect, :on, :wait, :send, :send_password, :capture, :match, :push_patterns, :pop_patterns, :exit, :eval_script_file, :eval_script_inline, :sleep, :set_basedir, :set_timeout, :load_screens, :print, :puts, :p, :pp ]
+    EXPORTED_METHODS = Set.new [:basedir, :init_term, :term, :connect, :screen, :expect, :on, :wait, :send, :send_password, :capture, :match, :push_patterns, :pop_patterns, :exit, :eval_script_file, :eval_script_inline, :sleep, :set_basedir, :set_timeout, :load_screens, :matched_screen, :matched_pattern, :print, :puts, :p, :pp ]
 
     attr_reader :term   # The terminal emulation object
 
     attr_reader :capture  # The last non-background captured fields.  For a ScreenPattern match, this is a Hash of fields.  For a String or Regexp match, this is a MatchData object.
     alias match capture   # "match" is the deprecated name for "capture"
 
+    attr_accessor :matched_pattern  # The last non-background pattern that matched (might be a RegExp or a ScreenPattern)
+
+    attr_accessor :matched_screen   # The last non-background ScreenPattern that matched.
+
     attr_accessor :transcript_writer # Set this to an instance of ScripTTY::Util::Transcript::Writer
     attr_accessor :transcript_writer_autoclose # Set this to false to disable closing transcript_writer on exit
 
@@ -58,6 +62,8 @@ module ScripTTY
       @transcript_writer_autoclose = options[:transcript_writer_autoclose].nil? ? true : options[:transcript_writer_autoclose]
       @screen_patterns = {}
       @basedir = "."
+      @matched_pattern = nil
+      @matched_screen = nil
     end
 
     # Get instance variable from the Evaluator
@@ -87,20 +93,10 @@ module ScripTTY
       nil
     end
 
-    # Return the expanded path relative to basedir
-    def expand_path(path)
-      base = Pathname.new(@basedir)
-      p = Pathname.new(path)
-      unless p.absolute?
-        p = base.join(p)
-      end
-      p.expand_path.to_s
-    end
-
     # Load and evaluate a script from a file.
     def eval_script_file(path)
       fail_unexpected_block if block_given?
-      path = expand_path(path)
+      path = File.expand_path(path, @basedir)
       eval_script_inline(File.read(path), path)
     end
 
@@ -200,7 +196,7 @@ module ScripTTY
       fail_unexpected_block if block_given?
       filenames_or_glob = filenames_or_glob.to_s if filenames_or_glob.is_a?(Pathname)
       if filenames_or_glob.is_a?(String)
-        filenames_or_glob = expand_path(filenames_or_glob)
+        filenames_or_glob = File.expand_path(filenames_or_glob, @basedir)
         filenames = Dir.glob(filenames_or_glob)
       elsif filenames_or_glob.is_a?(Array)
         filenames = filenames_or_glob
@@ -208,7 +204,7 @@ module ScripTTY
         raise ArgumentError.new("load_screens takes a string(glob) or an array, not #{filenames.class.name}")
       end
       filenames.each do |filename|
-        ScreenPattern.parse(File.read(filename)).each do |pattern|
+        ScreenPattern.parse(File.read(filename), filename).each do |pattern|
           @screen_patterns[pattern.name.to_sym] = pattern
         end
       end
@@ -441,6 +437,8 @@ module ScripTTY
 
             # Make the next wait() call return
             unless ph.background?
+              @matched_pattern = ph.pattern
+              @matched_screen = ph.pattern if ph.pattern.is_a?(ScreenPattern)
               @capture = m
               @wait_finished = true
               @net.suspend

data/lib/scriptty/request_dispatcher.rb

@@ -33,6 +33,9 @@ module ScripTTY
   # RequestDispatcher can be used, for example, to provide an HTTP interface to
   # functions of a screen-scraped terminal.
   class RequestDispatcher
+
+    class RequestCancelled < StandardError; end
+
     def initialize
       # Graceful shutdown flag
       @finishing_lock = Mutex.new
@@ -117,18 +120,27 @@ module ScripTTY
       def main
         loop do
           break if finishing?
-          begin
-            handle_one_request
-          rescue => exc
-            # Log & swallow exception
-            show_exception(exc)
-            close_expect rescue nil   # Ignore errors while closing the connection
-            sleep 0.5   # Delay just a tiny bit to keep an exception loop from consuming all available resources.
-          end
+          wrap_in_exception_handler(
+            :body => Proc.new {
+              handle_one_request
+            },
+            :rescue => Proc.new { |exc|
+              # Log & swallow exception
+              show_exception(exc)
+              close_expect rescue nil   # Ignore errors while closing the connection
+              sleep 0.5   # Delay just a tiny bit to keep an exception loop from consuming all available resources.
+            }
+          )
         end
         execute_hooks(:before_finish)
       ensure
         close_expect
+
+        # Clean up any remaining requests.
+        while (request = dequeue)
+          request[:exception] = RequestCancelled.new("main loop exited; request not executed")
+          signal_request_done(request)
+        end
       end
 
       def handle_one_request
@@ -140,22 +152,36 @@ module ScripTTY
 
         # Run the before_each_request hooks.  If an exception is raised,
         # put the request back on the queue before re-raising the error.
-        begin
-          execute_hooks(:before_each_request)
-        rescue
-          requeue(request)
-          raise
-        end
+        wrap_in_exception_handler(
+          :body => Proc.new {
+            execute_hooks(:before_each_request)
+          },
+          :rescue => Proc.new { |exc|
+            requeue(request)
+          },
+          :reraise => true
+        )
 
         # Execute the request
+        success = false
+        exception_caught = false
         begin
-          request[:result] = block_eval(request[:block_how], &request[:block])
-        rescue => exc
-          show_exception(exc, "in request")
-          request[:exception] = exc
-          close_expect rescue nil
+          wrap_in_exception_handler(
+            :body => Proc.new {
+              request[:result] = block_eval(request[:block_how], &request[:block])
+              success = true
+            },
+            :rescue => Proc.new { |exc|
+              show_exception(exc, "in request")
+              request[:exception] = exc
+              close_expect rescue nil
+              exception_caught = true
+            }
+          )
+        ensure
+          signal_request_done(request)
+          raise "RUBY BUG: No success and no exception caught: #{$ERROR_INFO.inspect}" unless success or exception_caught
         end
-        request[:cv_mutex].synchronize { request[:cv].signal }
 
         # Execute the after_each_request hooks.
         execute_hooks(:after_each_request)
@@ -235,7 +261,32 @@ module ScripTTY
         output = ["Exception #{context || "in #{self}"}: #{exc} (#{exc.class.name})"]
         output += exc.backtrace.map { |line| " #{line}" }
         $stderr.puts output.join("\n")
-        true    # true means to re-raise the exception
+      end
+
+      def signal_request_done(request)
+        request[:cv_mutex].synchronize { request[:cv].signal }
+      end
+
+      # XXX - Workaround for JRuby bug.
+      #
+      # Apparently, if we do this:
+      #
+      #   begin
+      #     # some code here
+      #   rescue Exception => exc
+      #     # handle
+      #   end
+      #
+      # Then other errors like SyntaxError and ArgumentError don't get caught
+      # when we do our block-passing-over-threads magic.  However, if we
+      # enumerate a bunch of exception classes, it seems to work.
+      def wrap_in_exception_handler(options={})
+        begin
+          options[:body].call
+        rescue Exception, ScriptError, SystemStackError, StandardError => exc
+          options[:rescue].call(exc) if options[:rescue]
+          raise if options[:reraise]
+        end
       end
   end
 end

data/lib/scriptty/screen_pattern/parser.rb

@@ -59,19 +59,20 @@ module ScripTTY
       RECOGNIZED_PROPERTIES = SINGLE_CHAR_PROPERTIES + TWO_TUPLE_PROPERTIES + %w( rectangle fields text )
 
       class <<self
-        def parse(s, &block)
-          new(s, &block).parse
+        def parse(s, filename=nil, lineno=nil, &block)
+          new(s, filename, lineno, &block).parse
           nil
         end
         protected :new    # Users should not instantiate this object directly
       end
 
-      def initialize(s, &block)
+      def initialize(s, filename=nil, lineno=nil, &block)
         raise ArgumentError.new("no block given") unless block
         @block = block
         @lines = preprocess(s).split("\n").map{|line| "#{line}\n"}
         @line = nil
-        @lineno = 0
+        @filename = filename
+        @lineno = (lineno||1) - 1
         @state = :start
       end
 
@@ -529,7 +530,8 @@ module ScripTTY
 
         def parse_fail(message=nil, line=nil)
           line ||= @lineno
-          raise ArgumentError.new("error:line #{line}: #{message || 'parse error'}")
+          f = @filename ? "#{@filename}:" : "line "
+          raise ArgumentError.new("error:#{f}#{line}: #{message || 'parse error'}")
         end
 
         # Pre-process an input string.

data/lib/scriptty/screen_pattern.rb

@@ -20,9 +20,9 @@ module ScripTTY
   class ScreenPattern
     class <<self
       # Parse a pattern file and return an array of ScreenPattern objects
-      def parse(s)
+      def parse(s, filename=nil, lineno=nil)
         retval = []
-        Parser.parse(s) do |spec|
+        Parser.parse(s, filename, lineno) do |spec|
           retval << new(spec[:name], spec[:properties])
         end
         retval

data/test/request_dispatcher_test.rb

@@ -0,0 +1,76 @@
+# = Tests for ScripTTY::RequestDispatcher
+# Copyright (C) 2010  Infonium Inc.
+#
+# This file is part of ScripTTY.
+#
+# ScripTTY is free software: you can redistribute it and/or modify
+# it under the terms of the GNU Lesser General Public License as published
+# by the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# ScripTTY is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU Lesser General Public License for more details.
+#
+# You should have received a copy of the GNU Lesser General Public License
+# along with ScripTTY.  If not, see <http://www.gnu.org/licenses/>.
+require File.dirname(__FILE__) + "/test_helper.rb"
+require 'scriptty/request_dispatcher'
+
+class RequestDispatcherTest < Test::Unit::TestCase
+
+  if !defined?(Java)
+    # This test gets executed when JRuby is not detected
+    def test_dummy_no_jruby
+      raise LoadError.new("Cannot test ScripTTY::RequestDispatcher: Not running under JRuby")
+    end
+
+  else  # defined?(Java)
+
+    def setup
+      @r = ScripTTY::RequestDispatcher.new
+    end
+
+    def teardown
+      @r.finish
+    end
+
+    def test_after_init
+      after_init_ran = false
+      @r.after_init { after_init_ran = true }
+      @r.start
+      sleep 0.2   # XXX - race condition
+      assert after_init_ran, "after_init hook should run"
+    end
+
+    def test_request
+      @r.start
+      assert_equal :success, @r.request { init_term "dg410"; :success }
+    end
+
+    def test_standard_exception_in_request
+      @r.instance_eval do
+        def show_exception(*args) end   # Silence exceptions
+      end
+
+      @r.start
+      assert_raise ArgumentError do
+        @r.request { raise ArgumentError.new("foo") }
+      end
+    end
+
+    def test_base_exception_in_request
+      @r.instance_eval do
+        def show_exception(*args) end   # Silence exceptions
+      end
+
+      @r.start
+      assert_raise SyntaxError do
+        @r.request { eval("*") }
+      end
+    end
+
+  end
+end
+

metadata

@@ -4,9 +4,9 @@ version: !ruby/object:Gem::Version
   prerelease: false
   segments: 
     - 1
-    - 1
+    - 2
     - 0
-  version: 1.1.0
+  version: 1.2.0
 platform: java
 authors: 
   - Dwayne Litzenberger
@@ -14,7 +14,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-05-13 00:00:00 -04:00
+date: 2010-05-15 00:00:00 -04:00
 default_executable: 
 dependencies: 
   - !ruby/object:Gem::Dependency 
@@ -119,6 +119,7 @@ files:
   - test/fsm_test.rb
   - test/multiline_buffer_test.rb
   - test/net/event_loop_test.rb
+  - test/request_dispatcher_test.rb
   - test/screen_pattern/generator_test.rb
   - test/screen_pattern/parser_test.rb
   - test/screen_pattern/parser_test/explicit_cursor_pattern.txt
@@ -172,6 +173,7 @@ test_files:
   - test/fsm_definition_parser_test.rb
   - test/fsm_test.rb
   - test/multiline_buffer_test.rb
+  - test/request_dispatcher_test.rb
   - test/test_helper.rb
   - test/apps/capture_app_test.rb
   - test/apps/transcript_parse_app_test.rb