natty-ui 0.7.0 → 0.8.0

data/examples/list_in_columns.rb

@@ -2,8 +2,6 @@
 
 require 'natty-ui'
 
-UI = NattyUI::StdOut
-
 LOREM = <<~LOREM
   Lorem ipsum dolor sit
   amet, consectetur adipisicing
@@ -14,7 +12,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.
@@ -24,20 +22,15 @@ LOREM = <<~LOREM
   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.space
+ui.h1 'Print a list in columns'
+ui.space
 
-UI.h3 'Lorem ipsum word list (compact)'
-UI.ls WORDS
-UI.space
+ui.h2 'Lorem ipsum lines (compact)'
+ui.ls LOREM.lines(chomp: true), glyph: 1
+ui.space
 
-UI.h3 'Lorem ipsum word list (row-wise)'
-UI.ls WORDS, compact: false
-UI.space
+ui.h2 'Lorem ipsum lines (row-wise)'
+ui.ls LOREM.lines(chomp: true), glyph: 1, compact: false
+ui.space

data/examples/progress.rb

@@ -2,67 +2,62 @@
 
 require 'natty-ui'
 
-UI = NattyUI::StdOut
-
-UI.space
-UI.h1 'NattyUI Progress Indication Demo'
-UI.space
+ui.space
+ui.h1 'NattyUI Progress Indication Demo'
+ui.space
 
 # just simulate some work
 def something = sleep(0.5)
 def some = sleep(0.15)
 
-UI.info 'Tasks are sections to visualize step by step processing.' do |info|
-  info.task 'Assemble assets' do |task|
-    task.task('Initialize') { something }
+ui.info 'Tasks are sections to visualize step by step processing.' do
+  ui.task 'Assemble assets' do
+    ui.task('Initialize') { something }
 
-    progress = task.progress 'Connect to server...'
+    progress = ui.progress 'Connect to server...'
     20.times do
       progress.step
       some
     end
     progress.ok 'Connected'
 
-    task.task('Collect files...') { something }
+    ui.task('Collect files...') { something }
 
-    task.task 'Compile files...' do |subtask|
+    ui.task 'Compile files...' do
       %w[readme.txt main.css main.html sub.html].each do |name|
-        subtask.msg "Compile file [[bright_yellow]]./source/#{name}[[/]]..."
+        ui.msg "Compile file [[bright_yellow]]./source/#{name}[[/]]..."
         something
       end
-      subtask.done 'Files compiled.'
+      ui.done 'Files compiled.'
     end
 
-    progress = task.progress('Compress files', max_value: 11)
+    progress = ui.progress('Compress files', max_value: 11)
     11.times do
       progress.step
       something
     end
     progress.done 'All compressed'
 
-    task.task('Signing') { something }
+    ui.task('Signing') { something }
 
-    task.task('Store assembled results') { something }
+    ui.task('Store assembled results') { something }
   end
