RubyPackager 0.2.1.20101110 → 1.0.0.20120301

data/lib/RubyPackager/i386-mswin32/Installers/NSIS.rb

@@ -1,5 +1,5 @@
 #--
-# Copyright (c) 2009-2010 Muriel Salvan (murielsalvan@users.sourceforge.net)
+# Copyright (c) 2009 - 2012 Muriel Salvan (muriel@x-aeon.com)
 # Licensed under the terms specified in LICENSE file. No warranty is provided.
 #++
 
@@ -11,14 +11,14 @@ module RubyPackager
 
       # Check that we can use this installer
       #
-      # Return:
+      # Return::
       # * _Boolean_: Can we use this installer ?
-      def checkTools
+      def check_tools
         rSuccess = true
 
         # Check that makensis is present
         if (!system('makensis /VERSION'))
-          logErr "Need to have MakeNSIS installed in the system PATH to create installer.\nPlease download and install MakeNSIS in the PATH from http://nsis.sourceforge.net/Main_Page"
+          log_err "Need to have MakeNSIS installed in the system PATH to create installer.\nPlease download and install MakeNSIS in the PATH from http://nsis.sourceforge.net/Main_Page"
           rSuccess = false
         end
 
@@ -27,24 +27,24 @@ module RubyPackager
 
       # Create the installer with everything in the release directory.
       #
-      # Parameters:
+      # Parameters::
       # * *iRootDir* (_String_): The Root directory
       # * *iReleaseDir* (_String_): The release directory (all files to put in the installer are there)
       # * *iInstallerDir* (_String_): The directory where the installer has to be put
       # * *iVersion* (_String_): Release version
       # * *iReleaseInfo* (_ReleaseInfo_): Release info
-      # Return:
+      # Return::
       # * _String_: File name to distribute, or nil in case of failure
-      def createInstaller(iRootDir, iReleaseDir, iInstallerDir, iVersion, iReleaseInfo)
+      def create_installer(iRootDir, iReleaseDir, iInstallerDir, iVersion, iReleaseInfo)
         rFileName = nil
 
-        if (iReleaseInfo.InstallInfo[:NSISFileName] == nil)
-          logErr 'No NSISFileName specified among the Install description.'
+        if (iReleaseInfo.install_info[:nsis_file_name] == nil)
+          log_err 'No NSISFileName specified among the Install description.'
         else
-          lNSISOK = system("makensis /DVERSION=#{iVersion} \"/DRELEASEDIR=#{iReleaseDir.gsub(/\//,'\\')}\" \"#{iRootDir.gsub(/\//,'\\')}\\#{iReleaseInfo.InstallInfo[:NSISFileName].gsub(/\//,'\\')}\"")
+          lNSISOK = system("makensis /DVERSION=#{iVersion} \"/DRELEASEDIR=#{iReleaseDir.gsub(/\//,'\\')}\" \"#{iRootDir.gsub(/\//,'\\')}\\#{iReleaseInfo.install_info[:nsis_file_name].gsub(/\//,'\\')}\"")
           if (lNSISOK)
-            lInstallerDir = File.dirname("#{iRootDir}/#{iReleaseInfo.InstallInfo[:NSISFileName]}")
-            rFileName = "#{iReleaseInfo.InstallInfo[:InstallerName]}_#{iVersion}_setup.exe"
+            lInstallerDir = File.dirname("#{iRootDir}/#{iReleaseInfo.install_info[:nsis_file_name]}")
+            rFileName = "#{iReleaseInfo.install_info[:installer_name]}_#{iVersion}_setup.exe"
             FileUtils.mv("#{lInstallerDir}/setup.exe", "#{iInstallerDir}/#{rFileName}")
           end
         end

data/lib/RubyPackager/i386-mswin32/PlatformReleaser.rb

@@ -1,5 +1,5 @@
 #--
