terminal_rb 0.16.2 → 0.17.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c1c85e6d14f19a36f2efd995aa90b962ef24deaedeacd6ba5ba0392ae7d87f54
-  data.tar.gz: 99a8c94cbb3b79386fb1725378f4f7cfc6e97e1e4b93978cf6e67d0a1d0720a0
+  metadata.gz: 3ccb3312146fca100bd13e4c079e5cf6f4a33e73ef9eb526765df1309ae5168e
+  data.tar.gz: ce4f5679183067ac7f7d84196db0ad9a06a22878fda79ec302fbacc8047699fa
 SHA512:
-  metadata.gz: 4d257376892920c46bd96c60a475953d169409552db6fc75a3e0f5f0613b34fe5bc3a2e18d77c53d05cf2670f0b81a02ba4ce237d83fb4c3299826d1c3e7cce8
-  data.tar.gz: 353f4ed0f0da7ad39ce7413335e31d89264e0587e12c450d6028c8fbfc5c30c986136e0babac12a146176d44c810aabdb403b52a13389a3900256f53cd5b96d8
+  metadata.gz: 8a898bce2dc22f5b1d873ace6cef5ea53046318d68bc80062898ec7be43553acde5a7709c1b1043666533e91fbecec3e66dd0372c0adb1642803b4273f0c91d0
+  data.tar.gz: d9a06bd5ef76f97a0331bb2e05681fae5103dbe69a21c8e5ac0b97cb7342a6569d0e595b90b00744f22ed9253fc858fdbcd8e81e37ce595bfd1bb830c5cea2b9

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

@@ -49,14 +49,16 @@ module Terminal
     # @return [KeyEvent] next event
     # @return [nil] in error case
     def read_key_event
-      case input_mode
-      when :dumb
-        raw = read_dumb or return
-        opts = @dumb_keys[raw.ord] if raw.size == 1
-        KeyEvent.new(raw, *opts)
-      when :csi_u, :legacy
-        raw = read_tty or return
-        KeyEvent[raw]
+      prevent_input_recursion do
+        case input_mode
+        when :dumb
+          raw = read_dumb or return
+          opts = @dumb_keys[raw.ord] if raw.size == 1
+          KeyEvent.new(raw, *opts)
+        when :csi_u, :legacy
+          raw = read_tty or return
+          KeyEvent[raw]
+        end
       end
     end
 
@@ -80,20 +82,33 @@ module Terminal
     #   when no block was given
     def on_key_event(mouse: false, mouse_move: false, focus: false, &block)
       return unless block
-      case input_mode
-      when :dumb
-        on_bumb_key_event(&block)
-        true
-      when :csi_u, :legacy
-        on_tty_key_event(mouse_option(mouse, mouse_move, focus), &block)
-        true
-      else
-        false
+      prevent_input_recursion do
+        case input_mode
+        when :dumb
+          on_bumb_key_event(&block)
+          true
+        when :csi_u, :legacy
+          on_tty_key_event(mouse_option(mouse, mouse_move, focus), &block)
+          true
+        else
+          false
+        end
       end
     end
 
     private
 
+    def prevent_input_recursion
+      if (@key_event += 1) != 1
+        raise(RuntimeError, 'already reading key events', caller(2))
+      end
+      begin
+        yield
+      ensure
+        @key_event -= 1
+      end
+    end
+
     def mouse_option(mouse, mouse_move, focus)
       opts = +(mouse ? '1000' : '')
       # highlight: '1001'
@@ -109,7 +124,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
@@ -189,5 +204,7 @@ module Terminal
     0x1b => :Esc
   }.compare_by_identity.freeze
 
+  @key_event = 0
+
   autoload :KeyEvent, "#{__dir__}/input/key_event.rb"
 end

data/lib/terminal/shell.rb

@@ -5,50 +5,43 @@ module Terminal
     class << self
       def exec(cmd, env: {}, shell: false, input: nil, **options)
         options = options.except(:in, :out, :err)
-        if shell
-          cmd = cmd.map! { _escape(_1) }.join(' ')
-        elsif cmd.size == 1 && cmd[0].include?(' ')
-          cmd = cmd[0]
-        end
+        cmd = cmd.map! { _escape(_1) }.join(' ') if shell
+        input = Input[input]
+        thread = nil
 
-        input = Input.for(input)
-        ret = nil
         with_io(options, input) do |cio, out_r, err_r, in_w|
           thread = Process.detach(Process.spawn(env, *cmd, options))
