objective_command 0.1.5.0

data/lib/objective_command/commands/seq.rb

@@ -0,0 +1,35 @@
+# Author::    Nicolas Pouillard  <ertai@lrde.epita.fr>.
+# Copyright:: Copyright (c) 2005, 2006 Nicolas Pouillard. All rights reserved.
+# License::   GNU General Public License (GPL).
+# Revision::  $Id: /w/fey/cmd/trunk/lib/objective_command/commands/seq.rb 22684 2006-03-12T16:36:11.301558Z pouillar  $
+
+module ObjectiveCommand
+
+  module Commands
+
+    class Seq < Command
+
+      def initialize ( *cmds )
+        @cmds = cmds
+        @input, @output, @error = nil, nil, nil
+      end
+
+      def run ( *a )
+        datas = []
+        @cmds.each do |cmd|
+          datas.last.waitpid unless datas.empty?
+          datas << cmd.run(*a)
+        end
+        Datas::Composite.new(datas)
+      end
+
+      def to_sh
+        strs = @cmds.map { |cmd| "(#{cmd.to_sh})" }
+        "(#{strs.join(' ; ')})#{sh_args}"
+      end
+
+    end # class Seq
+
+  end # module Commands
+
+end # module ObjectiveCommand

data/lib/objective_command/datas/composite.rb

@@ -0,0 +1,55 @@
+# Author::    Nicolas Pouillard  <ertai@lrde.epita.fr>.
+# Copyright:: Copyright (c) 2005, 2006 Nicolas Pouillard. All rights reserved.
+# License::   GNU General Public License (GPL).
+# Revision::  $Id: /w/fey/cmd/trunk/lib/objective_command/datas/composite.rb 22684 2006-03-12T16:36:11.301558Z pouillar  $
+
+module ObjectiveCommand
+
+  module Datas
+
+    class Composite < self::Data
+
+      attr_accessor :contents
+
+      def initialize ( *contents )
+        super()
+        @contents = contents.flatten
+      end
+
+      def each ( &block )
+        @contents.each(&block)
+      end
+
+      def waitpid
+        each { |x| x.waitpid }
+      end
+
+      def kill ( *a, &b )
+        each { |x| x.kill(*a, &b) }
+      end
+
+      def << ( data )
+        @contents << data
+      end
+
+      def status
+        @contents.last.status
+      end
+
+      def output
+        @contents.last.output
+      end
+
+      def error
+        @contents.last.error
+      end
+
+      def input
+        @contents.first.input
+      end
+
+    end # class Composite
+
+  end # module Datas
+
+end # module ObjectiveCommand

data/lib/objective_command/datas/data.rb

