natty-ui 0.12.1 → 0.25.0

data/lib/natty-ui/width_finder.rb

@@ -0,0 +1,125 @@
+# frozen_string_literal: true
+
+module NattyUI
+  class WidthFinder
+    # sum, columns =
+    def self.find(columns, max_width, saving_by_column = 1)
+      new(columns, max_width, saving_by_column).find
+    end
+
+    # width, padding_left, padding_right =
+    def self.adjust(width, padding_left, padding_right)
+      target = (width / 2) + 1
+      padding = padding_left + padding_right
+      return width - padding, padding_left, padding_right if padding < target
+      ep = ([padding_left, padding_right].max * 100.0) / padding
+      padding = width - target
+      [
+        target,
+        padding_left = ((padding * ep) / 100).to_i,
+        padding - padding_left
+      ]
+    end
+
+    def initialize(columns, max_width, saving_by_column)
+      @max_width = max_width
+      @saving_by_column = saving_by_column
+      columns, max = fit_max_width(columns, max_width, saving_by_column)
+      default = max_width / columns.size
+      @columns = columns.map { Column.create(_1, default, max) }
+    end
+
+    def find
+      sum = @columns.sum(&:value)
+      if sum < @max_width
+        sum = expand(sum)
+      elsif @max_width < sum
+        sum = shrink(sum)
+      end
+      [sum, @columns.map(&:value)]
+    end
+
+    private
+
+    def fit_max_width(columns, max_width, saving_by_column)
+      ret = max_width - columns.size + 1
+      return columns, ret if ret >= 1
+      saving_by_column += 1
+      columns = columns.dup
+      until ret >= 1
+        columns.pop
+        ret += saving_by_column
+      end
+      [columns, ret]
+    end
+
+    def expand(sum)
+      max_width = [@columns.sum(&:max_val), @max_width].min
+      expandables = @columns.find_all(&:expandable?)
+      while !expandables.empty? && sum < max_width
+        curr = expandables.min_by(&:value)
+        curr.value += 1
+        sum += 1
+        expandables.delete(curr) unless curr.expandable?
+      end
+      sum
+    end
+
+    def shrink(sum)
+      sum = shrink_elastic(sum)
+      return sum if sum <= @max_width
+      sum = shrink_harder(sum, @columns.find_all { _1.value > 1 && _1.fix? })
+      return sum if sum <= @max_width
+      sum = shrink_harder(sum, @columns.find_all { _1.value > 1 })
+      until sum <= @max_width
+        sum -= @columns.pop.value
+        sum -= @saving_by_column
+      end
+      sum
+    end
+
+    def shrink_elastic(sum)
+      shrinkables = @columns.find_all(&:shrinkable?)
+      while !shrinkables.empty? && @max_width < sum
+        curr = shrinkables.max_by(&:min_dist)
+        curr.value -= 1
+        sum -= 1
+        shrinkables.delete(curr) unless curr.shrinkable?
+      end
+      sum
+    end
+
+    def shrink_harder(sum, shrinkables)
+      while !shrinkables.empty? && @max_width < sum
+        curr = shrinkables.max_by(&:value)
+        curr.value -= 1
+        sum -= 1
+        shrinkables.delete(curr) if curr.value == 1
+      end
+      sum
+    end
+
+    Column =
+      Struct.new(:value, :min_val, :max_val) do
+        def self.create(value, default, max)
+          case value
+          when nil
+            new(default, 1, max)
+          when Range
+            min = (value.begin || 1).clamp(1, max)
+            max = (value.end || max).clamp(1, max)
+            new(min + ((max - min) / 2), min, max)
+          else
+            new(value = value.clamp(1, max), value, value)
+          end
+        end
+
+        def shrinkable? = min_val < value
+        def expandable? = value < max_val
+        def fix? = min_val == max_val
+        def min_dist = value - min_val
+      end
+    private_constant :Column
+  end
+  private_constant :WidthFinder
+end

data/lib/natty-ui.rb

