terminal_rb 0.17.2 → 0.19.0

data/lib/terminal/text.rb

@@ -108,18 +108,39 @@ module Terminal
       end
       alias each_with_size each_line_with_size
 
+      # Returns maximal width of a line of given text.
+      #
+      # @param (see each_line)
+      # @return [Integer] width
+      def max_line_width(*text, ignore_newline: false)
+        return 0 if text.empty?
+        ret = 0
+        pairs(as_snippets(text, false, false, ignore_newline, Word)) do |_l, w|
+          ret = w if w > ret
+        end
+        ret
+      end
+
       private
 
       def char_width(char)
         ord = char.ord
-        return @ctrlchar_width[ord] || 2 if ord < 0x20
-        return 1 if char.size < 2 && ord < 0xa1
-        width = CharWidth[ord]
-        return @ambiguous_char_width if width == -1
-        sco = char[-1].ord
-        return width if sco != 0xff9e && sco != 0xff9f
-        # handle halfwidth dakuten/handakuten
-        char.size < 2 ? 1 : char.each_char.sum { char_width(_1) }
+        return @ctrlchar_width[ord] if ord < 0x20
+        if char.size == 1
+          return 1 if ord < 0xa1
+          width = CharWidth[ord]
+          return width < 0 ? @ambiguous_char_width : width
+        end
+        sum = 0
+        zwj = false
+        char.each_char do |c|
+          next zwj = false if zwj
+          ord = c.ord
+          next zwj = true if ord == 0x200d # zero with joiner
+          width = CharWidth[ord]
+          sum += (width < 0 ? @ambiguous_char_width : width)
+        end
+        sum
       end
 
       def lim_pairs(snippets, limit)
@@ -153,8 +174,8 @@ module Terminal
             next csi = nil
           end
 
-          next line << (csi = snippet) if snippet.is_a?(Csi)
-          next line << snippet if snippet.is_a?(Osc)
+          next line << (csi = snippet) if Csi === snippet
+          next line << snippet if Osc === snippet
 
           # Word:
 
@@ -217,12 +238,12 @@ module Terminal
             next csi = nil
           end
 
-          next line << (csi = snippet) if snippet.is_a?(Csi)
-          next line << snippet if snippet.is_a?(Osc)
+          next line << (csi = snippet) if Csi === snippet
+          next line << snippet if Osc === snippet
 
           # Word:
-          line << snippet
           size += snippet.size
+          line << snippet
         end
         nil
       end
@@ -258,8 +279,8 @@ module Terminal
             next csi = nil
           end
 
-          next line << (csi = snippet) if snippet.is_a?(Csi)
-          next line << snippet if snippet.is_a?(Osc)
+          next line << (csi = snippet) if Csi === snippet
+          next line << snippet if Osc === snippet
 
           # Word:
 
@@ -322,12 +343,12 @@ module Terminal
             next csi = nil
           end
 
-          next line << (csi = snippet) if snippet.is_a?(Csi)
-          next line << snippet if snippet.is_a?(Osc)
+          next line << (csi = snippet) if Csi === snippet
+          next line << snippet if Osc === snippet
 
           # Word:
-          line << snippet
           size += snippet.size
+          line << snippet
         end
         nil
       end
@@ -335,9 +356,10 @@ module Terminal
       def as_snippets(text, bbcode, ansi, ignore_newline, word_class)
         ret = []
         last = nil
+        to_s = bbcode ? ->(s) { Ansi.bbcode(s) } : :to_s.to_proc
         text.each do |txt|
-          if (txt = bbcode ? Ansi.bbcode(txt) : txt.to_s).empty?
-            next ret[-1] = last = :hard_nl if last.is_a?(Symbol)
+          if (txt = to_s[txt]).empty?
+            next ret[-1] = last = :hard_nl if Symbol === last
             next ret << (last = :hard_nl)
           end
 
@@ -345,15 +367,15 @@ module Terminal
 
           txt.scan(@scan_snippet) do |nl, csi, osc, space, gc|
             if gc
