ttytest2 0.9.8 → 0.9.10

data/examples/canonical_integration_tests.rb

@@ -1,85 +1,85 @@
-#!/usr/bin/env ruby
-# frozen_string_literal: true
-
-# example testing a noncanonical shell, ncsh
-
-require 'ttytest'
-
-START_COL = 19
-
-def assert_check_new_row(row)
-  @tty.assert_row_starts_with(row, "#{ENV['USER']}:")
-  @tty.assert_row_like(row, 'ncsh')
-  @tty.assert_row_ends_with(row, '$')
-  @tty.assert_cursor_position(START_COL, row)
-end
-
-@tty = TTYtest.new_terminal(%(PS1='$ ' ./bin/ncsh), width: 80, height: 24)
-
-row = 0
-
-# # # # Basic Tests # # # #
-puts 'Starting basic tests'
-
-@tty.assert_row_starts_with(row, 'ncsh: startup time: ')
-row += 1
-
-assert_check_new_row(row)
-@tty.send_keys(%(ls))
-@tty.assert_cursor_position(START_COL + 2, 1)
-@tty.send_newline
-@tty.assert_row_ends_with(row, 'ls')
-row += 1
-@tty.assert_row_starts_with(row, 'LICENSE')
-row = 9
-
-assert_check_new_row(row)
-@tty.send_keys(%(echo hello))
-@tty.send_newline
-row += 1
-@tty.assert_row(row, 'hello')
-row += 1
-
-assert_check_new_row(row)
-@tty.send_keys(%(lss)) # send a bad command
-@tty.send_newline
-row += 1
-@tty.assert_row(row, 'ncsh: Could not find command or directory: No such file or directory')
-row += 1
-
-puts 'Starting backspace tests'
-
-# end of line backspace
-assert_check_new_row(row)
-@tty.send_keys(%(l))
-@tty.send_backspace
-assert_check_new_row(row)
-
-# multiple end of line backspaces
-@tty.send_keys(%(lsssss))
-@tty.send_backspaces(4)
-@tty.assert_row_ends_with(row, 'ls')
-@tty.send_backspaces(2)
-@tty.send_keys(%(echo hello)) # make sure buffer is properly formed after backspaces
-@tty.send_newline
-row += 1
-@tty.assert_row(row, 'hello')
-row += 1
-
-# midline backspace
-assert_check_new_row(row)
-@tty.send_keys(%(lsssss))
-@tty.assert_cursor_position(START_COL + 6, row)
-@tty.send_left_arrows(2)
-@tty.assert_cursor_position(START_COL + 4, row)
-@tty.send_backspaces(4)
-@tty.assert_cursor_position(START_COL, row)
-@tty.assert_row_ends_with(row, '$ ss')
-@tty.send_right_arrows(2)
-@tty.assert_cursor_position(START_COL + 2, row)
-@tty.send_backspaces(2)
-@tty.assert_cursor_position(START_COL, row)
-@tty.send_keys(%(echo hello)) # make sure buffer is properly formed after backspaces
-@tty.send_newline
-row += 1
-@tty.assert_row(row, 'hello')
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+# example testing a noncanonical shell, ncsh
+
+require 'ttytest'
+
+START_COL = 19
+
+def assert_check_new_row(row)
+  @tty.assert_row_starts_with(row, "#{ENV['USER']}:")
+  @tty.assert_row_like(row, 'ncsh')
+  @tty.assert_row_ends_with(row, '$')
+  @tty.assert_cursor_position(START_COL, row)
+end
+
+@tty = TTYtest.new_terminal(%(PS1='$ ' ./bin/ncsh), width: 80, height: 24)
+
+row = 0
+
+# # # # Basic Tests # # # #
+puts 'Starting basic tests'
+
+@tty.assert_row_starts_with(row, 'ncsh: startup time: ')
+row += 1
+
+assert_check_new_row(row)
+@tty.send_keys(%(ls))
+@tty.assert_cursor_position(START_COL + 2, 1)
+@tty.send_newline
+@tty.assert_row_ends_with(row, 'ls')
+row += 1
+@tty.assert_row_starts_with(row, 'LICENSE')
+row = 9
+
+assert_check_new_row(row)
+@tty.send_keys(%(echo hello))
+@tty.send_newline
+row += 1
+@tty.assert_row(row, 'hello')
+row += 1
+
+assert_check_new_row(row)
+@tty.send_keys(%(lss)) # send a bad command
+@tty.send_newline
+row += 1
+@tty.assert_row(row, 'ncsh: Could not find command or directory: No such file or directory')
+row += 1
+
+puts 'Starting backspace tests'
+
+# end of line backspace
+assert_check_new_row(row)
+@tty.send_keys(%(l))
+@tty.send_backspace
+assert_check_new_row(row)
+
+# multiple end of line backspaces
+@tty.send_keys(%(lsssss))
+@tty.send_backspaces(4)
+@tty.assert_row_ends_with(row, 'ls')
+@tty.send_backspaces(2)
+@tty.send_keys(%(echo hello)) # make sure buffer is properly formed after backspaces
+@tty.send_newline
+row += 1
+@tty.assert_row(row, 'hello')
+row += 1
+
+# midline backspace
+assert_check_new_row(row)
+@tty.send_keys(%(lsssss))
+@tty.assert_cursor_position(START_COL + 6, row)
+@tty.send_left_arrows(2)
+@tty.assert_cursor_position(START_COL + 4, row)
+@tty.send_backspaces(4)
+@tty.assert_cursor_position(START_COL, row)
+@tty.assert_row_ends_with(row, '$ ss')
+@tty.send_right_arrows(2)
+@tty.assert_cursor_position(START_COL + 2, row)
+@tty.send_backspaces(2)
+@tty.assert_cursor_position(START_COL, row)
+@tty.send_keys(%(echo hello)) # make sure buffer is properly formed after backspaces
+@tty.send_newline
+row += 1
+@tty.assert_row(row, 'hello')

