RDI 0.1.0.20091020

data/lib/rdi/Plugins/ContextModifiers/RubyLoadPath.rb

@@ -0,0 +1,76 @@
+#--
+# Copyright (c) 2009 Muriel Salvan (murielsalvan@users.sourceforge.net)
+# Licensed under the terms specified in LICENSE file. No warranty is provided.
+#++
+
+require 'rdi/Model/ContextModifier'
+
+module RDI
+
+  module ContextModifiers
+
+    class RubyLoadPath < RDI::Model::ContextModifier
+
+      # Get the name of classes that provide selection facility for locations
+      #
+      # Return:
+      # * _String_: The name of the LocationSelector class
+      def getLocationSelectorName
+        return 'Directory'
+      end
+
+      # Transform a given content based on an installation environment.
+      # This is called to pass some specific installation parameters to a more generic content (useful for installation directories for example)
+      #
+      # Parameters:
+      # * *iLocation* (_Object_): Location to transform
+      # * *iInstallEnv* (<em>map<Symbol,Object></em>): The installation environment that called this context modification
+      # Return:
+      # * _Object_: The location transformed with the installation environment
+      def transformContentWithInstallEnv(iLocation, iInstallEnv)
+        rNewLocation = iLocation
+
+        lInstallDir = iInstallEnv[:InstallDir]
+        if (lInstallDir != nil)
+          rNewLocation = iLocation.gsub(/%INSTALLDIR%/, lInstallDir)
+        end
+
+        return rNewLocation
+      end
+
+      # Is a given location present in the context ?
+      #
+      # Parameters:
+      # * *iLocation* (_Object_): Location to add
+      # Return:
+      # * _Boolean_: Is the location already present ?
+      def isLocationInContext?(iLocation)
+        # * *iLocation* (_String_): Directory
+        return $LOAD_PATH.include?(iLocation)
+      end
+
+      # Add a given location to the context
+      #
+      # Parameters:
+      # * *iLocation* (_Object_): Location to add
+      def addLocationToContext(iLocation)
+        # * *iLocation* (_String_): Directory
+        $LOAD_PATH << iLocation
+      end
+
+      # Remove a given location from the context
+      #
+      # Parameters:
+      # * *iLocation* (_Object_): Location to remove
+      def removeLocationFromContext(iLocation)
+        # * *iLocation* (_String_): Directory
+        $LOAD_PATH.delete_if do |iLoadDir|
+          (iLoadDir == iLocation)
+        end
+      end
+
+    end
+
+  end
+
+end

data/lib/rdi/Plugins/ContextModifiers/SystemPath.rb

@@ -0,0 +1,74 @@
+#--
+# Copyright (c) 2009 Muriel Salvan (murielsalvan@users.sourceforge.net)
+# Licensed under the terms specified in LICENSE file. No warranty is provided.
+#++
+
+require 'rdi/Model/ContextModifier'
+
+module RDI
+
+  module ContextModifiers
+
+    class SystemPath < RDI::Model::ContextModifier
+
+      # Get the name of classes that provide selection facility for locations
+      #
+      # Return:
+      # * _String_: The name of the LocationSelector class
+      def getLocationSelectorName
+        return 'Directory'
+      end
+
+      # Transform a given content based on an installation environment.
+      # This is called to pass some specific installation parameters to a more generic content (useful for installation directories for example)
+      #
+      # Parameters:
+      # * *iLocation* (_Object_): Location to transform
+      # * *iInstallEnv* (<em>map<Symbol,Object></em>): The installation environment that called this context modification
+      # Return:
+      # * _Object_: The location transformed with the installation environment
+      def transformContentWithInstallEnv(iLocation, iInstallEnv)
+        rNewLocation = iLocation
+
+        lInstallDir = iInstallEnv[:InstallDir]
+        if (lInstallDir != nil)
+          rNewLocation = iLocation.gsub(/%INSTALLDIR%/, lInstallDir)
+        end
+
+        return rNewLocation
+      end
+
+      # Is a given location present in the context ?
+      #
+      # Parameters:
+      # * *iLocation* (_Object_): Location to add
+      # Return:
+      # * _Boolean_: Is the location already present ?
+      def isLocationInContext?(iLocation)
+        # * *iLocation* (_String_): Directory
+        return $rUtilAnts_Platform_Info.getSystemExePath.include?(iLocation)
+      end
+
+      # Add a given location to the context
+      #
+      # Parameters:
+      # * *iLocation* (_Object_): Location to add
+      def addLocationToContext(iLocation)
+        # * *iLocation* (_String_): Directory
+        $rUtilAnts_Platform_Info.setSystemExePath($rUtilAnts_Platform_Info.getSystemExePath + [ iLocation ])
+      end
+
+      # Remove a given location from the context
+      #
+      # Parameters:
+      # * *iLocation* (_Object_): Location to remove
+      def removeLocationFromContext(iLocation)
+        # * *iLocation* (_String_): Directory
+        $rUtilAnts_Platform_Info.setSystemExePath($rUtilAnts_Platform_Info.getSystemExePath - [ iLocation ])
+      end
+
+    end
+
+  end
+
+end

