RubyPackager 0.2.1.20101110 → 1.0.0.20120301

data/lib/RubyPackager/Tools.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.
 #++
 
@@ -7,39 +7,28 @@ module RubyPackager
 
   module Tools
 
-    # The map of stored passwords, per login
-    @@Passwords = {}
-
-    # Get a needed password.
-    # Ask it from the user if we don't know it
+    # Set options that will be used by SSH calls
     #
-    # Parameters:
-    # * *iLogin* (_String_): Login for which we want the password
-    # Return:
-    # * _String_: Password
-    def getPassword(iLogin)
-      if (@@Passwords[iLogin] == nil)
-        # Ask for it
-        puts "Enter password for login #{iLogin}:"
-        # TODO: Hide the output
-        @@Passwords[iLogin] = $stdin.gets.strip
-      end
-
-      return @@Passwords[iLogin]
+    # Parameters::
+    # * *iSSHHost* (_String_): The SSH host
+    # * *iSSHLogin* (_String_): The SSH login
+    # * *iOptions* (<em>map<Symbol,Object></em>): Additional options [optional = {}]:
+    #   * *:ask_for_password* (_Boolean_): Do we ask for the user password to give to SSH ?
+    #   * *:ask_for_key_passphrase* (_Boolean_): Do we ask for the key passphrase to give to SSH ?
+    def set_ssh_options(iSSHHost, iSSHLogin, iOptions = {})
+      @SSHHost, @SSHLogin, @SSHOptions = iSSHHost, iSSHLogin, iOptions
     end
 
     # Execute some SSH command on a remote host protected with password
     #
-    # Parameters:
-    # * *iSSHHost* (_String_): The SSH host
-    # * *iSSHLogin* (_String_): The SSH login
+    # Parameters::
     # * *iCmd* (_String_): The command to execute
-    def sshWithPassword(iSSHHost, iSSHLogin, iCmd)
+    def ssh(iCmd)
       require 'net/ssh'
       Net::SSH.start(
-        iSSHHost,
-        iSSHLogin,
-        :password => getPassword(iSSHLogin)
+        @SSHHost,
+        @SSHLogin,
+        get_net_ssh_options
       ) do |iSSH|
         puts(iSSH.exec!(iCmd))
       end
@@ -47,17 +36,15 @@ module RubyPackager
 
     # Copy files through SCP.
     #
-    # Parameters:
-    # * *iSCPHost* (_String_): Host
-    # * *iSCPLogin* (_String_): Login
+    # Parameters::
     # * *iFileSrc* (_String_): Path to local file to copy from
     # * *iFileDst* (_String_): Path to remote file to copy to
-    def scpWithPassword(iSCPHost, iSCPLogin, iFileSrc, iFileDst)
+    def scp(iFileSrc, iFileDst)
       require 'net/scp'
       Net::SCP.start(
-        iSCPHost,
-        iSCPLogin,
-        :password => getPassword(iSCPLogin)
+        @SSHHost,
+        @SSHLogin,
+        get_net_ssh_options
       ) do |iSCP|
         iSCP.upload!(iFileSrc, iFileDst) do |iChunk, iName, iSent, iTotal|
           printf "#{iName}: #{iSent}/#{iTotal}\015"
@@ -67,6 +54,48 @@ module RubyPackager
       end
     end
 
+    private
+
+    # The map of stored passwords, per login
+    @@Passwords = {}
+
+    # Get a needed password.
+    # Ask it from the user if we don't know it
+    #
+    # Parameters::
+    # * *iLogin* (_String_): String for which we want the password
+    # Return::
+    # * _String_: Password
+    def get_password(iLogin)
+      if (@@Passwords[iLogin] == nil)
+        # Ask for it
+        require 'highline/import'
+        @@Passwords[iLogin] = ask("Enter password for #{iLogin}:") do |ioQuestion|
+          ioQuestion.echo = false
+        end
+      end
+
+      return @@Passwords[iLogin]
+    end
+
+    # Get the real SSH options that will be given to the Net::SSH library
+    # These are based on the way SSH options are set by set_ssh_options
+    #
+    # Return::
+    # * <em>map<Symbol,Object></em>: The Net::SSH options
+    def get_net_ssh_options
+      rOptions = {}
+
+      if (@SSHOptions[:ask_for_password])
+        rOptions[:password] = get_password("login #{@SSHLogin}")
+      end
+      if (@SSHOptions[:ask_for_key_passphrase])
+        rOptions[:passphrase] = get_password("key passphrase of #{@SSHLogin}")
+      end
+
+      return rOptions
+    end
+
   end
 
 end

data/lib/RubyPackager/i386-cygwin/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,18 +16,19 @@ 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
@@ -38,14 +39,14 @@ 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"
@@ -55,21 +56,21 @@ module RubyPackager
         # First create the binary containing all ruby
         lBinDir = "#{iReleaseDir}/#{lBinSubDir}"
         FileUtils::mkdir_p(lBinDir)
-        changeDir(lBinDir) do
+        change_dir(lBinDir) do
           lCmd = "allinoneruby #{lBinName}"
           rSuccess = system(lCmd)
           if (!rSuccess)
