natty-ui 0.5.2 → 0.6.0

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
@@ -110,18 +109,48 @@ module NattyUI
       MSG = Ansi[:bold, 231].freeze
     end
 
-    class Framed < Framed
+    class Framed < Section
       protected
 
+      def initialize(parent, title:, type:, **opts)
+        @parent = parent
+        title = title.to_s.tr("\r\n", '')
+        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
 
     class Ask < Ask
@@ -136,6 +165,14 @@ module NattyUI
       PREFIX = "#{Ansi[:bold, :italic, 220]}▶︎#{Ansi[:reset, 220]}".freeze
     end
 
+    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
+
     class Query < Query
       protected
 
@@ -155,9 +192,9 @@ module NattyUI
     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
@@ -167,26 +204,21 @@ module NattyUI
         end
       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,6 +226,7 @@ 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
 
     PAGE_BEGIN =

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, *args)
+      wrapper.class.const_get(type).__send__(:new, self).__send__(:_call, *args)
+    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/{wrapper/mixins.rb → 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?

data/lib/natty-ui/version.rb

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

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

@@ -17,11 +17,13 @@ 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
     #
+    # @see NattyUI.in_stream
+    #
     # @param question [#to_s] Question to display
     # @param yes [#to_s] chars which will be used to answer 'Yes'
     # @param no [#to_s] chars which will be used to answer 'No'
@@ -65,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
@@ -24,8 +24,7 @@ module NattyUI
 
       # Close the element.
       #
-      # @return [Element] itself when used without a code block
-      # @return [nil] when used with a code block
+      # @return [Element] itself
       def close = _close(:closed)
 
       alias _to_s to_s
@@ -37,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

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

@@ -14,7 +14,7 @@ module NattyUI
     # @param [Array<#to_s>] args more objects to print
     # @param [Symbol] type frame type;
     #   valid types are `:rounded`, `:simple`, `:heavy`, `:semi`, `:double`
-    # @yieldparam [Wrapper::Framed] section the created section
+    # @yieldparam [Wrapper::Framed] framed the created section
     # @return [Object] the result of the code block
     # @return [Wrapper::Framed] itself, when no code block is given
     def framed(title, *args, type: :rounded, &block)

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

@@ -7,7 +7,7 @@ module NattyUI
     # Creates section with a H1 title.
     #
     # @param (see #information)
-    # @yieldparam [Wrapper::Heading] section the created section
+    # @yieldparam [Wrapper::Heading] heading the created section
     # @return [Object] the result of the code block
     # @return [Wrapper::Heading] itself, when no code block is given
     def h1(title, *args, &block)

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/message.rb

@@ -10,7 +10,7 @@ module NattyUI
     # @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
-    # @yieldparam [Wrapper::Message] section the created section
+    # @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)

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

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 require_relative 'element'
-require_relative 'mixins'
+require_relative '../mixins'
 
 module NattyUI
   module Features
@@ -35,11 +35,11 @@ module NattyUI
         @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

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

@@ -24,9 +24,11 @@ module NattyUI
     #   )
     #   # => 'a' or 'b' or 'c' or nil if user aborted
     #
+    # @see NattyUI.in_stream
+    #
     # @param question [#to_s] Question to display
     # @param choices [#to_s] choices selectable via index (0..9)
-    # @param result  [Symbol] defines how the result ist returned
+    # @param result  [Symbol] defines how the result will be returned
     # @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`
@@ -78,7 +80,7 @@ module NattyUI
           .to_h
           .merge!(kw_choices)
           .transform_keys! { |k| [k.to_s[0], ' '].max }
-          .transform_values! { |v| v.to_s.tr("\r\n", ' ') }
+          .transform_values! { |v| v.to_s.tr("\r\n\t", ' ') }
       end
     end
   end

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

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+require_relative 'element'
+
+module NattyUI
+  module Features
+    # Request user input.
+    #
+    # @param question [#to_s] Question to display
+    # @return [String] the user input
+    # @return [nil] when input was aborted with `^C` or `^D`
+    def request(question) = _element(:Request, question)
+  end
+
+  class Wrapper
+    #
+    # An {Element} to request user input.
+    #
+    # @see Features#request
+    class Request < Element
+      protected
+
+      def _call(question)
+        NattyUI.readline(prompt(question), stream: wrapper.stream)
+      ensure
+        finish
+      end
+
+      def prompt(question) = "#{prefix}▶︎ #{question}: "
+    end
+  end
+end

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

@@ -29,7 +29,7 @@ module NattyUI
 
   class Wrapper
     #
-    # Visual element to keep text lines together.
+    # Visual {Element} to keep text lines together.
     #
     # A section can contain other elements and sections.
     #
@@ -38,23 +38,25 @@ module NattyUI
     class Section < Element
       # Close the section.
       #
-      # @return [Section] itself when used without a code block
-      # @return [nil] when used with a code block
+      # @return [Section] itself
       def close = _close(:closed)
 
       # Print given arguments as lines into the section.
+      # Optionally limit the line width to given `max_width`.
       #
-      # @overload puts(...)
+      # @overload puts(..., max_width: nil)
       #   @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, prefix: nil, suffix: nil)
+      def puts(*args, max_width: nil, prefix: nil, suffix: nil)
         return self if @status
         @parent.puts(
           *args,
+          max_width: max_width,
           prefix: prefix ? "#{@prefix}#{prefix}" : @prefix,
-          suffix: suffix ? "#{@suffix}#{suffix}" : @suffix
+          suffix: suffix ? "#{suffix}#{@suffix}" : @suffix
         )
         self
       end
@@ -66,7 +68,7 @@ module NattyUI
       # @return [Section] itself
       def space(lines = 1)
         @parent.puts(
-          "\n" * ([lines.to_i, 1].max - 1),
+          "\n" * [lines.to_i, 1].max,
           prefix: @prefix,
           suffix: @suffix
         )

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

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 require_relative 'section'
-require_relative 'mixins'
+require_relative '../mixins'
 
 module NattyUI
   module Features
@@ -11,7 +11,7 @@ module NattyUI
     # or {#failed}.
     #
     # @param (see #information)
-    # @yieldparam [Wrapper::Task] section the created section
+    # @yieldparam [Wrapper::Task] task the created section
     # @return [Object] the result of the code block
     # @return [Wrapper::Task] itself, when no code block is given
     def task(title, *args, &block)

data/lib/natty-ui/wrapper.rb

@@ -1,12 +1,14 @@
 # frozen_string_literal: true
 
-require 'stringio'
+require 'io/console'
 require_relative 'wrapper/ask'
 require_relative 'wrapper/framed'
 require_relative 'wrapper/heading'
+require_relative 'wrapper/list_in_columns'
 require_relative 'wrapper/message'
 require_relative 'wrapper/progress'
 require_relative 'wrapper/query'
+require_relative 'wrapper/request'
 require_relative 'wrapper/section'
 require_relative 'wrapper/task'
 
@@ -28,13 +30,13 @@ module NattyUI
     # @return [[Integer, Integer]] screen size as rows and columns
     def screen_size
       return @stream.winsize if @ws
-      [ENV['LINES'].to_i.nonzero? || 25, ENV['COLUMNS'].to_i.nonzero? || 80]
+      [ENV['LINES'].to_i.nonzero? || 24, ENV['COLUMNS'].to_i.nonzero? || 80]
     end
 
     # @attribute [r] screen_rows
     # @return [Integer] number of screen rows
     def screen_rows
-      @ws ? @stream.winsize[0] : (ENV['LINES'].to_i.nonzero? || 25)
+      @ws ? @stream.winsize[0] : (ENV['LINES'].to_i.nonzero? || 24)
     end
 
     # @attribute [r] screen_columns
@@ -46,24 +48,22 @@ module NattyUI
     # @!group Tool functions
 
     # Print given arguments as lines to the output stream.
+    # Optionally limit the line width to given `max_width`.
     #
-    # @overload puts(...)
+    # @overload puts(..., max_width: nil)
     #   @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 [Wrapper] itself
-    def puts(*args, prefix: nil, suffix: nil)
+    def puts(*args, max_width: nil, prefix: nil, suffix: nil)
       if args.empty?
         @stream.puts(embellish("#{prefix}#{suffix}"))
         @lines_written += 1
       else
-        StringIO.open do |io|
-          io.puts(*args)
-          io.rewind
-          io.each(chomp: true) do |line|
-            @stream.puts(embellish("#{prefix}#{line}#{suffix}"))
-            @lines_written += 1
-          end
+        NattyUI.each_line(*args, max_width: max_width) do |line|
+          @stream.puts(embellish("#{prefix}#{line}#{suffix}"))
+          @lines_written += 1
         end
       end
       @stream.flush
@@ -154,7 +154,7 @@ module NattyUI
     def initialize(stream)
       @stream = stream
       @lines_written = 0
-      @ws = stream.respond_to?(:winsize) && stream.winsize&.size == 2
+      @ws = stream.respond_to?(:winsize) && stream.winsize&.all?(&:positive?)
     rescue Errno::ENOTTY
       @ws = false
     end
@@ -163,6 +163,12 @@ module NattyUI
     def prefix = nil
     alias suffix prefix
 
+    def prefix_width = 0
+    alias suffix_width prefix_width
+    alias width prefix_width
+
+    alias available_width screen_columns
+
     private_class_method :new
   end
 end