ocra 1.1.1 → 1.1.2

data/History.txt

@@ -1,3 +1,27 @@
+=== 1.1.2
+
+* Warnings can be disabled using --no-warnings.
+
+* Fixed not .exe being generated when script calls 'exit'.
+
+* Path to the generated executable is now avilable to the running
+  script in the OCRA_EXECUTABLE environment variable.
+
+* Directories on the command line will now be created.
+
+* Supports path globs, fx. "ocra script.rb assets/**/*.png". (See
+  documentation for Ruby's Dir class).
+
+* Fixed issue with spaces in temporary path (TMP environment).
+
+* Improved path comparison to ignore case (this is Windows after all)
+  and be a bit more robust.
+
+* Added support for RubyGems installed in GEM_HOME (or other part
+  handled by RubyGems). If not installed in the Ruby hierarchy, they
+  will now be installed in a directory named 'gemhome' under the
+  temporary directory.
+
 === 1.1.1
 
 * Fixed duplicate entries in the RUBYLIB environment variable.

data/Manifest.txt

@@ -2,7 +2,7 @@ History.txt
 Manifest.txt
 README.txt
 Rakefile
-bin/ocra.rb
+bin/ocra
 share/ocra/lzma.exe
 share/ocra/stub.exe
 share/ocra/stubw.exe

data/README.txt

@@ -18,7 +18,7 @@ any additionally needed ruby libraries or DLL.
 * Both console programs and desktop programs supported (no console will
   pop up with .rbw files).
 
-If you experience problems with Ocra or have found a bug, please use
+If you experience problems with OCRA or have found a bug, please use
 the tracker on the RubyForge project page
 http://rubyforge.org/projects/ocra/. You are welcome to ask questions
 in the forums there aswell.
@@ -29,7 +29,7 @@ in the forums there aswell.
 
 == SYNOPSIS:
 
-ocra.rb [option] your/script.rb
+ocra [option] your/script.rb
 
 * OCRA will load your script (using Kernel#load) and build the
   executable when it exits.
@@ -37,10 +37,10 @@ ocra.rb [option] your/script.rb
 * Your program should 'require' all necessary files when invoked without
   arguments, so ocra can detect all dependencies.
 
-* Ocra executables clear the RUBYLIB environment variable but set
-  RUBYOPT to whatever value it had when you invoked Ocra.
+* OCRA executables clear the RUBYLIB environment variable but set
+  RUBYOPT to whatever value it had when you invoked OCRA.
 
-* Ocra does not set up the include path. Use "$:.unshift
+* 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.
@@ -50,6 +50,12 @@ ocra.rb [option] your/script.rb
   disabled using --no-autodll. DLLs can be manually added using the
   --dll option.
 
+* The current working directory is left untouched by OCRA (Details
+  below).
+
+* When the script is running, the OCRA_EXECUTABLE environment variable
+  points to the .exe (with full path).
+
 == REQUIREMENTS:
 
 * Windows
@@ -71,16 +77,16 @@ nothing but a working Ruby installation on Windows.
 
 == TECHNICAL DETAILS
 
-The Ocra stub extracts the Ruby interpreter and your scripts into a
+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
 
-Rubygems will be automatically included in the Ocra executable.
+Rubygems will be automatically included in the OCRA executable.
 
-Libraries found in non-standard path (for example, if you invoke Ocra
+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.
@@ -91,15 +97,18 @@ will be logged).
 
 === Environment variables
 
-Ocra executables clear the RUBYLIB environment variable before your
+OCRA executables clear the RUBYLIB environment variable before your
 script is launched. This is done to ensure that your script does not
 use load paths from the end user's Ruby installation.
 
-Ocra executables set the RUBYOPT environment variable to the value it
-had when you invoked Ocra. For example, if you had "RUBYOPT=rubygems"
-on your build PC, Ocra ensures that it is also set on PC's running the
+OCRA executables set the RUBYOPT environment variable to the value it
+had when you invoked OCRA. For example, if you had "RUBYOPT=rubygems"
+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".
+
 === Working directory
 
 You should not assume that the current working directory when invoking
@@ -130,19 +139,19 @@ source script you can use this idiom:
 
 === 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
+You can detect whether OCRA is currently building your script by
+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
 
 === Additional files and resources
 
-You can add additional files to the Ocra executable (for example
+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).
 
@@ -155,6 +164,9 @@ your program is executed:
    src/someimage.jpeg
    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".
+
 == CREDITS:
 
 Thanks for Igor Pavlov for the LZMA compressor and decompressor. The

data/Rakefile

@@ -2,10 +2,9 @@
 
 require 'rubygems'
 require 'hoe'
-require 'bin/ocra'
 
-Hoe.new('ocra', Ocra::VERSION) do |p|
-  p.developer('Lars Christensen', 'larsch@belunktum.dk')
+Hoe.spec 'ocra' do
+  developer "Lars Christensen", "larsch@belunktum.dk"
 end
 
 task :build_stub do
@@ -17,7 +16,7 @@ end
 
 file 'share/ocra/stub.exe' => :build_stub
 
-task :test => :stub
+task :test => :build_stub
 
 task :standalone => [ 'bin/ocrasa.rb' ]
 
@@ -33,8 +32,8 @@ task :release_standalone => standalone_zip do
   sh "rubyforge add_release ocra ocra-standalone #{Ocra::VERSION} #{standalone_zip}"
 end
 
-file 'bin/ocrasa.rb' => [ 'bin/ocra.rb', 'share/ocra/stub.exe', 'share/ocra/stubw.exe', 'share/ocra/lzma.exe', 'share/ocra/edicon.exe' ] do
-  cp 'bin/ocra.rb', 'bin/ocrasa.rb'
+file 'bin/ocrasa.rb' => [ 'bin/ocra', 'share/ocra/stub.exe', 'share/ocra/stubw.exe', 'share/ocra/lzma.exe', 'share/ocra/edicon.exe' ] do
+  cp 'bin/ocra', 'bin/ocrasa.rb'
   File.open("bin/ocrasa.rb", "a") do |f|
     f.puts "__END__"
     
@@ -75,8 +74,9 @@ task :test_standalone => :standalone do
 end
 
 def each_ruby_version
-  root = "h:/appl"
-  Dir.glob(File.join(root, 'ruby-*','bin')).each do |path|
+  raise "Set RUBIES to point to where you have various versions of Ruby installed" if ENV['RUBIES'].nil?
+  root = ENV['RUBIES']
+  Dir.glob(File.join(root, 'ruby*','bin')).each do |path|
     path.tr!('/','\\')
     pathenv = ENV['PATH']
     ENV['PATH'] = path

data/bin/{ocra.rb → ocra}

@@ -10,10 +10,12 @@ module Ocra
   OP_DECOMPRESS_LZMA = 4
   OP_SETENV = 5
 
-  VERSION = "1.1.1"
+  VERSION = "1.1.2"
 
   IGNORE_MODULES = /^enumerator.so$/
 
+  PATH_SEPARATOR = /[\/\\]/
+
   class << self
     attr_accessor :lzma_mode
     attr_accessor :extra_dlls
@@ -24,6 +26,7 @@ module Ocra
     attr_accessor :icon_filename
     attr_accessor :quiet
     attr_accessor :autodll
+    attr_accessor :show_warnings
     attr_reader :lzmapath
     attr_reader :ediconpath
     attr_reader :stubimage
@@ -65,6 +68,7 @@ module Ocra
     icon_filename = nil
     quiet = false
     autodll = true
+    show_warnings = true
     
     usage = <<EOF
 ocra [options] script.rb
@@ -102,6 +106,8 @@ EOF
       when /\A--version\z/
         puts "Ocra #{VERSION}"
         exit
+      when /\A--no-warnings\z/
+        show_warnings = false
       when /\A--help\z/, /\A--/
         puts usage
         exit
@@ -124,6 +130,7 @@ EOF
     @icon_filename = icon_filename
     @autodll = autodll
     @files = files
+    @show_warnings = show_warnings
   end
 
   def Ocra.init(argv)
@@ -149,7 +156,7 @@ EOF
             begin
               mod.const_get(const)
             rescue LoadError
-              puts "=== WARNING: #{mod}::#{const} was not loadable"
+              puts "=== WARNING: #{mod}::#{const} was not loadable" if Ocra.show_warnings
             end
           end
         end
@@ -169,6 +176,14 @@ EOF
     return b.join('/')
   end
 
+  # Determines if 'src' is contained in 'tgt' (i.e. it is a subpath of
+  # 'tgt'). Both must be absolute paths and not contain '..'
+  def Ocra.subpath?(src, tgt)
+    src_normalized = src.tr('/','\\')
+    tgt_normalized = tgt.tr('/','\\')
+    src_normalized =~ /^#{Regexp.escape tgt_normalized}[\/\\]/i
+  end
+
   def Ocra.find_load_path(paths, path)
     if path[1,1] == ":"
       rps = paths.map {|p| relative_path(File.expand_path(p), path) }
@@ -216,22 +231,25 @@ EOF
           filename = relative_path(File.expand_path(path), filename)
         end
         if filename =~ /^\.\.\//
-          puts "=== WARNING: Detected a relative require (#{filename}). This is not recommended."
+          puts "=== WARNING: Detected a relative require (#{filename}). This is not recommended." if Ocra.show_warnings
         end
         fullpath = File.expand_path(filename, path)
-        if fullpath.index(exec_prefix) == 0
+        if subpath?(fullpath, exec_prefix)
           libs << [ fullpath, fullpath[exec_prefix.size+1..-1] ]
-        elsif fullpath.index(src_prefix) == 0
+        elsif subpath?(fullpath, src_prefix)
           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))
           end
