natty-ui 0.7.0 → 0.9.0

data/lib/natty-ui/ansi_constants.rb

@@ -0,0 +1,73 @@
+# frozen_string_literal: true
+
+module NattyUI
+  module Ansi
+    CURSOR_SHOW = "\e[?25h"
+    CURSOR_HIDE = "\e[?25l"
+    CURSOR_HOME = cursor_pos(nil, nil)
+    CURSOR_FIRST_ROW = cursor_pos(1).freeze
+    CURSOR_FIRST_COLUMN = cursor_column(1).freeze
+    CURSOR_SAFE_POS_SCO = "\e[s"
+    CURSOR_RESTORE_POS_SCO = "\e[u"
+    CURSOR_SAFE_POS_DEC = "\e7"
+    CURSOR_RESTORE_POS_DEC = "\e8"
+    CURSOR_SAFE_POS = CURSOR_SAFE_POS_DEC
+    CURSOR_RESTORE_POS = CURSOR_RESTORE_POS_DEC
+
+    CURSOR_ALIGN_RIGHT = "\e[9999G\e[1D\e[1C" # @!visibility private
+
+    SCREEN_ERASE = screen_erase(:entire)
+    SCREEN_SAVE = "\e[?47h"
+    SCREEN_RESTORE = "\e[?47l"
+    SCREEN_ALTERNATE = "\e[?1049h"
+    SCREEN_ALTERNATE_OFF = "\e[?1049l"
+    SCREEN_SAVE_ATTRIBUTES = '\e[#{'
+    SCREEN_RESTORE_ATTRIBUTES = '\e[#}'
+
+    SCREEN_BLANK = "\e[0m\e[s\e[?47h\e[H\e[2J" # @!visibility private
+    SCREEN_UNBLANK = "\e[?47l\e[u\e[0m" # @!visibility private
+
+    LINE_PREVIOUS = cursor_previous_line(1).freeze
+    LINE_NEXT = cursor_next_line(1).freeze
+    LINE_ERASE = line_erase(:entire)
+
+    # ANSI control code sequence to erase the screen and set cursor position on
+    # upper left corner.
+    CLS = (CURSOR_HOME + SCREEN_ERASE).freeze
+
+    # ANSI control code sequence to erase current line and position to first
+    # column.
+    CLL = (LINE_ERASE + CURSOR_FIRST_COLUMN).freeze
+
+    # ANSI control code to reset all attributes.
+    RESET = self[:reset].freeze
+
+    BOLD = self[:bold].freeze
+    BOLD_OFF = self[:bold_off].freeze
+
+    FAINT = self[:faint].freeze
+    FAINT_OFF = self[:faint_off].freeze
+
+    ITALIC = self[:italic].freeze
+    ITALIC_OFF = self[:italic_off].freeze
+
+    STRIKE = self[:strike].freeze
+    STRIKE_OFF = self[:strike_off].freeze
+
+    UNDERLINE = self[:underline].freeze
+    DOUBLE_UNDERLINE = self[:double_underline].freeze
+    UNDERLINE_OFF = self[:underline_off].freeze
+
+    CURLY_UNDERLINE = self[:curly_underline].freeze
+    CURLY_UNDERLINE_OFF = self[:curly_underline_off].freeze
+
+    BLINK = self[:blink].freeze
+    BLINK_OFF = self[:blink_off].freeze
+
+    INVERT = self[:invert].freeze
+    INVERT_OFF = self[:invert_off].freeze
+
+    HIDE = self[:hide].freeze
+    REVEAL = self[:reveal].freeze
+  end
+end

data/lib/natty-ui/ansi_wrapper.rb

@@ -2,34 +2,85 @@
 
 require_relative 'ansi'
 require_relative 'wrapper'
+require_relative 'line_animation'
 
 module NattyUI
   class AnsiWrapper < Wrapper
     def ansi? = true
 
