command_exec 0.1.0 → 0.1.3

data/.gitignore

@@ -50,3 +50,4 @@ tmp/
 *.pdf
 !doc/*/*.pdf
 *.pid
+doc/yard

data/Gemfile

@@ -20,4 +20,5 @@ end
 
 group :development do
   gem 'tmrb'
+  gem 'activesupport'
 end

data/Gemfile.lock

@@ -12,6 +12,9 @@ GEM
       Platform (>= 0.4.0)
       open4
     Platform (0.4.0)
+    activesupport (3.2.6)
+      i18n (~> 0.6)
+      multi_json (~> 1.0)
     aruba (0.4.11)
       childprocess (>= 0.2.3)
       cucumber (>= 1.1.1)
@@ -34,35 +37,37 @@ GEM
       ruby-progressbar (~> 0.0.10)
     gherkin (2.11.1)
       json (>= 1.4.6)
-    github-markup (0.7.1)
+    github-markup (0.7.4)
+    i18n (0.6.0)
     json (1.7.3)
-    multi_json (1.1.0)
+    multi_json (1.3.6)
     open4 (1.3.0)
     rake (0.9.2.2)
-    redcarpet (1.17.2)
-    rspec (2.9.0)
-      rspec-core (~> 2.9.0)
-      rspec-expectations (~> 2.9.0)
-      rspec-mocks (~> 2.9.0)
-    rspec-core (2.9.0)
-    rspec-expectations (2.9.0)
+    redcarpet (2.1.1)
+    rspec (2.11.0)
+      rspec-core (~> 2.11.0)
+      rspec-expectations (~> 2.11.0)
+      rspec-mocks (~> 2.11.0)
+    rspec-core (2.11.1)
+    rspec-expectations (2.11.1)
       diff-lcs (~> 1.1.3)
-    rspec-instafail (0.2.2)
-    rspec-mocks (2.9.0)
+    rspec-instafail (0.2.4)
+    rspec-mocks (2.11.1)
     ruby-progressbar (0.0.10)
-    simplecov (0.6.1)
+    simplecov (0.6.4)
       multi_json (~> 1.0)
       simplecov-html (~> 0.5.3)
     simplecov-html (0.5.3)
     thor (0.15.4)
     tmrb (1.2.7)
       thor
-    yard (0.7.5)
+    yard (0.8.2.1)
 
 PLATFORMS
   ruby
 
 DEPENDENCIES
+  activesupport
   aruba
   command_exec!
   fuubar

data/README.md

@@ -19,18 +19,81 @@ command = CommandExec::Command.execute( 'command')
 
 #full path to commadn
 command = CommandExec::Command.execute( 'path/to/command')
+```
+
+## Options
+
+* `:logger`: Logger for output of information
 
-# available options
+```ruby
 command = CommandExec::Command.new(
   'command',
   :logger => Logger.new($stderr),
+}
+command.run
+```
+
+* `:options`: Commandline options for executed command
+
+```ruby
+command = CommandExec::Command.new(
+  'command',
   :options => '--command options',
-  :parameter => 'command parameter',
+}
+command.run
+```
+
+* `error_keywords`: Keywords which indicate error(s)
+
+Are there any keywords in stdout of the command which should be executed, which
+indicate errors?
+
+```ruby
+command = CommandExec::Command.new(
+  'command',
   :error_keywords => ['key words in', 'stdout with indicate errors' ],
+}
+command.run
+```
+
+* `:working_directory`: Change working directory of command 
+
+Change working directory to given one before command execution.
+
+```ruby
+command = CommandExec::Command.new(
+  'command',
   :working_directory => 'working/directory/where/the/command/should/be/executed/in',
+}
+command.run
+```
+
+* `logfile`: Logfile of command
+
+The first 30 lines of the command-logfile will be output by logger if an error
+occured. 
+
+```ruby
+command = CommandExec::Command.new(
+  'command',
+  :logfile => 'path/to/logfile.log',
+}
+command.run
+```
+
+* `:log_level`: 
+
+What should be put to logger? Available choices are :debug, :info, :warn,
+:error, :fatal, :unkonwn, :silent. If you choose :silent nothing will be
+output.
+
+
+```ruby
+command = CommandExec::Command.new(
+  'command',
   :logfile => 'path/to/logfile.log',
-  :debug => false,
-  )
+  :log_level => :debug
+}
 command.run
 ```
 

data/Rakefile

@@ -2,6 +2,7 @@
 require 'bundler/gem_tasks'
 require 'yard'
 require 'rubygems/package_task'
+require 'active_support/core_ext/string/strip'
 
 YARD::Rake::YardocTask.new do |t|
   t.files   = ['lib/**/*.rb', 'README.md', 'LICENCE.md']
@@ -22,9 +23,13 @@ namespace :version do
 
     new_version = ENV['VERSION']
 
-    version_string = %Q{ module DataUri
-        VERSION = '#{new_version}'
-    end}
+    raw_module_name = File.open(version_file, "r").readlines.grep(/module/).first
+    module_name = raw_module_name.chomp.match(/module\s+(\S+)/) {$1}
+
+    version_string = %Q{#main #{module_name}
+module #{module_name}
+  VERSION = '#{new_version}'
+end}
 
     File.open(version_file, "w") do |f|
       f.write version_string.strip_heredoc
@@ -46,4 +51,9 @@ namespace :version do
     end
 
   end
+
+  task :restore do
+    sh "git checkout #{version_file}"
+  end
+
 end

data/lib/command_exec/command.rb

@@ -147,7 +147,7 @@ module CommandExec
     # Read the content of the logfile
     #
     # @param [Path] file path to logfile
-    # @param [Integer num_of_lines the number of lines which should be read -- e.g. 30 lines = -30
+    # @param [Integer] num_of_lines the number of lines which should be read -- e.g. 30 lines = -30
     def read_logfile(file, num_of_lines=-30)
       content = StringIO.new
 

data/lib/command_exec/version.rb

@@ -1,3 +1,4 @@
+#main CommandExec
 module CommandExec
-  VERSION='0.1.0'
-end
+  VERSION = '0.1.3'
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: command_exec
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.3
   prerelease: 
 platform: ruby
 authors: