natty-ui 0.30.0 → 0.31.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3573e7d7a6d163f278494a095198e3fd913ff6710c4984ff12279f80893c1b54
-  data.tar.gz: 9d424a564160fa470b71d857b31fa725320b21047abd8423e613335b0e0449c6
+  metadata.gz: 5b2d8212f4b987cd05c8ce904cdde26e0a0228c9fe360a36dfad04b0e29bd7b6
+  data.tar.gz: 8a3cd4de41e7ae69e18b6bf4e5437166f0c45fccf329009ebd0ecefd90a72f70
 SHA512:
-  metadata.gz: f2b6c3c4bc0c8636bbed5dcfcfb5cc9f77487ef84be7650abba172b707cf2e9eb9c59b9a4f0ba3c2209ce4902c704f8920cbd99d63d7da3cd347dbf466afe689
-  data.tar.gz: 2c514b126360dd2c2b6173e9944db8e3cc1bd5a5505d5176ebaa382cf9a810dccc59137c55d1b18d7f1229ac8cbcee5fa9553ad5763ecea30fa84cabc0430387
+  metadata.gz: fe766477cf1ee36fad283300a659ed4bbc5e55a56e4d7b25383359f9e6616bac1179729ddda15a2c95e58a011dd185c3b419595554197a7fae6edf57f1a02b2c
+  data.tar.gz: 40c4b083965158a22a39f171e897f40d0e2e6ee2d5ff4a601ec0015dfce9a523882e45a68f2b3208aa623effaef7d563287252eca388fb033325fb404064fb3d

data/README.md

@@ -1,4 +1,4 @@
-# NattyUI ​ᓚᕠᗢ ![version](https://img.shields.io/gem/v/natty-ui?label=)
+# ​ᓚᕠᗢ NattyUI ![version](https://img.shields.io/gem/v/natty-ui?label=)
 
 This is the beautiful, nice, nifty, fancy, neat, pretty, cool, rich, lovely, natty user interface you like to have for your command line applications. It contains elegant, simple and beautiful tools that enhance your command line interfaces functionally and aesthetically.
 
@@ -18,6 +18,7 @@ This is the beautiful, nice, nifty, fancy, neat, pretty, cool, rich, lovely, nat
 - headings
 - text separators
 - lists
+- bar graphs
 - various types of text blocks with automatic alignment
 - text columns
 - tables

data/examples/cols.rb

@@ -17,12 +17,10 @@ ui.message '[b]​ᓚᕠᗢ NattyUI[/b] [i green]Print Columns[/]' do
 
   ui.space
   ui.cols do |cc|
