terminal_rb 0.9.6 → 0.9.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 977c06e8d495f8c0e73cff49642e812234cc5861d7495fc44f4dcef4f3b253ee
-  data.tar.gz: 863d24475a32ef39f8f1298876f55d112f4443384ddab9f3fe6fda7228db828c
+  metadata.gz: 151c319bb4dc4f395db83f3966bd37dd2436736b33f89c124baa3eb19ff7412a
+  data.tar.gz: 3a5a1fa68a55cf7de4a63688c76587dc4f6f5f03ad6a4531a7586abcc6c6601b
 SHA512:
-  metadata.gz: 2ad9fa7a857903776fddde3b4c4b00963f977c26f8e74662175234fe798615105f4a71c47a5d5cd02c944ed5090cc9c6892d164e1d2c7de9d013b0643d816115
-  data.tar.gz: ef31547f441d1833ef53d79b0e04c70451573f97966410247d83d883f392da0917fab3f0008a8419925e6d7e261d02b43f011bdc7fc2ab2b2519c21648aff1e7
+  metadata.gz: 978e14d08f3335a08ba06a70a4c92f4ed8a188eed03a255a7892fbf155ab11a66380a1eafb203fd81e398b49cfc4c46e81e05f4ff0dc7c8a134fed22f9bcfdb6
+  data.tar.gz: fc42bc22a4a92feea2eab08684ebe7fd0b9ccfc8d1ff08ee4e6ca2020e3a374c4ca2c048bd7d8ac8271e4b7c210d1a30697b42d9c7d9bc430d6b51b9375a7bd3

data/lib/terminal/ansi.rb

@@ -297,9 +297,9 @@ module Terminal
           .chars
           .map! do |char|
             i = (seed + ((pos += 1) / spread)) * frequency
-            "\e[38;2;#{(Math.sin(i) * 255).abs.to_i};" \
-              "#{(Math.sin(i + PI2_THIRD) * 255).abs.to_i};" \
-              "#{(Math.sin(i + PI4_THIRD) * 255).abs.to_i}m#{char}"
+            "\e[38;2;#{(Math.sin(i) * 255).to_i.abs};" \
+              "#{(Math.sin(i + PI2_THIRD) * 255).to_i.abs};" \
+              "#{(Math.sin(i + PI4_THIRD) * 255).to_i.abs}m#{char}"
           end
           .join << RESET
       end
@@ -390,6 +390,7 @@ module Terminal
 
       # Erase screen part.
       #
+      # @param [:below, :above, :all, :scrollback] part screen part to erase
       # @return (see cursor_up)
       def screen_erase(part = :all)
         "\e[#{
@@ -446,6 +447,7 @@ module Terminal
 
       # Erase part of line.
       #
+      # @param [:to_end, :to_start, :all] part line part to erase
       # @return (see cursor_up)
       def line_erase(part = :all)
         "\e[#{
@@ -468,14 +470,26 @@ module Terminal
       def title(title) = "\e]2;#{title}\a"
 
       # Set  tab title.
-      # This is not widely supported.
+      # This is not widely supported; works for
+      # Hyper,
+      # iTerm2,
+      # Kitty,
+      # MacOS Terminal,
+      # Tabby,
+      # WezTerm.
       #
       # @param (see title)
       # @return (see cursor_up)
       def tab_title(title) = "\e]0;#{title}\a"
 
       # Create a hyperlink.
-      # This is not widely supported.
+      # This is not widely supported; works for
+      # Ghosty,
+      # iTerm2,
+      # Kitty,
+      # Rio,
+      # Tabby,
+      # WezTerm.
       #
       # @param [#to_s] url URL to link to
       # @param [#to_s] text text to display for the link
@@ -485,7 +499,7 @@ module Terminal
       # Create scaled text.
       # It uses the
       # [text sizing protocol](https://sw.kovidgoyal.net/kitty/text-sizing-protocol).
-      # This is not widely supported.
+      # This is not widely supported; works for Kitty.
       #
       # @example Double-height Greeting
       #   Terminal::Ansi.scale('Hello Ruby!', scale: 2)