data/examples/noncanonical_integration_tests.rb

@@ -1,80 +1,80 @@
-#!/usr/bin/env ruby
-# frozen_string_literal: true
-
-# example testing a canonical shell called shl
-
-require 'ttytest'
-
-START_COL = 19
-
-def assert_check_new_row(row)
-  @tty.assert_row_starts_with(row, "#{ENV['USER']}:")
-  @tty.assert_row_like(row, 'shl')
-  @tty.assert_row_ends_with(row, '$')
-  @tty.assert_cursor_position(START_COL, row)
-end
-
-@tty = TTYtest.new_terminal(%(PS1='$ ' ./bin/shl), width: 80, height: 24)
-
-row = 0
-
-@tty.assert_row_starts_with(row, 'shl: startup time: ')
-row += 1
-
-assert_check_new_row(row)
-@tty.send_keys_one_at_a_time(%(ls))
-@tty.assert_cursor_position(START_COL + 2, 1)
-@tty.send_newline
-@tty.assert_row_ends_with(row, 'ls')
-row += 1
-@tty.assert_row_starts_with(row, 'LICENSE')
-row = 9
-
-assert_check_new_row(row)
-@tty.send_keys_one_at_a_time(%(echo hello))
-@tty.send_newline
-row += 1
-@tty.assert_row(row, 'hello')
-row += 1
-
-assert_check_new_row(row)
-@tty.send_keys_one_at_a_time(%(lss)) # send a bad command
-@tty.send_newline
-row += 1
-@tty.assert_row(row, 'shl: Could not find command or directory: No such file or directory')
-row += 1
-
-# end of line backspace
-assert_check_new_row(row)
-@tty.send_keys_one_at_a_time(%(l))
-@tty.send_backspace
-assert_check_new_row(row)
-
-# multiple end of line backspaces
-@tty.send_keys_one_at_a_time(%(lsssss))
-@tty.send_backspaces(4)
-@tty.assert_row_ends_with(row, '$ ls')
-@tty.send_backspaces(2)
-@tty.send_keys_one_at_a_time(%(echo hello)) # make sure buffer is properly formed after backspaces
-@tty.send_newline
-row += 1
-@tty.assert_row(row, 'hello')
-row += 1
-
-# midline backspace
-assert_check_new_row(row)
-@tty.send_keys_one_at_a_time(%(lsssss))
-@tty.assert_cursor_position(START_COL + 6, row)
-@tty.send_left_arrows(2)
-@tty.assert_cursor_position(START_COL + 4, row)
-@tty.send_backspaces(4)
-@tty.assert_cursor_position(START_COL, row)
-@tty.assert_row_ends_with(row, '$ ss')
-@tty.send_right_arrows(2)
-@tty.assert_cursor_position(START_COL + 2, row)
-@tty.send_backspaces(2)
-@tty.assert_cursor_position(START_COL, row)
-@tty.send_keys_one_at_a_time(%(echo hello)) # make sure buffer is properly formed after backspaces
-@tty.send_newline
-row += 1
-@tty.assert_row(row, 'hello')
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+# example testing a canonical shell called shl
+
+require 'ttytest'
+
+START_COL = 19
+
+def assert_check_new_row(row)
+  @tty.assert_row_starts_with(row, "#{ENV['USER']}:")
+  @tty.assert_row_like(row, 'shl')
+  @tty.assert_row_ends_with(row, '$')
+  @tty.assert_cursor_position(START_COL, row)
+end
+
+@tty = TTYtest.new_terminal(%(PS1='$ ' ./bin/shl), width: 80, height: 24)
+
+row = 0
+
+@tty.assert_row_starts_with(row, 'shl: startup time: ')
+row += 1
+
+assert_check_new_row(row)
+@tty.send_keys_one_at_a_time(%(ls))
+@tty.assert_cursor_position(START_COL + 2, 1)
+@tty.send_newline
+@tty.assert_row_ends_with(row, 'ls')
+row += 1
+@tty.assert_row_starts_with(row, 'LICENSE')
+row = 9
+
+assert_check_new_row(row)
+@tty.send_keys_one_at_a_time(%(echo hello))
+@tty.send_newline
+row += 1
+@tty.assert_row(row, 'hello')
+row += 1
+
+assert_check_new_row(row)
+@tty.send_keys_one_at_a_time(%(lss)) # send a bad command
+@tty.send_newline
+row += 1
+@tty.assert_row(row, 'shl: Could not find command or directory: No such file or directory')
+row += 1
+
+# end of line backspace
+assert_check_new_row(row)
+@tty.send_keys_one_at_a_time(%(l))
+@tty.send_backspace
+assert_check_new_row(row)
+
+# multiple end of line backspaces
+@tty.send_keys_one_at_a_time(%(lsssss))
+@tty.send_backspaces(4)
+@tty.assert_row_ends_with(row, '$ ls')
+@tty.send_backspaces(2)
+@tty.send_keys_one_at_a_time(%(echo hello)) # make sure buffer is properly formed after backspaces
+@tty.send_newline
+row += 1
+@tty.assert_row(row, 'hello')
+row += 1
+
+# midline backspace
+assert_check_new_row(row)
+@tty.send_keys_one_at_a_time(%(lsssss))
+@tty.assert_cursor_position(START_COL + 6, row)
+@tty.send_left_arrows(2)
+@tty.assert_cursor_position(START_COL + 4, row)
+@tty.send_backspaces(4)
+@tty.assert_cursor_position(START_COL, row)
+@tty.assert_row_ends_with(row, '$ ss')
+@tty.send_right_arrows(2)
+@tty.assert_cursor_position(START_COL + 2, row)
+@tty.send_backspaces(2)
+@tty.assert_cursor_position(START_COL, row)
+@tty.send_keys_one_at_a_time(%(echo hello)) # make sure buffer is properly formed after backspaces
+@tty.send_newline
+row += 1
+@tty.assert_row(row, 'hello')

