natty-ui 0.26.0 → 0.28.0

data/lib/natty-ui/features.rb

@@ -15,12 +15,12 @@ module NattyUI
     # Print given text as lines.
     #
     # @example Print two lines text, right aligned
-    #   ui.puts("Two lines", "of nice text", align: :right)
+    #   ui.puts "Two lines", "of nice text", align: :right
     #   # =>    Two lines
     #   # => of nice text
     #
     # @example Print two lines text, with a prefix
-    #   ui.puts("Two lines", "of nice text", prefix: ': ')
+    #   ui.puts "Two lines", "of nice text", prefix: ': '
     #   # => : Two lines
     #   # => : of nice text
     #
@@ -31,14 +31,15 @@ module NattyUI
     # @param options [{Symbol => Object}]
     # @option options [:left, :right, :centered] :align (:left)
     #   text alignment
-    # @option options [true, false] :ignore_newline (false)
-    #   whether to igniore newline characters
+    # @option options [true, false] :eol (true)
+    #   whether to respect newline characters
     #
     # @return [Features]
     #   itself
     def puts(*text, **options)
       bbcode = true if (bbcode = options[:bbcode]).nil?
       max_width = options[:max_width] || Terminal.columns
+      max_width = Terminal.columns + max_width if max_width < 0
 
       prefix_width =
         if (prefix = options[:prefix])
@@ -84,7 +85,7 @@ module NattyUI
           limit: max_width,
           bbcode: bbcode,
           ansi: Terminal.ansi?,
-          ignore_newline: options[:ignore_newline]
+          ignore_newline: options[:eol] == false || options[:ignore_newline]
         )
 
       if (align = options[:align]).nil?
@@ -272,8 +273,8 @@ module NattyUI
 
     # Print a horizontal rule.
     #
-    # @example
-    #   ui.hr(:heavy)
+    # @example Print double line
+    #   ui.hr :double
     #
     # @param type [Symbol]
     #   border type
@@ -305,10 +306,10 @@ module NattyUI
     # - any text as prefix
     #
     # @example Print all Ruby files as a numbered list
-    #   ui.ls(Dir['*/**/*.rb'], glyph: 1)
+    #   ui.ls Dir['*/**/*.rb'], glyph: 1
     #
     # @example Print all Ruby files as a bullet point list (with green bullets)
-    #   ui.ls(Dir['*/**/*.rb'], glyph: '[green]•[/fg]')
+    #   ui.ls Dir['*/**/*.rb'], glyph: '[green]•[/fg]'
     #
     # @param items [#to_s]
     #   one or more convertible objects to list
@@ -338,13 +339,16 @@ module NattyUI
     #   attributes for the table and default attributes for table cells
     # @option attributes [Symbol] :border (nil)
     #   kind of border,
-    #   see {Attributes::Border}
-    # @option attributes [true, false] :border_around (false)
-    #   whether the table should have a border around,
-    #   see {Attributes::BorderAround}
+    #   see {Table::Attributes}
     # @option attributes [Enumerable<Symbol>] :border_style (nil)
     #   style of border,
-    #   see {Attributes::BorderStyle}
+    #   see {Table::Attributes}
+    # @option attributes [true, false] :border_around (false)
+    #   whether the table should have a border around,
+    #   see {Table::Attributes}
+    # @option attributes [:left, :right, :centered] :position (false)
+    #   where to align the table,
+    #   see {Table::Attributes}
     #
     # @yieldparam table [Table]
     #   helper to define the table layout
@@ -353,7 +357,11 @@ module NattyUI
     def table(**attributes)
       return self unless block_given?
       yield(table = Table.new(**attributes))
-      puts(*TableRenderer[table, columns])
+      puts(
+        *TableRenderer[table, columns],
+        align: table.attributes.position,
+        expand: true
+      )
     end
 
     # Print text in columns.
@@ -372,9 +380,10 @@ module NattyUI
     #
     # @return (see puts)
     def cols(*columns, **attributes)
-      table(**attributes) do |table|
+      tab_att, att = Utils.split_table_attr(attributes)
+      table(**tab_att) do |table|
         table.add do |row|
-          columns.each { row.add(_1, **attributes) }
+          columns.each { row.add(_1, **att) }
           yield(row) if block_given?
         end
       end
@@ -403,8 +412,88 @@ module NattyUI
     # @return (see puts)
     def div(*text, **attributes)
       return self if text.empty?
