sprint 1.0.0

data/History.txt

@@ -0,0 +1,3 @@
+=== 1.0.0 2009-11-11
+
+* Initial release with basic execution and result capturing functionality

data/Manifest.txt

@@ -0,0 +1,11 @@
+History.txt
+Manifest.txt
+PostInstall.txt
+README.rdoc
+Rakefile
+lib/sprint.rb
+script/console
+script/destroy
+script/generate
+test/test_helper.rb
+test/test_sprint.rb

data/README.rdoc

@@ -0,0 +1,50 @@
+= sprint
+
+* http://github.com/#{github_username}/#{project_name}
+
+== DESCRIPTION:
+
+Make dealing with execution of external processes easier.
+
+== FEATURES/PROBLEMS:
+
+* Encapsulate the output of an external program/command and its return code in a single object.
+
+== SYNOPSIS:
+
+sprint adds a "sprint" method to the Kernel module. This method executes the given command (using Kernel.`). It then captures the program output and resulting Process::Status object (via $?) in a single Sprint::Status object. 
+
+== REQUIREMENTS:
+
+* Shoulda for testing; no dependencies on the core code.
+
+== INSTALL:
+
+Assuming you have Gemcutter in your gem sources:
+
+* sudo gem install sprint
+
+== LICENSE:
+
+(The MIT License)
+
+Copyright (c) 2009 Craig Walker
+
+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/Rakefile

@@ -0,0 +1,26 @@
+require 'rubygems'
+gem 'hoe', '>= 2.1.0'
+require 'hoe'
+require 'fileutils'
+require './lib/sprint'
+
+Hoe.plugin :newgem
+# Hoe.plugin :website
+# Hoe.plugin :cucumberfeatures
+
+# Generate all the Rake tasks
+# Run 'rake -T' to see list of generated tasks (from gem root directory)
+$hoe = Hoe.spec 'sprint' do
+  self.developer 'FIXME full name', 'FIXME email'
+  self.post_install_message = 'PostInstall.txt' # TODO remove if post-install message not required
+  self.rubyforge_name       = self.name # TODO this is default value
+  # self.extra_deps         = [['activesupport','>= 2.0.2']]
+
+end
+
+require 'newgem/tasks'
+Dir['tasks/**/*.rake'].each { |t| load t }
+
+# TODO - want other tests/tasks run by default? Add them to the list
+# remove_task :default
+# task :default => [:spec, :features]

data/lib/sprint.rb

@@ -0,0 +1,46 @@
+$:.unshift(File.dirname(__FILE__)) unless
+  $:.include?(File.dirname(__FILE__)) || $:.include?(File.expand_path(File.dirname(__FILE__)))
+
+module Sprint
+  VERSION = '1.0.0'
+  class Status
+    def initialize( output, status )
+      @output = output
+      @status = status
+    end
+    
+    def to_s
+      @output
+    end
+    alias :output :to_s
+    alias :to_string :to_s
+    
+    def good_output
+      raise "Process exited with error code: #{return_code}" unless success?
+      @output
+    end
+    
+    def to_i
+      @status.exitstatus
+    end
+    alias :return_code :to_i
+    alias :to_int :to_i
+    
+    def success?
+      @status.success?
+    end
+    alias :to_b :success?
+    
+    def self.run( command )
+      output = `#{command}`
+      status = $?
+      Status.new output, status
+    end
+  end
+end
+
+module Kernel
+  def sprint( command )
+    Sprint::Status.run command
+  end
+end

data/script/console

@@ -0,0 +1,10 @@
+#!/usr/bin/env ruby
+# File: script/console
+irb = RUBY_PLATFORM =~ /(:?mswin|mingw)/ ? 'irb.bat' : 'irb'
+
+libs =  " -r irb/completion"
+# Perhaps use a console_lib to store any extra methods I may want available in the cosole
+# libs << " -r #{File.dirname(__FILE__) + '/../lib/console_lib/console_logger.rb'}"
+libs <<  " -r #{File.dirname(__FILE__) + '/../lib/sprint.rb'}"
+puts "Loading sprint gem"
+exec "#{irb} #{libs} --simple-prompt"

data/script/destroy

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+APP_ROOT = File.expand_path(File.join(File.dirname(__FILE__), '..'))
+
+begin
+  require 'rubigen'
+rescue LoadError
+  require 'rubygems'
+  require 'rubigen'
+end
+require 'rubigen/scripts/destroy'
+
+ARGV.shift if ['--help', '-h'].include?(ARGV[0])
+RubiGen::Base.use_component_sources! [:rubygems, :newgem, :newgem_theme, :test_unit]
+RubiGen::Scripts::Destroy.new.run(ARGV)

data/script/generate

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+APP_ROOT = File.expand_path(File.join(File.dirname(__FILE__), '..'))
+
+begin
+  require 'rubigen'
+rescue LoadError
+  require 'rubygems'
+  require 'rubigen'
+end
+require 'rubigen/scripts/generate'
+
+ARGV.shift if ['--help', '-h'].include?(ARGV[0])
+RubiGen::Base.use_component_sources! [:rubygems, :newgem, :newgem_theme, :test_unit]
+RubiGen::Scripts::Generate.new.run(ARGV)

data/test/test_helper.rb

@@ -0,0 +1,3 @@
+require 'stringio'
+require 'test/unit'
+require File.dirname(__FILE__) + '/../lib/sprint'

data/test/test_sprint.rb

@@ -0,0 +1,58 @@
+require File.dirname(__FILE__) + '/test_helper.rb'
+require 'shoulda'
+
+class TestSprint < Test::Unit::TestCase
+
+  def setup
+  end
+  
+  context "The run command" do
+    context "when executing 'echo Test'" do
+      setup do
+        @results = sprint "echo Test"
+      end
+
+      should "return the word 'Test' as its execution results" do
+        assert_equal "Test", @results.output.strip
+      end
+      
+      should "have good output" do
+        assert_nothing_raised do
+          @results.good_output
+        end
+      end
+
+      should "indicate success" do
+        assert_equal true, @results.success?
+      end
+
+      should "have a zero status" do
+        assert_equal 0, @results.return_code
+      end
+    end
+
+    context "when executing 'false'" do
+      setup do
+        @results = sprint "/usr/bin/env false"
+      end
+
+      should "have blank execution results" do
+        assert_equal "", @results.output
+      end
+      
+      should "not have good output" do
+        assert_raise RuntimeError do
+          @results.good_output
+        end
+      end
+
+      should "indicate failure" do
+        assert_equal false, @results.success?
+      end
+
+      should "have a nonzero status" do
+        assert_not_equal 0, @results.return_code
+      end
+    end
+  end
+end

metadata

@@ -0,0 +1,87 @@
+--- !ruby/object:Gem::Specification 
+name: sprint
+version: !ruby/object:Gem::Version 
+  version: 1.0.0
+platform: ruby
+authors: 
+- Craig Walker
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-11-11 00:00:00 -07:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: hoe
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 2.3.3
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: thoughtbot-shoulda
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">"
+      - !ruby/object:Gem::Version 
+        version: 2.10.2
+    version: 
+description: Make dealing with execution of external processes easier.
+email: 
+- craig@softcraft.ca
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- History.txt
+- Manifest.txt
+files: 
+- History.txt
+- Manifest.txt
+- README.rdoc
+- Rakefile
+- lib/sprint.rb
+- script/console
+- script/destroy
+- script/generate
+- test/test_helper.rb
+- test/test_sprint.rb
+has_rdoc: true
+homepage: http://github.com/#{github_username}/#{project_name}
+licenses: []
+
+post_install_message: PostInstall.txt
+rdoc_options: 
+- --main
+- README.rdoc
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: sprint
+rubygems_version: 1.3.5
+signing_key: 
+specification_version: 3
+summary: Make dealing with execution of external processes easier.
+test_files: 
+- test/test_helper.rb
+- test/test_sprint.rb