data/lib/ttytest/capture.rb

@@ -1,64 +1,64 @@
-# frozen_string_literal: true
-
-module TTYtest
-  # Represents the complete state of a {TTYtest::Terminal} at the time it was captured (contents, cursor position, etc).
-  # @attr_reader [Integer] width the number of columns in the captured terminal
-  # @attr_reader [Integer] height the number of rows in the captured terminal
-  # @attr_reader [Integer] cursor_x the cursor's column (starting at 0) in the captured terminal
-  # @attr_reader [Integer] cursor_y the cursor's row (starting at 0) in the captured terminal
-  class Capture
-    include TTYtest::Matchers
-
-    attr_reader :cursor_x, :cursor_y, :width, :height
-
-    # Used internally by drivers when called by {Terminal#capture}
-    # @api private
-    def initialize(contents, cursor_x: 0, cursor_y: 0, width: nil, height: nil, cursor_visible: true)
-      @rows = "#{contents}\nEND".split("\n")[0...-1].map do |row|
-        row || ''
-      end
-      @cursor_x = cursor_x
-      @cursor_y = cursor_y
-      @width = width
-      @height = height
-      @cursor_visible = cursor_visible
-    end
-
-    # @return [Array<String>] An array of each row's contend from the captured terminal
-    attr_reader :rows
-
-    # @param [Integer] the row to return
-    # @return [String] the content of the row from the captured terminal
-    def row(row_number)
-      rows[row_number]
-    end
-
-    # @return [true,false] Whether the cursor is visible in the captured terminal
-    def cursor_visible?
-      @cursor_visible
-    end
-
-    # @return [true,false] Whether the cursor is hidden in the captured terminal
-    def cursor_hidden?
-      !cursor_visible?
-    end
-
-    # @return [Capture] returns self
-    def capture
-      self
-    end
-
-    def print
-      puts "\n#{self}"
-    end
-
-    def print_rows
-      p rows
-    end
-
-    # @return [String] All rows of the captured terminal, separated by newlines
-    def to_s
-      rows.join("\n")
-    end
-  end
-end
+# frozen_string_literal: true
+
+module TTYtest
+  # Represents the complete state of a {TTYtest::Terminal} at the time it was captured (contents, cursor position, etc).
+  # @attr_reader [Integer] width the number of columns in the captured terminal
+  # @attr_reader [Integer] height the number of rows in the captured terminal
+  # @attr_reader [Integer] cursor_x the cursor's column (starting at 0) in the captured terminal
+  # @attr_reader [Integer] cursor_y the cursor's row (starting at 0) in the captured terminal
+  class Capture
+    include TTYtest::Matchers
+
+    attr_reader :cursor_x, :cursor_y, :width, :height
+
+    # Used internally by drivers when called by {Terminal#capture}
+    # @api private
+    def initialize(contents, cursor_x: 0, cursor_y: 0, width: nil, height: nil, cursor_visible: true)
+      @rows = "#{contents}\nEND".split("\n")[0...-1].map do |row|
+        row || ''
+      end
+      @cursor_x = cursor_x
+      @cursor_y = cursor_y
+      @width = width
+      @height = height
+      @cursor_visible = cursor_visible
+    end
+
+    # @return [Array<String>] An array of each row's contend from the captured terminal
+    attr_reader :rows
+
+    # @param [Integer] the row to return
+    # @return [String] the content of the row from the captured terminal
+    def row(row_number)
+      rows[row_number]
+    end
+
+    # @return [true,false] Whether the cursor is visible in the captured terminal
+    def cursor_visible?
+      @cursor_visible
+    end
+
+    # @return [true,false] Whether the cursor is hidden in the captured terminal
+    def cursor_hidden?
+      !cursor_visible?
+    end
+
+    # @return [Capture] returns self
+    def capture
+      self
+    end
+
+    def print
+      puts "\n#{self}"
+    end
+
+    def print_rows
+      p rows
+    end
+
+    # @return [String] All rows of the captured terminal, separated by newlines
+    def to_s
+      rows.join("\n")
+    end
+  end
+end