@@ -0,0 +1,175 @@
+# Author::    Nicolas Pouillard  <ertai@lrde.epita.fr>.
+# Copyright:: Copyright (c) 2005, 2006 Nicolas Pouillard. All rights reserved.
+# License::   GNU General Public License (GPL).
+# Revision::  $Id: /w/fey/cmd/trunk/lib/objective_command/datas/data.rb 24389 2006-07-09T20:37:31.813443Z ertai  $
+
+module ObjectiveCommand
+
+  module Datas
+
+    #
+    # A CommandData instance contains all information returned by a Command#run:
+    #
+    #   * It's exit status:
+    #     - Exit number.
+    #     - Signals
+    #     - ...
+    #
+    #   * It's outputs:
+    #     - What it writes on stdout.
+    #     - stderr.
+    class Data
+
+      attr_accessor :pid
+      attr_reader   :input
+      attr_reader   :output
+      attr_reader   :error
+      attr_accessor :status
+      attr_reader   :open_mode
+
+      @@datas ||= Set.new
+
+      def initialize
+        @open_mode = :w
+        @status, @pid = nil, nil
+        @@datas << self
+      end
+
+
+      def waitpid
+        return @status unless @status.nil?
+        return if @pid.nil?
+        Process.waitpid(@pid)
+        @status = $?
+        @@datas.delete(self)
+        self
+      end
+
+
+      def | ( rhs ) # FIXME CHECK ME
+        raise unless rhs.is_a? Commands::Command
+        case output
+        when Pathname then rhs < output
+        when File     then rhs < output.path.to_path
+        else raise "Unexpected class #{rhs.class}"
+        end
+      end
+
+
+      def method_missing ( meth, *a, &b )
+        if output.respond_to?(meth)
+          output.send(meth, *a, &b)
+        else
+          super
+        end
+      end
+
+
+      def display ( out=STDOUT, err=STDERR )
+        waitpid
+        out.print @output.read
+        err.print @error.read
+      end
+
+      def input= ( anObject )
+        if anObject.is_a? Pathname
+          anObject = anObject.dup
+          anObject.open_mode = :r
+        end
+        @input = anObject
+      end
+
+      def output= ( anObject )
+        if anObject.is_a? Pathname
+          anObject = anObject.dup
+          anObject.open_mode = @open_mode
+        end
+        @output = anObject
+      end
+
+
+      def error= ( anObject )
+        if anObject.is_a? Pathname
+          anObject = anObject.dup
+          anObject.open_mode = @open_mode
+        end
+        @error = anObject
+      end
+
+
+      def open_mode= ( mode )
+        raise ArgumentError, "bad mode #{mode} need :w or :a" if mode == :r
+        @open_mode = mode
+      end
+
+      def exit
+        if status.signaled?
+          128 + status.termsig # Common exit status returned by sh
+        else
+          status.exitstatus
+        end
+      end
+
+      have YamlExtension, :'commands::data'
+
+      def to_yaml_string
+        suppress(IOError) { out = output.read }
+        suppress(IOError) { err = error.read }
+        out ||= ''
+        err ||= ''
+
+        msg = []
+        msg << "exit: #{status.exitstatus}" unless status.nil?
+        unless out.empty?
+          out.gsub!(/^/, '    ')
+          msg << "output: |\n  #{out}"
+        end
+        unless err.empty?
+          err.gsub!(/^/, '    ')
+          msg << "error: |\n  #{err}"
+        end
+        "\n" + msg.join("\n")
+      end
+
+      def kill ( sig='KILL' )
+        Process.kill sig, @pid if @status.nil? and not @pid.nil?
+        waitpid
+      end
+
+      def clean
+        return unless @status.nil?
+        return if @pid.nil?
+        if Process.waitpid(@pid, Process::WNOHANG)
+          @status = $?
+          @@datas.delete(self)
+        else
+          kill
+        end
+        [input, output, error].each do |stream|
+          next if stream.nil? or stream.is_a? IO
+          if stream.is_a? File
+            stream.close unless stream.closed?
+            stream = stream.path.to_path
+          end
+          if stream.is_a? Pathname
+            stream.unlink if stream.exist? and stream.temp?
+          elsif stream.is_a? String
+          elsif stream.respond_to? :clean
+            stream.clean
+          else
+            raise ArgumentError, "must at least respond to :clean (#{stream})"
+          end
+        end
+      end
+
+      def self.clean_all
+        @@datas.dup.each { |data| data.clean }
+      end
+
+      at_exit { clean_all }
+
+    end # class Data
+
+  end # module Datas
+
+end # module ObjectiveCommand

data/lib/objective_command/datas/factory.rb

@@ -0,0 +1,74 @@
+# Author::    Nicolas Pouillard  <ertai@lrde.epita.fr>.
+# Copyright:: Copyright (c) 2005, 2006 Nicolas Pouillard. All rights reserved.
+# License::   GNU General Public License (GPL).
+# Revision::  $Id: /w/fey/cmd/trunk/lib/objective_command/datas/factory.rb 22684 2006-03-12T16:36:11.301558Z pouillar  $
+
+module ObjectiveCommand
+
+  module Datas
+
+    class Factory < self::Data
+
+      attr_accessor :command_data_class
+
+      def initialize ( values={}, *a, &b )
+        super(*a, &b)
+        values.each do |k, v|
+          send("#{k}=", v)
+        end
+        @command_data_class ||= Temp
+      end
+
+      def new_command_data ( *a, &b )
+        data = @command_data_class.new(*a, &b)
+        instance_variables.each do |var|
+          next if var == '@command_data_class'
+          next if var =~ /^@__/
+          val = instance_variable_get(var)
+          data.send(var[1..-1] + '=', val) unless val.nil?
+        end
+        data
+      end
+
+      def create ( *a, &b )
+        new_command_data(*a, &b)
+      end
+
+    end # class Factory
+
+
+
+
+    test_section __FILE__ do
+
+      class FactoryTest < Test::Unit::TestCase
+
+        def setup
+          assert_nothing_raised { @fa = Factory.new }
+        end
+
+        def test_0_initialize
+        end
+
+        def test_new_command_data
+          assert_nothing_raised do
+            assert_kind_of(Data, @fa.create)
+            assert_kind_of(Data, @fa.new_command_data)
+          end
+        end
+
+        def test_simple
+          assert_nothing_raised do
+            @fa.pid = 42
+            @data = @fa.create
+          end
+          assert_equal(42, @data.pid)
+        end
+
+      end # class FactoryTest
+
+    end
+
+  end # module Datas
+
+end # module ObjectiveCommand

data/lib/objective_command/datas/pipe.rb