-              next last.add(gc, char_width(gc)) if last.is_a?(word_class)
+              next last.add(gc, char_width(gc)) if word_class === last
               next ret << (last = word_class.new(gc, char_width(gc)))
             end
 
-            next last.is_a?(Symbol) ? nil : ret << (last = :space) if space
+            next Symbol === last ? nil : ret << (last = :space) if space
 
             if nl
               if ignore_newline # handle nl like space
-                next last.is_a?(Symbol) ? nil : ret << (last = :space)
+                next Symbol === last ? nil : ret << (last = :space)
               end
               next last == :space ? ret[-1] = last = :nl : ret << (last = :nl)
             end
@@ -366,11 +388,10 @@ module Terminal
               next last == CsiEnd ? nil : ret << (last = CsiEnd)
             end
 
-            last.is_a?(Csi) ? last.add(csi) : ret << (last = Csi.new(csi))
+            Csi === last ? last.add(csi) : ret << (last = Csi.new(csi))
           end
 
-          next ret[-1] = last = :hard_nl if last.is_a?(Symbol)
-          ret << (last = :hard_nl)
+          Symbol === last ? ret[-1] = last = :hard_nl : ret << (last = :hard_nl)
         end
         ret
       end
@@ -378,9 +399,7 @@ 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
@@ -402,9 +421,7 @@ 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
@@ -461,42 +478,49 @@ module Terminal
         | (\X)
       )/x
 
-    @ctrlchar_width = {
-      0x00 => 0,
-      0x01 => 1,
-      0x02 => 1,
-      0x03 => 1,
-      0x04 => 1,
-      0x05 => 0,
-      0x06 => 1,
-      0x07 => 0,
-      0x08 => 0,
-      0x09 => 8,
-      0x0a => 0,
-      0x0b => 0,
-      0x0c => 0,
-      0x0d => 0,
-      0x0e => 0,
-      0x0f => 0,
-      0x10 => 1,
-      0x11 => 1,
-      0x12 => 1,
-      0x13 => 1,
-      0x14 => 1,
-      0x15 => 1,
-      0x16 => 1,
-      0x17 => 1,
-      0x18 => 1,
-      0x19 => 1,
-      0x1a => 1,
-      0x1b => 1,
-      0x1c => 1,
-      0x1d => 1,
-      0x1e => 1,
-      0x1f => 1
-    }.compare_by_identity.freeze
-
-    autoload :CharWidth, "#{__dir__}/text/char_width.rb"
+    @ctrlchar_width =
+      Hash
+        .new(2)
+        .compare_by_identity
+        .merge!(
+          0x00 => 0,
+          0x01 => 1,
+          0x02 => 1,
+          0x03 => 1,
+          0x04 => 1,
+          0x05 => 0,
+          0x06 => 1,
+          0x07 => 0,
+          0x08 => 0,
+          0x09 => 8,
+          0x0a => 0,
+          0x0b => 0,
+          0x0c => 0,
+          0x0d => 0,
+          0x0e => 0,
+          0x0f => 0,
+          0x10 => 1,
+          0x11 => 1,
+          0x12 => 1,
+          0x13 => 1,
+          0x14 => 1,
+          0x15 => 1,
+          0x16 => 1,
+          0x17 => 1,
+          0x18 => 1,
+          0x19 => 1,
+          0x1a => 1,
+          0x1b => 1,
+          0x1c => 1,
+          0x1d => 1,
+          0x1e => 1,
+          0x1f => 1
+        )
+        .freeze
+
+    cw_file = "#{__dir__}/text/char_width.rb"
+    autoload :CharWidth, cw_file
+    autoload :UNICODE_VERSION, cw_file
 
     private_constant :Osc, :Csi, :CsiEnd, :Word, :WordEx, :CharWidth
   end

data/lib/terminal/version.rb

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

data/lib/terminal.rb

@@ -1,7 +1,8 @@
 # frozen_string_literal: true
 
