eksek 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 38c99ca643c947821f164f389981a9958424ede39ba1aeea5ba956265291d0ff
-  data.tar.gz: bc09955bf615924204cad88a4a7b840826633184b6830207cb1193e71f132346
+  metadata.gz: 0c7830e5e5d0a88f9ecc26668684d1f14c5f8a4a0144268d52d9099fb6443db1
+  data.tar.gz: adbfab80da9e0a617fccd0f3afd7908009274e4ea88a407b0b95bdf921fad00d
 SHA512:
-  metadata.gz: a91f53242d38998a7b2ab739050379b07108697c488f9dc69120e8538c6ee1299a66cc07ea203bca54aa76341d8c817f107af365cbaa669f6c365704ca780757
-  data.tar.gz: 2918aa0f4ecea9affba5a6d531a7fa7cfd89ae2186ae30f033efda40e9480a91157afe4d20879591e7e8013a92a19adea79284dcc8cbc966737d6b6624080f7f
+  metadata.gz: cfcf19d51d3ee081739ecb55fb6d0572f07e8865953fe6cd90cc910d0bd453990344dc7df6988e2e30a1b7e799f68e70e6909ad59b1350b6a22c730233677c88
+  data.tar.gz: cc6e0f4ccb882adab62d699d7c5b7b5fe010dd6dc4d48c96828a9adf3de1f2e2eb6435261fd23ab1805f8800bc44693d3f4c7bd0f9732f269ba0c1920df81afe

data/.gemspec

@@ -1,6 +1,6 @@
 Gem::Specification.new do |s|
   s.name = 'eksek'
-  s.version = '0.1.0'
+  s.version = '0.2.0'
   s.authors = ['Johnny Lee-Othon', 'Thomas Bretzke']
   s.homepage = 'https://github.com/taccon/eksek'
   s.summary = 'A better backticks'
@@ -13,6 +13,5 @@ Gem::Specification.new do |s|
 
   s.required_ruby_version = '~> 2.3'
   s.add_development_dependency 'rspec','~> 3'
-  s.add_development_dependency 'rubocop', '~> 0'
-  s.add_development_dependency 'bundler', '~> 1.0'
+  s.add_development_dependency 'rubocop', '~> 0.49.0'
 end

data/README.md

@@ -1,6 +1,7 @@
 # eksek
 