data/lib/rdi/Plugins/GemCommon.rb

@@ -0,0 +1,127 @@
+#--
+# Copyright (c) 2009 Muriel Salvan (murielsalvan@users.sourceforge.net)
+# Licensed under the terms specified in LICENSE file. No warranty is provided.
+#++
+
+module Gem
+
+  class GemPathList < Array
+
+    # Add a path to the list
+    #
+    # Parameters:
+    # * *iDirName* (_String_): Directory to add to the list
+    def <<(iDirName)
+      # Add the path for real in the internals
+      super
+      # Add the lib directory if it is already initialized
+      if ((defined?(@LibDirs) != nil) and
+          (@LibDirs != nil))
+        Dir.glob("#{iDirName}/gems/*").each do |iGemDirName|
+          if (File.exists?("#{iGemDirName}/lib"))
+            @LibDirs << iGemDirName
+          end
+        end
+      end
+      # Add the path in RubyGems
+      Gem.path_ORG << iDirName
+    end
+
+    # Get the list of lib directories accessible through the paths
+    #
+    # Return:
+    # * <em>list<String></em>: List of paths
+    def getLibDirs
+      if ((defined?(@LibDirs) == nil) or
+          (@LibDirs == nil))
+        # Create it
+        @LibDirs = []
+        each do |iGemsDirName|
+          Dir.glob("#{iGemsDirName}/gems/*").each do |iGemDirName|
+            if (File.exists?("#{iGemDirName}/lib"))
+              @LibDirs << iGemDirName
+            end
+          end
+        end
+      end
+
+      return @LibDirs
+    end
+
+    # Clear the paths
+    def clear_paths
+      Gem.clear_paths_ORG
+      # Reset our cache with the new paths
+      replace(Gem.path_ORG)
+      @LibDirs = nil
+    end
+
+    # Clear the cache
+    def clearCache
+      @LibDirs = nil
+    end
+
+  end
+
+  $RDI_GemPath_Cache = GemPathList.new(Gem.path)
+
+  # Alias the old class methods
+  class << self
+    alias :find_files_ORG :find_files
+    remove_method :find_files
+    alias :path_ORG :path
+    remove_method :path
+    alias :clear_paths_ORG :clear_paths
+    remove_method :clear_paths
+  end
+
+  # Return the list of files matching a Ruby require
+  #
+  # Parameters:
+  # * *iRequireName* (_String_): Name to require
+  # Return:
+  # * <em>list<String></em>: File names list
+  def self.find_files(iRequireName)
+    rFilesList = []
+
+    lRequireGlob = iRequireName
+    if (File.extname(iRequireName).empty?)
+      # Look using globs of any extension
+      lRequireGlob = "#{iRequireName}.{rb,so,o,sl,dll}"
+    end
+    # 1. Look through Ruby LOAD PATH and the cache
+    ($LOAD_PATH + $RDI_GemPath_Cache.getLibDirs).each do |iLibDir|
+      lList = Dir.glob("#{iLibDir}/#{lRequireGlob}")
+      if (!lList.empty?)
+        rFilesList = lList
+        break
+      end
+    end
+    # 3. Ask RubyGems for real
+    if (rFilesList.empty?)
+      rFilesList = Gem.find_files_ORG(iRequireName)
+    end
+
+    return rFilesList
+  end
+
+  # Return the list of Gem paths
+  #
+  # Return:
+  # * <em>list<String></em>: List of Gem paths
+  def self.path
+    return $RDI_GemPath_Cache
+  end
+
+  # Clear the paths
+  def self.clear_paths
+    $RDI_GemPath_Cache.clear_paths
+  end
+
+  # Clear the library cache
+  # This is useful to ensure usecase tests isolation
+  def self.clearCache_RDI
+    $RDI_GemPath_Cache.clearCache
+  end
+
+end

data/lib/rdi/Plugins/Installers/Download.rb

