ocra 1.1.5.pre3 → 1.2.0.rc1

data/History.txt

@@ -1,4 +1,4 @@
-=== 1.1.5
+=== 1.2.0
 
 * Ignore console events (Ctrl-C, Ctrl-Break). Ruby process handles
   them anyway and exist, allowing the stub to clean up temporary
@@ -27,6 +27,10 @@
   directory layout would not be maintained, e.g. when running "ocra
   bin/script share/data.dat".
 
+* Added support for passing arguments to script. Specify argument to
+  your script after a "--" marker. Arguments will be passed both at
+  compile time and run time. (#27815)
+
 === 1.1.4
 
 * The tempdir marker is now pretty-printed as "<tempdir>" in the

data/README.txt

@@ -78,7 +78,11 @@ in the forums there aswell.
 == REQUIREMENTS:
 
 * Windows
-* Working Ruby installation
+
+* Working Ruby installation, tested with:
+    * One-Click Installer (187_27_rc2)
+    * RubyInstaller (1.8.7p299, 1.9.1p249, 1.9.2p0)
+
 * MinGW Installation (when working with the source code only)
 
 == INSTALL:
@@ -220,6 +224,19 @@ of files, for example
 
    ocra script.rb assets/**/*.png
 
+=== Command Line Arguments
+
+To pass command line argument to your script (both while building and
+when run from the resulting executable), specify them after a "--"
+marker. For example:
+
+   ocra script.rb -- --some-options=value
+
+This will pass "--some-options=value" to the script when build and
+when running the executable. Any extra argument specified by the user
+when invoking the executable will be appended after the compile-time
+arguments.
+
 === Window/Console
 
 By default, OCRA builds console application from .rb-files and

data/bin/ocra

@@ -11,7 +11,7 @@ module Ocra
   OP_SETENV = 5
   OP_POST_CREATE_PROCESS = 6
 
-  VERSION = "1.1.5.pre3"
+  VERSION = "1.2.0.rc1"
 
   IGNORE_MODULES = /^enumerator.so$/
 
@@ -43,7 +43,8 @@ module Ocra
     :quiet => false,
     :autodll => true,
     :show_warnings => true,
-    :gem_filter => true
+    :gem_filter => true,
+    :arg => []
   }
 
   @options.each_key { |opt| eval("def self.#{opt}; @options[:#{opt}]; end") }
@@ -143,7 +144,10 @@ EOF
         @options[:show_warnings] = false
       when /\A--no-gem-filter\z/
         @options[:gem_filter] = false
-      when /\A--help\z/, /\A--/
+      when /\A--\z/
+        @options[:arg] = ARGV.dup
+        ARGV.clear
+      when /\A--help\z/, /\A--./
         puts usage
         exit
       else
@@ -195,13 +199,13 @@ EOF
   # (directory or file). Return the absolute path to 'tgt' if it can't
   # be reached from 'src'.
   def Ocra.relative_path(src, tgt)
-    a = src.split('/')
-    b = tgt.split('/')
+    a = posixpath(src).split('/')
+    b = posixpath(tgt).split('/')
     while a.first && a.first.downcase == b.first.downcase
       a.shift
       b.shift
     end
-    return tgt if b.first =~ /^[a-z]:/i
+    return tgt if abspath?(b.first)
     a.size.times { b.unshift '..' }
     return b.join('/')
   end
@@ -214,57 +218,38 @@ EOF
     src_normalized =~ /^#{Regexp.escape tgt_normalized}[\/\\]/i
   end
 
+  # Returns true if 'path' is absolute, false otherwise.
+  def Ocra.abspath?(path)
+    path =~ /\A[A-Z]:/i
+  end
+
   # Guess the load path (from 'paths') that was used to load
   # 'path'. This is primarily relevant on Ruby 1.8 which stores
   # "unqualified" paths in $LOADED_FEATURES.
   def Ocra.find_load_path(paths, path)
-    if path[1,1] == ":"
+    if abspath?(path)
+      # Find the shortest path in 'paths' that contain 'path'
       rps = paths.map {|p| relative_path(File.expand_path(p), path) }
       rps.zip(paths).sort_by {|x| x[0].size }.first[1]
     else
+      # Select the paths that contain 'path' and select the shortest
       candidates = paths.select { |p| File.exist?(File.expand_path(path, p)) }
       candidates.sort_by {|p| p.size}.last
     end
   end
-  
-  def Ocra.build_exe
-    @added_load_paths = $LOAD_PATH - @load_path_before
 