-  info.puts(
+
+  ui.puts(
     'The details are removed ([[italic]]in ANSI version[[/]]) when the task',
     'ended sucessfully.'
   )
 end
 
-UI.info 'Details of failed tasks will not be cleaned.' do |info|
-  info.task 'Assemble assets' do |task|
-    task.task('Initialize') { something }
-
-    progress = task.progress 'Connect to server...'
-    20.times do
-      progress.step
-      some
+ui.info 'Details of failed tasks will not be cleaned.' do
+  ui.task 'Assemble assets' do
+    ui.task('Initialize') { something }
+    ui.task('Connect to Server') do
+      something
+      ui.failed 'Unable to connect to server'
     end
-    progress.failed 'Unable to connect to server'
-
-    task.error 'This code will not be reachd!'
+    ui.error 'This code will not be reachd!'
   end
 end
 
-UI.space
+ui.space

data/examples/query.rb

@@ -2,42 +2,36 @@
 
 require 'natty-ui'
 
-UI = NattyUI::StdOut
+ui.space
+ui.h1 'NattyUI Query Demo'
+ui.space
 
-UI.space
-UI.h1 'NattyUI Query Demo'
-UI.space
+# little helper
+def abort!
+  ui.failed 'aborted'
+  exit
+end
 
-unless UI.ask('Do you like to continute? (Y|n)')
-  UI.failed 'aborted'
+unless ui.ask('Do you like to continute? (Y|n): ')
+  ui.info 'ok, try later!'
   exit
 end
 
 choice =
-  UI.query(
+  ui.query(
     'Which fruits do you prefer?',
     'Apples',
-    'Bananas',
+    '[[yellow]]Bananas[[/]]',
     'Cherries',
-    x: 'No fruits',
-    result: :choice
+    x: 'No fruits'
   )
-unless choice
-  UI.failed 'aborted'
-  exit false
-end
-UI.info "Your choice: #{choice}"
+abort! unless choice
+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}"
+answer = ui.request 'What is your favorite verb?: '
+abort! unless answer
+ui.info "Your answer: #{answer.inspect}"
 
-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!"
+answer = ui.request('What is your current password?:', password: true)
+abort! unless answer
+ui.info "I'll keep your secret!"

data/examples/table.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+require 'natty-ui'
+
+User = Struct.new(:id, :name, :address)
+
+USERS = [
+  User.new(1, 'Henry', 'henry@some.test'),
+  User.new(2, 'Sam', 'sam-sam@some.test'),
+  User.new(3, 'Taylor', 'taylor@some.test'),
+  User.new(3, 'Max', 'maxxx@some.test')
+].freeze
+
+ui.space
+ui.h1 'The User List'
+ui.space
+
+ui.table(User.members, *USERS)

data/lib/natty-ui/ansi.rb

@@ -5,44 +5,85 @@ module NattyUI
   # Helper module for ANSI escape codes.
   #
   module Ansi
-    class << self
-      # @return [String] ANSI code to reset all attributes
-      def reset = "\e[0m"
+    # ANSI code to move the cursor down.
+    CURSOR_DOWN = "\e[B"
+
+    # ANSI code to move the cursor up.
+    CURSOR_UP = "\e[A"
+
+    # ANSI code to move the cursor left.
+    CURSOR_LEFT = "\e[D"
+
+    # ANSI code to move the cursor right.
+    CURSOR_RIGHT = "\e[C"
+
+    # ANSI code to move the cursor to beginning of the line below.
+    CURSOR_LINE_DOWN = "\e[E"
+
+    # ANSI code to move the cursor to beginning of the line up.
+    CURSOR_LINE_UP = "\e[F"
+
+    # ANSI code to hide the cursor.
+    CURSOR_HIDE = "\e[?25l"
+
+    # ANSI code to show the cursor (again).
+    CURSOR_SHOW = "\e[?25h"
+
+    # ANSI code to save current cursor position.
+    CURSOR_SAVE_POS = "\e[s"
+
+    # ANSI code to restore saved cursor position.
+    CURSOR_RESTORE_POS = "\e[u"
+
+    # ANSI code to set cursor position on upper left corner.
+    CURSOR_HOME = "\e[H"
+
+    # ANSI code to erase current line and position to first column.
+    LINE_CLEAR = "\e[1K\e[0G"
+
+    # ANSI code to erase current line.
+    LINE_ERASE = "\e[2K"
 
-      # @return [String] ANSI code to save current screen state
-      def screen_save = "\e[?47h"
+    # ANSI code to erase to end of current line.
+    LINE_ERASE_TO_END = "\e[0K"
 
-      # @return [String] ANSI code to restore screen state
-      def screen_restore = "\e[?47l"
+    # ANSI code to erase to begin of current line.
+    LINE_ERASE_TO_BEGIN = "\e[1K"
 
-      # @return [String] ANSI code to alternate screen
-      def screen_alternative = "\e[?1049h"
+    # ANSI code to save current screen state.
+    SCREEN_SAVE = "\e[?47h"
 
-      # @return [String] ANSI code to set alternate screen off
-      def screen_alternative_off = "\e[?1049l"
+    # ANSI code to restore screen state.
+    SCREEN_RESTORE = "\e[?47l"
 
-      # @return [String] ANSI code to erase screen
-      def screen_erase = "\e[2J"
+    # ANSI code to erase screen.
+    SCREEN_ERASE = "\e[2J"
 
-      # @return [String] ANSI code to erase screen below current cursor position
-      def screen_erase_below = "\e[0J"
+    # ANSI code to erase screen below current cursor position.
+    SCREEN_ERASE_BELOW = "\e[0J"
 
-      # @return [String] ANSI code to erase screen above current cursor position
-      def screen_erase_above = "\e[1J"
+    # ANSI code to erase screen above current cursor position.
+    SCREEN_ERASE_ABOVE = "\e[1J"
 
-      # @return [String] ANSI code to erase current line
-      def line_erase = "\e[2K"
+    # ANSI code to alternate screen
+    SCREEN_ALTERNATIVE = "\e[?1049h"
 
-      # @return [String] ANSI code to erase to end of current line
-      def line_erase_to_end = "\e[0K"
+    # ANSI code to set alternate screen off.
+    SCREEN_ALTERNATIVE_OFF = "\e[?1049l"
 
-      # @return [String] ANSI code to erase to begin of current line
-      def line_erase_to_begin = "\e[1K"
+    # ANSI code to reset all attributes.
+    RESET = "\e[0m"
 
-      # @return [String] ANSI code to erase current line and position to first
-      #   column
-      def line_clear = "\e[1K\e[0G"
+    # @!visibility private
+    CURSOR_RIGHT_ALIGNED = "\e[9999G\e[D\e[C"
 
+    # @!visibility private
+    BLANK_SLATE = "\e[0m\e[s\e[?47h\e[H\e[2J"
+
+    # @!visibility private
+    UNBLANK_SLATE = "\e[?47l\e[u\e[0m"
+
+    class << self
       # @param lines [Integer] number of lines
       # @return [String] ANSI code to move the cursor up
       def cursor_up(lines = nil) = "\e[#{lines}A"
@@ -60,37 +101,18 @@ module NattyUI
       def cursor_left(columns = nil) = "\e[#{columns}D"
 
       # @param lines [Integer] number of lines
-      # @return [String] ANSI code to move the cursor to beginning of the line
-      #   some lines down
+      # @return [String] ANSI code to move the cursor to beginning of some lines
+      #   below
       def cursor_line_down(lines = nil) = "\e[#{lines}E"
 
       # @param lines [Integer] number of lines
-      # @return [String] ANSI code to move the cursor to beginning of the line
-      #   some lines up
+      # @return [String] ANSI code to move the cursor to beginning of some lines
+      #   up
       def cursor_line_up(lines = nil) = "\e[#{lines}F"
 
-      # @param columns [Integer] number of columns
+      # @param column [Integer] column number
       # @return [String] ANSI code to move the cursor to given column
-      def cursor_column(columns = nil) = "\e[#{columns}G"
-
-      # @return [String] ANSI code positioning the cursor on right hand side of
-      #   the terminal
-      def cursor_right_aligned = "\e[9999G\e[D\e[C"
-
-      # @return [String] ANSI code to hide the cursor
-      def cursor_hide = "\e[?25l"
-
-      # @return [String] ANSI code to show the cursor (again)
-      def cursor_show = "\e[?25h"
-
-      # @return [String] ANSI code to save current cursor position
-      def cursor_save_pos = "\e[s"
-
-      # @return [String] ANSI code to restore saved cursor position
-      def cursor_restore_pos = "\e[u"
-
-      # @return [String] ANSI code to set cursor position on upper left corner
-      def cursor_home = "\e[H"
+      def cursor_column(column = nil) = "\e[#{column}G"
 
       # @param row [Integer] row to set cursor
       # @param column [Integer] column to set cursor
@@ -100,17 +122,17 @@ module NattyUI
         column ? "\e[;#{column}H" : "\e[H"
       end
 
-      # Decorate given `obj` with ANSI `attributes`.
+      # Decorate given `str` with ANSI `attributes`.
       #
       # @see []
       #
-      # @param obj [#to_s] object to be decorated
+      # @param str [#to_s] object to be decorated
       # @param attributes [Symbol, String] attribute names to be used
       # @param reset [Boolean] whether to include reset code for ANSI attributes
-      # @return [String] `obj` converted and decorated with the ANSI `attributes`
-      def embellish(obj, *attributes, reset: true)
+      # @return [String] `str` converted and decorated with the ANSI `attributes`
+      def embellish(str, *attributes, reset: true)
         attributes = self[*attributes]
-        attributes.empty? ? "#{obj}" : "#{attributes}#{obj}#{"\e[0m" if reset}"
+        attributes.empty? ? str.to_s : "#{attributes}#{str}#{"\e[0m" if reset}"
       end
 
       # Remove ANSI attribtes from given string.
@@ -229,9 +251,7 @@ module NattyUI
       def try_convert(attributes)
         return if (attributes = attributes.to_s.split).empty?
         "\e[#{
-          attributes
-            .map { |arg| ATTRIBUTES[arg] || color(arg) || return }
-            .join(';')
+          attributes.map { ATTRIBUTES[_1] || color(_1) || return }.join(';')
         }m"
       end
 
@@ -262,7 +282,7 @@ module NattyUI
           end
         val.delete_prefix!('#')
         case val.size
-        when 2
+        when 1, 2
           "#{base}5;#{val.hex}" if /\A[[:xdigit:]]+\z/.match?(val)
         when 3
           if /\A[[:xdigit:]]+\z/.match?(val)
@@ -433,7 +453,7 @@ module NattyUI
         ul_bright_magenta: '58;2;255;0;255',
         ul_bright_cyan: '58;2;0;255;255',
         ul_bright_white: '58;2;255;255;255'
-      }.tap { |ret| ret.merge!(ret.transform_keys(&:to_s)).freeze }
+      }.tap { _1.merge!(_1.transform_keys(&:to_s)).freeze }
     private_constant :ATTRIBUTES
   end
 end