natty-ui 0.31.0 → 0.33.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5b2d8212f4b987cd05c8ce904cdde26e0a0228c9fe360a36dfad04b0e29bd7b6
-  data.tar.gz: 8a3cd4de41e7ae69e18b6bf4e5437166f0c45fccf329009ebd0ecefd90a72f70
+  metadata.gz: 79e64cb2489dcf9efe4066e4f95252284f9227aafa4a77edd0d50f307b255cf2
+  data.tar.gz: 7ec6f014b300740062e816fa9c787ff79b3fb7ce68e4b1c2d6967ae6eb58b53d
 SHA512:
-  metadata.gz: fe766477cf1ee36fad283300a659ed4bbc5e55a56e4d7b25383359f9e6616bac1179729ddda15a2c95e58a011dd185c3b419595554197a7fae6edf57f1a02b2c
-  data.tar.gz: 40c4b083965158a22a39f171e897f40d0e2e6ee2d5ff4a601ec0015dfce9a523882e45a68f2b3208aa623effaef7d563287252eca388fb033325fb404064fb3d
+  metadata.gz: 86abb66230c52bd8863aec983435b434e7272003a12db631cb0b46af9db938ffc16f3ba1f987dad53a10f9ff4393e5f4bf403d04b813bb68b4b189c5bf0b2860
+  data.tar.gz: 34afc008cdec26384f7f20b7be6830a5be511147cfaef831d8e6869f858219ffeaea394ec8718ceb7513cfa3aaee19a852bb70d2b2ef641bc5880ca79d8de38d

data/.yardopts

@@ -6,7 +6,6 @@
 --embed-mixins
 --tag comment
 --hide-tag comment
---exclude lib/natty-ui/ansi_wrapper.rb
 lib/**/*.rb
 -
 README.md

data/README.md

