execute_shell 0.0.5 → 1.0.0

data/license/lgpl

@@ -0,0 +1,157 @@
+  This version of the GNU Lesser General Public License incorporates
+the terms and conditions of version 3 of the GNU General Public
+License, supplemented by the additional permissions listed below.
+
+  0. Additional Definitions.
+
+  As used herein, "this License" refers to version 3 of the GNU Lesser
+General Public License, and the "GNU GPL" refers to version 3 of the GNU
+General Public License.
+
+  "The Library" refers to a covered work governed by this License,
+other than an Application or a Combined Work as defined below.
+
+  An "Application" is any work that makes use of an interface provided
+by the Library, but which is not otherwise based on the Library.
+Defining a subclass of a class defined by the Library is deemed a mode
+of using an interface provided by the Library.
+
+  A "Combined Work" is a work produced by combining or linking an
+Application with the Library.  The particular version of the Library
+with which the Combined Work was made is also called the "Linked
+Version".
+
+  The "Minimal Corresponding Source" for a Combined Work means the
+Corresponding Source for the Combined Work, excluding any source code
+for portions of the Combined Work that, considered in isolation, are
+based on the Application, and not on the Linked Version.
+
+  The "Corresponding Application Code" for a Combined Work means the
+object code and/or source code for the Application, including any data
+and utility programs needed for reproducing the Combined Work from the
+Application, but excluding the System Libraries of the Combined Work.
+
+  1. Exception to Section 3 of the GNU GPL.
+
+  You may convey a covered work under sections 3 and 4 of this License
+without being bound by section 3 of the GNU GPL.
+
+  2. Conveying Modified Versions.
+
+  If you modify a copy of the Library, and, in your modifications, a
+facility refers to a function or data to be supplied by an Application
+that uses the facility (other than as an argument passed when the
+facility is invoked), then you may convey a copy of the modified
+version:
+
+   a) under this License, provided that you make a good faith effort to
+   ensure that, in the event an Application does not supply the
+   function or data, the facility still operates, and performs
+   whatever part of its purpose remains meaningful, or
+
+   b) under the GNU GPL, with none of the additional permissions of
+   this License applicable to that copy.
+
+  3. Object Code Incorporating Material from Library Header Files.
+
+  The object code form of an Application may incorporate material from
+a header file that is part of the Library.  You may convey such object
+code under terms of your choice, provided that, if the incorporated
+material is not limited to numerical parameters, data structure
+layouts and accessors, or small macros, inline functions and templates
+(ten or fewer lines in length), you do both of the following:
+
+   a) Give prominent notice with each copy of the object code that the
+   Library is used in it and that the Library and its use are
+   covered by this License.
+
+   b) Accompany the object code with a copy of the GNU GPL and this license
+   document.
+
+  4. Combined Works.
+
+  You may convey a Combined Work under terms of your choice that,
+taken together, effectively do not restrict modification of the
+portions of the Library contained in the Combined Work and reverse
+engineering for debugging such modifications, if you also do each of
+the following:
+
+   a) Give prominent notice with each copy of the Combined Work that
+   the Library is used in it and that the Library and its use are
+   covered by this License.
+
+   b) Accompany the Combined Work with a copy of the GNU GPL and this license
+   document.
+
+   c) For a Combined Work that displays copyright notices during
+   execution, include the copyright notice for the Library among
+   these notices, as well as a reference directing the user to the
+   copies of the GNU GPL and this license document.
+
+   d) Do one of the following:
+
+       0) Convey the Minimal Corresponding Source under the terms of this
+       License, and the Corresponding Application Code in a form
+       suitable for, and under terms that permit, the user to
+       recombine or relink the Application with a modified version of
+       the Linked Version to produce a modified Combined Work, in the
+       manner specified by section 6 of the GNU GPL for conveying
+       Corresponding Source.
+
+       1) Use a suitable shared library mechanism for linking with the
+       Library.  A suitable mechanism is one that (a) uses at run time
+       a copy of the Library already present on the user's computer
+       system, and (b) will operate properly with a modified version
+       of the Library that is interface-compatible with the Linked
+       Version.
+
+   e) Provide Installation Information, but only if you would otherwise
+   be required to provide such information under section 6 of the
+   GNU GPL, and only to the extent that such information is
+   necessary to install and execute a modified version of the
+   Combined Work produced by recombining or relinking the
+   Application with a modified version of the Linked Version. (If
+   you use option 4d0, the Installation Information must accompany
+   the Minimal Corresponding Source and Corresponding Application
+   Code. If you use option 4d1, you must provide the Installation
+   Information in the manner specified by section 6 of the GNU GPL
+   for conveying Corresponding Source.)
+
+  5. Combined Libraries.
+
+  You may place library facilities that are a work based on the
+Library side by side in a single library together with other library
+facilities that are not Applications and are not covered by this
+License, and convey such a combined library under terms of your
+choice, if you do both of the following:
+
+   a) Accompany the combined library with a copy of the same work based
+   on the Library, uncombined with any other library facilities,
+   conveyed under the terms of this License.
+
+   b) Give prominent notice with the combined library that part of it
+   is a work based on the Library, and explaining where to find the
+   accompanying uncombined form of the same work.
+
+  6. Revised Versions of the GNU Lesser General Public License.
+
+  The Free Software Foundation may publish revised and/or new versions
+of the GNU Lesser General Public License from time to time. Such new
+versions will be similar in spirit to the present version, but may
+differ in detail to address new problems or concerns.
+
+  Each version is given a distinguishing version number. If the
+Library as you received it specifies that a certain numbered version
+of the GNU Lesser General Public License "or any later version"
+applies to it, you have the option of following the terms and
+conditions either of that published version or of any later version
+published by the Free Software Foundation. If the Library as you
+received it does not specify a version number of the GNU Lesser
+General Public License, you may choose any version of the GNU Lesser
+General Public License ever published by the Free Software Foundation.
+
+  If the Library as you received it specifies that a proxy can decide
+whether future versions of the GNU Lesser General Public License shall
+apply, that proxy's public statement of acceptance of any version is
+permanent authorization for you to choose that version for the
+Library.