@@ -1,179 +1,121 @@
 # frozen_string_literal: true
 
-require_relative 'natty-ui/text'
-require_relative 'natty-ui/wrapper'
-require_relative 'natty-ui/ansi_wrapper'
+require 'terminal'
+require_relative 'natty-ui/features'
 
+# This is the beautiful, nice, nifty, fancy, neat, pretty, cool, rich, lovely,
+# natty user interface you like to have for your command line applications.
 #
-# Module to create beautiful, nice, nifty, fancy, neat, pretty, cool, rich,
-# lovely, natty user interfaces for your CLI application.
-#
-# It creates {Wrapper} instances which can optionally support ANSI. The UI
-# consists of {Wrapper::Element}s and {Wrapper::Section}s for different
-# {Features}.
+# The {NattyUI} ​ᓚᕠᗢ main module implements all {Features}.
 #
 module NattyUI
-  class << self
-    # @see .valid_in?
-    # @return [IO] IO stream used to read input
-    # @raise [TypeError] when a non-readable stream will be assigned
-    attr_reader :in_stream
+  # Uses the ANSI tools of the Terminal.rb gem
+  Ansi = Terminal::Ansi
 
-    # @return [Wrapper, Wrapper::Element] active UI element
-    attr_reader :element
+  # Uses the Text tools of the Terminal.rb gem
+  Text = Terminal::Text
 
-    # @param [IO] stream to read input
-    def in_stream=(stream)
-      unless valid_in?(stream)
-        raise(TypeError, "readable IO required  - #{stream.inspect}")
-      end
-      @in_stream = stream
-    end
+  extend Features
 
-    # Create a wrapper for given `stream`.
-    #
-    # @see .valid_out?
-    #
-    # @param [IO] stream valid out stream
-    # @param [Boolean, :auto] ansi whether ANSI should be supported
-    #   or automatically selected
-    # @return [Wrapper] wrapper for the given `stream`
-    # @raise [TypeError] when `stream` is not a writable stream
-    def new(stream, ansi: :auto)
-      unless valid_out?(stream)
-        raise(TypeError, "writable IO required  - #{stream.inspect}")
-      end
-      wrapper_class(stream, ansi).__send__(:new, stream)
-    end
-
-    # Test if the given `stream` can be used for input
+  class << self
+    # Current used {Element} (or {NattyUI} as top element) supporting all
+    # {Features}.
     #
-    # @param [IO] stream IO instance to test
-    # @return [Boolean] whether if the given stream is usable
-    def valid_in?(stream)
-      (stream.is_a?(IO) && !stream.closed? && stream.stat.readable?) ||
-        (stream.is_a?(StringIO) && !stream.closed_read?)
-    rescue StandardError
-      false
-    end
+    # @return [Features]
+    #   current element or itself
+    attr_reader :element
 
-    # Test if the given `stream` can be used for output
+    # Supported input mode.
     #
-    # @param [IO] stream IO instance to test
-    # @return [Boolean] whether if the given stream is usable
-    def valid_out?(stream)
-      (stream.is_a?(IO) && !stream.closed? && stream.stat.writable?) ||
-        (stream.is_a?(StringIO) && !stream.closed_write?)
-    rescue StandardError
-      false
+    # @attribute [r] input_mode
+    # @return [:default]
+    #   when terminal uses ANSI
+    # @return [:dumb]
+    #   when terminal does not support ANSI or interactive input
+    # @return [nil]
+    #   when terminal inoput is not supported
+    def input_mode
+      case Terminal.input_mode
+      when :csi_u
+        :default
+      when :legacy
+        Terminal.ansi? ? :default : :dumb
+      when :dumb
+        :dumb
+      end
     end
 
-    # Translate embedded attribute descriptions into ANSI control codes.
-    #
-    # @param [#to_s] str string to edit
-    # @return [String] edited string
-    def embellish(str) = Text.embellish(str)
-
-    # Remove embedded attribute descriptions from given string.
+    # Terminal title.
     #
