RubyPackager 0.1.0.20091021 → 0.1.1.20091105

data/ChangeLog

@@ -0,0 +1,67 @@
+= RubyPackager Release History
+
+== 0.1.1.20091105 (Alpha)
+
+=== New features
+
+* Implemented generation of Linux executables, with and without Ruby (with Ruby not tested correctly yet)
+* Moved directory containing modifications to perform in a separate place (Modifications dir)
+* Regression: Added test cases for Linux executables generated.
+* Adapted regression to run correctly under Linux.
+* -h option also gives the version of RubyPackager.
+* --debug option enables debugging logs.
+* Used rUtilAnts/Logging for logging.
+* Give the possibility to not generate RDoc by --no-rdoc command line option.
+* SourceForge distributor handles RDoc only if it has been generated.
+* NSIS installer does not need anymore ExeName to be set: use an additional InstallerName property instead.
+* Removed useless checkTools method from Gem Installer.
+* RubyPackager automatically creates directories Installer, Documentation and Release to not let this be done by plugins.
+* Try Muriel templates for RDoc, and switch back to default template in case of error.
+* Added RDoc modifications to make before using RubyPackager.
+* Use Muriel templates when generating RDoc.
+* No need anymore to set $ReleaseInfo variable in ReleaseInfo files.
+* Adapted RubyPackager's ReleaseInfo to the new interface.
+* Removed useless checkTools method from ReleaseInfo.
+
+=== Regression
+
+* Regression: Logging errors correctly.
+* Regression: Added test cases for binaries created with and without Ruby on Windows.
+* Regression: Muted output (still remains external programs output)
+* Regression: Added test cases for:
+** Gem Installer
+** NSIS Installer
+** SourceForge Distributor
+* Regression: Better organization of test cases.
+* Regression: Added test cases for:
+** Command line options.
+** Basic library release.
+** Basic executable release.
+* Regression: Added checks for ReleaseInfo file presence and content.
+* Regression: Refactored regression to cope with new interface.
+* Regression: Added a simple library release test.
+
+=== Bug corrections
+
+* Bug correction: When RubyPackager's Launcher was invoked after having changed current directory, it could not find plugins anymore.
+* Bug correction: when Installers or Distributors did not define checkTools, an error was issued.
+* Bug correction: Generated ReleaseInfo file was reporting Tags incorrectly.
+* Bug correction: Test files were included in releases even without -n flag.
+* Bug correction: When asked for help with -h switch, an error was displayed.
+* Bug correction: Exception occurred while generating ReleaseNotes when no release comment was provided.
+
+== 0.1.0.20091021 (Alpha)
+
+* Implemented release of libraries as well.
+* Implemented generation of Installers.
+* Implemented distribution to third parties (SourceForge...).
+* Harmonized the way ReleaseInfo are described (!!! complete change with no compatibility with previous format).
+* Plugins architecture for Installers and Distributors.
+* Removed .rb suffixes in required files (better migration to .so if needed).
+* Removed references to PBS.
+* Bug correction: Dir.glob does not work correctly with '\'.
+* Bug correction: Application specific checks for tools were ignored.
+
+== 0.0.1.20090819 (Alpha)
+
+* Initial public release.

data/{F:/RR/Source/rubypackager/svn/rubypackager/Releases/i386-mswin32/0.1.0.20091021/Normal/2009_10_21_19_10_02/Release/ReleaseInfo → ReleaseInfo}

@@ -2,7 +2,7 @@
 # This file has been generated by RubyPackager during a delivery.
 # More info about RubyPackager: http://rubypackager.sourceforge.net
 {
-  :Version => '0.1.0.20091021',
+  :Version => '0.1.1.20091105',
   :Tags => [],
   :DevStatus => 'Alpha'
 }

data/TODO

@@ -0,0 +1,14 @@
+* Documentation
+** Write a complete User Guide.
+** Write a complete Developer Guide.
+** Create FAQ
+
+* Testing
+** Test that each possible option from ReleaseInfo is used correctly in every context (Installers, Distributors...)
+** Test checkTools on ReleaseInfo, Installers and Distributors
+** Test that including Ruby in exe effectively works in an environment not having Ruby
+
+* Development
+** Make it run under MacOS
+** Make rdoc modifications part of a real Gem or an RDoc improvement.
+** Use RDI in checkContext methods.