data/rakefile

@@ -1,2 +1 @@
-require 'bundler'
-Bundler.require :rake
+require 'rake_tasks'

data/test/helper.rb

@@ -0,0 +1,37 @@
+#--
+################################################################################
+#                      Copyright (C) 2011 Travis Herrick                       #
+################################################################################
+#                                                                              #
+#                                 \v^V,^!v\^/                                  #
+#                                 ~%       %~                                  #
+#                                 {  _   _  }                                  #
+#                                 (  *   -  )                                  #
+#                                 |    /    |                                  #
+#                                  \   _,  /                                   #
+#                                   \__.__/                                    #
+#                                                                              #
+################################################################################
+# This program is free software: you can redistribute it                       #
+# and/or modify it under the terms of the GNU Lesser General Public License    #
+# as published by the Free Software Foundation,                                #
+# either version 3 of the License, or (at your option) any later version.      #
+################################################################################
+# This program is distributed in the hope that it will be useful,              #
+# but WITHOUT ANY WARRANTY;                                                    #
+# without even the implied warranty of MERCHANTABILITY                         #
+# or FITNESS FOR A PARTICULAR PURPOSE.                                         #
+# See the GNU Lesser General Public License for more details.                  #
+#                                                                              #
+# You should have received a copy of the GNU Lesser General Public License     #
+# along with this program.  If not, see <http://www.gnu.org/licenses/>.        #
+################################################################################
+#++
+
+root_path = File.join(File.dirname(File.expand_path(__FILE__)), '..')
+root_path = File.expand_path(root_path)
+
+require 'test/unit'
+require 'test_unit_helper'
+
+require_relative '../lib/execute_shell'

data/test/unit/execute_shell_test.rb