@@ -672,6 +686,7 @@ module Terminal
     #   def chars_delete(count = 1) = "\e[#{count}P"
     #   def chars_erase(count = 1) = "\e[#{count}X"
     #   def notify(title) = "\e]9;#{title}\a"
+    #   def set_scroll_region(top = nil, bottom = nil) = "\e[#{top};#{bottom}r"
 
     # @comment TODO:
     #   https://sw.kovidgoyal.net/kitty/desktop-notifications

data/lib/terminal/detect.rb

@@ -6,19 +6,19 @@ module Terminal
       def application
         return :kitty if ENV.key?('KITTY_PID')
         return :alacritty if ENV.key?('ALACRITTY_WINDOW_ID')
-        app_from_term_program || app_from_term
+        app_by_tp || app_by_term
       end
 
       def colors
-        if KNOW_APP_WITH_TRUE_COLOR.include?(app_from_term_program) ||
-             (ENV['COLORTERM'] == 'truecolor')
+        return 16_777_216 if ENV['COLORTERM'] == 'truecolor'
+        if %i[ghostty iterm kitty rio vscode wezterm tabby].include?(app_by_tp)
           return 16_777_216
         end
         term = ENV['TERM'] or return 8
         return 16_777_216 if /[+-]direct/.match?(term)
         match = /[-+](\d+)color/.match(term) and return match[1].to_i
         match = /[-+](\d+)bit/.match(term) and return 2**match[1].to_i
-        ret = color_by_name[term] and return ret
+        ret = color_by[term] and return ret
         case term
         when /^(?:iTerm\s?\d*\.app|nsterm-build\d+|terminology(-[0-9.]+)?)$/
           256
@@ -31,8 +31,7 @@ module Terminal
 
       private
 
-      def app_from_term_program
-        value = ENV['TERM_PROGRAM'] or return
+      def app_by_tp
         {
           'Apple_Terminal' => :macos,
           'CodeEditApp_Terminal' => :code_edit,
@@ -49,37 +48,43 @@ module Terminal
           'WarpTerminal' => :warp,
           'WezTerm' => :wezterm
         }[
-          value
+          ENV['TERM_PROGRAM']
         ]
       end
 
-      def app_from_term
-        value = ENV['TERM'] or return
-        {
-          'alacritty' => :alacritty,
-          'amiga' => :amiga,
-          'd430' => :dg_unix,
-          'd470' => :dg_unix,
-          'dg+' => :dg_unix,
-          'dgunix' => :dg_unix,
-          'hp+' => :hpterm,
-          'hpterm' => :hpterm,
-          'mintty' => :mintty,
-          'ms-terminal' => :ms_terminal,
-          'ncr260' => :ncr260,
-          'nsterm' => :nsterm,
-          'terminator' => :terminator,
-          'terminology' => :terminology,
-          'termite' => :termite,
-          'vt100' => :vt100,
-          'wy350' => :wyse,
-          'wy370' => :wyse,
-          'xnuppc' => :xnuppc
-        }.each_pair { |str, type| return type if value.start_with?(str) }
-        nil
+      def app_by_term
+        term = ENV['TERM'] or return
+        case term[0]
+        when 'a'
+          return :alacritty if term.start_with?('alacritty')
+          :amiga if term.start_with?('amiga')
+        when 'd'
+          if term.start_with?('dg+') || term.start_with?('dgunix') ||
+               /\Ad4[37]0/.match?(term)
+            :dg_unix
+          end
+        when 'h'
+          :hpterm if term.start_with?('hp+') || term.start_with?('hpterm')
+        when 'm'
+          return :mintty if term.start_with?('mintty')
+          :ms_terminal if term.start_with?('ms-terminal')
+        when 'n'
+          return :ncr260 if term.start_with?('ncr260')
+          :nsterm if term.start_with?('nsterm')
+        when 't'
+          return :terminator if term.start_with?('terminator')
+          return :terminology if term.start_with?('terminology')
+          :termite if term.start_with?('termite')
+        when 'v'
+          :vt100 if term.start_with?('vt100')
+        when 'w'
+          :wyse if /\Awy3\d\d/.match?(term)
+        when 'x'
+          :xnuppc if term.start_with?('xnuppc')
+        end
       end
 
