├── nbproject
    ├── private
    │   ├── config.properties
    │   ├── private.xml
    │   ├── rake-t.txt
    │   └── private.properties
    ├── project.properties
    └── project.xml
├── spec
    ├── spec_helper.rb
    ├── builder
    │   ├── fixtures
    │   │   ├── app
    │   │   │   ├── main.rb
    │   │   │   ├── greeters
    │   │   │   │   └── english.rb
    │   │   │   └── ext
    │   │   │   │   └── greeters
    │   │   │   │       └── JavaGreeter.java
    │   │   └── jruby
    │   │   │   └── lib
    │   │   │       └── jruby.jar
    │   ├── package_spec.rb
    │   ├── create_init_spec.rb
    │   ├── builder_spec.rb
    │   ├── spec_helper.rb
    │   ├── before_spec.rb
    │   └── copy_spec.rb
    ├── console
    │   ├── spec_helper.rb
    │   └── console_spec.rb
    ├── jartask
    │   └── jartask_spec.rb
    └── listener
    │   └── listener_spec.rb
├── TODO
├── lib
    ├── ruby2jar
    │   ├── error.rb
    │   ├── console.rb
    │   ├── listener.rb
    │   ├── jartask.rb
    │   └── builder.rb
    └── ruby2jar.rb
├── README
├── Rakefile
└── LICENSE


/nbproject/private/config.properties:
--------------------------------------------------------------------------------
1 | 


--------------------------------------------------------------------------------
/spec/spec_helper.rb:
--------------------------------------------------------------------------------
1 | require File.join(File.dirname(__FILE__), "..", "lib", "ruby2jar")


--------------------------------------------------------------------------------
/TODO:
--------------------------------------------------------------------------------
1 | * Gem list loader from gem task in Rakefile, gem spec file and tracing appliation
2 | * Create JAR from gem


--------------------------------------------------------------------------------
/spec/builder/fixtures/app/main.rb:
--------------------------------------------------------------------------------
1 | require "greeters/english"
2 | 
3 | g = EnglishGreeter.new("World")
4 | g.salute
5 | 


--------------------------------------------------------------------------------
/spec/builder/fixtures/jruby/lib/jruby.jar:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/ai/ruby2jar/master/spec/builder/fixtures/jruby/lib/jruby.jar


--------------------------------------------------------------------------------
/spec/builder/fixtures/app/greeters/english.rb:
--------------------------------------------------------------------------------
1 | class EnglishGreeter
2 |   def initialize(name)
3 |     @name = name.capitalize
4 |   end
5 |   def salute
6 |     puts "Hello #{@name}!"
7 |   end
8 | end
9 | 


--------------------------------------------------------------------------------
/spec/builder/fixtures/app/ext/greeters/JavaGreeter.java:
--------------------------------------------------------------------------------
1 | package greeters;
2 | 
3 | class JavaGreeter {
4 |     public static void salute(String name) {
5 |         System.out.println("Hello " + name + "!");
6 |     }
7 | }


--------------------------------------------------------------------------------
/nbproject/private/private.xml:
--------------------------------------------------------------------------------
1 | <?xml version="1.0" encoding="UTF-8"?>
2 | <project-private xmlns="http://www.netbeans.org/ns/project-private/1">
3 |     <editor-bookmarks xmlns="http://www.netbeans.org/ns/editor-bookmarks/1"/>
4 | </project-private>
5 | 


--------------------------------------------------------------------------------
/nbproject/private/rake-t.txt:
--------------------------------------------------------------------------------
1 | (in /home/ai/Разработка/ruby2jar)
2 | rake clobber_rcov  # Remove rcov products for rcov
3 | rake rcov          # RCov
4 | rake spec          # Run a specific spec with TASK=xxxx
5 | rake specs         # Run all specs
6 | rake specs_html    # Run all specs output html
7 | 


--------------------------------------------------------------------------------
/nbproject/project.properties:
--------------------------------------------------------------------------------
 1 | bin.dir=${file.reference.ruby2jar-bin}
 2 | file.reference.ruby2jar-bin=bin
 3 | file.reference.ruby2jar-lib=lib
 4 | file.reference.ruby2jar-spec=spec
 5 | javac.classpath=
 6 | main.file=
 7 | ruby.includejava=false
 8 | source.encoding=UTF-8
 9 | src.dir=${file.reference.ruby2jar-lib}
10 | test.src.dir=${file.reference.ruby2jar-spec}
11 | 


--------------------------------------------------------------------------------
/nbproject/private/private.properties:
--------------------------------------------------------------------------------
1 | file.reference.ruby2jar-bin=/home/ai/\u0420\u0430\u0437\u0440\u0430\u0431\u043e\u0442\u043a\u0430/ruby2jar/bin
2 | file.reference.ruby2jar-lib=/home/ai/\u0420\u0430\u0437\u0440\u0430\u0431\u043e\u0442\u043a\u0430/ruby2jar/lib
3 | file.reference.ruby2jar-spec=/home/ai/\u0420\u0430\u0437\u0440\u0430\u0431\u043e\u0442\u043a\u0430/ruby2jar/spec
4 | platform.active=Ruby
5 | 


--------------------------------------------------------------------------------
/spec/console/spec_helper.rb:
--------------------------------------------------------------------------------
 1 | require File.join(File.dirname(__FILE__), "..", "spec_helper")
 2 | 
 3 | module Ruby2Jar
 4 |   class FakeConsole < Console
 5 |     def initialize(builder, warnings = true)
 6 |       super(builder, warnings)
 7 |       @error_messages = []
 8 |       @warning_messages = []
 9 |     end
10 |     def error(msg)
11 |       @error_messages << msg
12 |     end
13 |     def warning(msg)
14 |       @warning_messages << msg
15 |     end
16 |   end
17 | end


--------------------------------------------------------------------------------
/nbproject/project.xml:
--------------------------------------------------------------------------------
 1 | <?xml version="1.0" encoding="UTF-8"?>
 2 | <project xmlns="http://www.netbeans.org/ns/project/1">
 3 |     <type>org.netbeans.modules.ruby.rubyproject</type>
 4 |     <configuration>
 5 |         <data xmlns="http://www.netbeans.org/ns/ruby-project/1">
 6 |             <name>Ruby2Jar</name>
 7 |             <source-roots>
 8 |                 <root id="src.dir" name="lib"/>
 9 |                 <root id="bin.dir"/>
10 |             </source-roots>
11 |             <test-roots>
12 |                 <root id="test.src.dir" name="spec"/>
13 |             </test-roots>
14 |         </data>
15 |     </configuration>
16 | </project>
17 | 


--------------------------------------------------------------------------------
/spec/console/console_spec.rb:
--------------------------------------------------------------------------------
 1 | require File.join(File.dirname(__FILE__), "..", "spec_helper")
 2 | 
 3 | require "tempfile"
 4 | 
 5 | describe Ruby2Jar::Console do
 6 |   before :each do
 7 |     @console = Ruby2Jar::Console.new
 8 |     @real_stderr = STDERR.clone
 9 |     @errors = Tempfile.new "ruby2jar_test_stderr"
10 |     STDERR.reopen(@errors)
11 |   end
12 |   
13 |   it "should print message from exception in STDERR" do
14 |     @console.on_error(Ruby2Jar::Error.new("ERROR_MSG"))
15 |     @errors.rewind
16 |     @errors.read.should include("ERROR_MSG")
17 |   end
18 |   
19 |   it "shouldn't catch non-builder exceptions" do
20 |     @console.on_error(Ruby2Jar::Error.new).should be_true
21 |     @console.on_error(Exception.new).should be_false
22 |   end
23 |   
24 |   after :each do
25 |     STDERR.reopen(@real_stderr)
26 |   end
27 | end


--------------------------------------------------------------------------------
/lib/ruby2jar/error.rb:
--------------------------------------------------------------------------------
 1 | =begin
 2 | Error on building.
 3 | 
 4 | Copyright (C) 2008 Andrey "A.I." Sitnik <andrey@sitnik.ru>
 5 | 
 6 | This program is free software: you can redistribute it and/or modify
 7 | it under the terms of the GNU General Public License as published by
 8 | the Free Software Foundation, either version 3 of the License, or
 9 | (at your option) any later version.
10 | 
11 | This program is distributed in the hope that it will be useful,
12 | but WITHOUT ANY WARRANTY; without even the implied warranty of
13 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
14 | GNU General Public License for more details.
15 | 
16 | You should have received a copy of the GNU General Public License
17 | along with this program.  If not, see <http://www.gnu.org/licenses/>.
18 | =end
19 | 
20 | module Ruby2Jar
21 |   # Error on JAR building
22 |   class Error < Exception; end
23 | end


--------------------------------------------------------------------------------
/lib/ruby2jar.rb:
--------------------------------------------------------------------------------
 1 | =begin
 2 | Load all neccessary classes.
 3 | 
 4 | Copyright (C) 2008 Andrey "A.I." Sitnik <andrey@sitnik.ru>
 5 | 
 6 | This program is free software: you can redistribute it and/or modify
 7 | it under the terms of the GNU General Public License as published by
 8 | the Free Software Foundation, either version 3 of the License, or
 9 | (at your option) any later version.
10 | 
11 | This program is distributed in the hope that it will be useful,
12 | but WITHOUT ANY WARRANTY; without even the implied warranty of
13 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
14 | GNU General Public License for more details.
15 | 
16 | You should have received a copy of the GNU General Public License
17 | along with this program.  If not, see <http://www.gnu.org/licenses/>.
18 | =end
19 | 
20 | $LOAD_PATH.unshift File.expand_path(File.dirname(__FILE__)) unless
21 |   $LOAD_PATH.include?(File.dirname(__FILE__)) ||
22 |   $LOAD_PATH.include?(File.expand_path(File.dirname(__FILE__)))
23 | 
24 | require "ruby2jar/builder"
25 | 
26 | module Ruby2Jar
27 |   autoload :Listener, "ruby2jar/listener"
28 |   autoload :Console, "ruby2jar/console"
29 |   autoload :Error, "ruby2jar/error"
30 |   autoload :JarTask, "ruby2jar/jartask"
31 | end


--------------------------------------------------------------------------------
/spec/jartask/jartask_spec.rb:
--------------------------------------------------------------------------------
 1 | require File.join(File.dirname(__FILE__), "..", "spec_helper")
 2 | 
 3 | describe Ruby2Jar::JarTask do
 4 | 
 5 |   it "should add task for create and clobber JAR" do
 6 |     task = Ruby2Jar::JarTask.new do |jar|
 7 |       jar.name = "app"
 8 |     end
 9 |     
10 |     Rake::Task["jar"].comment.should == "Build the JAR file pkg/app.jar"
11 |     Rake::Task["clobber_jar"].comment.should == "Remove JAR file pkg/app.jar"
12 |     
13 |     Rake::Task["package"].prerequisites.should include("jar")
14 |     Rake::Task["clobber"].prerequisites.should include("clobber_jar")
15 |   end
16 |   
17 |   it "should set JAR filename by application name and version" do
18 |     task = Ruby2Jar::JarTask.new do |jar|
19 |       jar.name = "MyProgram"
20 |     end
21 |     task.jar.should == "pkg/MyProgram.jar"
22 |     
23 |     task = Ruby2Jar::JarTask.new do |jar|
24 |       jar.name = "MyProgram"
25 |       jar.version = "1.0"
26 |     end
27 |     task.jar.should == "pkg/MyProgram-1.0.jar"
28 |   end
29 |   
30 |   it "shouldn't replace JAR filename if user set it" do
31 |     task = Ruby2Jar::JarTask.new do |jar|
32 |       jar.jar = "some path"
33 |     end
34 |     task.jar.should == "some path"
35 |   end
36 |   
37 | end


--------------------------------------------------------------------------------
/lib/ruby2jar/console.rb:
--------------------------------------------------------------------------------
 1 | =begin
 2 | Command line interface for ruby2jar builder.
 3 | 
 4 | Copyright (C) 2008 Andrey "A.I." Sitnik <andrey@sitnik.ru>
 5 | 
 6 | This program is free software: you can redistribute it and/or modify
 7 | it under the terms of the GNU General Public License as published by
 8 | the Free Software Foundation, either version 3 of the License, or
 9 | (at your option) any later version.
