natty-ui 0.12.0 → 0.25.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0aa357f7937c367ecc77396e7241f33a774973d773b99c6923cc975199755a14
-  data.tar.gz: '060778aaca552a23c57e39e4efd8adf3eff07658e6a712708b6c8e46c5077bc1'
+  metadata.gz: 23eed1ba95aaecb2555dfeed5a6fedbcd827299d1e4a64c91952953b3d36d787
+  data.tar.gz: 53380e5ebe647a96abbc24baecd1f24a7a3290544ac10e34e3aa8b1e8dba1e17
 SHA512:
-  metadata.gz: c79a14e0f8b02181a19268958c8784e306f66853e0e09f40ae630043a3f89b699aaaaee72622d06fff43df0eab9814908b5d692f748df0c7ff5f67d4cac1b460
-  data.tar.gz: 7b27b83b5592b3ec556e640d7d583983ec42615ac036c40a0f5b2a305616e3df846f292aae191952e312aeaf6d9e4be99ab84ed123c1853acbf055c515b9335f
+  metadata.gz: 56c829ee249c7cecce24bb9b88c131e8fdaaec20aff2f0340b16d701c77907805f7595d38cfe0e122d4f7365d6ae6babfccdd680b9754de283c7e63c944e78ea
+  data.tar.gz: 9964afa255fe3a76d59727f13edcafa31429768729e3b14408f6142f6af17236c7831836857897a0e860044732ad5a347c6bc4efb06ef277412d73d67167519d

data/LICENSE

@@ -1,6 +1,6 @@
 BSD 3-Clause License
 
-Copyright (c) 2017-2021, Mike Blumtritt. All rights reserved.
+Copyright (c) 2017-2025, Mike Blumtritt. All rights reserved.
 
 Redistribution and use in source and binary forms, with or without
 modification, are permitted provided that the following conditions are met:

data/README.md

