natty-ui 0.35.0 → 1.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f193a0c86adab949f0d0c40d522e879d47f0a75a6a52ae9cf4f9ff39a7582e0e
-  data.tar.gz: 2841fcf9135c48ef2df17ffcea4f5ff7619fe51dc62a489e58a9b7fc21f2bc1d
+  metadata.gz: ffd6017665733941fd093cbedda29b355bc207fd0ed3cecfdc041fcbc4b015f1
+  data.tar.gz: 0c8bd80f79200f5a0736a3830724e3effba02e45e90a7700ff3282206e0892fa
 SHA512:
-  metadata.gz: 8d956fcf0d7cf2809bda3db9e82e84a02fe260e7646c54f1ba195dc04e3e8842677d6bb2c6e3dc95712c2da59580d6753e5218cccd2779408d10c1174cf96d12
-  data.tar.gz: 99c7fa8acd5d4f6c12db79b95e02da4a269ade5439a8d6918ca8b47a07ac2dce24cb2f91a146f23fe3b9d4554588b2e6f9b02be476cf725d9e058985f7ed763a
+  metadata.gz: fc669642409c79aab2bf8147e6a1a490b83920e2549d8bf869c11d21e914c21b2f3e8e17135ce281d619716bbfb35536213826494a7e83ac37d996365c4ef6e4
+  data.tar.gz: 28ebfab029b8e77b9179f5d9652031e997cadc57e8eaf600729ccda22e0eaeb5443839ea58b7e157d7e425c495adddd38bd725d6c5e58758c9dff61b86be2f82

data/README.md

