command_exec 0.0.1 → 0.0.2

data/LICENSE.md

@@ -0,0 +1,20 @@
+Copyright (C) 2012 Max Meyer
+
+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,82 @@
 command-exec(1) -- execute shell commands with ease
 ===================================================
 
-## DESCRIPTION
+## Description
 
+This gem brings command execution via POpen4 with all the bells and whistles.
 
+## Usage
+
+```ruby
+require 'command_exec'
+
+#long form
+command = CommandExec::Command.new( 'command' )
+command.run
+
+#short form
+command = CommandExec::Command.execute( 'command')
+
+#full path to commadn
+command = CommandExec::Command.execute( 'path/to/command')
+
+# available options
+command = CommandExec::Command.new(
+  'command',
+  :logger => Logger.new($stderr),
+  :options => '--command options',
+  :parameter => 'command parameter',
+  :error_keywords => ['key words in', 'stdout with indicate errors' ],
+  :working_directory => 'working/directory/where/the/command/should/be/executed/in',
+  :logfile => 'path/to/logfile.log',
+  :debug => false,
+  )
+command.run
+```
+
+## Output
+
+After execute the command you get the following output. Today it's not possible
+to suppress that output, but it's on the roadmap.
+
+### Successfull 
+
+```
+<timestamp> command: OK
+```
+
+### Failed with STDERR set
+
+```
+<timestamp> command: FAILED
+================== LOGFILE ==================
+[...]
+================== STDOUT ==================
+[...]
+================== STDERR ==================
+[...]
+```
+
+### Failed with string in STDOUT indicating an error
+
+```
+<timestamp> command: FAILED
+================== STDOUT ==================
+```
+
+## Dependencies
+
+Please see the gemspec for runtime dependencies and the 'Gemfile' for
+development dependencies.
+
+## Todo
+
+Please see TODO.md for enhancements which are planned for implementation.
+
+## Copyright
+
+(c) 2012-, Max Meyer
+
+## License
+
+Please see LICENSE.md for license text.

data/TODO.md

@@ -0,0 +1 @@
+* Add options to execute a command silently

data/lib/command_exec/version.rb

@@ -1,3 +1,3 @@
 module CommandExec
-    VERSION = "0.0.1"
+    VERSION = "0.0.2"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: command_exec
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
   prerelease: 
 platform: ruby
 authors:
@@ -13,7 +13,7 @@ date: 2012-03-21 00:00:00.000000000Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: POpen4
-  requirement: &21841820 !ruby/object:Gem::Requirement
+  requirement: &20579680 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,10 +21,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *21841820
+  version_requirements: *20579680
 - !ruby/object:Gem::Dependency
   name: colored
-  requirement: &21889840 !ruby/object:Gem::Requirement
+  requirement: &20579260 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -32,7 +32,7 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *21889840
+  version_requirements: *20579260
 description: This adds bells and whistles to ease shell command execution
 email:
 - dev@fedux.org
@@ -44,8 +44,10 @@ files:
 - Gemfile
 - Gemfile.lock
 - Guardfile
+- LICENSE.md
 - README.md
 - Rakefile
+- TODO.md
 - command_exec.gemspec
 - lib/command_exec.rb
 - lib/command_exec/command.rb