ruby2jar 0.1

data/lib/ruby2jar/console.rb

@@ -0,0 +1,34 @@
+=begin
+Command line interface for ruby2jar builder.
+
+Copyright (C) 2008 Andrey "A.I." Sitnik <andrey@sitnik.ru>
+
+This program is free software: you can redistribute it and/or modify
+it under the terms of the GNU General Public License as published by
+the Free Software Foundation, either version 3 of the License, or
+(at your option) any later version.
+
+This program is distributed in the hope that it will be useful,
+but WITHOUT ANY WARRANTY; without even the implied warranty of
+MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+GNU General Public License for more details.
+
+You should have received a copy of the GNU General Public License
+along with this program.  If not, see <http://www.gnu.org/licenses/>.
+=end
+
+module Ruby2Jar
+  # Command line interface for builder. Check builder parameters and
+  # print error and warnings to console.
+  class Console < Listener
+    # Print message for standart builder error
+    def on_error(error)
+      if Error == error.class
+        STDERR.puts "ERROR: #{error.message}"
+        true
+      else
+        false
+      end
+    end
+  end
+end

data/lib/ruby2jar/error.rb

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

data/lib/ruby2jar/jartask.rb

@@ -0,0 +1,85 @@
+=begin
+Rake task for building.
+
+Copyright (C) 2008 Andrey "A.I." Sitnik <andrey@sitnik.ru>
+
+This program is free software: you can redistribute it and/or modify
+it under the terms of the GNU General Public License as published by
+the Free Software Foundation, either version 3 of the License, or
+(at your option) any later version.
+
+This program is distributed in the hope that it will be useful,
+but WITHOUT ANY WARRANTY; without even the implied warranty of
+MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+GNU General Public License for more details.
+
+You should have received a copy of the GNU General Public License
+along with this program.  If not, see <http://www.gnu.org/licenses/>.
+=end
+
+module Ruby2Jar
+  # Rake task to build JAR.
+  #
+  # Example:
+  #   require "ruby2jar"
+  #   
+  #   PKG_NAME = "program"
+  #   PKG_VERSION = "0.1"
+  #   
+  #   Ruby2Jar::Rake::JarTask.new do |jar|
+  #     jar.files = FileList["lib/**/*", "bin/*"]
+  #     jar.main = "bin/program"
+  #     jar.name = PKG_NAME
+  #     jar.version = PKG_VERSION
+  #     jar.add_dependency "rspec"
+  #   end
+  class JarTask
+    # Name of JAR package
+    attr_accessor :name
+
+    # Version of application to use in JAR name
+    attr_accessor :version
+
+    # Create an RDoc task named +task+ (default task name is +jar+)
+    def initialize(task = :jar)
+      @task = task
+      @builder = Builder.new
+      Console.new(@builder)
+      yield self if block_given?
+      if @builder.jar.nil? and not @name.nil?
+        if not @version.nil?
+          @builder.jar = "pkg/#{@name}-#{@version}.jar"
+        else
+          @builder.jar = "pkg/#{@name}.jar"
+        end
+      end
+      define
+    end
+
+    # Create the tasks
+    def define
+      task :package => [@task]
+      desc "Build the JAR file #{@builder.jar}"
+      task @task do
+        @builder.build
+      end
+
+      task :clobber => ["clobber_#{@task}"]
+      desc "Remove JAR file #{@builder.jar}"
+      task "clobber_#{@task}" do
+        File.delete @builder.jar if File.exists? @builder.jar
+        pkg = File.dirname(@builder.jar)
+        Dir.delete pkg if Dir.entries(pkg)
+      end
+    end
+
+    # Set parameters of JAR builder
+    def method_missing(method, *args)
+      if not @builder.method(method).nil?
+        @builder.method(method).call(*args)
+      else
+        super(method, *args)
+      end
+    end
+  end
+end

data/lib/ruby2jar/listener.rb

