buildr-gemjar 1.0.0

data/.braids

@@ -0,0 +1,8 @@
+--- 
+vendor/buildr: 
+  branch: trunk
+  remote: braid/vendor/buildr
+  revision: 5c643a311d181f06e6c09b33b98a5a24c546d6b7
+  squashed: true
+  type: git
+  url: git://git.apache.org/buildr.git

data/.gitignore

@@ -0,0 +1,5 @@
+*.gem
+.bundle
+Gemfile.lock
+pkg/*
+tmp/*

data/.rvmrc

@@ -0,0 +1 @@
+rvm_gemset_create_on_use_flag=1; rvm gemset use buildr-gemjar

data/CHANGELOG.md

@@ -0,0 +1,4 @@
+1.0.0
+=====
+
+- Initial version

data/Gemfile

@@ -0,0 +1,4 @@
+source "http://rubygems.org"
+
+# Specify your gem's dependencies in buildr-gemjar/.gemspec
+gemspec

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2011 Rhett Sutphin
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,98 @@
+buildr-gemjar
+=============
+
+`buildr-gemjar` is an extension for [buildr][] that makes it easy to
+package gems and their dependencies into a jar so that [JRuby can
+detect them on the classpath][gemjar].
+
+[buildr]: http://buildr.apache.org/
+[gemjar]: http://blog.nicksieger.com/articles/2009/01/10/jruby-1-1-6-gems-in-a-jar
+
+Installing
+----------
+
+`buildr-gemjar` is distributed as a rubygem on
+[rubygems.org][as-gem].  Install it as you would any other gem:
+
+$ gem install buildr-gemjar
+
+[as-gem]: https://rubygems.org/gems/buildr-gemjar
+
+Using
+-----
+
+`buildr-gemjar` provides a [package type][buildr-package] called
+`:gemjar`.  Sample use:
+
+    # buildfile
+    require 'buildr-gemjar'
+
+    define 'sinatra-gems' do
+      project.version = '1.1.2'
+
+      package(:gemjar).with_gem('sinatra', project.version)
+    end
+
+When you run `buildr package`, the result will be a JAR which contains
+sinatra 1.1.2 and all its dependencies.
+
+You can specify multiple gems:
+
+    package(:gemjar).
+      with_gem('activesupport', '2.3.10').
+      with_gem('facets, '2.4.5')
+
+You can specify additional sources on top of rubygems.org:
+
+    package(:gemjar).
+      add_source('http://myrepo.local/gems').
+      with_gem('my-orm', '1.0.3')
+
+You can also include a gem for which you have a `.gem` package:
+
+    package(:gemjar).with_gem(:file => _('snapshot-gem-2.0.7.pre.gem'))
+
+[buildr-package]: http://buildr.apache.org/packaging.html
+
+Caveats
+-------
+
+It's important that the name of your JAR not be the same as anything
+you will `require` from it.  E.g., in the sample above, if the JAR
+were named `sinatra.jar`, it would not be possible to `require
+"sinatra"` from it.  (This is a general JRuby requirement, not
+something that's specific to this tool.)
+
+Compatibility
+-------------
+
+`buildr-gemjar` has been tested with buildr 1.4.4 on ruby 1.8.7,
+1.9.2, and JRuby* 1.5.6.  It's expected that it will work with any
+fairly recent version of buildr.  It's been tested on OS X and Linux;
+it may or may not work on Windows.
+
+(*The spec suite does not execute on JRuby for no reason I've yet
+been able to track down, but manual testing indicates that the
+extension works fine on that platform.)
+
+Future work
+-----------
+
+* Use [bundler][] to get a coherent list of dependencies across
+  several gems.  (It would already do this, except that bundler
+  doesn't support sourcing a gem from a `.gem` file, which is a more
+  important feature.)
+* Improve performance.  Currently a new JVM is spun up to do each gem
+  install, which can be slow if there are a lot of gems.
+* Support Windows.
+
+[bundler]: http://gembundler.com/
+
+About
+-----
+
+Copyright 2011, Rhett Sutphin.
+
+`buildr-gemjar` was built at [NUBIC][].
+
+[NUBIC]: http://www.nucats.northwestern.edu/centers/nubic

data/Rakefile

@@ -0,0 +1,8 @@
+require 'bundler'
+require 'rspec/core/rake_task'
+
+Bundler::GemHelper.install_tasks
+
+RSpec::Core::RakeTask.new do |t|
+  t.pattern = "spec/**/*_spec.rb"
+end

data/buildr-gemjar.gemspec

