natty-ui 0.7.0 → 0.9.0

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

@@ -11,10 +11,38 @@ module NattyUI
     # The non-compact format prints all columns in same width and order the list
     # items row-wise.
     #
+    # @example simple compact list
+    #   ui.ls('apple', 'banana', 'blueberry', 'pineapple', 'strawberry')
+    #   # => apple   banana   blueberry   pineapple   strawberry
+    #
+    # @example (unordered) list with red dot
+    #   ui.ls('apple', 'banana', 'blueberry', 'pineapple', 'strawberry', glyph: '[[red]]•[[/]]')
+    #   # => • apple   • banana   • blueberry   • pineapple   • strawberry
+    #
+    # @example ordered list
+    #   ui.ls('apple', 'banana', 'blueberry', 'pineapple', 'strawberry', glyph: 1)
+    #   # => 1 apple   2 banana   3 blueberry   4 pineapple   5 strawberry
+    #
+    # @example ordered list, start at 100
+    #   ui.ls('apple', 'banana', 'blueberry', 'pineapple', 'strawberry', glyph: 100)
+    #   # => 100 apple   101 banana   102 blueberry   103 pineapple   104 strawberry
+    #
+    # @example ordered list using, uppercase characters
+    #   ui.ls('apple', 'banana', 'blueberry', 'pineapple', 'strawberry', glyph: :A)
+    #   # => A apple   B banana   C blueberry   D pineapple   E strawberry
+    #
+    # @example ordered list, using lowercase characters
+    #   ui.ls('apple', 'banana', 'blueberry', 'pineapple', 'strawberry', glyph: :a)
+    #   # => a apple   b banana   c blueberry   d pineapple   e strawberry
+    #
     # @param [Array<#to_s>] args items to print
     # @param [Boolean] compact whether to use compact format
+    # @param [nil,#to_s,Integer,Symbol] glyph optional glyph used as element
+    #   prefix
     # @return [Wrapper, Wrapper::Element] itself
-    def ls(*args, compact: true) = _element(:ListInColumns, args, compact)
+    def ls(*args, compact: true, glyph: nil)
+      _element(:ListInColumns, args, compact, glyph)
+    end
   end
 
   class Wrapper
@@ -25,22 +53,52 @@ module NattyUI
     class ListInColumns < Element
       protected
 
-      def _call(list, compact)
+      def call(list, compact, glyph)
+        return @parent if list.empty?
         list.flatten!
-        return parent if list.empty?
-        list.map! { |item| Item.new(item = item.to_s, _plain_width(item)) }
+        cvt = cvt(glyph, list.size)
+        list.map! do |item|
+          Item.new(item = cvt[item], NattyUI.display_width(item))
+        end
         if compact
-          each_compacted(list, available_width) { |line| parent.puts(line) }
+          each_compacted(list, available_width - 1) { @parent.puts(_1) }
+        else
+          each(list, available_width - 1) { @parent.puts(_1) }
+        end
+        @parent
+      end
+
+      def cvt(glyph, size)
+        case glyph
+        when nil, false
+          ->(s) { NattyUI.embellish(s) }
+        when :hex
+          pad = size.to_s(16).size
+          glyph = 0
+          lambda do |s|
+            "#{(glyph += 1).to_s(16).rjust(pad, '0')} #{NattyUI.embellish(s)}"
+          end
+        when Integer
+          pad = (glyph + size).to_s.size
+          glyph -= 1
+          ->(s) { "#{(glyph += 1).to_s.rjust(pad)} #{NattyUI.embellish(s)}" }
+        when Symbol
+          lambda do |s|
+            "#{
+              t = glyph
+              glyph = glyph.succ
+              t
+            } #{NattyUI.embellish(s)}"
+          end
         else
-          each(list, available_width) { |line| parent.puts(line) }
+          ->(s) { "#{glyph} #{NattyUI.embellish(s)}" }
         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)
+          yield(slice.map { _1.to_s(width) }.join)
         end
       end
 
@@ -58,7 +116,7 @@ module NattyUI
         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 = candidate.map { _1.max_by(&:width).width + 3 }
           cwidths[-1] -= 3
           break if cwidths.sum > max_width
           found = candidate
@@ -68,14 +126,15 @@ module NattyUI
       end
 
       def fill(ary, size)
-        diff = size - ary.size
-        ary.fill(nil, ary.size, diff) if diff.positive?
+        (diff = size - ary.size).positive? && ary.fill(nil, ary.size, diff)
       end
 
       Item =