-      table(border_around: true, **attributes) do |table|
-        table.add { _1.add(*text, **attributes) }
+      tab_att, att = Utils.split_table_attr(attributes)
+      tab_att[:border_around] = true
+      table(**tab_att) { |table| table.add { _1.add(*text, **att) } }
+    end
+
+    # Dump given values as vertical bars.
+    #
+    # @example Draw green bars
+    #   ui.vbars 1..10, style: :green
+    #
+    # @example Draw very big bars
+    #   ui.vbars 1..10, bar_width: 5, height: 20
+    #
+    # @param values [#to_a, Array<Numeric>] values to print
+    # @param normalize [true, false] whether the values should be normalized
+    # @param height [Integer] output height
+    # @param bar_width [:auto, :min, Integer] with of each bar
+    # @param style [Symbol, Array<Symbol>, nil] drawing style
+    #
+    # @raise [ArgumentError] if any value is negative
+    #
+    # @return (see puts)
+    def vbars(
+      values,
+      normalize: false,
+      height: 10,
+      bar_width: :auto,
+      style: nil
+    )
+      return self if (values = values.to_a).empty?
+      if values.any?(&:negative?)
+        raise(ArgumentError, 'values can not be negative')
+      end
+      puts(
+        *VBarsRenderer.lines(
+          values,
+          columns,
+          height,
+          normalize,
+          bar_width,
+          Terminal.ansi? ? style : nil
+        )
+      )
+    end
+
+    # Dump given values as horizontal bars.
+    #
+    # @example Draw green bars
+    #   ui.hbars 1..10, style: :green
+    #
+    # @example Draw bars in half sreen width
+    #   ui.hbars 1..10, style: :blue, width: 0.5
+    #
+    # @param values [#to_a, Array<Numeric>] values to print
+    # @param with_values [true, false] whether the values should be printed too
+    # @param normalize [true, false] whether the values should be normalized
+    # @param height [Integer] output height
+    # @param bar_width [:auto, :min, Integer] with of each bar
+    # @param style [Symbol, Array<Symbol>, nil] bar drawing style
+    # @param text_style [Symbol, Array<Symbol>, nil] text style
+    #
+    # @raise [ArgumentError] if any value is negative
+    #
+    # @return (see puts)
+    def hbars(
+      values,
+      with_values: true,
+      normalize: false,
+      width: :auto,
+      style: nil,
+      text_style: nil
+    )
+      return self if (values = values.to_a).empty?
+      if values.any?(&:negative?)
+        raise(ArgumentError, 'values can not be negative')
+      end
+      style = text_style = nil unless Terminal.ansi?
+      size = Utils.as_size(3..columns, width)
+      if with_values
+        puts(*HBarsRenderer.lines(values, size, normalize, style, text_style))
+      else
+        puts(*HBarsRenderer.lines_bars_only(values, size, normalize, style))
       end
     end
 
@@ -426,15 +515,15 @@ module NattyUI
     #   end
     #
     # @example Display simple progress
-    #   progress = ui.progress('Check some stuff')
+    #   progress = ui.progress 'Check some stuff'
     #   10.times do
     #     # simulate some work
-    #     sleep(0.1)
+    #     sleep 0.1
     #
     #     # here we actualize the progress
     #     progress.step
     #   end
-    #   progress.ok('Stuff checked ok')
+    #   progress.ok 'Stuff checked ok'
     #
     # @overload progress(title, max: nil, pin: false)
     #   @param title [#to_s]
@@ -483,10 +572,10 @@ module NattyUI
     #
     # @example
     #   ui.section do |section|
-    #     section.h1('About Sections')
+    #     section.h1 'About Sections'
     #     section.space
-    #     section.puts('Sections are areas of text elements.')
-    #     section.puts('You can use any other feature inside such an area.')
+    #     section.puts 'Sections are areas of text elements.'
+    #     section.puts 'You can use any other feature inside such an area.'
     #   end
     #   # => ╭────╶╶╶
     #   # => │ ╴╶╴╶─═══ About Sections ═══─╴╶╴╶
@@ -635,18 +724,14 @@ module NattyUI
     #
     #   @return [true, false]
     #     wheter the user inputs a positive result
+    #   @return nil
+    #     in error case
     #
     def await(yes: 'Enter', no: 'Esc')
-      temporary do |arg|
-        yield(arg) if block_given?
-        while (key = Terminal.read_key)
-          if (no == key) || (no.is_a?(Enumerable) && no.include?(key))
-            return false
-          end
-          if (yes == key) || (yes.is_a?(Enumerable) && yes.include?(key))
-            return true
-          end
-        end
+      return __await(yes, no) unless block_given?
+      temporary do |temp|
+        yield(temp)
+        __await(yes, no)
       end
     end
 