@@ -0,0 +1,42 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "buildr-gemjar/version"
+
+Gem::Specification.new do |s|
+  s.name        = "buildr-gemjar"
+  s.version     = BuildrGemjar::VERSION
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = ["Rhett Sutphin"]
+  s.email       = ["rhett@detailedbalance.net"]
+  s.homepage    = ""
+  s.summary     = %q{Provides buildr support for packaging gems in a JAR for JRuby}
+
+  s.rubyforge_project = "buildr-gemjar"
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+
+  # Have to use buildr's version for its spec helper to work
+  # s.add_development_dependency 'rspec', '~> 2.4'
+  s.add_development_dependency 'braid', '~> 0.6'
+
+  # Deps for the vendored buildr that's used in testing
+  s.add_development_dependency 'rake',                 '0.8.7'
+  s.add_development_dependency 'builder',              '2.1.2'
+  s.add_development_dependency 'net-ssh',              '2.0.23'
+  s.add_development_dependency 'net-sftp',             '2.0.4'
+  s.add_development_dependency 'rubyzip',              '0.9.4'
+  s.add_development_dependency 'highline',             '1.5.1'
+  s.add_development_dependency 'json_pure',            '1.4.3'
+  s.add_development_dependency 'rubyforge',            '2.0.3'
+  s.add_development_dependency 'hoe',                  '2.3.3'
+  s.add_development_dependency 'rjb',                  '1.3.3' if s.platform.to_s == 'ruby'
+  s.add_development_dependency 'rjb',                  '1.3.2' if s.platform.to_s == 'x86-mswin32'
+  s.add_development_dependency 'atoulme-Antwrap',      '0.7.1'
+  s.add_development_dependency 'rspec',                '~> 2.1.0'
+  s.add_development_dependency 'xml-simple',           '1.0.12'
+  s.add_development_dependency 'minitar',              '0.5.3'
+  s.add_development_dependency 'jruby-openssl',        '>= 0.7' if s.platform.to_s == 'java'
+end

data/lib/buildr-gemjar.rb