data/bin/Release.rb

@@ -0,0 +1,206 @@
+#!env ruby
+#--
+# Copyright (c) 2009 Muriel Salvan (murielsalvan@users.sourceforge.net)
+# Licensed under the terms specified in LICENSE file. No warranty is provided.
+#++
+
+# Release a distribution of a Ruby program or library.
+# Here is the behaviour:
+# 1. Gather all files meant to be released in a separate directory (Core, Additional and Test if specified)
+# 2. In the case of an executable release, generate the executable with Core files and Ruby distribution if specified
+# 3. In the case of specified installers, generate the needed installers including the Core files (or the executable), the Additional files and Test if specified)
+# 4. In the case of specified distributors, ship the generated installers to those distributors
+
+require 'rUtilAnts/Logging'
+RUtilAnts::Logging::initializeLogging("#{File.dirname(__FILE__)}/..", 'http://sourceforge.net/tracker/?group_id=274236&atid=1165400')
+
+module RubyPackager
+
+  # Class giving command line options for the releaser
+  class Launcher
+
+    FILE_PATH = File.expand_path(__FILE__)
+
+    # Run the releaser
+    #
+    # Parameters:
+    # * *iParameters* (<em>list<String></em>): List of arguments, as in command-line
+    # Return:
+    # * _Boolean_: Success ?
+    def run(iParameters)
+      rSuccess = true
+
+      # Get the RubyPackager version we are running on
+      lRPReleaseInfo = {
+        :Version => 'Development',
+        :Tags => [],
+        :DevStatus => 'Unofficial'
+      }
+      lReleaseInfoFileName = "#{File.dirname(FILE_PATH)}/ReleaseInfo"
+      if (File.exists?(lReleaseInfoFileName))
+        File.open(lReleaseInfoFileName, 'r') do |iFile|
+          lRPReleaseInfo = eval(iFile.read)
+        end
+      end
+
+      # Parse for plugins
+      require 'rUtilAnts/Plugins'
+      lPluginsManager = RUtilAnts::Plugins::PluginsManager.new
+      lPluginsManager.parsePluginsFromDir('Installers', "#{File.dirname(FILE_PATH)}/../lib/RubyPackager/Installers", 'RubyPackager::Installers')
+      lPluginsManager.parsePluginsFromDir('Installers', "#{File.dirname(FILE_PATH)}/../lib/RubyPackager/#{RUBY_PLATFORM}/Installers", 'RubyPackager::Installers')
+      lPluginsManager.parsePluginsFromDir('Distributors', "#{File.dirname(FILE_PATH)}/../lib/RubyPackager/Distributors", 'RubyPackager::Distributors')
+      lPluginsManager.parsePluginsFromDir('Distributors', "#{File.dirname(FILE_PATH)}/../lib/RubyPackager/#{RUBY_PLATFORM}/Distributors", 'RubyPackager::Distributors')
+
+      # Parse command line arguments
+      # Variables set by the parser
+      lDisplayUsage = false
+      lReleaseVersion = 'UnnamedVersion'
+      lReleaseTags = []
+      lReleaseComment = nil
+      lIncludeRuby = false
+      lIncludeTest = false
+      lIncludeRDoc = true
+      lInstallers = []
+      lDistributors = []
+      # The parser
+      require 'optparse'
+      lOptionsParser = OptionParser.new
+      lOptionsParser.banner = 'Release.rb [-h|--help] [-e|--debug] [-v|--version <Version>] [-t|--tag <TagName>]* [-c|--comment <Comment>] [-r|--ruby] [-n|--includeTest] [-o|--no-rdoc] [-i|--installer <InstallerName>]* [-d|--distributor <DistributorName>]* <ReleaseFile>'
+      lOptionsParser.on('-h', '--help',
+        'Display help usage.') do
+        lDisplayUsage = true
+      end
+      lOptionsParser.on('-e', '--debug',
+        'Activate debugging logs.') do
+        activateLogDebug(true)
+      end
+      lOptionsParser.on('-v', '--version <Version>', String,
+        '<Version>: Version string of the release.',
+        'Set the version to display for this release.') do |iArg|
+        lReleaseVersion = iArg
+      end
+      lOptionsParser.on('-t', '--tag <TagName>', String,
+        '<TagName>: Tag to apply to this version.',
+        'Set a Tag to this version. A Tag is a way to categorize the version (i.e. UltimateEdition, Alpha...).') do |iArg|
+        lReleaseTags << iArg
+      end
+      lOptionsParser.on('-c', '--comment <Comment>', String,
+        '<Comment>: Comment to add to the release note.',
+        'Set the release comment to display for this release.') do |iArg|
+        lReleaseComment = iArg
+      end
+      lOptionsParser.on('-r', '--ruby',
+        'Include Ruby distribution in the release (only applicable for executable releases).') do
+        lIncludeRuby = true
+      end
+      lOptionsParser.on('-n', '--includeTest',
+        'Include Test files in the release.') do
+        lIncludeTest = true
+      end
+      lOptionsParser.on('-o', '--no-rdoc',
+        'Do NOT generate RDoc.') do
+        lIncludeRDoc = false
+      end
+      lOptionsParser.on('-i', '--installer <InstallerName>', String,
+        '<InstallerName>: Name of an Installer to use.',
+        "Generate an installer. Can be specified multiple times. Available Installers are: #{lPluginsManager.getPluginNames('Installers').join(', ')}") do |iArg|
+        lInstallers << iArg
+      end
+      lOptionsParser.on('-d', '--distributor <DistributorName>', String,
+        '<DistributorName>: Name of a Distributor to use.',
+        "Ship generated installers to a distributor. Can be specified multiple times. Available Distributors are: #{lPluginsManager.getPluginNames('Distributors').join(', ')}") do |iArg|
+        lDistributors << iArg
+      end
+      lReleaseInfo = nil
+      begin
+        lRemainingArgs = lOptionsParser.parse(iParameters)
+        if (lRemainingArgs.size != 1)
+          if (!lDisplayUsage)
+            puts 'Wrong release file. Please specify 1 release file.'
+            puts lOptionsParser
+            rSuccess = false
+          end
+        else
+          # Check the Release file
+          lReleaseFile = lRemainingArgs[0]
+          require 'RubyPackager/ReleaseInfo'
+          File.open(lReleaseFile, 'r') do |iFile|
+            lReleaseInfo = eval(iFile.read)
+          end
+          if (!lReleaseInfo.kind_of?(RubyPackager::ReleaseInfo))
+            puts "Release file #{lReleaseFile} is incorrect. It does not define RubyPackager::ReleaseInfo variable. Please correct it and try again."
+            rSuccess = false
+          end
+        end
+        # Check the installers
+        lAvailableInstallers = lPluginsManager.getPluginNames('Installers')
+        lInstallers.each do |iInstallerName|
+          if (!lAvailableInstallers.include?(iInstallerName))
+            puts "Unknown specified installer: #{iInstallerName}."
+            puts lOptionsParser
+            rSuccess = false
+          end
+        end
+        # Check the distributors
+        lAvailableDistributors = lPluginsManager.getPluginNames('Distributors')
+        lDistributors.each do |iDistributorName|
+          if (!lAvailableDistributors.include?(iDistributorName))
+            puts "Unknown specified distributor: #{iDistributorName}."
+            puts lOptionsParser
+            rSuccess = false
+          end
+        end
+      rescue Exception
+        puts "Error while parsing arguments: #{$!}"
+        puts lOptionsParser
+        rSuccess = false
+      end
+      if (rSuccess)
+        if (lDisplayUsage)
+          puts "RubyPackager v. #{lRPReleaseInfo[:Version]} - #{lRPReleaseInfo[:DevStatus]}"
+          puts ''
+          puts lOptionsParser
+        else
+          # All is ok, call the library with parameters
+          require 'RubyPackager/Releaser'
+          # Require the platform specific distribution file
+          require "RubyPackager/#{RUBY_PLATFORM}/PlatformReleaser"
+          rSuccess = Releaser.new(
+            lPluginsManager,
+            lReleaseInfo,
+            Dir.getwd,
+            "#{Dir.getwd}/Releases",
+            PlatformReleaser.new,
+            lReleaseVersion,
+            lReleaseTags,
+            lReleaseComment,
+            lIncludeRuby,
+            lIncludeTest,
+            lIncludeRDoc,
+            lInstallers,
+            lDistributors
+          ).execute
+          if (rSuccess)
+            logInfo 'Release successful.'
+          else
+            logErr 'Error while releasing.'
+          end
+        end
+      end
+
+      return rSuccess
+    end
+
+  end
+
+end
+
+# Execute everything (take care that paths might differ in bin directories gems)
+if (File.basename($0) == File.basename(__FILE__))
+  lSuccess = RubyPackager::Launcher.new.run(ARGV)
+  if (lSuccess)
+    exit 0
+  else
+    exit 1
+  end
+end

