RDI 0.1.0.20091020

data/lib/rdi/Model/DependencyDescription.rb

@@ -0,0 +1,154 @@
+#--
+# Copyright (c) 2009 Muriel Salvan (murielsalvan@users.sourceforge.net)
+# Licensed under the terms specified in LICENSE file. No warranty is provided.
+#++
+
+module RDI
+
+  module Model
+
+    # Class storing information about a dependency
+    class DependencyDescription
+
+      # ID of the description
+      #   String
+      attr_reader :ID
+
+      # List of the testers that must be resolved to ensure this dependency (list of couples [ TesterName, TesterContent ])
+      #   list< [ String, Object ] >
+      attr_reader :Testers
+
+      # List of the possible installers
+      #   list< [ String, Object, list< [ String, Object ] > ] >
+      #   list< [ InstallerName, InstallerContent, list< [ ContextModifierName, ContextModifierContent ] > ] >
+      attr_reader :Installers
+
+      # Constructor
+      #
+      # Parameters:
+      # * *iID* (_String_): ID of this description. This can be used for example to further associate context modifiers to previously installed dependencies
+      def initialize(iID)
+        @ID = iID
+        @Testers = []
+        @Installers = []
+      end
+
+      # Add given testers and installers lists
+      #
+      # Parameters:
+      # * *iTesters* (<em>list<TesterInfo></em>): List of Testers
+      # * *iInstallers* (<em>list<InstallerInfo></em>): List of Installers
+      # Return:
+      # * _DependencyDescription_: self, useful to concatenate such method calls
+      def addTestersAndInstallers(iTesters, iInstallers)
+        iTesters.each do |iTesterInfo|
+          addTesterInfo(iTesterInfo)
+        end
+        iInstallers.each do |iInstallerInfo|
+          addInstallerInfo(iInstallerInfo)
+        end
+
+        return self
+      end
+
+      # Add a complete description.
+      # Here are the formats authorized:
+      # * { :Testers => list< TesterInfo >, :Installers => list< InstallerInfo > }
+      # * [ list< TesterInfo >, list< InstallerInfo > ]
+      #
+      # Parameters:
+      # * *iDescription* (_Object_): The description
+      # Return:
+      # * _DependencyDescription_: self, useful to concatenate such method calls
+      def addDescription(iDescription)
+        if (iDescription.is_a?(Array))
+          addTestersAndInstallers(iDescription[0], iDescription[1])
+        elsif (iDescription.is_a?(Hash))
+          addTestersAndInstallers(iDescription[:Testers], iDescription[:Installers])
+        else
+          logBug "Invalid Description: #{iDescription.inspect}."
+        end
+
+        return self
+      end
+
+      # Add a tester info
+      # Here are the following formats accepted for each Tester info:
+      # * [ String, Object ]
+      # * { :Type => String, :Content => Object }
+      #
+      # Parameters:
+      # * *iTesterInfo* (_Object_): The tester info
+      # Return:
+      # * _DependencyDescription_: self, useful to concatenate such method calls
+      def addTesterInfo(iTesterInfo)
+        if (iTesterInfo.is_a?(Array))
+          @Testers << iTesterInfo
+        elsif (iTesterInfo.is_a?(Hash))
+          @Testers << [ iTesterInfo[:Type], iTesterInfo[:Content] ]
+        else
+          logBug "Invalid TesterInfo: #{iTesterInfo.inspect}."
+        end
+
+        return self
+      end
+
+      # Add an installer info
+      # Here are the following formats accepted for each Installer info:
+      # * [ String, Object, list< ContextModifierInfo > ]
+      # * [ :Type => String, :Content => Object, :ContextModifiers => list< ContextModifierInfo > ]
+      #
+      # Parameters:
+      # * *iInstallerInfo* (_Object_): The installer info
+      # Return:
+      # * _DependencyDescription_: self, useful to concatenate such method calls
+      def addInstallerInfo(iInstallerInfo)
+        if (iInstallerInfo.is_a?(Array))
+          lNewInstallerInfo = [ iInstallerInfo[0], iInstallerInfo[1], [] ]
+          iInstallerInfo[2].each do |iContextModifierInfo|
+            lNewInstallerInfo[2] << getContextModifierInfo(iContextModifierInfo)
+          end
+          @Installers << lNewInstallerInfo
+        elsif (iInstallerInfo.is_a?(Hash))
+          lNewInstallerInfo = [ iInstallerInfo[:Type], iInstallerInfo[:Content], [] ]
+          iInstallerInfo[:ContextModifiers].each do |iContextModifierInfo|
+            lNewInstallerInfo[2] << getContextModifierInfo(iContextModifierInfo)
+          end
+          @Installers << lNewInstallerInfo
+        else
+          logBug "Invalid InstallerInfo: #{iInstallerInfo.inspect}."
+        end
+
+        return self
+      end
+
+      private
+
+      # Get the corresponding context modifier info
+      # Here are the following formats accepted for each ContextModifier info:
+      # * [ String, Object ]
+      # * { :Type => String, :Content => Object }
+      #
+      # Parameters:
+      # * *iContextModifierInfo* (_Object_): The context modifier info
+      # Return:
+      # * _Object_: The resulting context modifier info as stored internally
+      def getContextModifierInfo(iContextModifierInfo)
+        rContextModifierInfo = nil
+
+        if (iContextModifierInfo.is_a?(Array))
+          rContextModifierInfo = iContextModifierInfo
+        elsif (iContextModifierInfo.is_a?(Hash))
+          rContextModifierInfo = [ iContextModifierInfo[:Type], iContextModifierInfo[:Content] ]
+        else
+          logBug "Invalid ContextModifierInfo: #{iContextModifierInfo.inspect}."
+        end
+
+        return rContextModifierInfo
+      end
+
+    end
+
+  end
+
+end

