natty-ui 0.7.0 → 0.9.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 955176038d4388a0b55468997a267434bede767869071193c3fc45526ebbc3e5
-  data.tar.gz: 6fdcd1f82ae1ee09bbd5650050edd3493eedbe584263921e1e6d5abf30900b5c
+  metadata.gz: 05a38cff2c6416d6d7832c3c053d63ebf23977a67abf485e555c35e206fe768b
+  data.tar.gz: 14363fcea12c6dbb45ce7e7b8dec8d68668f5faa4a8f20793b212e9bb9bd5905
 SHA512:
-  metadata.gz: 5104516012022478512ad583b12e5110941013849f074ac3156ef34076654ad86ebd2a723b598c595984f3a5799c831106ec17add1a17da26b7839f19746b957
-  data.tar.gz: 6f55cc25b480284da8f77e284b13768b9b84b3dbf1efef15dcec7999227d1fb04f1b9addc570a0ae536d44111b94c685238319c6605a425d42eac8f7613c4e23
+  metadata.gz: 5e5031c308e7f63c4f99ba4d6558cf3a3effab04f475f568054c079b6da3908c47df2581259a6c93f661c51e623baafeed61c91e6fe0c025f55bc0adf2b18d17
+  data.tar.gz: 6275cb88ce6f4822b57debd98a9b8c560198fb3c48028768fd39401320339561b777512d3e0ddbc15a14dd250ef60b592777453f7733156925f525755e4e1678

data/.yardopts

@@ -1,9 +1,13 @@
---readme README.md
 --title 'NattyUI Documentation'
 --charset utf-8
 --markup markdown
+--readme README.md
+--no-private
+--embed-mixins
 --tag comment
 --hide-tag comment
---embed-mixins
 --exclude lib/natty-ui/ansi_wrapper.rb
-'lib/**/*.rb' - 'README.md' 'LICENSE'
+lib/**/*.rb
+-
+README.md
+LICENSE

data/README.md

@@ -1,6 +1,6 @@
 # NattyUI ![version](https://img.shields.io/gem/v/natty-ui?label=)
 