-    restore_environment
-    
-    # Attempt to autoload libraries before doing anything else.
-    attempt_load_autoload if Ocra.load_autoload
-
-    # Store the currently loaded files (before we require rbconfig for
-    # our own use).
-    features = $LOADED_FEATURES.dup
-
-    # Find gemspecs to include
-    if defined?(Gem)
-      gemspecs = Gem.loaded_specs.map { |name,info| info.loaded_from }
-    else
-      gemspecs = []
-    end
-
-    require 'rbconfig'
-    exec_prefix = RbConfig::CONFIG['exec_prefix']
-    src_prefix = Dir.pwd
-    sitelibdir = RbConfig::CONFIG['sitelibdir']
-    bindir = RbConfig::CONFIG['bindir']
-    libruby_so = RbConfig::CONFIG['LIBRUBY_SO']
-
-    # Find the root of all files specified on the command line and use
-    # it as the "src" of the output. Adjust 'Ocra.files' to be
-    # relative to the resulting root.
-    files = Ocra.files.map { |file| Dir[Ocra.posixpath(file)] }.flatten
-    files = files.map { |file| File.expand_path(file) }
-    src_prefix = files.inject(File.dirname(files[0])) do |srcroot, path|
-      if subpath?(path, exec_prefix)
+  # Find the root of all files specified on the command line and use
+  # it as the "src" of the output.
+  def Ocra.find_src_root(files)
+    src_files = files.map { |file| Dir[posixpath(file)] }.flatten
+    src_files = src_files.map { |file| File.expand_path(file) }
+    src_prefix = src_files.inject(File.dirname(src_files[0])) do |srcroot, path|
+      if subpath?(path, @ruby_exec_prefix)
         srcroot
       else
         loop do
           relpath = relative_path(srcroot, path)
-          if relpath =~ /^[A-Z]:$/i
+          if abspath?(relpath)
             puts "ERROR: No common directory contains all specified files"
           end
           if relpath =~ /^\.\.\//
@@ -276,20 +261,20 @@ EOF
         srcroot
       end
     end
-    files = files.map { |file| relative_path(src_prefix, file) }
-    Ocra.files.replace(files)
-
-    instsitelibdir = relative_path(exec_prefix, sitelibdir)
-
-    load_path = []
+    src_files = src_files.map { |file| relative_path(src_prefix, file) }
+    return src_prefix, src_files
+  end
 
-    # Detect loaded gems and add additional gem files to the
-    # executable. Ruby 1.8 provides Gem.loaded_specs to detect gems,
-    # but this is empty with Ruby 1.9. So instead, we look for any
-    # loaded file from a gem path.
+  # Searches for features that are loaded from gems, then produces a
+  # list of files included in those gems' manifests. Also returns a
+  # list of original features that are caused gems to be
+  # included. Ruby 1.8 provides Gem.loaded_specs to detect gems, but
+  # this is empty with Ruby 1.9. So instead, we look for any loaded
+  # file from a gem path.
+  def Ocra.find_gem_files(features)
+    features_from_gems = []
     if defined?(Gem)
       gems = []
-      features_from_gems = []
       features.each do |filename|
         if filename !~ /^[a-z]:/i
           filename = find_load_path($:, filename)
@@ -309,7 +294,7 @@ EOF
       gem_files = []
       gems.each do |gempath, fullgemname|
         gemspecpath = File.join(gempath, "specifications", fullgemname + ".gemspec")
-        gemspecs << gemspecpath
+        @gemspecs << gemspecpath
         spec = Gem::Specification.load(gemspecpath)
 
         # Get list of files
@@ -328,21 +313,61 @@ EOF
     else
       gem_files = []
     end
+    return gem_files, features_from_gems
+  end
+  
+  def Ocra.build_exe
+    @added_load_paths = $LOAD_PATH - @load_path_before
+
+    restore_environment
     
-    # Find loaded files
+    # Attempt to autoload libraries before doing anything else.
+    attempt_load_autoload if Ocra.load_autoload
+
+    # Store the currently loaded files (before we require rbconfig for
+    # our own use).
+    features = $LOADED_FEATURES.dup
+
+    # Find gemspecs to include
+    if defined?(Gem)
+      @gemspecs = Gem.loaded_specs.map { |name,info| info.loaded_from }
+    else
+      @gemspecs = []
+    end
+
+    require 'rbconfig'
+    @ruby_exec_prefix = RbConfig::CONFIG['exec_prefix']
+    src_prefix = Dir.pwd
+    sitelibdir = RbConfig::CONFIG['sitelibdir']
+    bindir = RbConfig::CONFIG['bindir']
+    libruby_so = RbConfig::CONFIG['LIBRUBY_SO']
+    instsitelibdir = relative_path(@ruby_exec_prefix, sitelibdir)
+
+    load_path = []
+
+    # Find the source root and adjust paths
+    src_prefix, src_files = find_src_root(Ocra.files)
+    Ocra.files.replace(src_files)
+
+    # Find gems files and remove them from features
+    gem_files, features_from_gems = find_gem_files(features)
+    features -= features_from_gems
+
+    # Find features and decide where to put them in the temporary
+    # directory layout.
     libs = []
     features.each do |filename|
       path = find_load_path($:, filename)
       if path