@@ -1,14 +1,14 @@
-# ​ᓚᕠᗢ NattyUI ![version](https://img.shields.io/gem/v/natty-ui?label=)
+# ᓚᕠᗢ NattyUI v1.0.2
 
 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.
 
 - Gem: [rubygems.org](https://rubygems.org/gems/natty-ui)
 - Source: [codeberg.org](https://codeberg.org/mblumtritt/natty-ui)
-- Help: [rubydoc.info](https://rubydoc.info/gems/natty-ui/NattyUI)
+- Help: [rubydoc.info](https://rubydoc.info/gems/natty-ui/1.0.2/NattyUI)
 
 ## Features
 
-![illustration](./examples/illustration.png)
+![illustration](./examples/illustration.jpeg)
 
 - automatic line break of all text output
 - markup of text attributes and colors using a [BBCode](https://en.wikipedia.org/wiki/BBCode) like syntax
@@ -28,7 +28,7 @@ This is the beautiful, nice, nifty, fancy, neat, pretty, cool, rich, lovely, nat
 
 ## Help
 
-📕 See the [online help](https://rubydoc.info/gems/natty-ui/index) and have a look at the [examples](./examples/) directory to learn from code.
+📕 See the [online help](https://rubydoc.info/gems/natty-ui/index) and have a look at the [examples](https://codeberg.org/mblumtritt/natty-ui/src/branch/main/examples) directory to learn from code.
 
 ### Run Examples
 
@@ -52,7 +52,7 @@ You can install the gem in your system with
 gem install natty-ui
 ```
 
-or you can use [Bundler](http://gembundler.com/) to add NattyUI to your own project:
+or you can use [Bundler](https://bundler.io) to add NattyUI to your own project:
 
 ```shell
 bundle add natty-ui
@@ -66,4 +66,4 @@ require 'natty-ui'
 
 ## Dependencies
 
-It uses only the fantastic [Terminal.rb](https://rubygems.org/gems/terminal_rb) gem.
+It uses the fantastic [Terminal.rb](https://rubygems.org/gems/terminal_rb) gem.

data/examples/24bit-colors.rb

@@ -2,13 +2,17 @@
 
 require_relative '../lib/natty-ui'
 
-ui.message '[b]​ᓚᕠᗢ NattyUI[/b] [i green]24-bit Color Support[/]' do
+ui.begin '[b]ᓚᕠᗢ NattyUI[/b] [i green]24-bit Color Support' do
   bar = '█' * ui.columns
   rainbow =
-    (7..21).map do |i|
-      NattyUI::Ansi.rainbow(bar, seed: 3, spread: 3.25, frequency: i / 200.0)
+    (7..27).map do |i|
+      NattyUI::Ansi.rainbow(
+        bar,
+        spread: 3.33,
+        seed: 3.33,
+        frequency: i / 333.33
+      )
     end
 
-  ui.space
-  ui.puts(*rainbow)
+  ui.puts rainbow.join, padding: [1, 0]
 end

data/examples/3bit-colors.rb

@@ -2,16 +2,14 @@
 
 require_relative '../lib/natty-ui'
 
-ui.message '[b]​ᓚᕠᗢ NattyUI[/b] [i green]3/4bit Color Support[/]' do
-  ui.space
-  ui.puts <<~INFO, eol: false
+ui.begin '[b]ᓚᕠᗢ NattyUI[/b] [i green]3/4bit Color Support' do
+  ui.puts <<~INFO, eol: false, padding: [1, 0]
     Terminals may support colors. You can colorize foreground text and
     background. The very basic color palette consists of eight colors and may
     be extended with eight colors which are much brighter.
   INFO
 
-  ui.space
-  ui.ls(
+  colors =
     %w[
       black
       red
@@ -29,6 +27,8 @@ ui.message '[b]​ᓚᕠᗢ NattyUI[/b] [i green]3/4bit Color Support[/]' do
       bright_magenta
       bright_cyan
       bright_white
-    ].map { |name| "[bg_#{name}]  [/bg] [#{name}]#{name}[/fg]" }
-  )
+    ].map { |name| "[on_#{name}]   [/bg] [#{name}]#{name}[/fg]" }
+
+  ui.ls colors
+  ui.space
 end

data/examples/8bit-colors.rb

@@ -2,22 +2,20 @@
 
 require_relative '../lib/natty-ui'
 
-ui.message '[b]​ᓚᕠᗢ NattyUI[/b] [i green]8bit Color Support[/]' do
-  color = ->(i) { "[bg#{i = i.to_s(16).rjust(2, '0')}] #{i} " }
+ui.begin '[b]ᓚᕠᗢ NattyUI[/b] [i green]8bit Color Support' do
+  color = ->(i) { "[on#{i = i.to_s(16).rjust(2, '0')}] #{i} " }
 
   ui.space
-  ui.message 'System Colors', <<~COLORS.chomp
+  ui.message('System Colors').puts(<<~COLORS.chomp).end
     [#ff]#{0.upto(7).map(&color).join}
     [#00]#{8.upto(15).map(&color).join}
   COLORS
-  ui.end
 
   ui.space
-  ui.message 'Grayscale', <<~GRAYSCALE.chomp
+  ui.message('Grayscale').puts(<<~GRAYSCALE.chomp).end
     [#ff]#{0xe8.upto(0xf3).map(&color).join}
     [#ff]#{0xf4.upto(0xff).map(&color).join}
   GRAYSCALE
-  ui.end
 
   ui.space
   ui.message '6x6x6 Color Cube' do
@@ -25,7 +23,7 @@ ui.message '[b]​ᓚᕠᗢ NattyUI[/b] [i green]8bit Color Support[/]' do
       b.step(b + 185, by: 36) do |i|
         left = i.upto(i + 5).map(&color).join
         right = (i + 18).upto(i + 23).map(&color).join
-        ui.puts "[#ff]#{left}[bg_default]#{right}"
+        ui.puts "[#ff]#{left}[on_default]#{right}"
       end
     end
   end

data/examples/attributes.rb

@@ -2,9 +2,8 @@
 
 require_relative '../lib/natty-ui'
 
-ui.message '[b]​ᓚᕠᗢ NattyUI[/b] [i green]ANSI Attributes[/]' do
-  ui.space
-  ui.puts <<~INFO_1, <<~INFO_2, eol: false
+ui.begin '[b]ᓚᕠᗢ NattyUI[/b] [i green]ANSI Attributes' do
+  ui.puts <<~INFO_1, <<~INFO_2, eol: false, padding: [1, 0]
     NattyUI supports all well known attributes like
     [b]bold[/b],
     [i]italic[/i],

data/examples/elements.rb

@@ -2,23 +2,26 @@
 
 require_relative '../lib/natty-ui'
 
-ui.message '[b]​ᓚᕠᗢ NattyUI[/b] [i green]Simple Elements[/]' do
+ui.begin '[b]ᓚᕠᗢ NattyUI:[/b] [i]Simple Elements' do
   ui.space
   ui.h1 'This is a [b]H1[/b] heading element'
 
   ui.space
   ui.h2 'This is a [b]H2[/b] heading element'
 
+  ui.space
+  ui.hr
+
   ui.space
   ui.quote "This is a\nmulti-line quotation"
 
+  ui.space
+  ui.hr '~'
+
   ui.space
   ui.h3 'This is a [b]H3[/b] heading element'
-  ui.mark(
-    'This is a multi-line message',
-    'with a leading checkmark.',
-    mark: :checkmark
-  )
+  ui.mark "This is a multi-line\nmarked message."
+  ui.mark 'And this is', 'another one.', mark: '[bold bright_red]!'
 
   ui.space
   ui.h4 'This is a [b]H4[/b] heading element'

data/examples/examples.rb

@@ -12,12 +12,13 @@ EXAMPLES = {
   'elements' => 'Simple Elements',
   'ls' => 'Print Lists',
   'tables' => 'Print Tables',
-  'cols' => 'Print Columns',
   'vbars' => 'Print Vertical Bars',
   'hbars' => 'Print Horizontal Bars',
   'sections' => 'Sections',
+  'frames' => 'Frames',
+  'sh' => 'Shell Execute',
   'tasks' => 'Tasks',
-  'options' => 'Options and Selections'
+  'select' => 'Selections'
 }.freeze
 
 ui.space
@@ -25,12 +26,11 @@ ui.space
 while true
   selected =
     ui.choice(**EXAMPLES, abortable: true, selected: selected) do
-      ui.cols(
-        "[red] /\\_/\\\n( o.o )\n > ^ <",
-        '[bright_green b]Select a natty example:',
-        width: 8
-      )
-      ui.div('[faint](Abort with [\\ESC])', padding: [1, 0, 1])
+      ui.puts <<~INFO, padding: [0, 0, 1]
+        [red] /\\_/\\
+        [red]( o.o )  [bright_green b]Select a natty example:
+        [red] > ^ <     [/fg faint](Abort with [\\ESC])
+      INFO
     end
 
   ui.space unless Terminal.ansi?
@@ -39,7 +39,7 @@ while true
   ui.temporary do
     load("#{__dir__}/#{selected}.rb")
     if Terminal.ansi?
-      ui.await { ui.puts '[faint][\\Press ENTER to continue...]' }
+      ui.await { ui.puts '[faint][\Press a key to continue...]' }
     else
       ui.space
     end

data/examples/frames.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+require_relative '../lib/natty-ui'
+
+ui.begin '[b]ᓚᕠᗢ NattyUI[/b] [i green]Frames' do
+  ui.puts <<~INFO, eol: false, padding: [1, 0]
+    A [i]framed section[/i] is a block element which supports all other
+    features.
+    This means frames may contain text,
+    other sections and frames,
+    titles,
+    horizontal rules,
+    lists,
+    progress bars and much more.
+  INFO
+
+  ui.frame do
+    ui.margin 1, 0.25 do
+      ui.frame border: :heavy do
+        ui.puts 'Frames can have different types of borders.', padding: 1
+
+        ui.frame border: :double do
+          ui.puts 'And can have different borders for horizontal rules.',
+                  padding: 1
+          ui.hr :single
+          ui.puts 'Frames are fun!', padding: [0, 1]
+        end
+      end
+    end
+  end
+end

data/examples/hbars.rb

@@ -2,8 +2,8 @@
 
 require_relative '../lib/natty-ui'
 
-ui.message '[b]​ᓚᕠᗢ NattyUI[/b] [i green]Print Horizontal Bars[/]' do
-  values = [11.97, 14.35, 15.51, 12.39, 14.3, 10.6, 17.7].freeze
+ui.begin '[b]ᓚᕠᗢ NattyUI[/b] [i green]Print Horizontal Bars' do
+  values = [11.9712, 14.35, 15.51, 12.39, 14.3, 10.6, 17.7].freeze
 
   ui.space
   ui.hbars values, style: :blue
@@ -12,6 +12,9 @@ ui.message '[b]​ᓚᕠᗢ NattyUI[/b] [i green]Print Horizontal Bars[/]' do
   ui.space
   ui.hbars values, style: :green, normalize: true, width: 0.5, min: 10
   ui.puts <<~INFO, eol: false
-    These are the same values but [i]normalized[/i] and printed in half width.
+    These are the same values but [i]normalized[/i] and limited to the half
+    width of the terminal.
   INFO
+
+  ui.space
 end

data/examples/info.rb

@@ -4,7 +4,7 @@ require_relative '../lib/natty-ui'
 
 def colors
   return Terminal.colors if Terminal.colors < 8
-  color_bar = "#{(0..15).map { "[#{_1.to_s(16).rjust(2, '0')}]██" }.join}[/]"
+  color_bar = "#{(0..15).map { "[#{it.to_s(16).rjust(2, '0')}]██" }.join}[/]"
   return "#{Terminal.colors}\n#{color_bar}" unless Terminal.true_color?
   <<~COLORS
     true color
@@ -13,15 +13,18 @@ def colors
   COLORS
 end
 
-ui.message '[b]​ᓚᕠᗢ NattyUI[/b] [i green]Terminal Information[/]' do
+ui.begin '[b]ᓚᕠᗢ NattyUI[/b] [i green]Terminal Information' do
   ui.space
-  ui.table do |table|
-    table.add 'Identifier', Terminal.application || 'unidentified'
-    table.add 'ANSI support', Terminal.ansi? ? 'yes' : 'no'
-    table.add 'Input mode', Terminal.input_mode
-    table.add 'Screen size', Terminal.size.join(' x ')
-    table.add 'Colors', colors
-    table.columns[0].assign(width: 15, padding_right: 2, align: :right)
-    table.columns[1].style = %i[bold bright_yellow]
+  ui.table(border: :none) do |table|
+    table.add_row 'Identifier', Terminal.application || 'unidentified'
+    table.add_row 'ANSI support', Terminal.ansi? ? 'yes' : 'no'
+    table.add_row 'Input mode', Terminal.input_mode
+    table.add_row 'Screen size', Terminal.size.join(' x ')
+    table.add_row 'Colors', colors
+    table.columns[0].attributes.assign(
+      width: 15,
+      right_padding: 2,
+      align: :right
+    )
   end
 end

data/examples/key-codes.rb

@@ -2,24 +2,23 @@
 
 require_relative '../lib/natty-ui'
 
-ui.message '[b]​ᓚᕠᗢ NattyUI[/b] [i green]Keyboard Key Codes[/]' do
-  ui.space
+ui.begin '[b]ᓚᕠᗢ NattyUI[/b] [i green]Keyboard Key Codes' do
   ui.puts(
-    "Your terminal uses [bright_blue]#{Terminal.input_mode}[/] mode. Press a key!",
-    '[dim](Exit with ESC)'
+    "Your terminal uses [bright_blue]#{
+      Terminal.input_mode
+    }[/] mode. Press a key!",
+    '[dim](Exit with ESC)',
+    padding: [1, 0, 1]
   )
 
-  ui.space
   # if you like to have mouse position changes reported then use
   # 'mouse_move: true' in next line
   Terminal.on_key_event(mouse: true, focus: true, mouse_move: false) do |event|
     ui.puts(
       "#{event.raw.inspect} [dim]→[/dim] [bold bright_green]#{
-        event.to_a.map { "[\\#{_1}]" }.join('+')
+        event.to_a.map { "[\\#{it}]" }.join('+')
       }#{" @ #{event.position.join(', ')}" if event.position}"
     )
-    event.name != 'Esc'
+    break if event.name == 'Esc'
   end
-
-  ui.space
 end

data/examples/ls.rb

@@ -2,28 +2,28 @@
 
 require_relative '../lib/natty-ui'
 
-lorem = <<~IPSUM.lines(chomp: true)
-  Lorem ipsum dolor sit amet,
-  consectetur adipisicing elit,
-  sed do eiusmod tempor
-  incididunt ut labore et
-  dolore [red]magna[/] aliqua.
-  Ut enim ad minim veniam, quis
-  nostrud exercitation ullamco
-  laboris nisi ut aliquip ex
-  ea commodo [b]consequat[/b].
-  Duis aute irure [bold green]dolor[/fg] in[/]
-  reprehenderit in voluptate
-  velit [underline]esse cillum[/] dolore eu
-  fugiat nulla pariatur.
-  Excepteur sint occaecat
-  cupidatat non proident,
-  sunt in culpa qui officia
-  deserunt mollit anim id
-  est laborum.
-IPSUM
-
-ui.message '[b]​ᓚᕠᗢ NattyUI[/b] [i green]Print Lists[/]' do
+ui.begin '[b]ᓚᕠᗢ NattyUI[/b] [i green]Print Lists' do
+  lorem = <<~IPSUM.lines(chomp: true)
+    [b]Lorem ipsum[/b] dolor sit amet,
+    consectetur adipisicing elit,
+    sed do eiusmod tempor
+    incididunt ut labore et
+    dolore [red]magna[/] aliqua.
+    Ut enim ad minim veniam, quis
+    nostrud exercitation ullamco
+    laboris nisi ut aliquip ex
+    ea commodo [b]consequat[/b].
+    Duis aute irure [bold green]dolor[/fg] in[/]
+    reprehenderit in voluptate
+    velit [underline]esse cillum[/] dolore eu
+    fugiat nulla pariatur.
+    Excepteur sint occaecat
+    cupidatat non proident,
+    sunt in culpa qui officia
+    deserunt mollit anim id
+    est laborum.
+  IPSUM
+
   ui.space
   ui.h2 'Traditional Display'
   ui.ls lorem, glyph: 1, compact: false
@@ -47,4 +47,6 @@ ui.message '[b]​ᓚᕠᗢ NattyUI[/b] [i green]Print Lists[/]' do
   ui.space
   ui.h2 'Custom Glyph'
   ui.ls lorem.take(5), glyph: '[b bright_yellow]→[/]'
+
+  ui.space
 end

data/examples/named-colors.rb

@@ -2,7 +2,7 @@
 
 require_relative '../lib/natty-ui'
 
-ui.message '[b]​ᓚᕠᗢ NattyUI[/b] [i green]Named Colors Support[/]' do
+ui.begin '[b]ᓚᕠᗢ NattyUI[/b] [i green]Named Colors Support' do
   ui.space
   ui.puts <<~INFO, eol: false
     NattyUI supports a series of named color values,
@@ -11,13 +11,14 @@ ui.message '[b]​ᓚᕠᗢ NattyUI[/b] [i green]Named Colors Support[/]' do
 
   ui.space
   ui.information 'Note' do
-    ui.puts 'Not all terminal emulators support true-colors.'
+    ui.puts 'Not all terminal emulators support true-color.'
   end
 
   ui.space
   ui.ls(
     NattyUI::Ansi.named_colors.filter_map do |name|
-      "[bg_#{name}] [/bg] [#{name}]#{name}[/fg]" unless /\d/.match?(name)
+      "[on_#{name}]   [/bg] [#{name}]#{name}[/fg]" unless /\d/.match?(name)
     end
   )
+  ui.space
 end

data/examples/sections.rb

@@ -2,33 +2,35 @@
 
 require_relative '../lib/natty-ui'
 
-ui.message '[b]​ᓚᕠᗢ NattyUI[/b] [i green]Sections[/]' do
-  ui.space
-  ui.information 'Informative Message' do
-    ui.puts <<~TEXT, eol: false
-      Sections and messages are elements which support any other feature. This
-      means they may contain text, other sections, titles, horizontal rules,
-      lists, progress bars and much more!
-    TEXT
+ui.begin '[b]ᓚᕠᗢ NattyUI[/b] [i green]Sections' do
+  ui.puts <<~TEXT, eol: false, padding: [1, 0]
+    A [i]section[/i] is a block element which supports all other features.
+    This means sections may contain text,
+    other sections and frames,
+    titles,
+    horizontal rules,
+    lists,
+    progress bars and much more.
+  TEXT
 
-    ui.space
-    ui.cols do |cc|
-      cc.add "()-()\n \\\"/\n  `", width: 6, style: :yellow
-      cc.add 'You can add all other elements to a section.', vertical: :middle
+  ui.message 'Section Types' do
+    ui.puts 'There are several pre-defined message types displayed here:',
+            padding: [1, 0]
+
+    ui.information 'Information' do
+      ui.puts 'Section type for informational notes.'
     end
 
-    ui.framed(<<~TEXT, align: :centered, eol: false).end
-      Sections and messages can be called with code blocks and will be
-      automatically closed when the block ends. Without a code block the
-      section or message needs to be closed.
-    TEXT
-  end
+    ui.warning 'Warning' do
+      ui.puts 'Section to bring attention tocontent.'
+    end
 
-  ui.warning "Warning\nThis is a warning message example."
-  ui.end
+    ui.error 'Error' do
+      ui.puts 'Section to display error messages.'
+    end
 
-  ui.error('Error Message', <<~MSG, align: :right, prefix: '[b red]>[/] ').end
-    Error message text with
-    print options.
-  MSG
+    ui.fatal 'Fatal' do
+      ui.puts 'Section to be used when things escalate.'
+    end
+  end
 end

data/examples/select.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+require_relative '../lib/natty-ui'
+
+ui.section '[b]ᓚᕠᗢ NattyUI[/b] [i green]Selection' do
+  ui.space
+  ui.puts <<~INFO, eol: false
+    [i]Selections[/i] allow the user to select from several options
+    interactively.
+    If ANSI is available the user can use [b][Up][/b] and [b][Down][/b] keys to
+    navigate, switch the state of selected item with [b][Space][/b] and complete
+    the selection with [b][Enter][/b].
+  INFO
+
+  ui.space
+  selected =
+    ui.select 'Kitty', 'iTerm2', 'Ghostty', 'Tabby', 'Rio' do
+      ui.puts '[i]Which terminal applications have you already tested?[/i]'
+    end
+  case selected.size
+  when 0
+    ui.puts 'You selected nothing – test more in the future!'
+  when 1
+    ui.puts "#{selected.first} is indeed a nice terminal."
+  else
+    ui.puts "#{selected.join(', ')} are worth testing!"
+  end
+end

data/examples/sh.rb

@@ -2,16 +2,34 @@
 
 require_relative '../lib/natty-ui'
 
-ui.message '[b]​ᓚᕠᗢ NattyUI[/b] [i green]Call Shell[/]' do
+ui.begin '[b]ᓚᕠᗢ NattyUI[/b] [i green]Shell Execute' do
   ui.space
-  ui.message 'Pipe this file to [i]cat[/i]; limit to five lines' do
-    File.open(__FILE__) do |file|
-      ui.run 'cat', input: file, preserve_spaces: true, max_lines: 5
-    end
+  ui.puts <<~INFO, eol: false
+    You can simply run Shell commands and wrap their output at word boundaries,
+    or run commands, capture their output and error messages, and limit the
+    number of lines displayed.
+  INFO
+
+  ui.space
+  ui.message 'Run a shell command' do
+    ui.sh 'echo "Hello Ruby!"'
+  end
+
+  ui.space
+  ui.message 'Run a shell script' do
+    ui.run <<~SH_SCRIPT
+      for i in 1 2 3 4
+      do
+        for str in 'Hello Ruby!' 'This is an example output.' 3 4
+        do echo "$str" && sleep 0.1
+        done
+        echo 'This is an error example.' >&2
+      done
+    SH_SCRIPT
   end
 
   ui.space
-  ui.message 'Call [i]cat[/i] with invalid option' do
-    ui.sh 'cat', '-?'
+  ui.message 'Pipe this file to [i]cat[/i] command and limit the line count' do
+    File.open(__FILE__) { |file| ui.run 'cat', input: file, max_lines: 5 }
   end
 end