-    # @param [#to_s] str string to edit
-    # @param [:keep,:remove] ansi keep or remove ANSI codes too
-    # @return [String] edited string
-    def plain(str, ansi: :keep)
-      ansi == :keep ? Text.plain_but_ansi(str) : Text.plain(str)
+    # @attribute [r] title
+    # @return [String]
+    #   configured title
+    # @return [nil]
+    #   when no title was set
+    def title = @title_stack.last
+
+    # @attribute [w] title
+    def title=(value)
+      if value
+        title = Ansi.plain(value).gsub(/\s+/, ' ')
+        _write(Ansi.tab_title(title)) if Terminal.ansi?
+        @title_stack << title
+      else
+        @title_stack.pop
+        last = @title_stack[-1]
+        _write(Ansi.tab_title(last)) if last && Terminal.ansi?
+      end
     end
 
-    # Calculate monospace (display) width of given String.
-    # It respects Unicode character sizes inclusive emoji.
-    #
-    # @param [#to_s] str string to calculate
-    # @return [Integer] the display size
-    def display_width(str) = Text.width(str)
+    # @!visibility private
+    attr_reader :lines_written
 
-    # Convert given arguments into strings and yield each line.
-    # Optionally limit the line width to given `max_width`.
-    #
-    # @overload each_line(..., max_width: nil)
-    #   @param [#to_s] ... objects converted to text lines
-    #   @param [#to_i, nil] max_width maximum line width
-    #   @yieldparam [String] line string line
-    #   @return [nil]
-    # @overload each_line(..., max_width: nil)
-    #   @param [#to_s] ... objects converted to text lines
-    #   @param [#to_i, nil] max_width maximum line width
-    #   @return [Enumerator] line enumerator
-    def each_line(*strs, max_width: nil, &block)
-      return to_enum(__method__, *strs, max_width: max_width) unless block
-      return Text.simple_each_line(strs, &block) unless max_width
-      Text.each_line(strs, max_width, &block)
+    # @!visibility private
+    def back_to_line(number, erase: true)
+      return @lines_written if (c = @lines_written - number) <= 0
+      if Terminal.ansi?
+        _write(erase ? (Ansi::LINE_ERASE_PREV * c) : Ansi.cursor_prev_line(c))
+      end
+      @lines_written = number
     end
 
-    # Read next raw key (keyboard input) from {in_stream}.
-    #
-    # The input will be returned as named key codes like "Ctrl+C" by default.
-    # This can be changed by the `mode` parameter:
-    #
-    # - `:named` - name if available (fallback to raw)
-    # - `:raw` - key code "as is"
-    # - `:both` - key code and name if available
-    #
-    # @param [:named, :raw, :both] mode modfies the result
-    # @return [String] read key
-    def read_key(mode: :named)
-      return @in_stream.getch unless defined?(@in_stream.getc)
-      return @in_stream.getc unless defined?(@in_stream.raw)
-      @in_stream.raw do |raw_stream|
-        key = raw_stream.getc
-        while (nc = raw_stream.read_nonblock(1, exception: false))
-          nc.is_a?(String) ? key += nc : break
-        end
-        return key if mode == :raw
-        return key, KEY_MAP[key]&.dup if mode == :both
-        KEY_MAP[key]&.dup || key
+    # @!visibility private
+    def alternate_screen
+      return yield unless Terminal.ansi?
+      begin
+        _write(Ansi::SCREEN_ALTERNATE)
+        yield
+      ensure
+        _write(Ansi::SCREEN_ALTERNATE_OFF)
       end
-    rescue Interrupt, SystemCallError
-      nil
     end
 
     private
 
-    def wrapper_class(stream, ansi)
-      return AnsiWrapper if ansi == true
-      return Wrapper if ansi == false || ENV.key?('NO_COLOR')
-      return AnsiWrapper if ENV['ANSI'] == '1'
-      return Wrapper if ENV['TERM'] == 'dumb'
-      stream.tty? ? AnsiWrapper : Wrapper
-    end
+    def _write(str) = Terminal.__send__(:_write, str)
 