@@ -0,0 +1,38 @@
+=begin
+Simple metaclass to create extensions for builder.
+
+Copyright (C) 2008 Andrey "A.I." Sitnik <andrey@sitnik.ru>
+
+This program is free software: you can redistribute it and/or modify
+it under the terms of the GNU General Public License as published by
+the Free Software Foundation, either version 3 of the License, or
+(at your option) any later version.
+
+This program is distributed in the hope that it will be useful,
+but WITHOUT ANY WARRANTY; without even the implied warranty of
+MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+GNU General Public License for more details.
+
+You should have received a copy of the GNU General Public License
+along with this program.  If not, see <http://www.gnu.org/licenses/>.
+=end
+
+module Ruby2Jar
+  # Simple metaclass to create extensions for builder, which provide user
+  # interface or special functions, such as creating Java Web Start files.
+  #
+  # It add all listener methods started by "before_" to builder.
+  class Listener
+    # Add listeners to +builder+
+    def initialize(builder = nil)
+      if not builder.nil?
+        @builder = builder
+        builder.methods.reject {|i| not i =~ /^(before_|on_error$)/}.each do |m|
+          if methods.include? m
+            builder.method(m).call << method(m)
+          end
+        end
+      end
+    end
+  end
+end

data/spec/builder/before_spec.rb