@@ -4,7 +4,7 @@ This is the beautiful, nice, nifty, fancy, neat, pretty, cool, rich, lovely, nat
 
 - Gem: [rubygems.org](https://rubygems.org/gems/natty-ui)
 - Source: [codeberg.org](https://codeberg.org/mblumtritt/natty-ui)
-- Help: [rubydoc.info](https://rubydoc.info/gems/natty-ui/NattyUI)
+- Help: [rubydoc.info](https://rubydoc.info/gems/natty-ui/index)
 
 ## Features
 
@@ -28,7 +28,7 @@ This is the beautiful, nice, nifty, fancy, neat, pretty, cool, rich, lovely, nat
 
 ## Help
 
-📕 See the [online help](https://rubydoc.info/gems/natty-ui/NattyUI) and have a look at the [examples](./examples/) directory to learn from code.
+📕 See the [online help](https://rubydoc.info/gems/natty-ui/index) and have a look at the [examples](./examples/) directory to learn from code.
 
 ### Run Examples
 

data/examples/hbars.rb

@@ -11,7 +11,7 @@ ui.message '[b]​ᓚᕠᗢ NattyUI[/b] [i green]Print Horizontal Bars[/]' do
 
   ui.space
   ui.hbars values, style: :green, normalize: true, width: 0.5, min: 10
-  ui.puts(
-    'These are the same values but [i]normalized[/i] and printed in half width.'
-  )
+  ui.puts <<~INFO, eol: false
+    These are the same values but [i]normalized[/i] and printed in half width.
+  INFO
 end

data/examples/named-colors.rb

@@ -3,13 +3,15 @@
 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.
-
+  ui.space
+  ui.puts <<~INFO, eol: false
+    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.')
+
+  ui.space
+  ui.information 'Note' do
+    ui.puts 'Not all terminal emulators support true-colors.'
   end
 
   ui.space

data/examples/sh.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+require_relative '../lib/natty-ui'
+
+ui.message '[b]​ᓚᕠᗢ NattyUI[/b] [i green]Call Shell[/]' do
+  ui.space
+  ui.message 'Pipe this file to [i]cat[/i]; limit to five lines' do
+    File.open(__FILE__) do |file|
+      ui.run 'cat', input: file, preserve_spaces: true, max_lines: 5
+    end
+  end
+
+  ui.space
+  ui.message 'Call [i]cat[/i] with invalid option' do
+    ui.sh 'cat', '-?'
+  end
+end

data/examples/tasks.rb

@@ -17,9 +17,9 @@ ui.message '[b]​ᓚᕠᗢ NattyUI[/b] [i green]Tasks[/]' do
 
   ui.space
   ui.task 'Actualize Reading List' do
-    ui.puts('This is a simple which actualizes the book reading list.')
+    ui.puts 'This is a simple which actualizes the book reading list.'
 
-    ui.task('Connect to Library') do
+    ui.task 'Connect to Library' do
       do_something
       ui.mark 'Server Found', mark: :checkmark
       ui.task('Login...') { do_something_heavy }
@@ -36,14 +36,14 @@ ui.message '[b]​ᓚᕠᗢ NattyUI[/b] [i green]Tasks[/]' do
 
     ui.task('Disconnect from Library') { do_something_heavy }
 
-    ui.progress('Read Cover Images', max: 11) do |progress|
+    ui.progress 'Read Cover Images', max: 11 do |progress|
       while progress.value < progress.max
         do_something
         progress.step
       end
     end
 
-    ui.pin('New Books Marked', mark: :checkmark)
+    ui.pin 'New Books Marked', mark: :checkmark
 
     ui.task('Optimize Database') { do_something_heavy }
 

data/examples/vbars.rb

@@ -32,8 +32,8 @@ ui.message '[b]​ᓚᕠᗢ NattyUI[/b] [i green]Print Vertical Bars[/]' do
 
   ui.space
   ui.vbars values, style: :green, normalize: true, bar_width: 2
-  ui.puts(
-    'These are the same values but [i]normalized[/i] and printed with ' \
-      'a fixed bar width.'
-  )
+  ui.puts <<~INFO, eol: false
+    These are the same values but [i]normalized[/i]
+    and printed with a fixed bar width.
+  INFO
 end

data/lib/natty-ui/attributes.rb

@@ -13,10 +13,10 @@ module NattyUI
     def merge!(**attributes) = attributes.empty? ? self : _assign(attributes)
     alias assign merge!
 
-    # @!visibility private
+    # @private
     def to_hash = _store({})
 
-    # @!visibility private
+    # @private
     def to_h(&block) = block ? _store({}).to_h(&block) : _store({})
 
     private
@@ -506,7 +506,7 @@ module NattyUI
         end
       end
 
-      # @!visibility private
+      # @private
       # @return [String, nil]
       attr_reader :border_chars
 
@@ -549,11 +549,14 @@ module NattyUI
       @attributes = @attributes.dup
     end
   end
+
   private_constant :WithAttributes
 
   module TextWithAttributes
     include WithAttributes
+
     attr_reader :text
+
     def empty? = @text.empty?
     alias _to_s to_s
     private :_to_s
@@ -585,5 +588,6 @@ module NattyUI
       @text = @text.map(&:dup)
     end
   end
+
   private_constant :TextWithAttributes
 end

data/lib/natty-ui/choice.rb

@@ -62,5 +62,6 @@ module NattyUI
       end
     end
   end
+
   private_constant :Choice
 end

data/lib/natty-ui/dumb_choice.rb

@@ -42,5 +42,6 @@ module NattyUI
       @abortable = abortable
     end
   end
+
   private_constant :DumbChoice
 end

data/lib/natty-ui/dumb_options.rb

@@ -59,5 +59,6 @@ module NattyUI
       end
     end
   end
+
   private_constant :DumbOptions
 end

data/lib/natty-ui/element.rb

@@ -8,10 +8,10 @@ module NattyUI
   class Element
     include Features
 
-    # @!visibility private
+    # @private
     def columns = @parent.columns - @prefix_width - @suffix_width
 
-    # @!visibility private
+    # @private
     def puts(*objects, **options)
       if @prefix
         options[:prefix] = "#{@prefix}#{options[:prefix]}"
@@ -32,7 +32,7 @@ module NattyUI
       self
     end
 
-    # @!visibility private
+    # @private
     alias to_s inspect
 
     alias _to_s to_s
@@ -46,13 +46,32 @@ module NattyUI
     end
   end
 
+  # Methods for elements with status like {ProgressHelper}, {Section}, {Task}.
+  #
   module WithStatus
+    # @return [Symbol, nil] element's current status
     attr_reader :status
+
+    # @attribute [r] active?
+    # @return [true, false] whether the element is still active
     def active? = @status.nil?
+
+    # @attribute [r] closed?
+    # @return [true, false] whether the element is closed
     def closed? = !active?
+
+    # @attribute [r] closed?
+    # @return [true, false] whether the element is completed
     def ok? = @state == :ok
+
+    # @attribute [r] failed?
+    # @return [true, false] whether the element is completed with failure
     def failed? = @state == :failed
 
+    # Close the element.
+    #
+    # @param [#to_s] text optional message
+    # @return [Element] itself
     def ok(*text)
       return self if @state
       text = [@title] if text.empty? && @title
@@ -62,6 +81,12 @@ module NattyUI
     end
     alias done ok
 
+    # Close the element with a failure.
+    #
+    # @param text [#to_s] optional message
+    # @yield optionally, when block is given
+    # @yieldparam failed [Section] see {Features.failed}
+    # @return [Element] itself
     def failed(*text, &block)
       return self if @state
       _failed

data/lib/natty-ui/features.rb

@@ -104,11 +104,11 @@ module NattyUI
           ansi: Terminal.ansi?,
           ignore_newline: ignore_newline
         )
-
+      tail = options[:tail] and lines = lines.to_a.last(tail)
       @__eol ||= Terminal.ansi? ? "\e[m\n" : "\n"
 
       if (align = options[:align]).nil?
-        lines.each do |line|
+        lines.each do |line, _|
           Terminal.print(prefix, line, suffix, @__eol, bbcode: false)
           @lines_written += 1
           prefix, prefix_next = prefix_next, nil if prefix_next
@@ -578,29 +578,65 @@ module NattyUI
       block ? __with(progress, &block) : progress
     end
 
-    # Run a shell program
-    #
-    # @return [Process::Status] when command was executed
-    # @return [nil] in error case (like command not found)
-    def sh(*cmd, shell: false, input: nil)
-      m = (theme = Theme.current).mark(:sh_out)
-      opts_out = {
-        bbcode: false,
-        prefix: "#{m}#{theme.sh_out_style}",
-        prefix_width: m.width
-      }
-      m = theme.mark(:sh_err)
-      opts_err = {
-        bbcode: false,
-        prefix: "#{m}#{theme.sh_err_style}",
-        prefix_width: m.width
-      }
-      ShellCommand.call(*cmd, shell: shell, input: input) do |line, kind|
-        puts(
-          line.gsub("\t", '    ').gsub(/[[:space:]]/, ' '),
-          **(kind == :error ? opts_err : opts_out)
+    # Execute a program.
+    #
+    # @example Execute a simple command
+    #   ui.sh 'ls'
+    #
+    # @example Execute a command wih arguments
+    #   ret = ui.sh('curl', '--version')
+    #   raise('Curl not found') unless ret&.success?
+    #
+    # @example Execute shell commands
+    #   ui.sh "mkdir 'test' && cd 'test'"
+    #
+    # @example Execute a command with environment variables
+    #   ui.sh({'ENV' => 'test'}, 'rails')
+    #
+    # @see run
+    #
+    # @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, preserve_spaces: false, **options)
+      ShellRenderer.sh(self, cmd, options, preserve_spaces)
+    end
+
+    # Execute a shell program and return output. Limit the lines displayed.
+    #
+    # @example Capture output and error
+    #   status, out, err = ui.run('ls ./ && ls ./this_does_not_exist')
+    #   # => #<Process::Status: pid 25562 exit 1>
+    #   # => [...] # the output of first `ls`
+    #   # => ["ls: ./this_does_not_exist: No such file or directory"]
+    #
+    # @see sh
+    #
+    # @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, preserve_spaces: false, max_lines: 10, **options)
+      result =
+        ShellRenderer.run(
+          self,
+          cmd,
+          options,
+          preserve_spaces,
+          max_lines.clamp(1, Terminal.rows)
         )
-      end
+      result if result[0]
     end
 
     #
@@ -749,28 +785,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]
-    #     wheter 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]
-    #     wheter 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|
@@ -783,9 +811,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]
@@ -800,9 +828,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]
@@ -814,11 +842,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]
@@ -836,13 +864,13 @@ module NattyUI
     #       r: 'Rio',
     #       abortable: true
     #     ) { ui.puts 'Which terminal emulator do you like?' }
-    #     # => wheter the user selected: :k, :i, :g, :t, :r
+    #     # => 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]
@@ -867,11 +895,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]
@@ -900,11 +928,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)
@@ -937,7 +965,7 @@ module NattyUI
     # @!group Utilities
     #
 
