natty-ui 0.5.3 → 0.7.0

data/lib/natty-ui/ansi.rb

@@ -60,17 +60,23 @@ module NattyUI
       def cursor_left(columns = nil) = "\e[#{columns}D"
 
       # @param lines [Integer] number of lines
-      # @return [String] ANSI code to move the cursor to beginning of the line some lines down
+      # @return [String] ANSI code to move the cursor to beginning of the line
+      #   some lines down
       def cursor_line_down(lines = nil) = "\e[#{lines}E"
 
       # @param lines [Integer] number of lines
-      # @return [String] ANSI code to move the cursor to beginning of the line some lines up
+      # @return [String] ANSI code to move the cursor to beginning of the line
+      #   some lines up
       def cursor_line_up(lines = nil) = "\e[#{lines}F"
 
       # @param columns [Integer] number of columns
-      # @return [String] ANSI code to move the cursor to giben column
+      # @return [String] ANSI code to move the cursor to given column
       def cursor_column(columns = nil) = "\e[#{columns}G"
 
+      # @return [String] ANSI code positioning the cursor on right hand side of
+      #   the terminal
+      def cursor_right_aligned = "\e[9999G\e[D\e[C"
+
       # @return [String] ANSI code to hide the cursor
       def cursor_hide = "\e[?25l"
 
@@ -107,6 +113,14 @@ module NattyUI
         attributes.empty? ? "#{obj}" : "#{attributes}#{obj}#{"\e[0m" if reset}"
       end
 
+      # Remove ANSI attribtes from given string.
+      #
+      # @see embellish
+      #
+      # @param str [#to_s] string to be modified
+      # @return [String] string without ANSI attributes
+      def blemish(str) = str.to_s.gsub(/(\x1b\[(?~[a-zA-Z])[a-zA-Z])/, '')
+
       # Combine given ANSI `attributes`.
       #
       # ANSI attribute names are:
@@ -119,55 +133,57 @@ module NattyUI
       # `fraktur_off`, `underline_off`, `blink_off`, `proportional`, `spacing`,
       # `invert_off`, `reverse_off`, `reveal`, `strike_off`, `proportional_off`,
       # `spacing_off`, `framed`, `encircled`, `overlined`, `framed_off`,
-      # `encircled_off`, `overlined_off`
+      # `encircled_off`, `overlined_off`.
       #
-      # Colors can specified by their name for ANSI 4-bit colors:
+      # Colors can specified by their name for ANSI 3-bit and 4-bit colors:
       # `black`, `red`, `green`, `yellow`, `blue`, `magenta`, `cyan`, `white`,
-      # `default`, `bright_black`, `bright_red`, `bright_green`, `bright_yellow`,
-      # `bright_blue`, `bright_magenta`, `bright_cyan`, `bright_white`
+      # `default`, `bright_black`, `bright_red`, `bright_green`,
+      # `bright_yellow`, `bright_blue`, `bright_magenta`, `bright_cyan`,
+      # `bright_white`.
       #
-      # For 8-bit ANSI colors you can use a prefixed integer number:
-      # `i0`...`i255`.
+      # For 8-bit ANSI colors use 2-digit hexadecimal values `00`...`ff`.
       #
-      # To use RGB ANSI colors just specify the hexadecimal code like `#XXXXXX`
-      # or the short form `#XXX`.
+      # To use RGB ANSI colors (24-bit colors) specify 3-digit or 6-digit
+      # hexadecimal values `000`...`fff` or `000000`...`ffffff`.
+      # This represent the `RRGGBB` values (or `RGB` for short version) like you
+      # may known from CSS color notation.
       #
       # To use a color as background color prefix the color attribute with `bg_`
       # or `on_`.
       #
       # To use a color as underline color prefix the color attribute with `ul_`.
       #
-      # To make it more clear a color attribute should be used as fereground
-      # color the code can be prefixed with `fg_`.
+      # To make it more clear a color attribute have to be used as foreground
+      # color the color value can be prefixed with `fg_`.
       #
       # @example Valid Foreground Color Attributes
       #   Ansi[:yellow]
-      #   Ansi["#fab"]
-      #   Ansi["#00aa00"]
+      #   Ansi['#fab']
+      #   Ansi['#00aa00']
       #   Ansi[:fg_fab]
       #   Ansi[:fg_00aa00]
-      #   Ansi[:i196]
-      #   Ansi[:fg_i196]
+      #   Ansi[:af]
+      #   Ansi[:fg_af]
       #
       # @example Valid Background Color Attributes
       #   Ansi[:bg_yellow]
       #   Ansi[:bg_fab]
       #   Ansi[:bg_00aa00]
       #   Ansi['bg#00aa00']
-      #   Ansi[:bg_i196]
+      #   Ansi[:bg_af]
       #
       #   Ansi[:on_yellow]
       #   Ansi[:on_fab]
       #   Ansi[:on_00aa00]
       #   Ansi['on#00aa00']
-      #   Ansi[:on_i196]
+      #   Ansi[:on_af]
       #
       # @example Valid Underline Color Attributes
-      #   Ansi[:underline, :yellow]
+      #   Ansi[:underline, :ul_yellow]
       #   Ansi[:underline, :ul_fab]
       #   Ansi[:underline, :ul_00aa00]
       #   Ansi[:underline, 'ul#00aa00']
-      #   Ansi[:underline, :ul_i196]
+      #   Ansi[:underline, :ul_fa]
       #   Ansi[:underline, :ul_bright_yellow]
       #
       # @example Combined attributes:
@@ -182,7 +198,7 @@ module NattyUI
             .map do |arg|
               case arg
               when Symbol, String
-                ATTRIBUTES[arg] || named_color(arg) || invalid_argument(arg)
+                ATTRIBUTES[arg] || color(arg) || invalid_argument(arg)
               when (0..255)
                 "38;5;#{arg}"
               when (256..512)
@@ -211,11 +227,10 @@ module NattyUI
       # @return [String] combined ANSI attributes
       # @return [nil] when string does not contain valid attributes
       def try_convert(attributes)
-        attributes = attributes.to_s.split
-        return if attributes.empty?
+        return if (attributes = attributes.to_s.split).empty?
         "\e[#{
           attributes
-            .map { |arg| ATTRIBUTES[arg] || named_color(arg) || return }
+            .map { |arg| ATTRIBUTES[arg] || color(arg) || return }
             .join(';')
         }m"
       end
@@ -230,41 +245,37 @@ module NattyUI
         )
       end
 