@@ -719,12 +804,12 @@ module NattyUI
     #   @return [nil]
     #     when user aborted the selection
     #
-    def choice(*choices, abortable: false, **kwchoices, &block)
+    def choice(*choices, abortable: false, selected: nil, **kwchoices, &block)
       return if choices.empty? && kwchoices.empty?
       choice =
         case NattyUI.input_mode
         when :default
-          Choice.new(self, choices, kwchoices, abortable)
+          Choice.new(self, choices, kwchoices, abortable, selected)
         when :dumb
           DumbChoice.new(self, choices, kwchoices, abortable)
         else
@@ -749,7 +834,7 @@ module NattyUI
     #
     # @example Show tempoary information
     #   ui.temporary do
-    #     ui.info('Information', 'This text will disappear when you pressed ENTER.')
+    #     ui.info 'Information', 'This text will disappear when you pressed ENTER.'
     #     ui.await
     #   end
     #
@@ -775,15 +860,27 @@ module NattyUI
       __sec(color, "#{Theme.current.mark(color)}#{title}", text, &block)
     end
 
+    def __await(yes, no)
+      while (event = Terminal.read_key_event&.name)
+        if (no == event) || (no.is_a?(Enumerable) && no.include?(event))
+          return false
+        end
+        if (yes == event) || (yes.is_a?(Enumerable) && yes.include?(event))
+          return true
+        end
+      end
+    end
+
     EOL__ = Terminal.ansi? ? "\e[m\n" : "\n"
     private_constant :EOL__
   end
 
   dir = __dir__
   autoload :Choice, "#{dir}/choice.rb"
-  autoload :CompactLSRenderer, "#{dir}/ls_renderer.rb"
   autoload :DumbChoice, "#{dir}/dumb_choice.rb"
+  autoload :CompactLSRenderer, "#{dir}/ls_renderer.rb"
   autoload :Framed, "#{dir}/framed.rb"
+  autoload :HBarsRenderer, "#{dir}/hbars_renderer.rb"
   autoload :LSRenderer, "#{dir}/ls_renderer.rb"
   autoload :Progress, "#{dir}/progress.rb"
   autoload :DumbProgress, "#{dir}/progress.rb"
@@ -793,6 +890,18 @@ module NattyUI
   autoload :Temporary, "#{dir}/temporary.rb"
   autoload :Theme, "#{dir}/theme.rb"
   autoload :Utils, "#{dir}/utils.rb"
-
-  private_constant :Choice, :DumbChoice, :LSRenderer, :CompactLSRenderer
+  autoload :VBarsRenderer, "#{dir}/vbars_renderer.rb"
+
+  private_constant(
+    :Choice,
+    :DumbChoice,
+    :CompactLSRenderer,
+    :Framed,
+    :HBarsRenderer,
+    :LSRenderer,
+    :Progress,
+    :DumbProgress,
+    :Utils,
+    :VBarsRenderer
+  )
 end

data/lib/natty-ui/hbars_renderer.rb

@@ -0,0 +1,58 @@
+# frozen_string_literal: true
+
+require_relative 'utils'
+
+module NattyUI
+  module HBarsRenderer
+    class << self
+      def lines(vals, width, normalize, style, text_style)
+        if text_style
+          bots = Ansi[*text_style]
+          eots = Ansi::RESET
+        end
+        texts = vals.map { Str.new(_1) }
+        tw = texts.max_by(&:width).width
+        size = width - tw - 1
+        if size < 2 # text only
+          return texts.map { "#{bots}#{' ' * (tw - _1.width)}#{_1}#{eots}" }
+        end
+        if style
+          bos = Ansi[*style]
+          eos = Ansi::RESET
+        end
+        vals = normalize ? normalize!(vals, size) : adjust!(vals, size)
+        texts.map.with_index do |str, idx|
+          "#{bots}#{' ' * (tw - str.width)}#{str}#{eots}#{bos}▕#{
+            '▆' * vals[idx]
+          }#{eos}"
+        end
+      end
+
+      def lines_bars_only(vals, width, normalize, style)
+        if style
+          bos = Ansi[*style]
+          eos = Ansi::RESET
+        end
+        width -= 1
+        vals = normalize ? normalize!(vals, width) : adjust!(vals, width)
+        vals.map { "#{bos}▕#{'▆' * _1}#{eos}" }
+      end
+
+      private
+
+      def adjust!(vals, size)
+        max = vals.max.to_f
+        vals.map { ((_1 / max) * size).round }
+      end
+
+      def normalize!(vals, size)
+        min, max = vals.minmax
+        return Array.new(vals.size, size) if min == max
+        max = (max - min).to_f
+        vals.map { (((_1 - min) / max) * size).round }
+      end
+    end
+  end
+
+  private_constant :HBarsRenderer
+end