-    # @!visibility private
+    # @private
     def columns = Terminal.columns
 
     # Display some temporary content.
@@ -983,15 +1011,16 @@ module NattyUI
     end
   end
 
-  dir = __dir__
+  dir = __dir__ # call the function once
+
   autoload :Framed, "#{dir}/framed.rb"
   autoload :Section, "#{dir}/section.rb"
-  autoload :ShellCommand, "#{dir}/shell_command.rb"
   autoload :Table, "#{dir}/table.rb"
   autoload :Task, "#{dir}/task.rb"
   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"
@@ -999,27 +1028,25 @@ module NattyUI
   autoload :DumbOptions, "#{dir}/dumb_options.rb"
   autoload :Progress, "#{dir}/progress.rb"
   autoload :DumbProgress, "#{dir}/progress.rb"
-
-  autoload :CompactLSRenderer, "#{dir}/ls_renderer.rb"
-  autoload :HBarsRenderer, "#{dir}/hbars_renderer.rb"
-  autoload :LSRenderer, "#{dir}/ls_renderer.rb"
-  autoload :VBarsRenderer, "#{dir}/vbars_renderer.rb"
-
   private_constant(
-    :Framed,
-    :ShellCommand,
-    :Utils,
-    # -
     :Choice,
     :DumbChoice,
     :Options,
     :DumbOptions,
     :Progress,
-    :DumbProgress,
-    # -
+    :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(
     :CompactLSRenderer,
     :HBarsRenderer,
     :LSRenderer,
+    :ShellRenderer,
     :VBarsRenderer
   )
 end

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

@@ -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
 

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

@@ -0,0 +1,91 @@
+# frozen_string_literal: true
+
+require_relative 'theme'
+
+module NattyUI
+  module ShellRenderer
+    def self.sh(parent, cmd, options, space)
+      opts_out, opts_err = opts_fom(Theme.current)
+      Terminal.sh(*cmd, **options) do |line, kind|
+        parent.puts(
+          space ? line.gsub("\t", '    ').gsub(/[[:space:]]/, ' ') : line,
+          **(kind == :error ? opts_err : opts_out)
+        )
+      end
+    end
+
+    if Terminal.ansi?
+      def self.opts_fom(theme)
+        out = theme.mark(:sh_out)
+        err = theme.mark(:sh_err)
+        [
+          {
+            bbcode: false,
+            prefix: "#{out}#{theme.sh_out_style}",
+            prefix_width: out.width
+          },
+          {
+            bbcode: false,
+            prefix: "#{err}#{theme.sh_err_style}",
+            prefix_width: err.width
+          }
+        ]
+      end
+
+      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
+        [
+          Terminal.sh(*cmd, **options) do |line, kind|
+            start = NattyUI.back_to_line(start)
+            ol = space ? line.gsub("\t", '    ').gsub(/[[:space:]]/, ' ') : line
+            if kind == :error
+              err << line
+              show << "#{epref}#{ol}"
+            else
+              out << line
+              show << "#{opref}#{ol}"
+            end
+            parent.puts(*show, bbcode: false, tail: tail)
+          end,
+          out,
+          err
+        ]
+      end
+    else
+      def self.opts_fom(theme)
+        out = theme.mark(:sh_out)
+        err = theme.mark(:sh_err)
+        [
+          { bbcode: false, prefix: out, prefix_width: out.width },
+          { bbcode: false, prefix: err, prefix_width: err.width }
+        ]
+      end
+
+      def self.run(parent, cmd, options, _space, _tail)
+        theme = Theme.current
+        opref, epref = theme.mark(:sh_out), theme.mark(:sh_err)
+        out, err = [], []
+        [
+          Terminal.sh(*cmd, **options) do |line, kind|
+            ol = line.gsub("\t", '    ').gsub(/[[:space:]]/, ' ')
+            if kind == :error
+              err << line
+              parent.puts("#{epref}#{ol}", bbcode: false)
+            else
+              out << line
+              parent.puts("#{opref}#{ol}", bbcode: false)
+            end
+          end,
+          out,
+          err
+        ]
+      end
+    end
+  end
+
+  private_constant :ShellRenderer
+end

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

@@ -323,6 +323,7 @@ module NattyUI
           ]
         end
       end
