bio-commandeer 0.1.3 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 65c0c939bb20515c6669195c285d113ac6da4638
-  data.tar.gz: f23a66f1c076dd46147451c948a68458345540af
+  metadata.gz: 386271eaa4c39b91d6a3a76891dd64b3ad8d1744
+  data.tar.gz: 56b7ee0ac4061f603d4c41491b5b81d968cd9332
 SHA512:
-  metadata.gz: 3c391e332150e3d05bb2451422c404bd04eb7310656f15910cb72a226ec29e82e510e88c6e537653f23a250df006b292dc8d96a96ab648a066664cef8a51074e
-  data.tar.gz: 818c977dd5192d42d0d69fae2e67f9dc8385b873487c98eda9649cc436544a62101075e3cbee7520480aa015146cf78fa67a8f3d6f62f4b007d8bb232bd70f13
+  metadata.gz: 17cfb131f6887eabf59776676610a6f1c9c39d2c8ba7c63e3179c2e53e4b25d85de44e371d2c1c30ff27c513469ce4a5938e9da8441e901010ce1e4a25faeea7
+  data.tar.gz: fdba58dd87e0e144a108d8e454d0d194c9ebee19bb1e1d80700421291070bffebc151ddbd78ff9c4beaff472c04c96a719598d303f613fa8156ed18955da6597

data/Gemfile

@@ -9,7 +9,7 @@ gem 'systemu', '~>2.6'
 # Include everything needed to run rake, tests, features, etc.
 group :development do
   gem "rspec", "~> 3.2"
-  gem "rdoc", "~>4.2"
+  gem "rdoc", "~> 5.0"
   gem "jeweler", "~> 2.0"
   gem "bundler", "~> 1.3"
 end

data/README.md

@@ -50,6 +50,13 @@ Or a logging can be given directly, so long as it has an `info` method:
 Bio::Commandeer.run 'echo 5', :log=>my_logger
 ```
 
+A command can also be run to completion without raising an errors using `run_to_finish`:
+```ruby
+require 'bio-commandeer'
+result = Bio::Commandeer.run_to_finish 'echo 5' #=> Bio::CommandResult
+result.stdout #=> "5\n"
+```
+
 
 ## Installation
 

data/VERSION

@@ -1 +1 @@
-0.1.3
+0.2.0

data/lib/bio-commandeer/commandeer.rb

@@ -3,7 +3,6 @@ require 'systemu'
 module Bio
   # See #run
   class Commandeer
-
     # Run a command line program, and be opinionated about how to handle failure
     #
     # command is a string of the command to be run
@@ -11,6 +10,17 @@ module Bio
     # :stdin: a string that is the stdin
     # :log: if true, turn on logging. If given an object use it as the logger
     def self.run(command, options={})
+      obj = run_to_finish(command, options)
+
+      if obj.status.exitstatus != 0
+        raise Bio::CommandFailedException, "Command returned non-zero exit status (#{obj.status.exitstatus}), likely indicating failure. Command run was #{command} and the STDERR was:\n#{obj.stderr}\nSTDOUT was: #{obj.stdout}"
+      end
+
+      return obj.stdout
+    end
+
+    # Options are as per #run, but return a CommandResult object
+    def self.run_to_finish(command, options={})
       if options[:log]
         if options[:log] == true
           log_name = 'bio-commandeer'
@@ -25,19 +35,20 @@ module Bio
 
         @log.info "Running command: #{command}"
       end
-      status, stdout, stderr = systemu command, :stdin => options[:stdin]
+      res = CommandResult.new
+      res.command = command
+      res.status, res.stdout, res.stderr = systemu command, :stdin => options[:stdin]
 
       if @log
-        @log.info "Command finished with exitstatus #{status.exitstatus}"
+        @log.info "Command finished with exitstatus #{res.status.exitstatus}"
       end
-
-      if status.exitstatus != 0
-        raise Bio::CommandFailedException, "Command returned non-zero exit status (#{status.exitstatus}), likely indicating failure. Command run was #{command} and the STDERR was:\n#{stderr}\nSTDOUT was: #{stdout}"
-      end
-
-      return stdout
+      return res
     end
   end
 
+  class CommandResult
+    attr_accessor :stdout, :stderr, :command, :status
+  end
+
   class CommandFailedException < Exception; end
 end

data/spec/bio-commandeer_spec.rb

@@ -51,4 +51,12 @@ describe "BioCommandeer" do
       expect(stdout).to eq "50\n"
     end
   end
+
+  it 'should run to finish' do
+    obj = Bio::Commandeer.run_to_finish("cat /definitelyNotAFile")
+    expect(obj.stdout).to eq ""
+    expect(obj.status.exitstatus).to eq 1
+    expect(obj.stderr).to eq "cat: /definitelyNotAFile: No such file or directory\n"
+    expect(obj.command).to eq "cat /definitelyNotAFile"
+  end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: bio-commandeer
 version: !ruby/object:Gem::Version
-  version: 0.1.3
+  version: 0.2.0
 platform: ruby
 authors:
 - Ben J. Woodcroft
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-04-18 00:00:00.000000000 Z
+date: 2017-08-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bio-logger
@@ -58,14 +58,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '4.2'
+        version: '5.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '4.2'
+        version: '5.0'
 - !ruby/object:Gem::Dependency
   name: jeweler
   requirement: !ruby/object:Gem::Requirement
@@ -135,7 +135,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.5.1
+rubygems_version: 2.6.8
 signing_key: 
 specification_version: 4
 summary: dead simple method of running shell commands from within Ruby