10 | 
11 | This program is distributed in the hope that it will be useful,
12 | but WITHOUT ANY WARRANTY; without even the implied warranty of
13 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
14 | GNU General Public License for more details.
15 | 
16 | You should have received a copy of the GNU General Public License
17 | along with this program.  If not, see <http://www.gnu.org/licenses/>.
18 | =end
19 | 
20 | module Ruby2Jar
21 |   # Command line interface for builder. Check builder parameters and
22 |   # print error and warnings to console.
23 |   class Console < Listener
24 |     # Print message for standart builder error
25 |     def on_error(error)
26 |       if Error == error.class
27 |         STDERR.puts "ERROR: #{error.message}"
28 |         true
29 |       else
30 |         false
31 |       end
32 |     end
33 |   end
34 | end


--------------------------------------------------------------------------------
/lib/ruby2jar/listener.rb:
--------------------------------------------------------------------------------
 1 | =begin
 2 | Simple metaclass to create extensions for builder.
 3 | 
 4 | Copyright (C) 2008 Andrey "A.I." Sitnik <andrey@sitnik.ru>
 5 | 
 6 | This program is free software: you can redistribute it and/or modify
 7 | it under the terms of the GNU General Public License as published by
 8 | the Free Software Foundation, either version 3 of the License, or
 9 | (at your option) any later version.
10 | 
11 | This program is distributed in the hope that it will be useful,
12 | but WITHOUT ANY WARRANTY; without even the implied warranty of
13 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
14 | GNU General Public License for more details.
15 | 
16 | You should have received a copy of the GNU General Public License
17 | along with this program.  If not, see <http://www.gnu.org/licenses/>.
18 | =end
19 | 
20 | module Ruby2Jar
21 |   # Simple metaclass to create extensions for builder, which provide user
22 |   # interface or special functions, such as creating Java Web Start files.
23 |   #
24 |   # It add all listener methods started by "before_" to builder.
25 |   class Listener
26 |     # Add listeners to +builder+
27 |     def initialize(builder = nil)
28 |       if not builder.nil?
29 |         @builder = builder
30 |         builder.methods.reject {|i| not i =~ /^(before_|on_error$)/}.each do |m|
31 |           if methods.include? m
32 |             builder.method(m).call << method(m)
33 |           end
34 |         end
35 |       end
36 |     end
37 |   end
38 | end
39 | 


--------------------------------------------------------------------------------
/spec/listener/listener_spec.rb:
--------------------------------------------------------------------------------
 1 | require File.join(File.dirname(__FILE__), "..", "spec_helper")
 2 | 
 3 | describe Ruby2Jar::Listener do
 4 | 
 5 |   it "should add before_* functions as builder listeners" do
 6 |     three_proc = lambda {}
 7 |     
 8 |     class Builder1
 9 |       attr_accessor :before_one
10 |       attr_accessor :before_two
11 |       attr_accessor :before_three
12 |     end
13 |     builder = Builder1.new
14 |     builder.before_one = []
15 |     builder.before_two = []
16 |     builder.before_three = [three_proc]
17 |     
18 |     class Listener1 < Ruby2Jar::Listener
19 |       def before_two; end
20 |       def before_three; end
21 |       def before_four; end
22 |     end
23 |     listener = Listener1.new(builder)
24 |     
25 |     builder.before_one.should == []
26 |     builder.before_two.should == [listener.method(:before_two)]
27 |     builder.before_three.should == [three_proc, listener.method(:before_three)]
28 |   end
29 |   
30 |   it "should add on_error function as builder listener" do
31 |     class Builder2
32 |       attr_accessor :before_one
33 |       attr_accessor :on_error
34 |     end
35 |     builder = Builder2.new
36 |     builder.before_one = []
37 |     builder.on_error = []
38 |     
39 |     class Listener2 < Ruby2Jar::Listener
40 |       def before_one; end
41 |       def on_error; end
42 |     end
43 |     listener = Listener2.new(builder)
44 |     
45 |     builder.before_one.should == [listener.method(:before_one)]
46 |     builder.on_error.should == [listener.method(:on_error)]
47 |   end
48 |   
49 | end


--------------------------------------------------------------------------------
/spec/builder/package_spec.rb:
--------------------------------------------------------------------------------
 1 | require File.join(File.dirname(__FILE__), "spec_helper")
 2 | 
 3 | describe Ruby2Jar::Builder do
 4 |   include DirHelper
 5 |   
 6 |   before :each do
 7 |     @builder = Ruby2Jar::Builder.new
 8 |     @builder.include_jruby = false
 9 |     @app_path = TempDir.create
10 |     @result_path = TempDir.create
11 |     @builder.path = @app_path
12 |     @builder.jar = File.join(@result_path, "result.jar")
13 |   end
14 |   
15 |   it "should package all files to JAR" do
16 |     create_files @builder.path, ["one.class", "subdir/two.class"]
17 |     
18 |     @builder.build
19 |     @builder.jar.should contain_files(
20 |       "ruby/app/one.class", "ruby/app/subdir/two.class", "META-INF/MANIFEST.MF")
21 |   end
22 |   
23 |   it "should copy JRuby classes if it neccessary" do
24 |     @builder.include_jruby = true
25 |     @builder.jruby = File.join(File.expand_path(File.dirname(__FILE__)), 
26 |       "fixtures", "jruby", "lib", "jruby.jar")
27 |     
28 |     @builder.build
29 |     @builder.jar.should contain_files("jruby.class", "META-INF/MANIFEST.MF")
30 |   end
31 |   
32 |   it "should add manifest if it neccessary" do
33 |     @builder.create_manifest = true
34 |     @builder.manifest["test"] = "value"
35 |     
36 |     @builder.build
37 |     dir = TempDir.create
38 |     current = Dir.getwd
39 |     Dir.chdir dir
40 |         
41 |     `jar -xf #{@builder.jar}`
42 |     IO.read("META-INF/MANIFEST.MF").should include("test: value")
43 |         
44 |      Dir.chdir current
45 |      dir.delete
46 |   end
47 |   
48 |   after :each do
49 |     @app_path.delete
50 |     @result_path.delete
51 |   end
52 | end


--------------------------------------------------------------------------------
/README:
--------------------------------------------------------------------------------
 1 | = Ruby2Jar - build JAR from Ruby script
 2 | 
 3 | Ruby2Jar builds JAR from a Ruby script. It copies gems, compiles sources
 4 | and packages JAR. It is an easy way to distribute your JRuby application or 
 5 | create Applet or Java Web Start.
 6 | 
 7 | == Installation
 8 | Use Gem to download and install Ruby2Jar.
 9 | 
10 |    gem install ruby2jar
11 | 
12 | You must have Java Development Kit to use JAR builder. Also you should run it 
13 | from JRuby for correct platform in gems.
14 | 
15 | == Usage
16 | Add task to build JAR in Rakefile:
17 | 
18 |   require "rubygems"
19 |   require "ruby2jar"
20 |   
21 |   PKG_NAME = "program"
22 |   PKG_VERSION = "0.1"
23 |   
24 |   Ruby2Jar::Rake::JarTask.new do |jar|
25 |     jar.files = FileList["lib/**/*", "bin/*"]
26 |     jar.main = "bin/program"
27 |     jar.name = PKG_NAME
28 |     jar.version = PKG_VERSION
29 |     jar.add_dependency "rspec"
30 |   end
31 | 
32 | == Limitation
33 | In current JRuby version (1.1.2) you can't use Ruby file system functions 
34 | and +__FILE__+ constant in JAR. So didn't use <tt>Dir.glob</tt> to require 
35 | all files in dir or somethink like this.
36 | 
37 | If program containt Java files it must be in ext/ dir. Source Java files 
38 | without class files will be compiled.
39 | 
40 | == Gem config
41 | Gem can contain building config <tt>java.yaml</tt> in gem root. Builder will 
42 | find list of exclude file patterns in <tt>jar.exclude</tt> config node.
43 | 
44 | == License
45 | Ruby2Jar is licensed under the GNU General Public License version 3.
46 | You can read it in LICENSE file or in http://www.gnu.org/licenses/gpl.html .
47 | 
48 | == Author
49 | Andrey "A.I." Sitnik <andrey@sitnik.ru>
50 | 


--------------------------------------------------------------------------------
/spec/builder/create_init_spec.rb:
--------------------------------------------------------------------------------
 1 | require File.join(File.dirname(__FILE__), "spec_helper")
 2 | 
 3 | describe Ruby2Jar::Builder do
 4 |   before :each do
 5 |     @builder = Ruby2Jar::Builder.new
 6 |     @builder.include_jruby = false
 7 |     @app_path = TempDir.create
 8 |     @builder.path = @app_path
 9 |     @builder.before_compile << lambda { @builder.stop }
10 |     FileUtils.touch File.join(@builder.path, "main.rb")
11 |     @builder.main = "main.rb"
12 |   end
13 |   
14 |   it "should create init script" do
15 |     @builder.before_compile << lambda { 
16 |       File.exist?(File.join(@builder.build_dir, "ruby", "init.rb")).should be_true
17 |     }
18 |     @builder.build
19 |   end
20 |   
21 |   it "should create init script with gem and require methods and calling main" do
22 |     @builder.before_compile << lambda {
23 |       init = IO.read File.join(@builder.build_dir, "ruby", "init.rb")
24 |       init.should include('def gem')
25 |       init.should include('def require')
26 |       init.should include('require "ruby/app/main"')
27 |     }
28 |     @builder.build
29 |   end
30 |   
31 |   it "should add init_require_paths to LOAD_PATH in init script" do
32 |     @builder.before_create_init << lambda { 
33 |       @builder.init_require_paths = ["one", "two/subdir"]
34 |     }
35 |     @builder.before_compile << lambda {
36 |       init = IO.read File.join(@builder.build_dir, "ruby", "init.rb")
37 |       init.should include('$LOAD_PATH << "one"')
38 |       init.should include('$LOAD_PATH << "two/subdir"')
39 |     }
40 |     @builder.build
41 |   end
42 |   
43 |   it "shouldn't do any action if main script isn't set" do
44 |     @builder.main = nil
45 |     @builder.before_compile << lambda {
46 |       File.exist?(File.join(@builder.build_dir, "ruby", "init.rb")).should be_false
47 |     }
48 |     @builder.build
49 |   end
50 |   
51 |   it "should add init script as Main-Class to manifest" do
52 |     @builder.before_compile << lambda {
53 |       @builder.manifest["Main-Class"].should == "ruby.init"
54 |     }
55 |     @builder.build
56 |   end
57 |   
58 |   it "shouldn't replace Main-Class in manifest" do
59 |     @builder.manifest["Main-Class"] = "test"
60 |     @builder.before_compile << lambda {
61 |       @builder.manifest["Main-Class"].should == "test"
62 |     }
63 |     @builder.build
64 |   end
65 |   
66 |   after :each do
67 |     @app_path.delete
68 |   end
69 | end


--------------------------------------------------------------------------------
/Rakefile:
--------------------------------------------------------------------------------
 1 | require 'rubygems'
 2 | require 'rake'
 3 | require "rake/rdoctask"
 4 | require 'spec/rake/spectask'
 5 | require 'rake/gempackagetask'
 6 | 
 7 | require File.join(File.dirname(__FILE__), "lib", "ruby2jar")
 8 | 
 9 | ##############################################################################