data/{F:/RR/Source/rubypackager/svn/rubypackager/Releases/i386-mswin32/0.1.0.20091021/Normal/2009_10_21_19_10_02/Release/lib → lib}/RubyPackager/Distributors/SourceForge.rb

@@ -23,17 +23,17 @@ module RubyPackager
         begin
           require 'net/ssh'
         rescue Exception
-          puts '!!! Missing net/ssh library. gem install net-ssh.'
+          logErr 'Missing net/ssh library. gem install net-ssh.'
           rSuccess = false
         end
         begin
           require 'net/scp'
         rescue Exception
-          puts '!!! Missing net/scp library. gem install net-scp.'
+          logErr 'Missing net/scp library. gem install net-scp.'
           rSuccess = false
         end
         if (!system('zip -v'))
-          puts '!!! Missing zip command-line utility.'
+          logErr 'Missing zip command-line utility.'
           rSuccess = false
         end
 
@@ -59,7 +59,10 @@ module RubyPackager
         @SFReleaseDir = "/home/frs/project/#{@SFProjectSubPath}/#{@ReleaseVersion}"
         createSFShell
         createReleaseOnSFNET
-        uploadRDocOnSFNET
+        # It is possible that he RDoc has not been generated
+        if (File.exists?("#{@DocDir}/rdoc"))
+          uploadRDocOnSFNET
+        end
         uploadReleaseNoteOnSFNET
         uploadFilesOnSFNET
 