-            logErr "Error while executing \"#{lCmd}\""
+            log_err "Error while executing \"#{lCmd}\""
           end
         end
       end
       if (rSuccess)
         # Then create the real executable
         # Generate the Shell file that launches everything for Linux
-        File.open("#{iReleaseDir}/#{iExecutableInfo[:ExeName]}", 'w') do |oFile|
+        File.open("#{iReleaseDir}/#{iExecutableInfo[:exe_name]}", 'w') do |oFile|
           oFile << "\#!/bin/sh
 \#--
-\# 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.
 \#++
 
@@ -94,14 +95,14 @@ then
   \# Set the environment correctly to execute Ruby from the extracted dir
   export LD_LIBRARY_PATH=`pwd`/tempruby/bin:`pwd`/tempruby/lib:`pwd`/tempruby/lib/lib1:`pwd`/tempruby/lib/lib2:`pwd`/tempruby/lib/lib3:`pwd`/tempruby/lib/lib4:${LD_LIRARY_PATH}
   export RUBYOPT=
-  ./tempruby/bin/ruby -w #{iExecutableInfo[:StartupRBFile]}
+  ./tempruby/bin/ruby -w #{iExecutableInfo[:startup_rb_file]}
 else
   echo 'Ruby found on current platform. Use it directly.'
-  ruby -w #{iExecutableInfo[:StartupRBFile]}
+  ruby -w #{iExecutableInfo[:startup_rb_file]}
 fi
 "
         end
-        File.chmod(0755, "#{iReleaseDir}/#{iExecutableInfo[:ExeName]}")
+        File.chmod(0755, "#{iReleaseDir}/#{iExecutableInfo[:exe_name]}")
       end
 
       return rSuccess

data/lib/RubyPackager/i386-linux/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,18 +16,19 @@ 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
@@ -38,14 +39,14 @@ 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"
@@ -55,21 +56,21 @@ module RubyPackager
         # First create the binary containing all ruby
         lBinDir = "#{iReleaseDir}/#{lBinSubDir}"
         FileUtils::mkdir_p(lBinDir)
-        changeDir(lBinDir) do
+        change_dir(lBinDir) do
           lCmd = "allinoneruby #{lBinName}"
           rSuccess = system(lCmd)
           if (!rSuccess)
-            logErr "Error while executing \"#{lCmd}\""
+            log_err "Error while executing \"#{lCmd}\""
           end
         end
       end
       if (rSuccess)
         # Then create the real executable
         # Generate the Shell file that launches everything for Linux
-        File.open("#{iReleaseDir}/#{iExecutableInfo[:ExeName]}", 'w') do |oFile|
+        File.open("#{iReleaseDir}/#{iExecutableInfo[:exe_name]}", 'w') do |oFile|
           oFile << "\#!/bin/sh
 \#--
-\# 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.
 \#++
 
@@ -94,14 +95,14 @@ then
   \# Set the environment correctly to execute Ruby from the extracted dir
   export LD_LIBRARY_PATH=`pwd`/tempruby/bin:`pwd`/tempruby/lib:`pwd`/tempruby/lib/lib1:`pwd`/tempruby/lib/lib2:`pwd`/tempruby/lib/lib3:`pwd`/tempruby/lib/lib4:${LD_LIRARY_PATH}
   export RUBYOPT=
-  ./tempruby/bin/ruby -w #{iExecutableInfo[:StartupRBFile]}
+  ./tempruby/bin/ruby -w #{iExecutableInfo[:startup_rb_file]}
 else
   echo 'Ruby found on current platform. Use it directly.'
-  ruby -w #{iExecutableInfo[:StartupRBFile]}
+  ruby -w #{iExecutableInfo[:startup_rb_file]}
 fi
 "
         end
-        File.chmod(0755, "#{iReleaseDir}/#{iExecutableInfo[:ExeName]}")
+        File.chmod(0755, "#{iReleaseDir}/#{iExecutableInfo[:exe_name]}")
       end
 
       return rSuccess

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