+    def puts(*args, **kwargs)
+      return super if args.empty? || (animation = kwargs[:animation]).nil?
+
+      prefix = kwargs[:prefix]
+      if prefix && !prefix.empty?
+        prefix = NattyUI.embellish(prefix)
+        prefix_width = kwargs[:prefix_width] || NattyUI.display_width(prefix)
+      else
+        prefix = nil
+        prefix_width = 0
+      end
+      kwargs[:prefix] = prefix
+      kwargs[:prefix_width] = prefix_width
+
+      suffix = kwargs[:suffix]
+      suffix = suffix.empty? ? nil : NattyUI.embellish(suffix) if suffix
+
+      mw = kwargs[:max_width]
+      unless mw
+        mw = screen_columns - prefix_width
+        mw -= kwargs[:suffix_width] || NattyUI.display_width(suffix) if suffix
+      end
+      kwargs[:max_width] = mw
+
+      (@stream << Ansi::CURSOR_HIDE).flush
+      animation = LineAnimation[animation].new(@stream, kwargs)
+      prefix = "#{Ansi::RESET}#{Ansi::CLL}#{prefix}"
+
+      NattyUI
+        .each_line(
+          *args.map! { NattyUI.embellish(Ansi.blemish(_1)) },
+          max_width: mw
+        )
+        .each do |line|
+          @stream << prefix
+          animation.print(line)
+          (@stream << "#{prefix}#{line}#{suffix}\n").flush
+          @lines_written += 1
+        end
+      (@stream << Ansi::CURSOR_SHOW).flush
+      self
+    end
+
     def page
       unless block_given?
         @stream.flush
         return self
       end
-      (@stream << PAGE_BEGIN).flush
+      (@stream << Ansi::SCREEN_BLANK).flush
       begin
         yield(self)
       ensure
-        (@stream << PAGE_END).flush
+        (@stream << Ansi::SCREEN_UNBLANK).flush
       end
     end
 
+    def cls
+      (@stream << Ansi::CLS).flush
+      self
+    end
+
     protected
 
-    def embellish(obj) = (obj = NattyUI.embellish(obj)).empty? ? nil : obj
+    def prepare_print(args, kwargs)
+      _prepare_print(args, kwargs) { NattyUI.embellish(_1) }
+    end
 
     def temp_func
       count = @lines_written
       lambda do
         count = @lines_written - count
         if count.nonzero?
-          @stream << Ansi.cursor_line_up(count) << Ansi.screen_erase_below
+          @stream << Ansi.cursor_prev_line(count) << Ansi.display(:erase_below)
           @lines_written -= count
         end
         @stream.flush
@@ -37,41 +88,48 @@ module NattyUI
       end
     end
 
-    class Message < Message
-      protected
+    class Progress < Progress
+      def draw(title, spinner)
+        @msg =
+          "#{@parent.prefix}#{Ansi[:bold, 39]}➔#{Ansi[:reset, 39]} " \
+            "#{title}#{Ansi::RESET} "
+        (wrapper.stream << @msg << Ansi::CURSOR_HIDE).flush
+        @msg = "#{Ansi::CLL}#{@msg}"
+        return @msg << BAR_COLOR if @max_value
+        spinner_color = Ansi[:bold, 220]
+        @spinner =
+          Enumerator.new do |y|
+            spinner.each_char { y << "#{spinner_color}#{_1}" } while true
+          end
+      end
+
+      def redraw
+        (wrapper.stream << @msg << (@max_value ? fullbar : @spinner.next)).flush
+      end
 
-      def title_attr(str, symbol)
-        color = COLORS[symbol]
-        {
-          prefix:
-            if color
-              "#{Ansi[:bold, :italic, color]}#{str}" \
-                "#{Ansi[:reset, :bold, color]} "
-            else
-              "#{Ansi[:bold, 231]}#{str} "
-            end,
-          suffix: Ansi.reset
-        }
+      def end_draw
+        (wrapper.stream << Ansi::CLL << Ansi::CURSOR_SHOW).flush
       end
 
