syscmd 0.0.3

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 Till Salzer
+
+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.rdoc

@@ -0,0 +1,27 @@
+= syscmd
+
+A simple wrapper to execute system commands, which provides stdout, stderr and
+exit code.
+
+== Usage
+
+ require 'syscmd'
+ cmd = Syscmd.exec!('command')  # => Syscmd::Command object
+ 
+ cmd.stdout                     # => String
+ cmd.stderr                     # => String
+ cmd.exitcode                   # => Integer
+
+Note that <code>Syscmd.exec!</code> immediately executes the given command.
+You will get the Syscmd::Command object executed and can examine it.
+
+
+== Heritage/Acknoledgement
+
+The <code>Syscmd::popen</code> code is mostly taken from the original Ruby 1.8
+implementation of Open3::open3 (author: Yukihiro Matsumoto: documentation: Konrad Meyer).
+
+
+== Copyright
+
+Copyright (c) 2009 Till Salzer. See LICENSE for details.

data/VERSION.yml

@@ -0,0 +1,4 @@
+--- 
+:major: 0
+:minor: 0
+:patch: 3

data/lib/syscmd.rb

@@ -0,0 +1,109 @@
+require 'syscmd/popen'
+
+# Module.
+module Syscmd
+  # Error raise if a command object is executed twice.
+  class AlreadyExecutedError < RuntimeError ; end
+  
+  # A command to execute.
+  # You usually just use Syscmd::exec! to create and execute the command.
+  # A command object can be executed only once.
+  class Command
+    # +true+ if the command was already executed, otherwise +false+.
+    attr_reader :executed
+    
+    # the command to execute.
+    attr_reader :cmd
+    # array of arguments.
+    attr_reader :args
+    # the constructed command line.
+    attr_reader :cmdline
+    
+    # standard output of the executed command.
+    attr_reader :stdout
+    # standard error of the executed command.
+    attr_reader :stderr
+    # exit code of the executed command.
+    # Note that the exit code is just a Byte value ranged 0..255 on
+    # Unix platforms, so don't expect any negative values or values greated
+    # than 255 here.
+    attr_reader :exitcode
+    # exit status of the executed command.
+    attr_reader :process_status
+    
+    # execute a system command.
+    #  cmd: the command to execute
+    #  args: command line arguments
+    def initialize(cmd, *args)
+      @cmd = cmd
+      @args = *args
+      @process_status = nil
+      @executed = false
+    end
+    
+    # execute the command.
+    # raises AlreadyExecutedError if the command is already executed.
+    def exec!
+      raise AlreadyExecutedError.new("already executed with status #{process_status}") if self.executed?
+      @process_status, pread, perr = Syscmd::popen(self.cmdline)
+      @stdout = pread.read
+      @stderr = perr.read
+      self
+    end
+    
+    # get the stdout as lines.
+    def stdout_lines
+      if @stdout_lines.nil?
+        stdout = self.stdout
+        return nil unless stdout
+        @stdout_lines = stdout.split(/\n/)
+      end
+      @stdout_lines
+    end
+    
+    # get the stdout as lines.
+    def stderr_lines
+      if @stderr_lines.nil?
+        stderr = self.stderr
+        return nil unless stderr
+        @stderr_lines = stderr.split(/\n/)
+      end
+      @stderr_lines
+    end
+    
+    # the exitcode of the executed command.
+    # returns nil 
+    def exitcode
+      @process_status ? @process_status.exitstatus : nil
+    end
+    
+    # build the command line for this command.
+    # Once the command line is created, it will be cached.
+    def cmdline
+      if @cmdline.nil?
+        cmdline = "#{@cmd}"
+        @args.each do |arg|
+          cmdline << (arg.to_s.index(" ") ? " \"#{arg}\"" : " #{arg}")
+        end if @args
+        @cmdline = cmdline
+      end
+      @cmdline
+    end
+    
+    # check if the command was executed.
+    def executed
+      @process_status.nil? ? false : true
+    end
+    alias executed? executed
+  end
+  
+  # execute a system command.
+  # cmd::     the command to execute
+  # args::    command line arguments
+  # returns:: executed Syscmd::Command object
+  def exec!(cmd, *args)
+    cmd = Command.new(cmd, args)
+    cmd.exec!
+  end
+  module_function :'exec!'
+end

data/lib/syscmd/popen.rb