@@ -0,0 +1,72 @@
+#--
+# Copyright (c) 2009 Muriel Salvan (murielsalvan@users.sourceforge.net)
+# Licensed under the terms specified in LICENSE file. No warranty is provided.
+#++
+
+require 'rdi/Model/Installer'
+
+module RDI
+
+  module Installers
+
+    class Download < RDI::Model::Installer
+
+      # Get the list of possible destinations
+      #
+      # Return:
+      # * <em>list<[Integer,Object]></em>: The list of possible destinations and their corresponding installation location (or location selector name for DEST_OTHER)
+      def getPossibleDestinations
+        return [
+          [ DEST_LOCAL, "#{@Installer.ExtDir}/Downloads" ],
+          [ DEST_SYSTEM, @Installer.SystemDir ],
+          [ DEST_USER, @Installer.UserDir ],
+          [ DEST_TEMP, @Installer.TempDir ],
+          [ DEST_OTHER, 'Directory' ]
+        ]
+      end
+
+      # Install a dependency
+      #
+      # Parameters:
+      # * *iContent* (_Object_): The dependency's content
+      # * *iLocation* (_Object_): The installation location
+      # * *ioInstallEnv* (<em>map<Symbol,Object></em>): The installed environment, that can be modified here. Stored variables will the be accessible to ContextModifiers. [optional = {}]
+      # Return:
+      # * _Exception_: The error, or nil in case of success
+      def installDependency(iContent, iLocation, ioInstallEnv = {})
+        # * *iContent* (_String_): The URL
+        # * *iLocation* (_String_): The directory to install to
+        rError = nil
+
+        # Download the URL
+        # The URL can be a zip file, a targz, a direct file ...
+        # Don't use URL caching.
+        accessFile(iContent, { :LocalFileAccess => true }) do |iLocalFileName, iBaseName|
+          case File.extname(iLocalFileName).upcase
+          when '.ZIP'
+            # Unzip before
+            rError = extractZipFile(iLocalFileName, iLocation)
+            if (rError != nil)
+              rError = RuntimeError.new("Error while unzipping from #{iLocalFileName} to #{iLocation}:\n#{rError}")
+            end
+          # TODO: Handle targz, bz...
+          else
+            # Just copy
+            begin
+              FileUtils::mkdir_p(iLocation)
+              FileUtils::cp(iLocalFileName, "#{iLocation}/#{File.basename(iLocalFileName)}")
+            rescue Exception
+              rError = $!
+            end
+          end
+          ioInstallEnv[:InstallDir] = iLocation
+        end
+
+        return rError
+      end
+
+    end
+
+  end
+
+end

data/lib/rdi/Plugins/Installers/DownloadAndInstall.desc.rb

@@ -0,0 +1,11 @@
+#--
+# Copyright (c) 2009 Muriel Salvan (murielsalvan@users.sourceforge.net)
+# Licensed under the terms specified in LICENSE file. No warranty is provided.
+#++
+
+{
+  :PluginsDependencies => [
+    # We depend on the Download dependency
+    [ 'Installers', 'Download' ]
+  ]
+}

data/lib/rdi/Plugins/Installers/DownloadAndInstall.rb

@@ -0,0 +1,54 @@
+#--
+# Copyright (c) 2009 Muriel Salvan (murielsalvan@users.sourceforge.net)
+# Licensed under the terms specified in LICENSE file. No warranty is provided.
+#++
+
+require 'rdi/Model/Installer'
+
+module RDI
+
+  module Installers
+
+    class DownloadAndInstall < RDI::Installers::Download
+
+      # Install a dependency
+      #
+      # Parameters:
+      # * *iContent* (_Object_): The dependency's content
+      # * *iLocation* (_Object_): The installation location
+      # * *ioInstallEnv* (<em>map<Symbol,Object></em>): The installed environment, that can be modified here. Stored variables will the be accessible to ContextModifiers. [optional = {}]
+      # Return:
+      # * _Exception_: The error, or nil in case of success
+      def installDependency(iContent, iLocation, ioInstallEnv = {})
+        # * *iContent* (<em>[String,Proc]</em>): The URL and the code to install
+        # * *iLocation* (_String_): The directory to install to
+        rError = nil
+
+        iURL, iCmdProc = iContent
+        # First we download in a temp directory
+        lTmpDir = "#{@Installer.TempDir}/DlAndInst"
+        require 'fileutils'
+        FileUtils::mkdir_p(lTmpDir)
+        rError = super(iURL, lTmpDir)
+        if (rError == nil)
+          # And then we execute the command to install it
+          lOldDir = Dir.getwd
+          Dir.chdir(lTmpDir)
+          if (iCmdProc.call(iLocation))
+            # Remove temporary directory
+            FileUtils::rm_rf(lTmpDir)
+            ioInstallEnv[:InstallDir] = iLocation
+          else
+            rError = RuntimeError.new('Installation code failed')
+          end
+          Dir.chdir(lOldDir)
+        end
+
+        return rError
+      end
+
+    end
+
+  end
+
+end

