tty-command 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 6c367c70f87e798b8c57dd55bd3b3d1c7b57af06
-  data.tar.gz: f68e94e54364a591eb73b639cd3c7aca74135372
+  metadata.gz: a35d801abdb3db9b76f2b73c9b602c40b67dce15
+  data.tar.gz: b9ba7fd35be52eca694285ef8bcf0c79b9eac01c
 SHA512:
-  metadata.gz: 7087e65b1f788c61fcfebd95f243595494d9ce75a7d3f8dc2a6782038bad9d412bf80df335017ecddbfa8248da1ea22250b0cc7e714390a54d1518c9e19d1490
-  data.tar.gz: b50d50c712cdd7b117bb138e88e29035b20b9ddd6d668b01ee39f6fc34443aaf2c0dab5e331ed6f33dcba4ff727866139d911206f9af09b5fbe74c911266121d
+  metadata.gz: c49e3e656210ef586253549099048e723fcd7cc337c1f0a762e541a01e9bcfb90515ce3178cfe5a7d74e4860783ba0fb3ac52b71911141f3801ad72ef8babd0e
+  data.tar.gz: 8c574b87afd46f3dc22839ebacf2e7593c4d7ace915cf6954ecbaa2178c7629d5af99384eaa53af004c08405d0f3787aa2545b4b984f527983c982b3e454efa4

data/.travis.yml

@@ -4,20 +4,21 @@ sudo: false
 cache: bundler
 script: "bundle exec rake ci"
 rvm:
-  - 1.9.3
-  - 2.0
-  - 2.1
-  - 2.2
-  - 2.3.0
+  - 2.0.0
+  - 2.1.10
+  - 2.2.6
+  - 2.3.3
+  - 2.4.0
   - ruby-head
-  - jruby
-  - jruby-9000
-  - rbx-2
+  - jruby-9.1.1.0
+  - jruby-head
+env:
+  global:
+    - JRUBY_OPTS=''
 matrix:
   allow_failures:
     - rvm: ruby-head
-    - rvm: jruby
-    - rvm: jruby-9000
+    - rvm: jruby-head
   fast_finish: true
 branches:
   only: master

data/CHANGELOG.md

@@ -1,5 +1,16 @@
 # Change log
 
+## [v0.3.0] - 2017-01-13
+
+### Added
+* Add ability to enumerate Result output
+* Add #record_saparator for specifying delimiter for enumeration
+
+### Changed
+* Change Abstract printer to separate arguments out
+* Change Cmd to prevent modifications
+* Change pastel dependency version
+
 ## [v0.2.0] - 2016-07-03
 
 ### Added
@@ -12,4 +23,6 @@
 
 * Initial implementation and release
 
+[v0.3.0]: https://github.com/piotrmurach/tty-command/compare/v0.2.0...v0.3.0
+[v0.2.0]: https://github.com/piotrmurach/tty-command/compare/v0.1.0...v0.2.0
 [v0.1.0]: https://github.com/piotrmurach/tty-command/compare/v0.1.0

data/Gemfile

@@ -3,6 +3,6 @@ source 'https://rubygems.org'
 gemspec
 
 group :test do
-  gem 'simplecov', '~> 0.10.0'
-  gem 'coveralls', '~> 0.8.2'
+  gem 'simplecov', '~> 0.12.0'
+  gem 'coveralls', '~> 0.8.17'
 end

data/README.md