-        if filename[1,1] == ":"
+        if abspath?(filename)
           filename = relative_path(File.expand_path(path), filename)
         end
         if filename =~ /^\.\.\//
           puts "=== WARNING: Detected a relative require (#{filename}). This is not recommended." if Ocra.show_warnings
         end
         fullpath = File.expand_path(filename, path)
-        if subpath?(fullpath, exec_prefix)
-          libs << [ fullpath, relative_path(exec_prefix, fullpath) ]
+        if subpath?(fullpath, @ruby_exec_prefix)
+          libs << [ fullpath, relative_path(@ruby_exec_prefix, fullpath) ]
         elsif subpath?(fullpath, src_prefix)
           targetpath = File.join("src", relative_path(src_prefix, fullpath))
           libs << [ fullpath, targetpath ]
@@ -360,10 +385,11 @@ EOF
       end
     end
 
-    # Add files from Gems
+    # Decide where to put gem files, either the system gem folder, or
+    # GEMHOME.
     gem_files.each do |gemfile|
-      if subpath?(gemfile, exec_prefix)
-        libs << [ gemfile, relative_path(exec_prefix, gemfile) ]
+      if subpath?(gemfile, @ruby_exec_prefix)
+        libs << [ gemfile, relative_path(@ruby_exec_prefix, gemfile) ]
       elsif defined?(Gem) and gemhome = Gem.path.find { |pth| subpath?(gemfile, pth) }
         targetpath = File.join("gemhome", relative_path(gemhome, fullpath))
         libs << [ gemfile, targetpath ]
@@ -382,11 +408,11 @@ EOF
     puts "=== Building #{executable}" unless Ocra.quiet
     OcraBuilder.new(executable, windowed) do |sb|
       # Add explicitly mentioned files
-      files.each do |file|
+      Ocra.files.each do |file|
         file = File.join(src_prefix, file)
 
-        if subpath?(file, exec_prefix)
-          target = relative_path(exec_prefix, file)
+        if subpath?(file, @ruby_exec_prefix)
+          target = relative_path(@ruby_exec_prefix, file)
         elsif subpath?(file, src_prefix)
           target = File.join('src', relative_path(src_prefix, file))
         else
@@ -413,23 +439,23 @@ EOF
 
       # Add detected DLLs
       dlls.each do |dll|
-        if subpath?(dll, exec_prefix)
-          target = relative_path(exec_prefix, dll)
+        if subpath?(dll, @ruby_exec_prefix)
+          target = relative_path(@ruby_exec_prefix, dll)
         else
           target = File.join('bin', File.basename(dll))
         end
         sb.createfile(dll, target)
       end
       
-      # Add extra DLLs
+      # Add extra DLLs specified on the command line
       Ocra.extra_dlls.each do |dll|
         sb.createfile(File.join(bindir, dll), File.join("bin", dll))
       end
       
       # Add gemspec files
-      gemspecs.each do |gemspec|
-        if subpath?(gemspec, exec_prefix)
-          path = relative_path(exec_prefix, gemspec)
+      @gemspecs.each do |gemspec|
+        if subpath?(gemspec, @ruby_exec_prefix)
+          path = relative_path(@ruby_exec_prefix, gemspec)
           sb.createfile(gemspec, path)
         elsif defined?(Gem) and gemhome = Gem.path.find { |pth| subpath?(gemspec, pth) }
           path = File.join('gemhome', relative_path(gemhome, gemspec))
@@ -439,7 +465,7 @@ EOF
         end
       end
 
-      # Add loaded libraries
+      # Add loaded libraries (features, gems)
       libs.each do |path, target|
         sb.createfile(path, target)
       end
@@ -450,7 +476,9 @@ EOF
       sb.setenv('GEM_PATH', "#{TEMPDIR_MARKER}\\gemhome")
 
       # Launch the script