-        Data.define(:str, :width) do
+        Struct.new(:str, :width) do
           def to_s(in_width) = "#{str}#{' ' * (in_width - width)}"
         end
+
+      private_constant :Item
     end
   end
 end

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

@@ -4,17 +4,17 @@ require_relative 'section'
 
 module NattyUI
   module Features
-    # Creates a simple message section with a highlighted `title`  and
-    # prints given additional arguments as lines into the section.
+    # Creates a section with a highlighted `title` and prints given additional
+    # arguments as lines into the section.
     #
     # @param [#to_s] title object to print as section title
     # @param [Array<#to_s>] args more objects to print
-    # @param [#to_s] symbol symbol/prefix used for the title
+    # @param [#to_s] glyph glyph/prefix used for the title
     # @yieldparam [Wrapper::Message] message the created section
     # @return [Object] the result of the code block
     # @return [Wrapper::Message] itself, when no code block is given
-    def message(title, *args, symbol: :default, &block)
-      _section(self, :Message, args, title: title, symbol: symbol, &block)
+    def message(title, *args, glyph: :default, &block)
+      _section(:Message, args, title: title, glyph: glyph, &block)
     end
     alias msg message
 
@@ -26,7 +26,7 @@ module NattyUI
     # @yieldparam (see #message)
     # @return (see #message)
     def information(title, *args, &block)
-      _section(self, :Message, args, title: title, symbol: :information, &block)
+      _section(:Message, args, title: title, glyph: :information, &block)
     end
     alias info information
 
@@ -37,7 +37,7 @@ module NattyUI
     # @yieldparam (see #message)
     # @return (see #message)
     def warning(title, *args, &block)
-      _section(self, :Message, args, title: title, symbol: :warning, &block)
+      _section(:Message, args, title: title, glyph: :warning, &block)
     end
     alias warn warning
 
@@ -48,7 +48,7 @@ module NattyUI
     # @yieldparam (see #message)
     # @return (see #message)
     def error(title, *args, &block)
-      _section(self, :Message, args, title: title, symbol: :error, &block)
+      _section(:Message, args, title: title, glyph: :error, &block)
     end
     alias err error
 
@@ -61,7 +61,7 @@ module NattyUI
     # @yieldparam (see #message)
     # @return (see #message)
     def completed(title, *args, &block)
-      _section(self, :Message, args, title: title, symbol: :completed, &block)
+      _section(:Message, args, title: title, glyph: :completed, &block)
     end
     alias done completed
     alias ok completed
@@ -76,7 +76,7 @@ module NattyUI
     # @yieldparam (see #message)
     # @return (see #message)
     def failed(title, *args, &block)
-      _section(self, :Message, args, title: title, symbol: :failed, &block)
+      _section(:Message, args, title: title, glyph: :failed, &block)
     end
   end
 
@@ -93,24 +93,17 @@ module NattyUI
     class Message < Section
       protected
 
-      def initialize(parent, title:, symbol:, **opts)
-        parent.puts(title, **title_attr(str = as_symbol_str(symbol), symbol))
-        super(parent, prefix: ' ' * (NattyUI.display_width(str) + 1), **opts)
+      def initialize(parent, title:, glyph:)
+        glyph = parent.wrapper.glyph(glyph) || glyph
+        prefix_width = NattyUI.display_width(glyph) + 1
+        super(
+          parent,
+          prefix: ' ' * prefix_width,
+          prefix_width: prefix_width,
+          suffix_width: 0
+        )
+        parent.puts(title, prefix: "#{glyph} ", prefix_width: prefix_width)
       end
-
-      def title_attr(str, _symbol) = { prefix: "#{str} " }
-      def as_symbol_str(symbol) = (SYMBOL[symbol] || symbol)
-
-      SYMBOL = {
-        default: '•',
-        information: 'i',
-        warning: '!',
-        error: 'X',
-        completed: '✓',
-        failed: 'F',
-        query: '▶︎',
-        task: '➔'
-      }.compare_by_identity.freeze
     end
   end
 end

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

@@ -7,14 +7,23 @@ module NattyUI
   module Features
     # Creates progress element implementing additional {ProgressAttributes}.
     #
-    # A progress element has additional states and can be closed with {#completed}
-    # or {#failed}.
+    # When a `max_value` is given, the progress will by displayed as a bar.
+    # Otherwise the `spinner` is used for a little animation.
+    #
+    # When no pre-defined spinner is specified then spinner will be
+    # used char-wise as a string for the progress animation.
+    #
+    # A progress element has additional states and can be closed with
+    # {#completed} or {#failed}.
     #
     # @param [#to_s] title object to print as progress title
