backticks 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 4c09ea76ce613d4920ab0f2f0102fa56eb0ddc86
-  data.tar.gz: 013d631b062d46df861787bf64107cf802fe4580
+  metadata.gz: b5b80eef1129c850eb5fc8ffb3dc816dcd7853d2
+  data.tar.gz: e49b51b178cf49bdcb0c73dc0e77f44a0a1951cc
 SHA512:
-  metadata.gz: 4d05727a43ef3634d734eef36990cf8915072da01ccca1e57993a58b83fc5af2d638366e3d3c9fbe123d7aa99b0e03a9239a79cc178589cb1b0c6d411fab7421
-  data.tar.gz: 60dba8be758e0ca850c573882ce14ed3da1200f9a6cb62020b2a9b92e2590b7acb396fd6b2914572b5337d7c9b92c559aa2f429158e203beff3c682ff6e80abf
+  metadata.gz: 3e267a2020567274d2335bc848421de16736cd9aa370d103b5c561474f9a85a8851909cda40f114b298d59ad583336f66e3caf017e29c63f7711f53b56a82a14
+  data.tar.gz: 728b478ae95cc2676fbf64c22809f4815e11a3b0b50031c7fb002eda006893309f56cb8201e4079e2046c806580f43bd43defc95723ce7834f81620a62e8e289

data/README.md

@@ -26,7 +26,16 @@ Or install it yourself as:
 ```ruby
 require 'backticks'
 
-# The easy way
+# The lazy way; provides no CLI sugar, but benefits from unbuffered output.
+# Many Unix utilities produce colorized output when stdout is a TTY; be
+# prepared to handle escape codes in the output.
+shell = Object.new ; shell.extend(Backticks::Ext)
+shell.instance_eval do
+  puts `ls -l`
+  raise 'Oh no!' unless $?.success?
+end
+
+# The easy way.
 output = Backticks.command('ls', R:true, '*.rb')
 puts "Exit status #{$?.to_i}. Output:"
 puts output

data/backticks.gemspec

@@ -4,22 +4,22 @@ $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require 'backticks/version'
 
 Gem::Specification.new do |spec|
-  spec.name          = "backticks"
+  spec.name          = 'backticks'
   spec.version       = Backticks::VERSION
-  spec.authors       = ["Tony Spataro"]
-  spec.email         = ["xeger@xeger.net"]
+  spec.authors       = ['Tony Spataro']
+  spec.email         = ['xeger@xeger.net']
 
   spec.summary       = %q{Intuitive OOP wrapper for command-line processes}
-  spec.description   = %q{Captures processes' stdout, stderr and (optionally) stdin; uses PTY to avoid buffering.}
-  spec.homepage      = "https://github.com/xeger/backticks"
-  spec.license       = "MIT"
+  spec.description   = %q{Captures stdout, stderr and (optionally) stdin; uses PTY to avoid buffering.}
+  spec.homepage      = 'https://github.com/xeger/backticks'
+  spec.license       = 'MIT'
 
   spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
-  spec.bindir        = "exe"
+  spec.bindir        = 'exe'
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
-  spec.require_paths = ["lib"]
+  spec.require_paths = ['lib']
 
-  spec.add_development_dependency "bundler", "~> 1.10"
-  spec.add_development_dependency "rake", "~> 10.0"
-  spec.add_development_dependency "rspec"
+  spec.add_development_dependency 'bundler', '~> 1.10'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec'
 end

data/lib/backticks.rb

@@ -1,7 +1,8 @@
-require "backticks/version"
-require "backticks/cli"
-require "backticks/command"
-require "backticks/runner"
+require_relative 'backticks/version'
+require_relative 'backticks/cli'
+require_relative 'backticks/command'
+require_relative 'backticks/runner'
+require_relative 'backticks/ext'
 
 module Backticks
   # Run a command.

data/lib/backticks/command.rb

@@ -31,6 +31,8 @@ module Backticks
       @stderr = stderr
       @interactive = interactive
 
+      stdin.close unless @interactive
+
       @captured_input  = String.new.force_encoding(Encoding::BINARY)
       @captured_output = String.new.force_encoding(Encoding::BINARY)
       @captured_error  = String.new.force_encoding(Encoding::BINARY)

data/lib/backticks/ext.rb

@@ -0,0 +1,7 @@
+module Backticks
+  module Ext
+    def `(str)
+      Backticks.command(str)
+    end
+  end
+end

data/lib/backticks/runner.rb

@@ -28,8 +28,11 @@ module Backticks
     # @return [Boolean]
     attr_accessor :buffered
 
+    # @return [#parameters] the CLI-translation object used by this runner
+    attr_reader :cli
+
     # Create an instance of Runner.
-    # @param [#parameters] cli object ysed to convert Ruby method parameters into command-line parameters
+    # @param [#parameters] cli object used to convert Ruby method parameters into command-line parameters
     def initialize(cli:Backticks::CLI::Getopt)
       @interactive = false
       @buffered = false
@@ -39,19 +42,22 @@ module Backticks
     # Run a command whose parameters are expressed using some Rubyish sugar.
     # This method accepts an arbitrary number of positional parameters; each
     # parameter can be a Hash, an array, or a simple Object. Arrays and simple
-    # objects are appended to argv as "bare" words; Hashes are translated to
-    # command-line options and then appended to argv.
+    # objects are appended to argv as words of the command; Hashes are
+    # translated to command-line options and then appended to argv.
+    #
+    # Hashes are processed by @cli, defaulting to Backticks::CLI::Getopt and
+    # easily overridden by passing the `cli` option to #initialize.
     #
-    # The
+    # @see Backticks::CLI::Getopt for option-Hash format information
+    #
+    # @param [Array] args list of command words and options
     #
     # @return [Command] the running command
     #
     # @example Run docker-compose with complex parameters
     #   command('docker-compose', {file: 'joe.yml'}, 'up', {d:true}, 'mysvc')
-    #
-    # @see #options for information on Hash-to-flag translation
-    def command(*cmd)
-      argv = @cli.parameters(*cmd)
+    def command(*args)
+      argv = @cli.parameters(*args)
 
       if self.buffered
         run_buffered(argv)

data/lib/backticks/version.rb

@@ -1,3 +1,3 @@
 module Backticks
-  VERSION = "0.1.0"
+  VERSION = "0.1.1"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: backticks
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Tony Spataro
@@ -52,8 +52,7 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-description: Captures processes' stdout, stderr and (optionally) stdin; uses PTY to
-  avoid buffering.
+description: Captures stdout, stderr and (optionally) stdin; uses PTY to avoid buffering.
 email:
 - xeger@xeger.net
 executables: []
@@ -73,6 +72,7 @@ files:
 - lib/backticks.rb
 - lib/backticks/cli.rb
 - lib/backticks/command.rb
+- lib/backticks/ext.rb
 - lib/backticks/runner.rb
 - lib/backticks/version.rb
 homepage: https://github.com/xeger/backticks