ruby_ex 0.1.1

data/src/commands/runners/exec.rb

@@ -0,0 +1,50 @@
+# Author::    Nicolas Pouillard  <ertai@lrde.epita.fr>.
+# Copyright:: Copyright (c) 2005 Nicolas Pouillard. All rights reserved.
+# License::   GNU General Public License (GPL).
+# Revision::  $Id: exec.rb 255 2005-06-01 00:08:46Z ertai $
+
+require 'commands'
+
+module Commands
+
+  module Runners
+
+    class Exec < Runner
+      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_cmd)
+            end
+            Process.waitpid pid
+          end
+        end
+
+      end # class ExecTest
+
+    end
+
+  end # module Runners
+
+end # module Commands

data/src/commands/runners/fork.rb

@@ -0,0 +1,130 @@
+# Author::    Nicolas Pouillard  <ertai@lrde.epita.fr>.
+# Copyright:: Copyright (c) 2005 Nicolas Pouillard. All rights reserved.
+# License::   GNU General Public License (GPL).
+# Revision::  $Id: fork.rb 255 2005-06-01 00:08:46Z ertai $
+
+require 'commands'
+
+module Commands
+
+  module Runners
+
+    class Fork < Exec
+      concrete
+
+      #
+      # Hooks declaration
+      #
+
+      hook_declare :exception_raised_during_exec
+      hook_declare :already_killed
+      hook_declare :waitpid
+      hook_declare :failure
+      hook_declare :son
+      hook_declare :kill
+
+      #
+      # Methods
+      #
+
+      def run_impl ( aCommand, data )
+        data.pid = Kernel.fork do
+          begin
+            hook_trigger :son, aCommand, data
+            super
+          rescue Exception => ex
+            hook_trigger :exception_raised_during_exec, ex
+          end
+        end
+        hook_trigger :waitpid, data
+        if data.status.nil? or not data.status.exitstatus.zero?
+          hook_trigger :failure, data
+        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.pid
+          end
+        end
+        super
+      end
+
+
+      def exception_raised_during_exec ( anException )
+        STDERR.reopen(File.new(1))
+        STDERR.puts anException
+        exit! 127
+      end
+
+
+      def kill ( data )
+        Process.kill('-KILL', -data.pid)
+      end
+
+
+      def raise_on_failures
+        hooker_subscribe FailureHooker.new
+        self
+      end
+
+    end # class Fork
+
+
+    class FailureHooker
+      class Error < Exception
+      end
+      def failure ( data )
+        output, error = '', ''
+        output = data.output.read rescue nil
+        error = data.error.read rescue nil
+        output.gsub!(/^/, '    ')
+        error.gsub!(/^/, '    ')
+
+        raise Error, <<end
+---
+Command failed:
+  exit: #{data.status.exitstatus}
+  output:
+#{output}
+  error:
+#{error}
+end
+      end
+    end
+
+
+    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_cmd)
+            assert(! tmp.exist?)
+            data.waitpid
+            assert(tmp.exist?)
+          end
+        end
+
+      end # class ForkTest
+
+    end
+
+  end # module Runners
+
+end # module Commands

data/src/commands/runners/runner.rb

@@ -0,0 +1,140 @@
+# Author::    Nicolas Pouillard  <ertai@lrde.epita.fr>.
+# Copyright:: Copyright (c) 2005 Nicolas Pouillard. All rights reserved.
+# License::   GNU General Public License (GPL).
+# Revision::  $Id: runner.rb 255 2005-06-01 00:08:46Z ertai $
+
+require 'commands'
+
+module Commands
+
+  module Runners
+
+    class Runner
+
+      abstract
+
+      include Hookable
+      include Hooker
+
+
+      #
+      # Accessors
+      #
+
+      attr_accessor :command_data_factory
+
+
+      #
+      # Hooks declaration
+      #
+
+      hook_declare :display_command
+      hook_declare :data
+      hook_declare :before_open
+      hook_declare :before_chdir
+      hook_declare :before_exec
+      hook_declare :exec
+
+
+      #
+      # Construction methods.
+      #
+
+      def initialize
+        @command_data_factory = Datas::Factory.new
+        hooker_subscribe self
+      end
+
+
+      #
+      # Methods.
+      #
+
+      def run ( aCommand )
+        unless aCommand.is_a? Commands::Command
+          raise ArgumentError, 'Need a Runner::Command'
+        end
+
+        hook_trigger :display_command, aCommand
+
+        data = @command_data_factory.create
+        data.input = aCommand.input unless aCommand.input.nil?
+        data.output = aCommand.output unless aCommand.output.nil?
+        data.error = aCommand.error unless aCommand.error.nil?
+        hook_trigger :data, aCommand, data
+
+        run_impl(aCommand, data)
+
+        data
+      end
+
+      def run_impl ( aCommand, data )
+        hook_trigger :before_open, data
+        STDIN.reopen(data.input.to_io_for_commands) unless data.input.nil?
+        STDOUT.reopen(data.output.to_io_for_commands) unless data.output.nil?
+        STDERR.reopen(data.error.to_io_for_commands) unless data.error.nil?
+
+        hook_trigger :before_chdir, data
+        Dir.chdir(aCommand.dir) unless aCommand.dir.nil?
+
+        hook_trigger :before_exec, aCommand, data
+        hook_trigger :exec, aCommand, data
+      end
+
+
+      def make_verbose
+        hooker_subscribe VerboseHooker.new
+        self
+      end
+
+
+      def make_debug
+        hooker_subscribe DebugHooker.new
+        self
+      end
+
+      #
+      # Hookers
+      #
+
+      class DebugHooker
+        include Hooker
+
+        def log ( m, *a )
+          STDERR.puts
+          STDERR.puts "#{m}: #{a.inspect}"
+        end
+
+        hook_default_method :log
+
+      end # class DebugHooker
+
+
+      class VerboseHooker
+        include Hooker
+
+        def display_command ( m )
+          STDERR.puts "Running: #{m.to_a.join(' ')}"
+        end
+
+      end # class VerboseHooker
+
+
+    end # class Runner
+
+
+
+    test_section __FILE__ do
+
+      class RunnerTest < Test::Unit::TestCase
+
+        def test_abstract
+          assert_raise(TypeError) { Runner.new }
+        end
+
+      end # class RunnerTest
+    end
+
+  end # module Runners
+
+end # module Commands