-      def named_color(value)
-        case value
-        when /\A(fg_|fg:|fg)?#?([[:xdigit:]]{3})\z/
-          hex_rgb_short(38, Regexp.last_match(2))
-        when /\A(fg_|fg:|fg)?#?([[:xdigit:]]{6})\z/
-          hex_rgb(38, Regexp.last_match(2))
-        when /\A(bg_|bg:|bg|on_|on:|on)#?([[:xdigit:]]{3})\z/
-          hex_rgb_short(48, Regexp.last_match(2))
-        when /\A(bg_|bg:|bg|on_|on:|on)#?([[:xdigit:]]{6})\z/
-          hex_rgb(48, Regexp.last_match(2))
-        when /\A(ul_|ul:|ul)#?([[:xdigit:]]{3})\z/
-          hex_rgb_short(58, Regexp.last_match(2))
-        when /\A(ul_|ul:|ul)#?([[:xdigit:]]{6})\z/
-          hex_rgb(58, Regexp.last_match(2))
-        when /\A(fg_|fg:|fg)?i([[:digit:]]{1,3})\z/
-          number(38, Regexp.last_match(2))
-        when /\A(bg_|bg:|bg|on_|on:|on)i([[:digit:]]{1,3})\z/
-          number(48, Regexp.last_match(2))
-        when /\A(ul_|ul:|ul)i([[:digit:]]{1,3})\z/
-          number(58, Regexp.last_match(2))
+      def color(val)
+        val = val.to_s.downcase
+        base =
+          if val.delete_prefix!('fg')
+            val.delete_prefix!(':') || val.delete_prefix!('_')
+            '38;'
+          elsif val.delete_prefix!('ul')
+            val.delete_prefix!(':') || val.delete_prefix!('_')
+            '58;'
+          elsif val.delete_prefix!('bg') || val.delete_prefix!('on')
+            val.delete_prefix!(':') || val.delete_prefix!('_')
+            '48;'
+          else
+            '38;'
+          end
+        val.delete_prefix!('#')
+        case val.size
+        when 2
+          "#{base}5;#{val.hex}" if /\A[[:xdigit:]]+\z/.match?(val)
+        when 3
+          if /\A[[:xdigit:]]+\z/.match?(val)
+            "#{base}2;#{(val[0] * 2).hex};#{(val[1] * 2).hex};#{
+              (val[2] * 2).hex
+            }"
+          end
+        when 6
+          if /\A[[:xdigit:]]+\z/.match?(val)
+            "#{base}2;#{val[0, 2].hex};#{val[2, 2].hex};#{val[4, 2].hex}"
+          end
         end
       end