@@ -0,0 +1,152 @@
+#--
+################################################################################
+#                      Copyright (C) 2011 Travis Herrick                       #
+################################################################################
+#                                                                              #
+#                                 \v^V,^!v\^/                                  #
+#                                 ~%       %~                                  #
+#                                 {  _   _  }                                  #
+#                                 (  *   -  )                                  #
+#                                 |    /    |                                  #
+#                                  \   _,  /                                   #
+#                                   \__.__/                                    #
+#                                                                              #
+################################################################################
+# This program is free software: you can redistribute it                       #
+# and/or modify it under the terms of the GNU Lesser General Public License    #
+# as published by the Free Software Foundation,                                #
+# either version 3 of the License, or (at your option) any later version.      #
+################################################################################
+# This program is distributed in the hope that it will be useful,              #
+# but WITHOUT ANY WARRANTY;                                                    #
+# without even the implied warranty of MERCHANTABILITY                         #
+# or FITNESS FOR A PARTICULAR PURPOSE.                                         #
+# See the GNU Lesser General Public License for more details.                  #
+#                                                                              #
+# You should have received a copy of the GNU Lesser General Public License     #
+# along with this program.  If not, see <http://www.gnu.org/licenses/>.        #
+################################################################################
+#++
+
+require_relative '../helper'
+
+class ExecuteShellTest < Test::Unit::TestCase
+  Command = {
+    :ls => {
+      :linux => 'ls',
+      :mingw => 'dir',
+    }
+  }
+
+  def setup
+    @obj = @class.new
+    @working_path = Dir.getwd
+    @home_path = File.expand_path(File.join('~', '..'))
+    @user = File.basename(File.expand_path('~'))
+  end
+
+  def test_supported_systems
+    assert_equal [:linux, :mingw], @class.supported_systems
+  end
+
+  def test_supported_flag
+    assert_equal true, @class.supported?
+    assert_equal true, @class.supported?(:linux)
+    assert_equal true, @class.supported?('linux')
+    assert_equal true, @class.supported?(:mingw)
+    assert_equal true, @class.supported?('mingw')
+    assert_equal false, @class.supported?(:my_os)
+    assert_equal false, @class.supported?('my_os')
+  end
+
+  def test_raise_not_implemented_error
+    assert_raise(NotImplementedError) { @class.raise_not_implemented('method') }
+  end
+
+  def test_basic_run
+    shell_result = @class.run("echo 'hello world'")
+    assert_equal ShellResult, shell_result.class
+    check_all 'hello world', '', true, shell_result
+  end
+
+  def test_bad_command
+    result = @class.run('my_bad_command')
+
+    case Platform::IMPL
+      when :linux
+        check_all '',
+          'bash: line 1: my_bad_command: command not found',
+          false, result
+      when :mingw
+        ExecuteShell.raise_not_implemented __method__
+    end
+  end
+
+  def test_change_directory_parameter
+    command = get_command(:ls)
+
+    result = @class.run(command, @home_path)
+
+    assert File.expand_path(Dir.getwd) != @home_path
+
+    assert_equal true, result.success?
+    assert_equal '', result.err
+
+    assert result.out.index(@user),
+      "'#{command}' does not appear to include " +
+      "the current user's folder (#{@user}), " +
+      "which implies that the path was not changed prior to execution."
+  end
+
+  def test_run_success
+    assert_equal true, @class.run_success?("echo 'hello world'")
+    assert_equal false, @class.run_success?('my_bad_command')
+  end
+
+  def test_run_out
+    assert_equal 'hello world', @class.run_out("echo 'hello world'")
+    assert_equal '', @class.run_out('my_bad_command')
+  end
+
+  def test_run_to_s
+    assert_equal 'hello world', @class.run_to_s("echo 'hello world'")
+    assert_equal 'bash: line 1: my_bad_command: command not found',
+      @class.run_to_s('my_bad_command')
+  end
+
+  def test_run_success_err
+    assert_equal [true, ''], @class.run_success_err("echo 'hello world'")
+    assert_equal [false, 'bash: line 1: my_bad_command: command not found'],
+      @class.run_success_err('my_bad_command')
+  end
+
+  def test_run_success_err_out
+    assert_equal [true, '', 'hello world'],
+      @class.run_success_err_out("echo 'hello world'")
+    assert_equal [false, 'bash: line 1: my_bad_command: command not found', ''],
+      @class.run_success_err_out('my_bad_command')
+  end
+
+  def test_respond_to
+    assert_respond_to @class, :run_success?
+    assert_respond_to @class, :run_success
+    assert_respond_to @class, :run_success_err_out
+    assert_respond_to @class, :run_err_out_success
+    assert_respond_to @class, :run_success_to_s
+    assert_equal false, @class.respond_to?(:run_success_blah)
+  end
+
+  ############################################################################
+  private
+  ############################################################################
+
+  def get_command(cmd)
+    return Command[cmd][Platform::IMPL]
+  end
+
+  def check_all(out, err, success, result)
+    assert_equal out, result.out
+    assert_equal err, result.err
+    assert_equal success, result.success?
+  end
+end