-    def stderr_is_stdout?
-      STDOUT.tty? && STDERR.tty? && STDOUT.pos == STDERR.pos
-    rescue IOError, SystemCallError
-      false
+    def with(element)
+      Terminal.hide_cursor if @element == self
+      current, @element = @element, element
+      yield(element) if block_given?
+    ensure
+      element.done if element.respond_to?(:done)
+      Terminal.show_cursor if (@element = current) == self
     end
   end
 
-  # Instance for standard output.
-  StdOut = new(STDOUT)
-
-  # Instance for standard error output.
-  StdErr = stderr_is_stdout? ? StdOut : new(STDERR)
-
-  dir = __dir__
-  autoload(:Animation, File.join(dir, 'natty-ui', 'animation'))
-  autoload(:Frame, File.join(dir, 'natty-ui', 'frame'))
-  autoload(:Glyph, File.join(dir, 'natty-ui', 'glyph'))
-  autoload(:KEY_MAP, File.join(dir, 'natty-ui', 'key_map'))
-  autoload(:Spinner, File.join(dir, 'natty-ui', 'spinner'))
-
-  private_constant :Animation, :KEY_MAP
-
-  @element = StdOut
-  self.in_stream = STDIN
+  @element = self
+  @lines_written = 0
+  @title_stack = []
 end
 
-# @!visibility private
-module Kernel
-  # @see NattyUI.element
-  # @return [NattyUI::Wrapper, NattyUI::Wrapper::Element] active UI element
-  def ui = NattyUI.element unless defined?(ui)
+unless defined?(Kernel.ui)
+  module Kernel
+    # @attribute [r] ui
+    # @return [NattyUI::Features] current used ui element
+    # @see NattyUI.element
+    def ui = NattyUI.element
+
+    # alias ​ᓚᕠᗢ ui
+  end
 end

metadata

@@ -1,26 +1,38 @@
 --- !ruby/object:Gem::Specification
 name: natty-ui
 version: !ruby/object:Gem::Version
-  version: 0.12.1
+  version: 0.25.0
 platform: ruby
 authors:
 - Mike Blumtritt
-autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-08-18 00:00:00.000000000 Z
-dependencies: []
+date: 1980-01-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: terminal_rb
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">"
+      - !ruby/object:Gem::Version
+        version: 0.9.5
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">"
+      - !ruby/object:Gem::Version
+        version: 0.9.5
 description: |
   This is the beautiful, nice, nifty, fancy, neat, pretty, cool, rich, lovely,
   natty user interface tool you like to have for your command line applications.
   It contains elegant, simple and beautiful features that enhance your
   command line interfaces functionally and aesthetically.
-email:
 executables: []
 extensions: []
 extra_rdoc_files:
-- README.md
 - LICENSE
+- README.md
 files:
 - ".yardopts"
 - LICENSE
@@ -28,63 +40,43 @@ files:
 - examples/24bit-colors.rb
 - examples/3bit-colors.rb
 - examples/8bit-colors.rb
-- examples/animate.rb
 - examples/attributes.rb
-- examples/attributes_list.rb
-- examples/demo.rb
+- examples/cols.rb
+- examples/elements.rb
+- examples/examples.rb
 - examples/illustration.rb
 - examples/ls.rb
-- examples/message.rb
-- examples/progress.rb
-- examples/query.rb
-- examples/read_key.rb
-- examples/table.rb
+- examples/named-colors.rb
+- examples/sections.rb
+- examples/tables.rb
+- examples/tasks.rb
 - lib/natty-ui.rb