-
-      def number(base, str)
-        index = str.to_i
-        "#{base};5;#{index}" if index >= 0 && index <= 255
-      end
-
-      def hex_rgb_short(base, str)
-        "#{base};2;#{(str[0] * 2).hex};#{(str[1] * 2).hex};#{(str[2] * 2).hex}"
-      end
-
-      def hex_rgb(base, str)
-        "#{base};2;#{str[0, 2].hex};#{str[2, 2].hex};#{str[4, 2].hex}"
-      end
     end
 
     ATTRIBUTES =
@@ -282,7 +293,6 @@ module NattyUI
         rapid_blink: 6,
         # ---
         invert: 7,
-        reverse: 7,
         # ---
         conceal: 8,
         hide: 8,
@@ -319,7 +329,6 @@ module NattyUI
         spacing: 26,
         # ---
         invert_off: 27,
-        reverse_off: 27,
         # ---
         reveal: 28,
         # ---

data/lib/natty-ui/ansi_wrapper.rb

@@ -1,8 +1,7 @@
 # frozen_string_literal: true
 
-require 'io/console'
-require_relative 'wrapper'
 require_relative 'ansi'
+require_relative 'wrapper'
 
 module NattyUI
   class AnsiWrapper < Wrapper
@@ -23,10 +22,7 @@ module NattyUI
 
     protected
 
-    def embellish(obj)
-      obj = NattyUI.embellish(obj)
-      obj.empty? ? nil : obj
-    end
+    def embellish(obj) = (obj = NattyUI.embellish(obj)).empty? ? nil : obj
 
     def temp_func
       count = @lines_written
@@ -69,6 +65,7 @@ module NattyUI
         task: 117
       }.compare_by_identity.freeze
     end
+    private_constant :Message
 
     class Section < Section
       def temporary
@@ -97,6 +94,7 @@ module NattyUI
         @prefix = Ansi.embellish(@prefix, *prefix_attr)
       end
     end
+    private_constant :Section
 
     class Heading < Heading
       protected
@@ -109,20 +107,52 @@ module NattyUI
       PREFIX = Ansi[39].freeze
       MSG = Ansi[:bold, 231].freeze
     end
+    private_constant :Heading
 
-    class Framed < Framed
+    class Framed < Section
       protected
 
+      def initialize(parent, title:, type:, **opts)
+        @parent = parent
+        title = title.to_s.tr("\r\n\t", '')
+        topl, topr, botl, botr, hor, vert = *components(type)
+        width = available_width
+        rcount = [width - _plain_width(title) - 6, 0].max
+        parent.puts(
+          "#{COLOR}#{topl}#{hor}#{hor}#{Ansi.reset} " \
+            "#{TITLE_ATTR}#{title}#{Ansi.reset} " \
+            "#{COLOR}#{hor * rcount}#{topr}#{Ansi.reset}"
+        )
+        @bottom = "#{COLOR}#{botl}#{hor * (width - 2)}#{botr}#{Ansi.reset}"
+        vert = "#{COLOR}#{vert}#{Ansi.reset}"
+        super(
+          parent,
+          prefix: "#{vert} ",
+          suffix:
+            "#{Ansi.cursor_right_aligned}" \
+              "#{Ansi.cursor_left(suffix_width)}#{vert}",
+          **opts
+        )
+      end
+
+      def suffix = "#{super} "
+      def finish = parent.puts(@bottom)
+
       def components(type)