@@ -0,0 +1,58 @@
+module Syscmd
+  # Taken from the original Ruby 1.8 implementation of Open3::open3 and slightly
+  # tweaked to return an exit status.
+  # This function is meant as in internal method of the Syscmd module; do not use
+  # it on it's own, as the interface may change anytime.
+  #
+  # cmd::       the command to execute
+  # returns::   status, stdout, stderr
+  #
+  # orignal author::        Yukihiro Matsumoto
+  # orignal socumentation:: Konrad Meyer
+  def popen(*cmd)
+    pw = IO::pipe   # pipe[0] for read, pipe[1] for write
+    pr = IO::pipe
+    pe = IO::pipe
+    status = 0 # status of the inner fork
+
+    pid = fork do
+      # child
+      gcpid = fork do
+      	# grandchild
+      	pw[1].close
+      	STDIN.reopen(pw[0])
+      	pw[0].close
+
+      	pr[0].close
+      	STDOUT.reopen(pr[1])
+      	pr[1].close
+
+      	pe[0].close
+      	STDERR.reopen(pe[1])
+      	pe[1].close
+
+      	exec(*cmd)
+      end
+      gcpid, gcstatus = Process.wait2(gcpid)
+      exit!(gcstatus.exitstatus)
+    end
+
+    pw[0].close
+    pr[1].close
+    pe[1].close
+    pid, status = Process.wait2(pid)
+    
+    #pi = [status.exitstatus, pw[1], pr[0], pe[0]]
+    pi = [status, pr[0], pe[0]]
+    pw[1].sync = true
+    if defined? yield
+      begin
+	      return yield(*pi)
+      ensure
+	      pi.each{|p| p.close unless p.closed?}
+      end
+    end
+    pi
+  end
+  module_function :popen
+end

data/spec/command_exec_spec.rb

@@ -0,0 +1,82 @@
+require File.join(File.dirname(__FILE__), 'spec_helper')
+
+describe Syscmd::Command, ".exec! for -s 'Hello World'" do
+  subject { Syscmd::Command.new(TESTER, '-s', 'Hello World').exec! }
+  
+  it "should have stdout 'Hello World\\n'" do
+    subject.stdout.should == "Hello World\n"
+  end
+  it "should have stdout_lines ['Hello World']" do
+    subject.stdout_lines.should == ["Hello World"]
+  end
+  
+  
+  it "should have stderr \"\"" do
+    subject.stderr.should == ""
+  end
+  
+  it "should have exitcode 0" do
+    subject.exitcode.should == 0
+  end
+end
+
+describe Syscmd::Command, ".exec! for multiline output" do
+  subject { Syscmd::Command.new(TESTER, 
+    '-s', 'Hello World', '-S', 2,
+    '-e', 'Bye Bye World', '-E', 2).exec! }
+  
+  it "should have stdout 'Hello World\\nHello World\\n'" do
+    subject.stdout.should == "Hello World\nHello World\n"
+  end
+  it "should have two strings in stdout_lines" do
+    subject.stdout_lines.should == ["Hello World", "Hello World"]
+  end
+  
+  it "should have stderr 'Bye Bye World\\nBye Bye World\\n'" do
+    subject.stderr.should == "Bye Bye World\nBye Bye World\n"
+  end
+  it "should have two strings in stdout_lines" do
+    subject.stderr_lines.should == ["Bye Bye World", "Bye Bye World"]
+  end
+end
+
+describe Syscmd::Command, ".exec! for positive exit codes" do
+  [1, 2, 254, 255].each do |st|
+    it "should return exit code #{st} for -x #{st}" do
+      cmd = Syscmd::Command.new(TESTER, '-x', st)
+      cmd.cmdline.should == "#{TESTER} -x #{st}"
+      cmd.exec!
+      cmd.exitcode.should == st
+    end
+  end
+end
+
+describe Syscmd::Command, ".exec! for hugh positive exit codes" do
+  [256, 257, 512, 4000].each do |st|
+    it "should return exit code #{st % 256} for -x #{st}" do
+      cmd = Syscmd::Command.new(TESTER, '-x', st)
+      cmd.cmdline.should == "#{TESTER} -x #{st}"
+      cmd.exec!
+      cmd.exitcode.should == st % 256
+    end
+  end
+end
+
+describe Syscmd::Command, ".exec! for negative exit codes" do
+  [-1, -2, -255, -256].each do |st|
+    it "should return exit code #{st % 256} for -x #{st}" do
+      cmd = Syscmd::Command.new(TESTER, '-x', st)
+      cmd.cmdline.should == "#{TESTER} -x #{st}"
+      cmd.exec!
+      cmd.exitcode.should == st % 256
+    end
+  end
+end
+
+describe Syscmd::Command, ".exec! called twice" do
+  subject { Syscmd::Command.new(TESTER) }
+  it "should fail with AlreadyExecutedError" do
+    subject.exec!
+    lambda { subject.exec! }.should raise_error(Syscmd::AlreadyExecutedError)
+  end
+end

data/spec/command_spec.rb

