RunIt 0.1.0 → 1.0.0

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    RunIt (0.1.0)
+    RunIt (1.0.0)
 
 GEM
   remote: https://rubygems.org/

data/lib/RunIt.rb

@@ -11,6 +11,14 @@
 
 A simple class to wrap Open3 to execute a command and return the result, stdout and stderr
 
+== Synopsis
+
+    require 'RunIt'
+
+    runner = RunIt.new "/bin/ls"
+    runner.run
+    puts runner.output
+
 =end
 
 require 'open3'
@@ -18,53 +26,113 @@ require 'ostruct'
 
 class RunIt
 
-  VERSION = "0.1.0"
+  # Version 
+  VERSION = "1.0.0"
 
-  attr_accessor :cmd, :input, :output, :error, :result
+  # cmd:: set/get the command to execute
+  attr_accessor :cmd
 
-  def initialize(cmd, input=nil, output=nil, error=nil)
+  # input:: set/get the input for the command
+  attr_accessor :input
 
-    self.cmd = cmd
-    self.output = output ||= ''
-    self.error = error ||= ''
+  # output:: get the output from the command
+  attr_reader :output
 
-    # Input is a little more complicated
+  # error:: get the error messages from the command
+  attr_reader :error
 
-    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
-    
+  # result:: the result of the command as a Process::Status object
+  attr_reader :result
+
+
+  # Class function to tell if mocking is turned on
+  def self.mock?
+    @@mock
+  end
+
+  # Class method to turn on mocking
+  def self.mock!
+    @@mock = true
   end
 
+  # Class method to turn off mocking
+  def self.unmock!
+    @@mock = false
+  end
+  
+  # Initialize the RunIt object
+  #
+  # cmd:: (required) [String] - the full command line to execute
+  # input:: (optional) [String] - input to the command, if any
+  def initialize(cmd, input=nil)
+    self.cmd = cmd
+    self.input = input
+    self.result = nil
+    @@mock = false
+  end
+
+  # Execute the specified command
+  #
+  # If mocking is on, only return the command as the output, and set success to true
   def run
 
-    begin
+    if @@mock
 
-      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
+      self.result = OpenStruct.new(:success? => true, :exitstatus => 0)
+      self.output = "Command entered: #{self.cmd}"
+      self.error  = ''
+      return true
+
+    else
+
+      self.output = ''
+      self.error  = ''
+      self.result = nil
+
+      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
         end
-        self.result = wait.value
-        self.result.success?
-      end
 
-    rescue Exception => e
+      rescue Exception => e
+
+        self.result = OpenStruct.new(:success? => false, :exitstatus => -1)
+        self.error << "#{cmd} raised an error: #{e.class}:#{e}"
 
-      self.result = OpenStruct.new(:success? => false, :exitstatus => -1)
-      self.error << "#{cmd} raised an error: #{e.class}:#{e}"
-      false
+      end
+
+      self.result.success?
 
     end
-        
+
+  end
+
+  # Whether the command completed successfully
+  def success?
+    self.result.success?
+  end
+
+  # The exit status of the command
+  def exitstatus
+    self.result.exitstatus
+  end
+
+  # Instance method to tell if mocking is turned on
+  def mock?
+    @@mock
   end
 
+  private
+
+
 end
- 
+

data/spec/RunIt_spec.rb

@@ -5,7 +5,7 @@ describe RunIt do
 
   describe "/bin/ls" do
 
-    it "should return the list of files in an array" do
+    it "should return the list of files" do
       
       runner = RunIt.new "/bin/ls"
 
@@ -13,7 +13,8 @@ describe RunIt do
         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.success?.should be_true
+          runner.exitstatus.should == 0
           runner.output.should == "a\nb\nc\nd\n"
           runner.error.should be_empty
         end
@@ -24,34 +25,18 @@ describe RunIt do
 
   describe "/bin/cat" do
 
-    let(:input) { "Now is the winter of our discount tent." }
+    let(:input) { "Now is the winter of our discount tent.\n" }
     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.success?.should be_true
+      runner.output.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? "}
@@ -59,13 +44,24 @@ describe RunIt do
 
     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
+      runner.success?.should be_false
+      runner.error.should_not be_empty
       puts "Runner.error: " + runner.error.inspect
     end
     
   end
 
+  describe "Test Mocking" do
+    it "Should not do anything except return the command given in the output" do
+      runner = RunIt.new "/bin/ls"
+      RunIt.mock!
+      runner.mock?.should be_true
+      runner.run.should be_true
+      runner.output.should == "Command entered: /bin/ls"
+    end
+
+    
+  end
 
 
 

metadata

@@ -1,18 +1,20 @@
 --- !ruby/object:Gem::Specification
 name: RunIt
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 1.0.0
+  prerelease: 
 platform: ruby
 authors:
 - Tamara Temple
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-04-24 00:00:00.000000000 Z
+date: 2013-05-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
+    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -20,6 +22,7 @@ dependencies:
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
+    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -27,6 +30,7 @@ dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
+    none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
@@ -34,6 +38,7 @@ dependencies:
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
+    none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
@@ -41,6 +46,7 @@ dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
+    none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
@@ -48,6 +54,7 @@ dependencies:
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
+    none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
@@ -55,6 +62,7 @@ dependencies:
 - !ruby/object:Gem::Dependency
   name: rdoc
   requirement: !ruby/object:Gem::Requirement
+    none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
@@ -62,6 +70,7 @@ dependencies:
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
+    none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
@@ -88,26 +97,33 @@ files:
 homepage: https://github.com/tamouse/RunIt
 licenses:
 - MIT
-metadata: {}
 post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
   requirements:
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
+      segments:
+      - 0
+      hash: -2733030625963170989
 required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
   requirements:
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
+      segments:
+      - 0
+      hash: -2733030625963170989
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.0.0
+rubygems_version: 1.8.25
 signing_key: 
-specification_version: 4
+specification_version: 3
 summary: A simple class to wrap Open3#popen3
 test_files:
 - spec/RunIt_spec.rb

checksums.yaml

@@ -1,15 +0,0 @@
----
-!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=