-      def color_by_name
+      def color_by
         {
           'alacritty' => 256,
           'kitty' => 256,
@@ -142,9 +147,6 @@ module Terminal
           'dummy' => 2
         }
       end
-
-      KNOW_APP_WITH_TRUE_COLOR = %i[kitty ghostty vscode iterm].freeze
-      private_constant :KNOW_APP_WITH_TRUE_COLOR
     end
   end
 

data/lib/terminal/input.rb

@@ -95,6 +95,7 @@ module Terminal
     end
 
     def csi_u?
+      # iTerm2 returns result in two chunks :/
       ret = false
       while true
         result = read_tty or return false
@@ -109,5 +110,5 @@ module Terminal
   autoload :CSIuKeys, "#{dir}/input/csiu_keys.rb"
   autoload :DumbKeys, "#{dir}/input/dumb_keys.rb"
   autoload :LegacyKeys, "#{dir}/input/legacy_keys.rb"
-  private_constant :CSIuKeys, :LegacyKeys
+  private_constant :CSIuKeys, :DumbKeys, :LegacyKeys
 end

data/lib/terminal/text.rb

@@ -67,19 +67,15 @@ module Terminal
         ignore_newline: false,
         &block
       )
-        if limit
-          limit = limit.to_i
-          raise(ArgumentError, "invalid limit - #{limit}") if limit < 1
-          if block
-            lim_lines(text, bbcode, ansi, ignore_newline, limit, &block)
-          else
-            to_enum(:lim_lines, text, bbcode, ansi, ignore_newline, limit)
-          end
-        elsif block
-          lines(text, bbcode, ansi, ignore_newline, &block)
-        else
-          to_enum(:lines, text, bbcode, ansi, ignore_newline)
+        unless limit
+          snippeds = as_snippeds(text, bbcode, ansi, ignore_newline, Word)
+          return block ? lines(snippeds, &block) : to_enum(:lines, snippeds)
         end
+        limit = limit.to_i
+        raise(ArgumentError, "invalid limit - #{limit}") if limit < 1
+        snippeds = as_snippeds(text, bbcode, ansi, ignore_newline, WordEx)
+        return lim_lines(snippeds, limit, &block) if block
+        to_enum(:lim_lines, snippeds, limit)
       end
       alias each each_line
 
@@ -101,19 +97,15 @@ module Terminal
         ignore_newline: false,
         &block
       )
-        if limit
-          limit = limit.to_i
-          raise(ArgumentError, "invalid limit - #{limit}") if limit < 1
-          if block
-            lim_pairs(text, bbcode, ansi, ignore_newline, limit, &block)
-          else
-            to_enum(:lim_pairs, text, bbcode, ansi, ignore_newline, limit)
-          end
-        elsif block
-          pairs(text, bbcode, ansi, ignore_newline, &block)
-        else
-          to_enum(:pairs, text, bbcode, ansi, ignore_newline)
+        unless limit
+          snippeds = as_snippeds(text, bbcode, ansi, ignore_newline, Word)
+          return block ? pairs(snippeds, &block) : to_enum(:pairs, snippeds)
         end
+        limit = limit.to_i
+        raise(ArgumentError, "invalid limit - #{limit}") if limit < 1
+        snippeds = as_snippeds(text, bbcode, ansi, ignore_newline, WordEx)
+        return lim_pairs(snippeds, limit, &block) if block
+        to_enum(:lim_pairs, snippeds, limit)
       end
       alias each_with_size each_line_with_size
 
@@ -130,17 +122,11 @@ module Terminal
         sco == 0xff9e || sco == 0xff9f ? 2 : 1
       end
 
-      def lim_pairs(text, bbcode, ansi, ignore_newline, limit)
+      def lim_pairs(snippeds, limit)
         line = EMPTY.dup
         size = 0
         csi = nil
-        as_snippeds(
-          text,
-          bbcode,
-          ansi,
-          ignore_newline,
-          WordEx
-        ).each do |snipped|
+        snippeds.each do |snipped|
           if snipped == :space
             next if size == 0
             next line << ' ' if (size += 1) <= limit
@@ -150,13 +136,13 @@ module Terminal
           end
 
           if snipped == :nl
