ocra 1.1.3 → 1.1.4

data/History.txt

@@ -1,3 +1,17 @@
+=== 1.1.4
+
+* The tempdir marker is now pretty-printed as "<tempdir>" in the
+  output.
+
+* Fixed various issues with path and filenames being handled case
+  sensitive.
+
+* Now uses config settings for Ruby executable names (should now also
+  work with ruby installations built with --program-suffix).
+
+* Supported invoking ocra with an absolute path to the script. Will
+  assume that the script is in the root of the source hierachy.
+
 === 1.1.3
 
 * Use Win32API (provided with Ruby) instead of win32-api (gem).

data/README.txt

@@ -1,5 +1,6 @@
 = ocra
 
+* http://ocra.rubyforge.org/
 * http://rubyforge.org/projects/ocra/
 * http://github.com/larsch/ocra/
 
@@ -15,8 +16,7 @@ any additionally needed ruby libraries or DLL.
 * LZMA Compression (optional, default on)
 * Windows support only
 * Ruby 1.9 support
-* Both console programs and desktop programs supported (no console will
-  pop up with .rbw files).
+* Both windowed/console mode supported
 
 If you experience problems with OCRA or have found a bug, please use
 the tracker on the RubyForge project page
@@ -29,44 +29,68 @@ in the forums there aswell.
 
 == SYNOPSIS:
 