-require_relative 'terminal/ansi'
+require_relative 'terminal/output'
 require_relative 'terminal/input'
+require_relative 'terminal/ansi'
 
 #
 # Terminal access with support for ANSI control codes and
@@ -16,41 +17,7 @@ require_relative 'terminal/input'
 #
 module Terminal
   class << self
-    # Return `true` if the current terminal supports ANSI control codes for
-    # output.
-    # In this case all output methods ({<<}, {print}, {puts}) will forward ANSI
-    # control codes to the terminal and translate BBCode (see {Ansi.bbcode}).
-    #
-    # When `false` is returned (ANSI is not supported) the output methods will
-    # not forward ANSI control codes and BBCodes will be removed.
-    # The {colors} method will just return 2 (two).
-    #
-    # @see tui?
-    #
-    # @attribute [r] ansi?
-    # @return [true, false] whether ANSI control codes are supported for output
-    def ansi? = @ansi
-
-    # Return `true` if the current terminal supports ANSI control codes for
-    # input _and_ output.
-    # In this case not only all output methods ({<<}, {print}, {puts}) will
-    # forward ANSI control codes to the terminal and translate BBCode
-    # (see {Ansi.bbcode}). But also the input methods {read_key_event} and
-    # {on_key_event} will support extended key codes, mouse  and focus events.
-    #
-    # @see ansi?
-    #
-    # @attribute [r] tui?
-    # @return [true, false]
-    #   whether ANSI control codes are supported for input and output
-    def tui?
-      case input_mode
-      when :csi_u, :legacy
-        @ansi
-      else
-        false
-      end
-    end
+    # @!group Attributes
 
     # Terminal application identifier.
     #
@@ -66,188 +33,9 @@ module Terminal
     # @return [Symbol, nil] the application identifier
     def application = (@application ||= Detect.application)
 
-    # Number of supported colors.
-    # The detection checks various conditions to find the correct value. The
-    # most common values are
-    #
-    # - `16_777_216` for 24-bit encoding ({true_color?} return true)
-    # - `256` for 8-Bit encoding
-    # - `52` for some Unix terminals with an extended color palette
-    # - `8` for 3-/4-bit encoding
-    # - `2` if ANSI is not supported in general ({ansi?} return false)
-    #
-    # @attribute [r] colors
-    # @return [Integer] number of supported colors
-    def colors = (@colors ||= ansi? ? Detect.colors : 2)
-
-    # Screen column count.
-    # See {size} for support and detection details.
-    #
-    # @attribute [r] columns
-    # @return [Integer] number of available columns
-    def columns = size[1]
-
-    # @attribute [w] columns
-    def columns=(value)
-      self.size = [rows, value]
-    end
-
-    # Current cursor position.
-    # This is only available when ANSI is supported ({ansi?} return true).
-    #
-    # @attribute [r] pos
-    # @return [[Integer, Integer]] cursor position as rows and columns
-    # @return [nil] for incompatible terminals
-    def pos
-      @con&.cursor
-    rescue IOError
-      @con = nil
-    end
-
-    # @attribute [w] pos
-    def pos=(pos)
-      @con&.cursor = pos
-    rescue IOError
-      @con = nil
-    end
-
-    # Screen row count.
-    # See {size} for support and detection details.
-    #
-    # @attribute [r] rows
-    # @return [Integer] number of available rows
-    def rows = size[0]
-
-    # @attribute [w] rows
-    def rows=(value)
-      self.size = [value, columns]
-    end
-
-    # Screen size as a tuple of {rows} and {columns}.
-    #
-    # If the terminal does not support the report of it's dimension or ANSI
-    # is not supported in general then environment variables `COLUMNS` and
-    # `LINES` will be used.
-    # If this failed `[25, 80]` will be returned as default.
-    #
-    # Setting the terminal size is not widely supported.
-    #
-    # @see rows
-    # @see columns
-    #
-    # @attribute [r] size
-    # @return [[Integer, Integer]] available screen size as rows and columns
-    def size
-      @size ||= @inf&.winsize || _default_size
-    rescue IOError
-      @inf = nil
-      @size = _default_size
-    end
-
-    # @attribute [w] size
-    def size=(size)
-      @inf&.winsize = size
-    rescue IOError
-      @inf = nil
-    end
-
-    # @see colors
-    # @attribute [r] true_color?
-    # @return [true, false] whether true colors are supported
-    def true_color? = (colors == 16_777_216)
-
-    # Hide the cursor.
-    # Will not send the control code if the cursor is already hidden.
-    #
-    # When you called {hide_cursor} n-times you need to call {show_cursor}
-    # n-times to show the cursor again.
-    #
-    # @return [Terminal] itself
-    def hide_cursor
-      raw_write(Ansi::CURSOR_HIDE) if ansi? && (@cc += 1) == 1
-      self
-    end
-
-    # Show the cursor.
-    # Will not send the control code if the cursor is not hidden.
-    #
-    # When you called {hide_cursor} n-times you need to call {show_cursor}
-    # n-times to show the cursor again.
-    #
-    # @return [Terminal] itself
-    def show_cursor
-      raw_write(Ansi::CURSOR_SHOW) if @cc > 0 && (@cc -= 1).zero?
-      self
-    end
+    # @!endgroup
 