10 | # Tests
11 | ##############################################################################
12 | 
13 | desc "Run all specs"
14 | Spec::Rake::SpecTask.new('specs') do |t|
15 |   t.spec_opts = ["--format", "specdoc", "--colour"]
16 |   t.spec_files = Dir['spec/**/*_spec.rb'].sort
17 | end
18 | 
19 | desc "Run a specific spec with TASK=xxxx"
20 | Spec::Rake::SpecTask.new('spec') do |t|
21 |   t.spec_opts = ["--format", "specdoc", "--colour"]
22 |   t.libs = ['lib']
23 |   t.spec_files = ["spec/**/#{ENV['TASK']}_spec.rb"]
24 | end
25 | 
26 | desc "Run all specs output html"
27 | Spec::Rake::SpecTask.new('specs_html') do |t|
28 |   t.spec_opts = ["--format", "html"]
29 |   t.libs = ['lib']
30 |   t.spec_files = Dir['spec/**/*_spec.rb'].sort
31 | end
32 | 
33 | desc "RCov"
34 | Spec::Rake::SpecTask.new('rcov') do |t|
35 |   t.spec_opts = ["--format", "specdoc", "--colour"]
36 |   t.spec_files = Dir['spec/**/*_spec.rb'].sort
37 |   t.libs = ['lib']
38 |   t.rcov = true
39 | end
40 | 
41 | ##############################################################################
42 | # Documentation and distribution
43 | ##############################################################################
44 | 
45 | Rake::RDocTask.new do |rdoc|
46 |   rdoc.main = "README"
47 |   rdoc.rdoc_files.include("README", "LICENSE", "lib/**/*.rb")
48 |   rdoc.title = "Ruby2Jar docs"
49 |   rdoc.rdoc_dir = "doc"
50 |   rdoc.options << "--all"
51 | end
52 | 
53 | spec = Gem::Specification.new do |s|
54 |   s.platform = Gem::Platform::RUBY
55 |   s.name = "ruby2jar"
56 |   s.version = "0.1"
57 |   s.summary = "Build JAR from Ruby script."
58 |   s.description = <<-EOF
59 |     Ruby2Jar build JAR from Ruby script. It copy gems, compile sources and 
60 |     package JAR. It is a easy way to distribute your JRuby application or to 
61 |     create Applet or Java Web Start.
62 |   EOF
63 |   
64 |   s.files = FileList[
65 |     "lib/**/*", 
66 |     "spec/**/*",
67 |     "LICENSE",
68 |     "TODO",
69 |     "Rakefile",
70 |     "README"]
71 |   s.require_path = 'lib'
72 |   
73 |   s.add_dependency 'rake'
74 |   
75 |   s.author = 'Andrey "A.I." Sitnik'
76 |   s.email = "andrey@sitnik.ru"
77 |   s.homepage = "http://ruby2jar.rubyforge.org/"
78 |   s.rubyforge_project = "ruby2jar"
79 | end
80 | 
81 | Rake::GemPackageTask.new(spec) do |pkg|
82 |   pkg.gem_spec = spec
83 | end


--------------------------------------------------------------------------------
/lib/ruby2jar/jartask.rb:
--------------------------------------------------------------------------------
 1 | =begin
 2 | Rake task for building.
 3 | 
 4 | Copyright (C) 2008 Andrey "A.I." Sitnik <andrey@sitnik.ru>
 5 | 
 6 | This program is free software: you can redistribute it and/or modify
 7 | it under the terms of the GNU General Public License as published by
 8 | the Free Software Foundation, either version 3 of the License, or
 9 | (at your option) any later version.
10 | 
11 | This program is distributed in the hope that it will be useful,
12 | but WITHOUT ANY WARRANTY; without even the implied warranty of
13 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
14 | GNU General Public License for more details.
15 | 
16 | You should have received a copy of the GNU General Public License
17 | along with this program.  If not, see <http://www.gnu.org/licenses/>.
18 | =end
19 | 
20 | module Ruby2Jar
21 |   # Rake task to build JAR.
22 |   #
23 |   # Example:
24 |   # 
25 |   #   require "rubygems"
26 |   #   require "ruby2jar"
27 |   #   
28 |   #   PKG_NAME = "program"
29 |   #   PKG_VERSION = "0.1"
30 |   #   
31 |   #   Ruby2Jar::Rake::JarTask.new do |jar|
32 |   #     jar.files = FileList["lib/**/*", "bin/*"]
33 |   #     jar.main = "bin/program"
34 |   #     jar.name = PKG_NAME
35 |   #     jar.version = PKG_VERSION
36 |   #     jar.add_dependency "rspec"
37 |   #   end
38 |   class JarTask
39 |     # Name of JAR package
40 |     attr_accessor :name
41 | 
42 |     # Version of application to use in JAR name
43 |     attr_accessor :version
44 | 
45 |     # Create an RDoc task named +task+ (default task name is +jar+)
46 |     def initialize(task = :jar)
47 |       @task = task
48 |       @builder = Builder.new
49 |       Console.new(@builder)
50 |       yield self if block_given?
51 |       if @builder.jar.nil? and not @name.nil?
52 |         if not @version.nil?
53 |           @builder.jar = "pkg/#{@name}-#{@version}.jar"
54 |         else
55 |           @builder.jar = "pkg/#{@name}.jar"
56 |         end
57 |       end
58 |       define
59 |     end
60 | 
61 |     # Create the tasks
62 |     def define
63 |       task :package => [@task]
64 |       desc "Build the JAR file #{@builder.jar}"
65 |       task @task do
66 |         @builder.build
67 |       end
68 | 
69 |       task :clobber => ["clobber_#{@task}"]
70 |       desc "Remove JAR file #{@builder.jar}"
71 |       task "clobber_#{@task}" do
72 |         File.delete @builder.jar if File.exists? @builder.jar
73 |         pkg = File.dirname(@builder.jar)
74 |         Dir.delete pkg if Dir.entries(pkg)
75 |       end
76 |     end
77 | 
78 |     # Set parameters of JAR builder
79 |     def method_missing(method, *args)
80 |       if not @builder.method(method).nil?
81 |         @builder.method(method).call(*args)
82 |       else
83 |         super(method, *args)
84 |       end
85 |     end
86 |   end
87 | end


--------------------------------------------------------------------------------
/spec/builder/builder_spec.rb:
--------------------------------------------------------------------------------
  1 | require File.join(File.dirname(__FILE__), "spec_helper")
  2 | 
  3 | describe Ruby2Jar::Builder do
  4 |   include DirHelper
  5 |   
  6 |   it "should do all steps and extension functions in order" do
  7 |     builder = TracerBuilder.new
  8 |     builder.before_copy << lambda {
  9 |       builder.steps << "touch"
 10 |     }
 11 |     
 12 |     builder.build
 13 |     builder.steps.should == [
 14 |       "before_start", "start",
 15 |       "before_copy", "touch", "copy",
 16 |       "before_create_init", "create_init",
 17 |       "before_compile", "compile",
 18 |       "before_package", "package",
 19 |       "before_finish", "finish"]
 20 |   end
 21 |   
 22 |   it "should can stop finish it work" do
 23 |     builder = TracerBuilder.new
 24 |     builder.before_create_init << lambda {
 25 |       builder.steps << "STOP"
 26 |       builder.stop
 27 |     }
 28 |     
 29 |     builder.build
 30 |     builder.steps.should == [
 31 |       "before_start", "start",
 32 |       "before_copy", "copy",
 33 |       "before_create_init", "STOP",
 34 |       "before_finish", "finish"]
 35 |   end
 36 |   
 37 |   it "should finish it work on exception" do
 38 |     builder = TracerBuilder.new
 39 |     builder.before_copy << lambda {
 40 |       builder.steps << "SHOT"
 41 |       raise "Shot"
 42 |     }
 43 |     builder.before_finish << lambda {
 44 |       builder.steps << "HEADSHOT"
 45 |       raise "Headshot"
 46 |     }
 47 |     
 48 |     begin
 49 |       builder.build
 50 |     rescue; end
 51 |     builder.steps.should == [
 52 |       "before_start", "start",
 53 |       "before_copy", "SHOT", "on_error Shot",
 54 |       "before_finish", "HEADSHOT", "finish"]
 55 |   end
 56 |   
 57 |   it "should raise error if it doesn't rescue on_error extensions" do
 58 |     builder = TracerBuilder.new
 59 |     builder.before_start << lambda { raise }
 60 |     
 61 |     builder.on_error = [lambda { true }]
 62 |     builder.method(:build).should_not raise_error
 63 |     
 64 |     builder.on_error = [lambda { false }]
 65 |     builder.method(:build).should raise_error
 66 |   end
 67 |   
 68 |   it "should remember added gems" do
 69 |     builder = Ruby2Jar::Builder.new
 70 |     builder.add_dependency "one"
 71 |     builder.add_dependency "two", ">=0.1", "< 1.0"
 72 |     builder.gems.should == [["one", []], ["two", [">=0.1", "< 1.0"]]]
 73 |   end
 74 |   
 75 |   it "should compile all Ruby and Java files" do
 76 |     builder = Ruby2Jar::Builder.new
 77 |     builder.path = File.join(File.dirname(__FILE__), "fixtures", "app")
 78 |     
 79 |     builder.before_package << lambda {
 80 |       builder.build_dir.should contain_files("ruby/app/main.class", 
 81 |         "ruby/app/greeters/english.class", "greeters/JavaGreeter.class")
 82 |       builder.stop
 83 |     }
 84 |     builder.build
 85 |   end
 86 |   
 87 |   it "should create working JAR" do
 88 |     builder = Ruby2Jar::Builder.new
 89 |     builder.path = File.join(File.dirname(__FILE__), "fixtures", "app")
 90 |     builder.main = "main.rb"
 91 |     dir = TempDir.create
 92 |     builder.include_jruby = true
 93 |     builder.jar = File.join(dir, "result.jar")
 94 |     builder.build
 95 |     
 96 |     `java -jar #{builder.jar}`.should == "Hello World!\n"
 97 |     
 98 |     dir.delete
 99 |   end
100 | end


--------------------------------------------------------------------------------
/spec/builder/spec_helper.rb:
--------------------------------------------------------------------------------
  1 | require File.join(File.dirname(__FILE__), "..", "spec_helper")
  2 | 
  3 | require "tmpdir"
  4 | require "fileutils"
  5 | 
  6 | class TracerBuilder < Ruby2Jar::Builder
  7 |   attr_accessor :steps
  8 |   def initialize
  9 |     super
 10 |     @steps = []
 11 |     @before_start       << lambda { self.steps << "before_start" }
 12 |     @before_copy        << lambda { self.steps << "before_copy" }
 13 |     @before_create_init << lambda { self.steps << "before_create_init" }
 14 |     @before_compile     << lambda { self.steps << "before_compile" }
 15 |     @before_package     << lambda { self.steps << "before_package" }
 16 |     @before_finish      << lambda { self.steps << "before_finish" }
 17 |     @on_error << lambda { |error| self.steps << "on_error #{error}"; false }
 18 |   end
 19 |   def start
 20 |     @steps << "start"
 21 |   end
 22 |   def copy
 23 |     @steps << "copy"
 24 |   end
 25 |   def create_init
 26 |     @steps << "create_init"
 27 |   end
 28 |   def compile
 29 |     @steps << "compile"
 30 |   end
 31 |   def package
 32 |     @steps << "package"
 33 |   end
 34 |   def finish
 35 |     @steps << "finish"
 36 |   end
 37 | end
 38 | 
 39 | class TempDir < String
 40 |   def self.create
 41 |     dir = self.new
 42 |     Dir.mkdir dir
 43 |     dir
 44 |   end
 45 |   def initialize
 46 |     number = Time.now.to_i
 47 |     begin
 48 |       number += 1
 49 |       tmpdir = File.join(Dir.tmpdir, "ruby2jar_test_#{number}")
 50 |     end while File.exist? tmpdir
 51 |     self.replace tmpdir
 52 |   end
 53 |   def delete
 54 |     FileUtils.rm_r self
 55 |   end
 56 | end
 57 | 
 58 | class FakeGems
 59 |   attr_accessor :gems
 60 |   def find_name(gem, version)
 61 |     @gems["#{gem}-#{version}"].to_a
 62 |   end
 63 | end
 64 | 
 65 | class FakeSpecification
 66 |   attr_accessor :name, :full_name, :full_gem_path, :require_paths, :dependencies
 67 |   def initialize(name, version, path, dependencies = [])
 68 |     @name = name
 69 |     @full_name = "#{name}-#{version}"
 70 |     @full_gem_path = path
 71 |     @require_paths = "lib"
 72 |     @dependencies = dependencies
 73 |   end
 74 |   def to_a
 75 |     [self]
 76 |   end
 77 | end
 78 | 
 79 | module DirHelper
 80 |   class ContainFiles
 81 |     def initialize(files)
 82 |       @files = files.sort
 83 |     end
 84 |     def files(dir)
 85 |       Dir.glob(File.join(dir, "**", "*")).delete_if { |i| File.directory? i }.map { |i| i[dir.length+1..-1] }.sort
 86 |     end
 87 |     def matches?(path)
 88 |       @path = path
 89 |       if File.directory? @path
 90 |         @in_dir = files @path
 91 |       elsif ".jar" == File.extname(@path)
 92 |         dir = TempDir.create
 93 |         current = Dir.getwd
 94 |         Dir.chdir dir
 95 |         
 96 |         `jar -xf #{@path}`
 97 |         @in_dir = files dir
 98 |         
 99 |         Dir.chdir current
