natty-ui 0.32.0 → 0.34.0

data/lib/natty-ui/features.rb

@@ -45,7 +45,7 @@ module NattyUI
         ignore_newline = options[:eol] == false || options[:ignore_newline]
 
         if (max_width = options[:max_width]).nil?
-          return self if (max_width = Terminal.columns).zero?
+          max_width = Terminal.columns
         elsif max_width < 1
           if max_width > 0
             max_width *= Terminal.columns
@@ -56,6 +56,8 @@ module NattyUI
           end
         end
 
+        return self if max_width <= 0
+
         prefix_width =
           if (prefix = options[:prefix])
             prefix = Ansi.bbcode(prefix) if bbcode
@@ -117,8 +119,7 @@ module NattyUI
       end
 
       unless options[:expand]
-        lines = lines.to_a
-        max_width = lines.max_by(&:last).last
+        max_width = (lines = lines.to_a).max_by(&:last)[-1]
       end
 
       case align
@@ -595,20 +596,15 @@ module NattyUI
     #
     # @see run
     #
-    # @param cmd [String]
-    #   command and optional arguments
-    # @param shell [true,false]
-    #   whether a seperate shell should be created
-    # @param input [IO,#to_io,Array,#each,#to_a,#to_s,nil]
-    #   input piped to the command
-    # @param preserve_spaces [true,false]
-    #   whether the spaces and tabs of the output should be preserve
+    # @param cmd (see run)
+    # @param preserve_spaces (see run)
+    # @param options (see run)
     # @return [Process::Status]
     #   when command was executed
     # @return [nil]
     #   in error case (like command not found)
-    def sh(*cmd, shell: false, input: nil, preserve_spaces: false)
-      ShellRenderer.sh(self, cmd, shell, input, preserve_spaces)
+    def sh(*cmd, preserve_spaces: false, **options)
+      ShellRenderer.sh(self, cmd, options, preserve_spaces)
     end
 
     # Execute a shell program and return output. Limit the lines displayed.
@@ -621,27 +617,23 @@ module NattyUI
     #
     # @see sh
     #
-    # @param cmd (see sh)
-    # @param shell (see sh)
-    # @param input (see sh)
-    # @param preserve_spaces (see sh)
-    # @param max_lines [Integer] limit of displayed lines
+    # @param cmd [String]
+    #   command and optional arguments
+    # @param preserve_spaces [true,false]
+    #   whether the spaces and tabs of the output should be preserve
+    # @param max_lines [Integer]
+    #   limit of displayed lines
+    # @param options [Hash] executions options
     # @return [[Process::Status, Array<String>, Array<String>]]
     #   process status, output and error output when command was executed
-    # @return [nil] in error case (like command not found)
-    def run(
-      *cmd,
-      shell: false,
-      input: nil,
-      preserve_spaces: false,
-      max_lines: 10
-    )
+    # @return [nil]
+    #   in error case (like command not found)
+    def run(*cmd, preserve_spaces: false, max_lines: 10, **options)
       result =
         ShellRenderer.run(
           self,
           cmd,
-          shell,
-          input,
+          options,
           preserve_spaces,
           max_lines.clamp(1, Terminal.rows)
         )
@@ -794,28 +786,20 @@ module NattyUI
     #   # Italian, Polish, Portuguese, Romanian, Spanish and Swedish.
     #
     # @overload await(yes: 'Enter', no: 'Esc')
-    #   @param yes [String, Enumerable<String>]
-    #     key code/s a user can input to return positive result
-    #   @param no [String, Enumerable<String>]
-    #     key code/s a user can input to return negative resault
-    #
-    #   @return [true, false]
-    #     whether the user inputs a positive result
     #
     # @overload await(yes: 'Enter', no: 'Esc', &block)