@@ -0,0 +1,29 @@
+require File.join(File.dirname(__FILE__), 'spec_helper')
+
+describe Syscmd::Command, ".new" do
+  subject { Syscmd::Command.new(TESTER) }
+  
+  it "should have #{TESTER} as cmd attribute" do
+    subject.cmd.should == TESTER
+  end
+  
+  it "should not be executed after creation" do
+    subject.executed?.should == false
+  end
+end
+
+describe Syscmd::Command, ".new with -s 'Hello World'" do
+  subject { Syscmd::Command.new(TESTER, '-s', 'Hello World') }
+  
+  it "should have the cmd attribute #{TESTER}" do
+    subject.cmd.should == TESTER
+  end
+  
+  it "should have the command line arguments ['-s', 'Hello World']" do
+    subject.args.should == ['-s', 'Hello World']
+  end
+  
+  it "should have the command line '#{TESTER} -s \"Hello World\"'" do
+    subject.cmdline.should == "#{TESTER} -s \"Hello World\""
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,11 @@
+require 'spec'
+
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+require 'syscmd'
+
+TESTER=File.join(File.dirname(__FILE__), 'tester.rb') unless defined?(TESTER)
+
+Spec::Runner.configure do |config|
+  
+end

data/spec/syscmd_spec.rb

@@ -0,0 +1,20 @@
+require File.join(File.dirname(__FILE__), 'spec_helper')
+require 'spec_helper'
+
+describe Syscmd, ".execute" do
+  subject { Syscmd }
+  
+  it "should provide a .execute method" do
+    subject.should respond_to(:exec!)
+  end
+  
+  it "should return a Syscmd::Command object" do
+    subject.exec!(TESTER).should be_a(Syscmd::Command)
+  end
+  
+  it "should return an executed Syscmd::Command object" do
+    cmd = subject.exec!(TESTER)
+    cmd.executed?.should == true
+  end
+  
+end

data/spec/tester.rb

@@ -0,0 +1,74 @@
+#!/usr/bin/env ruby
+# == Synopsis
+#
+# tester: test script for syscmd
+#
+# == Usage
+#
+# tester [OPTION]
+#
+# OPTIONS:
+#   --help, -h                display this page
+#   --stdout, -s  MSG         echo MSG to stdout
+#   --stdoutrepeat, -S COUNT  print the stdout message COUNT times
+#                             (DEFAULT: 1)
+#   --stderr, -e MSG          echo MSG to stderr
+#   --stderrrepeat, -E COUNT  print the stderr message COUNT times
+#                             (DEFAULT: 1)
+#   --exitcode, -x CODE       return exit code CODE
+#   --debug
+
+require "getoptlong"
+require "rdoc/usage"
+
+opts = GetoptLong.new(
+  [ '--help',         '-h', GetoptLong::NO_ARGUMENT ],
+  [ '--stdout',       '-s', GetoptLong::REQUIRED_ARGUMENT ],
+  [ '--stdoutcount',  '-S', GetoptLong::REQUIRED_ARGUMENT ],
+  [ '--stderr',       '-e', GetoptLong::REQUIRED_ARGUMENT ],
+  [ '--stderrcount',  '-E', GetoptLong::REQUIRED_ARGUMENT ],
+  [ '--exitcode',     '-x', GetoptLong::REQUIRED_ARGUMENT ],
+  [ '--debug',              GetoptLong::OPTIONAL_ARGUMENT ]
+)
+
+options = {}
+exitcode = 0
+
+msg_stdout = nil
+count_stdout = 1
+
+msg_stderr = nil
+count_stderr = 1
+
+opts.each do |opt, arg|
+  case opt
+    when '--help'
+      RDoc::usage
+    when '--stdout'
+      msg_stdout = arg
+    when '--stdoutcount'
+      count_stdout = arg.to_i
+    when '--stderr'
+      msg_stderr = arg
+    when '--stderrcount'
+      count_stderr = arg.to_i
+    when '--exitcode'
+      exitcode = arg.to_i
+    when '--debug'
+      # not yet implemented
+  end
+end
+
+if msg_stdout
+  count_stdout.times do
+    $stdout.print "#{msg_stdout}\n"
+  end
+end
+
+if msg_stderr
+  count_stderr.times do
+    $stderr.print "#{msg_stderr}\n"
+  end
+end
+
+exit exitcode

metadata

@@ -0,0 +1,66 @@
+--- !ruby/object:Gem::Specification 
+name: syscmd
+version: !ruby/object:Gem::Version 
+  version: 0.0.3
+platform: ruby
+authors: 
+- Till Salzer
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-04-18 00:00:00 +02:00
+default_executable: 
+dependencies: []
+
+description: 
+email: till.salzer@googlemail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- README.rdoc
+- LICENSE
+files: 
+- README.rdoc
+- VERSION.yml
+- lib/syscmd/popen.rb
+- lib/syscmd.rb
+- spec/command_exec_spec.rb
+- spec/command_spec.rb
+- spec/spec_helper.rb
+- spec/syscmd_spec.rb
+- spec/tester.rb
+- LICENSE
+has_rdoc: true
+homepage: http://github.com/tsalzer/syscmd
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --inline-source
+- --charset=UTF-8
+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: 
+rubygems_version: 1.3.4
+signing_key: 
+specification_version: 2
+summary: Wrapper for OS command execution
+test_files: []
+