-        top_start, top_suffix, left, bottom = super
-        [
-          "#{Ansi[39]}#{top_start}#{Ansi[:bold, 231]}",
-          "#{Ansi[:reset, 39]}#{top_suffix}#{Ansi.reset}",
-          Ansi.embellish(left, 39),
-          Ansi.embellish(bottom, 39)
-        ]
+        COMPONENTS[type] || raise(ArgumentError, "invalid frame type - #{type}")
       end
+
+      COLOR = Ansi[39].freeze
+      TITLE_ATTR = Ansi[:bold, 231].freeze
+      COMPONENTS = {
+        rounded: %w[╭ ╮ ╰ ╯ ─ │],
+        simple: %w[┌ ┐ └ ┘ ─ │],
+        heavy: %w[┏ ┓ ┗ ┛ ━ ┃],
+        semi: %w[┍ ┑ ┕ ┙ ━ │],
+        double: %w[╔ ╗ ╚ ╝ ═ ║]
+      }.compare_by_identity.freeze
     end
+    private_constant :Framed
 
     class Ask < Ask
       protected
@@ -135,6 +165,16 @@ module NattyUI
 
       PREFIX = "#{Ansi[:bold, :italic, 220]}▶︎#{Ansi[:reset, 220]}".freeze
     end
+    private_constant :Ask
+
+    class Request < Request
+      def prompt(question) = "#{prefix}#{PREFIX} #{question}#{Ansi.reset} "
+      def finish = (wrapper.stream << FINISH).flush
+
+      PREFIX = "#{Ansi[:bold, :italic, 220]}▶︎#{Ansi[:reset, 220]}".freeze
+      FINISH = (Ansi.cursor_line_up + Ansi.line_erase_to_end).freeze
+    end
+    private_constant :Request
 
     class Query < Query
       protected
@@ -146,47 +186,41 @@ module NattyUI
 
       PROMPT = Ansi.embellish(':', :bold, 220).freeze
     end
+    private_constant :Query
 
     class Task < Message
       include ProgressAttributes
       include TaskMethods
     end
+    private_constant :Task
 
     class Progress < Progress
       protected
 
-      def draw_title(title)
+      def draw(title)
         @prefix = "#{prefix}#{TITLE_PREFIX}#{title}#{Ansi.reset} "
-        (wrapper.stream << @prefix).flush
+        (wrapper.stream << @prefix << Ansi.cursor_hide).flush
         @prefix = "#{Ansi.line_clear}#{@prefix}"
-        if @max_value
-          @prefix << BAR_COLOR
-        else
-          @prefix << INDICATOR_ATTRIBUTE
-          @indicator = 0
-        end
+        return @prefix << BAR_COLOR if @max_value
+        @prefix << INDICATOR_ATTRIBUTE
+        @indicator = 0
       end
 
-      def draw_final = (wrapper.stream << Ansi.line_clear).flush
-
       def redraw
         (wrapper.stream << @prefix << (@max_value ? fullbar : indicator)).flush
       end
 
+      def end_draw = (wrapper.stream << ERASE).flush
       def indicator = '─╲│╱'[(@indicator += 1) % 4]
+      # def indicator = '⣷⣯⣟⡿⢿⣻⣽⣾'[(@indicator += 1) % 8]
 
       def fullbar
         percent = @value / @max_value
         count = (30 * percent).to_i
+        mv = max_value.to_i.to_s
         "#{'█' * count}#{BAR_BACK}#{'▁' * (30 - count)}" \
-          "#{BAR_INK} #{
-            format(
-              '%<value>.0f/%<max_value>.0f (%<percent>.2f%%)',
-              value: @value,
-              max_value: @max_value,
-              percent: percent * 100
-            )
-          }"
+          "#{BAR_INK} #{value.to_i.to_s.rjust(mv.size)}/#{mv} " \
+          "(#{(percent * 100).round(2).to_s.rjust(6)})"
       end
 
       TITLE_PREFIX = "#{Ansi[:bold, :italic, 117]}➔#{Ansi[:reset, 117]} ".freeze
@@ -194,7 +228,9 @@ module NattyUI
       BAR_COLOR = Ansi[39, 295].freeze
       BAR_BACK = Ansi[236, 492].freeze
       BAR_INK = Ansi[:bold, 255, :on_default].freeze