100 |         dir.delete
101 |       end
102 |       @in_dir == @files
103 |     end
104 |     def failure_message
105 |       "in #{@path} expected files [#{@files.join(", ")}], but found [#{@in_dir.join(", ")}]"
106 |     end
107 |     def negative_failure_message
108 |       "in #{@path} doesn't expected files [#{@files.join(", ")}], but it does"
109 |     end
110 |   end
111 |   def contain_files(*files)
112 |     ContainFiles.new(files)
113 |   end
114 |   def create_files(dir, files)
115 |     files.each do |file|
116 |       file = File.join(dir, file)
117 |       FileUtils.makedirs File.dirname(file)
118 |       FileUtils.touch file
119 |     end
120 |   end
121 | end


--------------------------------------------------------------------------------
/spec/builder/before_spec.rb:
--------------------------------------------------------------------------------
  1 | require File.join(File.dirname(__FILE__), "spec_helper")
  2 | 
  3 | describe Ruby2Jar::Builder do
  4 |   before :each do
  5 |     @builder = Ruby2Jar::Builder.new
  6 |     @builder.path = "."
  7 |     @builder.include_jruby = false
  8 |     @builder.before_copy << lambda { @builder.stop }
  9 |   end
 10 |   
 11 |   it "should set result jar path automatically" do
 12 |     tmpdir = TempDir.create
 13 |     FileUtils.mkdir File.join(tmpdir, "my_project")
 14 |     FileUtils.touch File.join(tmpdir, "my_application.rb")
 15 |     
 16 |     @builder.path = File.join(tmpdir, "my_project")
 17 |     @builder.build
 18 |     
 19 |     @builder.jar.should == File.join(tmpdir, "my_project", "pkg", "my_project.jar")
 20 |     
 21 |     @builder.path = File.join(tmpdir, "my_application.rb")
 22 |     @builder.jar = nil
 23 |     @builder.build
 24 |     
 25 |     @builder.jar.should == File.join(tmpdir, "my_application.jar")
 26 |     
 27 |     tmpdir.delete
 28 |   end
 29 |   
 30 |   it "should raise error if path didn't set" do
 31 |     @builder.path = nil
 32 |     @builder.method(:build).should raise_error(Ruby2Jar::Error, /didn't set path/)
 33 |   end
 34 |   
 35 |   it "should raise error if path isn't exist" do
 36 |     nodir = TempDir.new
 37 |     
 38 |     @builder.path = nodir
 39 |     @builder.method(:build).should raise_error(Ruby2Jar::Error, /path is already exist/)
 40 |   end
 41 |   
 42 |   it "should raise error if result jar is already exist" do
 43 |     tmpdir = TempDir.create
 44 |     FileUtils.touch File.join(tmpdir, "result.jar")
 45 |     @builder.jar = File.join(tmpdir, "result.jar")
 46 |     
 47 |     @builder.method(:build).should raise_error(Ruby2Jar::Error, /jar/)
 48 |     
 49 |     tmpdir.delete
 50 |   end
 51 |   
 52 |   it "should raise error if main script isn't exist" do
 53 |     tmpdir = TempDir.create
 54 |     @builder.path = tmpdir
 55 |     @builder.main = "script.rb"
 56 |     
 57 |     @builder.method(:build).should raise_error(Ruby2Jar::Error, /Main script isn't exist/)
 58 |     
 59 |     FileUtils.touch File.join(tmpdir, "script.rb")
 60 |     @builder.method(:build).should_not raise_error(Ruby2Jar::Error)
 61 |     
 62 |     tmpdir.delete
 63 |   end
 64 |   
 65 |   it "should raise error if it can't find JRuby jar" do
 66 |     jruby = ENV['JRUBY_HOME']
 67 |     ENV['JRUBY_HOME'] = nil
 68 |     @builder.include_jruby = true
 69 |     
 70 |     @builder.method(:build).should raise_error(Ruby2Jar::Error, /Can't find JRuby/)
 71 |     
 72 |     ENV['JRUBY_HOME'] = jruby
 73 |   end
 74 |   
 75 |   it "should raise error if JRuby jar isn't exist" do
 76 |     @builder.include_jruby = true
 77 |     tmpdir = TempDir.new
 78 |     @builder.jruby = File.join(tmpdir, "jruby.jar")
 79 |     
 80 |     @builder.method(:build).should raise_error(Ruby2Jar::Error, /JRuby isn't exist/)
 81 |   end
 82 |   
 83 |   it "should find JRuby jar by JRUBY_HOME enviroment" do
 84 |     jruby = ENV['JRUBY_HOME']
 85 |     ENV['JRUBY_HOME'] = File.join(File.dirname(__FILE__), "fixtures", "jruby")
 86 |     @builder.include_jruby = true
 87 |     
 88 |     @builder.build
 89 |     @builder.jruby.should == File.join(ENV['JRUBY_HOME'], "lib", "jruby.jar")
 90 |     
 91 |     ENV['JRUBY_HOME'] = jruby
 92 |   end
 93 |   
 94 |   it "should create temporal dir on start and delete it on finish " do
 95 |     @build_dir = nil
 96 |     @builder.before_copy << lambda {
 97 |       @build_dir = @builder.build_dir
 98 |       @build_dir.should_not be_nil
 99 |       File.directory?(@build_dir).should be_true
100 |     }
101 |     
102 |     @builder.build
103 |     File.directory?(@build_dir).should be_false
104 |   end
105 | end
106 | 


--------------------------------------------------------------------------------
/spec/builder/copy_spec.rb:
--------------------------------------------------------------------------------
  1 | require File.join(File.dirname(__FILE__), "spec_helper")
  2 | 
  3 | describe Ruby2Jar::Builder do
  4 |   include DirHelper
  5 |   
  6 |   before :each do
  7 |     @builder = Ruby2Jar::Builder.new
  8 |     @builder.include_jruby = false
  9 |     @app_path = TempDir.create
 10 |     @builder.path = @app_path
 11 |     @builder.before_create_init << lambda { @builder.stop }
 12 |     @builder.gems_index = FakeGems.new
 13 |   end
 14 |   
 15 |   it "should copy all neccessary file from application dir" do
 16 |     create_files @builder.path, ["1.rb", "1.no", "subdir/2.rb", "subdir/3.rb"]
 17 |     Dir.chdir(@builder.path) do
 18 |       @builder.files = FileList["**/*"].exclude("*.no")
 19 |     end
 20 |     
 21 |     @builder.before_create_init << lambda {
 22 |       @builder.build_dir.should contain_files(
 23 |         "ruby/app/1.rb", "ruby/app/subdir/2.rb", "ruby/app/subdir/3.rb")
 24 |     }
 25 |     @builder.build
 26 |   end
 27 |   
 28 |   it "should copy file if application is a one script" do
 29 |     create_files @builder.path, "application.rb"
 30 |     @builder.path = File.join(@builder.path, "application.rb")
 31 |     
 32 |     @builder.before_create_init << lambda {
 33 |       @builder.build_dir.should contain_files("ruby/app/application.rb")
 34 |     }
 35 |     @builder.build
 36 |   end
 37 |   
 38 |   it "should copy all Java file to archive root" do
 39 |     create_files @builder.path, ["one.rb", "ext/subdir/pure.java"]
 40 |     
 41 |     @builder.before_create_init << lambda {
 42 |       @builder.build_dir.should contain_files("ruby/app/one.rb", "subdir/pure.java")
 43 |     }
 44 |     @builder.build
 45 |   end
 46 |   
 47 |   it "should delete java source file if compiled class file if already exist" do
 48 |     create_files @builder.path, ["one.rb", "ext/pure.java", "ext/pure.class"]
 49 |     
 50 |     @builder.before_create_init << lambda {
 51 |       @builder.build_dir.should contain_files("ruby/app/one.rb", "pure.class")
 52 |     }
 53 |     @builder.build
 54 |   end
 55 |   
 56 |   it "should raise error if gem isn't found" do
 57 |     @builder.gems_index.gems = {}
 58 |     @builder.add_dependency "gem"
 59 |     @builder.method(:build).should raise_error(Ruby2Jar::Error, /Can't find gem/)
 60 |   end
 61 |   
 62 |   it "should raise error if gem with different version is already added" do
 63 |     @builder.gems_index.gems = {
 64 |       "gem-1.0" => FakeSpecification.new("gem", "1.0", @builder.path),
 65 |       "gem-0.9" => FakeSpecification.new("gem", "0.9", @builder.path)}
 66 |     @builder.add_dependency "gem", "1.0"
 67 |     @builder.add_dependency "gem", "0.9"
 68 |     
 69 |     @builder.method(:build).should raise_error(Ruby2Jar::Error, /different version/)
 70 |   end
 71 |   
 72 |   it "should copy gem dependencies too" do
 73 |     
 74 |     @builder.gems_index.gems = {
 75 |       "one-" => FakeSpecification.new("one", "", @builder.path, ["two"]), 
 76 |       "two-" => FakeSpecification.new("two", "", @builder.path, ["one"])}
 77 |     @builder.add_dependency "one"
 78 |     
 79 |     @builder.before_create_init << lambda {
 80 |       @builder.loaded_gems.should == ["one", "two"]
 81 |     }
 82 |     @builder.build
 83 |   end
 84 |   
 85 |   it "should load java config from gem" do
 86 |     gem_path = TempDir.create
 87 |     File.open(File.join(gem_path, "java.yaml"), "w") do |file|
 88 |       file.write({"name" => "value"}.to_yaml)
 89 |     end
 90 |     @builder.gems_index.gems = {
 91 |       "gem-" => FakeSpecification.new("gem", "", gem_path)}
 92 |     @builder.add_dependency "gem"
 93 |     
 94 |     @builder.before_create_init << lambda {
 95 |       @builder.configs["gem"].should == {"name" => "value"}
 96 |     }
 97 |     @builder.build
 98 |     
 99 |     gem_path.delete
100 |   end
101 |   
102 |   it "should copy all neccessary file from gem dir" do
103 |     gem_path = TempDir.create
104 |     create_files gem_path, ["one.rb", "1.no", "subdir/two.rb", "ext/pure.java"]
105 |     File.open(File.join(gem_path, "java.yaml"), "w") do |file|
106 |       file.write({"jar" => {"exclude" => "*.no"}}.to_yaml)
107 |     end
108 |     @builder.gems_index.gems = {
109 |       "gem-" => FakeSpecification.new("gem", "", gem_path)}
110 |     @builder.add_dependency "gem"
111 |     
112 |     @builder.before_create_init << lambda {
113 |       @builder.build_dir.should contain_files(
114 |         "ruby/gems/gem/one.rb", "ruby/gems/gem/subdir/two.rb", "pure.java")
115 |     }
116 |     @builder.build
117 |     
118 |     gem_path.delete
119 |   end
120 |   
121 |   it "should add gem and app paths to init_require_paths" do
122 |     @builder.gems_index.gems = {
123 |       "gem-" => FakeSpecification.new("gem", "", @builder.path)}
124 |     @builder.add_dependency "gem"
125 |     @builder.require_paths = ["one", "two"]
126 |     
127 |     @builder.before_create_init << lambda {
128 |       @builder.init_require_paths.should include("ruby/gems/gem/lib")
129 |       @builder.init_require_paths.should include("ruby/app/one")
130 |       @builder.init_require_paths.should include("ruby/app/two")
131 |     }
132 |     @builder.build
133 |   end
134 |   
135 |   after :each do
136 |     @app_path.delete
137 |   end
138 | end


--------------------------------------------------------------------------------
/lib/ruby2jar/builder.rb:
--------------------------------------------------------------------------------
  1 | =begin
  2 | Build JAR from Ruby script.
  3 | 
  4 | Copyright (C) 2008 Andrey "A.I." Sitnik <andrey@sitnik.ru>
  5 | 
  6 | This program is free software: you can redistribute it and/or modify
  7 | it under the terms of the GNU General Public License as published by
  8 | the Free Software Foundation, either version 3 of the License, or
  9 | (at your option) any later version.
 10 | 
 11 | This program is distributed in the hope that it will be useful,
 12 | but WITHOUT ANY WARRANTY; without even the implied warranty of
 13 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 14 | GNU General Public License for more details.
 15 | 
 16 | You should have received a copy of the GNU General Public License
 17 | along with this program.  If not, see <http://www.gnu.org/licenses/>.
 18 | =end
 19 | 
 20 | require "tmpdir"
 21 | require "tempfile"
 22 | require "yaml"
 23 | require "fileutils"
 24 | 
 25 | require "rubygems"
 26 | require "rake"
 27 | 
 28 | module Ruby2Jar
 29 |   # Ruby2Jar builds JAR from a Ruby script. It copies gems, compiles sources 
 30 |   # and packages JAR. It is an easy way to distribute your JRuby application or 
 31 |   # create Applet or Java Web Start.
 32 |   # 
 33 |   # == Examples
 34 |   # === Build from Rake task (best production way)
 35 |   # 
 36 |   #   require "rubygems"
 37 |   #   require "ruby2jar"
 38 |   #   
 39 |   #   PKG_NAME = "program"
 40 |   #   PKG_VERSION = "0.1"
 41 |   #   
 42 |   #   Ruby2Jar::Rake::JarTask.new do |jar|
 43 |   #     jar.files = FileList["lib/**/*", "bin/*"]
 44 |   #     jar.main = "bin/program"
 45 |   #     jar.name = PKG_NAME
 46 |   #     jar.version = PKG_VERSION
 47 |   #     jar.add_dependency "rspec"
 48 |   #   end
 49 |   # 
 50 |   # === Build with console output
 51 |   # 
 52 |   #   require "rubygems"
 53 |   #   require "ruby2jar"
 54 |   #   
 55 |   #   builder = Ruby2Jar::Builder.new
 56 |   #   console = Ruby2Jar::Console.new(builder)    # Add console error output
 57 |   #   builder.path = "/path/to/ruby/program/"     # Set program to build
 58 |   #   builder.files = Rake::FileList["/lib/**/*"] # Select files
 59 |   #   builder.add_dependency "actionsupport"      # Add gems
 60 |   #   builder.add_dependency "rspec", ">=1.0.0"   # Add gem with special version
 61 |   #   builde.build                                # Start building
 62 |   # 
 63 |   # == Extension
 64 |   # You can add some action in building work. For example, to show warning
 65 |   # dialogs or to create special manifest file. Just add new Proc or Method
 66 |   # object to "before_*" arrays with neccessary building step.
 67 |   # 
 68 |   # You can also extend Ruby2Jar::Listener to create extension, which
 69 |   # automatically connect all function to builder. 
 70 |   # 
 71 |   # === Example
 72 |   #   
 73 |   #   require "rubygems"
 74 |   #   require "ruby2jar"
 75 |   #   
 76 |   #   builder = Ruby2Jar::Builder.new
 77 |   #   builder.path = "/path/to/ruby/program/"
 78 |   #   builder.add_dependency "rspec"
 79 |   #   
 80 |   #   builder.before_start  << lambda {        # Add function, which will be
 81 |   #     puts "Jar building is start"           # call before builder start and
 82 |   #   }                                        # set system variables
 83 |   #   
 84 |   #   builder.before_finish << lambda {        # Function, which will be call
 85 |   #     puts "Jar building is finish"          # before builder finish it work  
 86 |   #   }                                        # and delete temporal files
 87 |   # 
 88 |   class Builder
 89 |     # Script or directory to build JAR
 90 |     attr_accessor :path
 91 |     
 92 |     # List of files to be included in the JAR.
 93 |     attr_accessor :files
 94 |     
 95 |     # Path to main script, which will be run whtn you execute JAR.
 96 |     # If in +path+ you set file, main script will be equal +path+.
 97 |     attr_accessor :main
 98 |     
 99 |     # Does builder must create Manifest file in JAR with +main+ script, which
100 |     # will be start on JAR executing (default if true).
101 |     attr_accessor :create_manifest
102 |     
103 |     # Custom content of Manifest file in JAR as hash. If parameters will be not
104 |     # set, builder add Manifest-Version and Main-Class if +main+ exist.
105 |     attr_accessor :manifest
106 |     
107 |     # Path to result JAR (default is +path+/pkg/{last dirname in +path+}.jar).
108 |     attr_accessor :jar
109 |     
110 |     # Does builder must copy JRuby to JAR (default if true). With JRuby 
111 |     # resulting JAR can be started on any Java Runtime, but file will be has 
112 |     # bigger size.
113 |     attr_accessor :include_jruby
114 |     
115 |     # Path to JRuby JAR (default is $JRUBY_HOME/lib/jruby/jar). Used only 
116 |     # if +include_jruby+ is true.
117 |     attr_accessor :jruby
118 |     
119 |     # Arguments for Java compiler
120 |     attr_accessor :javac_args
121 |     
122 |     # Path in script, which will be added to <tt>$LOAD_PATH</tt> in init script
123 |     # (default is root and lib dir of application)
124 |     attr_accessor :require_paths
125 |     
126 |     # Create builder instance
127 |     def initialize
128 |       @path = Dir.pwd
129 |       @create_manifest = false
130 |       @manifest = {"Manifest-Version" => "1.0"}
131 |       @include_jruby = true
132 |       @target = "1.6"
133 |       @require_paths = ["lib", ""]
134 |       @javac_args = ""
135 |       @gems_index = Gem.source_index
136 |       
137 |       @before_start = []
138 |       @before_find_gems = []
139 |       @before_copy = []
140 |       @before_create_init = []
141 |       @before_compile = []
142 |       @before_package = []
143 |       @before_finish = []
144 |       @on_error = []
145 |       
146 |       @gems = []
147 |       @configs = {}
148 |     end
149 |     
150 |     # Add a dependency gem
151 |     def add_dependency(gem, *requirements)
152 |       @gems << [gem, requirements]
153 |     end
154 |     
155 |     # Start building JAR. You must set +path+ before call it.
156 |     def build
157 |       @stop = false
158 |       %w{start copy create_init compile package}.each do |step|
159 |         method("before_#{step}").call.each do |proc|
160 |           proc.call
161 |         end
162 |         if @stop
163 |           break
164 |         end
165 |         method(step).call
166 |       end
167 |     rescue => error
168 |       @error_rescued = false
169 |       on_error.each do |proc|
170 |         @error_rescued |= proc.call error
171 |       end
172 |       if not @error_rescued
173 |         raise error
174 |       end
175 |     ensure
176 |       begin
177 |         before_finish.each do |proc|
178 |           proc.call
179 |         end
180 |       ensure
181 |         finish
182 |       end
183 |     end
184 |     
185 |     attr_accessor :before_start
186 |     attr_accessor :before_copy
187 |     attr_accessor :before_create_init
188 |     attr_accessor :before_compile
189 |     attr_accessor :before_package
190 |     attr_accessor :before_finish
191 |     attr_accessor :on_error
192 |     
193 |     # Path to work dir, which be used to copy all neccessary files.
194 |     # It will be set automatically and has public access only for extensions.
195 |     attr_accessor :build_dir
196 |     
197 |     # Gems, which using in program. Use +add_dependency+ to add gem.
198 |     attr_accessor :gems
199 |     
200 |     # Gem's configs with building information, which was loaded from 
201 |     # <tt>GEM_DIR/java.yaml</tt>. It will has information after +copy+ step.
202 |     attr_accessor :configs
203 |     
204 |     # Paths to add to <tt>$LOAD_PATH</tt> in init script
205 |     attr_accessor :init_require_paths
206 |     
207 |     # Gem's source index. It available as variable for testing and hacking.
208 |     attr_accessor :gems_index
209 |     
210 |     # Gems, which is added to JAR. Contain @gems and they dependencies.
211 |     attr_accessor :loaded_gems
212 |     
213 |     # Stop JAR building and delete temporal files. Must be runned from extension
214 |     # on error or when building is not necessary yet.
215 |     def stop
216 |       @stop = true
217 |     end
218 |     
219 |     protected
220 |     
221 |     # Check for errors and create temporal directory
222 |     def start
223 |       raise Error, "You didn't set path to source dir or file." if @path.nil?
224 |       raise Error, "Source path is already exist." if not File.exist? @path
225 |       
226 |       @path = File.expand_path(@path)
227 |       if File.directory? @path
228 |         Dir.chdir(@path) do
229 |           @files = Rake::FileList["**/*"] if @files.nil?
230 |           @files.map! { |i| File.expand_path(i) }
231 |         end
232 |       end
233 |       if @jar.nil?
234 |         if File.directory? @path
235 |           @jar = File.join(@path, "pkg", "#{@path.split('/').last}.jar")
236 |         else
237 |           @jar = File.join(File.dirname(@path), 
238 |             "#{File.basename(@path, File.extname(@path))}.jar")
239 |         end
240 |       end
241 |       @jar = File.expand_path(@jar)
242 |       
243 |       if File.exist? @jar
244 |         raise Error, "File #{@jar} already exist. Delete it or change jar name"
245 |       end
246 |       
247 |       if not @main.nil?
248 |         @create_manifest = true
249 |         path = File.join(@path, @main)
250 |         if not File.exist? path
251 |           raise Error, "Main script isn't exist in #{path}."
252 |         end
253 |       end
254 |       if @main.nil? and not File.directory? @path
255 |         @main = File.basename(@path)
256 |       end
257 |       
258 |       if @include_jruby
259 |         if @jruby.nil?
260 |           if ENV['JRUBY_HOME'].nil?
261 |             raise Error,  "Can't find JRuby, please set it manually."
262 |           else
263 |             @jruby = File.join(ENV['JRUBY_HOME'], "lib", "jruby.jar")
264 |           end
265 |         end
266 |         if not File.exist? @jruby
267 |           raise Error,  "JRuby isn't exist in #{@jruby}."
268 |         end
269 |       end
270 |       
271 |       number = Time.now.to_i
272 |       begin
273 |         number += 1
274 |         @build_dir = File.join(Dir.tmpdir, "ruby2jar#{number}")
275 |       end while File.exist? @build_dir
276 |       @app_dir = File.join(@build_dir, "ruby", "app")
277 |       @gems_dir = File.join(@build_dir, "ruby", "gems")
278 |       
279 |       @init_require_paths = @require_paths.map { |i| "ruby/app/#{i}"}
280 |       
281 |       Dir.mkdir @build_dir
282 |       File.chmod 0700, @build_dir
283 |       Dir.mkdir File.join(@build_dir, "ruby")
284 |       Dir.mkdir @app_dir
285 |       Dir.mkdir @gems_dir
286 |       
287 |       # Change current dir
288 |       @last_current_dir = Dir.pwd
289 |       Dir.chdir @build_dir
290 |     end
291 |     
292 |     # Copy application, gems and JRuby
293 |     def copy
294 |       if File.directory? @path
295 |         @files.each do |src|
296 |           dest = File.join(@app_dir, src[@path.length..-1])
297 |           if File.directory? src
298 |             FileUtils.mkdir_p(dest)
299 |           else
300 |             FileUtils.mkdir_p(File.dirname(dest))
301 |             FileUtils.copy src, dest
302 |           end
303 |         end
304 |       else
305 |         FileUtils.copy @path, @app_dir
306 |       end
307 |       
308 |       @loaded_gem_versions = []
309 |       @loaded_gems = []
310 |       @gems.each { |gem| copy_gem(gem[0], gem[1]) }
311 |       
312 |       ([@app_dir] + Dir.glob(File.join(@gems_dir, "*"))).each do |dir|
313 |         ext = File.join(dir, "ext")
314 |         Dir.glob(File.join(ext, "**", "*.{java,class}")).each do |file|
315 |           if ".java" == File.extname(file)
316 |             if File.exist? file[0..-6] + ".class"
317 |               File.delete file
318 |               next
319 |             end
320 |           end
321 |           dest = File.join(@build_dir, file[ext.length..-1])
322 |           FileUtils.makedirs File.dirname(dest)
323 |           FileUtils.move file, dest
324 |         end
325 |       end
326 |     end
327 |     
328 |     # Find gems and copy it and it's dependencies
329 |     def copy_gem(gem, version = nil)
330 |       specs = @gems_index.find_name(gem, version)
331 |       if specs.empty?
332 |         raise Error, "Can't find gem #{gem}"
333 |       end
334 |       spec = specs.first
335 |       
336 |       if @loaded_gem_versions.include? spec.full_name
337 |         return
338 |       end
339 |       if @loaded_gems.include? gem
340 |         raise Error, "Gem #{spec.name} is already added with different version"
341 |       end
342 |       
343 |       gem_dir = File.join(@gems_dir, gem)
344 |       FileUtils.cp_r File.join(spec.full_gem_path, "."), gem_dir
345 |       
346 |       config = File.join(@gems_dir, gem, "java.yaml")
347 |       if File.exist? config
348 |         @configs[gem] = YAML::load_file(config)
349 |         File.delete config
350 |         jar = @configs[gem]['jar']
351 |         if not jar.nil? and not jar['exclude'].nil?
352 |           jar['exclude'].map { |i| File.join(gem_dir, i) }.each do |files|
353 |             FileUtils.rm Dir.glob(files)
354 |           end
355 |         end
356 |       end
357 |       
358 |       @loaded_gem_versions << spec.full_name
359 |       @loaded_gems << gem
360 |       @init_require_paths += spec.require_paths.map{|i| "ruby/gems/#{gem}/#{i}"}
361 |       
362 |       spec.dependencies.each { |i| copy_gem(i) }
363 |     end
364 |     
365 |     # Create init script to set rubygems variables and start main script
366 |     def create_init
367 |       return if @main.nil?
368 |       
369 |       File.open(File.join(@build_dir, "ruby", "init.rb"), "w") do |file|
370 |         file.puts "module Kernel"
371 |         file.puts "  def gem(name, *version); end"
372 |         file.puts "  alias ruby2jar_original_require require"
373 |         file.puts "  def require(file)"
374 |         file.puts "    ruby2jar_original_require(file)"
375 |         file.puts "  rescue LoadError => error"
376 |         file.puts "    raise error if not error.message.include? 'no such file to load'"
377 |         file.puts "    $LOAD_PATH.each do |path|"
378 |         file.puts "      begin"
379 |         file.puts "        ruby2jar_original_require(File.join(path, file))"
380 |         file.puts "        return"
381 |         file.puts "      rescue LoadError => error"
382 |         file.puts "        raise error if not error.message.include? 'no such file to load'"
383 |         file.puts "      end"
384 |         file.puts "    end"
385 |         file.puts "  end"
386 |         file.puts "end"
387 |         @init_require_paths.each do |path|
388 |           file.puts '$LOAD_PATH << "' + path + '"'
389 |         end
390 |         file.puts 'require "ruby/app/' + @main.sub(/\.rb$/, '') + '"'
391 |       end
392 |       @manifest["Main-Class"] = "ruby.init" if not @manifest.include? "Main-Class"
393 |     end
394 |     
395 |     # Compile Ruby and Java sources
396 |     def compile
397 |       `jrubyc -p "" ./`
398 |       
399 |       Dir.glob(File.join(@build_dir, "**", "*.java")).each do |file|
400 |         `javac #{@javac_args} -sourcepath ./ "#{file}"`
401 |       end
402 |       
403 |       Dir.glob(File.join(@build_dir, "**", "*.{rb,java}")).each do |file|
404 |         File.delete file
405 |       end
406 |     end
407 |     
408 |     # Package files in one JAR
409 |     def package
410 |       if @include_jruby
411 |         `jar -xf "#{@jruby}"`
412 |       end
413 |       
414 |       FileUtils.makedirs File.dirname(@jar)
415 |       
416 |       if @create_manifest
417 |         @manifest_file = Tempfile.new("ruby2jar_manifest")
418 |         @manifest.each_pair do |name, value|
419 |           @manifest_file.puts "#{name}: #{value}"
420 |         end
421 |         @manifest_file.close(false)
422 |         
423 |         `jar -cvfm "#{@jar}" "#{@manifest_file.path}" ./`
424 |       else
425 |         `jar -cf "#{@jar}" ./`
426 |       end
427 |     end
428 |     
429 |     # Delete all temporal files
430 |     def finish
431 |       if not @last_current_dir.nil?
432 |         Dir.chdir @last_current_dir
433 |       end
434 |       if not @build_dir.nil?
435 |         FileUtils.rm_r @build_dir
436 |       end
437 |     end
438 |   end
439 | end


--------------------------------------------------------------------------------
/LICENSE:
--------------------------------------------------------------------------------
  1 |                     GNU GENERAL PUBLIC LICENSE
  2 |                        Version 3, 29 June 2007
  3 | 
  4 |  Copyright (C) 2007 Free Software Foundation, Inc. <http://fsf.org/>
  5 |  Everyone is permitted to copy and distribute verbatim copies
  6 |  of this license document, but changing it is not allowed.
  7 | 
  8 |                             Preamble
  9 | 
 10 |   The GNU General Public License is a free, copyleft license for
 11 | software and other kinds of works.
 12 | 
 13 |   The licenses for most software and other practical works are designed
 14 | to take away your freedom to share and change the works.  By contrast,
 15 | the GNU General Public License is intended to guarantee your freedom to
 16 | share and change all versions of a program--to make sure it remains free
 17 | software for all its users.  We, the Free Software Foundation, use the
 18 | GNU General Public License for most of our software; it applies also to
 19 | any other work released this way by its authors.  You can apply it to
 20 | your programs, too.
 21 | 
 22 |   When we speak of free software, we are referring to freedom, not
 23 | price.  Our General Public Licenses are designed to make sure that you
 24 | have the freedom to distribute copies of free software (and charge for
 25 | them if you wish), that you receive source code or can get it if you
 26 | want it, that you can change the software or use pieces of it in new
 27 | free programs, and that you know you can do these things.
 28 | 
 29 |   To protect your rights, we need to prevent others from denying you
 30 | these rights or asking you to surrender the rights.  Therefore, you have
 31 | certain responsibilities if you distribute copies of the software, or if
 32 | you modify it: responsibilities to respect the freedom of others.
 33 | 
 34 |   For example, if you distribute copies of such a program, whether
 35 | gratis or for a fee, you must pass on to the recipients the same
 36 | freedoms that you received.  You must make sure that they, too, receive
 37 | or can get the source code.  And you must show them these terms so they
 38 | know their rights.
 39 | 
 40 |   Developers that use the GNU GPL protect your rights with two steps:
 41 | (1) assert copyright on the software, and (2) offer you this License
 42 | giving you legal permission to copy, distribute and/or modify it.
 43 | 
 44 |   For the developers' and authors' protection, the GPL clearly explains
 45 | that there is no warranty for this free software.  For both users' and
 46 | authors' sake, the GPL requires that modified versions be marked as
 47 | changed, so that their problems will not be attributed erroneously to
 48 | authors of previous versions.
 49 | 
 50 |   Some devices are designed to deny users access to install or run
 51 | modified versions of the software inside them, although the manufacturer
 52 | can do so.  This is fundamentally incompatible with the aim of
 53 | protecting users' freedom to change the software.  The systematic
 54 | pattern of such abuse occurs in the area of products for individuals to
 55 | use, which is precisely where it is most unacceptable.  Therefore, we
 56 | have designed this version of the GPL to prohibit the practice for those
 57 | products.  If such problems arise substantially in other domains, we
 58 | stand ready to extend this provision to those domains in future versions
 59 | of the GPL, as needed to protect the freedom of users.
 60 | 
 61 |   Finally, every program is threatened constantly by software patents.
 62 | States should not allow patents to restrict development and use of
 63 | software on general-purpose computers, but in those that do, we wish to
 64 | avoid the special danger that patents applied to a free program could
 65 | make it effectively proprietary.  To prevent this, the GPL assures that
 66 | patents cannot be used to render the program non-free.
 67 | 
 68 |   The precise terms and conditions for copying, distribution and
 69 | modification follow.
 70 | 
 71 |                        TERMS AND CONDITIONS
 72 | 
 73 |   0. Definitions.
 74 | 
 75 |   "This License" refers to version 3 of the GNU General Public License.
 76 | 
 77 |   "Copyright" also means copyright-like laws that apply to other kinds of
 78 | works, such as semiconductor masks.
 79 | 
 80 |   "The Program" refers to any copyrightable work licensed under this
 81 | License.  Each licensee is addressed as "you".  "Licensees" and
 82 | "recipients" may be individuals or organizations.
 83 | 
 84 |   To "modify" a work means to copy from or adapt all or part of the work
 85 | in a fashion requiring copyright permission, other than the making of an
 86 | exact copy.  The resulting work is called a "modified version" of the
 87 | earlier work or a work "based on" the earlier work.
 88 | 
 89 |   A "covered work" means either the unmodified Program or a work based
 90 | on the Program.
 91 | 
 92 |   To "propagate" a work means to do anything with it that, without
 93 | permission, would make you directly or secondarily liable for
 94 | infringement under applicable copyright law, except executing it on a
 95 | computer or modifying a private copy.  Propagation includes copying,
 96 | distribution (with or without modification), making available to the
 97 | public, and in some countries other activities as well.
 98 | 
 99 |   To "convey" a work means any kind of propagation that enables other
100 | parties to make or receive copies.  Mere interaction with a user through
101 | a computer network, with no transfer of a copy, is not conveying.
102 | 
103 |   An interactive user interface displays "Appropriate Legal Notices"
104 | to the extent that it includes a convenient and prominently visible
105 | feature that (1) displays an appropriate copyright notice, and (2)
106 | tells the user that there is no warranty for the work (except to the
107 | extent that warranties are provided), that licensees may convey the
108 | work under this License, and how to view a copy of this License.  If
109 | the interface presents a list of user commands or options, such as a
110 | menu, a prominent item in the list meets this criterion.
111 | 
112 |   1. Source Code.
113 | 
114 |   The "source code" for a work means the preferred form of the work
115 | for making modifications to it.  "Object code" means any non-source
116 | form of a work.
117 | 
118 |   A "Standard Interface" means an interface that either is an official
119 | standard defined by a recognized standards body, or, in the case of
120 | interfaces specified for a particular programming language, one that
121 | is widely used among developers working in that language.
122 | 
123 |   The "System Libraries" of an executable work include anything, other
124 | than the work as a whole, that (a) is included in the normal form of
125 | packaging a Major Component, but which is not part of that Major
126 | Component, and (b) serves only to enable use of the work with that
127 | Major Component, or to implement a Standard Interface for which an
128 | implementation is available to the public in source code form.  A
129 | "Major Component", in this context, means a major essential component
130 | (kernel, window system, and so on) of the specific operating system
131 | (if any) on which the executable work runs, or a compiler used to
132 | produce the work, or an object code interpreter used to run it.
133 | 
134 |   The "Corresponding Source" for a work in object code form means all
135 | the source code needed to generate, install, and (for an executable
136 | work) run the object code and to modify the work, including scripts to
137 | control those activities.  However, it does not include the work's
138 | System Libraries, or general-purpose tools or generally available free
139 | programs which are used unmodified in performing those activities but
140 | which are not part of the work.  For example, Corresponding Source
141 | includes interface definition files associated with source files for
142 | the work, and the source code for shared libraries and dynamically
143 | linked subprograms that the work is specifically designed to require,
144 | such as by intimate data communication or control flow between those
145 | subprograms and other parts of the work.
146 | 
147 |   The Corresponding Source need not include anything that users
148 | can regenerate automatically from other parts of the Corresponding
149 | Source.
150 | 
151 |   The Corresponding Source for a work in source code form is that
152 | same work.
153 | 
154 |   2. Basic Permissions.
155 | 
156 |   All rights granted under this License are granted for the term of
157 | copyright on the Program, and are irrevocable provided the stated
158 | conditions are met.  This License explicitly affirms your unlimited
159 | permission to run the unmodified Program.  The output from running a
160 | covered work is covered by this License only if the output, given its
161 | content, constitutes a covered work.  This License acknowledges your
162 | rights of fair use or other equivalent, as provided by copyright law.
163 | 
164 |   You may make, run and propagate covered works that you do not
165 | convey, without conditions so long as your license otherwise remains
166 | in force.  You may convey covered works to others for the sole purpose
167 | of having them make modifications exclusively for you, or provide you
168 | with facilities for running those works, provided that you comply with
169 | the terms of this License in conveying all material for which you do
170 | not control copyright.  Those thus making or running the covered works
171 | for you must do so exclusively on your behalf, under your direction
172 | and control, on terms that prohibit them from making any copies of
173 | your copyrighted material outside their relationship with you.
174 | 
175 |   Conveying under any other circumstances is permitted solely under
176 | the conditions stated below.  Sublicensing is not allowed; section 10
177 | makes it unnecessary.
178 | 
179 |   3. Protecting Users' Legal Rights From Anti-Circumvention Law.
180 | 
181 |   No covered work shall be deemed part of an effective technological
182 | measure under any applicable law fulfilling obligations under article
183 | 11 of the WIPO copyright treaty adopted on 20 December 1996, or
184 | similar laws prohibiting or restricting circumvention of such
185 | measures.
186 | 
187 |   When you convey a covered work, you waive any legal power to forbid
188 | circumvention of technological measures to the extent such circumvention
189 | is effected by exercising rights under this License with respect to
190 | the covered work, and you disclaim any intention to limit operation or
191 | modification of the work as a means of enforcing, against the work's
192 | users, your or third parties' legal rights to forbid circumvention of
193 | technological measures.
194 | 
195 |   4. Conveying Verbatim Copies.
196 | 
197 |   You may convey verbatim copies of the Program's source code as you
198 | receive it, in any medium, provided that you conspicuously and
199 | appropriately publish on each copy an appropriate copyright notice;
200 | keep intact all notices stating that this License and any
201 | non-permissive terms added in accord with section 7 apply to the code;
202 | keep intact all notices of the absence of any warranty; and give all
203 | recipients a copy of this License along with the Program.
204 | 
205 |   You may charge any price or no price for each copy that you convey,
206 | and you may offer support or warranty protection for a fee.
207 | 
208 |   5. Conveying Modified Source Versions.
209 | 
210 |   You may convey a work based on the Program, or the modifications to
211 | produce it from the Program, in the form of source code under the
212 | terms of section 4, provided that you also meet all of these conditions:
213 | 
214 |     a) The work must carry prominent notices stating that you modified
215 |     it, and giving a relevant date.
216 | 
217 |     b) The work must carry prominent notices stating that it is
218 |     released under this License and any conditions added under section
219 |     7.  This requirement modifies the requirement in section 4 to
220 |     "keep intact all notices".
221 | 
222 |     c) You must license the entire work, as a whole, under this
223 |     License to anyone who comes into possession of a copy.  This
224 |     License will therefore apply, along with any applicable section 7
225 |     additional terms, to the whole of the work, and all its parts,
226 |     regardless of how they are packaged.  This License gives no
227 |     permission to license the work in any other way, but it does not
228 |     invalidate such permission if you have separately received it.
229 | 
230 |     d) If the work has interactive user interfaces, each must display
231 |     Appropriate Legal Notices; however, if the Program has interactive
232 |     interfaces that do not display Appropriate Legal Notices, your
233 |     work need not make them do so.
234 | 
235 |   A compilation of a covered work with other separate and independent
236 | works, which are not by their nature extensions of the covered work,
237 | and which are not combined with it such as to form a larger program,
238 | in or on a volume of a storage or distribution medium, is called an
239 | "aggregate" if the compilation and its resulting copyright are not
240 | used to limit the access or legal rights of the compilation's users
241 | beyond what the individual works permit.  Inclusion of a covered work
242 | in an aggregate does not cause this License to apply to the other
243 | parts of the aggregate.
244 | 
245 |   6. Conveying Non-Source Forms.
246 | 
247 |   You may convey a covered work in object code form under the terms
248 | of sections 4 and 5, provided that you also convey the
249 | machine-readable Corresponding Source under the terms of this License,
250 | in one of these ways:
251 | 
252 |     a) Convey the object code in, or embodied in, a physical product
253 |     (including a physical distribution medium), accompanied by the
254 |     Corresponding Source fixed on a durable physical medium
255 |     customarily used for software interchange.
256 | 
257 |     b) Convey the object code in, or embodied in, a physical product
258 |     (including a physical distribution medium), accompanied by a
259 |     written offer, valid for at least three years and valid for as
260 |     long as you offer spare parts or customer support for that product
261 |     model, to give anyone who possesses the object code either (1) a
262 |     copy of the Corresponding Source for all the software in the
263 |     product that is covered by this License, on a durable physical
264 |     medium customarily used for software interchange, for a price no
265 |     more than your reasonable cost of physically performing this
266 |     conveying of source, or (2) access to copy the
267 |     Corresponding Source from a network server at no charge.
268 | 
269 |     c) Convey individual copies of the object code with a copy of the
270 |     written offer to provide the Corresponding Source.  This
271 |     alternative is allowed only occasionally and noncommercially, and
272 |     only if you received the object code with such an offer, in accord
273 |     with subsection 6b.
274 | 
275 |     d) Convey the object code by offering access from a designated
276 |     place (gratis or for a charge), and offer equivalent access to the
277 |     Corresponding Source in the same way through the same place at no
278 |     further charge.  You need not require recipients to copy the
279 |     Corresponding Source along with the object code.  If the place to
280 |     copy the object code is a network server, the Corresponding Source
281 |     may be on a different server (operated by you or a third party)
282 |     that supports equivalent copying facilities, provided you maintain
283 |     clear directions next to the object code saying where to find the
284 |     Corresponding Source.  Regardless of what server hosts the
285 |     Corresponding Source, you remain obligated to ensure that it is
286 |     available for as long as needed to satisfy these requirements.
287 | 
288 |     e) Convey the object code using peer-to-peer transmission, provided
289 |     you inform other peers where the object code and Corresponding
290 |     Source of the work are being offered to the general public at no
291 |     charge under subsection 6d.
292 | 
293 |   A separable portion of the object code, whose source code is excluded
294 | from the Corresponding Source as a System Library, need not be
295 | included in conveying the object code work.
296 | 
297 |   A "User Product" is either (1) a "consumer product", which means any
298 | tangible personal property which is normally used for personal, family,
299 | or household purposes, or (2) anything designed or sold for incorporation
300 | into a dwelling.  In determining whether a product is a consumer product,
301 | doubtful cases shall be resolved in favor of coverage.  For a particular
302 | product received by a particular user, "normally used" refers to a
303 | typical or common use of that class of product, regardless of the status
304 | of the particular user or of the way in which the particular user
305 | actually uses, or expects or is expected to use, the product.  A product
306 | is a consumer product regardless of whether the product has substantial
307 | commercial, industrial or non-consumer uses, unless such uses represent
308 | the only significant mode of use of the product.
309 | 
310 |   "Installation Information" for a User Product means any methods,
311 | procedures, authorization keys, or other information required to install
312 | and execute modified versions of a covered work in that User Product from
313 | a modified version of its Corresponding Source.  The information must
314 | suffice to ensure that the continued functioning of the modified object
315 | code is in no case prevented or interfered with solely because
316 | modification has been made.
317 | 
318 |   If you convey an object code work under this section in, or with, or
319 | specifically for use in, a User Product, and the conveying occurs as
320 | part of a transaction in which the right of possession and use of the
321 | User Product is transferred to the recipient in perpetuity or for a
322 | fixed term (regardless of how the transaction is characterized), the
323 | Corresponding Source conveyed under this section must be accompanied
324 | by the Installation Information.  But this requirement does not apply
325 | if neither you nor any third party retains the ability to install
326 | modified object code on the User Product (for example, the work has
327 | been installed in ROM).
328 | 
329 |   The requirement to provide Installation Information does not include a
330 | requirement to continue to provide support service, warranty, or updates
331 | for a work that has been modified or installed by the recipient, or for
332 | the User Product in which it has been modified or installed.  Access to a
333 | network may be denied when the modification itself materially and
334 | adversely affects the operation of the network or violates the rules and
335 | protocols for communication across the network.
336 | 
337 |   Corresponding Source conveyed, and Installation Information provided,
338 | in accord with this section must be in a format that is publicly
339 | documented (and with an implementation available to the public in
340 | source code form), and must require no special password or key for
341 | unpacking, reading or copying.
342 | 
343 |   7. Additional Terms.
344 | 
345 |   "Additional permissions" are terms that supplement the terms of this
346 | License by making exceptions from one or more of its conditions.
347 | Additional permissions that are applicable to the entire Program shall
348 | be treated as though they were included in this License, to the extent
349 | that they are valid under applicable law.  If additional permissions
350 | apply only to part of the Program, that part may be used separately
351 | under those permissions, but the entire Program remains governed by
352 | this License without regard to the additional permissions.
353 | 
354 |   When you convey a copy of a covered work, you may at your option
355 | remove any additional permissions from that copy, or from any part of
356 | it.  (Additional permissions may be written to require their own
357 | removal in certain cases when you modify the work.)  You may place
358 | additional permissions on material, added by you to a covered work,
359 | for which you have or can give appropriate copyright permission.
360 | 
361 |   Notwithstanding any other provision of this License, for material you
362 | add to a covered work, you may (if authorized by the copyright holders of
363 | that material) supplement the terms of this License with terms:
364 | 
365 |     a) Disclaiming warranty or limiting liability differently from the
366 |     terms of sections 15 and 16 of this License; or
367 | 
368 |     b) Requiring preservation of specified reasonable legal notices or
369 |     author attributions in that material or in the Appropriate Legal
370 |     Notices displayed by works containing it; or
371 | 
372 |     c) Prohibiting misrepresentation of the origin of that material, or
373 |     requiring that modified versions of such material be marked in
374 |     reasonable ways as different from the original version; or
375 | 
376 |     d) Limiting the use for publicity purposes of names of licensors or
377 |     authors of the material; or
378 | 
379 |     e) Declining to grant rights under trademark law for use of some
380 |     trade names, trademarks, or service marks; or
381 | 
382 |     f) Requiring indemnification of licensors and authors of that
383 |     material by anyone who conveys the material (or modified versions of
384 |     it) with contractual assumptions of liability to the recipient, for
385 |     any liability that these contractual assumptions directly impose on
386 |     those licensors and authors.
387 | 
388 |   All other non-permissive additional terms are considered "further
389 | restrictions" within the meaning of section 10.  If the Program as you
390 | received it, or any part of it, contains a notice stating that it is
391 | governed by this License along with a term that is a further
392 | restriction, you may remove that term.  If a license document contains
393 | a further restriction but permits relicensing or conveying under this
394 | License, you may add to a covered work material governed by the terms
395 | of that license document, provided that the further restriction does
396 | not survive such relicensing or conveying.
397 | 
398 |   If you add terms to a covered work in accord with this section, you
399 | must place, in the relevant source files, a statement of the
400 | additional terms that apply to those files, or a notice indicating
401 | where to find the applicable terms.
402 | 
403 |   Additional terms, permissive or non-permissive, may be stated in the
404 | form of a separately written license, or stated as exceptions;
405 | the above requirements apply either way.
406 | 
407 |   8. Termination.
408 | 
409 |   You may not propagate or modify a covered work except as expressly
410 | provided under this License.  Any attempt otherwise to propagate or
411 | modify it is void, and will automatically terminate your rights under
412 | this License (including any patent licenses granted under the third
413 | paragraph of section 11).
414 | 
415 |   However, if you cease all violation of this License, then your
416 | license from a particular copyright holder is reinstated (a)
417 | provisionally, unless and until the copyright holder explicitly and
418 | finally terminates your license, and (b) permanently, if the copyright
419 | holder fails to notify you of the violation by some reasonable means
420 | prior to 60 days after the cessation.
421 | 
422 |   Moreover, your license from a particular copyright holder is
423 | reinstated permanently if the copyright holder notifies you of the
424 | violation by some reasonable means, this is the first time you have
425 | received notice of violation of this License (for any work) from that
426 | copyright holder, and you cure the violation prior to 30 days after
427 | your receipt of the notice.
428 | 
429 |   Termination of your rights under this section does not terminate the
430 | licenses of parties who have received copies or rights from you under
431 | this License.  If your rights have been terminated and not permanently
432 | reinstated, you do not qualify to receive new licenses for the same
433 | material under section 10.
434 | 
435 |   9. Acceptance Not Required for Having Copies.
436 | 
437 |   You are not required to accept this License in order to receive or
438 | run a copy of the Program.  Ancillary propagation of a covered work
439 | occurring solely as a consequence of using peer-to-peer transmission
440 | to receive a copy likewise does not require acceptance.  However,
441 | nothing other than this License grants you permission to propagate or
442 | modify any covered work.  These actions infringe copyright if you do
443 | not accept this License.  Therefore, by modifying or propagating a
444 | covered work, you indicate your acceptance of this License to do so.
445 | 
446 |   10. Automatic Licensing of Downstream Recipients.
447 | 
448 |   Each time you convey a covered work, the recipient automatically
449 | receives a license from the original licensors, to run, modify and
450 | propagate that work, subject to this License.  You are not responsible
451 | for enforcing compliance by third parties with this License.
452 | 
453 |   An "entity transaction" is a transaction transferring control of an
454 | organization, or substantially all assets of one, or subdividing an
455 | organization, or merging organizations.  If propagation of a covered
456 | work results from an entity transaction, each party to that
457 | transaction who receives a copy of the work also receives whatever
458 | licenses to the work the party's predecessor in interest had or could
459 | give under the previous paragraph, plus a right to possession of the
460 | Corresponding Source of the work from the predecessor in interest, if
461 | the predecessor has it or can get it with reasonable efforts.
462 | 
463 |   You may not impose any further restrictions on the exercise of the
464 | rights granted or affirmed under this License.  For example, you may
465 | not impose a license fee, royalty, or other charge for exercise of
466 | rights granted under this License, and you may not initiate litigation
467 | (including a cross-claim or counterclaim in a lawsuit) alleging that
468 | any patent claim is infringed by making, using, selling, offering for
469 | sale, or importing the Program or any portion of it.
470 | 
471 |   11. Patents.
472 | 
473 |   A "contributor" is a copyright holder who authorizes use under this
474 | License of the Program or a work on which the Program is based.  The
475 | work thus licensed is called the contributor's "contributor version".
476 | 
477 |   A contributor's "essential patent claims" are all patent claims
478 | owned or controlled by the contributor, whether already acquired or
479 | hereafter acquired, that would be infringed by some manner, permitted
480 | by this License, of making, using, or selling its contributor version,
481 | but do not include claims that would be infringed only as a
482 | consequence of further modification of the contributor version.  For
483 | purposes of this definition, "control" includes the right to grant
484 | patent sublicenses in a manner consistent with the requirements of
485 | this License.
486 | 
487 |   Each contributor grants you a non-exclusive, worldwide, royalty-free
488 | patent license under the contributor's essential patent claims, to
489 | make, use, sell, offer for sale, import and otherwise run, modify and
490 | propagate the contents of its contributor version.
491 | 
492 |   In the following three paragraphs, a "patent license" is any express
493 | agreement or commitment, however denominated, not to enforce a patent
494 | (such as an express permission to practice a patent or covenant not to
495 | sue for patent infringement).  To "grant" such a patent license to a
496 | party means to make such an agreement or commitment not to enforce a
497 | patent against the party.
498 | 
499 |   If you convey a covered work, knowingly relying on a patent license,
500 | and the Corresponding Source of the work is not available for anyone
501 | to copy, free of charge and under the terms of this License, through a
502 | publicly available network server or other readily accessible means,
503 | then you must either (1) cause the Corresponding Source to be so
504 | available, or (2) arrange to deprive yourself of the benefit of the
505 | patent license for this particular work, or (3) arrange, in a manner
506 | consistent with the requirements of this License, to extend the patent
507 | license to downstream recipients.  "Knowingly relying" means you have
508 | actual knowledge that, but for the patent license, your conveying the
509 | covered work in a country, or your recipient's use of the covered work
510 | in a country, would infringe one or more identifiable patents in that
511 | country that you have reason to believe are valid.
512 | 
513 |   If, pursuant to or in connection with a single transaction or
514 | arrangement, you convey, or propagate by procuring conveyance of, a
515 | covered work, and grant a patent license to some of the parties
516 | receiving the covered work authorizing them to use, propagate, modify
517 | or convey a specific copy of the covered work, then the patent license
518 | you grant is automatically extended to all recipients of the covered
519 | work and works based on it.
520 | 
521 |   A patent license is "discriminatory" if it does not include within
522 | the scope of its coverage, prohibits the exercise of, or is
523 | conditioned on the non-exercise of one or more of the rights that are
524 | specifically granted under this License.  You may not convey a covered
525 | work if you are a party to an arrangement with a third party that is
526 | in the business of distributing software, under which you make payment
527 | to the third party based on the extent of your activity of conveying
528 | the work, and under which the third party grants, to any of the
529 | parties who would receive the covered work from you, a discriminatory
530 | patent license (a) in connection with copies of the covered work
531 | conveyed by you (or copies made from those copies), or (b) primarily
532 | for and in connection with specific products or compilations that
533 | contain the covered work, unless you entered into that arrangement,
534 | or that patent license was granted, prior to 28 March 2007.
535 | 
536 |   Nothing in this License shall be construed as excluding or limiting
537 | any implied license or other defenses to infringement that may
538 | otherwise be available to you under applicable patent law.
539 | 
540 |   12. No Surrender of Others' Freedom.
541 | 
542 |   If conditions are imposed on you (whether by court order, agreement or
543 | otherwise) that contradict the conditions of this License, they do not
544 | excuse you from the conditions of this License.  If you cannot convey a
545 | covered work so as to satisfy simultaneously your obligations under this
546 | License and any other pertinent obligations, then as a consequence you may
547 | not convey it at all.  For example, if you agree to terms that obligate you
548 | to collect a royalty for further conveying from those to whom you convey
549 | the Program, the only way you could satisfy both those terms and this
550 | License would be to refrain entirely from conveying the Program.
551 | 
552 |   13. Use with the GNU Affero General Public License.
553 | 
554 |   Notwithstanding any other provision of this License, you have
555 | permission to link or combine any covered work with a work licensed
556 | under version 3 of the GNU Affero General Public License into a single
557 | combined work, and to convey the resulting work.  The terms of this
558 | License will continue to apply to the part which is the covered work,
559 | but the special requirements of the GNU Affero General Public License,
560 | section 13, concerning interaction through a network will apply to the
561 | combination as such.
562 | 
563 |   14. Revised Versions of this License.
564 | 
565 |   The Free Software Foundation may publish revised and/or new versions of
566 | the GNU General Public License from time to time.  Such new versions will
567 | be similar in spirit to the present version, but may differ in detail to
568 | address new problems or concerns.
569 | 
570 |   Each version is given a distinguishing version number.  If the
571 | Program specifies that a certain numbered version of the GNU General
572 | Public License "or any later version" applies to it, you have the
573 | option of following the terms and conditions either of that numbered
574 | version or of any later version published by the Free Software
575 | Foundation.  If the Program does not specify a version number of the
576 | GNU General Public License, you may choose any version ever published
577 | by the Free Software Foundation.
578 | 
579 |   If the Program specifies that a proxy can decide which future
580 | versions of the GNU General Public License can be used, that proxy's
581 | public statement of acceptance of a version permanently authorizes you
582 | to choose that version for the Program.
583 | 
584 |   Later license versions may give you additional or different
585 | permissions.  However, no additional obligations are imposed on any
586 | author or copyright holder as a result of your choosing to follow a
587 | later version.
588 | 
589 |   15. Disclaimer of Warranty.
590 | 
591 |   THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY
592 | APPLICABLE LAW.  EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT
593 | HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY
594 | OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO,
595 | THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
596 | PURPOSE.  THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM
597 | IS WITH YOU.  SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF
598 | ALL NECESSARY SERVICING, REPAIR OR CORRECTION.
599 | 
600 |   16. Limitation of Liability.
601 | 
602 |   IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
603 | WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS
604 | THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY
605 | GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE
606 | USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF
607 | DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD
608 | PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS),
609 | EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF
610 | SUCH DAMAGES.
611 | 
612 |   17. Interpretation of Sections 15 and 16.
613 | 
614 |   If the disclaimer of warranty and limitation of liability provided
615 | above cannot be given local legal effect according to their terms,
616 | reviewing courts shall apply local law that most closely approximates
617 | an absolute waiver of all civil liability in connection with the
618 | Program, unless a warranty or assumption of liability accompanies a
619 | copy of the Program in return for a fee.
620 | 
621 |                      END OF TERMS AND CONDITIONS
622 | 
623 |             How to Apply These Terms to Your New Programs
624 | 
625 |   If you develop a new program, and you want it to be of the greatest
626 | possible use to the public, the best way to achieve this is to make it
627 | free software which everyone can redistribute and change under these terms.
628 | 
629 |   To do so, attach the following notices to the program.  It is safest
630 | to attach them to the start of each source file to most effectively
631 | state the exclusion of warranty; and each file should have at least
632 | the "copyright" line and a pointer to where the full notice is found.
633 | 
634 |     <one line to give the program's name and a brief idea of what it does.>
635 |     Copyright (C) <year>  <name of author>
636 | 
637 |     This program is free software: you can redistribute it and/or modify
638 |     it under the terms of the GNU General Public License as published by
639 |     the Free Software Foundation, either version 3 of the License, or
640 |     (at your option) any later version.
641 | 
642 |     This program is distributed in the hope that it will be useful,
643 |     but WITHOUT ANY WARRANTY; without even the implied warranty of
644 |     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
645 |     GNU General Public License for more details.
646 | 
647 |     You should have received a copy of the GNU General Public License
648 |     along with this program.  If not, see <http://www.gnu.org/licenses/>.
649 | 
650 | Also add information on how to contact you by electronic and paper mail.
651 | 
652 |   If the program does terminal interaction, make it output a short
653 | notice like this when it starts in an interactive mode:
654 | 
655 |     <program>  Copyright (C) <year>  <name of author>
656 |     This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'.
657 |     This is free software, and you are welcome to redistribute it
658 |     under certain conditions; type `show c' for details.
659 | 
660 | The hypothetical commands `show w' and `show c' should show the appropriate
661 | parts of the General Public License.  Of course, your program's commands
662 | might be different; for a GUI interface, you would use an "about box".
663 | 
664 |   You should also get your employer (if you work as a programmer) or school,
665 | if any, to sign a "copyright disclaimer" for the program, if necessary.
666 | For more information on this, and how to apply and follow the GNU GPL, see
667 | <http://www.gnu.org/licenses/>.
668 | 
669 |   The GNU General Public License does not permit incorporating your program
670 | into proprietary programs.  If your program is a subroutine library, you
671 | may consider it more useful to permit linking proprietary applications with
672 | the library.  If this is what you want to do, use the GNU Lesser General
673 | Public License instead of this License.  But first, please read
674 | <http://www.gnu.org/philosophy/why-not-lgpl.html>.
675 | 


--------------------------------------------------------------------------------