-    # @param [##to_f] max_value maximum value of the progress
+    # @param [#to_f] max_value maximum value of the progress
+    # @param [:bar, :blink, :blocks, :braile, :circle, :colors, :pulse,
+    #   :snake, :swap, :triangles, :vintage, #to_s] spinner type of spinner or
+    #   spinner elements
     # @return [Wrapper::Progress] the created progress element
-    def progress(title, max_value: nil)
-      _section(self, :Progress, nil, title: title, max_value: max_value)
+    def progress(title, max_value: nil, spinner: :pulse)
+      _element(:Progress, title, max_value, spinner)
     end
   end
 
@@ -29,16 +38,34 @@ module NattyUI
 
       protected
 
-      def initialize(parent, title:, max_value:, **opts)
-        super(parent, **opts)
+      def call(title, max_value, spinner)
         @final_text = [title]
         @max_value = [0, max_value.to_f].max if max_value
-        @value = 0
-        @progress = 0
-        draw(title)
+        @value = @progress = 0
+        draw(title, SPINNER[spinner] || spinner.to_s)
+        self
+      end
+
+      SPINNER = {
+        bar: '▁▂▃▄▅▆▇█▇▆▅▄▃▂',
+        blink: '■□▪▫',
+        blocks: '▖▘▝▗',
+        braile: '⣷⣯⣟⡿⢿⣻⣽⣾',
+        braile_reverse: '⡿⣟⣯⣷⣾⣽⣻⢿',
+        circle: '◐◓◑◒',
+        colors: '🟨🟧🟥🟦🟪🟩',
+        pulse: '•✺◉●◉✺',
+        snake: '⠁⠉⠙⠸⢰⣠⣄⡆⠇⠃',
+        swap: '㊂㊀㊁',
+        triangles: '◢◣◤◥',
+        vintage: '-\\|/'
+      }.compare_by_identity.freeze
+      private_constant :SPINNER
+
+      def draw(title, _spinner)
+        (wrapper.stream << @parent.prefix << "➔ #{title} ").flush
       end
 
-      def draw(title) = (wrapper.stream << prefix << "➔ #{title} ").flush
       def end_draw = (wrapper.stream << "\n")
 
       def redraw
@@ -53,11 +80,11 @@ module NattyUI
         end_draw
         return @parent.failed(*@final_text) if failed?
         _section(
-          @parent,
           :Message,
           @final_text,
+          owner: @parent,
           title: @final_text.shift,
-          symbol: @status = :completed
+          glyph: @status = :completed
         )
       end
     end

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

@@ -7,7 +7,7 @@ module NattyUI
     # Request a choice from user.
     #
     # @example Select by Index
-    #   choice = sec.query(
+    #   choice = ui.query(
     #     'Which fruits do you prefer?',
     #     'Apples',
     #     'Bananas',
@@ -16,7 +16,7 @@ module NattyUI
     #   # => '1' or '2' or '3' or nil if user aborted
     #
     # @example Select by given char
-    #   choice = sec.query(
+    #   choice = ui.query(
     #     'Which fruits do you prefer?',
     #     a: 'Apples',
     #     b: 'Bananas',
@@ -29,13 +29,14 @@ module NattyUI
     # @param question [#to_s] Question to display
     # @param choices [#to_s] choices selectable via index (0..9)
     # @param result  [Symbol] defines how the result will be returned
+    # @param display  [Symbol] display choices as `:list` or `:compact`
     # @param kw_choices [{Char => #to_s}] choices selectable with given char
     # @return [Char] when `result` is configured as `:char`
     # @return [#to_s] when `result` is configured as `:choice`
     # @return [[Char, #to_s]] when `result` is configured as `:both`
-    # @return [nil] when input was aborted with `ESC`, `^C` or `^D`
-    def query(question, *choices, result: :char, **kw_choices)
-      _element(:Query, question, choices, kw_choices, result)
+    # @return [nil] when input was aborted with `^C` or `^D`
+    def query(question, *choices, result: :char, display: :list, **kw_choices)
+      _element(:Query, question, choices, kw_choices, result, display)
     end
   end
 
@@ -47,41 +48,43 @@ module NattyUI
     class Query < Element
       protected
 
