natty-ui 0.6.0 → 0.8.0

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

@@ -1,87 +1,60 @@
 # frozen_string_literal: true
 
-require_relative 'section'
+require_relative 'element'
 
 module NattyUI
   module Features
-    # Creates section with a H1 title.
+    # Prints a H1 title.
     #
-    # @param (see #information)
-    # @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)
-      _section(self, :Heading, args, title: title, weight: 1, &block)
-    end
+    # @param [#to_s] title text
+    # @return [Wrapper::Section, Wrapper] it's parent object
+    def h1(title) = _element(:Heading, title, '═══════')
 
-    # Creates section with a H2 title.
+    # Prints a H2 title.
     #
-    # @param (see #information)
-    # @yieldparam (see #h1)
+    # @param (see #h1)
     # @return (see #h1)
-    def h2(title, *args, &block)
-      _section(self, :Heading, args, title: title, weight: 2, &block)
-    end
+    def h2(title) = _element(:Heading, title, '━━━━━')
 
-    # Creates section with a H3 title.
+    # Prints a H3 title.
     #
-    # @param (see #information)
-    # @yieldparam (see #h1)
+    # @param (see #h1)
     # @return (see #h1)
-    def h3(title, *args, &block)
-      _section(self, :Heading, args, title: title, weight: 3, &block)
-    end
+    def h3(title) = _element(:Heading, title, '━━━')
 
-    # Creates section with a H4 title.
+    # Prints a H4 title.
     #
-    # @param (see #information)
-    # @yieldparam (see #h1)
+    # @param (see #h1)
     # @return (see #h1)
-    def h4(title, *args, &block)
-      _section(self, :Heading, args, title: title, weight: 4, &block)
-    end
+    def h4(title) = _element(:Heading, title, '───')
 
-    # Creates section with a H5 title.
+    # Prints a H5 title.
     #
-    # @param (see #information)
-    # @yieldparam (see #h1)
+    # @param (see #h1)
     # @return (see #h1)
-    def h5(title, *args, &block)
-      _section(self, :Heading, args, title: title, weight: 5, &block)
-    end
+    def h5(title) = _element(:Heading, title, '──')
   end
 
   class Wrapper
     #
-    # A {Section} with a highlighted title.
+    # A {Element} drawing a title.
     #
     # @see Features#h1
     # @see Features#h2
     # @see Features#h3
     # @see Features#h4
     # @see Features#h5
-    class Heading < Section
+    class Heading < Element
       protected
 
-      def initialize(parent, title:, weight:, **opts)
-        prefix, suffix = enclose(weight)
-        parent.puts(title, prefix: prefix, suffix: suffix)
-        super(parent, **opts)
-      end
-
-      def enclose(weight)
-        enclose = ENCLOSE[weight]
-        return "#{enclose} ", " #{enclose}" if enclose
-        raise(ArgumentError, "invalid heading weight - #{weight}")
+      def call(title, enclose)
+        @parent.puts(
+          title,
+          prefix: "#{Ansi[39]}#{enclose} #{Ansi[:bold, 255]}",
+          suffix: " #{Ansi[:normal, 39]}#{enclose}#{Ansi::RESET}",
+          max_width: available_width - 2 - (enclose.size * 2)
+        )
       end
-
-      ENCLOSE = {
-        1 => '═══════',
-        2 => '━━━━━',
-        3 => '━━━',
-        4 => '───',
-        5 => '──'
-      }.compare_by_identity.freeze
     end
   end
 end

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

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+require_relative 'element'
+
+module NattyUI
+  module Features
+    # Print a horizontal rule
+    #
+    # @param [#to_s] symbol string to build the horizontal rule
+    # @return [Wrapper::Section, Wrapper] it's parent object
+    def hr(symbol = '=') = _element(:HorizontalRule, symbol)
+  end
+
+  class Wrapper
+    #
+    # A {Element} drawing a horizontal rule.
+    #
+    # @see Features#hr
+    class HorizontalRule < Element
+      protected
+
+      def call(symbol)
+        size = NattyUI.display_width(symbol = symbol.to_s)
+        return @parent.puts if size == 0
+        max_width = available_width
+        @parent.puts(
+          symbol * ((max_width / size) - 1),
+          max_width: max_width,
+          prefix: Ansi[39],
+          prefix_width: 0,
+          suffix: Ansi::RESET,
+          suffix_width: 0
+        )
+      end
+    end
+  end
+end

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)
+    #   # => 1 apple   2 banana   3 blueberry   4 pineapple   5 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,48 @@ 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 +112,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
@@ -73,9 +127,11 @@ module NattyUI
       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
+        parent.puts(
+          title,
+          prefix: "#{glyph} ",
+          prefix_width: prefix_width,
+          suffix_width: 0
+        )
+        super(parent, prefix: ' ' * prefix_width, 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/{mixins.rb → wrapper/mixins.rb}

@@ -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

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 require_relative 'element'
-require_relative '../mixins'
+require_relative 'mixins'
 
 module NattyUI
   module Features
@@ -14,7 +14,7 @@ module NattyUI
     # @param [##to_f] max_value maximum value of the progress
     # @return [Wrapper::Progress] the created progress element
     def progress(title, max_value: nil)
-      _section(self, :Progress, nil, title: title, max_value: max_value)
+      _element(:Progress, title, max_value)
     end
   end
 
@@ -29,16 +29,18 @@ module NattyUI
 
       protected
 
-      def initialize(parent, title:, max_value:, **_)
-        super(parent)
+      def call(title, max_value)
         @final_text = [title]
         @max_value = [0, max_value.to_f].max if max_value
-        @value = 0
-        @progress = 0
+        @value = @progress = 0
         draw(title)
+        self
+      end
+
+      def draw(title)
+        (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 +55,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,47 @@ module NattyUI
     class Query < Element
       protected
 
-      def _call(question, choices, kw_choices, result_typye)
-        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_typye)
+      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_typye)
+      def as_choices(choices, kw_choices)
+        ret = {}
+        choices.each_with_index do |title, i|
+          (i += 1) == 10 ? break : ret[i.to_s] = title.to_s.tr("\r\n\t", ' ')
+        end
+        ret.merge!(
+          kw_choices
+            .transform_keys! { [' ', _1.to_s[0]].max }
+            .transform_values! { _1.to_s.tr("\r\n\t", ' ') }
+        )
+      end
+
+      def read(choices, result)
         while true
           char = NattyUI.in_stream.getch
-          return if "\3\4\e".include?(char)
+          return if "\3\4".include?(char)
           next unless choices.key?(char)
-          return char if result_typye == :char
-          return choices[char] if result_typye == :choice
+          return char if result == :char
+          return choices[char] if result == :title
           return char, choices[char]
         end
+      rescue Interrupt, SystemCallError
+        nil
       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

@@ -7,9 +7,12 @@ module NattyUI
     # Request user input.
     #
     # @param question [#to_s] Question to display
+    # @param password [Boolean] whether to hide the input
     # @return [String] the user input
     # @return [nil] when input was aborted with `^C` or `^D`
-    def request(question) = _element(:Request, question)
+    def request(question, password: false)
+      _element(:Request, question, password)
+    end
   end
 
   class Wrapper
@@ -20,13 +23,32 @@ module NattyUI
     class Request < Element
       protected
 
-      def _call(question)
-        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 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::CURSOR_UP + Ansi::LINE_ERASE
+      private_constant :ANSI_PREFIX, :ANSI_FINISH
     end
   end
 end