terminal_rb 0.16.2 → 0.17.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c1c85e6d14f19a36f2efd995aa90b962ef24deaedeacd6ba5ba0392ae7d87f54
-  data.tar.gz: 99a8c94cbb3b79386fb1725378f4f7cfc6e97e1e4b93978cf6e67d0a1d0720a0
+  metadata.gz: 4a91661bad1d2b3b3d432dd5ae4e0e0101b3a006773d30c58a39a75c703ab03e
+  data.tar.gz: 533349101fb9890e0bf0e73a407f9302ac881eeb9376aca78aba1e76486544ad
 SHA512:
-  metadata.gz: 4d257376892920c46bd96c60a475953d169409552db6fc75a3e0f5f0613b34fe5bc3a2e18d77c53d05cf2670f0b81a02ba4ce237d83fb4c3299826d1c3e7cce8
-  data.tar.gz: 353f4ed0f0da7ad39ce7413335e31d89264e0587e12c450d6028c8fbfc5c30c986136e0babac12a146176d44c810aabdb403b52a13389a3900256f53cd5b96d8
+  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

@@ -109,7 +109,7 @@ module Terminal
 
     def on_tty_key_event(opts)
       STDIN.noecho do |stdin|
-        opts = raw_write("#{opts}h") ? "#{opts}l" : nil
+        opts &&= raw_write("#{opts}h") ? "#{opts}l" : nil
         while (raw = stdin.getch)
           (yield(KeyEvent[raw]) ? next : break) if raw != "\e"
           lesci = 0

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.2'
+  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.2
+  version: 0.17.0
 platform: ruby
 authors:
 - Mike Blumtritt