data/lib/ttytest/constants.rb

@@ -1,18 +1,31 @@
-# frozen_string_literal: true
-
-# some constants that can be used with send_keys, just to help out people creating tests
-module TTYtest
-  BACKSPACE = 127.chr
-  TAB = 9.chr
-  CTRLF = 6.chr
-  CTRLC = 3.chr
-  CTRLD = '\004'
-  ESCAPE = 27.chr
-
-  UP_ARROW = "#{ESCAPE}[A".freeze
-  DOWN_ARROW = "#{ESCAPE}[B".freeze
-  RIGHT_ARROW = "#{ESCAPE}[C".freeze
-  LEFT_ARROW = "#{ESCAPE}[D".freeze
-
-  CLEAR = "#{ESCAPE}[2J".freeze
-end
+# frozen_string_literal: true
+
+# some constants that can be used with send_keys, just to help out people creating tests
+module TTYtest
+  CTRLA = 1.chr
+  CTRLB = 2.chr
+  CTRLC = 3.chr
+  CTRLD = 4.chr
+  CTRLF = 6.chr
+  BELL = 7.chr
+  BACKSPACE = 8.chr
+  TAB = 9.chr # \t
+  NEWLINE = 10.chr # \n
+  VERTICAL_TAB = 11.chr # \v
+  FORM_FEED = 12.chr # \f
+  CARRIAGE_RETURN = 13.chr # \r
+  CTRLU = 21.chr
+  CTRLW = 23.chr
+  ESCAPE = 27.chr # ^[ or /033 or /e
+  DELETE = 127.chr
+
+  UP_ARROW = "#{ESCAPE}[A".freeze
+  DOWN_ARROW = "#{ESCAPE}[B".freeze
+  RIGHT_ARROW = "#{ESCAPE}[C".freeze
+  LEFT_ARROW = "#{ESCAPE}[D".freeze
+
+  HOME_KEY = "#{ESCAPE}[H".freeze
+  END_KEY = "#{ESCAPE}[F".freeze
+
+  CLEAR = "#{ESCAPE}[2J".freeze
+end