-    #   @param yes [String, Enumerable<String>]
-    #     key code/s a user can input to return positive result
-    #   @param no [String, Enumerable<String>]
-    #     key code/s a user can input to return negative resault
-    #
     #   @yieldparam temp [Temporary]
     #     temporary displayed section (section will be erased after input)
     #
-    #   @return [true, false]
-    #     whether the user inputs a positive result
-    #   @return nil
-    #     in error case
+    # @param yes [String, Enumerable<String>]
+    #   key code/s a user can input to return positive result
+    # @param no [String, Enumerable<String>]
+    #   key code/s a user can input to return negative resault
     #
+    # @return [true, false]
+    #   whether the user inputs a positive result
+    # @return [nil]
+    #   in error case
     def await(yes: 'Enter', no: 'Esc')
       return __await(yes, no) unless block_given?
       temporary do |temp|
@@ -828,9 +812,9 @@ module NattyUI
     # The selected option is returned.
     #
     # @overload choice(*choices, abortable: false)
-    #   @param [#to_s] choices
+    #   @param choices [#to_s]
     #     one or more alternatives to select from
-    #   @param [true, false] abortable
+    #   @param abortable [true, false]
     #     whether the user is allowed to abort with 'Esc' or 'Ctrl+c'
     #
     #   @return [Integer]
@@ -845,9 +829,9 @@ module NattyUI
     #     # => 1, when bananas are user's favorite
     #     # => 2, when user is a oranges lover
     #
-    #   @param [#to_s] choices
+    #   @param choices[#to_s]
     #     one or more alternatives to select from
-    #   @param [true, false] abortable
+    #   @param abortable[true, false]
     #     whether the user is allowed to abort with 'Esc' or 'Ctrl+c'
     #
     #   @yieldparam temp [Temporary]
@@ -859,11 +843,11 @@ module NattyUI
     #     when user aborted the selection
     #
     # @overload choice(**choices, abortable: false)
-    #   @param [#to_s] choices
+    #   @param choices [#to_s]
     #     one or more alternatives to select from
-    #   @param [true, false] abortable
+    #   @param abortable [true, false]
     #     whether the user is allowed to abort with 'Esc' or 'Ctrl+c'
-    #   @param [#to_s, nil] selected
+    #   @param selected [#to_s, nil]
     #     optionally pre-selected option
     #
     #   @return [Object]
@@ -883,11 +867,11 @@ module NattyUI
     #     ) { ui.puts 'Which terminal emulator do you like?' }
     #     # => whether the user selected: :k, :i, :g, :t, :r
     #     # => nil, when the user aborted
-    #   @param [#to_s] choices
+    #   @param choices[#to_s]
     #     one or more alternatives to select from
-    #   @param [true, false] abortable
+    #   @param abortable[true, false]
     #     whether the user is allowed to abort with 'Esc' or 'Ctrl+c'
-    #   @param [Integer] selected
+    #   @param selected[Integer]
     #     pre-selected option index
     #
     #   @yieldparam temp [Temporary]
@@ -912,11 +896,11 @@ module NattyUI
     # Allows the user to select from several options.
     # All options are returned with their selection status.
     #
-    # @param [{#to_s => [true,false]}] choices
+    # @param choices [{#to_s => [true,false]}]
     #   Hash of options and their selection state
-    # @param [true, false] abortable
+    # @param abortable [true, false]
     #   whether the user is allowed to abort with 'Esc' or 'Ctrl+c'
-    # @param [#to_s, nil] selected
+    # @param selected [#to_s, nil]
     #   optionally pre-selected key
     #
     # @yieldparam temp [Temporary]
@@ -945,11 +929,11 @@ module NattyUI
     #    ui.puts '[i]Which terminal applications did you already tested?[/i]'
     #   end
     #
-    # @param [Array<#to_s>] choices
+    # @param choices [Array<#to_s>]
     #   selectable options
-    # @param [true, false] abortable
+    # @param abortable [true, false]
     #   whether the user is allowed to abort with 'Esc' or 'Ctrl+c'