-    cc.add(
-      "This is a left aligned blue column with some text but also with with\n" \
-        'a forced line break.',
-      style: 'bright_white on_blue',
-      align: :left
-    )
+    cc.add(<<~TEXT, style: 'bright_white on_blue', align: :left)
+      This is a left aligned blue column with some text but also with
+      a forced line break.
+    TEXT
     cc.add(
       'This is the middle red column.',
       style: 'bright_white on_red',

data/examples/hbars.rb

@@ -10,9 +10,8 @@ ui.message '[b]​ᓚᕠᗢ NattyUI[/b] [i green]Print Horizontal Bars[/]' do
   ui.puts 'NattyUI can quick dump values as horizontal bars.'
 
   ui.space
-  ui.hbars values, style: :green, normalize: true, width: 0.5
+  ui.hbars values, style: :green, normalize: true, width: 0.5, min: 10
   ui.puts(
-    'These are the same values but [i]normalized[/i] ' \
-      'and printed in half width.'
+    'These are the same values but [i]normalized[/i] and printed in half width.'
   )
 end

data/examples/illustration.rb

@@ -3,16 +3,17 @@
 require_relative '../lib/natty-ui'
 
 ui.message '[b]​ᓚᕠᗢ NattyUI[/b]' do
+  ui.space
   ui.table(border: :defaulth, border_style: 'bright_blue') do |table|
     table.add do |row|
       row.add 'Styles'
-      row.add <<~TEXT.tr("\n", ' ')
+      row.add <<~TEXT, eol: false
         Support of all ANSI styles like
-        [bold]bold[/bold],
-        [italic]italic[/italic],
-        [underline]underline[/underline],
-        [invert]invert[/invert],
-        [strike]strike[/strike],
+        [b]bold[/b],
+        [i]italic[/i],
+        [u]underline[/u],
+        [inv]invert[/inv],
+        [s]strike[/s],
         [faint]faint[/faint],
         [double_underline]double underline[/double_underline],
         [curly_underline]curly underline[/curly_underline],
@@ -24,10 +25,9 @@ ui.message '[b]​ᓚᕠᗢ NattyUI[/b]' do
 
     table.add do |row|
       row.add 'Colors'
-      row.add <<~TEXT.chomp
-        ✓ [palegreen]3/4-bit color[/fg]         ✓ [ff7f50]Truecolor (16.7 million)
-        ✓ [skyblue]8-bit color[/fg]           ✓ [gold]Dumb terminals
-        ✓ [tan1]NO_COLOR convention
+      row.add <<~TEXT
+        ✓ [palegreen]3/4-bit color[/fg]  ✓ #{NattyUI::Ansi.rainbow('Truecolor')}       ✓ [tan1]NO_COLOR convention[/fg]
+        ✓ [skyblue]8-bit color[/fg]    ✓ [gold]Dumb terminals[/fg]
       TEXT
     end
 
@@ -38,7 +38,7 @@ ui.message '[b]​ᓚᕠᗢ NattyUI[/b]' do
 
     table.add do |row|
       row.add 'Layout'
-      row.add <<~TEXT.chomp
+      row.add <<~TEXT
         🎩 heading elements     📝 messages    📊 bar graphs
         📏 horizontal rulers    [blue]┼┼[/] tables
         📋 lists                [b green]✓✓[/] tasks
@@ -47,15 +47,14 @@ ui.message '[b]​ᓚᕠᗢ NattyUI[/b]' do
 
     table.add do |row|
       row.add 'Asian', 'language', 'support'
-      row.add <<~TEXT.chomp
+      row.add <<~TEXT
         [bright_green]🇨🇳 该库支持中文，日文和韩文文本！
         [bright_green]🇯🇵 ライブラリは中国語、日本語、韓国語のテキストをサポートしています
         [bright_green]🇰🇷 이 라이브러리는 중국어, 일본어 및 한국어 텍스트를 지원합니다
       TEXT
     end
 
-    table.columns[0].style = 'bold red'
-    table.columns[0].width = 10
+    table.columns[0].assign(style: 'bold red', width: 8)
     table.columns[1].padding_right = 2
   end
 end

data/examples/info.rb

@@ -3,15 +3,14 @@
 require_relative '../lib/natty-ui'
 
 def colors
-  return Terminal.colors.to_s if Terminal.colors < 8
-  colors = [
-    Terminal.true_color? ? 'true color' : Terminal.colors,
-    "#{(0..15).map { "[#{_1.to_s(16).rjust(2, '0')}]██" }.join}[/]"
-  ]
-  if Terminal.true_color?
-    colors << Terminal::Ansi.rainbow('████████████████████████████████')
-  end
-  colors.join("\n")
+  return Terminal.colors if Terminal.colors < 8
+  color_bar = "#{(0..15).map { "[#{_1.to_s(16).rjust(2, '0')}]██" }.join}[/]"
+  return "#{Terminal.colors}\n#{color_bar}" unless Terminal.true_color?
+  <<~COLORS
+    true color
+    #{color_bar}
+    #{Terminal::Ansi.rainbow('████████████████████████████████')}
+  COLORS
 end
 
 ui.message '[b]​ᓚᕠᗢ NattyUI[/b] [i green]Terminal Information[/]' do
@@ -22,10 +21,7 @@ ui.message '[b]​ᓚᕠᗢ NattyUI[/b] [i green]Terminal Information[/]' do
     table.add 'Input mode', Terminal.input_mode
     table.add 'Colors', colors
     table.add 'Screen size', Terminal.size.join(' x ')
-    fc = table.columns[0]
-    fc.width = 14
-    fc.padding_right = 2
-    fc.align = :right
+    table.columns[0].assign(width: 15, padding_right: 2, align: :right)
     table.columns[1].style = %i[bold bright_yellow]
   end
 end

data/examples/named-colors.rb

@@ -8,16 +8,14 @@ ui.message '[b]​ᓚᕠᗢ NattyUI[/b] [i green]Named Colors Support[/]' do
     NattyUI supports a series of named color values, such as those  supported by Kitty.
 
   INFO
-
   ui.information('Note') do
     ui.puts('Not all terminal emulators support true-colors.')
   end
 
   ui.space
   ui.ls(
-    NattyUI::Ansi
-      .named_colors
-      .delete_if { /\d/.match?(_1) }
-      .map! { "[bg_#{_1}] [/bg] [#{_1}]#{_1}[/fg]" }
+    NattyUI::Ansi.named_colors.filter_map do |name|
+      "[bg_#{name}] [/bg] [#{name}]#{name}[/fg]" unless /\d/.match?(name)
+    end
   )
 end

data/examples/tables.rb

@@ -20,14 +20,14 @@ ui.message '[b]​ᓚᕠᗢ NattyUI[/b] [i green]Print Tables[/]' do
       row.padding = [0, 2]
     end
 
-    filler_text = <<~FILLER.tr("\n", ' ')
+    filler_text = <<~FILLER
       This is some filler text to demonstrate word-wise line breaks inside
       a table cell. Please, just ignore this nonsense-text gently.
     FILLER
     table.add do |row|
-      row.add '[blue]Row 2 Col 0', filler_text, align: :right
-      row.add '[blue]Row 2 Col 1', filler_text, align: :centered
-      row.add '[blue]Row 2 Col 2', filler_text, align: :left
+      row.add '[blue]Row 2 Col 0', filler_text, eol: false, align: :right
+      row.add '[blue]Row 2 Col 1', filler_text, eol: false, align: :centered
+      row.add '[blue]Row 2 Col 2', filler_text, eol: false, align: :left
       row.padding = [1, 2]
     end
   end
@@ -37,10 +37,7 @@ ui.message '[b]​ᓚᕠᗢ NattyUI[/b] [i green]Print Tables[/]' do
     table.add(*('A'..'Z').each_slice(2).map(&:join))
     table.add(*('😀'..'😌'))
     table.add(*(3..15).map { _1.to_s(3) })
-    table.each do |row|
-      row.align = :centered
-      row.style = :bright_yellow
-    end
+    table.each { |row| row.assign(align: :centered, style: :bright_yellow) }
   end
 
   ui.space

data/examples/tasks.rb

@@ -5,48 +5,48 @@ require_relative '../lib/natty-ui'
 ui.message '[b]​ᓚᕠᗢ NattyUI[/b] [i green]Tasks[/]' do
   ui.space
   ui.puts <<~TEXT, eol: false
-    Tasks are sections that are closed either successfully or with an error message.
-    If successful, their content is only displayed temporarily and can consist of all
-    other features, in particular further (sub)tasks. As an exception to this, some
-    elements can be “pinned” as permanent content.
+    Tasks are sections that are closed either successfully or with an error
+    message. If successful, their content is only displayed temporarily and can
+    consist of all other features, in particular further (sub)tasks. As an
+    exception to this, some elements can be “pinned” as permanent content.
   TEXT
 
   # to simulate some work:
-  def foo = sleep(0.25)
-  def some = sleep(0.75)
+  def do_something = sleep(0.25)
+  def do_something_heavy = sleep(0.75)
 
   ui.space
   ui.task 'Actualize Reading List' do
     ui.puts('This is a simple which actualizes the book reading list.')
 
     ui.task('Connect to Library') do
-      foo
+      do_something
       ui.mark 'Server Found', mark: :checkmark
-      ui.task('Login...') { some }
+      ui.task('Login...') { do_something_heavy }
     end
 
-    ui.task('Request New Books') { some }
+    ui.task('Request New Books') { do_something_heavy }
 
     bar = ui.progress('Loading Books...', pin: true)
     11.times do
-      foo
+      do_something
       bar.step
     end
     bar.ok 'Books Loaded'
 
-    ui.task('Disconnect from Library') { some }
+    ui.task('Disconnect from Library') { do_something_heavy }
 
     ui.progress('Read Cover Images', max: 11) do |progress|
       while progress.value < progress.max
-        foo
+        do_something
         progress.step
       end
     end
 
     ui.pin('New Books Marked', mark: :checkmark)
 
-    ui.task('Optimize Database') { some }
+    ui.task('Optimize Database') { do_something_heavy }
 
-    ui.task('Remove Dust') { some }
+    ui.task('Remove Dust') { do_something_heavy }
   end
 end

data/examples/themes.rb

@@ -0,0 +1,51 @@
+# frozen_string_literal: true
+
+require_relative '../lib/natty-ui'
+
+NAMES = NattyUI::Theme.names.freeze
+DESCR = NAMES.map { NattyUI::Theme.description(_1) }.freeze
+ORG = NattyUI::Theme.current_name
+
+def show(name)
+  NattyUI::Theme.use(name)
+  theme = NattyUI::Theme.current
+  ui.message(
+    "[b]​ᓚᕠᗢ NattyUI [/b] [i green]Theme #{NattyUI::Theme.description(name)}[/]"
+  ) do
+    ui.ls(
+      (1..6).map do |i|
+        left, right = theme.heading(i)
+        "#{left} H#{i} #{right}"
+      end
+    )
+    ui.space
+    ui.ls(theme.defined_marks.map { "#{theme.mark(_1)} #{_1}" })
+    ui.space
+    ui.ls(
+      %i[
+        task_style
+        choice_style
+        choice_current_style
+        sh_out_style
+        sh_err_style
+      ].map { "#{theme.send(_1)}█ #{_1} [/]" }
+    )
+    ui.space
+    %i[section message information warning error].each do |name|
+      ui.send(name, name.capitalize)
+    end
+  end
+end
+
+while true
+  selected =
+    ui.choice(*DESCR, abortable: true, selected: selected) do
+      ui.puts '[bright_green b]Select a theme:[/] [faint](Abort with [\\ESC])'
+    end
+  break unless selected
+  ui.temporary do
+    show(NAMES[selected])
+    ui.await { ui.puts '[faint][\\Press ENTER to continue...]' }
+  end
+  NattyUI::Theme.use(ORG)
+end

data/lib/natty-ui/attributes.rb

@@ -3,53 +3,52 @@
 module NattyUI
   # @todo This chapter needs more documentation.
   #
-  module Attributes
-    class Base
-      # @return [Attributes] updated copy of itself
-      def merge(**attributes)
-        attributes.empty? ? dup : dup._assign(attributes)
-      end
+  class Attributes
+    # @return [Attributes] updated copy of itself
+    def merge(**attributes)
+      attributes.empty? ? dup : dup._assign(attributes)
+    end
 
-      # @return [Attributes] itself
-      def merge!(**attributes) = attributes.empty? ? self : _assign(attributes)
+    # @return [Attributes] itself
+    def merge!(**attributes) = attributes.empty? ? self : _assign(attributes)
+    alias assign merge!
 
-      # @!visibility private
-      def to_hash = _store({})
+    # @!visibility private
+    def to_hash = _store({})
 
-      # @!visibility private
-      def to_h(&block) = block ? _store({}).to_h(&block) : _store({})
+    # @!visibility private
+    def to_h(&block) = block ? _store({}).to_h(&block) : _store({})
 
-      private
+    private
 
-      def initialize(**attributes)
-        _init
-        _assign(attributes) unless attributes.empty?
-      end
+    def initialize(**attributes)
+      _init
+      _assign(attributes) unless attributes.empty?
+    end
 
-      def _init = nil
-      def _assign(_opt) = self
-      def _store(opt) = opt
-      def as_uint(value) = [0, value.to_i].max
-      def as_nint(value) = ([0, value.to_i].max if value)
+    def _init = nil
+    def _assign(_opt) = self
+    def _store(opt) = opt
+    def as_uint(value) = [0, value.to_i].max
+    def as_nint(value) = ([0, value.to_i].max if value)
 
-      def as_wh(value)
-        return unless value
-        return value > 0 ? value : nil if value.is_a?(Numeric)
-        value.is_a?(Range) ? wh_from(value.begin, value.end) : nil
-      end
+    def as_wh(value)
+      return unless value
+      return value > 0 ? value : nil if value.is_a?(Numeric)
+      value.is_a?(Range) ? wh_from(value.begin, value.end) : nil
+    end
 
-      def wh_from(min, max)
-        min = normalized(min)
-        max = normalized(max)
-        return max ? (..max) : nil unless min
-        return Range.new(min, nil) unless max
-        min == max ? min : Range.new(*[min, max].minmax)
-      end
+    def wh_from(min, max)
+      min = normalized(min)
+      max = normalized(max)
+      return max ? (..max) : nil unless min
+      return Range.new(min, nil) unless max
+      min == max ? min : Range.new(*[min, max].minmax)
+    end
 
-      def normalized(value)
-        return value < 0 ? nil : value if value.is_a?(Float) && value < 1
-        (value = value.to_i) < 1 ? nil : value
-      end
+    def normalized(value)
+      return value < 0 ? nil : value if value.is_a?(Float) && value < 1
+      (value = value.to_i) < 1 ? nil : value
     end
 
     module Align

data/lib/natty-ui/features.rb

@@ -37,12 +37,6 @@ module NattyUI
     # @return [Features]
     #   itself
     def puts(*text, **options)
-      if (ansi = Terminal.ansi?)
-        @__eol ||= "\e[m\n"
-      else
-        @__eol ||= "\n"
-      end
-
       if options.empty?
         bbcode = true
         max_width = Terminal.columns
@@ -107,10 +101,12 @@ module NattyUI
           *text,
           limit: max_width,
           bbcode: bbcode,
-          ansi: ansi,
+          ansi: Terminal.ansi?,
           ignore_newline: ignore_newline
         )
 
+      @__eol ||= Terminal.ansi? ? "\e[m\n" : "\n"
+
       if (align = options[:align]).nil?
         lines.each do |line|
           Terminal.print(prefix, line, suffix, @__eol, bbcode: false)
@@ -489,10 +485,11 @@ module NattyUI
     #   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 min [#to_f] start value
+    # @param max [#to_f] end value
     # @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 text [true, false] whether the values should be printed too
+    # @param 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
     #
@@ -501,8 +498,10 @@ module NattyUI
     # @return (see puts)
     def hbars(
       values,
-      with_values: true,
+      min: nil,
+      max: nil,
       normalize: false,
+      text: true,
       width: :auto,
       style: nil,
       text_style: nil
@@ -512,12 +511,9 @@ module NattyUI
         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
+      renderer = HBarsRenderer.new(values, min, max)
+      renderer.with_text(text_style) if text
+      puts(*renderer.lines(Utils.as_size(3..columns, width), style, normalize))
     end
 
     # Dynamically display a task progress.
@@ -582,6 +578,31 @@ module NattyUI
       block ? __with(progress, &block) : progress
     end
 
+    # Run a shell program
+    #
+    # @return [Process::Status] when command was executed
+    # @return [nil] in error case (like command not found)
+    def sh(*cmd, shell: false, input: nil)
+      m = (theme = Theme.current).mark(:sh_out)
+      opts_out = {
+        bbcode: false,
+        prefix: "#{m}#{theme.sh_out_style}",
+        prefix_width: m.width
+      }
+      m = theme.mark(:sh_err)
+      opts_err = {
+        bbcode: false,
+        prefix: "#{m}#{theme.sh_err_style}",
+        prefix_width: m.width
+      }
+      ShellCommand.call(*cmd, shell: shell, input: input) do |line, kind|
+        puts(
+          line.gsub("\t", '    ').gsub(/[[:space:]]/, ' '),
+          **(kind == :error ? opts_err : opts_out)
+        )
+      end
+    end
+
     #
     # @!endgroup
     #
@@ -963,36 +984,42 @@ module NattyUI
   end
 
   dir = __dir__
-  autoload :Choice, "#{dir}/choice.rb"
-  autoload :DumbChoice, "#{dir}/dumb_choice.rb"
-  autoload :DumbOptions, "#{dir}/dumb_options.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 :Options, "#{dir}/options.rb"
-  autoload :Progress, "#{dir}/progress.rb"
-  autoload :DumbProgress, "#{dir}/progress.rb"
   autoload :Section, "#{dir}/section.rb"
+  autoload :ShellCommand, "#{dir}/shell_command.rb"
   autoload :Table, "#{dir}/table.rb"
   autoload :Task, "#{dir}/task.rb"
   autoload :Temporary, "#{dir}/temporary.rb"
   autoload :Theme, "#{dir}/theme.rb"
   autoload :Utils, "#{dir}/utils.rb"
+
+  autoload :Choice, "#{dir}/choice.rb"
+  autoload :DumbChoice, "#{dir}/dumb_choice.rb"
+  autoload :Options, "#{dir}/options.rb"
+  autoload :DumbOptions, "#{dir}/dumb_options.rb"
+  autoload :Progress, "#{dir}/progress.rb"
+  autoload :DumbProgress, "#{dir}/progress.rb"
+
+  autoload :CompactLSRenderer, "#{dir}/ls_renderer.rb"
+  autoload :HBarsRenderer, "#{dir}/hbars_renderer.rb"
+  autoload :LSRenderer, "#{dir}/ls_renderer.rb"
   autoload :VBarsRenderer, "#{dir}/vbars_renderer.rb"
 
   private_constant(
+    :Framed,
+    :ShellCommand,
+    :Utils,
+    # -
     :Choice,
     :DumbChoice,
+    :Options,
     :DumbOptions,
+    :Progress,
+    :DumbProgress,
+    # -
     :CompactLSRenderer,
-    :Framed,
     :HBarsRenderer,
     :LSRenderer,
-    :Options,
-    :Progress,
-    :DumbProgress,
-    :Utils,
     :VBarsRenderer
   )
 end