-    # Show the alternate screen.
-    # Will not send the control code if the alternate screen is already used.
-    #
-    # When you called {show_alt_screen} n-times you need to call
-    # {hide_alt_screen} n-times to show the default screen again.
-    #
-    # @return [Terminal] itself
-    def show_alt_screen
-      raw_write(Ansi::SCREEN_ALTERNATE) if ansi? && (@as += 1) == 1
-      self
-    end
-
-    # Hide the alternate screen.
-    # Will not send the control code if the alternate screen is not used.
-    #
-    # When you called {show_alt_screen} n-times you need to call
-    # {hide_alt_screen} n-times to show the default screen again.
-    #
-    # @return [Terminal] itself
-    def hide_alt_screen
-      raw_write(Ansi::SCREEN_ALTERNATE_OFF) if @as > 0 && (@as -= 1).zero?
-      self
-    end
-
-    # Writes the given object to the terminal.
-    # Interprets embedded BBCode.
-    #
-    # @param object [#to_s] object to write
-    # @return [Terminal] itself
-    def <<(object)
-      @out.write(Ansi.bbcode(object)) if @out && object != nil
-      self
-    rescue IOError
-      @out = nil
-      self
-    end
-
-    # Writes the given objects to the terminal.
-    # Optionally interprets embedded BBCode.
-    #
-    # @param objects [Array<#to_s>] any number of objects to write
-    # @param bbcode [true|false] whether to interpret embedded BBCode
-    # @return [nil]
-    def print(*objects, bbcode: true)
-      return if @out.nil? || objects.empty?
-      return @out.print(*objects) unless bbcode
-      @out.print(*objects.map! { Ansi.bbcode(_1) })
-    rescue IOError
-      @out = nil
-    end
-
-    # Writes the given objects to the terminal.
-    # Writes a newline after each object that does not already end with a
-    # newline sequence in it's String represenation.
-    # If called without any arguments, writes a newline only.
-    #
-    # Optionally interprets embedded BBCode.
-    #
-    # @param (see print)
-    # @return (see print)
-    def puts(*objects, bbcode: true)
-      return unless @out
-      return @out.puts(objects.empty? ? nil : objects) unless bbcode
-      objects.flatten!
-      @out.puts(objects.empty? ? nil : objects.map! { Ansi.bbcode(_1) })
-    rescue IOError
-      @out = nil
-    end
+    # @!group Tool methods
 
     # Execute a command and report command output line by line
     # or capture the output.
@@ -314,77 +102,7 @@ module Terminal
       ]
     end
 