-This is the beautiful, nice, nifty, fancy, neat, pretty, cool, lovely, natty user interface you like to have for your command line interfaces (CLI).
+This is the beautiful, nice, nifty, fancy, neat, pretty, cool, 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: [github.com](https://github.com/mblumtritt/natty-ui)
@@ -13,40 +13,43 @@ Here you find elegant, simple and beautiful tools that enhance your command line
 You can simply decorate your text with named ANSI attributes and colors
 
 ```ruby
-UI = NattyUI::StdOut
-
-UI.puts "[[bold]]Hello [[ff7bfd]]World[[/]]!"
+ui.puts "[[bold]]Hello [[ff7bfd]]World[[/]]!"
 ```
 
 or use different types of messages
 
 ```ruby
-UI.info 'NattyUI installed'
-UI.warning 'Nice gem found!'
+ui.info 'NattyUI installed'
+ui.warning 'Nice gem found!'
 ```
 
-and headings
+and headings, framed sections, progress bars and tasks, queries, tables and much much more…
 
-```ruby
-UI.h1 'The Main Title (TMT)'
-UI.h2 'A Subtitle'
-```
+🚀 Have a look at the [features](https://rubydoc.info/gems/natty-ui/NattyUI/Features)!
 
-and framed sections
+![illustration](https://raw.githubusercontent.com/mblumtritt/natty-ui/main/examples/illustration.png)
 
-```ruby
-UI.framed 'Text Below In Frame' do |framed|
-  framed.puts 'This is the text'
-end
-```
+## NO_COLOR Convention
 
-or use progression displays like progress bars.
+NattyUI follows the [NO_COLOR convention](https://no-color.org).
 
-🚀 There are much more [features](https://rubydoc.info/gems/natty-ui/NattyUI/Features)!
+## Help
 
-📕 See the [online help](https://rubydoc.info/gems/natty-ui/NattyUI) for more details or have a look at the [examples](./examples/) directory to get an impression of the current feature set.
+📕 See the [online help](https://rubydoc.info/gems/natty-ui/NattyUI) and have a look at the [examples](./examples/) directory to learn from code.
 
-![illustration](https://raw.githubusercontent.com/mblumtritt/natty-ui/main/examples/illustration.png)
+### Run Examples
+
+You can execute the examples by
+
+```sh
+ruby ./examples/demo.rb
+```
+
+or see the non-ANSI version
+
+```sh
+NO_COLOR=1 ruby ./examples/demo.rb
+```
 
 ## Installation
 
@@ -59,7 +62,7 @@ gem install natty-ui
 or you can use [Bundler](http://gembundler.com/) to add NattyUI to your own project:
 
 ```shell
-bundle add 'natty-ui'
+bundle add natty-ui
 ```
 
 After that you only need one line of code to have everything together
@@ -67,28 +70,3 @@ After that you only need one line of code to have everything together
 ```ruby
 require 'natty-ui'
 ```
-
-## Run Examples
-
-You can execute the examples by
-
-```sh
-bundle exec ruby ./examples/basic.rb
-```
-
-or see the non-ANSI version
-
-```sh
-NO_COLOR=1 bundle exec ruby ./examples/basic.rb
-```
-
-## NO_COLOR Convention
-
-NattyUI follows the [NO_COLOR convention](https://no-color.org).
-
-## TODO
-
-Since I did not complete the tests and not all my ideas are already implemented I have this Todo list:
-
-- add more samples to help
-- add more tests

data/examples/24bit-colors.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+require_relative '../lib/natty-ui'
+
+ui.space
+ui.h1 'NattyUI: 24-bit Color Support'
+ui.space
+
+RGB_COLORS = <<~SAMPLES.lines(chomp: true).map!(&:split)
+  #800000 #8b0000 #a52a2a #b22222 #dc143c #ff0000 #ff6347 #ff7f50
+  #cd5c5c #f08080 #e9967a #fa8072 #ffa07a #ff4500 #ff8c00 #ffa500
+  #ffd700 #b8860b #daa520 #eee8aa #bdb76b #f0e68c #808000 #ffff00
+  #9acd32 #556b2f #6b8e23 #7cfc00 #7fff00 #adff2f #006400 #008000
+  #228b22 #00ff00 #32cd32 #90ee90 #98fb98 #8fbc8f #00fa9a #00ff7f
+  #2e8b57 #66cdaa #3cb371 #20b2aa #2f4f4f #008080 #008b8b #00ffff
+  #00ffff #e0ffff #00ced1 #40e0d0 #48d1cc #afeeee #7fffd4 #b0e0e6
+  #5f9ea0 #4682b4 #6495ed #00bfff #1e90ff #add8e6 #87ceeb #87cefa
+SAMPLES
+
+RGB_COLORS.each { ui.puts _1.map { |v| " [[#{v}]]#{v}[[/]] " }.join }
+ui.space
+RGB_COLORS.each { ui.puts _1.map { |v| " [[on:#{v}]]#{v}[[/]] " }.join }
+ui.space
+RGB_COLORS.each do |code|
+  ui.puts code.map { |v| " [[underline ul:#{v}]]#{v}[[/]] " }.join
+end
+ui.space

data/examples/3bit-colors.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+require_relative '../lib/natty-ui'
+
+ui.space
+ui.h1 'NattyUI: 3/4-bit Color Support'
+ui.space
+
+color = ->(n) { "[[#{n}]]#{n.ljust(14)}[[/]] [[on_#{n}]] sample text [[/]]" }
+%w[black red green yellow blue magenta cyan white].each do |name|
+  ui.puts "#{color[name]}    #{color["bright_#{name}"]}"
+end
+
+ui.space

data/examples/8bit-colors.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+require_relative '../lib/natty-ui'
+
+ui.space
+ui.h1 'NattyUI: 8-bit Color Support'
+ui.space
+
+color = ->(i) { "[[bg#{i = i.to_s(16).rjust(2, '0')}]] #{i} " }
+ui.msg 'System Colors', glyph: '[[27]]◉' do
+  ui.puts "[[#ff]]#{0.upto(7).map(&color).join}"
+  ui.puts "[[#00]]#{8.upto(15).map(&color).join}"
+  ui.space
+end
+
+ui.msg '6x6x6 Color Cube', glyph: '[[27]]◉' do
+  [16, 22, 28].each do |b|
+    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}"
+    end
+    ui.space
+  end
+end
+
+ui.msg 'Grayscale', glyph: '[[27]]◉' do
+  ui.puts "[[#ff]]#{232.upto(243).map(&color).join}"
+  ui.puts "[[#ff]]#{244.upto(255).map(&color).join}"
+  ui.space
+end

data/examples/animate.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+require_relative '../lib/natty-ui'
+
+ui.space
+ui.h1 'NattyUI: Text Line Animation'
+ui.space
+
+TEXT = <<~TEXT.tr("\n", ' ')
+  Lorem [[yellow]]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 [[bold]]consequat[[/]].
+TEXT
+
+{
+  default: 'Default Animation',
+  type_writer: 'Typewriter Like',
+  rainbow: 'Shiny Rainbow',
+  matrix: 'Matrix Style'
+}.each_pair do |type, title|
+  ui.message(title, glyph: '[[27]]◉') { ui.animate TEXT, animation: type }
+  ui.space
+end

data/examples/attributes.rb

@@ -1,161 +1,27 @@
 # frozen_string_literal: true
 
-require 'natty-ui'
-
-UI = NattyUI::StdOut
-
-UI.space
-UI.h1 'NattyUI ANSI Attributes Demo', <<~TEXT
-
-  This text contains all supported ANSI attrubtes and explains the available
-  colors.
-
-  Please, keep in mind that no all terminals will support of all attributes and
-  color types used in this text. In fact, you can use the output of this text to
-  check the supported ANSI attributes.
-
-TEXT
-
-UI.h2 'Attributes', <<~TEXT
-
-  Some attributes are widely supported, such as [[bold]]bold[[/]], [[italic]]italic[[/]], [[underline]]underline[[/]], [[blink]]blink[[/]],
-  [[invert]]invert[[/]] and [[strike]]strike[[/]], while others are rarely complete or correctly implemented,
-  like [[faint]]faint[[/]], [[rapid_blink]]rapid_blink[[/]], [[double_underline]]double_underline[[/]], [[framed]]framed[[/]], [[encircled]]encircled[[/]], [[overlined]]overlined[[/]],
-  [[proportional]]proportional[[/]] and [[spacing]]spacing[[/]].
-
-  Different font types are very rarely displayed:
-
-    • [[primary_font]]primary_font[[/]]
-    • [[font1]]font1[[/]]
-    • [[font2]]font2[[/]]
-    • [[font3]]font3[[/]]
-    • [[font4]]font4[[/]]
-    • [[font5]]font5[[/]]
-    • [[font6]]font6[[/]]
-    • [[font7]]font7[[/]]
-    • [[font8]]font8[[/]]
-    • [[font9]]font9[[/]]
-    • [[fraktur]]fraktur[[/]]
-
-TEXT
-
-UI.h2 '3-bit and 4-bit Colors' do |sec|
-  sec.space
-  colors = %w[black red green yellow blue magenta cyan white].freeze
-  (colors + colors.map { |name| "bright_#{name}" }).each do |name|
-    sec.puts "  [[#{name}]]#{name.ljust(14)}[[/]] [[on_#{name}]]sample text"
-  end
-end
-UI.space
-
-UI.h2 '8-bit Colors' do |sec|
-  sec.space
-  sec.puts 'There are 256 pre-defined color which can be used by their index:'
-  sec.space
-
-  # helper:
-  colors_std = 0.upto(15)
-  colors216 = 16.upto(231).lazy
-  colors_gray1 = 232.upto(243)
-  colors_gray2 = 244.upto(255)
-  as_color = ->(i) { "[[#{i = i.to_s(16).rjust(2, '0')}]] #{i} [[/]]" }
-  as_bgcolor = ->(i) { "[[on:#{i.to_s(16).rjust(2, '0')}]] #{i} [[/]]" }
-
-  sec.puts colors_std.map(&as_color).join
-  colors216.each_slice(18) { |slice| sec.puts slice.map(&as_color).join }
-  sec.puts colors_gray1.map(&as_color).join
-  sec.puts colors_gray2.map(&as_color).join
-
-  sec.space
-  sec.puts colors_std.map(&as_bgcolor).join
-  colors216.each_slice(18) { |slice| sec.puts slice.map(&as_bgcolor).join }
-  sec.puts colors_gray1.map(&as_bgcolor).join
-  sec.puts colors_gray2.map(&as_bgcolor).join
-end
-
-UI.space
-UI.h2 '24-bit colors' do |sec|
-  sec.puts <<~TEXT
-
-    Modern terminal applications support 24-bit colors for foreground and background
-    RGB-color values. Here are just some samples:
-
-  TEXT
-
-  some_rgb = DATA.readlines(chomp: true).lazy.each_slice(8)
-
-  some_rgb.each do |slice|
-    sec.puts slice.map { |v| " [[#{v}]]#{v}[[/]] " }.join
-  end
-  sec.space
-  some_rgb.each do |slice|
-    sec.puts slice.map { |v| " [[on:#{v}]]#{v}[[/]] " }.join
-  end
-end
-UI.space
-
-__END__
-#800000
-#8b0000
-#a52a2a
-#b22222
-#dc143c
-#ff0000
-#ff6347
-#ff7f50
-#cd5c5c
-#f08080
-#e9967a
-#fa8072
-#ffa07a
-#ff4500
-#ff8c00
-#ffa500
-#ffd700
-#b8860b
-#daa520
-#eee8aa
-#bdb76b
-#f0e68c
-#808000
-#ffff00
-#9acd32
-#556b2f
-#6b8e23
-#7cfc00
-#7fff00
-#adff2f
-#006400
-#008000
-#228b22
-#00ff00
-#32cd32
-#90ee90
-#98fb98
-#8fbc8f
-#00fa9a
-#00ff7f
-#2e8b57
-#66cdaa
-#3cb371
-#20b2aa
-#2f4f4f
-#008080
-#008b8b
-#00ffff
-#00ffff
-#e0ffff
-#00ced1
-#40e0d0
-#48d1cc
-#afeeee
-#7fffd4
-#b0e0e6
-#5f9ea0
-#4682b4
-#6495ed
-#00bfff
-#1e90ff
-#add8e6
-#87ceeb
-#87cefa
+require_relative '../lib/natty-ui'
+
+ui.space
+ui.h2 'NattyUI: ANSI Attributes'
+ui.space
+
+ui.puts <<~PARA1.tr("\n", ' '), <<~PARA2.tr("\n", ' ')
+  Some attributes are widely supported, such as [[bold]]bold[[/]],
+  [[italic]]italic[[/]], [[underline]]underline[[/]], [[blink]]blink[[/]],
+  [[invert]]invert[[/]] and [[strike]]strike[[/]], while others are rarely
+  complete or correctly implemented,  like [[faint]]faint[[/]],
+  [[double_underline]]double underline[[/]], [[curly_underline]]curly
+  underline[[/]], [[dotted_underline]]dotted underline[[/]],
+  [[dashed_underline]]dashed underline[[/]], [[rapid_blink]]rapid_blink[[/]],
+  [[framed]]framed[[/]], [[encircled]]encircled[[/]],
+  [[overlined]]overlined[[/]] and [[proportional]]proportional[[/]].
+PARA1
+  Alternative fonts are mostly completely ignored:
+  [[primary_font]]primary_font[[/]], [[fraktur]]fraktur[[/]],
+  [[font1]]font1[[/]], [[font2]]font2[[/]], [[font3]]font3[[/]],
+  [[font4]]font4[[/]], [[font5]]font5[[/]], [[font6]]font6[[/]],
+  [[font7]]font7[[/]], [[font8]]font8[[/]], [[font9]]font9[[/]].
+PARA2
+
+ui.space

data/examples/demo.rb

@@ -0,0 +1,53 @@
+# frozen_string_literal: true
+
+require_relative '../lib/natty-ui'
+
+ui.page do
+  ui.space
+  ui.h1 'NattyUI: Examples'
+  ui.space
+
+  ruby =
+    ENV.fetch('RUBY') do
+      require('rbconfig')
+      File.join(
+        RbConfig::CONFIG['bindir'],
+        "#{RbConfig::CONFIG['ruby_install_name']}#{RbConfig::CONFIG['EXEEXT']}"
+      ).sub(/.*\s.*/m, '"\&"')
+    end
+  run = ->(name) { system(ruby, File.join(__dir__, "#{name}.rb")) }
+  run['illustration']
+
+  ui.space
+
+  choices = {}
+  examples = {}
+  {
+    '1' => ['attributes', 'ANSI Attributes'],
+    '2' => ['message', 'Message Types'],
+    '3' => ['3bit-colors', '3/4-bit Color Support'],
+    '4' => ['8bit-colors', '8-bit Color Support'],
+    '5' => ['24bit-colors', '24-bit Color Support'],
+    '6' => ['ls', 'Print In Columns'],
+    '7' => %w[table Tables],
+    '8' => ['animate', 'Text Line Animation'],
+    '9' => ['progress', 'Progress Indication'],
+    '0' => ['query', 'User Queries'],
+    'ESC' => [nil, 'Exit Demo']
+  }.each_pair do |key, (name, descr)|
+    examples[key] = name
+    choices[key] = descr
+  end
+
+  loop do
+    choice =
+      ui.query(
+        'Which example do you like to watch?',
+        display: :compact,
+        **choices
+      ) or break
+    example = examples[choice] or break
+    ui.cls
+    run[example]
+  end
+end

data/examples/illustration.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+require_relative '../lib/natty-ui'
+
+ui.framed do
+  ui.msg('Natty UI', <<~TEXT.tr("\n", ' '), glyph: '⭐️')
+    This is the [[c4]]beautiful[[/]], [[c5]]nice[[/]], [[c6]]nifty[[/]],
+    [[c7]]fancy[[/]], [[c8]]neat[[/]], [[c9]]pretty[[/]],  [[ca]]cool[[/]],
+    [[cb]]lovely[[/]], [[cc]]natty[[/]] [[bold]]user interface[[/]] you like to
+    have for your command line applications. It contains [[italic]]elegant[[/]],
+    [[italic]]simple[[/]] and [[italic]]beautiful[[/]] tools that enhance your
+    command line interfaces functionally and aesthetically.
+  TEXT
+
+  ui.msg('Features', glyph: '⭐️') { ui.ls(<<~FEATURES.lines(chomp: true)) }
+    [[bold red]]T[[/]]  text attributes
+    🌈 text coloring
+    🔦 text animation
+    🎩 heading elements
+    📏 horizontal rulers
+    📝 messages
+    [[bold blue]]""[[/]] quote blocks
+    [[yellow]]🄵[[/]]  framed blocks
+    ✅ tasks
+    [[bold green]]…[[/]]  progress bars
+    [[blue]]┼┼[[/]] tables
+    [[bold bright_white]]>[[bright_red]]_[[/]] user input
+  FEATURES
+end

data/examples/{list_in_columns.rb → ls.rb}

@@ -1,10 +1,12 @@
 # frozen_string_literal: true
 
-require 'natty-ui'
+require_relative '../lib/natty-ui'
 
-UI = NattyUI::StdOut
+ui.space
+ui.h1 'NattyUI: Print In Columns'
+ui.space
 
-LOREM = <<~LOREM
+LOREM = <<~IPSUM.lines(chomp: true)
   Lorem ipsum dolor sit
   amet, consectetur adipisicing
   elit, sed do eiusmod tempor
@@ -14,7 +16,7 @@ LOREM = <<~LOREM
   nostrud exercitation ullamco
   laboris nisi ut aliquip ex
   ea commodo [[bold]]consequat[[/]]. Duis
-  aute irure dolor in
+  aute irure [[bold green]]dolor[[/]] in
   reprehenderit in voluptate
   velit [[underline]]esse cillum[[/]] dolore eu
   fugiat nulla pariatur.
@@ -23,21 +25,12 @@ LOREM = <<~LOREM
   sunt in culpa qui officia
   deserunt mollit anim id
   est laborum.
-LOREM
-WORDS = LOREM.split(/\W+/).uniq.sort!.freeze
+IPSUM
 
-UI.space
-UI.h2 'Print a list in columns'
-UI.space
+ui.h2 'Compact Display'
+ui.ls LOREM, glyph: 1
+ui.space
 
-UI.h3 'Lorem ipsum lines'
-UI.ls LOREM.lines(chomp: true)
-UI.space
-
-UI.h3 'Lorem ipsum word list (compact)'
-UI.ls WORDS
-UI.space
-
-UI.h3 'Lorem ipsum word list (row-wise)'
-UI.ls WORDS, compact: false
-UI.space
+ui.h2 'Traditional Display'
+ui.ls LOREM, glyph: 1, compact: false
+ui.space

data/examples/message.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+require_relative '../lib/natty-ui'
+
+ui.space
+ui.h1 'NattyUI: Message Types'
+ui.space
+
+TEXT = <<~TEXT.tr("\n", ' ')
+  Lorem [[yellow]]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 [[bold]]consequat[[/]].
+TEXT
+
+IMPORTANT =
+  '[[red]]>>>[[/]] [[italic]]Here some important information[[/]] [[red]]<<<'
+
+ui.framed do
+  ui.info 'Informative Message', TEXT
+  ui.warning 'Warning Message' do
+    ui.puts TEXT
+    ui.framed { ui.puts IMPORTANT }
+  end
+  ui.error 'Error Message', TEXT
+  ui.failed 'Fail Message', TEXT
+  ui.message '[[italic #fad]]Custom Message', TEXT, glyph: '💡'
+end
+
+ui.space