ttytest2 0.7.1 → 0.8.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b9eaa16f80b9604b9b174e0e7cba8fe5552c453d928d7f543dbf0d1498726516
-  data.tar.gz: a8b0cad547df8948c71951817ad7c9fbaa74a8d1a17e7e0bf61c94911c4a6d13
+  metadata.gz: 7a35421907aa8999c90ba5e18959aa659bf6a9b14248ae46acddb7d18f1db0f5
+  data.tar.gz: bbf9762f20e681e29861f9f04090afa03c238fccee3ea6e3d2e8314fb6fa88c1
 SHA512:
-  metadata.gz: 6b64fa53f510b203ea188a715e76ea524564dab12e5718d3c93e57c2182d8a192c263511492667703a155e3b8b8d68293ffa8ab835f606117b603696c92e0159
-  data.tar.gz: 1f16083d91f27ccc16064a5d23bff87e03b18b5185ce206ad3efe8efeec0e1b0c6a32d947b4078f49b929c31e4be13f311bd6fd3dacf8af7e03bdf86e7873d5f
+  metadata.gz: 978ca3331442680de64cd74fdd9e7167526c4a521dc9ed41fdbd8e08d89d9caebb617d6427edb58b5bc79b1b0a522cbb4a54d0854a5f8a3953f22777adebc0d9
+  data.tar.gz: 4115b6301cba03d98b92a6b40f9264b3a0630f28421fae34d402bbfef941f6704895e6b73fee83ddde511b2523f602a16d351434366392a75a1e61457164432d

data/README.md

@@ -6,7 +6,7 @@ Forked from https://github.com/jhawthorn/ttytest, because I had some features I
 
 It works by running commands inside a tmux session, capturing the pane, and comparing the content. The assertions will wait a specified amount of time (default 2 seconds) for the expected content to appear.
 