-    # @param [Integer, :all, nil] selected
+    # @param selected [Integer, :all, nil]
     #   optionally pre-selected option index or `:all` to pre-select all items
     # @yieldparam temp [Temporary]
     #   temporary displayed section (section will be erased after input)
@@ -982,7 +966,7 @@ module NattyUI
     # @!group Utilities
     #
 
-    # @!visibility private
+    # @private
     def columns = Terminal.columns
 
     # Display some temporary content.
@@ -1017,18 +1001,21 @@ module NattyUI
     end
 
     def __await(yes, no)
-      while (event = Terminal.read_key_event&.name)
+      Terminal.on_key_event do |event|
+        event = event.name
         if (no == event) || (no.is_a?(Enumerable) && no.include?(event))
           return false
         end
         if (yes == event) || (yes.is_a?(Enumerable) && yes.include?(event))
           return true
         end
+        true
       end
     end
   end
 
-  dir = __dir__
+  dir = __dir__ # call the function once
+
   autoload :Framed, "#{dir}/framed.rb"
   autoload :Section, "#{dir}/section.rb"
   autoload :Table, "#{dir}/table.rb"
@@ -1036,6 +1023,7 @@ module NattyUI
   autoload :Temporary, "#{dir}/temporary.rb"
   autoload :Theme, "#{dir}/theme.rb"
   autoload :Utils, "#{dir}/utils.rb"
+  private_constant(:Framed, :Utils)
 
   autoload :Choice, "#{dir}/choice.rb"
   autoload :DumbChoice, "#{dir}/dumb_choice.rb"
@@ -1043,24 +1031,21 @@ module NattyUI
   autoload :DumbOptions, "#{dir}/dumb_options.rb"
   autoload :Progress, "#{dir}/progress.rb"
   autoload :DumbProgress, "#{dir}/progress.rb"
+  private_constant(
+    :Choice,
+    :DumbChoice,
+    :Options,
+    :DumbOptions,
+    :Progress,
+    :DumbProgress
+  )
 
   autoload :CompactLSRenderer, "#{dir}/ls_renderer.rb"
   autoload :HBarsRenderer, "#{dir}/hbars_renderer.rb"
   autoload :LSRenderer, "#{dir}/ls_renderer.rb"
   autoload :ShellRenderer, "#{dir}/shell_renderer.rb"
   autoload :VBarsRenderer, "#{dir}/vbars_renderer.rb"