-      sb.postcreateprocess(TEMPDIR_MARKER + "\\bin\\" + rubyexe, "#{rubyexe} \"\xff\\src\\" + Ocra.dospath(Ocra.files[0]) + "\"")
+      extra_arg = Ocra.arg.map { |a| ' "' + a.gsub(/\"/,'\\"') + '"' }.join
+      sb.postcreateprocess(TEMPDIR_MARKER + "\\bin\\" + rubyexe,
+        "#{rubyexe} \"\xff\\src\\" + Ocra.dospath(Ocra.files[0]) + "\"#{extra_arg}")
       
       puts "=== Compressing" unless Ocra.quiet or not Ocra.lzma_mode
     end
@@ -597,7 +625,7 @@ end # module Ocra
 
 if File.basename(__FILE__) == File.basename($0)
   Ocra.init(ARGV)
-  ARGV.clear
+  ARGV.replace(Ocra.arg)
 
   if !File.exist?(Ocra.files[0])
     puts "ERROR: #{Ocra.files[0]} was not found!"

data/lib/ocra.rb

@@ -1,3 +1,3 @@
 class Ocra
-  VERSION = '1.1.5.pre3'
+  VERSION = '1.2.0.rc1'
 end

data/test/test_ocra.rb

@@ -4,9 +4,6 @@ require "fileutils"
 require "rbconfig"
 
 require 'rbconfig'
-puts "Version: #{RUBY_VERSION}-p#{RUBY_PATCHLEVEL}"
-puts "Architecture: #{RbConfig::CONFIG['arch']}"
-puts "Host: #{RbConfig::CONFIG['host']}"
 
 begin
   require "rubygems"
@@ -146,17 +143,57 @@ class TestOcra < Test::Unit::TestCase
   end
 
   # Test that arguments are passed correctly to scripts.
-  def test_arguments
+  def test_arguments1
     with_fixture 'arguments' do
       assert system("ruby", ocra, "arguments.rb", *DefaultArgs)
       assert File.exist?("arguments.exe")
       pristine_env "arguments.exe" do
-        system("arguments.exe foo \"bar baz\"")
+        system("arguments.exe foo \"bar baz \\\"quote\\\"\"")
         assert_equal 5, $?.exitstatus
       end
     end
   end
 
+  # Test that arguments are passed correctly to scripts (specified at
+  # compile time).
+  def test_arguments2
+    with_fixture 'arguments' do
+      args = DefaultArgs + ["--", "foo", "bar baz \"quote\"" ]
+      assert system("ruby", ocra, "arguments.rb", *args)
+      assert File.exist?("arguments.exe")
+      pristine_env "arguments.exe" do
+        system("arguments.exe")
+        assert_equal 5, $?.exitstatus
+      end
+    end
+  end
+
+  # Test that arguments are passed correctly to scripts (specified at
+  # compile time).
+  def test_arguments3
+    with_fixture 'arguments' do
+      args = DefaultArgs + ["--", "foo"]
+      assert system("ruby", ocra, "arguments.rb", *args)
+      assert File.exist?("arguments.exe")
+      pristine_env "arguments.exe" do
+        system("arguments.exe \"bar baz \\\"quote\\\"\"")
+        assert_equal 5, $?.exitstatus
+      end
+    end
+  end
+
+  # Test that arguments are passed correctly at build time.
+  def test_buildarg
+    with_fixture "buildarg" do
+      args = DefaultArgs + [ "--", "--some-option" ]
+      assert system("ruby", ocra, "buildarg.rb", *args)
+      assert File.exist?("buildarg.exe")
+      pristine_env "buildarg.exe" do
+        assert system("buildarg.exe")
+      end
+    end
+  end
+  
   # Test that the standard output from a script can be redirected to a
   # file.
   def test_stdout_redir

metadata

@@ -1,14 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: ocra
 version: !ruby/object:Gem::Version 
-  hash: -671420158
   prerelease: true
   segments: 
   - 1
-  - 1
-  - 5
-  - pre3
-  version: 1.1.5.pre3
+  - 2
+  - 0
+  - rc1
+  version: 1.2.0.rc1
 platform: ruby
 authors: 
 - Lars Christensen
@@ -16,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-08-20 00:00:00 +02:00
+date: 2010-08-22 00:00:00 +02:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -27,7 +26,6 @@ dependencies:
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        hash: 7
         segments: 
         - 2
         - 0
@@ -43,7 +41,6 @@ dependencies:
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        hash: 21
         segments: 
         - 2
         - 6
@@ -93,7 +90,6 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
-      hash: 3
       segments: 
       - 0
       version: "0"
@@ -102,7 +98,6 @@ required_rubygems_version: !ruby/object:Gem::Requirement
   requirements: 
   - - ">"
     - !ruby/object:Gem::Version 
-      hash: 25
       segments: 
       - 1
       - 3