@@ -0,0 +1,55 @@
+# Author::    Nicolas Pouillard  <ertai@lrde.epita.fr>.
+# Copyright:: Copyright (c) 2005, 2006 Nicolas Pouillard. All rights reserved.
+# License::   GNU General Public License (GPL).
+# Revision::  $Id: /w/fey/cmd/trunk/lib/objective_command/datas/pipe.rb 24389 2006-07-09T20:37:31.813443Z ertai  $
+
+class IOPipe
+  attr_accessor :reader, :writer, :open_mode
+  def initialize
+    @reader, @writer = IO.pipe
+    @open_mode = :w
+  end
+  def open ( mode=:r )
+    case mode.to_sym
+      when :r
+        @writer.close
+        @reader
+      when :w
+        @reader.close
+        @writer
+      else raise ArgumentError, "Bad open mode: #{mode.inspect}"
+    end
+  end
+  def close
+    @reader.close unless @reader.closed?
+    @writer.close unless @writer.closed?
+  end
+  alias_method :clean, :close
+  def to_io_for_ocmd
+    open(open_mode)
+  end
+  def each_line &block
+    open.each_line(&block)
+  end
+  def read
+    open.read
+  end
+end
+
+module ObjectiveCommand
+
+  module Datas
+
+    class Pipe < self::Data
+
+      def initialize ( *a, &b )
+        super
+        @output = IOPipe.new
+        @error = IOPipe.new
+      end
+
+    end # class Pipe
+
+  end # module Datas
+
+end # module ObjectiveCommand

data/lib/objective_command/datas/temp.rb

@@ -0,0 +1,24 @@
+# Author::    Nicolas Pouillard  <ertai@lrde.epita.fr>.
+# Copyright:: Copyright (c) 2005, 2006 Nicolas Pouillard. All rights reserved.
+# License::   GNU General Public License (GPL).
+# Revision::  $Id: /w/fey/cmd/trunk/lib/objective_command/datas/temp.rb 22684 2006-03-12T16:36:11.301558Z pouillar  $
+
+module ObjectiveCommand
+
+  module Datas
+
+    class Temp < self::Data
+
+      def initialize ( *a, &b )
+        super
+        @output = TempPath.new('cmd-output')
+        @output.open_mode = :w
+        @error = TempPath.new('cmd-error')
+        @error.open_mode = :w
+      end
+
+    end # class Temp
+
+  end # module Datas
+
+end # module ObjectiveCommand

data/lib/objective_command/datas.rb

@@ -0,0 +1,11 @@
+# Author::    Nicolas Pouillard  <ertai@lrde.epita.fr>.
+# Copyright:: Copyright (c) 2005, 2006 Nicolas Pouillard. All rights reserved.
+# License::   GNU General Public License (GPL).
+# Revision::  $Id: /w/fey/cmd/trunk/lib/objective_command/datas.rb 22684 2006-03-12T16:36:11.301558Z pouillar  $
+
+module ObjectiveCommand
+
+  module Datas
+  end # module Datas
+
+end # module ObjectiveCommand

data/lib/objective_command/helpers.rb

@@ -0,0 +1,113 @@
+# Author::    Nicolas Pouillard  <ertai@lrde.epita.fr>.
+# Copyright:: Copyright (c) 2005, 2006 Nicolas Pouillard. All rights reserved.
+# License::   GNU General Public License (GPL).
+# Revision::  $Id: /w/fey/cmd/trunk/lib/objective_command/helpers.rb 53907 2007-01-13T18:40:33.521685Z ertai  $
+
+require 'shellwords'
+
+module ObjectiveCommand
+
+  module Helpers
+
+    class ::Object
+
+      def to_io_for_ocmd
+        to_io
+      end
+
+      def to_ocmd_args
+        [self]
+      end
+
+    end
+
+
+    class ::String
+
+      #
+      # Make a command from a String.
+      #
+      # Split your command using the Shellwords module.
+      #
+      def to_ocmd
+        Shellwords.shellwords(self).to_ocmd
+      end
+
+      def to_io_for_ocmd
+        tmp = TempPath.new
+        tmp.open('w') { |f| f.write self }
+        tmp.to_io_for_ocmd
+      end
+
+      def to_ocmd_args
+        Shellwords.shellwords(self)
+      end
+
+      def to_sh
+        (self =~ /[^-\w:_\/\.@]/)? dump : self
+      end
+
+    end # class ::String
+
+
+    class ::Array
+
+      def to_ocmd
+        ObjectiveCommand::Commands::Command.new(*self)
+      end
+
+      def to_ocmd_args
+        dup
+      end
+
+    end # class ::Array
+
+
+    class ::Pathname
+
+      def to_ocmd
+        to_s.to_ocmd
+      end
+
+      def to_ocmd_args
+        to_s.to_ocmd_args
+      end
+
+    end # class ::Pathname
+
+
+    class ::NilClass
+
+      def to_ocmd_args
+        []
+      end
+
+    end # class ::NilClass
+
+
+  end # module Helpers
+
+  test_section __FILE__ do
+
+    class HelpersTest < Test::Unit::TestCase
+
+      def test_string_to_ocmd
+        assert_equal(['foo', 'bar'], "foo bar".to_ocmd.to_a)
+
+        assert_equal(['foo', 'b/ar', 'qu44x32'],
+                     "foo b/ar \t \n  qu44x32".to_ocmd.to_a)
+
+        s = "foo 'b/ar \t' \n  qu44x32"
+        assert_equal(["foo", "b/ar \t", "qu44x32"], s.to_ocmd.to_a)
+      end
+
+      def test_array_to_ocmd
+        a = ['foo', "b/ar \t", "\n  qu44x32"]
+        assert_equal(a, a.to_ocmd.to_a)
+      end
+
+    end # class HelpersTest
+
+  end
+
+end # module ObjectiveCommand

