irpack 0.2.5 → 0.2.6

data/README.rdoc

@@ -13,6 +13,8 @@ IronRuby 1.1.3 or later.
 You need to use igem (gem command for IronRuby) instead of gem.
 
 ==Usage
+
+===Command
   $ irpack [options] ENTRYFILE [EMBEDFILES...]
     -b BASEDIR               Specify base directory. [base of ENTRYFILE]
     -o OUTPUTFILE            Specify output file name.
@@ -70,6 +72,33 @@ files. To load compressed file costs extra time.
 Runtime options are passed to script engine when generated executable started
 as well as ir.exe.
 
+===Rake task
+
+In Rakefile:
+
+  require 'irpack/rake/generateexetask'
+
+  exe_spec = IRPack::Specification.new do |s|
+    s.output_file      = 'example.exe'
+    s.entry_file       = 'bin/main.rb'
+    s.files            = Rake::Filelist['lib/**/*.rb']
+    s.target           = :exe
+    s.embed_stdlibs    = true
+    s.embed_assemblies = true
+    s.compress         = true
+  end
+
+  IRPack::Rake::GenerateExeTask.new(exe_spec) do |t|
+  end
+
+Invoke 'exe' task to generate 'example.exe'.
+
+  rake exe
+
+If rake command is not exists, use ir.exe;
+
+  ir -rrake -e "Rake.application.run" exe
+
 ==Limitations
 Embedded native dlls and mixed (C++/CLI) assemblies are not loadable.
 
@@ -91,6 +120,7 @@ IronRubyでしか動かないのでigem (IronRubyのgemコマンド)を使って
 
 ==使い方
 
+===コマンド
   $ irpack [options] ENTRYFILE [EMBEDFILES...]
     -b BASEDIR               埋め込み基準のディレクトリを指定します。[ENTRYFILEのあるディレクトリ]
     -o OUTPUTFILE            出力ファイル名を指定します。[ENTRYFILEの拡張子を.exeにしたもの]
@@ -159,6 +189,33 @@ EMBEDFILESにアイコン(.ico)ファイルを指定するとexeのアイコン
 実行時オプションは生成した実行ファイルの起動時にスクリプトエンジンに渡されます。
 ir.exeに指定するのと同じものです。
 
+===Rakeタスク
+
+Rakefileにて:
+
+  require 'irpack/rake/generateexetask'
+
+  exe_spec = IRPack::Specification.new do |s|
+    s.output_file      = 'example.exe'
+    s.entry_file       = 'bin/main.rb'
+    s.files            = Rake::Filelist['lib/**/*.rb']
+    s.target           = :exe
+    s.embed_stdlibs    = true
+    s.embed_assemblies = true
+    s.compress         = true
+  end
+
+  IRPack::Rake::GenerateExeTask.new(exe_spec) do |t|
+  end
+
+'exe'タスクを起動すると'example.exe'を生成することができます。
+
+  rake exe
+
+rakeコマンドが無い場合はir.exeから起動できます。
+
+  ir -rrake -e "Rake.application.run" exe
+
 ==制限
 C++/CLIの混合アセンブリやネイティブdllは埋め込めません。
 

data/lib/irpack.rb

@@ -26,6 +26,7 @@ require 'irpack/bootloader'
 require 'irpack/entrypoint'
 require 'irpack/packager'
 require 'irpack/missing'
+require 'irpack/specification'
 require 'tmpdir'
 
 module IRPack
@@ -73,57 +74,34 @@ module IRPack
   def ironruby_libraries(dstpath='stdlib', srcpath=ironruby_library_path)
     res = {}
     Dir.glob(File.join(srcpath, "{ironruby,ruby/#{ironruby_standard_library_version}}", '**', '*')) do |fn|