-    # @private
-    def raw_write(str)
-      @out&.syswrite(str)
-    rescue IOError
-      @out = nil
-    end
-
-    private
-
-    def _default_size
-      rows = ENV['LINES'].to_i
-      columns = ENV['COLUMNS'].to_i
-      [rows > 0 ? rows : 25, columns > 0 ? columns : 80]
-    end
-
-    def _determine_modes
-      # order is important!
-      tty = STDOUT.tty?
-      return tty, true if ENV['ANSI'] == 'force'
-      return false, false if ENV.key?('NO_COLOR') || ENV['TERM'] == 'dumb'
-      [tty, tty]
-    rescue IOError
-      [nil, false]
-    end
-  end
-
-  @cc = @as = 0
-  tty, @ansi = _determine_modes
-
-  unless tty.nil?
-    @out = STDOUT
-    @out.sync = true
-    if tty
-      @inf = STDOUT
-      @con = IO.console
-      Signal.trap('WINCH') { @size = nil } if Signal.list.key?('WINCH')
-    end
-  end
-
-  unless @ansi
-    @plain = ->(s) { Ansi.plain(s) }
-    @undecorate = ->(s) { Ansi.undecorate(s) }
-
-    class << self
-      alias << <<
-      def <<(object)
-        @out.write(Ansi.plain(object)) if @out && object != nil
-        self
-      rescue IOError
-        @out = nil
-        self
-      end
-
-      alias print print
-      def print(*objects, bbcode: true)
-        return if @out.nil? || objects.empty?
-        @out.print(*objects.map!(&(bbcode ? @plain : @undecorate)))
-      rescue IOError
-        @out = nil
-      end
-
-      alias puts puts
-      def puts(*objects, bbcode: true)
-        return unless @out
-        objects.flatten!
-        return @out.puts if objects.empty?
-        @out.puts(objects.map!(&(bbcode ? @plain : @undecorate)))
-      rescue IOError
-        @out = nil
-      end
-    end
+    # @!endgroup
   end
 
   dir = "#{__dir__}/terminal"

data/terminal_rb.gemspec

@@ -21,7 +21,9 @@ Gem::Specification.new do |spec|
   spec.homepage = 'https://codeberg.org/mblumtritt/Terminal.rb'
   spec.metadata['source_code_uri'] = spec.homepage
   spec.metadata['bug_tracker_uri'] = "#{spec.homepage}/issues"
-  spec.metadata['documentation_uri'] = 'https://rubydoc.info/gems/terminal_rb'
+  spec.metadata['documentation_uri'] = "https://rubydoc.info/gems/terminal_rb/#{
+    Terminal::VERSION
+  }"
   spec.metadata['rubygems_mfa_required'] = 'true'
   spec.metadata['yard.run'] = 'yard'
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: terminal_rb
 version: !ruby/object:Gem::Version
-  version: 0.17.2
+  version: 0.19.0
 platform: ruby
 authors:
 - Mike Blumtritt
@@ -35,7 +35,12 @@ files:
 - lib/terminal/ansi/named_colors.rb
 - lib/terminal/detect.rb
 - lib/terminal/input.rb
+- lib/terminal/input/ansi.rb
+- lib/terminal/input/dumb.rb
 - lib/terminal/input/key_event.rb
+- lib/terminal/output.rb
+- lib/terminal/output/ansi.rb
+- lib/terminal/output/dumb.rb
 - lib/terminal/rspec/helper.rb
 - lib/terminal/shell.rb
 - lib/terminal/text.rb
@@ -50,7 +55,7 @@ licenses:
 metadata:
   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
+  documentation_uri: https://rubydoc.info/gems/terminal_rb/0.19.0
   rubygems_mfa_required: 'true'
   yard.run: yard
 rdoc_options: []
@@ -67,7 +72,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 4.0.1
+rubygems_version: 4.0.4
 specification_version: 4
 summary: Fast terminal access with ANSI, CSIu, mouse events, BBCode, word-wise line
   break support and much more.