data/lib/rdi/Model/DependencyUserChoice.rb

@@ -0,0 +1,202 @@
+#--
+# Copyright (c) 2009 Muriel Salvan (murielsalvan@users.sourceforge.net)
+# Licensed under the terms specified in LICENSE file. No warranty is provided.
+#++
+
+module RDI
+
+  module Model
+
+    # Class used to store user decisions associated to a dependency
+    class DependencyUserChoice
+
+      # The corresponding dependency's description
+      #   DependencyDescription
+      attr_reader :DepDesc
+
+      # Ignore flag
+      #   Boolean
+      attr_reader :Ignore
+
+      # Locate flag
+      #   Boolean
+      attr_reader :Locate
+
+      # Installer index chosen for this dependency (can be nil if not to be installed)
+      #   Integer
+      attr_reader :IdxInstaller
+
+      # Destination index chosen for this dependency (can be nil if not to be installed)
+      #   Integer
+      attr_reader :IdxDestination
+
+      # The resolved testers (indexes), with their respective ContextModifier name and Location used to resolve them
+      #   map< Integer, [ String, Object ] >
+      attr_reader :ResolvedTesters
+
+      # The other location
+      #   Object
+      attr_reader :OtherLocation
+
+      # The list of ContextModifiers that could help resolving the Testers
+      #   list< String >
+      attr_reader :AffectingContextModifiers
+
+      # Constructor
+      #
+      # Parameters:
+      # * *ioInstaller* (_Installer_): RDI's installer used to query plugins
+      # * *iViewName* (_String_): Name of the view to use
+      # * *iDepDesc* (_DependencyDescription_): The dependency description to handle
+      def initialize(ioInstaller, iViewName, iDepDesc)
+        @Installer, @ViewName, @DepDesc = ioInstaller, iViewName, iDepDesc
+        @Ignore = false
+        @Locate = false
+        @IdxInstaller = 0
+        @IdxDestination = 0
+        @ResolvedTesters = {}
+        @OtherLocation = nil
+        @AffectingContextModifiers = DependencyUserChoice::getAffectingContextModifiers(@Installer, @DepDesc)
+      end
+
+      # Compute the list of AffectingContextModifiers
+      #
+      # Parameters:
+      # * *ioInstaller* (_Installer_): The installer
+      # * *iDepDesc* (_DependencyDescription_): The dependency description
+      # Return:
+      # * <em>list<String></em>: The list of ContextModifiers names
+      def self.getAffectingContextModifiers(ioInstaller, iDepDesc)
+        rAffectingContextModifiers = []
+
+        # Gather the list of affecting ContextModifiers by parsing every Tester.
+        iDepDesc.Testers.each do |iTesterInfo|
+          iTesterName, iTesterContent = iTesterInfo
+          ioInstaller.accessPlugin('Testers', iTesterName) do |iPlugin|
+            rAffectingContextModifiers = (rAffectingContextModifiers + iPlugin.AffectingContextModifiers).uniq
+          end
+        end
+
+        return rAffectingContextModifiers
+      end
+
+      # Ask the user to change the context of a given context modifier to resolve this dependency
+      #
+      # Parameters:
+      # * *iCMName* (_String_): Name of the ContextModifier we want to use
+      def affectContextModifier(iCMName)
+        @Installer.accessPlugin('ContextModifiers', iCMName) do |ioPlugin|
+          # Get the name of LocationSelector class to use
+          lLocationSelectorName = ioPlugin.LocationSelectorName
+          @Installer.accessPlugin("LocationSelectors_#{@ViewName}", lLocationSelectorName) do |iLSPlugin|
+            # Get the location from the plugin
+            lLocationToTry = iLSPlugin.getNewLocation
+            if (lLocationToTry != nil)
+              # Try adding this new location if not already there
+              if (ioPlugin.isLocationInContext?(lLocationToTry))
+                logMsg "Location #{lLocationToTry} is already part of #{iCMName}"
+              else
+                # Add it
+                ioPlugin.addLocationToContext(lLocationToTry)
+                # Test Testers that were not already resolved
+                lIdxTester = 0
+                @DepDesc.Testers.each do |iTesterInfo|
+                  if (!@ResolvedTesters.has_key?(lIdxTester))
+                    # Test this one
+                    iTesterName, iTesterContent = iTesterInfo
+                    @Installer.accessPlugin('Testers', iTesterName) do |iTesterPlugin|
+                      # Consider it only if it declares iCMName as an AffectingContextModifier
+                      if (iTesterPlugin.AffectingContextModifiers.include?(iCMName))
+                        if (iTesterPlugin.isContentResolved?(iTesterContent))
+                          # Yes, it resolved this one
+                          @ResolvedTesters[lIdxTester] = [ iCMName, lLocationToTry ]
+                          logMsg "Location #{lLocationToTry} resolves correctly #{iTesterName} - #{iTesterContent}"
+                        else
+                          logErr "Location #{lLocationToTry} does not resolve #{iTesterName} - #{iTesterContent}"
+                        end
+                      end
+                    end
+                  end
+                  lIdxTester += 1
+                end
+                # Remove it
+                ioPlugin.removeLocationFromContext(lLocationToTry)
+              end
+            end
+          end
+        end
+      end
+
+      # Select a different install location for this dependency
+      #
+      # Parameters:
+      # * *iLocationSelectorName* (_String_): The location selector name
+      # Return:
+      # * _Boolean_: Is the selection valid ?
+      def selectOtherInstallLocation(iLocationSelectorName)
+        rSuccess = false
+
+        @Installer.accessPlugin("LocationSelectors_#{@ViewName}", iLocationSelectorName) do |iPlugin|
+          # Get the location from the plugin
+          lInstallLocation = iPlugin.getNewLocation
+          if (lInstallLocation != nil)
+            @OtherLocation = lInstallLocation
+            rSuccess = true
+          end
+        end
+
+        return rSuccess
+      end
+
+      # Set this choice to be "locate it"
+      def setLocate
+        @Ignore = false
+        @Locate = true
+        @IdxInstaller = nil
+        @IdxDestination = nil
+      end
+
+      # Set this choice to be "ignore it"
+      def setIgnore
+        @Ignore = true
+        @Locate = false
+        @IdxInstaller = nil
+        @IdxDestination = nil
+      end
+
+      # Set this choice to be "install it"
+      #
+      # Parameters:
+      # * *iIdxInstaller* (_Integer_): The Installer's index
+      # * *iIdxDestination* (_Integer_): The destination's index
+      def setInstaller(iIdxInstaller, iIdxDestination)
+        @Ignore = false
+        @Locate = false
+        @IdxInstaller = iIdxInstaller
+        @IdxDestination = iIdxDestination
+      end
+
+      # Do we equal another user choice ?
+      # Used by the regression
+      #
+      # Parameters:
+      # * *iOtherDUC* (_DependencyOtherChoice_): The other one
+      # Return:
+      # * _Boolean_: Do we equal another user choice ?
+      def ==(iOtherDUC)
+        return (
+          (@DepDesc == iOtherDUC.DepDesc) and
+          (@Ignore == iOtherDUC.Ignore) and
+          (@Locate == iOtherDUC.Locate) and
+          (@IdxInstaller == iOtherDUC.IdxInstaller) and
+          (@IdxDestination == iOtherDUC.IdxDestination) and
+          (@ResolvedTesters == iOtherDUC.ResolvedTesters) and
+          (@OtherLocation == iOtherDUC.OtherLocation)
+        )
+      end
+
+    end
+
+  end
+
+end