-      COLORS = {
-        default: 231,
-        information: 117,
-        warning: 220,
-        error: 196,
-        completed: 46,
-        failed: 198,
-        query: 220,
-        task: 117
-      }.compare_by_identity.freeze
+      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} #{value.to_i.to_s.rjust(mv.size)}/#{mv} " \
+          "(#{(percent * 100).round(2).to_s.rjust(6)})"
+      end
+
+      BAR_COLOR = Ansi[39, 295].freeze
+      BAR_BACK = Ansi[236, 492].freeze
+      BAR_INK = Ansi[:bold, 255, :on_default].freeze
     end
-    private_constant :Message
+    private_constant :Progress
 
-    class Section < Section
+    module Temporary
       def temporary
-        stream = wrapper.stream
         unless block_given?
-          stream.flush
+          wrapper.stream.flush
           return self
         end
         count = wrapper.lines_written
@@ -80,163 +138,79 @@ module NattyUI
         ensure
           count = wrapper.lines_written - count
           if count.nonzero?
-            stream << Ansi.cursor_line_up(count) << Ansi.screen_erase_below
+            wrapper.stream << Ansi.cursor_prev_line(count) <<
+              Ansi.display(:erase_below)
           end
-          stream.flush
+          wrapper.stream.flush
         end
       end
+    end
+    private_constant :Temporary
 
-      protected
-
-      def initialize(parent, prefix_attr: nil, **opts)
-        super
-        return unless @prefix && prefix_attr
-        @prefix = Ansi.embellish(@prefix, *prefix_attr)
-      end
+    class Section < Section
+      include Temporary
     end
     private_constant :Section
 
-    class Heading < Heading
-      protected
+    class Quote < Quote
+      include Temporary
 
-      def enclose(weight)
-        prefix, suffix = super
-        ["#{PREFIX}#{prefix}#{MSG}", "#{PREFIX}#{suffix}#{Ansi.reset}"]
+      def initialize(...)
+        super
+        @prefix = "#{Ansi[39]}#{@prefix}#{Ansi::RESET}"
       end
-
-      PREFIX = Ansi[39].freeze
-      MSG = Ansi[:bold, 231].freeze
     end
-    private_constant :Heading
+    private_constant :Quote
 
-    class Framed < Section
-      protected
+    class Framed < Framed
+      def color(str) = "#{Ansi[39]}#{str}#{Ansi::RESET}"
 
-      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)
-        COMPONENTS[type] || raise(ArgumentError, "invalid frame type - #{type}")
+      def init(deco)
+        @prefix = "#{color(deco[0])} "
+        @suffix = "#{Ansi.cursor_column(parent.rcol)}#{color(deco[4])}"
+        aw = @parent.available_width - 2
+        parent.puts(color("#{deco[1]}#{deco[2] * aw}#{deco[3]}"))
+        @finish = color("#{deco[5]}#{deco[6] * aw}#{deco[7]}")
       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
-
-      def query(question)
-        (wrapper.stream << "#{prefix}#{PREFIX} #{question}#{Ansi.reset} ").flush
-      end
-
-      def finish = (wrapper.stream << Ansi.line_clear).flush
-
-      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
+    class Message < Section
       protected
 
-      def read(choices, result_typye)
-        wrapper.stream << "#{prefix}#{PROMPT} "
-        super
+      def initialize(parent, title:, glyph:)
+        wrapper = parent.wrapper
+        color = COLORS[glyph] || COLORS[:default]
+        glyph = wrapper.glyph(glyph) || glyph
+        prefix_width = NattyUI.display_width(glyph) + 1
+        parent.puts(
+          title,
+          prefix: "#{glyph} #{color}",
+          prefix_width: prefix_width,
+          suffix: Ansi::RESET,
+          suffix_width: 0
+        )
+        super(parent, prefix: ' ' * prefix_width, prefix_width: prefix_width)
       end
 
-      PROMPT = Ansi.embellish(':', :bold, 220).freeze
+      COLORS = {
+        default: Ansi[255],
+        information: Ansi[255],
+        warning: Ansi[221],
+        error: Ansi[208],
+        completed: Ansi[82],
+        failed: Ansi[196],
+        task: Ansi[39],
+        query: Ansi[255]
+      }.compare_by_identity.freeze
     end