data/lib/rdi/Plugins/Installers/Gem.desc.rb

@@ -0,0 +1,13 @@
+#--
+# Copyright (c) 2009 Muriel Salvan (murielsalvan@users.sourceforge.net)
+# Licensed under the terms specified in LICENSE file. No warranty is provided.
+#++
+
+require 'rdi/Plugins/RubyGemsDepDesc'
+
+{
+  :Dependencies => [
+    # RubyGems
+    ::RDI::getRubyGemsDepDesc
+  ]
+}

data/lib/rdi/Plugins/Installers/Gem.rb

@@ -0,0 +1,67 @@
+#--
+# Copyright (c) 2009 Muriel Salvan (murielsalvan@users.sourceforge.net)
+# Licensed under the terms specified in LICENSE file. No warranty is provided.
+#++
+
+require 'rdi/Model/Installer'
+
+module RDI
+
+  module Installers
+
+    class Gem < RDI::Model::Installer
+
+      # Get the list of possible destinations
+      #
+      # Return:
+      # * <em>list<[Integer,Object]></em>: The list of possible destinations and their corresponding installation location (or location selector name for DEST_OTHER)
+      def getPossibleDestinations
+        return [
+          [ DEST_LOCAL, "#{@Installer.ExtDir}/LocalGems" ],
+          [ DEST_SYSTEM, ::Gem.dir ],
+          [ DEST_USER, ::Gem.user_dir ],
+          [ DEST_TEMP, @Installer.TempDir ],
+          [ DEST_OTHER, 'Directory' ]
+        ]
+      end
+
+      # Install a dependency
+      #
+      # Parameters:
+      # * *iContent* (_Object_): The dependency's content
+      # * *iLocation* (_Object_): The installation location
+      # * *ioInstallEnv* (<em>map<Symbol,Object></em>): The installed environment, that can be modified here. Stored variables will the be accessible to ContextModifiers. [optional = {}]
+      # Return:
+      # * _Exception_: The error, or nil in case of success
+      def installDependency(iContent, iLocation, ioInstallEnv = {})
+        # * *iContent* (_String_): The gem install command
+        # * *iLocation* (_String_): The directory to install to
+        rError = nil
+
+        # Load RubyGems
+        require 'rubygems/command_manager'
+        # Install
+        begin
+          lSplitContent = iContent.split(' ') + [ '-i', iLocation, '--no-rdoc', '--no-ri', '--no-test' ]
+          ::Gem::CommandManager.instance.find_command('install').invoke(*lSplitContent)
+        rescue ::Gem::SystemExitException
+          # For RubyGems, this is normal behaviour: success results in an exception thrown with exit_code 0.
+          if ($!.exit_code != 0)
+            rError = $!
+          else
+            # Refresh as otherwise, Gems installed in paths already part of Gem.path will still not be seen by Gem.find_files.
+            ::Gem.refresh
+            ioInstallEnv[:InstallDir] = iLocation
+          end
+        rescue Exception
+          rError = $!
+        end
+
+        return rError
+      end
+
+    end
+
+  end
+
+end

data/lib/rdi/Plugins/Installers/Yum.rb

@@ -0,0 +1,52 @@
+#--
+# Copyright (c) 2009 Muriel Salvan (murielsalvan@users.sourceforge.net)
+# Licensed under the terms specified in LICENSE file. No warranty is provided.
+#++
+
+require 'rdi/Model/Installer'
+
+module RDI
+
+  module Installers
+
+    class Yum < RDI::Model::Installer
+
+      # Get the list of possible destinations
+      #
+      # Return:
+      # * <em>list<[Integer,Object]></em>: The list of possible destinations and their corresponding installation location (or location selector name for DEST_OTHER)
+      def getPossibleDestinations
+        return [
+          [ DEST_SYSTEM, '/' ]
+        ]
+      end
+
+      # Install a dependency
+      #
+      # Parameters:
+      # * *iContent* (_Object_): The dependency's content
+      # * *iLocation* (_Object_): The installation location
+      # * *ioInstallEnv* (<em>map<Symbol,Object></em>): The installed environment, that can be modified here. Stored variables will the be accessible to ContextModifiers. [optional = {}]
+      # Return:
+      # * _Exception_: The error, or nil in case of success
+      def installDependency(iContent, iLocation, ioInstallEnv = {})
+        # * *iContent* (_String_): The yum install command
+        # * *iLocation* (_String_): The directory to install to
+        rError = nil
+
+        begin
+          if (!system("yum -y -q install #{iContent}"))
+            rError = RuntimeError.new("Execution of 'yum -y -q install #{iContent}' ended in error with code #{$?.exitstatus}.")
+          end
+        rescue Exception
+          rError = $!
+        end
+
+        return rError
+      end
+
+    end
+
+  end
+
+end

