RunIt 0.1.0

checksums.yaml

@@ -0,0 +1,15 @@
+---
+!binary "U0hBMQ==":
+  metadata.gz: !binary |-
+    N2JjMmEzZTk4NzdlM2M0Y2QwOTAzOTU3OTg5ZDljNzEyYzhiYzY2Mg==
+  data.tar.gz: !binary |-
+    M2QxNjU2ZmIwODNkYjgzYmE4ZjBhMDI4NTRlMWFiOTQ2NzY0MGZhOA==
+!binary "U0hBNTEy":
+  metadata.gz: !binary |-
+    MTFlOTE5Y2YyZmU4OTgwY2YxMThhZTJkMTQ3NjA5OGU1ZTA5NTZhNDg0Mjg1
+    NGJkMWUwYzQ3NmUyNWY3NTJhYjhhOTQ5NTVlZGY4Njg1NzkyMjY1ZDM4ZGY2
+    YzZlYWE5MGU2YTM2ODBjMTRmYTExNjQwYTE3ZTE0MWQ2ZWY0NmY=
+  data.tar.gz: !binary |-
+    NDQxOGY1OTAyM2RhNTMxMjkzODc4NTM3M2Q4NTZiZjkxY2M2OTdhNTk3ZTZk
+    MGRjYzIzMmQzMjRlMjUxNzNhMTBiNzJkNmNlZThiZGYwMmIwY2NmNzA5OTYy
+    NDM5ZTFlMGIyODc0NmY3NWI1ODI1NGI2YWZjNzE5OWFmMzlhZmY=

data/.gitignore

@@ -0,0 +1,5 @@
+.DS_Store
+results.html
+pkg
+html
+.rspec

data/.rspec.example