+
     private_constant :SectionBorder
 
     @ll = {}

data/lib/natty-ui/version.rb

@@ -2,5 +2,5 @@
 
 module NattyUI
   # The version number of the gem.
-  VERSION = '0.31.0'
+  VERSION = '0.33.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
@@ -56,23 +56,23 @@ module NattyUI
     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,19 @@ module NattyUI
       @lines_written = number
     end
 
-    # @!visibility private
+    # @private
     def alternate_screen
       return yield unless Terminal.ansi?
       begin
-        _write(Ansi::SCREEN_ALTERNATE)
+        Terminal.raw_write(Ansi::SCREEN_ALTERNATE)
         yield
       ensure
-        _write(Ansi::SCREEN_ALTERNATE_OFF)
+        Terminal.raw_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
@@ -118,7 +116,7 @@ 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
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: natty-ui
 version: !ruby/object:Gem::Version
-  version: 0.31.0
+  version: 0.33.0
 platform: ruby
 authors:
 - Mike Blumtritt
@@ -15,14 +15,14 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.13.0
+        version: 0.14.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.13.0
+        version: 0.14.0
 description: |
   This is the beautiful, nice, nifty, fancy, neat, pretty, cool, rich, lovely,
   natty user interface tool you like to have for your command line applications.
@@ -52,6 +52,7 @@ files:
 - examples/named-colors.rb
 - examples/options.rb
 - examples/sections.rb