+      ERASE = (Ansi.line_clear + Ansi.cursor_show).freeze
     end
+    private_constant :Progress
 
     PAGE_BEGIN =
       "#{Ansi.reset}#{Ansi.cursor_save_pos}#{Ansi.screen_save}" \

data/lib/natty-ui/features.rb

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+module NattyUI
+  #
+  # Features of {NattyUI} - methods to display natty elements.
+  #
+  module Features
+    # Print a horizontal rule
+    #
+    # @param [#to_s] symbol string to build the horizontal rule
+    # @return [Wrapper, Wrapper::Element] itself
+    def hr(symbol = '═')
+      symbol = symbol.to_s
+      size = _plain_width(symbol)
+      return self if size.zero?
+      msg = symbol * ((available_width - 1) / size)
+      return puts(msg, prefix: Ansi[39], suffix: Ansi.reset) if wrapper.ansi?
+      puts(msg)
+    end
+
+    protected
+
+    def _plain_width(str) = NattyUI.display_width(NattyUI.plain(str))
+    def _blemish_width(str) = NattyUI.display_width(Ansi.blemish(str))
+
+    def _element(type, ...)
+      wrapper.class.const_get(type).__send__(:new, self).__send__(:_call, ...)
+    end
+
+    def _section(owner, type, args, **opts, &block)
+      sec = wrapper.class.const_get(type).__send__(:new, owner, **opts)
+      sec.puts(*args) if args && !args.empty?
+      block ? sec.__send__(:_call, &block) : sec
+    end
+  end
+end

data/lib/natty-ui/version.rb

@@ -2,5 +2,5 @@
 
 module NattyUI
   # @return [String] the version number of the gem
-  VERSION = '0.5.3'
+  VERSION = '0.7.0'
 end

data/lib/natty-ui/wrapper/ask.rb

@@ -17,7 +17,7 @@ module NattyUI
     #   when true
     #     sec.info('Yeah!!')
     #   when false
-    #     sec.write("That's pitty!")
+    #     sec.write("That's pity!")
     #   else
     #     sec.failed('You should have an opinion!')
     #   end
@@ -59,7 +59,7 @@ module NattyUI
       def read(yes, no)
         while true
           char = NattyUI.in_stream.getch
-          return if "\u0003\u0004\e".include?(char)
+          return if "\3\4\e".include?(char)
           return true if yes.include?(char)
           return false if no.include?(char)
         end
@@ -67,9 +67,9 @@ module NattyUI
 
       def grab(yes, no)
         yes = yes.to_s.chars.uniq
+        raise(ArgumentError, ':yes can not be empty') if yes.empty?
         no = no.to_s.chars.uniq
-        raise(ArgumentError, ':yes can not be emoty') if yes.empty?
-        raise(ArgumentError, ':no can not be emoty') if no.empty?
+        raise(ArgumentError, ':no can not be empty') if no.empty?
         return yes, no if (yes & no).empty?
         raise(ArgumentError, 'chars in :yes and :no can not be intersect')
       end

data/lib/natty-ui/wrapper/element.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-require_relative 'features'
+require_relative '../features'
 
 module NattyUI
   class Wrapper
@@ -36,7 +36,10 @@ module NattyUI
       protected
 
       def prefix = "#{@parent.__send__(:prefix)}#{@prefix}"
-      def suffix = "#{@parent.__send__(:suffix)}#{@suffix}"
+      def suffix = "#{@suffix}#{@parent.__send__(:suffix)}"
+      def prefix_width = _blemish_width(prefix)
+      def suffix_width = _blemish_width(suffix)
+      def available_width = wrapper.screen_columns - prefix_width - suffix_width
       def finish = nil
 
       def wrapper
@@ -46,7 +49,7 @@ module NattyUI
         @wrapper
       end
 
-      def initialize(parent) = (@parent = parent)
+      def initialize(parent, **_) = (@parent = parent)
 
       def _close(state)
         return self if @status

data/lib/natty-ui/wrapper/list_in_columns.rb