-[![Travis](https://img.shields.io/travis/jleeothon/eksek.svg)](https://travis-ci.org/jleeothon/eksek)
+[![Travis](https://img.shields.io/travis/taccon/eksek.svg)](https://travis-ci.org/taccon/eksek)
+[![Coverage Status](https://coveralls.io/repos/github/taccon/eksek/badge.svg?branch=coveralls)](https://coveralls.io/github/taccon/eksek?branch=coveralls)
 
 `eksek` is a library to run shell commands synchronously and obtain any of the standard output, standard error, and exit code with flexibility.
 
@@ -8,17 +9,23 @@
 
 ### Basic usage
 
-Use the `eksek` to execute a command:
+Use the `eksek` method to execute a command:
 
 ```ruby
 eksek 'echo Hello'
 ```
 
-This returns an `EksekResult` object providing the following methods:
+or the `kapture` method to execute a command but "capture" the standard output and standard error in a fashion similar to `Kernel#\`` (backticks) or `%x()`.
+
+```ruby
+kapture 'echo Hello'
+```
+
+These methods return an `EksekResult` object providing the following methods:
 
 - `exit` returns the exit code.
-- `stdout` returns the standard output as a string.
-- `stderr` returns the standard error as a string.
+- `stdout` returns the standard output as a string if `kapture` was called.
+- `stderr` returns the standard error as a string if `kapture` was called.
 - `success?` returns `true` or `false` depending of the exit code (`0` for `true`).
 - `success!` throws an exception if the command exited with a non-0 code.
 
@@ -32,25 +39,6 @@ puts eksek!('echo Hello').stdout # Hello
 puts eksek('echo Hello').success!.stdout
 ```
 
-### Writing to stdin
-
-To write into the standard input a block can be used:
-
-```ruby
-r = eksek('read A; echo $A') { |stdin| stdin.write "Hello" }
-r.success!
-```
-
-If the block returns a `String` or `IO`, it will be written into the stdio.
-
-```ruby
-r = eksek('read A; echo $A') { "Hello" }
-r.success!
-
-r = eksek('read A; echo $A') { File.open('myfile.txt') }
-r.success!
-```
-
 ### Passing other options
 
 `eksek` has the same signature as `Process#spawn`. This means that:
@@ -78,7 +66,10 @@ In case you prefer an object oriented method, you can also use the `Eksekuter` c
 
 ```ruby
 # With eksek
-eksek 'echo Hello' { 'This goes to stdin.' }
+eksek 'echo Hello'
+kapture 'echo Hello'
+
 # With Eksekuter
-Eksekuter.new('echo Hello').run { 'This goes to stdin.' }
+Eksekuter.new.exec('echo Hello')
+Eksekuter.new.capture('echo Hello')
 ```

data/lib/eksek.rb

@@ -9,10 +9,18 @@ module Kernel
   private
 
   def eksek *args, **opts, &block
-    Eksekuter.new(*args, **opts).run(&block)
+    Eksekuter.new.exec(*args, **opts, &block)
   end
 
   def eksek! *args, **opts, &block
     eksek(*args, **opts, &block).success!
   end
+
+  def kapture *args, **opts, &block
+    Eksekuter.new.capture(*args, **opts, &block)
+  end
+
+  def kapture! *args, **opts, &block
+    kapture(*args, **opts, &block).success!
+  end
 end

data/lib/eksek_result.rb

@@ -5,21 +5,27 @@ require_relative 'eksek_error'
 # Describes a result object to be used for evaluating
 # return values from a command
 class EksekResult
-  # rubocop:disable Metrics/ParameterLists
-  def initialize env, cmd, exit_code, success, stdout, stderr
+  def initialize env, cmd, exit_code, out_stream, err_stream
     @env = env
     @cmd = cmd
     @exit_code = exit_code
-    @success = success
-    @stdout = stdout
-    @stderr = stderr
+    @out_stream = out_stream
+    @err_stream = err_stream
   end
   # rubocop:enable Metrics/ParameterLists
 
-  attr_reader :exit_code, :stdout, :stderr
+  attr_reader :exit_code
+
+  def stdout
+    @stdout ||= @out_stream&.read
+  end
+
+  def stderr
+    @stderr ||= @err_stream&.read
+  end
 
   def success?
-    @success
+    @exit_code.zero?
   end
 
   def success!

data/lib/eksekuter.rb

@@ -6,75 +6,66 @@ require_relative 'eksek_result'
 
 # Class that command execution is delegated to by Eksek.
 class Eksekuter
-  def initialize *args, **opts
-    @env = args[0].is_a?(Hash) ? args.shift : {}
-    @env = @env.each_with_object({}) { |(k, v), o| o[k.to_s] = v }
-    @cmd = args.size == 1 ? args.first : args
-    @opts = opts
+  # @param {Logger} logger
+  def initialize logger: nil
+    @logger = logger
+    @stdout_buffer = nil
+    @stderr_buffer = nil
+    @stdin_buffer = nil
   end
 
-  def run &block
-    spawn_process
-    write_and_close_stdin(&block)
-    wait
-    read_and_close_stdout_stderr
-    assemble_result
+  # Wraps around Kernel#spawn so that the return value is an EksekResult.
+  # @return EksekResult
+  def exec *args, **opts
+    env, cmd = split_env_and_cmd(args)
+    params = { env: env, cmd: cmd, opts: opts }
+    process_status = spawn_and_get_status(params)
+    assemble_result(params, process_status)
   end
 
-  private
-
-  attr_reader(
-    :cmd,
-    :env,
-    :err_str,
-    :opts,
-    :out_str,
-    :process_status,
-    :stdin,
-    :wait_thr,
-  )
-
-  def stdout
-    @stdout ||= StringIO.new('', 'r')
-  end
-
-  def stderr
-    @stderr ||= StringIO.new('', 'r')
+  # Like Eksekuter#exec but the :out and :err options are ignored; instead
+  # the output is attached to the EksekResult object returned.
+  # Returns an EksekResult object which getters :stdout and :stderr containing
+  # the corresponding output of the spawned process.
+  # @return EksekResult
+  def capture *args, **opts
+    env, cmd = split_env_and_cmd(args)
+    out_read, out_write = IO.pipe
+    err_read, err_write = IO.pipe
+    opts2 = opts.merge(out: out_write, err: err_write)
+    params = { env: env, cmd: cmd, opts: opts2 }
+    process_status = spawn_and_get_status(params)
+    out_write.close
+    err_write.close
+    assemble_result(params, process_status, out_read, err_read)
   end
 
-  def spawn_process
-    @stdin, @stdout, @stderr, @wait_thr = Open3.popen3(env, *cmd, opts)
-    nil
-  end
-
-  def write_and_close_stdin
-    return if stdin.closed? || !block_given?
-    block_result = yield stdin
-    block_result = StringIO.new(block_result) if block_result.is_a? String
-    IO.copy_stream(block_result, stdin) if block_result.respond_to? :read
-    stdin.close
-    nil
-  end
+  private
 
-  def wait
-    @process_status = wait_thr.value
+  def split_env_and_cmd args
+    cmd_args = args.clone
+    env = cmd_args.first.is_a?(Hash) ? cmd_args.shift : {}
+    env = env.each_with_object({}) { |(k, v), o| o[k.to_s] = v }
+    cmd = cmd_args.size == 1 ? cmd_args.first : cmd_args
+    [env, cmd]
   end
 
-  def read_and_close_stdout_stderr
-    streams = [stdout, stderr]
-    @out_str, @err_str = streams.map(&:read).map(&:chomp)
-    streams.each(&:close)
-    nil
+  def spawn_and_get_status params
+    env = params.fetch(:env)
+    cmd = params.fetch(:cmd)
+    opts = params.fetch(:opts)
+    pid = spawn(env, *cmd, opts)
+    _, process_status = Process.wait2(pid)
+    process_status
   end
 
-  def assemble_result
+  def assemble_result params, process_status, out_stream = nil, err_stream = nil
     EksekResult.new(
-      env,
-      cmd,
+      params.fetch(:env),
+      params.fetch(:cmd),
       process_status.exitstatus,
-      process_status.success?,
-      out_str,
-      err_str,
+      out_stream,
+      err_stream,
     )
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: eksek
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Johnny Lee-Othon
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-04-01 00:00:00.000000000 Z
+date: 2019-03-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
@@ -31,28 +31,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.49.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: bundler
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.0'
+        version: 0.49.0
 description: 'Execute shell commands and easily get stdout, stderr, exit code, and
   more