data/test/unit/shell_result_test.rb

@@ -0,0 +1,63 @@
+#--
+################################################################################
+#                      Copyright (C) 2011 Travis Herrick                       #
+################################################################################
+#                                                                              #
+#                                 \v^V,^!v\^/                                  #
+#                                 ~%       %~                                  #
+#                                 {  _   _  }                                  #
+#                                 (  *   -  )                                  #
+#                                 |    /    |                                  #
+#                                  \   _,  /                                   #
+#                                   \__.__/                                    #
+#                                                                              #
+################################################################################
+# This program is free software: you can redistribute it                       #
+# and/or modify it under the terms of the GNU Lesser General Public License    #
+# as published by the Free Software Foundation,                                #
+# either version 3 of the License, or (at your option) any later version.      #
+################################################################################
+# This program is distributed in the hope that it will be useful,              #
+# but WITHOUT ANY WARRANTY;                                                    #
+# without even the implied warranty of MERCHANTABILITY                         #
+# or FITNESS FOR A PARTICULAR PURPOSE.                                         #
+# See the GNU Lesser General Public License for more details.                  #
+#                                                                              #
+# You should have received a copy of the GNU Lesser General Public License     #
+# along with this program.  If not, see <http://www.gnu.org/licenses/>.        #
+################################################################################
+#++
+
+require_relative '../helper'
+
+class ShellResultTest < Test::Unit::TestCase
+  def setup
+    @obj = @class.new('Std Out', 'Std Err')
+  end
+
+  def test_readonly_attributes
+    assert_raise(NoMethodError) { @obj.out = 'blah' }
+    assert_raise(NoMethodError) { @obj.err = 'blah' }
+  end
+
+  def test_output_text
+    assert_equal 'Std Out', @obj.out
+  end
+
+  def test_error_text
+    assert_equal 'Std Err', @obj.err
+  end
+
+  def test_success
+    result = @class.new('output', nil)
+    assert_equal true, result.success?
+    result = @class.new('output', '')
+    assert_equal true, result.success?
+    result = @class.new('output', '  ')
+    assert_equal false, result.success?
+  end
+
+  def test_to_string
+    assert_equal "Std Out\nStd Err", @obj.to_s
+  end
+end

metadata

@@ -1,151 +1,125 @@
---- !ruby/object:Gem::Specification 
+--- !ruby/object:Gem::Specification
 name: execute_shell
-version: !ruby/object:Gem::Version 
-  prerelease: false
-  segments: 
-  - 0
-  - 0
-  - 5
-  version: 0.0.5
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+  prerelease: 
 platform: ruby
-authors: 
+authors:
 - Travis Herrick
 autorequire: 
 bindir: bin
 cert_chain: []
-
-date: 2011-08-10 00:00:00 -04:00
-default_executable: 
-dependencies: 
-- !ruby/object:Gem::Dependency 
+date: 2012-03-07 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
   name: Platform
-  requirement: &id001 !ruby/object:Gem::Requirement 
+  requirement: &14839660 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
+    requirements:
     - - ~>
-      - !ruby/object:Gem::Version 
-        segments: 
-        - 0
-        - 4
-        - 0
+      - !ruby/object:Gem::Version
         version: 0.4.0
   type: :runtime
   prerelease: false
-  version_requirements: *id001
-- !ruby/object:Gem::Dependency 
+  version_requirements: *14839660
+- !ruby/object:Gem::Dependency
   name: open4
-  requirement: &id002 !ruby/object:Gem::Requirement 
+  requirement: &14839060 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
+    requirements:
     - - ~>