+        elsif defined?(Gem) and gemhome = Gem.path.find { |pth| subpath?(fullpath, pth) }
+          targetpath = File.join("gemhome", relative_path(gemhome, fullpath))
+          libs << [ fullpath, targetpath ]
         else
           libs << [ fullpath, File.join(instsitelibdir, filename) ]
         end
       else
-        puts "=== WARNING: Couldn't find #{filename}" unless filename =~ IGNORE_MODULES
+        puts "=== WARNING: Couldn't find #{filename}" unless filename =~ IGNORE_MODULES if Ocra.show_warnings
       end
     end
 
@@ -246,8 +264,12 @@ EOF
     OcraBuilder.new(executable, windowed) do |sb|
       # Add explicitly mentioned files
       Ocra.files.each do |file|
-        path = File.join('src', file).tr('/','\\')
-        sb.createfile(file, path)
+        if File.directory?(file)
+          sb.ensuremkdir(File.join('src',file).tr('/','\\'))
+        else
+          path = File.join('src', file).tr('/','\\')
+          sb.createfile(file, path)
+        end
       end
 
       # Add the ruby executable and DLL
@@ -263,7 +285,7 @@ EOF
 
       # Add detected DLLs
       dlls.each do |dll|
-        if dll.tr('\\','/').index(exec_prefix) == 0
+        if subpath?(dll.tr('\\','/'), exec_prefix)
           target = dll[exec_prefix.size+1..-1]
         else
           target = File.join('bin', File.basename(dll))