-
   private_constant(
-    :Framed,
-    :Utils,
-    # -
-    :Choice,
-    :DumbChoice,
-    :Options,
-    :DumbOptions,
-    :Progress,
-    :DumbProgress,
-    # -
     :CompactLSRenderer,
     :HBarsRenderer,
     :LSRenderer,

data/lib/natty-ui/framed.rb

@@ -6,10 +6,10 @@ module NattyUI
   # {Element} with a frame around the content used by {Features.framed}.
   #
   class Framed < Element
-    # @!visibility private
+    # @private
     def closed? = @bottom ? false : true
 
-    # @!visibility private
+    # @private
     def puts(*objects, **options)
       return self if closed?
       options[:align] = @align
@@ -17,14 +17,14 @@ module NattyUI
       super
     end
 
-    # @!visibility private
+    # @private
     def done
       return if closed?
       @parent.puts(@bottom)
       @bottom = nil
     end
 
-    # @!visibility private
+    # @private
     def inspect = "#{_to_s.chop} align=#{@align.inspect} closed?=#{closed?}>"
 
     private

data/lib/natty-ui/ls_renderer.rb

@@ -47,6 +47,7 @@ module NattyUI
 
       class Item
         attr_reader :width
+
         def to_s(in_width) = "#{@str}#{' ' * (in_width - @width)}"
 
         def initialize(str)
@@ -54,6 +55,7 @@ module NattyUI
           @width = Text.width(str)
         end
       end
+
       private_constant :Item
     end
   end

data/lib/natty-ui/options.rb

@@ -9,7 +9,7 @@ module NattyUI
       pin_line = NattyUI.lines_written
       draw
       last = @current
-      while (event = Terminal.read_key_event)
+      Terminal.on_key_event do |event|
         case event.name
         when 'Esc', 'Ctrl+c'
           return if @abortable
@@ -34,7 +34,7 @@ module NattyUI
           keys = @opts.keys
           @current = keys[keys.index(@current) + 1] || keys[0]
         end
-        next if last == @current
+        next true if last == @current
         pin_line = NattyUI.back_to_line(pin_line, erase: false)
         draw
         last = @current
@@ -73,5 +73,6 @@ module NattyUI
       end
     end
   end
+
   private_constant :Options
 end

data/lib/natty-ui/progress.rb

@@ -44,6 +44,11 @@ module NattyUI
       redraw
     end
 
+    # Increment {value} and/or change {title}.
+    #
+    # @param count [Integer] increment
+    # @param title [#to_s] new title
+    # @return [ProgressHelper] itself
     def step(count: 1, title: nil)
       @title = title if title
       self.value += count
@@ -53,7 +58,7 @@ module NattyUI
     alias _to_s to_s
     private :_to_s
 
-    # @!visibility private
+    # @private
     def to_s
       return "#{title}: #{format('%5.2f', @value)}" unless @max
       "#{@title}: #{
@@ -66,7 +71,7 @@ module NattyUI
       }"
     end
 
-    # @!visibility private
+    # @private
     def inspect = "#{_to_s.chop} #{self}>"
   end
 
@@ -77,7 +82,6 @@ module NattyUI
 
     def _done(text)
       NattyUI.back_to_line(@pin_line)
