terminal_rb 0.16.1 → 0.17.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1127036c0cda3cdc5e44853ba2f650d7475338166d363ca3f50c35900ac858d7
-  data.tar.gz: 638eaaa9c3d072d8ee1acddab353150f4619f50420b03682b7436d9de19ff71a
+  metadata.gz: 4a91661bad1d2b3b3d432dd5ae4e0e0101b3a006773d30c58a39a75c703ab03e
+  data.tar.gz: 533349101fb9890e0bf0e73a407f9302ac881eeb9376aca78aba1e76486544ad
 SHA512:
-  metadata.gz: 562cef6e62f27adadf22e361017968c422e0c3661787be87d4474debffb26e73f87fc104aeb5e2e4d10fb9a7ba4634d14f44e8c9bebf88ba776cee63912fabcb
-  data.tar.gz: 5668c79725449d1bb9989ba691997adb93a18186a0bfde224ebd8a626a523db08b34a1b45aa2639d46e32acaab7490d47c7987daf875ea5ab6047e690d265885
+  metadata.gz: 39c6527ea4d97ff28e1fc11408297057ee537b44c945be71814cc7b99b4e2759863c063b023d1c7d9d4bb4b9c0ae8172bbb3ceb9166c93b54301119fb0443e9d
+  data.tar.gz: f068bf0ffbc3952260cae2a5e56506063b5bc566c66b4cac8f138732a1bd748a17c9d165ffa29a22a4ca85a12e4c78ba88d3e722a349c0de70d899892f5c7e06

data/lib/terminal/ansi.rb

@@ -467,7 +467,7 @@ module Terminal
 
       # Create a hyperlink.
       # This is not widely supported; works for
-      # Ghosty,
+      # Ghostty,
       # iTerm2,
       # Kitty,
       # Rio,
@@ -481,7 +481,7 @@ module Terminal
 
       # Show a simple notification.
       # This is not widely supported; works for
-      # Ghosty,
+      # Ghostty,
       # iTerm2,
       # Kitty,
       # WezTerm.
@@ -490,6 +490,42 @@ module Terminal
       # @return (see cursor_up)
       def notify(text) = "\e]9;#{text}\a"
 
+      # Set task progress state.
+      # This is not widely supported; works for
+      # Ghostty,
+      # iTerm2,
+      # Kitty.
+      #
+      # @param state [:show, :warning, :error, :indeterminate, :hide]
+      #   - `:show`
+      #     show progress indicator with given percent value in default mode
+      #   - `:warning`
+      #     show progress with given percent value in warning mode
+      #   - `:error`
+      #     show progress with given percent value in error mode
+      #   - `:indeterminate`
+      #     show progress in indeterminate state (percent value is ignored)
+      #   - `:hide`
+      #     hide progress indicator (percent value is ignored)
+      # @return (see cursor_up)
+      def progress(state, percent = 0)
+        case state
+        when :show, true
+          state = 1
+        when :err, :error
+          state = 2
+        when :warn, :warning
+          state = 4
+        when Numeric
+          percent, state = state, 1
+        when :indeterminate
+          return +PROGRESS_SHOW_INDETERMINATE
+        else
+          return +PROGRESS_HIDE
+        end
+        "\e]9;4;#{state};#{percent.to_i.clamp(0, 100)}\a"
+      end
+
       # Create scaled text.
       # It uses the
       # [text sizing protocol](https://sw.kovidgoyal.net/kitty/text-sizing-protocol).
@@ -857,6 +893,11 @@ module Terminal
     # @private
     LINE_ERASE_PREV = -"#{cursor_prev_line(nil)}#{LINE_ERASE}"
 
+    # @private
+    PROGRESS_HIDE = "\e]9;4;0;0\a"
+    # @private
+    PROGRESS_SHOW_INDETERMINATE = "\e]9;4;3;0\a"
+
     # @comment seems not widely supported:
     #   doubled: def cursor_column(column = 1) = "\e[#{column}`"
     #   doubled: def cursor_row(row = 1) = "\e[#{row}d"

data/lib/terminal/input.rb

@@ -85,7 +85,7 @@ module Terminal
         on_bumb_key_event(&block)
         true
       when :csi_u, :legacy
-        on_tty_key_event(mouse, mouse_move, focus, &block)
+        on_tty_key_event(mouse_option(mouse, mouse_move, focus), &block)
         true
       else
         false
@@ -94,36 +94,30 @@ module Terminal
 
     private
 