-            yield(line, size)
+            line[-1] == ' ' ? yield(line.chop, size - 1) : yield(line, size)
             line = "#{csi}"
             next size = 0
           end
 
           if snipped == :hard_nl
-            yield(line, size)
+            line[-1] == ' ' ? yield(line.chop, size - 1) : yield(line, size)
             line = EMPTY.dup
             csi = nil
             next size = 0
@@ -183,13 +169,13 @@ module Terminal
           end
           yield(line, size) if size != 0
 
-          if snipped.size < limit
+          if snipped.size <= limit
             line = "#{csi}#{snipped}"
             next size = snipped.size
           end
 
           words = snipped.split(limit)
-          if words[-1].size < limit
+          if words[-1].size <= limit
             snipped = words.pop
             line = "#{csi}#{snipped}"
             size = snipped.size
@@ -202,17 +188,50 @@ module Terminal
         nil
       end
 
-      def lim_lines(text, bbcode, ansi, ignore_newline, limit)
+      def pairs(snippeds)
+        line = EMPTY.dup
+        size = 0
+        csi = nil
+        snippeds.each do |snipped|
+          if snipped == :space
+            next if size == 0
+            line << ' '
+            next size += 1
+          end
+
+          if snipped == :nl
+            line[-1] == ' ' ? yield(line.chop, size - 1) : yield(line, size)
+            line = "#{csi}"
+            next size = 0
+          end
+
+          if snipped == :hard_nl
+            line[-1] == ' ' ? yield(line.chop, size - 1) : yield(line, size)
+            line = EMPTY.dup
+            csi = nil
+            next size = 0
+          end
+
+          if snipped == CsiEnd
+            line << CsiEnd if csi
+            next csi = nil
+          end
+
+          next line << (csi = snipped) if snipped.is_a?(Csi)
+          next line << snipped if snipped.is_a?(Osc)
+
+          # Word:
+          line << snipped
+          size += snipped.size
+        end
+        nil
+      end
+
+      def lim_lines(snippeds, limit)
         line = EMPTY.dup
         size = 0
         csi = nil
-        as_snippeds(
-          text,
-          bbcode,
-          ansi,
-          ignore_newline,
-          WordEx
-        ).each do |snipped|
+        snippeds.each do |snipped|
           if snipped == :space
             next if size == 0
             next line << ' ' if (size += 1) <= limit
@@ -222,13 +241,13 @@ module Terminal
           end
 
           if snipped == :nl
-            yield(line)
+            yield(line[-1] == ' ' ? line.chop : line)
             line = "#{csi}"
             next size = 0
           end
 
           if snipped == :hard_nl
-            yield(line)
+            yield(line[-1] == ' ' ? line.chop : line)
             line = EMPTY.dup
             csi = nil
             next size = 0
@@ -255,13 +274,13 @@ module Terminal
           end
           yield(line) if size != 0
 
-          if snipped.size < limit
+          if snipped.size <= limit
             line = "#{csi}#{snipped}"
             next size = snipped.size
           end
 
           words = snipped.split(limit)
-          if words[-1].size < limit
+          if words[-1].size <= limit
             snipped = words.pop
             line = "#{csi}#{snipped}"
             size = snipped.size
@@ -274,11 +293,11 @@ module Terminal
         nil
       end
 
-      def pairs(text, bbcode, ansi, ignore_newline)
+      def lines(snippeds)
         line = EMPTY.dup
         size = 0
         csi = nil
-        as_snippeds(text, bbcode, ansi, ignore_newline, Word).each do |snipped|
+        snippeds.each do |snipped|
           if snipped == :space
             next if size == 0
             line << ' '
@@ -286,13 +305,13 @@ module Terminal
           end
 
           if snipped == :nl
-            yield(line, size)
+            yield(line[-1] == ' ' ? line.chop : line)
             line = "#{csi}"
             next size = 0
           end
 
           if snipped == :hard_nl
-            yield(line, size)
+            yield(line[-1] == ' ' ? line.chop : line)
             line = EMPTY.dup
             csi = nil
             next size = 0
@@ -313,62 +332,43 @@ module Terminal
         nil
       end
 