-- lib/natty-ui/animation.rb
-- lib/natty-ui/animation/binary.rb
-- lib/natty-ui/animation/default.rb
-- lib/natty-ui/animation/matrix.rb
-- lib/natty-ui/animation/rainbow.rb
-- lib/natty-ui/animation/type_writer.rb
-- lib/natty-ui/ansi.rb
-- lib/natty-ui/ansi/constants.rb
-- lib/natty-ui/ansi_wrapper.rb
-- lib/natty-ui/frame.rb
-- lib/natty-ui/glyph.rb
-- lib/natty-ui/key_map.rb
-- lib/natty-ui/preload.rb
-- lib/natty-ui/spinner.rb
-- lib/natty-ui/text.rb
-- lib/natty-ui/text/east_asian_width.rb
+- lib/natty-ui/attributes.rb
+- lib/natty-ui/choice.rb
+- lib/natty-ui/dumb_choice.rb
+- lib/natty-ui/element.rb
+- lib/natty-ui/features.rb
+- lib/natty-ui/framed.rb
+- lib/natty-ui/ls_renderer.rb
+- lib/natty-ui/progress.rb
+- lib/natty-ui/section.rb
+- lib/natty-ui/table.rb
+- lib/natty-ui/table_renderer.rb
+- lib/natty-ui/task.rb
+- lib/natty-ui/temporary.rb
+- lib/natty-ui/theme.rb
+- lib/natty-ui/utils.rb
 - lib/natty-ui/version.rb
-- lib/natty-ui/wrapper.rb
-- lib/natty-ui/wrapper/animate.rb
-- lib/natty-ui/wrapper/ask.rb
-- lib/natty-ui/wrapper/element.rb
-- lib/natty-ui/wrapper/features.rb
-- lib/natty-ui/wrapper/framed.rb
-- lib/natty-ui/wrapper/heading.rb
-- lib/natty-ui/wrapper/horizontal_rule.rb
-- lib/natty-ui/wrapper/list_in_columns.rb
-- lib/natty-ui/wrapper/message.rb
-- lib/natty-ui/wrapper/mixins.rb
-- lib/natty-ui/wrapper/progress.rb
-- lib/natty-ui/wrapper/query.rb
-- lib/natty-ui/wrapper/quote.rb
-- lib/natty-ui/wrapper/request.rb
-- lib/natty-ui/wrapper/section.rb
-- lib/natty-ui/wrapper/table.rb
-- lib/natty-ui/wrapper/task.rb
+- lib/natty-ui/width_finder.rb
 - lib/natty_ui.rb
 homepage: https://github.com/mblumtritt/natty-ui
 licenses:
 - BSD-3-Clause
 metadata:
+  rubygems_mfa_required: 'true'
   source_code_uri: https://github.com/mblumtritt/natty-ui
   bug_tracker_uri: https://github.com/mblumtritt/natty-ui/issues
-  documentation_uri: https://rubydoc.info/gems/natty-ui
-  rubygems_mfa_required: 'true'
-post_install_message:
+  documentation_uri: https://rubydoc.info/gems/natty-ui/0.25.0/NattyUI/
 rdoc_options: []
 require_paths:
 - lib
@@ -99,8 +91,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.17
-signing_key:
+rubygems_version: 3.6.9
 specification_version: 4
 summary: This is the beautiful, nice, nifty, fancy, neat, pretty, cool, rich, lovely,
   natty user interface you like to have for your CLI.

data/examples/animate.rb

@@ -1,42 +0,0 @@
-# frozen_string_literal: true
-
-require_relative '../lib/natty-ui'
-
-ui.h1 'NattyUI: Text Line Animation', space: 2
-
-TEXT = <<~TEXT.tr("\n", ' ')
-  Lorem [yellow]ipsum[/] dolor sit amet, consectetur adipisicing elit, sed
-  do eiusmod tempor incididunt ut labore et dolore [red]magna[/] aliqua.
-  Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut
-  aliquip ex ea commodo [bold]consequat[/].
-TEXT
-
-ui.message 'Default Animation' do
-  ui.animate TEXT, animation: :default
-end
-ui.space
-
-ui.message 'Shiny Rainbow' do
-  ui.animate TEXT, animation: :rainbow
-end
-ui.space
-
-ui.message 'Binary Encoded' do
-  ui.animate TEXT, animation: :binary, style: 'green', alt_style: :bright_green
-end
-ui.space
-
-ui.message 'Matrix Style' do
-  ui.animate TEXT, animation: :matrix
-end
-ui.space
-
-ui.message 'Typewriter Like' do
-  ui.animate TEXT, animation: :type_writer
-end
-ui.space
-
-ui.message 'Default Styled' do
-  ui.animate TEXT, style: 'bold bright_white on_red'
-end
-ui.space

