execute_shell 0.0.1 → 0.0.2

data/{gemfile → Gemfile}

@@ -1,11 +1,11 @@
-source "http://rubygems.org"
-
-gem 'Platform',       '~>  0.4.0', :group => [:rake, :test],
-  :require => 'platform'
-gem 'open4',          '~>  1.0.1', :group => [:rake, :test]
-gem 'win32-open3-19', '~>  0.0.1', :group => [:rake, :test], :require => 'open3'
-
-group :rake do
-	gem 'rake', '0.8.7'
-	gem 'highline', '~>  1.6.1', :require => 'highline/import'
-end
+source "http://rubygems.org"
+
+gem 'Platform',       '~>  0.4.0', :group => [:rake, :test],
+  :require => 'platform'
+gem 'open4',          '~>  1.0.1', :group => [:rake, :test]
+gem 'win32-open3-19', '~>  0.0.1', :group => [:rake, :test], :require => 'open3'
+
+group :rake do
+	gem 'rake', '0.8.7'
+	gem 'highline', '~>  1.6.1', :require => 'highline/import'
+end

data/README

@@ -0,0 +1,44 @@
+== Welcome to ExecuteShell
+
+ExecuteShell allows shell commands to be executed the same across all platforms.
+
+== Getting Started
+
+1. Install ExecuteShell at the command prompt if you haven't yet:
+
+    gem install execute_shell
+
+2. Require the gem in your gemfile:
+
+    gem 'execute_shell', '~> 0.0.1'
+
+3. Require the gem wherever you need shell commands:
+
+    require 'execute_shell'
+
+4. Include the ExecuteShell module in your class or module:
+
+    include ExecuteShell
+
+5. Call a shell command:
+
+    success, output = shell('ls ~')
+
+== Additional Notes
+
+* The shell method has a second optional parameter, which is a path.
+  If specified, the working directory will be changed to this path prior
+  to executing the shell command. It will be set back to the original
+  working directory before returning to the calling function.
+
+* Success will be false under two conditions. One is if there is any output
+  to stderr. The other is if an exception is raised. In either case, the
+  information is returned in the output.
+
+== Additional Documentation
+
+ rake rdoc:app
+
+== License
+
+ExecuteShell is released under the GPLv3 license.

data/execute_shell.gemspec

@@ -1,13 +1,16 @@
 gem_spec = Gem::Specification.new do |s|
-  s.name = 'execute_shell'
-  s.version = '0.0.1'
+  s.name    = 'execute_shell'
+  s.version = '0.0.2'
 
-  s.summary = 'Executes shell commands.'
+  s.summary     = 'Cross-platform shell commands.'
+  s.description = 'Execute Shell provides ' +
+    'cross-platform shell command execution.'
 
-  s.author = 'Travis Herrick'
-  s.email = 'tthetoad@gmail.com'
+  s.author   = 'Travis Herrick'
+  s.email    = 'tthetoad@gmail.com'
+  s.homepage = 'http://www.bitbucket.org/ToadJamb/gems_execute_shell'
 
-  s.license = 'MIT'
+  s.license = 'GPLV3'
 
   s.extra_rdoc_files << 'README'
 

data/rakefile

@@ -67,9 +67,10 @@ namespace :rdoc do
         :rdoc         => rdoc_task,
         :clobber_rdoc => "#{rdoc_task}:clobber",
         :rerdoc       => "#{rdoc_task}:force") do |rdtask|
-      rdtask.rdoc_dir = "help/#{rdoc_task}"
+      rdtask.rdoc_dir = "doc/#{rdoc_task}"
       rdtask.options << '--charset' << 'utf8'
-      rdtask.rdoc_files.include(RDOC_FILES[rdoc_task])
+      rdtask.rdoc_files.include RDOC_FILES[rdoc_task], 'README'
+      rdtask.main = 'README'
     end
 
     Rake::Task[rdoc_task].comment =

metadata

@@ -5,8 +5,8 @@ version: !ruby/object:Gem::Version
   segments: 
   - 0
   - 0
-  - 1
-  version: 0.0.1
+  - 2
+  version: 0.0.2
 platform: ruby
 authors: 
 - Travis Herrick
@@ -14,7 +14,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-07-28 00:00:00 -04:00
+date: 2011-07-29 00:00:00 -04:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -92,7 +92,7 @@ dependencies:
         version: 1.6.1
   type: :development
   version_requirements: *id005
-description: 
+description: Execute Shell provides cross-platform shell command execution.
 email: tthetoad@gmail.com
 executables: []
 
@@ -106,16 +106,16 @@ files:
 - lib/execute_shell.rb
 - Gemfile.lock
 - README
-- gemfile
+- Gemfile
 - rakefile
 - execute_shell.gemspec
 - test/require.rb
 - test/lib/test_case.rb
 - test/execute_shell_test.rb
 has_rdoc: true
-homepage: 
+homepage: http://www.bitbucket.org/ToadJamb/gems_execute_shell
 licenses: 
-- MIT
+- GPLV3
 post_install_message: 
 rdoc_options: []
 
@@ -143,7 +143,7 @@ rubyforge_project:
 rubygems_version: 1.3.7
 signing_key: 
 specification_version: 3
-summary: Executes shell commands.
+summary: Cross-platform shell commands.
 test_files: 
 - test/require.rb
 - test/lib/test_case.rb