@@ -55,14 +55,16 @@ Or install it yourself as:
   * [3.2. Options](#32-options)
     * [3.2.1. Current directory](#321-current-directory)
     * [3.2.2. Redirection](#322-redirection)
-    * [3.2.3. Timeout](#323-timeout)
-    * [3.2.4. User](#324-user)
-    * [3.2.5. Group](#325-group)
-    * [3.2.6. Umask](#326-umask)
+    * [3.2.3. Handling input](#323-handling-input)    
+    * [3.2.4. Timeout](#324-timeout)    
+    * [3.2.5. User](#324-user)
+    * [3.2.6. Group](#325-group)
+    * [3.2.7. Umask](#326-umask)
   * [3.3. Result](#33-result)
     * [3.3.1. success?](#331-success)
     * [3.3.2. failure?](#332-failure)
     * [3.3.3. exited?](#333-exited)
+    * [3.3.4. each](#334-each)
   * [3.4. Custom printer](#34-custom-printer)
 * [4. Example](#4-example)
 
@@ -239,9 +241,15 @@ cmd.run(:echo, 'hello', chdir: '/var/tmp')
 
 #### 3.2.2 Redirection
 
-The streams can be redirected using hash keys `:in`, `:out`, `:err`, a fixnum, an IO and array. The keys specify a given file descriptor for the child process.
+There are few ways you can redirect commands output.
 
-You can specify a filename for redirection as a hash value:
+You can directly use shell redirection facility like so:
+
+```ruby
+cmd.run("ls 1&>2")
+```
+
+You can provide the streams as additional hash options where the key is one of `:in`, `:out`, `:err`, a fixnum(a file descriptor for the child process), an IO or array. The pair value can be a filename for redirection.
 
 ```ruby
 cmd.run(:ls, :in => "/dev/null")   # read mode
@@ -264,7 +272,22 @@ cmd.run(:ls, '-la', :stderr => :stdout)
 cmd.run(:ls, '-la', 2 => 1)
 ```
 
-#### 3.2.3 Timeout
+#### 3.2.3 Handling Input
+
+You can pass input via the :in option, by passing a StringIO Object. This object might have more than one line, if the executed command reads more than once from STDIN.
+
+Assume you have run a program, that first asks for your email address and then for a password:
+
+```ruby
+in_stream = StringIO.new
+in_stream.puts "username@example.com"
+in_stream.puts "password"
+in_stream.rewind
+
+TTY::Command.new.run("my_cli_program", "login", in: in_stream).out
+```
+
+#### 3.2.4 Timeout
 
 You can timeout command execuation by providing the `:timeout` option in seconds:
 
@@ -274,7 +297,7 @@ cmd.run("while test 1; sleep 1; done", timeout: 5)
 
 Please run `examples/timeout.rb` to see timeout in action.
 
-#### 3.2.4 User
+#### 3.2.5 User
 
 To run command as a given user do:
 
@@ -282,7 +305,7 @@ To run command as a given user do:
 cmd.run(:echo, 'hello', user: 'piotr')
 ```
 
-#### 3.2.5 Group
+#### 3.2.6 Group
 
 To run command as part of group do:
 
@@ -290,7 +313,7 @@ To run command as part of group do:
 cmd.run(:echo, 'hello', group: 'devs')
 ```
 
-#### 3.2.6 Umask
+#### 3.2.7 Umask
 
 To run command with umask do:
 
@@ -343,6 +366,37 @@ result.exited?    # => true
 result.complete?  # => true
 ```
 
+#### 3.3.4 each
+
+The result itself is an enumerable and allows you to iterate over the stdout output:
+
+```ruby
+result = cmd.run(:ls, '-1')
+result.each { |line| puts line }
+# =>
+#  CHANGELOG.md
+#  CODE_OF_CONDUCT.md
+#  Gemfile
+#  Gemfile.lock
+#  ...
+#  lib
+#  pkg
+#  spec
+#  tasks
+```
+
+By default the linefeed character `\n` is used as a delimiter but this can be changed either globally by calling `record_separator`:
+
+```ruby
+TTY::Command.record_separator = "\n\r"
+```
+
+or configured per `each` call by passing delimiter as an argument:
+
+```ruby
+cmd.run(:ls, '-1').each("\t") { ... }
+```
+
 ### 3.4 Custom printer
 
 If the built-in printers do not meet your requirements you can create your own. At the very minimum you need to specify the `write` method that will be called during the lifecycle of command execution:
@@ -359,6 +413,7 @@ printer = CustomPrinter
 cmd = TTY::Command.new(printer: printer)
 ```
 
+
 ## 4. Example
 
 Here's a slightly more elaborate example to illustrate how tty-command can improve on plain old shell scripts. This example installs a new version of Ruby on an Ubuntu machine.
@@ -398,4 +453,4 @@ The gem is available as open source under the terms of the [MIT License](http://
 
 ## Copyright
 
-Copyright (c) 2016 Piotr Murach. See LICENSE for further details.
+Copyright (c) 2016-2017 Piotr Murach. See LICENSE for further details.

data/examples/redirect_stdin.rb

@@ -0,0 +1,14 @@
+# encoding: utf-8
+
+require 'tty-command'
+
+cmd = TTY::Command.new
+
+stdin = StringIO.new
+stdin.puts "hello"
+stdin.puts "world"
+stdin.rewind
+
+out, _ = cmd.run(:cat, :in => stdin)
+
+puts "#{out}"

data/lib/tty/command.rb

@@ -1,6 +1,5 @@
 # encoding: utf-8
 
-require 'thread'
 require 'rbconfig'
 require 'tty/command/version'
 require 'tty/command/cmd'
@@ -23,6 +22,14 @@ module TTY
       RbConfig::CONFIG['bindir'],
       RbConfig::CONFIG['ruby_install_name'] + RbConfig::CONFIG['EXEEXT'])
 
+    def self.record_separator
+      @record_separator ||= $/
+    end
+
+    def self.record_separator=(sep)
+      @record_separator = sep
+    end
+
     attr_reader :printer
 
     # Initialize a Command object
@@ -50,6 +57,11 @@ module TTY
     # @example
     #   cmd.run(command, [argv1, ..., argvN], [options])
     #
+    # @example
+    #   cmd.run(command, ...) do |result|
+    #     ...
+    #   end
+    #
     # @param [String] command
     #   the command to run
     #
@@ -124,10 +136,6 @@ module TTY
       @dry_run
     end
 
-    def printer
-      use_printer(@printer_name, color: @color, uuid: @uuid)
-    end
-
     private
 
     # @api private

data/lib/tty/command/cmd.rb

@@ -17,6 +17,10 @@ module TTY
       # @api public
       attr_reader :options
 
+      # Unique identifier
+      # @api public
+      attr_reader :uuid
+
       # Initialize a new Cmd object
       #
       # @api private
@@ -46,13 +50,9 @@ module TTY
         end
         @env ||= {}
         @options = opts
-      end
 
-      # Unique identifier
-      #
-      # @api public
-      def uuid
-        @uuid ||= SecureRandom.uuid.split('-')[0]
+        @uuid = SecureRandom.uuid.split('-')[0]
+        freeze
       end
 
       # The shell environment variables

data/lib/tty/command/printers/abstract.rb

@@ -21,8 +21,8 @@ module TTY
         def initialize(output, options = {})
           @output  = output
           @options = options
-          enabled  = options.fetch(:color) { true }
-          @color   = ::Pastel.new(output: output, enabled: enabled)
+          @enabled  = options.fetch(:color) { true }
+          @color   = ::Pastel.new(output: output, enabled: @enabled)
         end
 
         def print_command_start(cmd, *args)
@@ -30,15 +30,15 @@ module TTY
         end
 
         def print_command_out_data(cmd, *args)
-          write(args.join)
+          write(args.join(' '))
         end
 
         def print_command_err_data(cmd, *args)
-          write(args.join)
+          write(args.join(' '))
         end
 
         def print_command_exit(cmd, *args)
-          write(args.join)
+          write(args.join(' '))
         end
 
         def write(message)

data/lib/tty/command/process_runner.rb

@@ -1,5 +1,6 @@
 # encoding: utf-8
 
+require 'thread'
 require 'tty/command/execute'
 require 'tty/command/result'
 require 'tty/command/truncator'

data/lib/tty/command/result.rb

@@ -6,23 +6,37 @@ module TTY
     #
     # @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
+
       def initialize(status, out, err)
         @status = status
         @out    = out
         @err    = err
       end
 
-      # All data written out to process's stdout stream
-      def out
-        @out
-      end
-      alias_method :stdout, :out
-
-      # All data written out to process's stdin stream
-      def err
-        @err
+      # 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
-      alias_method :stderr, :err
 
       # Information on how the process exited
       #
@@ -30,8 +44,8 @@ module TTY
       def exit_status
         @status
       end
-      alias_method :exitstatus, :exit_status
-      alias_method :status, :exit_status
+      alias exitstatus exit_status
+      alias status exit_status
 
       def to_i
         @status
@@ -48,20 +62,16 @@ module TTY
       def exited?
         @status != nil
       end
-      alias_method :complete?, :exited?
+      alias complete? exited?
 
       def success?
-        if exited?
-          @status == 0
-        else
-          false
-        end
+        exited? ?  @status.zero? : false
       end
 
       def failure?
         !success?
       end
-      alias_method :failed?, :failure?
+      alias failed? failure?
 
       def ==(other)
         return false unless other.is_a?(TTY::Command::Result)

data/lib/tty/command/truncator.rb

@@ -47,7 +47,7 @@ module TTY
           content = copy(content, @suffix)
         end
       end
-      alias_method :<<, :write
+      alias << write
 
       # Truncated representation of the content
       #
@@ -67,7 +67,7 @@ module TTY
         res << @suffix
         res
       end
-      alias_method :to_s, :read
+      alias to_s read
 
       private
 

data/lib/tty/command/version.rb

@@ -2,6 +2,6 @@
 
 module TTY
   class Command
-    VERSION = '0.2.0'
+    VERSION = '0.3.0'
   end # Command
 end # TTY

data/tty-command.gemspec

@@ -19,7 +19,7 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]
 
-  spec.add_dependency 'pastel', '~> 0.6.0'
+  spec.add_dependency 'pastel', '~> 0.7.0'
 
   spec.add_development_dependency 'bundler', '>= 1.5.0', '< 2.0'
   spec.add_development_dependency 'rake', '~> 10.0'

metadata

@@ -1,75 +1,75 @@
 --- !ruby/object:Gem::Specification
 name: tty-command
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors:
 - Piotr Murach
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-07-03 00:00:00.000000000 Z
+date: 2017-01-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: pastel
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.6.0
+        version: 0.7.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.6.0
+        version: 0.7.0
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: 1.5.0
-    - - <
+    - - "<"
       - !ruby/object:Gem::Version
         version: '2.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: 1.5.0
-    - - <
+    - - "<"
       - !ruby/object:Gem::Version
         version: '2.0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '10.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '10.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,
@@ -81,9 +81,9 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- .gitignore
-- .rspec
-- .travis.yml
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
 - CHANGELOG.md
 - CODE_OF_CONDUCT.md
 - Gemfile
@@ -97,6 +97,7 @@ files:
 - examples/env.rb
 - examples/logger.rb
 - examples/redirect_stderr.rb
+- examples/redirect_stdin.rb
 - examples/redirect_stdout.rb
 - examples/timeout.rb
 - lib/tty-command.rb
@@ -128,17 +129,17 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.0.3
+rubygems_version: 2.5.1
 signing_key: 
 specification_version: 4
 summary: Execute shell commands with pretty output logging and capture their stdout,