data/examples/attributes_list.rb

@@ -1,12 +0,0 @@
-# frozen_string_literal: true
-
-require_relative '../lib/natty-ui'
-
-ui.h2 'NattyUI: All Attribute and Defined Color Names', space: 2
-
-ui.ls(
-  (NattyUI::Ansi.attribute_names + NattyUI::Ansi.color_names)
-    .sort!
-    .map! { |name| "[#{name}]#{name}" }
-)
-ui.space

data/examples/demo.rb

@@ -1,51 +0,0 @@
-# frozen_string_literal: true
-
-require_relative '../lib/natty-ui'
-
-ui.page do
-  ui.h1 'NattyUI: Examples', space: 2
-
-  ruby =
-    ENV.fetch('RUBY') do
-      require('rbconfig')
-      File.join(
-        RbConfig::CONFIG['bindir'],
-        "#{RbConfig::CONFIG['ruby_install_name']}#{RbConfig::CONFIG['EXEEXT']}"
-      ).sub(/.*\s.*/m, '"\&"')
-    end
-  run = ->(name) { system(ruby, File.join(__dir__, "#{name}.rb")) }
-  run['illustration']
-
-  ui.space
-
-  choices = {}
-  examples = {}
-  {
-    '1' => ['attributes', 'ANSI Attributes'],
-    '2' => ['3bit-colors', '3/4-bit Color Support'],
-    '3' => ['8bit-colors', '8-bit Color Support'],
-    '4' => ['24bit-colors', '24-bit Color Support'],
-    '5' => ['message', 'Message Types'],
-    '6' => ['ls', 'Print In Columns'],
-    '7' => %w[table Tables],
-    '8' => ['animate', 'Text Line Animation'],
-    '9' => ['progress', 'Progress Indication'],
-    '0' => ['query', 'User Queries'],
-    'ESC' => [nil, 'Exit Demo']
-  }.each_pair do |key, (name, descr)|
-    examples[key] = name
-    choices[key] = descr
-  end
-
-  loop do
-    choice =
-      ui.query(
-        'Which example do you like to run?',
-        display: :compact,
-        **choices
-      ) or break
-    example = examples[choice] or break
-    ui.cls
-    run[example]
-  end
-end

data/examples/message.rb

@@ -1,30 +0,0 @@
-# frozen_string_literal: true
-
-require_relative '../lib/natty-ui'
-
-ui.h1 'NattyUI: Message Types', space: 2
-
-TEXT = <<~TEXT.tr("\n", ' ')
-  Lorem [yellow]ipsum[/fg] dolor sit amet, consectetur adipisicing elit, sed
-  do eiusmod tempor incididunt ut labore et dolore [red]magna[/fg] aliqua.
-  Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut
-  aliquip ex ea commodo [b]consequat[/b].
-TEXT
-
-ui.framed do
-  ui.info 'Informative Message', TEXT
-  ui.warning 'Warning Message' do
-    ui.framed(type: :double) do
-      ui.puts(
-        '[red]>>>[/fg] [i]Important information maybe here[/i] [red]<<<',
-        align: :center
-      )
-    end
-    ui.puts('[italic f4]Ut enim ad minim veniam', align: :right)
-  end
-  ui.error 'Error Message', TEXT
-  ui.failed 'Fail Message', TEXT
-  ui.message '[italic #fad]Custom Message', TEXT, glyph: '💡'
-end
-
-ui.space