-    private_constant :Query
+    private_constant :Message
 
     class Task < Message
       include ProgressAttributes
       include TaskMethods
     end
     private_constant :Task
-
-    class Progress < Progress
-      protected
-
-      def draw(title)
-        @prefix = "#{prefix}#{TITLE_PREFIX}#{title}#{Ansi.reset} "
-        (wrapper.stream << @prefix << Ansi.cursor_hide).flush
-        @prefix = "#{Ansi.line_clear}#{@prefix}"
-        return @prefix << BAR_COLOR if @max_value
-        @prefix << INDICATOR_ATTRIBUTE
-        @indicator = 0
-      end
-
-      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} #{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
-      INDICATOR_ATTRIBUTE = Ansi[:bold, 220].freeze
-      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}" \
-        "#{Ansi.cursor_home}#{Ansi.screen_erase}".freeze
-    PAGE_END =
-      "#{Ansi.screen_restore}#{Ansi.cursor_restore_pos}#{Ansi.reset}".freeze
   end
 
   private_constant :AnsiWrapper

data/lib/natty-ui/features.rb

@@ -5,32 +5,25 @@ 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)
+    # @return [Wrapper] assigned output stream wrapper
+    def wrapper
+      return @wrapper if @wrapper
+      @wrapper = @parent
+      @wrapper = @wrapper.parent until @wrapper.is_a?(Wrapper)
+      @wrapper
     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, ...)
+      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)
+    def _section(type, args = nil, owner: nil, **opts, &block)
+      sec = wrapper.class.const_get(type).__send__(:new, owner || self, **opts)
       sec.puts(*args) if args && !args.empty?
-      block ? sec.__send__(:_call, &block) : sec
+      sec.__send__(:call, &block) if block
+      sec
     end
   end
 end

data/lib/natty-ui/key_map.rb