data/lib/natty-ui/progress.rb

@@ -99,6 +99,9 @@ module NattyUI
       @pin = pin
       @pin_line = NattyUI.lines_written
       @style = Theme.current.task_style
+      cm = Theme.current.mark(:current)
+      @flp = "#{cm} #{@style}"
+      @flpw = cm.width + 1
       max ? self.max = max : redraw
     end
 
@@ -110,8 +113,8 @@ module NattyUI
       @pin_line = NattyUI.back_to_line(@pin_line) if @last
       @parent.puts(
         *curr,
-        first_line_prefix: "#{@style}➔ ",
-        first_line_prefix_width: 2
+        first_line_prefix: @flp,
+        first_line_prefix_width: @flpw
       )
       @last = curr
     end

data/lib/natty-ui/section.rb

@@ -48,7 +48,7 @@ module NattyUI
       @border = Theme.current.section_border(kind)
       show_title(title)
       @prefix = @border.prefix
-      @prefix_width = @prefix.size
+      @prefix_width = @prefix.width
       puts(*rest) if rest && !rest.empty?
       puts(*msg) unless msg.empty?
     end

data/lib/natty-ui/table.rb

@@ -33,7 +33,7 @@ module NattyUI
           m = cell.attributes.max_width
           max = m if m && (max.nil? || max < m)
         end
-        wh_from(min.to_i, max.to_i)
+        wh_from(min, max)
       end
 
       def respond_to_missing?(name, _)
@@ -181,7 +181,46 @@ module NattyUI
     class Attributes < NattyUI::Attributes::Base
       prepend NattyUI::Attributes::Border
       prepend NattyUI::Attributes::BorderStyle
-      prepend NattyUI::Attributes::BorderAround
+      prepend NattyUI::Attributes::Position
+
+      # Whether the table has a border around.
+      #
+      # @return [true, false]
+      attr_reader :border_around
+
+      # @attribute [w]  border_around
+      def border_around=(value)
+        @border_around = value ? true : false
+      end
+
+      # Maximum table width.
+      #
+      # @return [Integer, nil]
+      attr_reader :max_width
+
+      # @attribute [w] max_width
+      def max_width=(value)
+        if value.is_a?(Float)
+          return @max_width = nil if value < 0
+          return @max_width = value if value < 1
+        end
+        value = value.to_i
+        @max_width = value <= 0 ? nil : value
+      end
+
+      protected
+
+      def _assign(opt)
+        @border_around = opt[:border_around]
+        self.max_width = opt[:max_width]
+        super
+      end
+
+      def _store(opt)
+        opt[:border_around] = true if @border_around
+        opt[:max_width] = @max_width if @max_width
+        super
+      end
     end
 
     include Enumerable
@@ -207,10 +246,20 @@ module NattyUI
 
     # @return [Row] created row
     def add(*text, **attributes)
-      nr = Row.new
-      @rows << nr
-      text.each { nr.add(_1, **attributes) }
-      block_given? ? yield(nr) : nr
+      unless text[0].is_a?(Hash)
+        @rows << (nr = Row.new)
+        text.each { nr.add(_1, **attributes) }
+        return block_given? ? yield(nr) : nr
+      end
+      new_rows = []
+      text[0].each_pair do |key, value|
+        new_rows << (nr = Row.new)
+        @rows << nr
+        nr.add(key, **attributes)
+        nr.add(value, **attributes)
+        yield(nr) if block_given?
+      end
+      new_rows
     end
 
     def delete(row)

data/lib/natty-ui/table_renderer.rb

@@ -8,22 +8,28 @@ module NattyUI
     def self.[](table, max_width)
       columns = table.columns.map(&:width)
       return [] if columns.empty?
-      attributes = table.attributes
-      unless attributes.border_chars.nil?
+      att = table.attributes
+      case att.max_width
+      when Float
+        max_width *= att.max_width
+      when Integer
+        max_width = [max_width, att.max_width].min
+      end
+      unless att.border_chars.nil?
         max_width -= (columns.size - 1)
-        max_width -= 2 if attributes.border_around
+        max_width -= 2 if att.border_around
       end
       return [] if max_width < columns.size
-      new(columns, table.each.to_a, attributes, max_width).lines
+      new(columns, table.each.to_a, att, max_width).lines
     end
 
     attr_reader :lines
 
     private
 