data/lib/objective_command/runners/exec.rb

@@ -0,0 +1,46 @@
+# Author::    Nicolas Pouillard  <ertai@lrde.epita.fr>.
+# Copyright:: Copyright (c) 2005, 2006 Nicolas Pouillard. All rights reserved.
+# License::   GNU General Public License (GPL).
+# Revision::  $Id: /w/fey/cmd/trunk/lib/objective_command/runners/exec.rb 23187 2006-03-31T21:59:37.612710Z ertai  $
+
+module ObjectiveCommand
+
+  module Runners
+
+    class Exec < Runner
+      make Concrete
+
+      def exec ( aCommand, data )
+        Kernel.exec(*aCommand.to_a)
+      end
+
+    end # class Exec
+
+    test_section __FILE__ do
+
+      class ExecTest < Test::Unit::TestCase
+
+        def setup
+          assert_nothing_raised { @runner = Exec.new }
+        end
+
+        def test_0_initialize
+        end
+
+        def test_simple
+          TempPath.new do |tmp|
+            cmd = %Q[ruby -e "File.open('#{tmp}', 'w') { |f| f.puts :foo }"]
+            pid = fork do
+              @runner.run(cmd.to_ocmd)
+            end
+            Process.waitpid pid
+          end
+        end
+
+      end # class ExecTest
+
+    end
+
+  end # module Runners
+
+end # module ObjectiveCommand

data/lib/objective_command/runners/fork.rb

@@ -0,0 +1,91 @@
+# Author::    Nicolas Pouillard  <ertai@lrde.epita.fr>.
+# Copyright:: Copyright (c) 2005, 2006 Nicolas Pouillard. All rights reserved.
+# License::   GNU General Public License (GPL).
+# Revision::  $Id: /w/fey/cmd/trunk/lib/objective_command/runners/fork.rb 24389 2006-07-09T20:37:31.813443Z ertai  $
+
+module ObjectiveCommand
+
+  module Runners
+
+    class Fork < Exec
+      make Concrete
+
+      #
+      # Methods
+      #
+
+      def fork data, &block
+        data.pid = Kernel.fork do
+          TempPath.fork_init true
+          block.call
+        end
+      end
+
+
+      def abort ( data )
+        if data.pid
+          begin
+            hook_trigger :kill, data
+            hook_trigger :waitpid, data
+          rescue Errno::ESRCH
+            hook_trigger :already_killed, data
+          end
+        end
+      end
+
+
+      def exception_raised_during_exec ( anException )
+        STDERR.reopen(File.new(1))
+        STDERR.puts anException
+        exit! 127
+      end
+
+
+      def kill ( data )
+        data.kill
+      end
+
+
+      def failure command, data
+        if data.status and data.status.signaled?
+          data.status.instance_eval { @exitstatus = 134 }
+        end
+      end
+
+
+      def before_exec ( command, data )
+        TempPath.clean
+      end
+
+    end # class Fork
+
+
+    test_section __FILE__ do
+
+      class ForkTest < Test::Unit::TestCase
+
+        def setup
+          assert_nothing_raised { @runner = Fork.new }
+        end
+
+        def test_0_initialize
+        end
+
+        def test_simple
+          TempPath.new do |tmp|
+            cmd = %Q[ruby -e "sleep 1
+                              File.open('#{tmp}', 'w') { |f| f.puts :foo }"]
+            data = @runner.run(cmd.to_ocmd)
+            assert(! tmp.exist?)
+            data.waitpid
+            assert(tmp.exist?)
+          end
+        end
+
+      end # class ForkTest
+
+    end
+
+  end # module Runners
+
+end # module ObjectiveCommand