natty-ui 0.5.3 → 0.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6a717eec681b358c4979684881f16d5217dea7ebacca3baf46f84edfc318d39b
-  data.tar.gz: 2829903b6bf15aa81d33259bf77633d6ed6b9e5f88a598bc858b881be94da4cc
+  metadata.gz: 955176038d4388a0b55468997a267434bede767869071193c3fc45526ebbc3e5
+  data.tar.gz: 6fdcd1f82ae1ee09bbd5650050edd3493eedbe584263921e1e6d5abf30900b5c
 SHA512:
-  metadata.gz: 274f008deb82e73ba4a6c0b93d2a4e4cea3afdd60284d8fdc8e462e56cf04f6e5bda8a25af1c1707cd5a8c92612d48f445f5d127fb5c6531d183b3b8ac424279
-  data.tar.gz: 770c07b0085ac1efd565b141fae6f704899a89b7e8b648fd27e687166a13676edd3a38039d8f4aeae7c490849cf39a5d2d22daed25d6a1c0b9540340b21483f4
+  metadata.gz: 5104516012022478512ad583b12e5110941013849f074ac3156ef34076654ad86ebd2a723b598c595984f3a5799c831106ec17add1a17da26b7839f19746b957
+  data.tar.gz: 6f55cc25b480284da8f77e284b13768b9b84b3dbf1efef15dcec7999227d1fb04f1b9addc570a0ae536d44111b94c685238319c6605a425d42eac8f7613c4e23

data/.yardopts

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

data/README.md

@@ -46,7 +46,7 @@ or use progression displays like progress bars.
 
 📕 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.
 
