natty-ui 0.31.0 → 0.32.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5b2d8212f4b987cd05c8ce904cdde26e0a0228c9fe360a36dfad04b0e29bd7b6
-  data.tar.gz: 8a3cd4de41e7ae69e18b6bf4e5437166f0c45fccf329009ebd0ecefd90a72f70
+  metadata.gz: 92532c7a8557373cb4e26efb2a0bae197e1da2daddac5853ef40800c7cfbf344
+  data.tar.gz: 3da178c8e00a752802e8cf1fc4822ce6d187516fc7af5af31e03b85b123fd348
 SHA512:
-  metadata.gz: fe766477cf1ee36fad283300a659ed4bbc5e55a56e4d7b25383359f9e6616bac1179729ddda15a2c95e58a011dd185c3b419595554197a7fae6edf57f1a02b2c
-  data.tar.gz: 40c4b083965158a22a39f171e897f40d0e2e6ee2d5ff4a601ec0015dfce9a523882e45a68f2b3208aa623effaef7d563287252eca388fb033325fb404064fb3d
+  metadata.gz: 0e41a869ea4dfde35449314f95662e2fcb837f50a76ab49cdd9e0f7cc462c5c12481e83e2eec66029468b2ef91d9f05e56f3702e0d488329c0fb3e1ee61f4431
+  data.tar.gz: da9d3545c79c99d6d09cc924a2d0dcbff6e697c264228a8ec657103c2fda7fc77583e7a5fb60db04f3a3189fd7161059e9841d155038f83cd9de88f88ee6cf65

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/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,74 @@ module NattyUI
       block ? __with(progress, &block) : progress
     end
 
-    # Run a shell program
+    # 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'"
     #
-    # @return [Process::Status] when command was executed
+    # @example Execute a command with environment variables
+    #   ui.sh({'ENV' => 'test'}, 'rails')
+    #
+    # @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
+    # @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)
+    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 (see sh)
+    # @param shell (see sh)
+    # @param input (see sh)
+    # @param preserve_spaces (see sh)
+    # @param max_lines [Integer] limit of displayed lines
+    # @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 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)
+    def run(
+      *cmd,
+      shell: false,
+      input: nil,
+      preserve_spaces: false,
+      max_lines: 10
+    )
+      result =
+        ShellRenderer.run(
+          self,
+          cmd,
+          shell,
+          input,
+          preserve_spaces,
+          max_lines.clamp(1, Terminal.rows)
         )
-      end
+      result if result[0]
     end
 
     #
@@ -755,7 +800,7 @@ module NattyUI
     #     key code/s a user can input to return negative resault
     #
     #   @return [true, false]
-    #     wheter the user inputs a positive result
+    #     whether the user inputs a positive result
     #
     # @overload await(yes: 'Enter', no: 'Esc', &block)
     #   @param yes [String, Enumerable<String>]
@@ -767,7 +812,7 @@ module NattyUI
     #     temporary displayed section (section will be erased after input)
     #
     #   @return [true, false]
-    #     wheter the user inputs a positive result
+    #     whether the user inputs a positive result
     #   @return nil
     #     in error case
     #
@@ -836,7 +881,7 @@ 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
     #     one or more alternatives to select from
@@ -986,7 +1031,6 @@ module NattyUI
   dir = __dir__
   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"
@@ -1003,11 +1047,11 @@ module NattyUI
   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,
-    :ShellCommand,
     :Utils,
     # -
     :Choice,
@@ -1020,6 +1064,7 @@ module NattyUI
     :CompactLSRenderer,
     :HBarsRenderer,
     :LSRenderer,
+    :ShellRenderer,
     :VBarsRenderer
   )
 end

data/lib/natty-ui/shell_command.rb

@@ -5,7 +5,7 @@ module NattyUI
         options = options.except(:in, :out, :err)
         env = (cmd[0].is_a?(Hash) ? cmd.shift.dup : {}).freeze
         if shell
-          cmd = cmd.map! { _escape(it) }.join(' ')
+          cmd = cmd.map! { _escape(_1) }.join(' ')
         elsif cmd.size == 1 && cmd[0].include?(' ')
           cmd = cmd[0]
         end
@@ -119,7 +119,7 @@ module NattyUI
             if enum.respond_to?(:enum_for)
               enum.enum_for(:each)
             else
-              Enumerator.new { |y| enum.each { y << it } }
+              Enumerator.new { |y| enum.each { y << _1 } }
             end
         end
       end

data/lib/natty-ui/shell_renderer.rb

@@ -0,0 +1,92 @@
+# 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|
+        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, shell, input, 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|
+            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, shell, input, _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|
+            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/version.rb

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: natty-ui
 version: !ruby/object:Gem::Version
-  version: 0.31.0
+  version: 0.32.0
 platform: ruby
 authors:
 - Mike Blumtritt
@@ -70,6 +70,7 @@ files:
 - 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
@@ -103,7 +104,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.6.9
+rubygems_version: 3.7.2
 specification_version: 4
 summary: This is the beautiful, nice, nifty, fancy, neat, pretty, cool, rich, lovely,
   natty user interface you like to have for your CLI.