-    def on_tty_key_event(mouse, mouse_move, focus)
+    def mouse_option(mouse, mouse_move, focus)
+      opts = +(mouse ? '1000' : '')
       # highlight: '1001'
       # drag: '1002'
-      # move: '1003'
-      # focus: '1004' - lost: "\e[O", get: "\e[I"
+      opts << ';1003' if mouse_move
+      opts << ';1004' if focus
       # ext: '1005'
       # sgr: '1006'
       # urxvt: '1015'
       # pixel: '1016'
-      opts =
-        if mouse || mouse_move || focus
-          opts = mouse ? +"\e[?1006;1000" : +"\e[?1006"
-          opts << ';1003' if mouse_move
-          opts << ';1004' if focus
-          raw_write("#{opts}h") ? "#{opts}l" : nil
-        end
+      "\e[?#{opts};1006" unless opts.empty?
+    end
+
+    def on_tty_key_event(opts)
       STDIN.noecho do |stdin|
+        opts &&= raw_write("#{opts}h") ? "#{opts}l" : nil
         while (raw = stdin.getch)
-          if raw != "\e"
-            yield(KeyEvent[raw]) ? next : break
-          end
+          (yield(KeyEvent[raw]) ? next : break) if raw != "\e"
           lesci = 0
-          while (nc = stdin.read_nonblock(1, exception: false))
-            break unless String === nc
+          while String === (nc = stdin.read_nonblock(1, exception: false))
             lesci = raw.size if nc == "\e"
             raw << nc
           end
-          if lesci < 2
-            yield(KeyEvent[raw]) ? next : break
-          end
+          (yield(KeyEvent[raw]) ? next : break) if lesci < 2
           break unless raw[1..].split("\e").all? { yield(KeyEvent["\e#{_1}"]) }
         end
       end
@@ -147,16 +141,13 @@ module Terminal
       return :legacy if im == 'legacy'
       return :dumb if im == 'dumb' || !STDIN.tty?
       STDIN.noecho do |stdin|
-        if raw_write("\e[>1u\e[?u\e[c")
-          inp = +''
-          inp << stdin.getch until inp.rindex('c')
-          if inp.include?("\e[?1u")
-            at_exit { raw_write("\e[<u") }
-            return :csi_u
-          end
-        end
+        return :legacy unless raw_write("\e[>1u\e[?u\e[c")
+        inp = +''
+        inp << stdin.getch until inp.rindex('c')
+        return :legacy unless inp.include?("\e[?1u")
+        at_exit { raw_write("\e[<u") }
+        :csi_u
       end
-      :legacy
     rescue Interrupt
       :legacy
     rescue IOError, SystemCallError

data/lib/terminal/rspec/helper.rb

@@ -61,5 +61,12 @@ RSpec.shared_context 'with Terminal.rb' do |ansi: true, application: :kitty, col
     allow(Terminal).to receive(:read_key_event) do
       Terminal::KeyEvent[stdin.shift || raise('stdin buffer is empty')]
     end
+
+    allow(Terminal).to receive(:on_key_event) do |&b|
+      while true
+        ev = Terminal::KeyEvent[stdin.shift || raise('stdin buffer is empty')]
+        b[ev] or break
+      end
+    end
   end
 end

data/lib/terminal/shell.rb

@@ -120,7 +120,11 @@ module Terminal
           @enum = Enumerator.new { |y| enum.each { y << _1 } }
         end
       end
+
+      private_constant :Writer, :CopyWriter, :ArrayWriter, :EnumerableWriter
     end
+
+    private_constant :Input
   end
 
   private_constant :Shell

data/lib/terminal/version.rb

@@ -2,5 +2,5 @@
 
 module Terminal
   # The version number of the gem.
-  VERSION = '0.16.1'
+  VERSION = '0.17.0'
 end

data/lib/terminal.rb

@@ -301,7 +301,9 @@ module Terminal
     #   whether to create a seperate shell or not
     # @option options [#readpartial, #to_io, Array, #each, #to_a, #to_s] :input
     #   piped to the command as input
+    # @raise [ArgumentError] when command is missing
     def sh(*cmd, **options, &block)
+      raise(ArgumentError, 'command expected') if cmd.empty?
       return Shell.exec(cmd, **options, &block) if block_given?
       out = []
       err = []

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: terminal_rb
 version: !ruby/object:Gem::Version
-  version: 0.16.1
+  version: 0.17.0
 platform: ruby
 authors:
 - Mike Blumtritt