@@ -0,0 +1,81 @@
+# frozen_string_literal: true
+
+require_relative 'element'
+
+module NattyUI
+  module Features
+    #
+    # Print items of a given list as columns.
+    # In the default compact format columns may have diffrent widths and the
+    # list items are ordered column-wise.
+    # The non-compact format prints all columns in same width and order the list
+    # items row-wise.
+    #
+    # @param [Array<#to_s>] args items to print
+    # @param [Boolean] compact whether to use compact format
+    # @return [Wrapper, Wrapper::Element] itself
+    def ls(*args, compact: true) = _element(:ListInColumns, args, compact)
+  end
+
+  class Wrapper
+    #
+    # An {Element} to print items of a given list as columns.
+    #
+    # @see Features#ls
+    class ListInColumns < Element
+      protected
+
+      def _call(list, compact)
+        list.flatten!
+        return parent if list.empty?
+        list.map! { |item| Item.new(item = item.to_s, _plain_width(item)) }
+        if compact
+          each_compacted(list, available_width) { |line| parent.puts(line) }
+        else
+          each(list, available_width) { |line| parent.puts(line) }
+        end
+        parent
+      end
+
+      def each(list, max_width)
+        width = list.max_by(&:width).width + 3
+        list.each_slice(max_width / width) do |slice|
+          yield(slice.map { |item| item.to_s(width) }.join)
+        end
+      end
+
+      def each_compacted(list, max_width)
+        found, widths = find_columns(list, max_width)
+        fill(found[-1], found[0].size)
+        found.transpose.each do |row|
+          row = row.each_with_index.map { |item, col| item&.to_s(widths[col]) }
+          yield(row.join)
+        end
+      end
+
+      def find_columns(list, max_width)
+        found = [list]
+        widths = [list.max_by(&:width).width]
+        1.upto(list.size - 1) do |slice_size|
+          candidate = list.each_slice(list.size / slice_size).to_a
+          cwidths = candidate.map { |ary| ary.max_by(&:width).width + 3 }
+          cwidths[-1] -= 3
+          break if cwidths.sum > max_width
+          found = candidate
+          widths = cwidths
+        end
+        [found, widths]
+      end
+
+      def fill(ary, size)
+        diff = size - ary.size
+        ary.fill(nil, ary.size, diff) if diff.positive?
+      end
+
+      Item =
+        Data.define(:str, :width) do
+          def to_s(in_width) = "#{str}#{' ' * (in_width - width)}"
+        end
+    end
+  end
+end

data/lib/natty-ui/wrapper/mixins.rb

@@ -12,7 +12,7 @@ module NattyUI
   #
   module ProgressAttributes
     # @attribute [r] completed?
-    # @return [Boolean] whether the task completed sucessfully
+    # @return [Boolean] whether the task completed successfully
     def completed? = (@status == :completed)
 
     # @attribute [r] failed?
@@ -49,9 +49,9 @@ module NattyUI
       redraw
     end
 
-    # Maximal value.
+    # Maximum value.
     #
-    # @return [Float] maximal value
+    # @return [Float] maximum value
     # @return [nil] when no max_value was configured
     attr_reader :max_value
 

data/lib/natty-ui/wrapper/progress.rb

@@ -29,17 +29,17 @@ module NattyUI
 
       protected
 
-      def initialize(parent, title:, max_value:, **_)
-        super(parent)
+      def initialize(parent, title:, max_value:, **opts)
+        super(parent, **opts)
         @final_text = [title]
         @max_value = [0, max_value.to_f].max if max_value
         @value = 0
         @progress = 0
-        draw_title(title)
+        draw(title)
       end
 
-      def draw_title(title) = (wrapper.stream << prefix << "➔ #{title} ").flush
-      def draw_final = (wrapper.stream << "\n")
+      def draw(title) = (wrapper.stream << prefix << "➔ #{title} ").flush
+      def end_draw = (wrapper.stream << "\n")
 
       def redraw
         return (wrapper.stream << '.').flush unless @max_value
@@ -50,10 +50,15 @@ module NattyUI
       end
 
       def finish
-        draw_final
+        end_draw
         return @parent.failed(*@final_text) if failed?
-        @status = :ok if @status == :closed
-        @parent.completed(*@final_text)
+        _section(
+          @parent,
+          :Message,
+          @final_text,
+          title: @final_text.shift,
+          symbol: @status = :completed
+        )
       end
     end
   end