ttytest2 0.9.8 → 0.9.9

data/lib/ttytest/tmux/driver.rb

@@ -1,79 +1,79 @@
-# frozen_string_literal: true
-
-require 'open3'
-require 'securerandom'
-
-require 'ttytest/terminal'
-require 'ttytest/tmux/session'
-
-module TTYtest
-  module Tmux
-    # tmux driver
-    class Driver
-      COMMAND = 'tmux'
-      SOCKET_NAME = 'ttytest'
-      REQUIRED_TMUX_VERSION = '1.8'
-      DEFAULT_CONFING_FILE_PATH = File.expand_path('tmux.conf', __dir__)
-      SLEEP_INFINITY = 'read x < /dev/fd/1'
-
-      class TmuxError < StandardError; end
-
-      def initialize(
-        debug: false,
-        command: COMMAND,
-        socket_name: SOCKET_NAME,
-        config_file_path: DEFAULT_CONFING_FILE_PATH
-      )
-        @debug = debug
-        @tmux_cmd = command
-        @socket_name = socket_name
-        @config_file_path = config_file_path
-      end
-
-      def new_terminal(cmd, width: 80, height: 24)
-        cmd = "#{cmd}\n#{SLEEP_INFINITY}"
-
-        session_name = "ttytest-#{SecureRandom.uuid}"
-        tmux(*%W[-f #{@config_file_path} new-session -s #{session_name} -d -x #{width} -y #{height} #{cmd}])
-        session = Session.new(self, session_name)
-        Terminal.new(session)
-      end
-
-      # @api private
-      def tmux(*args)
-        ensure_available
-        puts "tmux(#{args.inspect[1...-1]})" if debug?
-
-        stdout, stderr, status = Open3.capture3(@tmux_cmd, '-L', SOCKET_NAME, *args)
-        raise TmuxError, "tmux(#{args.inspect[1...-1]}) failed\n#{stderr}" unless status.success?
-
-        stdout
-      end
-
-      def available?
-        return false unless tmux_version
-
-        @available ||= (Gem::Version.new(tmux_version) >= Gem::Version.new(REQUIRED_TMUX_VERSION))
-      end
-
-      private
-
-      def debug?
-        @debug
-      end
-
-      def ensure_available
-        return if available?
-        raise TmuxError, 'Running `tmux -V` to determine version failed. Is tmux installed?' unless tmux_version
-
-        raise TmuxError, "tmux version #{tmux_version} does not meet requirement >= #{REQUIRED_TMUX_VERSION}"
-      end
-
-      def tmux_version
-        @tmux_version ||= `#{@tmux_cmd} -V`[/tmux (\d+.\d+)/, 1]
-      rescue Errno::ENOENT
-        nil
-      end
-    end
-  end
-end
+# frozen_string_literal: true
+
+require 'open3'
+require 'securerandom'
+
+require 'ttytest/terminal'
+require 'ttytest/tmux/session'
+
+module TTYtest
+  module Tmux
+    # tmux driver
+    class Driver
+      COMMAND = 'tmux'
+      SOCKET_NAME = 'ttytest'
+      REQUIRED_TMUX_VERSION = '1.8'
+      DEFAULT_CONFING_FILE_PATH = File.expand_path('tmux.conf', __dir__)
+      SLEEP_INFINITY = 'read x < /dev/fd/1'
+
+      class TmuxError < StandardError; end
+
+      def initialize(
+        debug: false,
+        command: COMMAND,
+        socket_name: SOCKET_NAME,
+        config_file_path: DEFAULT_CONFING_FILE_PATH
+      )
+        @debug = debug
+        @tmux_cmd = command
+        @socket_name = socket_name
+        @config_file_path = config_file_path
+      end
+
+      def new_terminal(cmd, width: 80, height: 24)
+        cmd = "#{cmd}\n#{SLEEP_INFINITY}"
+
+        session_name = "ttytest-#{SecureRandom.uuid}"
+        tmux(*%W[-f #{@config_file_path} new-session -s #{session_name} -d -x #{width} -y #{height} #{cmd}])
+        session = Session.new(self, session_name)
+        Terminal.new(session)
+      end
+
+      # @api private
+      def tmux(*args)
+        ensure_available
+        puts "tmux(#{args.inspect[1...-1]})" if debug?
+
+        stdout, stderr, status = Open3.capture3(@tmux_cmd, '-L', SOCKET_NAME, *args)
+        raise TmuxError, "tmux(#{args.inspect[1...-1]}) failed\n#{stderr}" unless status.success?
+
+        stdout
+      end
+
+      def available?
+        return false unless tmux_version
+
+        @available ||= (Gem::Version.new(tmux_version) >= Gem::Version.new(REQUIRED_TMUX_VERSION))
+      end
+
+      private
+
+      def debug?
+        @debug
+      end
+
+      def ensure_available
+        return if available?
+        raise TmuxError, 'Running `tmux -V` to determine version failed. Is tmux installed?' unless tmux_version
+
+        raise TmuxError, "tmux version #{tmux_version} does not meet requirement >= #{REQUIRED_TMUX_VERSION}"
+      end
+
+      def tmux_version
+        @tmux_version ||= `#{@tmux_cmd} -V`[/tmux (\d+.\d+)/, 1]
+      rescue Errno::ENOENT
+        nil
+      end
+    end
+  end
+end

data/lib/ttytest/tmux/session.rb

@@ -1,159 +1,163 @@
-# frozen_string_literal: true
-
-module TTYtest
-  module Tmux
-    # represents a tmux session and how to send output to the current tmux session
-    class Session
-      # @api private
-      def initialize(driver, name)
-        @driver = driver
-        @name = name
-
-        # ObjectSpace.define_finalizer(self, self.class.finalize(driver, name))
-      end
-
-      # @api private
-      # def self.finalize(driver, name)
-      #   proc { driver.tmux(*%W[kill-session -t #{name}]) }
-      # end
-
-      def capture
-        contents = driver.tmux(*%W[capture-pane -t #{name} -p])
-        str = driver.tmux(*%W[display-message -t #{name} -p
-                              #\{cursor_x},#\{cursor_y},#\{cursor_flag},#\{pane_width},#\{pane_height},#\{pane_dead},#\{pane_dead_status},])
-        x, y, cursor_flag, width, height, pane_dead, pane_dead_status, _newline = str.split(',')
-
-        if pane_dead == '1'
-          raise Driver::TmuxError,
-                "Tmux pane has died\nCommand exited with status: #{pane_dead_status}\nEntire screen:\n#{contents}"
-        end
-
-        TTYtest::Capture.new(
-          contents.chomp("\n"),
-          cursor_x: x.to_i,
-          cursor_y: y.to_i,
-          width: width.to_i,
-          height: height.to_i,
-          cursor_visible: (cursor_flag != '0')
-        )
-      end
-
-      # Send the array of keys as a string literal to tmux.
-      # Will not be interpreted as send-keys values like Enter, Escape, DC for Delete, etc.
-      # @param [%w()] keys the keys to send to tmux
-      def send_keys(*keys)
-        driver.tmux(*%W[send-keys -t #{name} -l], *keys)
-      end
-
-      # Send a string of keys one character at a time as literals to tmux.
-      # @param [String] keys the keys to send one at a time to tmux
-      def send_keys_one_at_a_time(keys)
-        keys.split('').each do |key|
-          driver.tmux(*%W[send-keys -t #{name} -l], key)
-        end
-      end
-
-      def send_newline
-        driver.tmux(*%W[send-keys -t #{name} -l], %(\n))
-      end
-
-      def send_newlines(number_of_times)
-        while number_of_times.positive?
-          send_newline
-          number_of_times -= 1
-        end
-      end
-
-      def send_delete
-        send_keys_exact(%(DC))
-      end
-
-      def send_deletes(number_of_times)
-        while number_of_times.positive?
-          send_delete
-          number_of_times -= 1
-        end
-      end
-
-      def send_backspace
-        send_keys_exact(%(BSpace))
-      end
-
-      def send_backspaces(number_of_times)
-        while number_of_times.positive?
-          send_backspace
-          number_of_times -= 1
-        end
-      end
-
-      def send_right_arrow
-        send_keys(TTYtest::RIGHT_ARROW)
-      end
-
-      def send_right_arrows(number_of_times)
-        while number_of_times.positive?
-          send_right_arrow
-          number_of_times -= 1
-        end
-      end
-
-      def send_left_arrow
-        send_keys(TTYtest::LEFT_ARROW)
-      end
-
-      def send_left_arrows(number_of_times)
-        while number_of_times.positive?
-          send_left_arrow
-          number_of_times -= 1
-        end
-      end
-
-      def send_up_arrow
-        send_keys(TTYtest::UP_ARROW)
-      end
-
-      def send_up_arrows(number_of_times)
-        while number_of_times.positive?
-          send_up_arrow
-          number_of_times -= 1
-        end
-      end
-
-      def send_down_arrow
-        send_keys(TTYtest::DOWN_ARROW)
-      end
-
-      def send_down_arrows(number_of_times)
-        while number_of_times.positive?
-          send_down_arrow
-          number_of_times -= 1
-        end
-      end
-
-      # Useful to send send-keys commands to tmux without sending them as a string literal.
-      # So you can send Escape for escape key, DC for delete, etc.
-      # Uses the same key bindings as bind-key as well. C-c represents Ctrl + C keys, F1 is F1 key, etc.
-      # @param [String] keys the keys to send to tmux
-      def send_keys_exact(keys)
-        driver.tmux(*%W[send-keys -t #{name}], keys)
-      end
-
-      def send_home
-        send_keys_exact(%(Home))
-      end
-
-      def send_end
-        send_keys_exact(%(End))
-      end
-
-      def send_clear
-        send_keys_one_at_a_time(TTYtest::CLEAR)
-        send_newline
-      end
-
-      private
-
-      attr_reader :driver, :name
-    end
-  end
-end
+# frozen_string_literal: true
+
+module TTYtest
+  module Tmux
+    # represents a tmux session and how to send output to the current tmux session
+    class Session
+      # @api private
+      def initialize(driver, name)
+        @driver = driver
+        @name = name
+
+        # ObjectSpace.define_finalizer(self, self.class.finalize(driver, name))
+      end
+
+      # @api private
+      # def self.finalize(driver, name)
+      #   proc { driver.tmux(*%W[kill-session -t #{name}]) }
+      # end
+
+      def capture
+        contents = driver.tmux(*%W[capture-pane -t #{name} -p])
+        str = driver.tmux(*%W[display-message -t #{name} -p
+                              #\{cursor_x},#\{cursor_y},#\{cursor_flag},#\{pane_width},#\{pane_height},#\{pane_dead},#\{pane_dead_status},])
+        x, y, cursor_flag, width, height, pane_dead, pane_dead_status, _newline = str.split(',')
+
+        if pane_dead == '1'
+          raise Driver::TmuxError,
+                "Tmux pane has died\nCommand exited with status: #{pane_dead_status}\nEntire screen:\n#{contents}"
+        end
+
+        TTYtest::Capture.new(
+          contents.chomp("\n"),
+          cursor_x: x.to_i,
+          cursor_y: y.to_i,
+          width: width.to_i,
+          height: height.to_i,
+          cursor_visible: (cursor_flag != '0')
+        )
+      end
+
+      # Send the array of keys as a string literal to tmux.
+      # Will not be interpreted as send-keys values like Enter, Escape, DC for Delete, etc.
+      # @param [%w()] keys the keys to send to tmux
+      def send_keys(*keys)
+        driver.tmux(*%W[send-keys -t #{name} -l], *keys)
+      end
+
+      # Send a string of keys one character at a time as literals to tmux.
+      # @param [String] keys the keys to send one at a time to tmux
+      def send_keys_one_at_a_time(keys)
+        keys.split('').each do |key|
+          driver.tmux(*%W[send-keys -t #{name} -l], key)
+        end
+      end
+
+      def send_newline
+        driver.tmux(*%W[send-keys -t #{name} -l], %(\n))
+      end
+
+      def send_newlines(number_of_times)
+        while number_of_times.positive?
+          send_newline
+          number_of_times -= 1
+        end
+      end
+
+      def send_delete
+        send_keys_exact(%(DC))
+      end
+
+      def send_deletes(number_of_times)
+        while number_of_times.positive?
+          send_delete
+          number_of_times -= 1
+        end
+      end
+
+      def send_backspace
+        send_keys_exact(%(BSpace))
+      end
+
+      def send_backspaces(number_of_times)
+        while number_of_times.positive?
+          send_backspace
+          number_of_times -= 1
+        end
+      end
+
+      def send_right_arrow
+        send_keys(TTYtest::RIGHT_ARROW)
+      end
+
+      def send_right_arrows(number_of_times)
+        while number_of_times.positive?
+          send_right_arrow
+          number_of_times -= 1
+        end
+      end
+
+      def send_left_arrow
+        send_keys(TTYtest::LEFT_ARROW)
+      end
+
+      def send_left_arrows(number_of_times)
+        while number_of_times.positive?
+          send_left_arrow
+          number_of_times -= 1
+        end
+      end
+
+      def send_up_arrow
+        send_keys(TTYtest::UP_ARROW)
+      end
+
+      def send_up_arrows(number_of_times)
+        while number_of_times.positive?
+          send_up_arrow
+          number_of_times -= 1
+        end
+      end
+
+      def send_down_arrow
+        send_keys(TTYtest::DOWN_ARROW)
+      end
+
+      def send_down_arrows(number_of_times)
+        while number_of_times.positive?
+          send_down_arrow
+          number_of_times -= 1
+        end
+      end
+
+      # Useful to send send-keys commands to tmux without sending them as a string literal.
+      # So you can send Escape for escape key, DC for delete, etc.
+      # Uses the same key bindings as bind-key as well. C-c represents Ctrl + C keys, F1 is F1 key, etc.
+      # @param [String] keys the keys to send to tmux
+      def send_keys_exact(keys)
+        driver.tmux(*%W[send-keys -t #{name}], keys)
+      end
+
+      def send_home
+        send_keys_exact(TTYtest::HOME_KEY)
+      end
+
+      def send_end
+        send_keys_exact(TTYtest::END_KEY)
+      end
+
+      def send_clear
+        send_keys_one_at_a_time(TTYtest::CLEAR)
+        send_newline
+      end
+
+      def send_escape
+        send_keys_exact(%(Escape))
+      end
+
+      private
+
+      attr_reader :driver, :name
+    end
+  end
+end

data/lib/ttytest/tmux/tmux.conf

@@ -1,3 +1,3 @@
-set -g status off
-set -g remain-on-exit on
-set -g default-shell /bin/sh
+set -g status off
+set -g remain-on-exit on
+set -g default-shell /bin/sh

data/lib/ttytest/version.rb

@@ -1,5 +1,5 @@
-# frozen_string_literal: true
-
-module TTYtest
-  VERSION = '0.9.8'
-end
+# frozen_string_literal: true
+
+module TTYtest
+  VERSION = '0.9.9'
+end

data/lib/ttytest.rb

@@ -1,27 +1,27 @@
-# frozen_string_literal: true
-
-require 'forwardable'
-require 'ttytest/constants'
-require 'ttytest/tmux/driver'
-require 'ttytest/tmux/session'
-
-# ttytest2 main module
-module TTYtest
-  class << self
-    attr_accessor :driver, :default_max_wait_time
-
-    extend Forwardable
-    # @!method new_terminal(command, width: 80, height: 24)
-    #   Create a new terminal through the current driver.
-    #   @param [String] command a valid shell command to run
-    #   @param [Integer] width width of the new terminal
-    #   @param [Integer] height height of the new terminal
-    #   @return [Terminal] a new terminal running the specified command
-    def_delegators :driver, :new_terminal
-  end
-
-  class MatchError < StandardError; end
-
-  self.driver = TTYtest::Tmux::Driver.new
-  self.default_max_wait_time = 2
-end
+# frozen_string_literal: true
+
+require 'forwardable'
+require 'ttytest/constants'
+require 'ttytest/tmux/driver'
+require 'ttytest/tmux/session'
+
+# ttytest2 main module
+module TTYtest
+  class << self
+    attr_accessor :driver, :default_max_wait_time
+
+    extend Forwardable
+    # @!method new_terminal(command, width: 80, height: 24)
+    #   Create a new terminal through the current driver.
+    #   @param [String] command a valid shell command to run
+    #   @param [Integer] width width of the new terminal
+    #   @param [Integer] height height of the new terminal
+    #   @return [Terminal] a new terminal running the specified command
+    def_delegators :driver, :new_terminal
+  end
+
+  class MatchError < StandardError; end
+
+  self.driver = TTYtest::Tmux::Driver.new
+  self.default_max_wait_time = 2
+end

data/notes.txt

@@ -1,7 +1,7 @@
-to push new version to github
-git tag v0.9.8
-git push origin --tags
-
-to push new version to rubygems.org
-gem build ttytest2.gemspec
-gem push ttytest2-0.9.8.gem
+to push new version to github
+git tag v0.9.9
+git push origin --tags
+
+to push new version to rubygems.org
+gem build ttytest2.gemspec
+gem push ttytest2-0.9.9.gem

data/ttytest2.gemspec

@@ -1,31 +1,31 @@
-# frozen_string_literal: true
-
-lib = File.expand_path('lib', __dir__)
-$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
-require 'ttytest/version'
-
-Gem::Specification.new do |spec|
-  spec.name          = 'ttytest2'
-  spec.version       = TTYtest::VERSION
-  spec.authors       = ['Alex Eski']
-  spec.email         = ['alexeski@gmail.com']
-
-  spec.summary       = 'ttytest2 is an integration test framework for interactive console (tty) applications'
-  spec.description   = 'ttytest2 runs shell/cli applications inside of tmux and allows you to make assertions on what the output should be'
-  spec.homepage      = 'https://github.com/a-eski/ttytest2'
-  spec.license       = 'MIT'
-
-  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
-    f.match(%r{^(test|spec|features)/})
-  end
-  spec.bindir        = 'exe'
-  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
-  spec.require_paths = ['lib']
-
-  spec.required_ruby_version = '>= 3.2.3'
-
-  spec.add_development_dependency 'bundler', '~> 2.4'
-  spec.add_development_dependency 'minitest', '~> 5.0'
-  spec.add_development_dependency 'rake', '~> 13.0'
-  spec.add_development_dependency 'yard', '~> 0.9'
-end
+# frozen_string_literal: true
+
+lib = File.expand_path('lib', __dir__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'ttytest/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'ttytest2'
+  spec.version       = TTYtest::VERSION
+  spec.authors       = ['Alex Eski']
+  spec.email         = ['alexeski@gmail.com']
+
+  spec.summary       = 'ttytest2 is an integration test framework for interactive console (tty) applications'
+  spec.description   = 'ttytest2 runs shell/cli applications inside of tmux and allows you to make assertions on what the output should be'
+  spec.homepage      = 'https://github.com/a-eski/ttytest2'
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = 'exe'
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.required_ruby_version = '>= 3.2.3'
+
+  spec.add_development_dependency 'bundler', '~> 2.4'
+  spec.add_development_dependency 'minitest', '~> 5.0'
+  spec.add_development_dependency 'rake', '~> 13.0'
+  spec.add_development_dependency 'yard', '~> 0.9'
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ttytest2
 version: !ruby/object:Gem::Version
-  version: 0.9.8
+  version: 0.9.9
 platform: ruby
 authors:
 - Alex Eski
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-12-15 00:00:00.000000000 Z
+date: 2024-12-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -111,7 +111,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.23
+rubygems_version: 3.4.20
 signing_key:
 specification_version: 4
 summary: ttytest2 is an integration test framework for interactive console (tty) applications