-# Copyright (c) 2009-2010 Muriel Salvan (murielsalvan@users.sourceforge.net)
+# Copyright (c) 2009 - 2012 Muriel Salvan (muriel@x-aeon.com)
 # Licensed under the terms specified in LICENSE file. No warranty is provided.
 #++
 
@@ -16,30 +16,33 @@ module RubyPackager
 
     # Check if the tools we will use to generate an executable are present
     #
-    # Parameters:
+    # Parameters::
     # * *iRootDir* (_String_): Root directory
     # * *iIncludeRuby* (_Boolean_): Do we include Ruby in the release ?
-    # Return:
+    # * *iNeedBinaryCompilation* (_Boolean_): Do we need to compile RB files into a binary executable ?
+    # Return::
     # * _Boolean_: Are tools correctly useable ?
-    def checkExeTools(iRootDir, iIncludeRuby)
+    def check_exe_tools(iRootDir, iIncludeRuby, iNeedBinaryCompilation)
       rSuccess = true
 
       if (iIncludeRuby)
         # We need allinoneruby
         if (Gem.find_files('allinoneruby').empty?)
-          logErr "Need to have allinoneruby gem to release including Ruby.\nPlease install allinoneruby gem (gem install allinoneruby)."
+          log_err "Need to have allinoneruby gem to release including Ruby.\nPlease install allinoneruby gem (gem install allinoneruby)."
           rSuccess = false
         end
       end
-      # Check that edicon is present
-      if (!File.exists?("#{PLATFORM_DIR}/edicon/edicon.exe"))
-        logErr "Need to have edicon.exe installed in #{PLATFORM_DIR}/edicon to set a Windows executable's icon.\nPlease install edicon, part of Ocra Gem (gem install ocra), and copy from the Gem directory (ocra-1.1.1/share/ocra/edicon.exe) to #{PLATFORM_DIR}/edicon/edicon.exe."
-        rSuccess = false
-      end
-      # Check that exerb is present
-      if (!system('exerb.bat --version'))
-        logErr "Need to have exerb installed in the system PATH to create a Windows executable.\nPlease download and install exerb from http://exerb.sourceforge.jp/index.en.html"
-        rSuccess = false
+      if (iNeedBinaryCompilation)
+        # Check that edicon is present
+        if (!File.exists?("#{PLATFORM_DIR}/edicon/edicon.exe"))
+          log_err "Need to have edicon.exe installed in #{PLATFORM_DIR}/edicon to set a Windows executable's icon.\nPlease install edicon, part of Ocra Gem (gem install ocra), and copy from the Gem directory (ocra-1.1.1/share/ocra/edicon.exe) to #{PLATFORM_DIR}/edicon/edicon.exe."
+          rSuccess = false
+        end
+        # Check that exerb is present
+        if (!system('exerb.bat --version'))
+          log_err "Need to have exerb installed in the system PATH to create a Windows executable.\nPlease download and install exerb from http://exerb.sourceforge.jp/index.en.html"
+          rSuccess = false
+        end
       end
 
       return rSuccess
@@ -48,20 +51,20 @@ module RubyPackager
     # Create the binary.
     # This is called when the core library has been copied in the release directory.
     #
-    # Parameters:
+    # Parameters::
     # * *iRootDir* (_String_): Root directory
     # * *iReleaseDir* (_String_): Release directory
     # * *iIncludeRuby* (_Boolean_): Do we include Ruby in the release ?
     # * *iExecutableInfo* (<em>map<Symbol,Object></em>): The executable information
-    # Return:
+    # Return::
     # * _Boolean_: Success ?
-    def createBinary(iRootDir, iReleaseDir, iIncludeRuby, iExecutableInfo)
+    def create_binary(iRootDir, iReleaseDir, iIncludeRuby, iExecutableInfo)
       rSuccess = true
 
       lBinSubDir = "Launch/#{RUBY_PLATFORM}/bin"
       lRubyBaseBinName = nil
       lRubyLaunchCmd = nil