@@ -0,0 +1,119 @@
+# frozen_string_literal: true
+
+module NattyUI
+  KEY_MAP =
+    Module # generator
+      .new do
+        def self.add_mods(name, code)
+          @mods.each_pair do |mod, prefix|
+            @map["\e[1;#{mod}#{code}"] = "#{prefix}+#{name}"
+          end
+        end
+
+        def self.add_akey(name, code)
+          @map["\e[#{code}"] = name
+          add_mods(name, code)
+        end
+
+        def self.add_fkey(name, code)
+          @map["\e[#{code}~"] = name
+          @mods.each_pair do |mod, prefix|
+            @map["\e[#{code};#{mod}~"] = "#{prefix}+#{name}"
+          end
+        end
+
+        def self.to_hash
+          # control codes
+          num = 0
+          @map = ('A'..'Z').to_h { [(num += 1).chr, "Ctrl+#{_1}"] }
+
+          add_akey('Up', 'A')
+          add_akey('Down', 'B')
+          add_akey('Right', 'C')
+          add_akey('Left', 'D')
+          add_akey('End', 'F')
+          add_akey('Home', 'H')
+
+          add_mods('F1', 'P')
+          add_mods('F2', 'Q')
+          add_mods('F3', 'R')
+          add_mods('F4', 'S')
+
+          add_fkey('DEL', '3')
+          add_fkey('PgUp', '5')
+          add_fkey('PgDown', '6')
+          add_fkey('F1', 'F1')
+          add_fkey('F2', 'F2')
+          add_fkey('F3', 'F3')
+          add_fkey('F4', 'F4')
+          add_fkey('F5', '15')
+          add_fkey('F6', '17')
+          add_fkey('F7', '18')
+          add_fkey('F8', '19')
+          add_fkey('F9', '20')
+          add_fkey('F10', '21')
+          add_fkey('F11', '23')
+          add_fkey('F12', '24')
+          add_fkey('F13', '25')
+          add_fkey('F14', '26')
+          add_fkey('F15', '28')
+          add_fkey('F16', '29')
+          add_fkey('F17', '31')
+          add_fkey('F18', '32')
+          add_fkey('F19', '33')
+          add_fkey('F20', '34')
+
+          # overrides and additionals
+          @map.merge!(
+            "\e" => 'ESC',
+            "\4" => 'DEL', # = Ctrl+D
+            "\u007F" => 'BACK',
+            "\b" => 'Ctrl+BACK',
+            "\r" => 'ENTER', # = Ctrl+M
+            "\t" => 'TAB',
+            "\e[Z" => 'Shift+TAB',
+            "\e[5" => 'PgUp',
+            "\e[6" => 'PgDown',
+            # SS3 control (VT 100 etc)
+            "\eOA" => 'Up',
+            "\eOB" => 'Down',
+            "\eOC" => 'Right',
+            "\eOD" => 'Left',
+            "\eOP" => 'F1',
+            "\eOQ" => 'F2',
+            "\eOR" => 'F3',
+            "\eOS" => 'F4',
+            "\eO2P" => 'Shift+F1',
+            "\eO2Q" => 'Shift+F2',
+            "\eO2R" => 'Shift+F3',
+            "\eO2S" => 'Shift+F4',
+            "\eOt" => 'F5',
+            "\eOu" => 'F6',
+            "\eOv" => 'F7',
+            "\eOw" => 'F8',
+            "\eOl" => 'F9',
+            "\eOx" => 'F10'
+          )
+        end
+
+        @mods = {
+          2 => 'Shift',
+          3 => 'Alt',
+          4 => 'Alt-Shift',
+          5 => 'Ctrl',
+          6 => 'Ctrl-Shift',
+          7 => 'Ctrl-Alt',
+          8 => 'Ctrl-Alt-Shift',
+          9 => 'Meta',
+          10 => 'Meta-Shift',
+          11 => 'Meta-Alt',
+          12 => 'Meta-Alt-Shift',
+          13 => 'Ctrl-Meta',
+          14 => 'Ctrl-Meta-Shift',
+          15 => 'Ctrl-Meta-Alt',
+          16 => 'Ctrl-Meta-Alt-Shift'
+        }.compare_by_identity
+      end
+      .to_hash
+      .freeze
+end

data/lib/natty-ui/line_animation/default.rb

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+module NattyUI
+  module LineAnimation
+    class Default < None
+      def initialize(*_)
+        super
+        @column = @options[:prefix_width] + 1
+        @color = color
+        @num = 0
+      end
+
+      def print(line)
+        line = plain(line)
+        time = 0.5 / line.size
+        @stream << @color
+        if (@num += 1).odd?
+          line.each_char do |char|
+            (@stream << char).flush
+            sleep(time)
+          end
+        else
+          pos = @column + line.size
+          line.reverse!
+          line.each_char do |char|
+            (@stream << Ansi.cursor_column(pos -= 1) << char).flush
+            sleep(time)
+          end
+        end
+      end
+    end
+
+    define default: Default
+  end
+end

data/lib/natty-ui/line_animation/matrix.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+module NattyUI
+  module LineAnimation
+    class Matrix < None
+      def initialize(*_)
+        super
+        @prefix = "#{to_column}#{color}"
+      end
+
+      def print(line)
+        line = plain(line)
+        str = Array.new(line.size) { CHARS.sample }.join
+        pos = Array.new(line.size, &:itself).shuffle
+        until pos.size < 4
+          pos.shift(pos.size / 4).each { str[_1] = line[_1] }
+          pos.sample(pos.size / 2).each { str[_1] = CHARS.sample }
+          (@stream << "#{@prefix}#{str}").flush
+          sleep(0.08)
+        end
+      end
+
+      CHARS = '2598Z*):.\=+-¦|_ｦｱｳｴｵｶｷｹｺｻｼｽｾｿﾀﾂﾃﾅﾆﾇﾈﾊﾋﾎﾏﾐﾑﾒﾓﾔﾕﾗﾘﾜ'.chars
+    end
+
+    define matrix: Matrix
+  end
+end