-      def lines(text, bbcode, ansi, ignore_newline)
-        line = EMPTY.dup
-        csi = nil
-        as_snippeds(text, bbcode, ansi, ignore_newline, Word).each do |snipped|
-          next line << ' ' if snipped == :space
-
-          if snipped == :nl
-            next if line.empty?
-            yield(line)
-            next line = "#{csi}"
-          end
-
-          if snipped == :hard_nl
-            yield(line)
-            line = EMPTY.dup
-            next csi = nil
-          end
-
-          if snipped == CsiEnd
-            line << CsiEnd if csi
-            next csi = nil
-          end
-
-          csi = snipped if snipped.is_a?(Csi)
-          # Csi, Osc, Word:
-          line << snipped
-        end
-        nil
-      end
-
       def as_snippeds(text, bbcode, ansi, ignore_newline, word_class)
         ret = []
         last = nil
         text.each do |txt|
           if (txt = bbcode ? Ansi.bbcode(txt) : txt.to_s).empty?
-            next ret[-1] = last = :hard_nl if ret[-1] == :space
+            next ret[-1] = last = :hard_nl if last.is_a?(Symbol)
             next ret << (last = :hard_nl)
           end
+
           txt = txt.encode(ENC) if txt.encoding != ENC
+
           txt.scan(SCAN_EXPR) do |nl, csi, osc, space, gc|
             if gc
               next last.add(gc, char_width(gc)) if last.is_a?(word_class)
               next ret << (last = word_class.new(gc, char_width(gc)))
             end
+
             next last.is_a?(Symbol) ? nil : ret << (last = :space) if space
+
             if nl
-              if ignore_newline
+              if ignore_newline # handle nl like space
                 next last.is_a?(Symbol) ? nil : ret << (last = :space)
               end
               next last == :space ? ret[-1] = last = :nl : ret << (last = :nl)
             end
+
             next unless ansi
+
             next ret << (last = Osc.new(osc)) if osc
-            next ret << (last = CsiEnd) if csi == "\e[m" || csi == "\e[0m"
+
+            if csi == "\e[m" || csi == "\e[0m"
+              next last == CsiEnd ? nil : ret << (last = CsiEnd)
+            end
+
             last.is_a?(Csi) ? last.add(csi) : ret << (last = Csi.new(csi))
           end
+
           next ret[-1] = last = :hard_nl if last.is_a?(Symbol)
           ret << (last = :hard_nl)
         end
@@ -378,15 +378,14 @@ module Terminal
 
     class Osc
       attr_reader :to_str, :size
-
+      alias _to_s to_s
       alias to_s to_str
+      def inspect = "#{_to_s.chop} #{@to_str.inspect}>"
 
       def initialize(str)
         @to_str = str
         @size = 0
       end
-
-      def inspect = "#{to_s.chop} #{@to_str.inspect}>"
     end
 
     class Csi < Osc
@@ -403,8 +402,9 @@ module Terminal
 
     class Word
       attr_reader :to_str, :size
-
+      alias _to_s to_s
       alias to_s to_str
+      def inspect = "#{_to_s.chop} #{@size}:#{@to_str.inspect}>"
 
       def initialize(char, size)
         @to_str = char.dup
@@ -415,8 +415,6 @@ module Terminal
         @to_str << char
         @size += size
       end
-
-      def inspect = "#{to_s.chop} #{@size}:#{@to_str.inspect}>"
     end
 
     class WordEx < Word

data/lib/terminal/version.rb

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: terminal_rb
 version: !ruby/object:Gem::Version
-  version: 0.9.6
+  version: 0.9.7
 platform: ruby
 authors:
 - Mike Blumtritt
@@ -49,7 +49,7 @@ metadata:
   rubygems_mfa_required: 'true'
   source_code_uri: https://codeberg.org/mblumtritt/Terminal.rb
   bug_tracker_uri: https://codeberg.org/mblumtritt/Terminal.rb/issues
-  documentation_uri: https://rubydoc.info/gems/terminal_rb/0.9.6/Terminal
+  documentation_uri: https://rubydoc.info/gems/terminal_rb/0.9.7/Terminal
 rdoc_options: []
 require_paths:
 - lib