rsystem 0.0.1 → 0.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: e3e0bc843f56332982ab975f6ce6ce0363f3f500
-  data.tar.gz: f869bd3bdcadf2036e5dee35703eea49a986ea55
+  metadata.gz: 3ed9e665a05086dbdd52905d68f25f5d44465d74
+  data.tar.gz: cbc2f064e1af691ac2430cce9699167f5cf6e8e9
 SHA512:
-  metadata.gz: 4c4f3aee2a926c39bb61a180eca3715515a4c6a166c9d17d04ef2401ca31136d8f48cbc6450f9e54b41ba7103b328c83724aa128d482910a157183fa8b01fa74
-  data.tar.gz: 3fdb5b500b0b22aa657258f3a64794d67bd492c0395f218a5494af3399cdd423d9e19115474e5fcc7bf807d23997dba8ec242a7df15709ab52b4b0a1e086e8d0
+  metadata.gz: dc00c0a07b41e33aa9c204a3e2905b661c007166ecca6189995534828b757c1be8e5504221ec24a5e9f10a845c55573b32654d3cbb8b6b7189752fc323b9add3
+  data.tar.gz: 703222eda2aae3c5cbca39caf8ec3e16551e2685b7f368d6b460824ff6f373ebae28d037422b24006b7e10503345ae86acd0c8a9f4a113c4e939466dabfe5dc1

data/LICENSE

@@ -0,0 +1,22 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 Miles Jordan
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.
+

data/README.md

@@ -1,6 +1,6 @@
 # RSystem
 
-RSystem simply executes a system() call but it also echoes the command that it is about to execute to stdout.
+RSystem simply executes a system() call but it also echoes the command that it is about to execute to stdout, and will raise an exception if the command does not return successfully.
 
 ## Installation
 
@@ -20,11 +20,25 @@ Or install it yourself as:
 
 ## Usage
 
-`rsystem(<command>, echo=[true], options=[{}])`
+Right now this gem just contains one statuc method.
 
-Simply using `rsystem(<command>` will execute the command and echo it, returning the return code of the command that is ran.
+`RSystem::Runner:Run(<command>, [options={}])`
 
-The options that you can pass are the same as the ones listed for the [spawn](http://www.ruby-doc.org/core-2.2.0/Kernel.html#method-i-spawn) method in Ruby's Kernel module. 
+Simply using `RSystem::Runner:Run(<command>)` will execute the command and echo it, returning the return code of the command that is ran or raising an exception if it did not return successfully.
+
+### Options
+
+There are two options specific to the `run` method that you can use, with the defaults listed here:
+
+options{echo:true, raise_on_error: true}
+
+The other options that you can pass are the same as the ones listed for the [spawn](http://www.ruby-doc.org/core-2.2.0/Kernel.html#method-i-spawn) method in Ruby's Kernel module.
+
+## Todo
+
+- more tests
+- output logging to a file
+- stdout/stderr configuration
 
 ## Contributing
 

data/lib/rsystem.rb

@@ -2,9 +2,28 @@ require "rsystem/version"
 
 module RSystem
   class Runner
-  	def self.run(command, echo=true, options={})
-  		puts "[#{Time.now}] Executing: #{command}" if echo
-  		system command, options
-  	end
+    def self.run(command, options={})
+
+      # Only set the default options of the haven't already been set
+      options[:echo] = true unless options.has_key?(:echo)
+      options[:raise_on_error] = true unless options.has_key?(:raise_on_error)
+
+      puts "[#{Time.now}] Executing: #{command}" if options[:echo]
+
+      # Remove custom options so we can pass the entire options hash to system()
+      sys_options = options.clone
+      sys_options.delete(:echo)
+      sys_options.delete(:raise_on_error)
+
+      ret = system(command, sys_options)
+      if !ret and options[:raise_on_error]
+        raise FailedExecutionException, "[#{Time.now}] Error: The executed command returned a failure code."
+      else
+        ret
+      end
+    end
+  end
+
+  class FailedExecutionException < Exception
   end
 end

data/lib/rsystem/version.rb

@@ -1,3 +1,3 @@
 module RSystem
-  VERSION = "0.0.1"
+  VERSION = "0.0.3"
 end

data/spec/rsystem_spec.rb

@@ -0,0 +1,8 @@
+
+require_relative '../lib/rsystem'
+
+describe RSystem do
+  it "executes a valid command with no options" do
+  	expect(RSystem::Runner::run 'echo "Hello, world!"').to eql true
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rsystem
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.3
 platform: ruby
 authors:
 - Miles Jordan
@@ -75,12 +75,14 @@ extra_rdoc_files: []
 files:
 - .gitignore
 - Gemfile
+- LICENSE
 - LICENSE.txt
 - README.md
 - Rakefile
 - lib/rsystem.rb
 - lib/rsystem/version.rb
 - rsystem.gemspec
+- spec/rsystem_spec.rb
 homepage: ''
 licenses:
 - MIT
@@ -106,4 +108,5 @@ signing_key:
 specification_version: 4
 summary: RSystem simply executes a system() call but it also echoes the command that
   it is about to execute to stdout.
-test_files: []
+test_files:
+- spec/rsystem_spec.rb