@@ -277,14 +299,17 @@ EOF
       end
 
       # Add gemspecs
-      gemspecs.each { |gemspec|
-        pref = gemspec[0,exec_prefix.size]
-        path = gemspec[exec_prefix.size+1..-1]
-        if pref != exec_prefix
+      gemspecs.each do |gemspec|
+        if subpath?(gemspec, exec_prefix)
+          path = gemspec[exec_prefix.size+1..-1]
+          sb.createfile(gemspec, path.tr('/','\\'))
+        elsif defined?(Gem) and gemhome = Gem.path.find { |pth| subpath?(gemspec, pth) }
+          path = File.join('gemhome', relative_path(gemhome, gemspec))
+          sb.createfile(gemspec, path.tr('/','\\'))
+        else
           raise "#{gemspec} does not exist in the Ruby installation. Don't know where to put it."
         end
-        sb.createfile(gemspec, path.tr('/','\\'))
-      }
+      end
 
       # Add loaded libraries
       libs.each do |path, target|
@@ -294,9 +319,10 @@ EOF
       # Set environment variable
       sb.setenv('RUBYOPT', ENV['RUBYOPT'] || '')
       sb.setenv('RUBYLIB', load_path.uniq.join(';'))
+      sb.setenv('GEM_HOME', "\xFF\\gemhome")
 
       # Launch the script
-      sb.createprocess("bin\\" + rubyexe, "#{rubyexe} \xff\\src\\" + Ocra.files[0])
+      sb.createprocess("bin\\" + rubyexe, "#{rubyexe} \"\xff\\src\\" + Ocra.files[0] + "\"")
       
       puts "=== Compressing" unless Ocra.quiet or not Ocra.lzma_mode
     end
@@ -342,8 +368,8 @@ EOF
       loaded = loaded_dlls
       exec_prefix = RbConfig::CONFIG['exec_prefix']
       loaded.select do |path|