-      @pin_line = nil
       cm = Theme.current.mark(:checkmark)
       @parent.puts(
         *text,
@@ -89,7 +93,6 @@ module NattyUI
 
     def _failed
       NattyUI.back_to_line(NattyUI.lines_written - 1) if @last&.size == 2
-      @pin_line = nil
     end
 
     def initialize(parent, title, max, pin)
@@ -101,8 +104,8 @@ module NattyUI
       @style = Theme.current.task_style
       cm = Theme.current.mark(:current)
       @redraw_opts = {
-        first_line_prefix: "#{cm} #{@style}",
-        first_line_prefix_width: cm.width + 1
+        first_line_prefix: "#{cm}#{@style}",
+        first_line_prefix_width: cm.width
       }
       max ? self.max = max : redraw
     end
@@ -125,7 +128,6 @@ module NattyUI
       size = [@parent.columns, 72].min - 11
       percent = format('%5.2f', 100.0 * diff)
       return percent if size < 10
-      return if percent == '100.00'
       fill = '█' * (size * diff)
       "#{percent}% [bright_black]┃#{@style}#{fill}[bright_black]#{
         '░' * (size - fill.size)

data/lib/natty-ui/section.rb

@@ -15,7 +15,7 @@ module NattyUI
   class Section < Element
     include WithStatus
 
-    # @!visibility private
+    # @private
     def puts(*objects, **options) = @state ? self : super
 
     private

data/lib/natty-ui/shell_renderer.rb

@@ -1,13 +1,12 @@
 # frozen_string_literal: true
 
 require_relative 'theme'
-require_relative 'shell_command'
 
 module NattyUI
   module ShellRenderer
-    def self.sh(parent, cmd, shell, input, space)
-      opts_out, opts_err = opts_fom(Theme.current)
-      ShellCommand.call(*cmd, shell: shell, input: input) do |line, kind|
+    def self.sh(parent, cmd, options, space)
+      opts_out, opts_err = opts_from(Theme.current)
+      Terminal.sh(*cmd, **options) do |line, kind|
         parent.puts(
           space ? line.gsub("\t", '    ').gsub(/[[:space:]]/, ' ') : line,
           **(kind == :error ? opts_err : opts_out)
@@ -16,7 +15,7 @@ module NattyUI
     end
 
     if Terminal.ansi?
-      def self.opts_fom(theme)
+      def self.opts_from(theme)
         out = theme.mark(:sh_out)
         err = theme.mark(:sh_err)
         [
@@ -33,14 +32,14 @@ module NattyUI
         ]
       end
 
-      def self.run(parent, cmd, shell, input, space, tail)
+      def self.run(parent, cmd, options, space, tail)
         theme = Theme.current
         opref = "#{theme.mark(:sh_out)}#{theme.sh_out_style}"
         epref = "#{theme.mark(:sh_err)}#{theme.sh_err_style}"
         out, err, show = [], [], []
         start = NattyUI.lines_written
         [
-          ShellCommand.call(*cmd, shell: shell, input: input) do |line, kind|
+          Terminal.sh(*cmd, **options) do |line, kind|
             start = NattyUI.back_to_line(start)
             ol = space ? line.gsub("\t", '    ').gsub(/[[:space:]]/, ' ') : line
             if kind == :error
@@ -57,7 +56,7 @@ module NattyUI
         ]
       end
     else
-      def self.opts_fom(theme)
+      def self.opts_from(theme)
         out = theme.mark(:sh_out)
         err = theme.mark(:sh_err)
         [
@@ -66,12 +65,12 @@ module NattyUI
         ]
       end
 
-      def self.run(parent, cmd, shell, input, _tail)
+      def self.run(parent, cmd, options, _space, _tail)
         theme = Theme.current
         opref, epref = theme.mark(:sh_out), theme.mark(:sh_err)
         out, err = [], []
         [
-          ShellCommand.call(*cmd, shell: shell, input: input) do |line, kind|
+          Terminal.sh(*cmd, **options) do |line, kind|
             ol = line.gsub("\t", '    ').gsub(/[[:space:]]/, ' ')
             if kind == :error
               err << line

data/lib/natty-ui/table_renderer.rb

@@ -157,7 +157,9 @@ module NattyUI
         ["#{@style}#{' ' * @padding[3]}", "#{' ' * @padding[1]}[/]"]
       end
     end
+
     private_constant :Cell
   end
+
   private_constant :TableRenderer
 end

data/lib/natty-ui/temporary.rb

@@ -3,11 +3,10 @@
 require_relative 'element'
 
 module NattyUI
-  # Temprary display section used by
-  # {Features.temporary}.
+  # Temporary display section used by {Features.temporary}.
   #
   class Temporary < Element
-    # @!visibility private
+    # @private
     def puts(*objects, **opts)
       return self if @state
       if opts.delete(:pin)
@@ -16,7 +15,7 @@ module NattyUI
       super
     end
 
-    # @!visibility private
+    # @private
     def done
       return self if @state
       NattyUI.back_to_line(@start_line) if @start_line

data/lib/natty-ui/theme.rb

@@ -163,6 +163,8 @@ module NattyUI
           current: '➔',
           choice: '◦',
           current_choice: '◉',
+          option: '[ ]',
+          option_selected: '[X]',
           sh_out: ':',
           sh_err: '𝙓'
         }
@@ -243,8 +245,8 @@ module NattyUI
       # [current?][selected?]
       c = @mark[:current_choice]
       n = @mark[:none]
-      sel = @mark[:checkmark]
-      uns = @mark[:choice]
+      uns = @mark[:option]
+      sel = @mark[:option_selected]
       {
         false => { false => n + uns, true => n + sel }.compare_by_identity,
         true => { false => c + uns, true => c + sel }.compare_by_identity
@@ -323,6 +325,7 @@ module NattyUI
           ]
         end
       end
+
     private_constant :SectionBorder
 
     @ll = {}
@@ -347,6 +350,8 @@ module NattyUI
         current: '[bright_green]➔[/fg]',
         choice: '[bright_white]◦[/fg]',
         current_choice: '[bright_green]➔[/fg]',
+        option: '[dim][ ][/dim]',
+        option_selected: '[dim][[/dim][green]X[/fg][dim]][/dim]',
         sh_out: '[bright_white]:[/fg]',
         sh_err: '[red]𝙓[/fg]'
       )
@@ -378,6 +383,8 @@ module NattyUI
         current: '➡️',
         choice: '[bright_white]•[/fg]',
         current_choice: '[bright_green]●[/fg]',
+        option: '[dim][ ][/dim] ',
+        option_selected: '[dim][[/dim][green]X[/fg][dim]][/dim]',
         sh_out: '[white b]:[/]',
         sh_err: '❗️'
       )