-ocra [option] your/script.rb
+  ocra [option] script.rb
+
+* Will package "script.rb", the Ruby interpreter and all dependencies
+  (gems and DLLs) into an executable named "script.exe".
+
+=== Compilation:
 
 * OCRA will load your script (using Kernel#load) and build the
   executable when it exits.
 
 * Your program should 'require' all necessary files when invoked without
-  arguments, so ocra can detect all dependencies.
+  arguments, so OCRA can detect all dependencies.
+
+* DLLs are detected automatically but only those located in your Ruby
+  installation are included.
+
+* .rb files will become console applications. .rbw files will become
+  windowed application (without a console window popping
+  up). Alternatively, use the <tt>--console</tt> or <tt>--windows</tt>
+  options.
+
+=== Running your application:
+
+* The 'current working directory' is not changed by OCRA when running
+  your application. You must change to the installation or temporary
+  directory yourself. See also below.
+
+* When the application is running, the OCRA_EXECUTABLE environment
+  variable points to the .exe (with full path).
 
-* OCRA executables clear the RUBYLIB environment variable but set
-  RUBYOPT to whatever value it had when you invoked OCRA.
+* The temporary location of the script can be obtained by inspected
+  the $0 variable.
 
-* OCRA does not set up the include path. Use "$:.unshift
-  File.dirname(__FILE__)" at the start of your script if you need to
-  'require' additional source files in the same directory no matter
-  what the user's current working directory is.
+* OCRA does not set up the include path. Use <tt>$:.unshift
+  File.dirname($0)</tt> at the start of your script if you need to
+  'require' additional source files from the same directory as your
+  main script.
 
-* Loaded DLLs are detected automatically but only those located in
-  your Ruby installation are included. Automatic detection can be
-  disabled using --no-autodll. DLLs can be manually added using the
-  --dll option.
+=== Pitfalls:
 
-* The current working directory is left untouched by OCRA (Details
-  below).
+* Avoid modifying load paths at run time. Specify load paths using -I
+  or RUBYLIB if you must, but don't expect OCRA to preserve them for
+  runtime. OCRA may pack sources into other directories than you
+  expect.
+
+* If you use .rbw files or the <tt>--windows</tt> option, then check
+  that your application works with rubyw.exe before trying with OCRA.
+
+* Avoid absolute paths in your code and when invoking OCRA.
 
-* When the script is running, the OCRA_EXECUTABLE environment variable
-  points to the .exe (with full path).
 
 == REQUIREMENTS:
 
 * Windows
 * Working Ruby installation
-* MinGW Installation (for building the stub)
+* MinGW Installation (when working with the source code only)
 
 == INSTALL:
 
 === Gem
 
-* gem install ocra
+  gem install ocra
 
 Can also be downloaded from http://rubyforge.org/frs/?group_id=8185
 
@@ -77,10 +101,20 @@ nothing but a working Ruby installation on Windows.
 
 == TECHNICAL DETAILS
 
-The OCRA stub extracts the Ruby interpreter and your scripts into a
-temporary directory. The directory will contains the same directory
-layout as your Ruby installlation. The source files for your
-application will be put in the 'src' subdirectory.
+OCRA first runs the target script in order to detect any files that
+are loaded and used at runtime (Using Kernel#require and Kernel#load).
+
+OCRA embeds everything needed to run a Ruby script into a single
+executable file. The file contains the .exe stub which is compiled
+from C-code, and a custom opcode format containing instructions to
+create directories, save files, set environment variables and run
+programs. The OCRA script generates this executable and the
+instructions to be run when it is launched.
+
+When executed, the OCRA stub extracts the Ruby interpreter and your
+scripts into a temporary directory. The directory will contains the
+same directory layout as your Ruby installlation. The source files for
+your application will be put in the 'src' subdirectory.
 
 === Libraries
 
@@ -88,12 +122,18 @@ Rubygems will be automatically included in the OCRA executable.
 
 Libraries found in non-standard path (for example, if you invoke OCRA
 with "ruby -I some/path") will be placed into the site dir
-(lib/ruby/site_ruby). Avoid changing $LOAD_PATH / $: from your script
-to include paths outside your source tree.
+(lib/ruby/site_ruby). Avoid changing <tt>$LOAD_PATH</tt> or
+<tt>$:</tt> from your script to include paths outside your source
+tree, since OCRA may place the files elsewhere when extracted into the
+temporary directory.
 
-Autoloaded libraries will be attempted loaded when building the
-executable. Modules that doesn't exist will be ignore (but a warning
-will be logged).
+Autoloaded libraries (Kernel#autoload) will be attempted loaded when
+building the executable. Modules that doesn't exist will be ignore
+(but a warning will be logged).
+
+Conditionally loaded code will not be loaded and included in the
+executable unless the code is actually run when OCRA invokes your
+script.
 
 === Environment variables
 
@@ -107,7 +147,9 @@ on your build PC, OCRA ensures that it is also set on PC's running the
 executables.
 
 OCRA executables set OCRA_EXECUTABLE to the full path of the
-executable, fx. "C:\Program Files\MyApp\MyApp.exe".
+executable, for example
+
+  ENV["OCRA_EXECUTABLE"] # => C:\Program Files\MyApp\MyApp.exe
 
 === Working directory
 
@@ -115,37 +157,37 @@ You should not assume that the current working directory when invoking
 an executable built with .exe is the location of the source script. It
 can be the directory where the executable is placed (when invoked
 through the Windows Explorer), the users' current working directory
-(when invoking from the Command Prompt), or even C:\WINDOWS\SYSTEM32
+(when invoking from the Command Prompt), or even <tt>C:\\WINDOWS\\SYSTEM32</tt>
 when the executable is invoked through a file association. You can
 optionally change the directory yourself:
 
-   Dir.chdir File.dirname(__FILE__)
+   Dir.chdir File.dirname($0)
 
 If you wish to maintain the user's working directory, but need to
 'require' additional Ruby scripts from the source directory, you can
 add the following line to your script:
 
-   $LOAD_PATH.unshift File.dirname(__FILE__)
+   $LOAD_PATH.unshift File.dirname($0)
 
-=== $LOAD_PATH/$: mangling
+=== Load path mangling
 
-Adding paths to $LOAD_PATH or $: at runtime is not recommended. Adding
-relative load paths depends on the working directory being the same as
-where the script is located (See above). If you have additional
-library files in directories below the directory containing your
-source script you can use this idiom:
+Adding paths to <tt>$LOAD_PATH</tt> or <tt>$:</tt> at runtime is not
+recommended. Adding relative load paths depends on the working
+directory being the same as where the script is located (See
+above). If you have additional library files in directories below the
+directory containing your source script you can use this idiom:
 
-   $LOAD_PATH.unshift File.join(File.dirname(__FILE__), 'path/to/script')
+   $LOAD_PATH.unshift File.join(File.dirname($0), 'path/to/script')
 
 === Detecting OCRA
 
 You can detect whether OCRA is currently building your script by
-looking for the 'OCRA' constant. If it is defined, OCRA is currenly
+looking for the 'Ocra' constant. If it is defined, OCRA is currenly
 building the executable from your script. For example, you can use
 this to avoid opening a GUI window when compiling executables:
 
    app = MyApp.new
-   if not defined?(OCRA)
+   if not defined?(Ocra)
      app.main_loop
    end
 
@@ -155,7 +197,7 @@ You can add additional files to the OCRA executable (for example
 images) by appending them to the command line. They should be placed
 in the source directory with your main script (or a subdirectory).
 
-   ocra.rb mainscript.rb someimage.jpeg docs/document.txt
+   ocra mainscript.rb someimage.jpeg docs/document.txt
 
 This will create the following layout in the temporary directory when
 your program is executed:
@@ -165,7 +207,37 @@ your program is executed:
    src/docs/document.txt
 
 Paths on the command line can include ** globs to include a hierachy
-of files, for example: "ocra script.rb assets/**/*.png".
+of files, for example
+
+   ocra script.rb assets/**/*.png
+
+=== Window/Console
+
+Ruby on Windows provides two executables: ruby.exe is a console mode
+application and rubyw.exe is a windowed application which does not
+bring up a console window when launched using the Windows Explorer.
+By default, or if the <tt>--console</tt> option is used, OCRA will use
+the console runtime (rubyw.exe). OCRA will automatically select the
+windowed runtime when your script has the ".rbw" extension, or if you
+specify the <tt>--windows</tt> command line option.
+
+If your application works in console mode but not in windowed mode,
+first check if your script works without OCRA using rubyw.exe. A
+script that prints to standard output (using puts, print etc.) will
+eventually cause an exception when run with rubyw.exe (when the IO
+buffers run full).
+
+You can also try wrapping your script in an exception handler that
+logs any errors to a file:
+
+   begin
+     # your script here
+   rescue Exception => e
+     File.open("except.log") do |f|
+       f.puts e.inspect
+       f.puts e.backtrace
+     end
+   end
 
 == CREDITS:
 
@@ -181,7 +253,7 @@ http://ruby.morphball.net/vit-ruby-ico_en.html)
 
 (The MIT License)
 
-Copyright (c) 2009 Lars Christensen
+Copyright (c) 2009-2010 Lars Christensen
 
 Permission is hereby granted, free of charge, to any person obtaining
 a copy of this software and associated documentation files (the

data/Rakefile

@@ -5,6 +5,7 @@ require 'hoe'
 
 Hoe.spec 'ocra' do
   developer "Lars Christensen", "larsch@belunktum.dk"
+  self.readme_file = 'README.rdoc'
 end
 
 task :build_stub do
@@ -16,6 +17,10 @@ end
 
 file 'share/ocra/stub.exe' => :build_stub
 
+file 'README.txt' => 'README.rdoc' do
+  cp 'README.rdoc', 'README.txt'
+end
+
 task :test => :build_stub
 
 task :standalone => [ 'bin/ocrasa.rb' ]
@@ -122,4 +127,9 @@ task :list_all_rubies do
   end
 end
 
+task :release_docs => :redocs do
+  sh "pscp -r doc/* ocra.rubyforge.org:/var/www/gforge-projects/ocra"
+end
+
+
 # vim: syntax=Ruby

data/bin/ocra

@@ -10,12 +10,14 @@ module Ocra
   OP_DECOMPRESS_LZMA = 4
   OP_SETENV = 5
 
-  VERSION = "1.1.3"
+  VERSION = "1.1.4"
 
   IGNORE_MODULES = /^enumerator.so$/
 
   PATH_SEPARATOR = /[\/\\]/
 
+  TEMPDIR_MARKER = "\xFF"
+
   class << self
     attr_accessor :lzma_mode
     attr_accessor :extra_dlls
@@ -240,7 +242,7 @@ EOF
           targetpath = "src/" + fullpath[src_prefix.size+1..-1]
           libs << [ fullpath, targetpath ]
           if not @added_load_paths.include?(path) and not load_path.include?(path)
-            load_path << File.join("\xFF", File.dirname(targetpath))
+            load_path << File.join(TEMPDIR_MARKER, File.dirname(targetpath))
           end
         elsif defined?(Gem) and gemhome = Gem.path.find { |pth| subpath?(fullpath, pth) }
           targetpath = File.join("gemhome", relative_path(gemhome, fullpath))
@@ -256,7 +258,7 @@ EOF
     # Detect additional DLLs
     dlls = Ocra.autodll ? LibraryDetector.detect_dlls : []
 
-    executable = Ocra.files[0].sub(/(\.rbw?)?$/, '.exe')
+    executable = File.basename(Ocra.files[0].sub(/(\.rbw?)?$/, '.exe'))
 
     windowed = (Ocra.files[0] =~ /\.rbw$/ || Ocra.force_windows) && !Ocra.force_console
 
@@ -264,23 +266,30 @@ EOF
     OcraBuilder.new(executable, windowed) do |sb|
       # Add explicitly mentioned files
       Ocra.files.each do |file|
+        file = File.expand_path(file)
+
+        if subpath?(file, exec_prefix)
+          target = relative_path(exec_prefix, file)
+        elsif subpath?(file, src_prefix)
+          target = File.join('src', relative_path(src_prefix, file))
+        else
+          target = File.join('src', File.basename(file))
+        end
+
+        target.tr!('/','\\')
+        
         if File.directory?(file)
-          sb.ensuremkdir(File.join('src',file).tr('/','\\'))
+          sb.ensuremkdir(target)
         else
-          if subpath?(file, exec_prefix)
-            target = file[exec_prefix.size+1..-1]
-          else
-            target = File.join('src', file).tr('/','\\')
-          end
           sb.createfile(file, target)
         end
       end
 
       # Add the ruby executable and DLL
       if windowed
-        rubyexe = "rubyw.exe"
+        rubyexe = (RbConfig::CONFIG['rubyw_install_name'] || "rubyw") + ".exe"
       else
-        rubyexe = "ruby.exe"
+        rubyexe = (RbConfig::CONFIG['ruby_install_name'] || "ruby") + ".exe"
       end
       sb.createfile(File.join(bindir, rubyexe), "bin\\" + rubyexe)
       if libruby_so
@@ -323,14 +332,14 @@ EOF
       # Set environment variable
       sb.setenv('RUBYOPT', ENV['RUBYOPT'] || '')
       sb.setenv('RUBYLIB', load_path.uniq.join(';'))
-      sb.setenv('GEM_PATH', "\xFF\\gemhome")
+      sb.setenv('GEM_PATH', "#{TEMPDIR_MARKER}\\gemhome")
 
       # Launch the script
-      sb.createprocess("bin\\" + rubyexe, "#{rubyexe} \"\xff\\src\\" + Ocra.files[0] + "\"")
+      sb.createprocess(TEMPDIR_MARKER + "\\bin\\" + rubyexe, "#{rubyexe} \"\xff\\src\\" + File.basename(Ocra.files[0]) + "\"")
       
       puts "=== Compressing" unless Ocra.quiet or not Ocra.lzma_mode
     end
-    puts "=== Finished (Final size was #{File.size(executable)})" unless Ocra.quiet
+    puts "=== Finished building #{executable} (#{File.size(executable)} bytes)" unless Ocra.quiet
   end
 
   module LibraryDetector
@@ -384,7 +393,7 @@ EOF
       end
 
       if Ocra.icon_filename
-        system("#{Ocra.ediconpath} #{path} #{Ocra.icon_filename}")
+        system Ocra.ediconpath, path, Ocra.icon_filename
       end
 
       opcode_offset = File.size(path)
@@ -420,13 +429,13 @@ EOF
       end
     end
     def mkdir(path)
-      @paths[path] = true
-      puts "m #{path}" unless Ocra.quiet
+      @paths[path.downcase] = true
+      puts "m #{showtempdir path}" unless Ocra.quiet
       @of << [OP_CREATE_DIRECTORY, path].pack("VZ*")
     end
     def ensuremkdir(tgt)
       return if tgt == "."
-      if not @paths[tgt]
+      if not @paths[tgt.downcase]
         ensuremkdir(File.dirname(tgt))
         mkdir(tgt)
       end
@@ -434,20 +443,25 @@ EOF
     def createfile(src, tgt)
       ensuremkdir(File.dirname(tgt))
       str = File.open(src, "rb") { |file| file.read }
-      puts "a #{tgt}" unless Ocra.quiet
+      puts "a #{showtempdir tgt}" unless Ocra.quiet
       @of << [OP_CREATE_FILE, tgt, str.size, str].pack("VZ*VA*")
     end
     def createprocess(image, cmdline)
-      puts "l #{image} #{cmdline}" unless Ocra.quiet
+      puts "l #{showtempdir image} #{showtempdir cmdline}" unless Ocra.quiet
       @of << [OP_CREATE_PROCESS, image, cmdline].pack("VZ*Z*")
     end
     def setenv(name, value)
-      puts "e #{name} #{value}" unless Ocra.quiet
+      puts "e #{name} #{showtempdir value}" unless Ocra.quiet
       @of << [OP_SETENV, name, value].pack("VZ*Z*")
     end
     def close
       @of.close
     end
+
+    def showtempdir(x)
+      x.gsub(TEMPDIR_MARKER, "<tempdir>")
+    end
+      
   end # class OcraBuilder
   
 end # module Ocra

data/lib/ocra.rb

@@ -1,3 +1,3 @@
 class Ocra
-  VERSION = '1.1.3'
+  VERSION = '1.1.4'
 end

data/test/test_ocra.rb

@@ -319,7 +319,7 @@ class TestOcra < Test::Unit::TestCase
 
   # Test that ocra.rb accepts --version and outputs the version number.
   def test_version
-    assert_match(/^Ocra \d+(\.\d)+$/, `ruby #{ocra} --version`)
+    assert_match(/^Ocra \d+(\.\d)+$/, `ruby \"#{ocra}\" --version`)
   end
 
   # Test that ocra.rb accepts --icon.
@@ -402,4 +402,44 @@ class TestOcra < Test::Unit::TestCase
       end
     end
   end
+
+  def test_abspath
+    with_fixture "helloworld" do
+      assert system("ruby", ocra, File.expand_path("helloworld.rb"), *DefaultArgs)
+      assert File.exist?("helloworld.exe")
+      assert system("helloworld.exe")
+    end
+  end
+
+  def test_abspath_outside
+    with_fixture "helloworld" do
+      mkdir "build"
+      cd "build" do
+        assert system("ruby", ocra, File.expand_path("../helloworld.rb"), *DefaultArgs)
+        assert File.exist?("helloworld.exe")
+        assert system("helloworld.exe")
+      end
+    end
+  end
+
+  def test_relpath
+    with_fixture "helloworld" do
+      assert system("ruby", ocra, "./helloworld.rb", *DefaultArgs)
+      assert File.exist?("helloworld.exe")
+      assert system("helloworld.exe")
+    end
+  end
+
+  def test_relpath_outside
+    with_fixture "helloworld" do
+      mkdir "build"
+      cd "build" do
+        assert system("ruby", ocra, "../helloworld.rb", *DefaultArgs)
+        assert File.exist?("helloworld.exe")
+        assert system("helloworld.exe")
+      end
+    end
+  end
+
+  
 end

metadata

@@ -1,7 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: ocra
 version: !ruby/object:Gem::Version 
-  version: 1.1.3
+  hash: 27
+  prerelease: false
+  segments: 
+  - 1
+  - 1
+  - 4
+  version: 1.1.4
 platform: ruby
 authors: 
 - Lars Christensen
@@ -9,19 +15,41 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-11-21 00:00:00 +01:00
+date: 2010-08-04 00:00:00 +02:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
-  name: hoe
+  name: rubyforge
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 7
+        segments: 
+        - 2
+        - 0
+        - 4
+        version: 2.0.4
   type: :development
-  version_requirement: 
-  version_requirements: !ruby/object:Gem::Requirement 
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: hoe
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        version: 2.3.3
-    version: 
+        hash: 21
+        segments: 
+        - 2
+        - 6
+        - 1
+        version: 2.6.1
+  type: :development
+  version_requirements: *id002
 description: |-
   OCRA (One-Click Ruby Application) builds Windows executables from Ruby
   source code. The executable is a self-extracting, self-running
@@ -50,31 +78,37 @@ files:
 - test/test_ocra.rb
 - lib/ocra.rb
 has_rdoc: true
-homepage: http://rubyforge.org/projects/ocra/
+homepage: http://ocra.rubyforge.org/
 licenses: []
 
 post_install_message: 
 rdoc_options: 
 - --main
-- README.txt
+- README.rdoc
 require_paths: 
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
       version: "0"
-  version: 
 required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
       version: "0"
-  version: 
 requirements: []
 
 rubyforge_project: ocra
-rubygems_version: 1.3.5
+rubygems_version: 1.3.7
 signing_key: 
 specification_version: 3
 summary: OCRA (One-Click Ruby Application) builds Windows executables from Ruby
 source code