+- examples/sh.rb
 - examples/tables.rb
 - examples/tasks.rb
 - examples/themes.rb
@@ -69,7 +70,7 @@ files:
 - lib/natty-ui/options.rb
 - lib/natty-ui/progress.rb
 - lib/natty-ui/section.rb
-- lib/natty-ui/shell_command.rb
+- lib/natty-ui/shell_renderer.rb
 - lib/natty-ui/table.rb
 - lib/natty-ui/table_renderer.rb
 - lib/natty-ui/task.rb

data/lib/natty-ui/shell_command.rb

@@ -1,132 +0,0 @@
-module NattyUI
-  module ShellCommand
-    class << self
-      def call(*cmd, shell: false, input: nil, **options)
-        options = options.except(:in, :out, :err)
-        env = (cmd[0].is_a?(Hash) ? cmd.shift.dup : {}).freeze
-        if shell
-          cmd = cmd.map! { _escape(it) }.join(' ')
-        elsif cmd.size == 1 && cmd[0].include?(' ')
-          cmd = cmd[0]
-        end
-        cmd.freeze
-        input = Input.for(input)
-        ret = nil
-        with_io(options, input) do |cio, out_r, err_r, in_w|
-          thread = Process.detach(Process.spawn(env, *cmd, options))
-          begin
-            cio.each(&:close)
-            read = [out_r, err_r]
-            write = [in_w] if in_w
-            while !read.empty? || write
-              rr, wr, = IO.select(read, write)
-              if rr.include?(out_r)
-                begin
-                  yield(out_r.readline(chomp: true), :output)
-                rescue SystemCallError, IOError
-                  read.delete(out_r)
-                end
-              end
-              if rr.include?(err_r)
-                begin
-                  yield(err_r.readline(chomp: true), :error)
-                rescue SystemCallError, IOError
-                  read.delete(err_r)
-                end
-              end
-              next if wr.empty?
-              begin
-                next if input.call(in_w)
-              rescue SystemCallError, IOError
-                # nop
-              end
-              in_w.close
-              write = nil
-            end
-          ensure
-            ret = thread.join.value
-          end
-        end
-        ret
-      rescue SystemCallError, IOError
-        nil
-      end
-
-      private
-
-      def with_io(options, input)
-        IO.pipe do |out_r, out_w|
-          IO.pipe do |err_r, err_w|
-            cio = [options[:out] = out_w, options[:err] = err_w]
-            return yield(cio, out_r, err_r) unless input
-            IO.pipe do |in_r, in_w|
-              cio << (options[:in] = in_r)
-              in_w.sync = true
-              yield(cio, out_r, err_r, in_w)
-            end
-          end
-        end
-      end
-
-      def _escape(str)
-        return +"''" if str.empty?
-        str = str.dup
-        str.gsub!(%r{[^A-Za-z0-9_\-.,:+/@\n]}, "\\\\\\&")
-        str.gsub!("\n", "'\n'")
-        str
-      end
-    end
-
-    module Input
-      def self.for(obj)
-        return unless obj
-        return CopyWriter.new(obj) if obj.respond_to?(:readpartial)
-        return CopyWriter.new(obj.to_io) if obj.respond_to?(:to_io)
-        return ArrayWriter.new(obj) if obj.is_a?(Array)
-        return EnumerableWriter.new(obj) if obj.respond_to?(:each)
-        return ArrayWriter.new(obj.to_a) if obj.respond_to?(:to_a)
-        Writer.new(obj)
-      end
-
-      class Writer
-        def call(io) = (io.write(_next) if @obj)
-        def initialize(obj) = (@obj = obj)
-        def _next = (_, @obj = @obj, nil).first
-      end
-
-      class CopyWriter < Writer
-        def call(io) = (IO.copy_stream(_next, io) if @obj)
-      end
-
-      class ArrayWriter
-        def call(io) = io.write(@ry[@idx += 1] || return)
-
-        def initialize(ary)
-          @ry = ary
-          @idx = -1
-        end
-      end
-
-      class EnumerableWriter
-        def call(io)
-          io.write(@enum.next)
-        rescue StopIteration
-          false
-        end
-
-        def initialize(enum)
-          @enum =
-            if enum.respond_to?(:enum_for)
-              enum.enum_for(:each)
-            else
-              Enumerator.new { |y| enum.each { y << it } }
-            end
-        end
-      end
-    end
-
-    private_constant :Input
-  end
-
-  private_constant :ShellCommand
-end