data/lib/rdi/Model/Installer.rb

@@ -0,0 +1,24 @@
+#--
+# Copyright (c) 2009 Muriel Salvan (murielsalvan@users.sourceforge.net)
+# Licensed under the terms specified in LICENSE file. No warranty is provided.
+#++
+
+module RDI
+
+  module Model
+
+    class Installer
+
+      # The Installer
+      #   Installer
+      attr_accessor :Installer
+
+      # The list of possible destinations, and the directories they point to
+      #   map< Integer, String >
+      attr_accessor :PossibleDestinations
+
+    end
+
+  end
+
+end

data/lib/rdi/Model/LocationSelector.rb

@@ -0,0 +1,16 @@
+#--
+# Copyright (c) 2009 Muriel Salvan (murielsalvan@users.sourceforge.net)
+# Licensed under the terms specified in LICENSE file. No warranty is provided.
+#++
+
+module RDI
+
+  module Model
+
+    class LocationSelector
+
+    end
+
+  end
+
+end

data/lib/rdi/Model/ProgressView.rb

@@ -0,0 +1,16 @@
+#--
+# Copyright (c) 2009 Muriel Salvan (murielsalvan@users.sourceforge.net)
+# Licensed under the terms specified in LICENSE file. No warranty is provided.
+#++
+
+module RDI
+
+  module Model
+
+    class ProgressView
+
+    end
+
+  end
+
+end