-      def _call(question, choices, kw_choices, result_type)
-        choices = grab(choices, kw_choices)
-        return if choices.empty?
-        wrapper.temporary do
-          _section(
-            @parent,
-            :Message,
-            choices.map { |k, v| "#{k} #{v}" },
-            title: question,
-            symbol: :query
-          )
-          read(choices, result_type)
+      def call(question, choices, kw_choices, result, display)
+        return if choices.empty? && kw_choices.empty?
+        choices = as_choices(choices, kw_choices)
+        text = choices.map { |k, v| "⦗#{CHOICE_MARK}#{k}#{Ansi::RESET}⦘ #{v}" }
+        @parent.wrapper.temporary do
+          if display == :compact
+            @parent.msg(question, glyph: :query).ls(text)
+          else
+            @parent.msg(question, *text, glyph: :query)
+          end
+          read(choices, result)
         end
       end
 
-      def read(choices, result_type)
+      def as_choices(choices, kw_choices)
+        choices
+          .take(9)
+          .each_with_index
+          .to_h { |str, i| [i + 1, str] }
+          .merge!(kw_choices)
+          .transform_keys!(&:to_s)
+          .transform_values! { _1.to_s.gsub(/[[:space:]]/, ' ') }
+      end
+
+      def read(choices, result)
         while true
-          char = NattyUI.in_stream.getch
-          return if "\3\4\e".include?(char)
+          char = NattyUI.read_key
+          return if char == 'Ctrl+C'
           next unless choices.key?(char)
-          return char if result_type == :char
-          return choices[char] if result_type == :choice
+          return char if result == :char
+          return choices[char] if result == :title
           return char, choices[char]
         end
       end
 
-      def grab(choices, kw_choices)
-        Array
-          .new(choices.size) { |i| i + 1 }
-          .zip(choices)
-          .to_h
-          .merge!(kw_choices)
-          .transform_keys! { |k| [k.to_s[0], ' '].max }
-          .transform_values! { |v| v.to_s.tr("\r\n\t", ' ') }
-      end
+      CHOICE_MARK = Ansi[:bold, 34]
+      private_constant :CHOICE_MARK
     end
   end
 end

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

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+require_relative 'element'
+
+module NattyUI
+  module Features
+    # Creates a quotation section and prints given arguments as lines
+    # into the section.
+    #
+    # @param (see #section)
+    # @yieldparam (see #section)
+    # @return [Object] the result of the code block
+    # @return [Wrapper::Quote] itself, when no code block is given
+    def quote(*args, &block) = _section(:Quote, args, prefix: '▍ ', &block)
+  end
+
+  class Wrapper
+    #
+    # A quotation {Section}.
+    #
+    # @see Features#quote
+    class Quote < Section
+    end
+  end
+end

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

@@ -23,21 +23,32 @@ module NattyUI
     class Request < Element
       protected
 
-      def _call(question, password)
-        return read_password(question) if password
-        NattyUI.readline(prompt(question), stream: wrapper.stream)
+      def call(question, password)
+        draw(question)
+        return NattyUI.in_stream.getpass if password
+        NattyUI.in_stream.gets(chomp: true)
+      rescue Interrupt, SystemCallError
+        nil
       ensure
-        finish
+        (wrapper = @parent.wrapper).ansi? and
+          (wrapper.stream << ANSI_FINISH).flush
       end
 
-      def read_password(question)
-        (wrapper.stream << prompt(question)).flush
-        NattyUI.in_stream.getpass
-      rescue Interrupt
-        nil
+      def draw(question)
+        wrapper = @parent.wrapper
+        glyph = wrapper.glyph(:query)
+        @parent.print(
+          question,
+          prefix: "#{glyph} #{Ansi[255]}",
+          prefix_width: NattyUI.display_width(glyph) + 1,
+          suffix_width: 0
+        )
+        (wrapper.stream << ANSI_PREFIX).flush if wrapper.ansi?
       end
 
-      def prompt(question) = "#{prefix}▶︎ #{question}: "
+      ANSI_PREFIX = Ansi::RESET + Ansi::ITALIC
+      ANSI_FINISH = Ansi::RESET + Ansi::LINE_PREVIOUS + Ansi::LINE_ERASE
+      private_constant :ANSI_PREFIX, :ANSI_FINISH
     end
   end
 end

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

@@ -7,24 +7,16 @@ module NattyUI
     # Creates a default section and prints given arguments as lines
     # into the section.
     #
-    # @param [Array<#to_s>] args objects to print
+    # @param [Array<#to_s>] args optional objects to print
+    # @param [String] prefix used for each printed line
+    # @param [String] suffix used for each printed line
     # @yieldparam [Wrapper::Section] section the created section
     # @return [Object] the result of the code block
     # @return [Wrapper::Section] itself, when no code block is given