-          begin
-            cio.each(&:close)
-            read = [out_r, err_r]
-            write = [in_w] if in_w
-            while !read.empty? || write
-              rr, wr, = IO.select(read, write)
-              if rr.include?(out_r)
-                begin
-                  yield(out_r.readline(chomp: true), :output)
-                rescue SystemCallError, IOError
-                  read.delete(out_r)
-                end
-              end
-              if rr.include?(err_r)
-                begin
-                  yield(err_r.readline(chomp: true), :error)
-                rescue SystemCallError, IOError
-                  read.delete(err_r)
-                end
+          cio.each(&:close)
+          read = [out_r, err_r]
+          write = [in_w] if in_w
+          until read.empty? && write.nil?
+            rr, wr, = IO.select(read, write)
+            if rr.include?(out_r)
+              begin
+                yield(out_r.readline(chomp: true), :output)
+              rescue SystemCallError, IOError
+                read.delete(out_r)
               end
-              next if wr.empty?
+            end
+            if rr.include?(err_r)
               begin
-                next if input.call(in_w)
-                in_w.close
-                write = nil
+                yield(err_r.readline(chomp: true), :error)
               rescue SystemCallError, IOError
-                write = nil
+                read.delete(err_r)
               end
             end
-          ensure
-            ret = thread.join.value
+            next if wr.empty?
+            begin
+              next if input.call(in_w)
+              in_w.close
+              write = nil
+            rescue SystemCallError, IOError
+              write = nil
+            end
           end
         end
-        ret
+
+        thread.join.value if thread
       rescue SystemCallError, IOError
         nil
       end
@@ -70,57 +63,49 @@ module Terminal
       end
 
       def _escape(str)
-        return +"''" if str.empty?
-        str = str.dup
-        str.gsub!(%r{[^A-Za-z0-9_\-.,:+/@\n]}, "\\\\\\&")
-        str.gsub!("\n", "'\n'")
-        str
+        return "''" if str.empty?
+        str.gsub(%r{[^A-Za-z0-9_\-.,:+/@\n]}, "\\\\\\&").gsub("\n", "'\n'")
       end
     end
 
     module Input
-      def self.for(obj)
+      def self.[](obj)
         return unless obj
-        return CopyWriter.new(obj) if obj.respond_to?(:readpartial)
-        return CopyWriter.new(obj.to_io) if obj.respond_to?(:to_io)
-        return ArrayWriter.new(obj) if obj.is_a?(Array)
-        return EnumerableWriter.new(obj) if obj.respond_to?(:each)
-        return ArrayWriter.new(obj.to_a) if obj.respond_to?(:to_a)
-        Writer.new(obj)
-      end
-
-      class Writer
-        def call(io) = (io.write(_next) if @obj)
-        def initialize(obj) = (@obj = obj)
-        def _next = (_, @obj = @obj, nil).first
+        return copy_writer(obj) if obj.respond_to?(:readpartial)
+        return copy_writer(obj.to_io) if obj.respond_to?(:to_io)
+        return array_writer(obj) if obj.is_a?(Array)
+        if obj.respond_to?(:each)
+          return enum_writer(obj.enum_for(:each)) if obj.respond_to?(:enum_for)
+          return enum_writer(Enumerator.new { |y| obj.each { y << _1 } })
+        end
+        return array_writer(obj.to_a) if obj.respond_to?(:to_a)
+        proc do |io|
+          io.write(obj)
+          nil
+        end
       end
 
-      class CopyWriter < Writer
-        def call(io) = (IO.copy_stream(_next, io) if @obj)
+      def self.copy_writer(src)
+        proc do |trg|
+          IO.copy_stream(src, trg)
+          nil
+        end
       end
 
-      class ArrayWriter
-        def call(io) = io.write(@ry[@idx += 1] || return)
-
-        def initialize(ary)
-          @ry = ary
-          @idx = -1
-        end
+      def self.array_writer(array, idx = -1)
+        proc { _1.write(array[idx += 1] || next) }
       end
 
-      class EnumerableWriter
-        def call(io)
-          io.write(@enum.next)
+      def self.enum_writer(enum)
+        proc do |io|
+          io.write(enum.next)
         rescue StopIteration
-          false
-        end
-
-        def initialize(enum)
-          return @enum = enum.enum_for(:each) if enum.respond_to?(:enum_for)
-          @enum = Enumerator.new { |y| enum.each { y << _1 } }
+          nil
         end
       end
     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.1'
 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.1
 platform: ruby
 authors:
 - Mike Blumtritt