outstand-tty-command 0.10.0.pre

data/lib/tty/command/result.rb

@@ -0,0 +1,89 @@
+# frozen_string_literal: true
+
+module TTY
+  class Command
+    # Encapsulates the information on the command executed
+    #
+    # @api public
+    class Result
+      include Enumerable
+
+      # All data written out to process's stdout stream
+      attr_reader :out
+      alias stdout out
+
+      # All data written out to process's stdin stream
+      attr_reader :err
+      alias stderr err
+
+      # Total command execution time
+      attr_reader :runtime
+
+      # Create a result
+      #
+      # @api public
+      def initialize(status, out, err, runtime = 0.0)
+        @status = status
+        @out    = out
+        @err    = err
+        @runtime = runtime
+      end
+
+      # Enumerate over output lines
+      #
+      # @param [String] separator
+      #
+      # @api public
+      def each(separator = nil)
+        sep = separator || TTY::Command.record_separator
+        return unless @out
+        elements = @out.split(sep)
+        if block_given?
+          elements.each { |line| yield(line) }
+        else
+          elements.to_enum
+        end
+      end
+
+      # Information on how the process exited
+      #
+      # @api public
+      def exit_status
+        @status
+      end
+      alias exitstatus exit_status
+      alias status exit_status
+
+      def to_i
+        @status
+      end
+
+      def to_s
+        @status.to_s
+      end
+
+      def to_ary
+        [@out, @err]
+      end
+
+      def exited?
+        @status != nil
+      end
+      alias complete? exited?
+
+      def success?
+        exited? ?  @status.zero? : false
+      end
+
+      def failure?
+        !success?
+      end
+      alias failed? failure?
+
+      def ==(other)
+        return false unless other.is_a?(TTY::Command::Result)
+        @status == other.to_i && to_ary == other.to_ary
+      end
+    end # Result
+  end # Command
+end # TTY

data/lib/tty/command/truncator.rb

@@ -0,0 +1,106 @@
+# frozen_string_literal: true
+
+module TTY
+  class Command
+    # Retains the first N bytes and the last N bytes from written content
+    #
+    # @api private
+    class Truncator
+      # Default maximum byte size for prefix & suffix
+      DEFAULT_SIZE = 32 << 10
+
+      # Create a Truncator
+      #
+      # @param [Hash] options
+      # @option options [Number] max_size
+      #
+      # @api public
+      def initialize(options = {})
+        @max_size = options.fetch(:max_size) { DEFAULT_SIZE }
+        @prefix   = ''
+        @suffix   = ''
+        @skipped  = 0
+      end
+
+      # Write content
+      #
+      # @param [String] content
+      #   the content to write
+      #
+      # @return [nil]
+      #
+      # @api public
+      def write(content)
+        content = content.to_s.dup
+
+        content, @prefix = append(content, @prefix)
+
+        if (over = (content.bytesize - @max_size)) > 0
+          content = content.byteslice(over..-1)
+          @skipped += over
+        end
+
+        content, @suffix = append(content, @suffix)
+
+        # suffix is full but we still have content to write
+        while content.bytesize > 0
+          content = copy(content, @suffix)
+        end
+      end
+      alias << write
+
+      # Truncated representation of the content
+      #
+      # @return [String]
+      #
+      # @api public
+      def read
+        return @prefix if @suffix.empty?
+
+        if @skipped.zero?
+          return @prefix << @suffix
+        end
+
+         @prefix + "\n... omitting #{@skipped} bytes ...\n" + @suffix
+      end
+      alias to_s read
+
+      private
+
+      # Copy minimum bytes from source to destination
+      #
+      # @return [String]
+      #   the remaining content
+      #
+      # @api private
+      def copy(value, dest)
+        bytes = value.bytesize
+        n = bytes < dest.bytesize ? bytes : dest.bytesize
+
+        head, tail = dest.byteslice(0...n), dest.byteslice(n..-1)
+        dest.replace("#{tail}#{value[0...n]}")
+        @skipped += head.bytesize
+        value.byteslice(n..-1)
+      end
+
+      # Append value to destination
+      #
+      # @param [String] value
+      #
+      # @param [String] dst
+      #
+      # @api private
+      def append(value, dst)
+        remain    = @max_size - dst.bytesize
+        remaining = ''
+        if remain > 0
+          value_bytes = value.to_s.bytesize
+          offset = value_bytes < remain ? value_bytes : remain
+          remaining = value.byteslice(0...offset)
+          value = value.byteslice(offset..-1)
+        end
+        [value, dst + remaining]
+      end
+    end # Truncator
+  end # Command
+end # TTY

data/lib/tty/command/version.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module TTY
+  class Command
+    VERSION = '0.10.0.pre'
+  end # Command
+end # TTY

metadata

@@ -0,0 +1,129 @@
+--- !ruby/object:Gem::Specification
+name: outstand-tty-command
+version: !ruby/object:Gem::Version
+  version: 0.10.0.pre
+platform: ruby
+authors:
+- Piotr Murach
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2020-09-18 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: pastel
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.8'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.8'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.5.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.5.0
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: Execute shell commands with pretty output logging and capture their stdout,
+  stderr and exit status. Redirect stdin, stdout and stderr of each command to a file
+  or a string.
+email:
+- piotr@piotrmurach.com
+executables: []
+extensions: []
+extra_rdoc_files:
+- README.md
+- CHANGELOG.md
+- LICENSE.txt
+files:
+- CHANGELOG.md
+- LICENSE.txt
+- README.md
+- lib/tty-command.rb
+- lib/tty/command.rb
+- lib/tty/command/child_process.rb
+- lib/tty/command/cmd.rb
+- lib/tty/command/dry_runner.rb
+- lib/tty/command/exit_error.rb
+- lib/tty/command/printers/abstract.rb
+- lib/tty/command/printers/null.rb
+- lib/tty/command/printers/pretty.rb
+- lib/tty/command/printers/progress.rb
+- lib/tty/command/printers/quiet.rb
+- lib/tty/command/process_runner.rb
+- lib/tty/command/result.rb
+- lib/tty/command/truncator.rb
+- lib/tty/command/version.rb
+homepage: https://piotrmurach.github.io/tty
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+  bug_tracker_uri: https://github.com/piotrmurach/tty-command/issues
+  changelog_uri: https://github.com/piotrmurach/tty-command/blob/master/CHANGELOG.md
+  documentation_uri: https://www.rubydoc.info/gems/tty-command
+  homepage_uri: https://piotrmurach.github.io/tty
+  source_code_uri: https://github.com/piotrmurach/tty-command
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.0.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">"
+    - !ruby/object:Gem::Version
+      version: 1.3.1
+requirements: []
+rubygems_version: 3.1.2
+signing_key:
+specification_version: 4
+summary: Execute shell commands with pretty output logging and capture their stdout,
+  stderr and exit status.
+test_files: []