-[![Gem Version](https://badge.fury.io/rb/ttytest.svg)](https://rubygems.org/gems/ttytest)
+[![Gem Version](https://badge.fury.io/rb/ttytest2.svg)](https://rubygems.org/gems/ttytest2)
 
 ## Minimum Requirements
 
@@ -18,6 +18,8 @@ It works by running commands inside a tmux session, capturing the pane, and comp
 ### Example
 
 ``` ruby
+require 'ttytest'
+
 @tty = TTYtest.new_terminal(%{PS1='$ ' /bin/sh}, width: 80, height: 24)
 @tty.assert_row(0, '$')
 @tty.assert_cursor_position(x: 2, y: 0)
@@ -41,6 +43,8 @@ The main way to use TTYtest is through assertions. When called on a `TTYtest::Te
 Available assertions:
 * `assert_row(row_number, expected_text)`
 * `assert_row_like(row_number, expected_text)`
+* `assert_row_starts_with(row_number, expected_text)`
+* `assert_row_ends_with(row_number, expected_text)`
 * `assert_cursor_position(x: x, y: y)`
 * `assert_cursor_visible`
 * `assert_cursor_hidden`

data/lib/ttytest/capture.rb

@@ -1,3 +1,5 @@
+# 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

data/lib/ttytest/matchers.rb

@@ -1,4 +1,7 @@
+# frozen_string_literal: true
+
 module TTYtest
+  # Assertions for ttytest2.
   module Matchers
     # Asserts the contents of a single row
     # @param [Integer] row_number the row (starting from 0) to test against
@@ -7,15 +10,15 @@ module TTYtest
     def assert_row(row_number, expected)
       expected = expected.rstrip
       actual = row(row_number)
-      return unless actual != expected
+      return if actual == expected
 
       raise MatchError,
             "expected row #{row_number} to be #{expected.inspect} but got #{actual.inspect}\nEntire screen:\n#{self}"
     end
 
-    # Asserts the contents of a single row
+    # Asserts the contents of a single row contains expected
     # @param [Integer] row_number the row (starting from 0) to test against
-    # @param [String] expected the expected value of the row. Any trailing whitespace is ignored
+    # @param [String] expected the expected value contained in the row. Any trailing whitespace is ignored
     # @raise [MatchError] if the row doesn't match
     def assert_row_like(row_number, expected)
       expected = expected.rstrip
@@ -26,6 +29,32 @@ module TTYtest
             "expected row #{row_number} to be like #{expected.inspect} but got #{actual.inspect}\nEntire screen:\n#{self}"
     end
 
+    # Asserts the contents of a single row start with expected
+    # @param [Integer] row_number the row (starting from 0) to test against
+    # @param [String] expected the expected value that the row starts with. Any trailing whitespace is ignored
+    # @raise [MatchError] if the row doesn't match
+    def assert_row_starts_with(row_number, expected)
+      expected = expected.rstrip
+      actual = row(row_number)
+      return if actual.start_with?(expected)
+
+      raise MatchError,
+            "expected row #{row_number} to start with #{expected.inspect} and got #{actual.inspect}\nEntire screen:\n#{self}"
+    end
+
+    # Asserts the contents of a single row end with expected
+    # @param [Integer] row_number the row (starting from 0) to test against
+    # @param [String] expected the expected value that the row starts with. Any trailing whitespace is ignored
+    # @raise [MatchError] if the row doesn't match
+    def assert_row_ends_with(row_number, expected)
+      expected = expected.rstrip
+      actual = row(row_number)
+      return if actual.end_with?(expected)
+
+      raise MatchError,
+            "expected row #{row_number} to end with #{expected.inspect} and got #{actual.inspect}\nEntire screen:\n#{self}"
+    end
+
     # Asserts that the cursor is in the expected position
     # @param [Integer] x cursor x (row) position, starting from 0
     # @param [Integer] y cursor y (column) position, starting from 0
@@ -33,7 +62,7 @@ module TTYtest
     def assert_cursor_position(x, y)
       expected = [x, y]
       actual = [cursor_x, cursor_y]
-      return unless actual != expected
+      return if actual == expected
 
       raise MatchError,
             "expected cursor to be at #{expected.inspect} but was at #{actual.inspect}\nEntire screen:\n#{self}"

data/lib/ttytest/terminal.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'forwardable'
 require 'ttytest/matchers'
 require 'ttytest/capture'

data/lib/ttytest/tmux/session.rb

@@ -2,19 +2,20 @@
 
 module TTYtest
   module Tmux
+    # tmux session manager
     class Session
       # @api private
       def initialize(driver, name)
         @driver = driver
         @name = name
 
-        ObjectSpace.define_finalizer(self, self.class.finalize(driver, 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 self.finalize(driver, name)
+      #   proc { driver.tmux(*%W[kill-session -t #{name}]) }
+      # end
 
       def capture
         contents = driver.tmux(*%W[capture-pane -t #{name} -p])

data/lib/ttytest/version.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module TTYtest
-  VERSION = '0.7.1'.freeze
+  VERSION = '0.8.1'
 end

data/lib/ttytest.rb

@@ -1,7 +1,10 @@
+# frozen_string_literal: true
+
 require 'forwardable'
 require 'ttytest/tmux/driver'
 require 'ttytest/tmux/session'
 
+# ttytest2 main module
 module TTYtest
   class << self
     attr_accessor :driver, :default_max_wait_time

data/notes.txt

@@ -1,7 +1,7 @@
 to push new version to github,
-git tag v0.7.0
+git tag v0.8.1
 git push origin --tags
 
 to push new version to rubygems.org
 gem build ttytest2.gemspec
-gem push ttytest2-0.7.0.gem
+gem push ttytest2-0.8.1.gem

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: ttytest2
 version: !ruby/object:Gem::Version
-  version: 0.7.1
+  version: 0.8.1
 platform: ruby
 authors:
 - Alex Eski