data/lib/rdi/Model/Tester.rb

@@ -0,0 +1,20 @@
+#--
+# Copyright (c) 2009 Muriel Salvan (murielsalvan@users.sourceforge.net)
+# Licensed under the terms specified in LICENSE file. No warranty is provided.
+#++
+
+module RDI
+
+  module Model
+
+    class Tester
+
+      # The list of affecting context modifier names
+      #   list< String >
+      attr_accessor :AffectingContextModifiers
+
+    end
+
+  end
+
+end

data/lib/rdi/Model/View.rb

@@ -0,0 +1,16 @@
+#--
+# Copyright (c) 2009 Muriel Salvan (murielsalvan@users.sourceforge.net)
+# Licensed under the terms specified in LICENSE file. No warranty is provided.
+#++
+
+module RDI
+
+  module Model
+
+    class View
+
+    end
+
+  end
+
+end

data/lib/rdi/Plugins/ContextModifiers/GemPath.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/ContextModifiers/GemPath.rb

@@ -0,0 +1,106 @@
+#--
+# 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'
+require 'rdi/Plugins/GemCommon'
+
+module RDI
+
+  module ContextModifiers
+
+    class GemPath < RDI::Model::ContextModifier
+
+      # To get the complete list of loadable paths through RubyGems:
+      # > Gem.all_loaded_paths
+      # C:/Program Files/ruby/lib/ruby/gems/1.8/gems/win32-process-0.5.1/lib
+      # C:/Program Files/ruby/lib/ruby/gems/1.8/gems/win32-sapi-0.1.3-mswin32/lib
+      # C:/Program Files/ruby/lib/ruby/gems/1.8/gems/win32-sound-0.4.0/lib
+      # C:/Program Files/ruby/lib/ruby/gems/1.8/gems/windows-pr-0.5.3/lib
+      # E:/Documents and Settings/Muriel Salvan/toto/gems/crated-0.2.1/lib
+      #
+      # Find if a file is accessible
+      # > Gem.find_files('crate')
+      #
+      # To add a new Gems repository:
+      # > Gem.path << 'E:/Documents and Settings/Muriel Salvan/toto'
+      #
+      # To remove a Gems repository:
+      # > Gem.clear_paths
+      # Then re-add others than the one we want to remove
+
+      # 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 Gem.path.include?(iLocation)
+      end
+
+      # Add a given location to the context
+      #
+      # Parameters:
+      # * *iLocation* (_Object_): Location to add
+      def addLocationToContext(iLocation)
+        # * *iLocation* (_String_): Directory
+        Gem.path << iLocation
+        # TODO (RubyGems): Make the extra source_index modification useless. Adding to path should reflect changes internally.
+        Gem.source_index.spec_dirs << "#{iLocation}/specifications"
+        Gem.refresh
+      end
+
+      # Remove a given location from the context
+      #
+      # Parameters:
+      # * *iLocation* (_Object_): Location to remove
+      def removeLocationFromContext(iLocation)
+        # * *iLocation* (_String_): Directory
+        lLastPaths = Gem.path.clone
+        Gem.clear_paths
+        lLastPaths.each do |iLastDir|
+          if ((iLastDir != iLocation) and
+              (!Gem.path.include?(iLastDir)))
+            Gem.path << iLastDir
+            # TODO (RubyGems): Make the extra source_index modification useless. Adding to path should reflect changes internally.
+            Gem.source_index.spec_dirs << "#{iLastDir}/specifications"
+          end
+        end
+        Gem.refresh
+      end
+
+    end
+
+  end
+
+end

data/lib/rdi/Plugins/ContextModifiers/LibraryPath.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 LibraryPath < 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.getSystemLibsPath.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.setSystemLibsPath($rUtilAnts_Platform_Info.getSystemLibsPath + [ iLocation ])
+      end
+
+      # Remove a given location from the context
+      #
+      # Parameters:
+      # * *iLocation* (_Object_): Location to remove
+      def removeLocationFromContext(iLocation)
+        # * *iLocation* (_String_): Directory
+        $rUtilAnts_Platform_Info.setSystemLibsPath($rUtilAnts_Platform_Info.getSystemLibsPath - [ iLocation ])
+      end
+
+    end
+
+  end
+
+end