-      if (iExecutableInfo[:TerminalApplication])
+      if (iExecutableInfo[:terminal_application])
         lRubyBaseBinName = 'ruby'
         lRubyLaunchCmd = 'ruby'
       else
@@ -73,16 +76,16 @@ module RubyPackager
         # First create the binary containing all ruby
         lBinDir = "#{iReleaseDir}/#{lBinSubDir}"
         FileUtils::mkdir_p(lBinDir)
-        changeDir(lBinDir) do
+        change_dir(lBinDir) do
           lCmd = nil
-          if (iExecutableInfo[:TerminalApplication])
+          if (iExecutableInfo[:terminal_application])
             lCmd = "allinoneruby.bat #{lBinName}"
           else
             lCmd = "allinoneruby.bat --rubyw #{lBinName}"
           end
           rSuccess = system(lCmd)
           if (!rSuccess)
-            logErr "Error while executing \"#{lCmd}\""
+            log_err "Error while executing \"#{lCmd}\""
           end
         end
       end
@@ -93,7 +96,7 @@ module RubyPackager
         File.open(lTempFileName, 'w') do |oFile|
           oFile << "
 \#--
-\# Copyright (c) 2009-2010 Muriel Salvan (murielsalvan@users.sourceforge.net)
+\# Copyright (c) 2009 - 2012 Muriel Salvan (muriel@x-aeon.com)
 \# Licensed under the terms specified in LICENSE file. No warranty is provided.
 \#++
 
@@ -107,9 +110,9 @@ module RubyPackager
 
   \# Execute a shell command
   \#
-  \# Parameters:
+  \# Parameters::
   \# * *iCmd* (_String_): The shell command to execute
-  \# Return:
+  \# Return::
   \# * _Boolean_: Success ?
   def self.shellExecute(iCmd)
     puts \"> \#{iCmd}\"
@@ -130,12 +133,12 @@ lCurrentDir = Dir.getwd
 if (system('#{lRubyBaseBinName} --version'))
   \# Launch directly
   puts \"Ruby found in environment. Using it directly.\"