-        path.tr('\\','/').index(exec_prefix) == 0 and
-          File.basename(path) =~ /\.dll$/ and
+        Ocra.subpath?(path.tr('\\','/'), exec_prefix) and
+          File.basename(path) =~ /\.dll$/i and
           File.basename(path).downcase != RbConfig::CONFIG['LIBRUBY_SO'].downcase
       end
     end
@@ -435,7 +461,7 @@ if File.basename(__FILE__) == File.basename($0)
   ARGV.clear
   
   at_exit do
-    if $!.nil?
+    if $!.nil? or $!.kind_of?(SystemExit)
       Ocra.build_exe
       exit(0)
     end

data/test/test_ocra.rb

@@ -21,7 +21,7 @@ class TestOcra < Test::Unit::TestCase
   DefaultArgs.push '--no-autodll' if not $have_win32_api
 
   # Name of the tested ocra script.
-  TESTED_OCRA = ENV['TESTED_OCRA'] || 'ocra.rb'
+  TESTED_OCRA = ENV['TESTED_OCRA'] || 'ocra'
 
   # Root of OCRA.
   OcraRoot = File.expand_path(File.join(File.dirname(__FILE__), '..'))
@@ -70,6 +70,26 @@ class TestOcra < Test::Unit::TestCase
       end
     end
   end
+
+  def with_tmpdir
+    tempdirname = File.join(ENV['TEMP'], ".ocratest-#{$$}-#{rand 2**32}").tr('\\','/')
+    Dir.mkdir tempdirname
+    begin
+      FileUtils.cd tempdirname do
+        yield
+      end
+    ensure
+      FileUtils.rm_rf tempdirname
+    end
+  end
+
+  def with_exe(name)
+    orig_exe = File.expand_path(name)
+    with_tmpdir do
+      cp orig_exe, File.join('.', File.basename(name))
+      yield
+    end
+  end
   
   # Test setup method. Creates a tempory directory to work in and
   # changes to it. 
@@ -337,4 +357,44 @@ class TestOcra < Test::Unit::TestCase
       end
     end
   end
+
+  def test_exit
+    with_fixture 'exit' do
+      assert system("ruby", ocra, "exit.rb", *DefaultArgs)
+      assert File.exist?("exit.exe")
+      assert system("exit.exe")
+    end
+  end
+
+  def test_ocra_executable_env
+    with_fixture 'environment' do
+      assert system("ruby", ocra, "environment.rb", *DefaultArgs)
+      assert system("environment.exe")
+      env = Marshal.load(File.open("environment", "rb") { |f| f.read })
+      expected_path = File.expand_path("environment.exe").tr('/','\\')
+      assert_equal expected_path, env['OCRA_EXECUTABLE']
+    end
+  end
+
+  def test_hierarchy
+    with_fixture 'hierarchy' do
+      assert system("ruby", ocra, "hierarchy.rb", "assets/**/*", *DefaultArgs)
+      with_exe "hierarchy.exe" do
+        assert system("hierarchy.exe")
+      end
+    end
+  end
+
+  def test_temp_with_space
+    with_fixture 'helloworld' do
+      assert system("ruby", ocra, "helloworld.rb", *DefaultArgs)
+      tempdir = File.expand_path("temporary directory")
+      mkdir_p tempdir
+      with_exe "helloworld.exe" do
+        with_env "TMP" => tempdir.tr('/','\\') do
+          assert system("helloworld.exe")
+        end
+      end
+    end
+  end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: ocra
 version: !ruby/object:Gem::Version 
-  version: 1.1.1
+  version: 1.1.2
 platform: ruby
 authors: 
 - Lars Christensen
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-06-01 00:00:00 +02:00
+date: 2009-08-10 00:00:00 +02:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -20,7 +20,7 @@ dependencies:
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        version: 1.12.2
+        version: 2.3.1
     version: 
 description: |-
   OCRA (One-Click Ruby Application) builds Windows executables from Ruby
@@ -30,7 +30,7 @@ description: |-
 email: 
 - larsch@belunktum.dk
 executables: 
-- ocra.rb
+- ocra
 extensions: []
 
 extra_rdoc_files: 
@@ -42,7 +42,7 @@ files:
 - Manifest.txt
 - README.txt
 - Rakefile
-- bin/ocra.rb
+- bin/ocra
 - share/ocra/lzma.exe
 - share/ocra/stub.exe
 - share/ocra/stubw.exe