@@ -0,0 +1,59 @@
+#--
+# Copyright (c) 2009 - 2012 Muriel Salvan (muriel@x-aeon.com)
+# Licensed under the terms specified in LICENSE file. No warranty is provided.
+#++
+
+module RubyPackager
+
+  module Installers
+
+    class NSIS
+
+      # Check that we can use this installer
+      #
+      # Return::
+      # * _Boolean_: Can we use this installer ?
+      def check_tools
+        rSuccess = true
+
+        # Check that makensis is present
+        if (!system('makensis /VERSION'))
+          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
+
+        return rSuccess
+      end
+
+      # Create the installer with everything in the release directory.
+      #
+      # 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::
+      # * _String_: File name to distribute, or nil in case of failure
+      def create_installer(iRootDir, iReleaseDir, iInstallerDir, iVersion, iReleaseInfo)
+        rFileName = nil
+
+        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.install_info[:nsis_file_name].gsub(/\//,'\\')}\"")
+          if (lNSISOK)
+            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
+
+        return rFileName
+      end
+
+    end
+
+  end
+
+end

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

@@ -0,0 +1,171 @@
+#--
+# Copyright (c) 2009 - 2012 Muriel Salvan (muriel@x-aeon.com)
+# Licensed under the terms specified in LICENSE file. No warranty is provided.
+#++
+
+# This file prepares a win32 distribution on mingw32 architecture
+
+# Require needed to generate the temporary ruby file that produces the executable
+require 'tmpdir'
+
+module RubyPackager
+
+  class PlatformReleaser
+
+    PLATFORM_DIR = File.dirname(__FILE__)
+
+    # Check if the tools we will use to generate an executable are present
+    #
+    # Parameters::
+    # * *iRootDir* (_String_): Root directory
+    # * *iIncludeRuby* (_Boolean_): Do we include Ruby in the release ?
+    # * *iNeedBinaryCompilation* (_Boolean_): Do we need to compile RB files into a binary executable ?
+    # Return::
+    # * _Boolean_: Are tools correctly useable ?
+    def check_exe_tools(iRootDir, iIncludeRuby, iNeedBinaryCompilation)
+      rSuccess = true
+
+      if (iIncludeRuby)
+        # We need allinoneruby
+        if (Gem.find_files('allinoneruby').empty?)
+          log_err "Need to have allinoneruby gem to release including Ruby.\nPlease install allinoneruby gem (gem install allinoneruby)."
+          rSuccess = false
+        end
+      end
+      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
+    end
+
+    # Create the binary.
+    # This is called when the core library has been copied in the release directory.
+    #
+    # 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::
+    # * _Boolean_: Success ?
+    def create_binary(iRootDir, iReleaseDir, iIncludeRuby, iExecutableInfo)
+      rSuccess = true
+
+      lBinSubDir = "Launch/#{RUBY_PLATFORM}/bin"
+      lRubyBaseBinName = nil
+      lRubyLaunchCmd = nil
+      if (iExecutableInfo[:terminal_application])
+        lRubyBaseBinName = 'ruby'
+        lRubyLaunchCmd = 'ruby'
+      else
+        lRubyBaseBinName = 'rubyw'
+        lRubyLaunchCmd = 'start rubyw'
+      end
+      lBinName = "#{lRubyBaseBinName}-#{RUBY_VERSION}.exe"
+      if (iIncludeRuby)
+        # First create the binary containing all ruby
+        lBinDir = "#{iReleaseDir}/#{lBinSubDir}"
+        FileUtils::mkdir_p(lBinDir)
+        change_dir(lBinDir) do
+          lCmd = nil
+          if (iExecutableInfo[:terminal_application])
+            lCmd = "allinoneruby.bat #{lBinName}"
+          else
+            lCmd = "allinoneruby.bat --rubyw #{lBinName}"
+          end
+          rSuccess = system(lCmd)
+          if (!rSuccess)
+            log_err "Error while executing \"#{lCmd}\""
+          end
+        end
+      end
+      if (rSuccess)
+        # Then create the real executable
+        # Generate the Ruby file that launches everything for Windows
+        lTempFileName = "#{Dir.tmpdir}/EXE_#{RUBY_PLATFORM}_Gen.rb"
+        File.open(lTempFileName, 'w') do |oFile|
+          oFile << "
+\#--
+\# Copyright (c) 2009 - 2012 Muriel Salvan (muriel@x-aeon.com)
+\# Licensed under the terms specified in LICENSE file. No warranty is provided.
+\#++
+
+\# This file is generated by RubyPackager for Windows (mingw32).
+\# This is a temporary file that should not exist anymore once the release has been done.
+
+\# This file has to launch the correct binary. There can be several binaries dependending on the configuration.
+\# This is the file that will be created as the executable to launch.
+
+module RubyPackager
+
+  \# Execute a shell command
+  \#
+  \# Parameters::
+  \# * *iCmd* (_String_): The shell command to execute
+  \# Return::
+  \# * _Boolean_: Success ?
+  def self.shellExecute(iCmd)
+    puts \"> \#{iCmd}\"
+    rSuccess = system(iCmd)
+
+    if (!rSuccess)
+      puts \"Error while executing '\#{iCmd}'\"
+    end
+
+    return rSuccess
+  end
+
+end
+
+\# Test if Ruby is installed
+lSuccess = false
+lCurrentDir = Dir.getwd
+if (system('#{lRubyBaseBinName} --version'))
+  \# Launch directly
+  puts \"Ruby found in environment. Using it directly.\"
+  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[:startup_rb_file]}\\\" \#{ARGV.join(' ')}\")
+  if (!lSuccess)
+    puts 'Unable to execute the application. Please reinstall it.'
+    puts 'Hit enter to quit.'
+    $stdin.gets
+  end
+end
+"
+        end
+        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[:exe_name]}.exe #{iRootDir}/#{iExecutableInfo[:icon_name]}"
+          rSuccess = system(lEdiconCmd)
+          if (!rSuccess)
+            log_err "Error while executing \"#{lEdiconCmd}\""
+          end
+        else
+          log_err "Error while executing \"exerb.bat -o #{iExecutableInfo[:exe_name]}.exe #{lTempFileName}\""
+        end
+      end
+
+      return rSuccess
+    end
+
+  end
+
+end