@@ -0,0 +1,162 @@
+require 'buildr/java/packaging'
+
+module BuildrGemjar
+  class GemjarTask < Buildr::Packaging::Java::JarTask
+    def initialize(*args)
+      super
+      @target = File.expand_path("../gem_home", self.to_s)
+      mkdir_p @target
+
+      clean
+      include(@target, :as => '.')
+      enhance do
+        install_gems
+      end
+    end
+
+    def with_gem(*args)
+      new_gem =
+        if args.first.respond_to?(:has_key?)
+          FileSourcedGem.new(args.first[:file])
+        else
+          NamedGem.new(args[0], args[1])
+        end
+      gems << new_gem
+      enhance new_gem.dependencies
+      self
+    end
+
+    def clear_sources
+      sources.clear
+      self
+    end
+
+    def add_source(source)
+      sources << source
+      self
+    end
+
+    def gems
+      @gems ||= []
+    end
+
+    def sources
+      @sources ||= ['http://rubygems.org']
+    end
+
+    private
+
+    def install_gems
+      fail "No gems specified.  Did you call #with_gem?" if gems.empty?
+      gems.each do |gem|
+        cmd = [
+          "GEM_HOME='#{@target}'",
+          "java",
+          "-jar",
+          BuildrGemjar.jruby_complete_jar,
+          "-S",
+          "gem",
+          "install",
+          # The behavior of --source changed between rubygems 1.3.6
+          # and 1.5.0.  Previously, specifying source(s) overrode the
+          # default source(s).  After, specifying source(s) adds onto
+          # the default list.  To get the old behavior, you have to
+          # include "--clear-sources".  This code wants the old
+          # behavior, but no version of jruby-complete contains a
+          # version of rubygems > 1.3.6, so it's not an issue today.
+          # Later we'll probably have to do version sniffing or
+          # something.
+          # "--clear-sources",
+          sources.collect { |s| ["--source", "'#{s}'"] },
+          "--no-ri",
+          "--no-rdoc",
+          gem.install_command_elements
+        ].flatten.join(" ")
+
+        trace cmd
+        out = %x[#{cmd} 2>&1]
+        trace out
+        if out =~ /ERROR/
+          fail out.split("\n").grep(/ERROR/).join("\n")
+        end
+      end
+    end
+
+    class FileSourcedGem
+      attr_accessor :filename
+
+      def initialize(filename)
+        @filename = filename
+      end
+
+      def kind; :file; end
+
+      def install_command_elements
+        [filename]
+      end
+
+      def dependencies
+        [(filename if File.exist?(filename))].compact
+      end
+    end
+
+    class NamedGem
+      attr_accessor :name, :version
+
+      def initialize(name, version)
+        @name = name
+        @version = version
+      end
+
+      def kind; :named; end
+
+      def install_command_elements
+        [name].tap do |elts|
+          elts << "-v '#{version}'" if version
+        end
+      end
+
+      def dependencies
+        []
+      end
+    end
+  end
+
+  include Buildr::Extension
+
+  def package_as_gemjar(filename)
+    GemjarTask.define_task(filename)
+  end
+
+  def package_as_gemjar_spec(spec)
+    spec.merge(:type => 'jar')
+  end
+
+  def self.jruby_version
+    version = Buildr.settings.build['jruby'] ||
+      (JRUBY_VERSION if Kernel.const_defined?(:JRUBY_VERSION)) ||
+      "1.5.6"
+  end
+
+  def self.jruby_artifact
+    "org.jruby:jruby-complete:jar:#{jruby_version}"
+  end
+
+  class << self
+    attr_accessor :jruby_complete_jar
+  end
+
+  after_define do |project|
+    jruby = project.artifact(BuildrGemjar.jruby_artifact)
+    project.packages.each do |pkg|
+      if pkg.is_a?(GemjarTask)
+        pkg.enhance [jruby]
+        BuildrGemjar.jruby_complete_jar = jruby.to_s
+      end
+    end
+  end
+end
+
+class Buildr::Project
+  include BuildrGemjar
+end

data/lib/buildr-gemjar/version.rb

@@ -0,0 +1,3 @@
+module BuildrGemjar
+  VERSION = "1.0.0"
+end

data/meta.rakefile

@@ -0,0 +1,30 @@
+PLATFORMS = {
+  :ruby18 => 'ruby-1.8.7-p330',
+  :jruby  => 'jruby-1.5.6',
+  :ruby19 => 'ruby-1.9.2-p136'
+}
+
+BUNDLER_VERSION = '1.0.10'
+
+def ci_env
+  (ENV["GEMJAR_ENV"] || :ruby18).to_sym
+end
+
+namespace :ci do
+  task :rvmrc do
+    puts "#{PLATFORMS[ci_env]}@buildr-gemjar"
+  end
+
+  task :ensure_bundler_available do
+    unless Gem.available?('bundler', BUNDLER_VERSION)
+      puts "Installing bundler"
+      system "gem install bundler -v '#{BUNDLER_VERSION}'"
+    end
+  end
+
+  task :setup => [:ensure_bundler_available] do
+    system "bundle _#{BUNDLER_VERSION}_ install"
+  end
+end
+
+task :default => 'ci:setup'

data/spec/buildr-gemjar/version_spec.rb

@@ -0,0 +1,11 @@
+require File.expand_path("../../spec_helper.rb", __FILE__)
+
+describe BuildrGemjar, "::VERSION" do
+  it "exists" do
+    lambda { BuildrGemjar::VERSION }.should_not raise_error
+  end
+
+  it "has 3 or 4 dot separated parts" do
+    BuildrGemjar::VERSION.split('.').size.should be_between(3, 4)
+  end
+end

data/spec/buildr-gemjar_spec.rb

@@ -0,0 +1,179 @@
+require File.expand_path("../spec_helper.rb", __FILE__)
+
+describe ":gemjar packaging" do
+  describe "#with_gem" do
+    def actual_gems
+      projects.first.packages.first.gems
+    end
+
+    it "accepts a gem name" do
+      define('foo', :version => '1.0') {
+        package(:gemjar).with_gem('shenandoah', '~> 0.1.0')
+      }
+
+      actual_gems.first.kind.should == :named
+      actual_gems.first.name.should == 'shenandoah'
+      actual_gems.first.version.should == '~> 0.1.0'
+    end
+
+    it "defaults the version to nil" do
+      define('foo', :version => '1.0') {
+        package(:gemjar).with_gem('shenandoah')
+      }
+
+      actual_gems.first.kind.should == :named
+      actual_gems.first.name.should == 'shenandoah'
+      actual_gems.first.version.should be_nil
+    end
+
+    it "accepts a filename" do
+      define('foo', :version => '1.0') {
+        package(:gemjar).with_gem(:file => 'foo/bcdatabase-1.0.3.pre.gem')
+      }
+
+      actual_gems.first.kind.should == :file
+      actual_gems.first.filename.should == 'foo/bcdatabase-1.0.3.pre.gem'
+    end
+
+    it "can be invoked multiple times" do
+      define('foo', :version => '1.0') {
+        package(:gemjar).
+          with_gem('ladle', '~> 0.2.0').
+          with_gem(:file => 'target/just-built.gem').
+          with_gem('schema_qualified_tables', '~> 1.0.0')
+      }
+
+      actual_gems.collect { |g| g.kind }.should == [:named, :file, :named]
+    end
+  end
+
+  describe "sources" do
+    def actual_sources
+      projects.first.packages.first.sources
+    end
+
+    it "defaults to rubygems.org" do
+      define('foo', :version => '1.0') {
+        package(:gemjar)
+      }
+
+      actual_sources.should == %w(http://rubygems.org)
+    end
+
+    it "appends new sources while preserving the default" do
+      define('foo', :version => '1.0') {
+        package(:gemjar).
+          add_source('http://archive.local/gems').
+          with_gem('private-stuff')
+      }
+
+      actual_sources.should == %w(http://rubygems.org http://archive.local/gems)
+    end
+
+    it "can clear the default source" do
+      define('foo', :version => '1.0') {
+        package(:gemjar).clear_sources.add_source('http://archive.local/gems')
+      }
+
+      actual_sources.should == %w(http://archive.local/gems)
+    end
+  end
+
+  describe "name" do
+    it "uses 'jar' as the extension" do
+      define('foo', :version => '1.0') { package(:gemjar) }
+      project('foo').package(:gemjar).to_s.should =~ /\.jar/
+    end
+  end
+
+  describe "execution" do
+    before(:all) do
+      create_repo
+    end
+
+    after(:all) do
+      rm_repo
+    end
+
+    def test_package(invoke=true)
+      r = repo_path
+      define('foo', :version => '2.0') { |project|
+        yield package(:gemjar).clear_sources.add_source("file://#{r}")
+      }
+      @pkg = projects.first.packages.first
+      @pkg.invoke if invoke
+      @pkg.to_s
+    end
+
+    it "includes the explicitly requested gem" do
+      test_package { |p| p.with_gem("c") }.
+        should be_a_jar_containing("specifications/c-2.3.2.gemspec")
+    end
+
+    it "fails if the gem isn't available" do
+      lambda {
+        test_package { |p| p.with_gem("y") }
+      }.should raise_error(/could not find gem y/)
+    end
+
+    it "includes the specific version requested" do
+      test_package { |p| p.with_gem("b", "1.1") }.
+        should be_a_jar_containing("specifications/b-1.1.gemspec")
+    end
+
+    it "fails if the version requested isn't available" do
+      lambda {
+        test_package { |p| p.with_gem("b", "> 2") }
+      }.should raise_error(/could not find gem b/)
+    end
+
+    it "includes dependencies of the requested gem" do
+      test_package { |p| p.with_gem("c") }.
+        should be_a_jar_containing("specifications/a-1.0.gemspec")
+    end
+
+    it "includes the java variant of the gem when applicable" do
+      test_package { |p| p.with_gem("jr") }.
+        should be_a_jar_containing("specifications/jr-1.0-java.gemspec")
+    end
+
+    it "includes more than one explicitly prequested gem" do
+      test_package { |p| p.with_gem("b").with_gem("c") }.
+        should be_a_jar_containing("specifications/b-1.2.gemspec", "specifications/c-2.3.2.gemspec")
+    end
+
+    it "includes a gem from a file" do
+      create_gem "f", "2.3", :path => tmp("other")
+      test_package { |p| p.with_gem(:file => tmp("other", "f-2.3.gem")) }.
+        should be_a_jar_containing("specifications/f-2.3.gemspec")
+    end
+
+    it "fails usefully when a specified file isn't available" do
+      lambda {
+        test_package { |p| p.with_gem(:file => "z-4.5.gem") }
+      }.should raise_error(/could not find gem z-4.5.gem/)
+    end
+
+    it "usually only builds the jar once" do
+      create_gem "f", "2.3", :path => tmp("other")
+      path = test_package(false) { |p| p.with_gem(:file => tmp("other", "f-2.3.gem")) }
+      touch path
+      stat = File.stat(path)
+      sleep 5
+      @pkg.invoke
+      stat.mtime.should == File.stat(path).mtime
+    end
+
+    it "rebuilds the jar if the source file changes" do
+      create_gem "f", "2.3", :path => tmp("other")
+      path = test_package(false) { |p| p.with_gem(:file => tmp("other", "f-2.3.gem")) }
+      touch path
+      stat = File.stat(path)
+      sleep 4
+      touch tmp("other", "f-2.3.gem")
+      @pkg.invoke
+      stat.mtime.should_not == File.stat(path).mtime
+    end
+  end
+end
+