@@ -0,0 +1,2 @@
+--color
+--format progress

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in RunIt.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,31 @@
+PATH
+  remote: .
+  specs:
+    RunIt (0.1.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    diff-lcs (1.2.4)
+    json (1.7.7)
+    rake (10.0.3)
+    rdoc (4.0.1)
+      json (~> 1.4)
+    rspec (2.13.0)
+      rspec-core (~> 2.13.0)
+      rspec-expectations (~> 2.13.0)
+      rspec-mocks (~> 2.13.0)
+    rspec-core (2.13.1)
+    rspec-expectations (2.13.0)
+      diff-lcs (>= 1.1.3, < 2.0)
+    rspec-mocks (2.13.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  RunIt!
+  bundler (~> 1.3)
+  rake
+  rdoc
+  rspec

data/LICENSE.txt

@@ -0,0 +1,7 @@
+Copyright (c) 2013 YOUR NAME 
+
+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

@@ -0,0 +1,62 @@
+# RunIt
+
+A small wrapper class for Open3#popen3
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'RunIt'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install RunIt
+
+## Usage
+
+    require 'RunIt'
+    runner = RunIt.new command
+	runner.run
+    if runner.result.success?
+	   puts runner.output
+	else
+	   $stderr.puts runner.error
+	end
+
+Simple one-line thing:
+
+    raise "Could not list files!!" unless (runner = RunIt.new "/bin/ls").run
+
+Full usage:
+
+    require 'RunIt'
+
+    input <<-LIPSUM
+    Lorem ipsum solar et domit.
+    Now is the winter of our discount tent.
+    For score and winning the game.
+    Every good boy deserves favour.
+    LIPSUM
+
+    runner = RunIt.new "/bin/cat", input, [], nil
+	if runner.run
+	    # the output will be in an array
+	    puts runner.output.join
+    else
+	    STDERR.puts runner.error.join
+	end
+
+    
+
+
+## Contributing
+
+1. Fork it [Githum repo](https://github.com/tamouse/RunIt)
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/README.rdoc

@@ -0,0 +1,42 @@
+= RunIt - A wrapper class around Open3#popen3
+
+Author::  Tamara Temple <tamouse@gmail.com>
+Copyright:: Copyright (c) 2013 Tamara Temple Web Development
+
+
+License:: mit, see LICENSE.txt
+
+
+== SYNOPSIS
+
+    runner = RunIt.new(command, [input,] [output,] [error])
+    result = runner.run
+    puts runner.output if result
+    puts runner.error unless result
+
+== DESCRIPTION
+
+RunIt is a very simple class that wraps up the Open3#popen3 call. When you create the object, you specify the command to run as a string, optionally the input to the command (no input is given if nil), a type of receiver for the output of the command, but default this will be a string, and a type of receiver for the error output of the command, by default, also a string.
+
+The #run method will execute the command, returning a Boolean denoting success or failure. The process status, standard output and standard error will be available from the runner object itself.
+
+== Links
+
+* {Source on Github}[https://github.com/tamouse/RunIt]
+* RDoc[LINK TO RDOC.INFO]
+
+== Install
+
+    gem install RunIt
+
+== Examples
+
+   runner = RunIt.new("/bin/ls")
+   if runner.run
+     # process runner.output
+   else
+     STDERR.puts runner.error
+   end
+
+== Contributing
+

data/Rakefile

@@ -0,0 +1,21 @@
+require 'rspec/core/rake_task'
+gem 'rdoc' # we need the installed RDoc gem, not the system one
+require 'rdoc/task'
+
+include Rake::DSL
+
+Bundler::GemHelper.install_tasks
+
+RSpec::Core::RakeTask.new do |t|
+  # Put spec opts in a file named .rspec in root
+end
+
+Rake::RDocTask.new do |rd|
+  
+  rd.main = "README.rdoc"
+  
+  rd.rdoc_files.include("README.rdoc","lib/*.rb")
+end
+
+task :default => [:spec]
+

data/RunIt.gemspec

@@ -0,0 +1,24 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'RunIt'
+
+Gem::Specification.new do |spec|
+  spec.name          = "RunIt"
+  spec.version       = RunIt::VERSION
+  spec.authors       = ["Tamara Temple"]
+  spec.email         = ["tamouse@gmail.com"]
+  spec.description   = "A simple class to wrap Open3#popen3"
+  spec.summary       = "A simple class to wrap Open3#popen3"
+  spec.homepage      = "https://github.com/tamouse/RunIt"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec"
+  spec.add_development_dependency('rdoc')
+end

data/lib/RunIt.rb

@@ -0,0 +1,70 @@
+=begin rdoc
+
+= RUNIT.RB
+
+*Author*::      Tamara Temple <tamara@tamaratemple.com>
+*Since*::       2013-04-23
+*Copyright*::   (c) 2013 Tamara Temple Web Development
+*License*::     MIT
+  
+== Description
+
+A simple class to wrap Open3 to execute a command and return the result, stdout and stderr
+
+=end
+
+require 'open3'
+require 'ostruct'
+
+class RunIt
+
+  VERSION = "0.1.0"
+
+  attr_accessor :cmd, :input, :output, :error, :result
+
+  def initialize(cmd, input=nil, output=nil, error=nil)
+
+    self.cmd = cmd
+    self.output = output ||= ''
+    self.error = error ||= ''
+
+    # Input is a little more complicated
+
+    case input
+    when String ; self.input = input
+    when Array ; self.input = input.flatten.join("\n")
+    when NilClass ; self.input = nil
+    else self.input = input.to_s
+    end
+    
+  end
+
+  def run
+
+    begin
+
+      Open3.popen3(self.cmd) do |stdin, stdout, stderr, wait|
+        stdin.puts self.input unless self.input.nil?
+        stdin.close
+        until stdout.eof?
+          self.output <<  stdout.gets
+        end
+        until stderr.eof?
+          self.error <<  stderr.gets
+        end
+        self.result = wait.value
+        self.result.success?
+      end
+
+    rescue Exception => e
+
+      self.result = OpenStruct.new(:success? => false, :exitstatus => -1)
+      self.error << "#{cmd} raised an error: #{e.class}:#{e}"
+      false
+
+    end
+        
+  end
+
+end
+ 

data/spec/RunIt_spec.rb

@@ -0,0 +1,72 @@
+require 'spec_helper'
+require 'tmpdir'
+
+describe RunIt do
+
+  describe "/bin/ls" do
+
+    it "should return the list of files in an array" do
+      
+      runner = RunIt.new "/bin/ls"
+
+      Dir.mktmpdir do |dir|
+        Dir.chdir(dir) do |dir|
+          %w[a b c d].each {|fn| FileUtils.touch(fn)}
+          runner.run.should be_true
+          runner.result.success?.should be_true
+          runner.output.should == "a\nb\nc\nd\n"
+          runner.error.should be_empty
+        end
+      end
+    end
+    
+  end
+
+  describe "/bin/cat" do
+
+    let(:input) { "Now is the winter of our discount tent." }
+    let(:runner) { RunIt.new "/bin/cat", input }
+    
+    it "should return the same text as input" do
+      runner.run.should be_true
+      runner.result.success?.should be_true
+      runner.output.chomp.should == input
+      runner.error.should be_empty
+    end
+
+  end
+
+  describe "array return" do
+
+    let(:input) {%w[Every good boy deserves favour]}
+    let(:runner) {RunIt.new "/bin/cat", input, [], nil}
+
+    it "should return the same text as input, but in an array" do
+      runner.run.should be_true
+      runner.result.success?.should be_true
+      runner.output.should be_a(Array)
+      runner.output.count.should == input.count
+      runner.output.map(&:chomp).should == input
+      runner.error.should be_empty
+    end
+    
+  end
+
+  describe "Bogus Command" do
+
+    let(:input) {"Why did the chicken cross the road? "}
+    let(:runner) {RunIt.new "/xyzzy/not_a_command_issit", input}
+
+    it "should give a false result" do
+      runner.run.should be_false
+      runner.result.success?.should be_false
+      runner.error.chomp.should_not be_empty
+      puts "Runner.error: " + runner.error.inspect
+    end
+    
+  end
+
+
+
+
+end

data/spec/spec_helper.rb

@@ -0,0 +1,17 @@
+# This file was generated by the `rspec --init` command. Conventionally, all
+# specs live under a `spec` directory, which RSpec adds to the `$LOAD_PATH`.
+# Require this file using `require "spec_helper"` to ensure that it is only
+# loaded once.
+#
+# See http://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration
+RSpec.configure do |config|
+  config.treat_symbols_as_metadata_keys_with_true_values = true
+  config.run_all_when_everything_filtered = true
+  config.filter_run :focus
+
+  # Run specs in random order to surface order dependencies. If you find an
+  # order dependency and want to debug it, you can fix the order by providing
+  # the seed, which is printed after each run.
+  #     --seed 1234
+  config.order = 'random'
+end

metadata

@@ -0,0 +1,114 @@
+--- !ruby/object:Gem::Specification
+name: RunIt
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Tamara Temple
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-04-24 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rdoc
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: A simple class to wrap Open3#popen3
+email:
+- tamouse@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec.example
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- README.rdoc
+- Rakefile
+- RunIt.gemspec
+- lib/RunIt.rb
+- spec/RunIt_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/tamouse/RunIt
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.0.0
+signing_key: 
+specification_version: 4
+summary: A simple class to wrap Open3#popen3
+test_files:
+- spec/RunIt_spec.rb
+- spec/spec_helper.rb