@@ -0,0 +1,105 @@
+require File.join(File.dirname(__FILE__), "spec_helper")
+
+describe Ruby2Jar::Builder do
+  before :each do
+    @builder = Ruby2Jar::Builder.new
+    @builder.path = "."
+    @builder.include_jruby = false
+    @builder.before_copy << lambda { @builder.stop }
+  end
+  
+  it "should set result jar path automatically" do
+    tmpdir = TempDir.create
+    FileUtils.mkdir File.join(tmpdir, "my_project")
+    FileUtils.touch File.join(tmpdir, "my_application.rb")
+    
+    @builder.path = File.join(tmpdir, "my_project")
+    @builder.build
+    
+    @builder.jar.should == File.join(tmpdir, "my_project", "pkg", "my_project.jar")
+    
+    @builder.path = File.join(tmpdir, "my_application.rb")
+    @builder.jar = nil
+    @builder.build
+    
+    @builder.jar.should == File.join(tmpdir, "my_application.jar")
+    
+    tmpdir.delete
+  end
+  
+  it "should raise error if path didn't set" do
+    @builder.path = nil
+    @builder.method(:build).should raise_error(Ruby2Jar::Error, /didn't set path/)
+  end
+  
+  it "should raise error if path isn't exist" do
+    nodir = TempDir.new
+    
+    @builder.path = nodir
+    @builder.method(:build).should raise_error(Ruby2Jar::Error, /path is already exist/)
+  end
+  
+  it "should raise error if result jar is already exist" do
+    tmpdir = TempDir.create
+    FileUtils.touch File.join(tmpdir, "result.jar")
+    @builder.jar = File.join(tmpdir, "result.jar")
+    
+    @builder.method(:build).should raise_error(Ruby2Jar::Error, /jar/)
+    
+    tmpdir.delete
+  end
+  
+  it "should raise error if main script isn't exist" do
+    tmpdir = TempDir.create
+    @builder.path = tmpdir
+    @builder.main = "script.rb"
+    
+    @builder.method(:build).should raise_error(Ruby2Jar::Error, /Main script isn't exist/)
+    
+    FileUtils.touch File.join(tmpdir, "script.rb")
+    @builder.method(:build).should_not raise_error(Ruby2Jar::Error)
+    
+    tmpdir.delete
+  end
+  
+  it "should raise error if it can't find JRuby jar" do
+    jruby = ENV['JRUBY_HOME']
+    ENV['JRUBY_HOME'] = nil
+    @builder.include_jruby = true
+    
+    @builder.method(:build).should raise_error(Ruby2Jar::Error, /Can't find JRuby/)
+    
+    ENV['JRUBY_HOME'] = jruby
+  end
+  
+  it "should raise error if JRuby jar isn't exist" do
+    @builder.include_jruby = true
+    tmpdir = TempDir.new
+    @builder.jruby = File.join(tmpdir, "jruby.jar")
+    
+    @builder.method(:build).should raise_error(Ruby2Jar::Error, /JRuby isn't exist/)
+  end
+  
+  it "should find JRuby jar by JRUBY_HOME enviroment" do
+    jruby = ENV['JRUBY_HOME']
+    ENV['JRUBY_HOME'] = File.join(File.dirname(__FILE__), "fixtures", "jruby")
+    @builder.include_jruby = true
+    
+    @builder.build
+    @builder.jruby.should == File.join(ENV['JRUBY_HOME'], "lib", "jruby.jar")
+    
+    ENV['JRUBY_HOME'] = jruby
+  end
+  
+  it "should create temporal dir on start and delete it on finish " do
+    @build_dir = nil
+    @builder.before_copy << lambda {
+      @build_dir = @builder.build_dir
+      @build_dir.should_not be_nil
+      File.directory?(@build_dir).should be_true
+    }
+    
+    @builder.build
+    File.directory?(@build_dir).should be_false
+  end
+end

data/spec/builder/builder_spec.rb

@@ -0,0 +1,100 @@
+require File.join(File.dirname(__FILE__), "spec_helper")
+
+describe Ruby2Jar::Builder do
+  include DirHelper
+  
+  it "should do all steps and extension functions in order" do
+    builder = TracerBuilder.new
+    builder.before_copy << lambda {
+      builder.steps << "touch"
+    }
+    
+    builder.build
+    builder.steps.should == [
+      "before_start", "start",
+      "before_copy", "touch", "copy",
+      "before_create_init", "create_init",
+      "before_compile", "compile",
+      "before_package", "package",
+      "before_finish", "finish"]
+  end
+  
+  it "should can stop finish it work" do
+    builder = TracerBuilder.new
+    builder.before_create_init << lambda {
+      builder.steps << "STOP"
+      builder.stop
+    }
+    
+    builder.build
+    builder.steps.should == [
+      "before_start", "start",
+      "before_copy", "copy",
+      "before_create_init", "STOP",
+      "before_finish", "finish"]
+  end
+  
+  it "should finish it work on exception" do
+    builder = TracerBuilder.new
+    builder.before_copy << lambda {
+      builder.steps << "SHOT"
+      raise "Shot"
+    }
+    builder.before_finish << lambda {
+      builder.steps << "HEADSHOT"
+      raise "Headshot"
+    }
+    
+    begin
+      builder.build
+    rescue; end
+    builder.steps.should == [
+      "before_start", "start",
+      "before_copy", "SHOT", "on_error Shot",
+      "before_finish", "HEADSHOT", "finish"]
+  end
+  
+  it "should raise error if it doesn't rescue on_error extensions" do
+    builder = TracerBuilder.new
+    builder.before_start << lambda { raise }
+    
+    builder.on_error = [lambda { true }]
+    builder.method(:build).should_not raise_error
+    
+    builder.on_error = [lambda { false }]
+    builder.method(:build).should raise_error
+  end
+  
+  it "should remember added gems" do
+    builder = Ruby2Jar::Builder.new
+    builder.add_dependency "one"
+    builder.add_dependency "two", ">=0.1", "< 1.0"
+    builder.gems.should == [["one", []], ["two", [">=0.1", "< 1.0"]]]
+  end
+  
+  it "should compile all Ruby and Java files" do
+    builder = Ruby2Jar::Builder.new
+    builder.path = File.join(File.dirname(__FILE__), "fixtures", "app")
+    
+    builder.before_package << lambda {
+      builder.build_dir.should contain_files("ruby/app/main.class", 
+        "ruby/app/greeters/english.class", "greeters/JavaGreeter.class")
+      builder.stop
+    }
+    builder.build
+  end
+  
+  it "should create working JAR" do
+    builder = Ruby2Jar::Builder.new
+    builder.path = File.join(File.dirname(__FILE__), "fixtures", "app")
+    builder.main = "main.rb"
+    dir = TempDir.create
+    builder.include_jruby = true
+    builder.jar = File.join(dir, "result.jar")
+    builder.build
+    
+    `java -jar #{builder.jar}`.should == "Hello World!\n"
+    
+    dir.delete
+  end
+end

data/spec/builder/copy_spec.rb

@@ -0,0 +1,138 @@
+require File.join(File.dirname(__FILE__), "spec_helper")
+
+describe Ruby2Jar::Builder do
+  include DirHelper
+  
+  before :each do
+    @builder = Ruby2Jar::Builder.new
+    @builder.include_jruby = false
+    @app_path = TempDir.create
+    @builder.path = @app_path
+    @builder.before_create_init << lambda { @builder.stop }
+    @builder.gems_index = FakeGems.new
+  end
+  
+  it "should copy all neccessary file from application dir" do
+    create_files @builder.path, ["1.rb", "1.no", "subdir/2.rb", "subdir/3.rb"]
+    Dir.chdir(@builder.path) do
+      @builder.files = FileList["**/*"].exclude("*.no")
+    end
+    
+    @builder.before_create_init << lambda {
+      @builder.build_dir.should contain_files(
+        "ruby/app/1.rb", "ruby/app/subdir/2.rb", "ruby/app/subdir/3.rb")
+    }
+    @builder.build
+  end
+  
+  it "should copy file if application is a one script" do
+    create_files @builder.path, "application.rb"
+    @builder.path = File.join(@builder.path, "application.rb")
+    
+    @builder.before_create_init << lambda {
+      @builder.build_dir.should contain_files("ruby/app/application.rb")
+    }
+    @builder.build
+  end
+  
+  it "should copy all Java file to archive root" do
+    create_files @builder.path, ["one.rb", "ext/subdir/pure.java"]
+    
+    @builder.before_create_init << lambda {
+      @builder.build_dir.should contain_files("ruby/app/one.rb", "subdir/pure.java")
+    }
+    @builder.build
+  end
+  
+  it "should delete java source file if compiled class file if already exist" do
+    create_files @builder.path, ["one.rb", "ext/pure.java", "ext/pure.class"]
+    
+    @builder.before_create_init << lambda {
+      @builder.build_dir.should contain_files("ruby/app/one.rb", "pure.class")
+    }
+    @builder.build
+  end
+  
+  it "should raise error if gem isn't found" do
+    @builder.gems_index.gems = {}
+    @builder.add_dependency "gem"
+    @builder.method(:build).should raise_error(Ruby2Jar::Error, /Can't find gem/)
+  end
+  
+  it "should raise error if gem with different version is already added" do
+    @builder.gems_index.gems = {
+      "gem-1.0" => FakeSpecification.new("gem", "1.0", @builder.path),
+      "gem-0.9" => FakeSpecification.new("gem", "0.9", @builder.path)}
+    @builder.add_dependency "gem", "1.0"
+    @builder.add_dependency "gem", "0.9"
+    
+    @builder.method(:build).should raise_error(Ruby2Jar::Error, /different version/)
+  end
+  
+  it "should copy gem dependencies too" do
+    
+    @builder.gems_index.gems = {
+      "one-" => FakeSpecification.new("one", "", @builder.path, ["two"]), 
+      "two-" => FakeSpecification.new("two", "", @builder.path, ["one"])}
+    @builder.add_dependency "one"
+    
+    @builder.before_create_init << lambda {
+      @builder.loaded_gems.should == ["one", "two"]
+    }
+    @builder.build
+  end
+  
+  it "should load java config from gem" do
+    gem_path = TempDir.create
+    File.open(File.join(gem_path, "java.yaml"), "w") do |file|
+      file.write({"name" => "value"}.to_yaml)
+    end
+    @builder.gems_index.gems = {
+      "gem-" => FakeSpecification.new("gem", "", gem_path)}
+    @builder.add_dependency "gem"
+    
+    @builder.before_create_init << lambda {
+      @builder.configs["gem"].should == {"name" => "value"}
+    }
+    @builder.build
+    
+    gem_path.delete
+  end
+  
+  it "should copy all neccessary file from gem dir" do
+    gem_path = TempDir.create
+    create_files gem_path, ["one.rb", "1.no", "subdir/two.rb", "ext/pure.java"]
+    File.open(File.join(gem_path, "java.yaml"), "w") do |file|
+      file.write({"jar" => {"exclude" => "*.no"}}.to_yaml)
+    end
+    @builder.gems_index.gems = {
+      "gem-" => FakeSpecification.new("gem", "", gem_path)}
+    @builder.add_dependency "gem"
+    
+    @builder.before_create_init << lambda {
+      @builder.build_dir.should contain_files(
+        "ruby/gems/gem/one.rb", "ruby/gems/gem/subdir/two.rb", "pure.java")
+    }
+    @builder.build
+    
+    gem_path.delete
+  end
+  
+  it "should add gem and app paths to init_require_paths" do
+    @builder.gems_index.gems = {
+      "gem-" => FakeSpecification.new("gem", "", @builder.path)}
+    @builder.add_dependency "gem"
+    @builder.require_paths = ["one", "two"]
+    
+    @builder.before_create_init << lambda {
+      @builder.init_require_paths.should include("ruby/gems/gem/lib")
+      @builder.init_require_paths.should include("ruby/app/one")
+      @builder.init_require_paths.should include("ruby/app/two")
+    }
+    @builder.build
+  end
+  
+  after :each do
+    @app_path.delete
+  end
+end