-    def initialize(columns, rows, attributes, max_width)
+    def initialize(columns, rows, att, max_width)
       @max_width, @columns = WidthFinder.find(columns, max_width)
-      init_borders(attributes)
+      init_borders(att)
       @columns = @columns.each.with_index
 
       @lines = render(rows.shift)
@@ -50,12 +56,12 @@ module NattyUI
       end
     end
 
-    def init_borders(attributes)
-      chars = attributes.border_chars or return
-      style = border_style(attributes)
+    def init_borders(att)
+      chars = att.border_chars or return
+      style = border_style(att)
       @b_inner = style[chars[9]]
       return if chars[10] == ' '
-      return init_borders_around(chars, style) if attributes.border_around
+      return init_borders_around(chars, style) if att.border_around
       @b_between = chars[10] * (@max_width + @columns.size - 1)
       i = -1
       @columns[0..-2].each { |w| @b_between[i += w + 1] = chars[4] }
@@ -79,8 +85,8 @@ module NattyUI
       @b_outer = @b_inner
     end
 
-    def border_style(attributes)
-      style = attributes.border_style_bbcode
+    def border_style(att)
+      style = att.border_style_bbcode
       style ? ->(line) { "#{style}#{line}[/]" } : lambda(&:itself)
     end
 
@@ -150,6 +156,7 @@ module NattyUI
         ["#{@style}#{' ' * @padding[3]}", "#{' ' * @padding[1]}[/]"]
       end
     end
+    private_constant :Cell
   end
   private_constant :TableRenderer
 end

data/lib/natty-ui/task.rb

@@ -30,16 +30,17 @@ module NattyUI
     def initialize(parent, title, msg, pin)
       super(parent)
       @title = title
-      @prefix = '  '
-      @prefix_width = 2
       @pin = pin
       style = Theme.current.task_style
+      cm = Theme.current.mark(:current)
+      @prefix = ' ' * cm.width
+      @prefix_width = cm.width
       parent.puts(
         title,
-        first_line_prefix: "#{style}➔ ",
-        first_line_prefix_width: 2,
-        prefix: "#{style}  ",
-        prefix_width: 2
+        first_line_prefix: "#{cm}#{style}",
+        first_line_prefix_width: cm.width,
+        prefix: "#{@prefix}#{style}",
+        prefix_width: cm.width
       )
       puts(*msg) unless msg.empty?
     end

data/lib/natty-ui/theme.rb

@@ -53,6 +53,7 @@ module NattyUI
             warning: '[bright_yellow]![/fg]',
             error: '[red]𝙓[/fg]',
             failed: '[bright_red]𝑭[/fg]',
+            current: '[bright_green]➔[/fg]',
             choice: '[bright_white]◦[/fg]',
             current_choice: '[bright_green]◉[/fg]'
           )
@@ -66,6 +67,35 @@ module NattyUI
           )
         end
       end
+
+      def emoji
+        create do |theme|
+          theme.heading_sytle = :bright_blue
+          theme.task_style = %i[bright_green b]
+          # theme.choice_style =
+          theme.choice_current_style = %i[bright_white on_blue b]
+          theme.define_marker(
+            bullet: '▫️',
+            checkmark: '✅',
+            quote: '[bright_blue]▍[/fg]',
+            information: '📌',
+            warning: '⚠️',
+            error: '❗️',
+            failed: '‼️',
+            current: '➡️',
+            choice: '[bright_white]•[/fg]',
+            current_choice: '[bright_green]●[/fg]'
+          )
+          theme.define_section(
+            default: :bright_blue,
+            message: :bright_blue,
+            information: :bright_blue,
+            warning: :bright_yellow,
+            error: :red,
+            failed: :bright_red
+          )
+        end
+      end
     end
 
     attr_accessor :section_border
@@ -206,7 +236,7 @@ module NattyUI
         return create_styled_heading(heading, style) if style
         heading.map do |left|
           right = " #{left.reverse}"
-          [left = Str.new("#{left} ", true), Str.new(right, left.size)]
+          [left = Str.new("#{left} ", true), Str.new(right, left.width)]
         end
       end
 
@@ -215,7 +245,7 @@ module NattyUI
           right = Ansi.decorate(left.reverse, *style)
           [
             left = Str.new("#{Ansi.decorate(left, *style)} ", true),
-            Str.new(" #{right}", left.size)
+            Str.new(" #{right}", left.width)
           ]
         end
       end
@@ -278,6 +308,7 @@ module NattyUI
         warning: '!',
         error: '𝙓',
         failed: '𝑭',
+        current: '➔',
         choice: '◦',
         current_choice: '◉'
       }