-    def section(*args, &block)
-      _section(self, :Section, args, prefix: '  ', suffix: '  ', &block)
+    def section(*args, prefix: '  ', suffix: '  ', &block)
+      _section(:Section, args, prefix: prefix, suffix: suffix, &block)
     end
     alias sec section
-
-    # Creates a quotation section and prints given arguments as lines
-    # into the section.
-    #
-    # @param (see #section)
-    # @yieldparam (see #section)
-    # @return (see #section)
-    def quote(*args, &block)
-      _section(self, :Section, args, prefix: '▍ ', prefix_attr: 39, &block)
-    end
   end
 
   class Wrapper
@@ -34,47 +26,57 @@ module NattyUI
     # A section can contain other elements and sections.
     #
     # @see Features#section
-    # @see Features#quote
     class Section < Element
-      # Close the section.
-      #
-      # @return [Section] itself
-      def close = _close(:closed)
+      # @return [Integer] available columns count within the section
+      def available_width
+        @available_width ||=
+          @parent.available_width - @prefix_width - @suffix_width
+      end
 
-      # Print given arguments as lines into the section.
-      # Optionally limit the line width to given `max_width`.
+      # Print given arguments line-wise into the section.
       #
-      # @overload puts(..., max_width: nil)
+      # @overload puts(...)
       #   @param [#to_s] ... objects to print
-      #   @param [Integer, nil] max_width maximum line width
-      #   @comment @param [#to_s, nil] prefix line prefix
-      #   @comment @param [#to_s, nil] suffix line suffix
       #   @return [Section] itself
-      def puts(*args, max_width: nil, prefix: nil, suffix: nil)
+      def puts(*args, **kwargs)
         return self if @status
         @parent.puts(
           *args,
-          max_width: max_width,
-          prefix: prefix ? "#{@prefix}#{prefix}" : @prefix,
-          suffix: suffix ? "#{suffix}#{@suffix}" : @suffix
+          **kwargs.merge!(
+            prefix: "#{@prefix}#{kwargs[:prefix]}",
+            prefix_width: @prefix_width + kwargs[:prefix_width].to_i,
+            suffix: "#{kwargs[:suffix]}#{@suffix}",
+            suffix_width: @suffix_width + kwargs[:suffix_width].to_i
+          )
         )
         self
       end
-      alias add puts
 
-      # Add at least one empty line
+      # Print given arguments into the section.
       #
-      # @param [#to_i] lines count of lines
-      # @return [Section] itself
-      def space(lines = 1)
-        @parent.puts(
-          "\n" * [lines.to_i, 1].max,
-          prefix: @prefix,
-          suffix: @suffix
+      # @overload print(...)
+      #   @param [#to_s] ... objects to print
+      #   @return [Section] itself
+      def print(*args, **kwargs)
+        return self if @status
+        @parent.print(
+          *args,
+          **kwargs.merge!(
+            prefix: "#{@prefix}#{kwargs[:prefix]}",
+            prefix_width: @prefix_width + kwargs[:prefix_width].to_i,
+            suffix: "#{kwargs[:suffix]}#{@suffix}",
+            suffix_width: @suffix_width + kwargs[:suffix_width].to_i
+          )
         )
         self
       end
 
+      # Add at least one empty line
+      #
+      # @param [#to_i] lines count of lines
+      # @return [Section] itself
+      def space(lines = 1) = puts("\n" * [1, lines.to_i].max)
+
       # @note The screen manipulation is only available in ANSI mode see {#ansi?}
       #
       # Resets the part of the screen written below the current output line when
@@ -90,12 +92,26 @@ module NattyUI
       # @return [Object] block result
       def temporary = block_given? ? yield(self) : self
 
+      # @!visibility private
+      def inspect = @status ? "#{_to_s[..-2]} status=#{@status}>" : _to_s
+
+      # @!visibility private
+      def rcol = @parent.rcol - @suffix_width
+
       protected
 
-      def initialize(parent, prefix: nil, suffix: nil, **opts)
-        super(parent, **opts)
+      def initialize(
+        parent,
+        prefix:,
+        prefix_width: NattyUI.display_width(prefix),
+        suffix: nil,
+        suffix_width: NattyUI.display_width(suffix)
+      )
+        super(parent)
         @prefix = prefix
         @suffix = suffix
+        @prefix_width = prefix_width
+        @suffix_width = suffix_width
       end
     end
   end