@@ -1,30 +1,29 @@
-# 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, 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.
+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: [github.com](https://github.com/mblumtritt/natty-ui)
 - Help: [rubydoc.info](https://rubydoc.info/gems/natty-ui/NattyUI)
 
-## Description
-
-Here you find elegant, simple and beautiful tools that enhance your command line application functionally and look.
-
-You can style your text using a [BBCode](https://en.wikipedia.org/wiki/BBCode)-like syntax
-
-```ruby
- ui.puts '[bold underline bright_white]Hello [ff7bfd]World!'
-```
-
-which supports all ANSI attributes, colors in 3/4-bit, 8-bit and Truecolor. There are headers, rulers, diverse message types, framed blocks and tables to layout your text. You can organize the output of tasks, use progress bars and request and handle user input. And there are text animations for fame and fun!
-
-🚀 Have a look at the [features](https://rubydoc.info/gems/natty-ui/NattyUI/Features) or check the code [examples](./examples/)!
-
-![illustration](https://raw.githubusercontent.com/mblumtritt/natty-ui/main/examples/illustration.png)
-
-## NO_COLOR Convention
-
-NattyUI follows the [NO_COLOR convention](https://no-color.org).
+## Features
+
+![illustration](./examples/illustration.png)
+
+- automatic line break of all text output
+- markup of text attributes and colors using a [BBCode](https://en.wikipedia.org/wiki/BBCode) like syntax
+- automatic detection if ANSI is available
+- support of [NO_COLOR convention](https://no-color.org)
+- support of [CSIu input protocol](https://sw.kovidgoyal.net/kitty/keyboard-protocol)
+- headings
+- text separators
+- lists
+- various types of text blocks with automatic alignment
+- text columns
+- tables
+- task lists
+- progress indicators
+- and more!
 
 ## Help
 
@@ -32,16 +31,16 @@ NattyUI follows the [NO_COLOR convention](https://no-color.org).
 
 ### Run Examples
 
-You can execute the examples by
+You can execute all examples by
 
 ```sh
-ruby ./examples/demo.rb
+ruby ./examples/examples.rb
 ```
 
 or see the non-ANSI version
 
 ```sh
-NO_COLOR=1 ruby ./examples/demo.rb
+NO_COLOR=1 ruby ./examples/examples.rb
 ```
 
 ## Installation

data/examples/24bit-colors.rb

@@ -2,18 +2,13 @@
 
 require_relative '../lib/natty-ui'
 
-ui.space
-ui.h1 'NattyUI: 24-bit Color Support'
-ui.space
-
-ui.section do
-  bar = '█' * ui.available_width
+ui.message '[b]​ᓚᕠᗢ NattyUI[/b] [i green]24-bit Color Support[/]' do
+  ui.space
+  bar = '█' * ui.columns
   rainbow =
     (7..17).map do |i|
-      NattyUI::Ansi.rainbow(bar, seed: 3, spread: 3.25, frequence: i / 100.0)
+      NattyUI::Ansi.rainbow(bar, seed: 3, spread: 3.25, frequency: i / 100.0)
     end
 
   ui.puts(*rainbow)
 end
-
-ui.space

data/examples/3bit-colors.rb

@@ -2,13 +2,33 @@
 
 require_relative '../lib/natty-ui'
 
-ui.space
-ui.h1 'NattyUI: 3/4-bit Color Support'
-ui.space
+ui.message '[b]​ᓚᕠᗢ NattyUI[/b] [i green]3/4bit Color Support[/]' do
+  ui.space
+  ui.puts <<~INFO, ignore_newline: true
+    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
 
-color = ->(n, j) { "[#{n}]#{n.ljust(j)}[/] [on_#{n}] sample text [/]" }
-%w[black red green yellow blue magenta cyan white].each do |name|
-  ui.puts "#{color[name, 7]}    #{color["bright_#{name}", 14]}"
+  ui.space
+  ui.ls(
+    %w[
+      black
+      red
+      green
+      yellow
+      blue
+      magenta
+      cyan
+      white
+      bright_black
+      bright_red
+      bright_green
+      bright_yellow
+      bright_blue
+      bright_magenta
+      bright_cyan
+      bright_white
+    ].map { |name| "[bg_#{name}]  [/bg] [#{name}]#{name}[/fg]" }
+  )
 end
-
-ui.space

data/examples/8bit-colors.rb

@@ -2,34 +2,29 @@
 
 require_relative '../lib/natty-ui'
 
-ui.space
-ui.h1 'NattyUI: 8-bit Color Support'
-ui.space
+ui.message '[b]​ᓚᕠᗢ NattyUI[/b] [i green]8bit Color Support[/]' do
+  color = ->(i) { "[bg#{i = i.to_s(16).rjust(2, '0')}] #{i} " }
 
-color = ->(i) { "[bg#{i = i.to_s(16).rjust(2, '0')}] #{i} " }
-ui.msg 'System Colors' do
-  ui.puts <<~COLORS
+  ui.space
+  ui.message('System Colors', <<~COLORS.chomp)
     [#ff]#{0.upto(7).map(&color).join}
     [#00]#{8.upto(15).map(&color).join}
-
   COLORS
-end
 
-ui.msg '6x6x6 Color Cube' 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}"
+  ui.space
+  ui.message('Grayscale', <<~GRAYSCALE.chomp)
+    [#ff]#{0xe8.upto(0xf3).map(&color).join}
+    [#ff]#{0xf4.upto(0xff).map(&color).join}
+  GRAYSCALE
+
+  ui.space
+  ui.message '6x6x6 Color Cube' 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
     end
-    ui.space
   end
 end
-
-ui.msg 'Grayscale' do
-  ui.puts <<~GRAYSCALE
-    [#ff]#{232.upto(243).map(&color).join}
-    [#ff]#{244.upto(255).map(&color).join}
-
-  GRAYSCALE
-end

data/examples/attributes.rb

@@ -2,28 +2,33 @@
 
 require_relative '../lib/natty-ui'
 
-ui.space
-ui.h2 'NattyUI: ANSI Attributes'
-ui.space
-
-ui.puts <<~PARA1.tr("\n", ' ')
-  Some attributes are widely supported, such as [b]bold[/b],
-  [i]italic[/i], [u]underline[/u], [blink]blink[/blink],
-  [invert]invert[/invert] and [strike]strike[/strike], while others are rarely
-  complete or correctly implemented, like [faint]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
-
-ui.puts <<~PARA2.tr("\n", ' ')
-  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
+ui.message '[b]​ᓚᕠᗢ NattyUI[/b] [i green]ANSI Attributes[/]' do
+  ui.space
+  ui.puts <<~INFO_1, <<~INFO_2, ignore_newline: true
+    NattyUI supports all well known attributes like
+    [b]bold[/b],
+    [i]italic[/i],
+    [u]underline[/u],
+    [blink]blink[/blink],
+    [inv]invert[/inv]
+    and [strike]strike[/strike].
+    Other attributes like
+    [faint]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[/]
+    are not widely used but also supported.
+  INFO_1
+    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[/].
+  INFO_2
+end

data/examples/cols.rb

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+
+require_relative '../lib/natty-ui'
+
+ui.message '[b]​ᓚᕠᗢ NattyUI[/b] [i green]Print Columns[/]' do
+  ui.space
+  ui.cols(
+    'Here we',
+    'have some',
+    'columns',
+    'which are',
+    'arranged',
+    'and centered',
+    align: :centered,
+    border: :default
+  )
+
+  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(
+      'This is the middle red column.',
+      style: 'bright_white on_red',
+      align: :centered,
+      vertical: :middle
+    )
+    cc.add(
+      'This is a right aligned blue column vertically bottom aligned.',
+      style: 'bright_white on_blue',
+      align: :right,
+      vertical: :bottom
+    )
+    cc.padding = [1, 2]
+  end
+end

data/examples/elements.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+require_relative '../lib/natty-ui'
+
+ui.message '[b]​ᓚᕠᗢ NattyUI[/b] [i green]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.quote "This is a\nmulti-line quotation"
+
+  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.space
+  ui.h4('This is a [b]H4[/b] heading element')
+
+  ui.space
+  ui.h5('This is a [b]H5[/b] heading element')
+
+  ui.space
+  ui.h6('This is a [b]H6[/b] heading element')
+end

data/examples/examples.rb

@@ -0,0 +1,45 @@
+# frozen_string_literal: true
+
+require_relative '../lib/natty-ui'
+
+EXAMPLES = {
+  'attributes' => 'ANSI Attributes',
+  '3bit-colors' => '3/4bit Color Support',
+  '8bit-colors' => '8bit Color Support',
+  '24bit-colors' => '24bit Color Support',
+  'named-colors' => 'Named Colors Support',
+  'elements' => 'Simple Elements',
+  'ls' => 'Print Lists',
+  'tables' => 'Print Tables',
+  'cols' => 'Print Columns',
+  'sections' => 'Sections',
+  'tasks' => 'Tasks'
+}.freeze
+
+DEFAULT_MODE = NattyUI.input_mode == :default
+
+ui.space
+
+while true
+  selected =
+    ui.choice(**EXAMPLES, abortable: true) 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])
+    end
+
+  ui.space unless DEFAULT_MODE
+  break unless selected
+
+  ui.temporary do
+    load("#{__dir__}/#{selected}.rb")
+    if DEFAULT_MODE
+      ui.await { ui.puts '[faint][\\Press ENTER to continue...]' }
+    else
+      ui.space
+    end
+  end
+end

data/examples/illustration.rb

@@ -2,58 +2,60 @@
 
 require_relative '../lib/natty-ui'
 
-ui.space
-
-ui.table(type: :undecorated) do |table|
-  table.add(
-    'Styles',
-    "Support of all ANSI styles like #{
-      %w[
-        bold
-        italic
-        underline
-        invert
-        strike
-        faint
-        double_underline
-        curly_underline
-        dotted_underline
-        dashed_underline
-        blink
-      ].map { "[#{_1}]#{_1.tr('_', ' ')}[/]" }.join(', ')
-    }, and even rarely supported like [fraktur]fraktur[/fraktur]."
-  )
-
-  table.add('Colors', <<~TEXT)
-    ✓ [green]3/4-bit color[/]         ✓ [ff7f50]Truecolor (16.7 million)
-    ✓ [1b]8-bit color[/]           ✓ [bright_yellow]Dumb terminals
-    ✓ [bright_blue]NO_COLOR convention
-  TEXT
-
-  table.add(
-    'Markup',
-    '[0c]You can style your text using a [i]BBCode[/i]-like syntax.'
-  )
-
-  table.add('Layout', <<~TEXT)
-    🎩 heading elements     📏 horizontal rulers
-    📝 messages             [yellow]🄵[/]  framed blocks
-    [blue]┼┼[/] tables
-  TEXT
-
-  table.add('Tools', <<~TEXT)
-    ✅ tasks                [bold green]…[/]  progress bars
-    [bold bright_white]>[bright_red]_[/] user input           🔦 text animation
-  TEXT
-
-  table.add("Asian\nlanguage\nsupport", <<~TEXT)
-    [0a]🇨🇳 该库支持中文，日文和韩文文本！
-    [0a]🇯🇵 ライブラリは中国語、日本語、韓国語のテキストをサポートしています
-    [0a]🇰🇷 이 라이브러리는 중국어, 일본어 및 한국어 텍스트를 지원합니다
-  TEXT
-
-  table.align_column(0, :center)
-  table.style_column(0, :red)
+ui.message '[b]​ᓚᕠᗢ NattyUI[/b]' do
+  ui.table(border: :defaulth, border_style: 'bright_blue') do |table|
+    table.add do |row|
+      row.add 'Styles'
+      row.add <<~TEXT.tr("\n", ' ')
+        Support of all ANSI styles like
+        [bold]bold[/bold],
+        [italic]italic[/italic],
+        [underline]underline[/underline],
+        [invert]invert[/invert],
+        [strike]strike[/strike],
+        [faint]faint[/faint],
+        [double_underline]double underline[/double_underline],
+        [curly_underline]curly underline[/curly_underline],
+        [dotted_underline]dotted underline[/dotted_underline],
+        [dashed_underline]dashed underline[/dashed_underline]
+        and even rarely supported like [fraktur]fraktur[/fraktur].
+      TEXT
+    end
+
+    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
+      TEXT
+    end
+
+    table.add do |row|
+      row.add 'Markup'
+      row.add '[0c]You can style your text using a [i]BBCode[/i]-like syntax.'
+    end
+
+    table.add do |row|
+      row.add 'Layout'
+      row.add <<~TEXT.chomp
+        🎩 heading elements     📝 messages
+        📏 horizontal rulers    [blue]┼┼[/] tables
+        📋 lists                [b green]✓✓[/] tasks
+      TEXT
+    end
+
+    table.add do |row|
+      row.add 'Asian', 'language', 'support'
+      row.add <<~TEXT.chomp
+        [bright_green]🇨🇳 该库支持中文，日文和韩文文本！
+        [bright_green]🇯🇵 ライブラリは中国語、日本語、韓国語のテキストをサポートしています
+        [bright_green]🇰🇷 이 라이브러리는 중국어, 일본어 및 한국어 텍스트를 지원합니다
+      TEXT
+    end
+
+    table.columns[0].style = 'bold red'
+    table.columns[0].width = 10
+    table.columns[1].padding_right = 2
+  end
 end
-
-ui.space

data/examples/ls.rb

@@ -2,21 +2,17 @@
 
 require_relative '../lib/natty-ui'
 
-ui.space
-ui.h1 'NattyUI: Print In Columns'
-ui.space
-
-LOREM = <<~IPSUM.lines(chomp: true)
-  Lorem ipsum dolor sit
-  amet, consectetur adipisicing
-  elit, sed do eiusmod tempor
+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
+  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[/]
+  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.
@@ -27,10 +23,12 @@ LOREM = <<~IPSUM.lines(chomp: true)
   est laborum.
 IPSUM
 
-ui.h2 'Compact Display'
-ui.ls LOREM, glyph: 1
-ui.space
+ui.message '[b]​ᓚᕠᗢ NattyUI[/b] [i green]Print Lists[/]' do
+  ui.space
+  ui.h2 'Traditional Display'
+  ui.ls lorem, glyph: 1, compact: false
 
-ui.h2 'Traditional Display'
-ui.ls LOREM, glyph: 1, compact: false
-ui.space
+  ui.space
+  ui.h2 'Compact Display'
+  ui.ls lorem, glyph: 1
+end

data/examples/named-colors.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+require_relative '../lib/natty-ui'
+
+ui.message '[b]​ᓚᕠᗢ NattyUI[/b] [i green]Named Colors Support[/]' do
+  ui.puts <<~INFO
+
+    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.to_s.ljust(22)}[/fg]" }
+  )
+end

data/examples/sections.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+require_relative '../lib/natty-ui'
+
+ui.message '[b]​ᓚᕠᗢ NattyUI[/b] [i green]Sections[/]' do
+  ui.space
+  ui.information 'Informative Message' do
+    ui.puts <<~TEXT, ignore_newline: true
+      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
+  end
+
+  ui.space
+  ui.warning 'Warning', 'This is a warning message example.'
+
+  ui.space
+  ui.error 'Error Message' do
+    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
+    end
+  end
+
+  ui.space
+  ui.failed "Fail Message\nA sad failure message."
+end