-      - !ruby/object:Gem::Version 
-        segments: 
-        - 1
-        - 0
-        - 1
+      - !ruby/object:Gem::Version
         version: 1.0.1
   type: :runtime
   prerelease: false
-  version_requirements: *id002
-- !ruby/object:Gem::Dependency 
+  version_requirements: *14839060
+- !ruby/object:Gem::Dependency
   name: win32-open3-19
-  requirement: &id003 !ruby/object:Gem::Requirement 
+  requirement: &14853660 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
+    requirements:
     - - ~>
-      - !ruby/object:Gem::Version 
-        segments: 
-        - 0
-        - 0
-        - 1
+      - !ruby/object:Gem::Version
         version: 0.0.1
   type: :runtime
   prerelease: false
-  version_requirements: *id003
-- !ruby/object:Gem::Dependency 
-  name: app_mode
-  requirement: &id004 !ruby/object:Gem::Requirement 
+  version_requirements: *14853660
+- !ruby/object:Gem::Dependency
+  name: rake_tasks
+  requirement: &14851340 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
+    requirements:
     - - ~>
-      - !ruby/object:Gem::Version 
-        segments: 
-        - 1
-        - 0
-        - 0
-        version: 1.0.0
-  type: :runtime
+      - !ruby/object:Gem::Version
+        version: 2.0.5
+  type: :development
   prerelease: false
-  version_requirements: *id004
-- !ruby/object:Gem::Dependency 
-  name: rake_tasks
-  requirement: &id005 !ruby/object:Gem::Requirement 
+  version_requirements: *14851340
+- !ruby/object:Gem::Dependency
+  name: test_unit_helper
+  requirement: &14850100 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
+    requirements:
     - - ~>
-      - !ruby/object:Gem::Version 
-        segments: 
-        - 0
-        - 0
-        - 1
+      - !ruby/object:Gem::Version
         version: 0.0.1
   type: :development
   prerelease: false
-  version_requirements: *id005
-description: |-
-  ExecuteShell provides cross-platform shell command execution.
+  version_requirements: *14850100
+description: ! 'ExecuteShell provides cross-platform shell command execution.
+
   In other words, it lays the smack down like a hungry t-rex
-  in the octagon with a pig.
+
+  in the octagon with a pig.'
 email: tthetoad@gmail.com
 executables: []
-
 extensions: []
-
-extra_rdoc_files: 
+extra_rdoc_files:
 - README
-files: 
-- lib/execute_shell/execute_shell.rb
-- lib/execute_shell.rb
+- license/gpl
+- license/lgpl
+- license/lgplv3-88x31.png
+files:
 - Gemfile.lock
 - README
+- execute_shell.gemspec
 - Gemfile
 - rakefile
-- execute_shell.gemspec
-- test/require.rb
-- test/execute_shell_test.rb
-has_rdoc: true
+- lib/execute_shell.rb
+- lib/execute_shell/execute_shell.rb
+- lib/execute_shell/shell_result.rb
+- license/gpl
+- license/lgpl
+- license/lgplv3-88x31.png
+- test/helper.rb
+- test/unit/execute_shell_test.rb
+- test/unit/shell_result_test.rb
 homepage: http://www.bitbucket.org/ToadJamb/gems_execute_shell
-licenses: 
-- GPLv3
+licenses:
+- LGPLv3
 post_install_message: 
 rdoc_options: []
-
-require_paths: 
+require_paths:
 - lib
-required_ruby_version: !ruby/object:Gem::Requirement 
+required_ruby_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      hash: -1239307810502746702
-      segments: 
-      - 0
-      version: "0"
-required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      segments: 
-      - 0
-      version: "0"
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
 requirements: []
-
 rubyforge_project: 
-rubygems_version: 1.3.7
+rubygems_version: 1.8.17
 signing_key: 
 specification_version: 3
 summary: Cross-platform shell commands.
-test_files: 
-- test/require.rb
-- test/execute_shell_test.rb
+test_files:
+- test/helper.rb
+- test/unit/execute_shell_test.rb
+- test/unit/shell_result_test.rb