@@ -88,7 +91,7 @@ module RubyPackager
 
       # Upload the RDoc on SF.NET
       def uploadRDocOnSFNET
-        puts 'Uploading RDoc on SF.NET ...'
+        logDebug 'Uploading RDoc on SF.NET ...'
         # Zip the RDoc
         lOldDir = Dir.getwd
         Dir.chdir(@DocDir)
@@ -119,7 +122,7 @@ module RubyPackager
 
       # Create the release on SF.NET
       def createReleaseOnSFNET
-        puts 'Creating Release on SF.NET ...'
+        logDebug 'Creating Release on SF.NET ...'
         sshWithPassword(
           'shell.sourceforge.net',
           @SFLogin,
@@ -130,7 +133,7 @@ module RubyPackager
       # Upload the generated files on SF.NET
       def uploadFilesOnSFNET
         @GeneratedFileNames.each do |iFileName|
-          puts "Uploading #{iFileName} on SF.NET ..."
+          logDebug "Uploading #{iFileName} on SF.NET ..."
           scpWithPassword(
             'shell.sourceforge.net',
             @SFLogin,
@@ -142,14 +145,14 @@ module RubyPackager
 
       # Upload the Release note on SF.NET
       def uploadReleaseNoteOnSFNET
-        puts 'Uploading Release Note on SF.NET ...'
+        logDebug 'Uploading Release Note on SF.NET ...'
         scpWithPassword(
           'shell.sourceforge.net',
           @SFLogin,
           "#{@DocDir}/ReleaseNote.html",
           "#{@SFReleaseDir}/ReleaseNote.html"
         )
-        puts '!!! DON\'T FORGET to make association between ReleaseNote and Gem in SF.NET'
+        logInfo '!!! DON\'T FORGET to make association between ReleaseNote and Gem in SF.NET'
       end
 
     end

data/{F:/RR/Source/rubypackager/svn/rubypackager/Releases/i386-mswin32/0.1.0.20091021/Normal/2009_10_21_19_10_02/Release/lib → lib}/RubyPackager/Installers/Gem.rb

@@ -9,14 +9,6 @@ module RubyPackager
 
     class Gem
 
-      # Check that we can use this installer
-      #
-      # Return:
-      # * _Boolean_: Can we use this installer ?
-      def checkTools
-        return true
-      end
-
       # Create the installer with everything in the release directory.
       #
       # Parameters:
@@ -30,6 +22,8 @@ module RubyPackager
       def createInstaller(iRootDir, iReleaseDir, iInstallerDir, iVersion, iReleaseInfo)
         rFileName = nil
 
+        lOldDir = Dir.getwd
+        Dir.chdir(iReleaseDir)
         # 1. Generate the gemspec that will build the gem
         lStrHasRDoc = nil
         if (iReleaseInfo.GemInfo[:HasRDoc])
@@ -37,12 +31,12 @@ module RubyPackager
         else
           lStrHasRDoc = 'false'
         end
-        lFilesFilter = "#{iReleaseDir}/**/*"
-        lStrFiles = "iSpec.files = [ '#{Dir.glob(lFilesFilter).join('\', \'')}' ]"
+        # !!! Don't use absolute paths here, otherwise they will be stored in the Gem
+        lStrFiles = "iSpec.files = [ '#{Dir.glob('**/*').join('\', \'')}' ]"
         lStrExtraRDocFiles = ''
         if ((iReleaseInfo.GemInfo[:ExtraRDocFiles] != nil) and
             (!iReleaseInfo.GemInfo[:ExtraRDocFiles].empty?))
-          lStrExtraRDocFiles = "iSpec.extra_rdoc_files = [ '#{@Description[:ExtraRDocFiles].join('\', \'')}' ]"
+          lStrExtraRDocFiles = "iSpec.extra_rdoc_files = [ '#{iReleaseInfo.GemInfo[:ExtraRDocFiles].join('\', \'')}' ]"
           RubyPackager::copyFiles(iRootDir, iReleaseDir, iReleaseInfo.GemInfo[:ExtraRDocFiles])
         end
         lGemDepsStrList = []
@@ -64,7 +58,7 @@ module RubyPackager
         lStrDefaultExecutable = ''
         if (iReleaseInfo.ExecutableInfo[:StartupRBFile] != nil)
           lStrBinDir = "iSpec.bindir = '#{File.dirname(iReleaseInfo.ExecutableInfo[:StartupRBFile])}'"
-          lStrDefaultExecutable = "iSpec.default_executable = '#{File.basename(iReleaseInfo.ExecutableInfo[:StartupRBFile])}'"
+          lStrDefaultExecutable = "iSpec.executables = [ '#{File.basename(iReleaseInfo.ExecutableInfo[:StartupRBFile])}' ]"
         end
         lGemSpecFileName = 'release.gemspec.rb'
         File.open(lGemSpecFileName, 'w') do |oFile|
@@ -100,7 +94,7 @@ end
         rescue ::Gem::SystemExitException
           # For RubyGems, this is normal behaviour: success results in an exception thrown with exit_code 0.
           if ($!.exit_code != 0)
-            puts "!!! RubyGems returned error #{$!.exit_code}."
+            logErr "RubyGems returned error #{$!.exit_code}."
             lGemOK = false
           end
         end
@@ -111,6 +105,7 @@ end
           rFileName = "#{iReleaseInfo.GemInfo[:GemName]}-#{iVersion}.gem"
           FileUtils::mv(rFileName, "#{iInstallerDir}/#{rFileName}")
         end
+        Dir.chdir(lOldDir)
 
         return rFileName
       end

data/{F:/RR/Source/rubypackager/svn/rubypackager/Releases/i386-mswin32/0.1.0.20091021/Normal/2009_10_21_19_10_02/Release/lib → lib}/RubyPackager/ReleaseInfo.rb

@@ -48,17 +48,6 @@ module RubyPackager
     #   list< String >
     attr_reader :TestFiles
 
-    # Check if the tools needed for the release are ok
-    # This is meant to be overriden if needed
-    #
-    # Parameters:
-    # * *iRootDir* (_String_): Root directory from where the release is happening
-    # Return:
-    # * _Boolean_: Success ?
-    def checkTools(iRootDir)
-      return true
-    end
-    
     # Constructor
     def initialize
       # This sets also default values
@@ -131,6 +120,7 @@ module RubyPackager
     # Parameters:
     # * *iParams* (<em>map<Symbol,Object></em>): The parameters:
     # ** *:NSISFileName* (_String_): Name of the NSI file to use to generate the installer
+    # ** *:InstallerName* (_String_): Name of the generated installer
     # Return:
     # * _ReleaseInfo_: self
     def install(iParams)