data/lib/rdi/Plugins/ProgressViews/SimpleWxGUI.desc.rb

@@ -0,0 +1,13 @@
+#--
+# Copyright (c) 2009 Muriel Salvan (murielsalvan@users.sourceforge.net)
+# Licensed under the terms specified in LICENSE file. No warranty is provided.
+#++
+
+require 'rdi/Plugins/WxRubyDepDesc'
+
+{
+  :Dependencies => [
+    # WxRuby
+    ::RDI::getWxRubyDepDesc
+  ]
+}

data/lib/rdi/Plugins/ProgressViews/SimpleWxGUI.rb

@@ -0,0 +1,58 @@
+#--
+# Copyright (c) 2009 Muriel Salvan (murielsalvan@users.sourceforge.net)
+# Licensed under the terms specified in LICENSE file. No warranty is provided.
+#++
+
+require 'rdi/Model/ProgressView'
+
+module RDI
+
+  module ProgressViews
+
+    class SimpleWxGUI < RDI::Model::ProgressView
+
+      # Proxy class that will route calls made by RDI to the corresponding RUtilAnts::GUI::TextProgressDialog
+      class SimpleWxGUIProgressDialog < RUtilAnts::GUI::TextProgressDialog
+
+        # Set the title of the operation
+        #
+        # Parameters:
+        # * *iTitle* (_String_): Title of the operation
+        def setTitle(iTitle)
+          setText(iTitle)
+        end
+
+        # Set the range
+        #
+        # Parameters:
+        # * *iRange* (_Integer_): Range to set
+        def setRange(iRange)
+          super
+        end
+
+        # Increment the value
+        #
+        # Parameters:
+        # * *iIncrement* (_Integer_): The increment [optional = 1]
+        def incValue(iIncrement = 1)
+          super
+        end
+
+      end
+
+      # Setup the progress and call the client code to execute inside
+      #
+      # Parameters:
+      # * _CodeBlock_: The code to execute during this progression:
+      # ** *ioProgressView* (_Object_): The progress view that will receive notifications of progression (can be nil if no progression view available)
+      def setupProgress(&iCodeToExecute)
+        showModal(SimpleWxGUIProgressDialog, Wx.get_app.get_top_window, iCodeToExecute, '') do |iModalResult, iDialog|
+          # Nothing to do
+        end
+      end
+
+    end
+
+  end
+
+end

data/lib/rdi/Plugins/ProgressViews/Text.rb

@@ -0,0 +1,68 @@
+#--
+# Copyright (c) 2009 Muriel Salvan (murielsalvan@users.sourceforge.net)
+# Licensed under the terms specified in LICENSE file. No warranty is provided.
+#++
+
+require 'rdi/Model/ProgressView'
+
+module RDI
+
+  module ProgressViews
+
+    class Text < RDI::Model::ProgressView
+
+      # Proxy class that will route calls made by RDI to stdout
+      class TextProgressDialog
+
+        # Constructor
+        def initialize
+          @Range = 0
+          @Value = 0
+        end
+
+        # Set the title of the operation
+        #
+        # Parameters:
+        # * *iTitle* (_String_): Title of the operation
+        def setTitle(iTitle)
+          puts "==== #{iTitle} ... ===="
+        end
+
+        # Set the range
+        #
+        # Parameters:
+        # * *iRange* (_Integer_): Range to set
+        def setRange(iRange)
+          @Range = iRange
+        end
+
+        # Increment the value
+        #
+        # Parameters:
+        # * *iIncrement* (_Integer_): The increment [optional = 1]
+        def incValue(iIncrement = 1)
+          @Value += iIncrement
+          # Display the value
+          if (@Range == 0)
+            puts '...'
+          else
+            puts "#{(@Value*100)/@Range} %"
+          end
+        end
+
+      end
+
+      # Setup the progress and call the client code to execute inside
+      #
+      # Parameters:
+      # * _CodeBlock_: The code to execute during this progression:
+      # ** *ioProgressView* (_Object_): The progress view that will receive notifications of progression (can be nil if no progression view available)
+      def setupProgress
+        yield(TextProgressDialog.new)
+      end
+
+    end
+
+  end
+
+end