data/src/commands/runners/system.rb

@@ -0,0 +1,57 @@
+# Author::    Nicolas Pouillard  <ertai@lrde.epita.fr>.
+# Copyright:: Copyright (c) 2005 Nicolas Pouillard. All rights reserved.
+# License::   GNU General Public License (GPL).
+# Revision::  $Id: system.rb 255 2005-06-01 00:08:46Z ertai $
+
+require 'commands'
+
+module Commands
+
+  module Runners
+
+    class WaitpidHooker
+      include Hooker
+
+      def waitpid ( data )
+        data.waitpid
+      end
+    end
+
+
+    # This version wait to reach the end of the command before returns.
+    class System < Fork
+      concrete
+
+      hooker_subscribe WaitpidHooker.new
+
+    end # class System
+
+
+
+    test_section __FILE__ do
+
+      class SystemTest < Test::Unit::TestCase
+
+        def setup
+          assert_nothing_raised { @runner = System.new }
+        end
+
+        def test_0_initialize
+        end
+
+        def test_simple
+          TempPath.new do |tmp|
+            cmd = %Q[ruby -e "sleep 0.5
+                              File.open('#{tmp}', 'w') { |f| f.puts :foo }"]
+            @runner.run(cmd.to_cmd)
+            assert(tmp.exist?)
+          end
+        end
+
+      end # class SystemTest
+
+    end
+
+  end # module Runners
+
+end # module Commands

data/src/commands/seq.rb

@@ -0,0 +1,32 @@
+# Author::    Nicolas Pouillard  <ertai@lrde.epita.fr>.
+# Copyright:: Copyright (c) 2005 Nicolas Pouillard. All rights reserved.
+# License::   GNU General Public License (GPL).
+# Revision::  $Id: seq.rb 255 2005-06-01 00:08:46Z ertai $
+
+require 'commands'
+
+module Commands
+
+  class Seq < Command
+
+    def initialize ( *cmds )
+      @cmds = cmds
+    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

data/src/config_file.rb

@@ -0,0 +1,95 @@
+# Copyright: Copyright (c) 2004  Nicolas Despres. All rights reserved.
+# Author: Nicolas Despres  <polrop@lrde.epita.fr>.
+# License: Gnu General Public License.
+
+# $LastChangedBy: ertai $
+# $Id: config_file.rb 266 2005-06-01 14:27:18Z ertai $
+
+
+require 'ruby_ex'
+require 'pathname'
+require 'yaml'
+require 'delegate'
+
+
+class ConfigFile < SimpleDelegator
+
+  protected :__setobj__
+
+  class FormatError < RuntimeError; end
+
+  attr_reader :default_config
+
+  def initialize(filename, default_config=nil)
+    @filename = Pathname.new(filename)
+    @default_config = default_config.freeze
+    __load__
+  end
+
+  def __load__(&block)
+    config = nil
+    if @filename.exist?
+      @filename.open do |f|
+        f.flock(File::LOCK_EX)
+        config = real_load(f)
+        f.flock(File::LOCK_UN)
+      end
+      block ? block[config] : check_config(config)
+      config.freeze
+    else
+      if $VERBOSE
+        Kernel.warn('warning: use default configuration because no ' +
+                    'configuration file has been found')
+      end
+      config = @default_config
+    end
+    __setobj__(config)
+  end
+
+  # Raise a FormatError if the loaded configuration do not fit the format
+  protected
+  def check_config(config)
+  end
+
+  # You can override it to change arguments or Yaml parsing command.
+  protected
+  def real_load(io)
+    YAML::load(io)
+  end
+
+
+end # class ConfigFile
+
+
+test_section __FILE__ do
+
+require 'tempfile'
+
+
+class ConfigFileTest < Test::Unit::TestCase
+
+  def test_config_file
+    tmp_file = nil
+    Tempfile.open('config_file') do |f|
+      f.puts '---'
+      f.puts 'key1: val1'
+      f.puts 'key2: val2'
+      tmp_file = f
+    end
+    raise 'no temp file' if tmp_file.nil?
+    default_config = { 'key1' => 'def1', 'key2' => 'def2' }
+    config_file = ConfigFile.new('/toto', default_config)
+    assert_equal(default_config, config_file.__getobj__)
+    assert_raises(NoMethodError) { config_file.__setobj__(nil) }
+    config_file = ConfigFile.new(tmp_file.path, default_config)
+    assert_equal({ 'key1' => 'val1', 'key2' => 'val2' },
+                 config_file.__getobj__)
+    assert(config_file.__getobj__.frozen?)
+  end
+
+end # class ConfigFileTest
+
+
+end
+
+