-      res[fn] = fn.sub(/^#{srcpath}/, dstpath) if File.file?(fn)
+      res[fn.sub(/^#{srcpath}/, dstpath)] = fn if File.file?(fn)
     end
     res
   end
 
-  def pack(output_file, files, entry_file, opts={}, runtime_options={})
-    opts = {
-      target:           :exe,
-      compress:         false,
-      complete:         false,
-      embed_references: true,
-      seach_paths:      [],
-      module_name:      path_to_module_name(output_file),
-    }.update(opts)
-    runtime_options = {
-      DebugMode:             false,
-      PrivateBinding:        false,
-      NoAdaptiveCompilation: false,
-      CompilationThreshold:  -1,
-      ExceptionDetail:       false,
-      ShowClrExceptions:     false,
-      Profile:               false,
-      Verbosity:             1,
-      DebugVariable:         false,
-      EnableTracing:         false,
-      RequiredPaths:         [],
-      SearchPaths:           [],
-    }.update(runtime_options)
-    output_file = File.expand_path(output_file)
-    basename    = File.basename(output_file, '.*')
-    module_name = opts[:module_name]
-    target      = opts[:target]
-    references  = opts[:references] || ironruby_assemblies
-    compress    = opts[:compress]
-    pack_files  = {}.merge(files)
-    pack_files  = ironruby_libraries.merge(pack_files) if opts[:complete]
-    if opts[:embed_references] then
+  def pack(spec)
+    output_file = File.expand_path(spec.output_file)
+    entry_file  = spec.map_entry
+    basename    = File.basename(spec.output_file, '.*')
+    references  = ironruby_assemblies
+    pack_files  = spec.map_files
+    pack_files  = ironruby_libraries.merge(pack_files) if spec.embed_stdlibs
+    if spec.embed_assemblies then
       references.each do |asm|
-        pack_files[asm] = File.basename(asm)
+        pack_files[File.basename(asm)] = asm
       end
     end
 
+    module_name = spec.module_name || path_to_module_name(output_file)
     Dir.mktmpdir(File.basename($0,'.*')) do |tmp_path|
       entry_dll = File.join(tmp_path, module_name+'.EntryPoint.dll')
-      EntryPoint.compile(entry_dll, module_name, entry_file, references, runtime_options)
-      pack_files[entry_dll] = File.basename(entry_dll)
+      EntryPoint.compile(entry_dll, module_name, entry_file, references, spec.runtime_options.to_hash)
+      pack_files[File.basename(entry_dll)] = entry_dll
 
       package_file = File.join(tmp_path, basename+'.pkg')
-      Packager.pack(pack_files, package_file, compress)
+      Packager.pack(pack_files, package_file, spec.compress)
 
-      BootLoader.compile(target, output_file, module_name, references, package_file)
+      BootLoader.compile(spec.target, output_file, module_name, references, package_file)
     end
     output_file
   end

data/lib/irpack/application.rb

@@ -22,131 +22,87 @@ freely, subject to the following restrictions:
 =end
 
 require 'irpack'
+require 'irpack/specification'
 require 'optparse'
 require 'pathname'
 
 module IRPack
   module Application
-    Arguments = Struct.new(
-      :output_file,
-      :target,
-      :compress,
-      :complete,
-      :embed_references,
-      :runtime_options,
-      :entry_file,
-      :files) do
-      def self.parse!(argv)
-        args = self.new
-        basedir     = nil
-        args.output_file = nil
-        args.target      = :exe
-        args.compress    = false
-        args.complete    = false
-        args.embed_references = true
-        args.entry_file  = nil
-        args.files = {}
-        args.runtime_options = {
-          DebugMode:             false,
-          PrivateBinding:        false,
-          NoAdaptiveCompilation: false,
-          CompilationThreshold:  -1,
-          ExceptionDetail:       false,
-          ShowClrExceptions:     false,
-          Profile:               false,
-          Verbosity:             1,
-          DebugVariable:         false,
-          EnableTracing:         false,
-          RequiredPaths:         [],
-          SearchPaths:           [],
-        }
-        opt = OptionParser.new("Usage: #{$0} [options] ENTRYFILE [EMBEDFILES...]", 24, '  ')
-        opt.on('-b BASEDIR',    'Specify base directory. [base of ENTRYFILE]') {|v| basedir = v }
-        opt.on('-o OUTPUTFILE', 'Specify output file name.') {|v| args.output_file = v }
-        opt.on('--window',      'Generate window app.') { args.target = :winexe }
-        opt.on('--console',     'Generate console app.[default]') { args.target = :exe }
-        opt.on('--compress',    'Compress package.') { args.compress = true }
-        opt.on('--complete',    'Embed all standard libraries.') { args.complete = true }
-        opt.on('--no-embed',    'Do not embed IronRuby assemblies.') {|v| args.embed_references = v }
-        opt.separator('Runtime options:')
-        opt.on('-Idirectory', 'specify $LOAD_PATH directory (may be used more than once)') {|v|
-          args.runtime_options[:SearchPaths] << v
-        }
-        opt.on('-rlibrary', 'require the library, before executing your script') {|v|
-          args.runtime_options[:RequiredPaths] << v
-        }
-        opt.on('-d', 'set debugging flags (set $DEBUG to true)') {|v|
-          args.runtime_options[:DebugVariable] = v
-        }
-        opt.on('-D', 'emit debugging information (PDBs) for Visual Studio debugger') {|v|
-          args.runtime_options[:DebugMode] = v
-        }
-        opt.on('-v', 'print version number, then turn on verbose mode') {|v|
-          args.runtime_options[:Verbosity] = 2
-        }
-        opt.on('-w', 'turn warnings on for your script') {|v|
-          args.runtime_options[:Verbosity] = 2
-        }
-        opt.on('-W[level]', 'set warning level; 0=silence, 1=medium (default), 2=verbose', Integer) {|v|
-          args.runtime_options[:Verbosity] = (v || 2).to_i
-        }
-        opt.on('--trace', 'enable support for set_trace_func') {|v|
-          args.runtime_options[:EnableTracing] = v
-        }
-        opt.on('--profile', "enable support for 'pi = IronRuby::Clr.profile { block_to_profile }'") {|v|
-          args.runtime_options[:Profile] = v
-        }
-        opt.on('--exception-detail', 'enable ExceptionDetail mode') {|v|
-          args.runtime_options[:ExceptionDetail] = v
-        }
-        opt.on('--no-adaptive-compilation', 'disable adaptive compilation - all code will be compiled') {|v|
-          args.runtime_options[:NoAdaptiveCompilation] = true
-        }
-        opt.on('--compilation-threshold THRESHOLD', 'the number of iterations before the interpreter starts compiling', Integer) {|v|
-          args.runtime_options[:CompilationThreshold] = v.to_i
-        }
-        opt.on('--pass-exceptions', 'do not catch exceptions that are unhandled by script code') {|v|
-          args.runtime_options[:PassExceptions] = v
-        }
-        opt.on('--private-binding', 'enable binding to private members') {|v|
-          args.runtime_options[:PrivateBinding] = v
-        }
-        opt.on('--show-clr-exceptions', 'display CLS Exception information') {|v|
-          args.runtime_options[:ShowClrExceptions] = v
-        }
-        opt.parse!(argv)
+    def self.parse!(argv)
+      spec = ::IRPack::Specification.new
+      opt = OptionParser.new("Usage: #{$0} [options] ENTRYFILE [EMBEDFILES...]", 24, '  ')
+      opt.on('-b BASEDIR',    'Specify base directory.') {|v| spec.base_paths << v }
+      opt.on('-o OUTPUTFILE', 'Specify output file name.') {|v| spec.output_file = v }
+      opt.on('--window',      'Generate window app.') { spec.target = :winexe }
+      opt.on('--console',     'Generate console app.[default]') { spec.target = :exe }
+      opt.on('--compress',    'Compress package.') { spec.compress = true }
+      opt.on('--complete',    'Embed all standard libraries.') { spec.complete = true }
+      opt.on('--no-embed',    'Do not embed IronRuby assemblies.') {|v| spec.embed_assemblies = v }
+      opt.on('--[no-]embed-assemblies', 'Embed IronRuby assemblies.')   {|v| spec.embed_assemblies = v }
+      opt.on('--[no-]embed-stdlibs',    'Embed all standard libraris.') {|v| spec.embed_stdlibs = v }
+      opt.separator('Runtime options:')
+      opt.on('-Idirectory', 'specify $LOAD_PATH directory (may be used more than once)') {|v|
+        spec.runtime_options.search_paths << v
+      }
+      opt.on('-rlibrary', 'require the library, before executing your script') {|v|
+        spec.runtime_options.required_paths << v
+      }
+      opt.on('-d', 'set debugging flags (set $DEBUG to true)') {|v|
+        spec.runtime_options.debug_variable = v
+      }
+      opt.on('-D', 'emit debugging information (PDBs) for Visual Studio debugger') {|v|
+        spec.runtime_options.debug_mode = v
+      }
+      opt.on('-v', 'print version number, then turn on verbose mode') {|v|
+        spec.runtime_options.warning_level = 2
+      }
+      opt.on('-w', 'turn warnings on for your script') {|v|
+        spec.runtime_options.warning_level = 2
+      }
+      opt.on('-W[level]', 'set warning level; 0=silence, 1=medium (default), 2=verbose', Integer) {|v|
+        spec.runtime_options.warning_level = (v || 2).to_i
+      }
+      opt.on('--trace', 'enable support for set_trace_func') {|v|
+        spec.runtime_options.trace = v
+      }
+      opt.on('--profile', "enable support for 'pi = IronRuby::Clr.profile { block_to_profile }'") {|v|
+        spec.runtime_options.profile = v
+      }
+      opt.on('--exception-detail', 'enable ExceptionDetail mode') {|v|
+        spec.runtime_options.exception_detail = v
+      }
+      opt.on('--no-adaptive-compilation', 'disable adaptive compilation - all code will be compiled') {|v|
+        spec.runtime_options.no_adaptive_compilation = true
+      }
+      opt.on('--compilation-threshold THRESHOLD', 'the number of iterations before the interpreter starts compiling', Integer) {|v|
+        spec.runtime_options.compilation_threshold = v.to_i
+      }
+      opt.on('--pass-exceptions', 'do not catch exceptions that are unhandled by script code') {|v|
+        spec.runtime_options.pass_exceptions = v
+      }
+      opt.on('--private-binding', 'enable binding to private members') {|v|
+        spec.runtime_options.private_binding = v
+      }
+      opt.on('--show-clr-exceptions', 'display CLS Exception information') {|v|
+        spec.runtime_options.show_clr_exceptions = v
+      }
+      opt.parse!(argv)
 
-        if argv.size<1 then
-          $stderr.puts opt.help
-          nil
-        else
-          basedir = Pathname.new(File.expand_path(basedir || File.dirname(argv[0])).gsub(/\\/, '/'))
-          args.output_file ||= File.join(File.dirname(argv[0]), File.basename(argv[0], '.*')+'.exe')
-          args.entry_file = argv[0]
-          argv.each_with_index do |file, i|
-            fullpath = Pathname.new(file.gsub(/\\/, '/')).expand_path
-            relpath  = fullpath.relative_path_from(basedir)
-            args.files[fullpath.to_s] = relpath.to_s 
-            args.entry_file = relpath.to_s if i==0
-          end
-          args
+      if argv.size<1 then
+        $stderr.puts opt.help
+        nil
+      else
+        spec.entry_file = argv.shift
+        argv.each do |file|
+          spec.files << file
         end
+        spec
       end
     end
 
-    def self.run(args)
-      return 1 unless args
-      IRPack.pack(
-        args.output_file,
-        args.files,
-        args.entry_file,
-        {
-          target:   args.target,
-          compress: args.compress,
-          complete: args.complete,
-          embed_references: args.embed_references,
-        },
-        args.runtime_options)
+    def self.run(spec)
+      return 1 unless spec
+      IRPack.pack(spec)
       return 0
     end
   end

data/lib/irpack/packager.rb

@@ -33,7 +33,7 @@ module IRPack
     def pack(files, package_file, compress=false)
       compress_option = compress ? CompressionOption.normal : CompressionOption.not_compressed
       package = Package.open(package_file, System::IO::FileMode.create)
-      files.each do |src, dest|
+      files.each do |dest, src|
         uri = PackUriHelper.create_part_uri(Uri.new(dest, UriKind.relative))
         part = package.create_part(uri, 'application/octet-stream', compress_option)
         stream = part.get_stream

data/lib/irpack/rake/generateexetask.rb

@@ -0,0 +1,86 @@
+=begin
+Copyright (c) 2011 Ryuichi Sakamoto.
+
+This software is provided 'as-is', without any express or implied
+warranty. In no event will the authors be held liable for any damages
+arising from the use of this software.
+
+Permission is granted to anyone to use this software for any purpose,
+including commercial applications, and to alter it and redistribute it
+freely, subject to the following restrictions:
+
+    1. The origin of this software must not be misrepresented; you must not
+    claim that you wrote the original software. If you use this software
+    in a product, an acknowledgment in the product documentation would be
+    appreciated but is not required.
+
+    2. Altered source versions must be plainly marked as such, and must not be
+    misrepresented as being the original software.
+
+    3. This notice may not be removed or altered from any source
+    distribution.
+=end
+
+require 'rake'
+require 'rake/tasklib'
+require 'pathname'
+require 'irpack'
+
+module IRPack
+  module Rake
+  end
+end
+
+# Define task to generate executable described by IRPack::Specification.
+#
+# Example:
+#
+#   require 'irpack/rake/generateexetask'
+#
+#   exe_spec = IRPack::Specification.new do |s|
+#     s.output_file      = 'example.exe'
+#     s.entry_file       = 'bin/main.rb'
+#     s.files            = Rake::Filelist['lib/**/*.rb']
+#     s.target           = :exe
+#     s.embed_stdlibs    = true
+#     s.embed_assemblies = true
+#     s.compress         = true
+#   end
+#
+#   IRPack::Rake::GenerateExeTask.new(exe_spec) do |t|
+#   end
+#
+class IRPack::Rake::GenerateExeTask < ::Rake::TaskLib
+  # Task name. default is +exe+.
+  attr_accessor :name
+  # Spec to generate executable.
+  attr_accessor :exe_spec
+
+  # Create tasks that generates exe file.
+  # Automatically define the gem if a block is given.
+  # If no block is supplied, then +define+
+  # needs to be called to define the task.
+  def initialize(exe_spec, name=:exe)
+    @defined  = false
+    @name     = name
+    @exe_spec = exe_spec
+    if block_given? then
+      yield self
+      define
+    end
+  end
+  
+  # Create rake tasks.
+  def define
+    raise ArgumentError, "No output_file is specified" unless @exe_spec.output_file
+    raise ArgumentError, "No entry_file is specified" unless @exe_spec.entry_file
+    output_file = @exe_spec.output_file
+    sources = @exe_spec.map_files.values.to_a
+    desc "Generate #{File.basename(output_file)}"
+    task @name => [output_file]
+    file output_file => sources do
+      IRPack.pack(@exe_spec)
+    end
+  end
+end
+