-  lSuccess = RubyPackager::shellExecute(\"#{lRubyLaunchCmd} -w \\\"\#{lCurrentDir}/#{iExecutableInfo[:StartupRBFile]}\\\" \#{ARGV.join(' ')}\")
+  lSuccess = RubyPackager::shellExecute(\"#{lRubyLaunchCmd} -w \\\"\#{lCurrentDir}/#{iExecutableInfo[:startup_rb_file]}\\\" \#{ARGV.join(' ')}\")
 end
 if (!lSuccess)
   \# Use allinoneruby
   puts \"Ruby not found in environment. Using shipped Ruby.\"
-  lSuccess = RubyPackager::shellExecute(\"start \\\"Title\\\" \\\"\#{lCurrentDir}/#{lBinSubDir}/#{lBinName}\\\" \\\"\#{lCurrentDir}/#{iExecutableInfo[:StartupRBFile]}\\\" \#{ARGV.join(' ')}\")
+  lSuccess = RubyPackager::shellExecute(\"start \\\"Title\\\" \\\"\#{lCurrentDir}/#{lBinSubDir}/#{lBinName}\\\" \\\"\#{lCurrentDir}/#{iExecutableInfo[:startup_rb_file]}\\\" \#{ARGV.join(' ')}\")
   if (!lSuccess)
     puts 'Unable to execute the application. Please reinstall it.'
     puts 'Hit enter to quit.'
@@ -144,19 +147,19 @@ if (!lSuccess)
 end
 "
         end
-        changeDir(iReleaseDir) do
-          rSuccess = system("exerb.bat -o #{iExecutableInfo[:ExeName]}.exe #{lTempFileName}")
+        change_dir(iReleaseDir) do
+          rSuccess = system("exerb.bat -o #{iExecutableInfo[:exe_name]}.exe #{lTempFileName}")
         end
         if (rSuccess)
           File.unlink(lTempFileName)
           # And set its icon
-          lEdiconCmd = "#{PLATFORM_DIR}/edicon/edicon.exe #{iReleaseDir}/#{iExecutableInfo[:ExeName]}.exe #{iRootDir}/#{iExecutableInfo[:IconName]}"
+          lEdiconCmd = "#{PLATFORM_DIR}/edicon/edicon.exe #{iReleaseDir}/#{iExecutableInfo[:exe_name]}.exe #{iRootDir}/#{iExecutableInfo[:icon_name]}"
           rSuccess = system(lEdiconCmd)
           if (!rSuccess)
-            logErr "Error while executing \"#{lEdiconCmd}\""
+            log_err "Error while executing \"#{lEdiconCmd}\""
           end
         else
-          logErr "Error while executing \"exerb.bat -o #{iExecutableInfo[:ExeName]}.exe #{lTempFileName}\""
+          log_err "Error while executing \"exerb.bat -o #{iExecutableInfo[:exe_name]}.exe #{lTempFileName}\""
         end
       end
 

metadata

@@ -3,11 +3,11 @@ name: RubyPackager
 version: !ruby/object:Gem::Version 
   prerelease: false
   segments: 
-  - 0
-  - 2
   - 1
-  - 20101110
-  version: 0.2.1.20101110
+  - 0
+  - 0
+  - 20120301
+  version: 1.0.0.20120301
 platform: ruby
 authors: 
 - Muriel Salvan
@@ -15,24 +15,51 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-11-10 00:00:00 +01:00
+date: 2012-03-01 00:00:00 +01:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: rUtilAnts
   prerelease: false
   requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
         segments: 
-        - 0
         - 1
-        version: "0.1"
+        - 0
+        version: "1.0"
   type: :runtime
   version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: allinoneruby
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        version: "0"
+  type: :runtime
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: highline
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        version: "0"
+  type: :runtime
+  version_requirements: *id003
 description: Generate installable binary distributions of Ruby programs for many platforms (many OS, with or without Ruby installed on clients...). Fit to distribute extensible (plugins) Ruby programs also. Handles also libraries and uploads on websites (SF.net...).
-email: murielsalvan@users.sourceforge.net
+email: muriel@x-aeon.com
 executables: 
 - Release.rb
 extensions: []
@@ -44,9 +71,13 @@ files:
 - bin/Release.rb
 - ChangeLog
 - Credits
+- lib/RubyPackager/Distributors/RubyGems.rb
 - lib/RubyPackager/Distributors/SourceForge.rb
 - lib/RubyPackager/i386-cygwin/PlatformReleaser.rb
 - lib/RubyPackager/i386-linux/PlatformReleaser.rb
+- lib/RubyPackager/i386-mingw32/edicon/edicon.exe
+- lib/RubyPackager/i386-mingw32/Installers/NSIS.rb
+- lib/RubyPackager/i386-mingw32/PlatformReleaser.rb
 - lib/RubyPackager/i386-mswin32/edicon/edicon.exe
 - lib/RubyPackager/i386-mswin32/Installers/NSIS.rb
 - lib/RubyPackager/i386-mswin32/PlatformReleaser.rb
@@ -57,7 +88,6 @@ files:
 - LICENSE
 - README
 - ReleaseInfo
-- TODO
 has_rdoc: true
 homepage: http://rubypackager.sourceforge.net/
 licenses: []
@@ -68,6 +98,7 @@ rdoc_options: []
 require_paths: 
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
@@ -75,6 +106,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       - 0
       version: "0"
 required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
@@ -84,7 +116,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements: []
 
 rubyforge_project: rubypackager
-rubygems_version: 1.3.6
+rubygems_version: 1.3.7
 signing_key: 
 specification_version: 3
 summary: Solution to release Ruby programs on any platform.

data/TODO

@@ -1,16 +0,0 @@
-* 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.
-** As it is possible to have many failures when delivering or generating installers, and as generating executables and documentation is a long process, it should be better to reuse partially generated content.
-** Delivering a Gem has to be done using "gem push" with a RubyGems.org account info.