data/lib/natty-ui/version.rb

@@ -2,5 +2,5 @@
 
 module NattyUI
   # The version number of the gem.
-  VERSION = '0.32.0'
+  VERSION = '0.34.0'
 end

data/lib/natty-ui/width_finder.rb

@@ -129,7 +129,9 @@ module NattyUI
         def fix? = min_val == max_val
         def min_dist = value - min_val
       end
+
     private_constant :Column
   end
+
   private_constant :WidthFinder
 end

data/lib/natty-ui.rb

@@ -33,7 +33,7 @@ module NattyUI
     # @return [:dumb]
     #   when terminal does not support ANSI or interactive input
     # @return [nil]
-    #   when terminal inoput is not supported
+    #   when terminal input is not supported
     def input_mode
       case Terminal.input_mode
       when :csi_u, :legacy
@@ -50,29 +50,29 @@ module NattyUI
     #   configured title
     # @return [nil]
     #   when no title was set
-    def title = @title_stack.last
+    def title = @title_stack[-1]
 
     # @attribute [w] title
     def title=(value)
       if value
         title = Ansi.plain(value).gsub(/\s+/, ' ')
-        _write(Ansi.title(title)) if Terminal.ansi?
+        Terminal.raw_write(Ansi.title(title)) if Terminal.ansi?
         @title_stack << title
       else
         @title_stack.pop
         last = @title_stack[-1]
-        _write(Ansi.title(last)) if last && Terminal.ansi?
+        Terminal.raw_write(Ansi.title(last)) if last && Terminal.ansi?
       end
     end
 
-    # @!visibility private
+    # @private
     attr_reader :lines_written
 
-    # @!visibility private
+    # @private
     def back_to_line(number, erase: true)
       return @lines_written if (c = @lines_written - number) <= 0
       if Terminal.ansi?
-        _write(
+        Terminal.raw_write(
           if erase == :all
             Ansi.cursor_prev_line(c) + Ansi::SCREEN_ERASE_BELOW
           elsif erase
@@ -85,21 +85,8 @@ module NattyUI
       @lines_written = number
     end
 
-    # @!visibility private
-    def alternate_screen
-      return yield unless Terminal.ansi?
-      begin
-        _write(Ansi::SCREEN_ALTERNATE)
-        yield
-      ensure
-        _write(Ansi::SCREEN_ALTERNATE_OFF)
-      end
-    end
-
     private
 
-    def _write(str) = Terminal.__send__(:_write, str)
-
     def with(element)
       Terminal.hide_cursor if @element == self
       current, @element = @element, element
@@ -113,12 +100,14 @@ module NattyUI
   @element = self
   @lines_written = 0
   @title_stack = []
+
+  autoload :VERSION, "#{__dir__}/natty-ui/version.rb"
 end
 
 unless defined?(Kernel.ui)
   module Kernel
     # @attribute [r] ui
-    # @return [NattyUI::Features] current used ui element
+    # @return [NattyUI::Features] current used UI element
     # @see NattyUI.element
     def ui = NattyUI.element