-![illustration](https://raw.githubusercontent.com/mblumtritt/natty-ui/main/examples/illustration.svg)
+![illustration](https://raw.githubusercontent.com/mblumtritt/natty-ui/main/examples/illustration.png)
 
 ## Installation
 
@@ -73,13 +73,13 @@ require 'natty-ui'
 You can execute the examples by
 
 ```sh
-ruby ./examples/basic.rb
+bundle exec ruby ./examples/basic.rb
 ```
 
 or see the non-ANSI version
 
 ```sh
-NO_COLOR=1 ruby ./examples/basic.rb
+NO_COLOR=1 bundle exec ruby ./examples/basic.rb
 ```
 
 ## NO_COLOR Convention
@@ -92,5 +92,3 @@ Since I did not complete the tests and not all my ideas are already implemented
 
 - add more samples to help
 - add more tests
-- simple prompt
-- password prompt

data/examples/attributes.rb

@@ -0,0 +1,161 @@
+# 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

data/examples/basic.rb

@@ -1,7 +1,6 @@
 # frozen_string_literal: true
 
-# require 'natty-ui'
-require_relative '../lib/natty-ui'
+require 'natty-ui'
 
 UI = NattyUI::StdOut
 
@@ -9,15 +8,15 @@ UI.space
 
 UI.h1 'NattyUI Basic Feature Demo', <<~TEXT
 
-  This is a short demo of the basic features of [[i117 bold]]NattyUI[[/]].
+  This is a short demo of the basic features of [[75 bold]]NattyUI[[/]].
 
 TEXT
 
 UI.h2 'Feature: ANSI Colors and Attributes', <<~TEXT
 
-  Like you might noticed you can [[i87]]color [[i215]]text[[/]] for terminals supporting this
+  Like you might noticed you can [[57]]color [[d7]]text[[/]] for terminals supporting this
   feature. You can enforece the non-ANSI version by setting the environment
-  variable [[i117 italic]]NO_COLOR[[/]] to '[[i117]]1[[/]]'. (see also [[underline]]https://no-color.org[[/]])
+  variable [[75 italic]]NO_COLOR[[/]] to '[[75]]1[[/]]'. (see also [[underline]]https://no-color.org[[/]])
 
   You can not only color your text but also [[italic]]modify[[/]], [[underline]]decorate[[/]] and [[strike]]manipulate[[/]]
   it. The attributes are direct embedded into the text like '[[/bold red]]'
@@ -40,14 +39,14 @@ UI.h2 'Feature: Sections' do |sec|
   sec.error 'Error Message'
   sec.completed 'Completion Message'
   sec.failed 'Failure Message'
-  sec.msg '[[i213]]Customized Message', symbol: '◉'
+  sec.msg '[[d5]]Customized Message', symbol: '◉'
   sec.space
 
   sec.puts 'You can stack all kinds of sections together:'
   sec.space
-  sec.framed('Simple Framed Section', type: :simple) do |f1|
-    f1.framed('Heavy Framed Section', type: :heavy) do |f2|
-      f2.framed('Semi Framed Section', type: :semi) do |f3|
+  sec.framed('Rouned Frame') do |f1|
+    f1.framed('Heavy Framed', type: :heavy) do |f2|
+      f2.framed('Simple Frame', type: :simple) do |f3|
         f3.framed('Double Framed Section', type: :double) do |f4|
           f4.message(
             '[[fff400]]Frames are nice',

data/examples/list_in_columns.rb

@@ -0,0 +1,43 @@
+# frozen_string_literal: true
+
+require 'natty-ui'
+
+UI = NattyUI::StdOut
+
+LOREM = <<~LOREM
+  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 [[bold]]consequat[[/]]. Duis
+  aute irure dolor 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.
+LOREM
+WORDS = LOREM.split(/\W+/).uniq.sort!.freeze
+
+UI.space
+UI.h2 'Print a list in columns'
+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

data/examples/progress.rb

@@ -1,7 +1,6 @@
 # frozen_string_literal: true
 
-# require 'natty-ui'
-require_relative '../lib/natty-ui'
+require 'natty-ui'
 
 UI = NattyUI::StdOut
 
@@ -10,75 +9,60 @@ UI.h1 'NattyUI Progress Indication Demo'
 UI.space
 
 # just simulate some work
-def something = sleep(0.4)
+def something = sleep(0.5)
 def some = sleep(0.15)
 
-UI.framed('Pogress Indicators') do |sec|
-  progress = sec.progress('Progress with max_value', max_value: 11)
-  11.times do
-    progress.step
-    something
-  end
-  progress.done 'Progress ok'
-
-  progress = sec.progress('Simple progress')
-  20.times do
-    progress.step
-    some
-  end
-  progress.done 'All fine'
-end
+UI.info 'Tasks are sections to visualize step by step processing.' do |info|
+  info.task 'Assemble assets' do |task|
+    task.task('Initialize') { something }
 
-# simulate assembling task steps
-def assemble(task)
-  task.msg 'Collect files...'
-  something
-  task.task 'Compile files...' do |subtask|
-    %w[readme.txt main.css main.html sub.html].each do |name|
-      subtask.msg "Compile file [[bright_yellow]]./source/#{name}[[/]]..."
-      something
+    progress = task.progress 'Connect to server...'
+    20.times do
+      progress.step
+      some
     end
-    subtask.done 'Files compiled.'
-  end
-  something
-  task.msg 'Compressing...'
-  something
-  task.msg 'Signing...'
-  something
-  task.msg 'Store assembled results...'
-  something
-end
+    progress.ok 'Connected'
+
+    task.task('Collect files...') { something }
 
-UI.framed('Tasks') do |sec|
-  sec.puts 'Tasks are sections to visualize step by step processing.'
-  sec.task('Assemble assets') { |task| assemble(task) }
-  sec.space
+    task.task 'Compile files...' do |subtask|
+      %w[readme.txt main.css main.html sub.html].each do |name|
+        subtask.msg "Compile file [[bright_yellow]]./source/#{name}[[/]]..."
+        something
+      end
+      subtask.done 'Files compiled.'
+    end
 
-  sec.puts 'If such a task failed the logged messages are kept:'
-  assembling = sec.task('Assemble assets')
-  assemble(assembling)
-  assembling.failed
-  sec.space
+    progress = task.progress('Compress files', max_value: 11)
+    11.times do
+      progress.step
+      something
+    end
+    progress.done 'All compressed'
 
-  sec.puts 'You can add some more description when failed:'
-  sec.task('Assemble assets') do |task|
-    assemble(task)
-    task.failed('Unable to store results', <<~ERROR)
-      Server reported Invalid credentials
-      Check your credentials and try again...
-    ERROR
+    task.task('Signing') { something }
 
-    This code here is never reached!
+    task.task('Store assembled results') { something }
   end
-  sec.space
+  info.puts(
+    'The details are removed ([[italic]]in ANSI version[[/]]) when the task',
+    'ended sucessfully.'
+  )
+end
 
-  sec.puts 'You can also add a description when all was fine:'
-  sec.task('Assemble assets') do |task|
-    assemble(task)
-    task.done('Assets assembled', <<~INFO)
-      Your assets are ready on server now.
-    INFO
+UI.info 'Details of failed tasks will not be cleaned.' do |info|
+  info.task 'Assemble assets' do |task|
+    task.task('Initialize') { something }
 
-    This code here is never reached!
+    progress = task.progress 'Connect to server...'
+    20.times do
+      progress.step
+      some
+    end
+    progress.failed 'Unable to connect to server'
+
+    task.error 'This code will not be reachd!'
   end
 end
+
+UI.space

data/examples/query.rb

@@ -1,32 +1,43 @@
 # frozen_string_literal: true
 
-# require 'natty-ui'
-require_relative '../lib/natty-ui'
+require 'natty-ui'
 
 UI = NattyUI::StdOut
 
 UI.space
+UI.h1 'NattyUI Query Demo'
+UI.space
+
+unless UI.ask('Do you like to continute? (Y|n)')
+  UI.failed 'aborted'
+  exit
+end
 
-UI.framed('NattyUI Query Demo') do |sec|
-  unless sec.ask('Do you like to continute? (Y|n)')
-    sec.failed('aborted')
-    sec.close
-    exit
-  end
+choice =
+  UI.query(
+    'Which fruits do you prefer?',
+    'Apples',
+    'Bananas',
+    'Cherries',
+    x: 'No fruits',
+    result: :choice
+  )
+unless choice
+  UI.failed 'aborted'
+  exit false
+end
+UI.info "Your choice: #{choice}"
+
+answer = UI.request 'Are you okay?'
+unless answer
+  UI.failed 'aborted'
+  exit false
+end
+UI.info "Your answer: #{answer.inspect}"
 
-  choice =
-    sec.query(
-      'Which fruits do you prefer?',
-      'Apples',
-      'Bananas',
-      'Cherries',
-      x: 'No fruits',
-      result: :choice
-    )
-  unless choice
-    sec.failed('aborted')
-    sec.close
-    exit(false)
-  end
-  sec.info("Your choice: #{choice}")
+answer = UI.request('What is your current password?', password: true)
+unless answer
+  UI.failed 'aborted'
+  exit false
 end
+UI.info "I'll keep your secret!"