buildr-gemjar 1.0.2 → 1.1.0

data/CHANGELOG.md

@@ -1,3 +1,15 @@
+1.1.0
+=====
+
+- Added: JARs which are embedded in gems which are being packaged by
+  buildr-gemjar can be unpacked into the result JAR. The default
+  behavior is to unpack any JARs found under `lib` in the gem, but
+  this can be changed with an option on `with_gem`. See the README for
+  more details. (#4)
+
+- Fixed: When invoking `gem install` check the exit status (in
+  addition to scanning the output) to detect failures. (#2)
+
 1.0.2
 =====
 

data/README.md

@@ -54,6 +54,32 @@ You can also include a gem for which you have a `.gem` package:
 
 [buildr-package]: http://buildr.apache.org/packaging.html
 
+### JARs embedded in gems
+
+Many gems that are intended for use in JRuby embed one or more JARs
+containing "native" java code. [jruby-openssl][] is a popular example
+of this practice. If these jars are embedded as-is into the gemjar,
+they won't be visible to ruby code.
+
+To resolve this, `buildr-gemjar` will unpack any jar found under the
+lib directory of any installed gem (including dependent gems) and
+include its contents in the gemjar directly. You can control this
+behavior for an individual gem with the `:unpack_jars` option to
+`with_gems`. It can be set to one of the following values:
+
+* an array of globs; e.g., `["lib/shared/**/*.jar"]`. Each glob will be
+  applied at the root of the installed gem's contents and each match
+  will be unpacked into the gemjar.
+* `true`. Equivalent to `["lib/**/*.jar"]`. This is the default.
+* `false`. Do not unpack any jars from this gem.
+
+The default is `:unpack_jars => true`. Note that you can only apply
+different unpack behavior for gems which are explicitly included via
+`with_gem`. Any transitively installed gems will have the default
+unpack behavior (i.e., unpack every JAR under lib) applied.
+
+[jruby-openssl]: https://rubygems.org/gems/jruby-openssl
+
 Caveats
 -------
 
@@ -63,6 +89,9 @@ 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.)
 
+Embedded JARs will not have any of their metadata (manifests, META-INF
+service registrations, etc.) preserved if they are unpacked.
+
 Compatibility
 -------------
 
@@ -99,7 +128,7 @@ For bugs and feature requests, please use the [github issue
 tracker][issues].  For other questions, please use the [buildr users
 mailing list][buildrusers] or e-mail [me][] directly.
 
-[issues]: https://github.com/rsutphin/buildr-gemjar/issues
+[issues]: https://github.com/NUBIC/buildr-gemjar/issues
 [buildrusers]: http://buildr.apache.org/mailing_lists.html
 [me]: mailto:rhett@detailedbalance.net
 

data/lib/buildr-gemjar.rb

@@ -1,31 +1,40 @@
 require 'buildr/java/packaging'
+require 'pathname'
 
 module BuildrGemjar
   class GemjarTask < Buildr::Packaging::Java::JarTask
+    DEFAULT_UNPACK_GLOBS = ['lib/**/*.jar']
+
     def initialize(*args)
       super
-      @target = File.expand_path("../gem_home", self.to_s)
+      @target = Pathname.new File.expand_path("../gem_home", self.to_s)
       # It doesn't seem like this should be necessary or useful --
       # the directory is also created by a task dependency.
       # However, if it isn't here, the file gem dependency is not
       # correctly taken into account.  (Try commenting it out and
       # running the specs.)
-      mkdir_p @target
+      @target.mkpath
 
       clean
-      include(@target, :as => '.')
+      include(@target.to_s, :as => '.')
       enhance do
         install_gems
+        unpack_jars
       end
     end
 
     def with_gem(*args)
+      options = args.last.respond_to?(:has_key?) ? args.pop : {}
+
       new_gem =
-        if args.first.respond_to?(:has_key?)
-          FileSourcedGem.new(args.first[:file])
+        if options.has_key?(:file)
+          FileSourcedGem.new(options[:file])
         else
           NamedGem.new(args[0], args[1])
         end
+
+      new_gem.unpack_globs = determine_unpack_globs(options[:unpack_jars])
+
       gems << new_gem
       enhance new_gem.dependencies
       self
@@ -86,13 +95,77 @@ module BuildrGemjar
         trace cmd
         out = %x[#{cmd} 2>&1]
         trace out
-        if out =~ /ERROR/
+        if $? != 0
+          fail "gem invocation failed:\n#{out}"
+        elsif out =~ /ERROR/
           fail out.split("\n").grep(/ERROR/).join("\n")
         end
       end
     end
 
+    def determine_unpack_globs(unpack_jars_option)
+      unpack_jars_option = true if unpack_jars_option.nil?
+
+      case unpack_jars_option
+      when true
+        DEFAULT_UNPACK_GLOBS
+      when false
+        []
+      else
+        [*unpack_jars_option]
+      end
+    end
+
+    def unpack_jars
+      all_gem_roots = (gem_home + 'gems').children
+      requested_gem_roots = gems.collect { |gem| gem.install_root(gem_home) }.compact
+      other_gem_roots = all_gem_roots - requested_gem_roots
+
+      FileUtils.cd gem_home do
+        other_gem_roots.each do |root|
+          unpack_gem_jars(root, DEFAULT_UNPACK_GLOBS)
+        end
+        gems.each do |gem|
+          unpack_gem_jars(gem.install_root(gem_home), gem.unpack_globs)
+        end
+      end
+    end
+
+    def unpack_gem_jars(installed_root, jar_globs)
+      jar_globs.each do |glob|
+        Dir[installed_root + glob].each do |jar|
+          trace "Unpacking #{jar}"
+          cmd = [
+            'jar',
+            'xf',
+            jar
+          ].join(' ')
+          trace cmd
+          out = %x[#{cmd} 2>&1]
+          if $? != 0
+            fail "jar extraction failed:\n#{out}"
+          else
+            trace out
+          end
+          FileUtils.rm_rf 'META-INF'
+        end
+      end
+    end
+
+    module GemProperties
+      attr_accessor :unpack_globs
+
+      ##
+      # If the gem is installed in the given gem home, this method
+      # gives the path to its expanded root under `{gem_home}/gems`.
+      def install_root(gem_home)
+        (gem_home + 'gems').children.detect { |p| p.to_s =~ /#{name}-#{version}/ }
+      end
+    end
+
     class FileSourcedGem
+      include GemProperties
+
       attr_accessor :filename
 
       def initialize(filename)
@@ -108,9 +181,26 @@ module BuildrGemjar
       def dependencies
         [(filename if File.exist?(filename))].compact
       end
+
+      def name
+        spec.name
+      end
+
+      def version
+        spec.version
+      end
+
+      def spec
+        require 'rubygems/specification'
+
+        @spec ||= YAML.load(`tar xOf '#{filename}' metadata.gz | gunzip`)
+      end
+      private :spec
     end
 
     class NamedGem
+      include GemProperties
+
       attr_accessor :name, :version
 
       def initialize(name, version)
@@ -160,8 +250,8 @@ module BuildrGemjar
     jruby = project.artifact(BuildrGemjar.jruby_artifact)
     project.packages.each do |pkg|
       if pkg.is_a?(GemjarTask)
-        directory pkg.gem_home
-        pkg.enhance [pkg.gem_home, jruby]
+        directory pkg.gem_home.to_s
+        pkg.enhance [pkg.gem_home.to_s, jruby]
         BuildrGemjar.jruby_complete_jar = jruby.to_s
       end
     end

data/lib/buildr-gemjar/version.rb

@@ -1,3 +1,3 @@
 module BuildrGemjar
-  VERSION = "1.0.2"
+  VERSION = '1.1.0'
 end

data/spec/buildr-gemjar_spec.rb

@@ -45,6 +45,58 @@ describe ":gemjar packaging" do
 
       actual_gems.collect { |g| g.kind }.should == [:named, :file, :named]
     end
+
+    describe ':unpack_jars' do
+      shared_examples_for 'a gem with unpack behavior' do
+        let(:gem) {
+          a = args
+          define('foo', :version => '1.0') {
+            package(:gemjar).with_gem(*a)
+          }
+          actual_gems.first
+        }
+
+        it 'defaults to true' do
+          gem.unpack_globs.should == ['lib/**/*.jar']
+        end
+
+        it 'interprets true as "lib/**/*.jar"' do
+          args.last[:unpack_jars] = true
+          gem.unpack_globs.should == ['lib/**/*.jar']
+        end
+
+        it 'interprets false as no globs' do
+          args.last[:unpack_jars] = false
+          gem.unpack_globs.should == []
+        end
+
+        it 'passes through an array' do
+          expected = %w(lib/shared/*.jar ext/**/*.jar)
+          args.last[:unpack_jars] = expected
+
+          gem.unpack_globs.should == expected
+        end
+
+        it 'wraps a single value into an array' do
+          expected = 'ext/**/*.jar'
+          args.last[:unpack_jars] = expected
+
+          gem.unpack_globs.should == [expected]
+        end
+      end
+
+      describe 'with a named gem' do
+        let(:args) { ['jruby-openssl', '0.7.5', {}] }
+
+        it_behaves_like 'a gem with unpack behavior'
+      end
+
+      describe 'with a file-sourced gem' do
+        let(:args) { [{ :file => 'snapshot.gem' }] }
+
+        it_behaves_like 'a gem with unpack behavior'
+      end
+    end
   end
 
   describe "sources" do
@@ -190,11 +242,27 @@ describe ":gemjar packaging" do
       File.exist?(path).should be_true
     end
 
+    def manifest_text_from(jarfile)
+      require 'zip/zipfilesystem'
+
+      Zip::ZipFile.open(jarfile) do |zfs|
+        zfs.file.read('META-INF/MANIFEST.MF')
+      end
+    end
+
+    it 'includes directly specified manifest properties' do
+      actual = test_package { |p|
+        p.with_gem('a').with :manifest => { 'Bundle-SymbolicName' => 'foo-bar' }
+      }
+
+      manifest_text_from(actual).should include("Bundle-SymbolicName: foo-bar")
+    end
+
     describe "with gems in GEM_PATH" do
       before do
         gem_path_entry = tmp('gem_path')
         system("GEM_HOME='#{gem_path_entry}' gem install --source 'file://#{repo_path}' --no-rdoc --no-ri -q a > '#{tmp('install_out')}'")
-        ENV['GEM_PATH'] = gem_path_entry
+        ENV['GEM_PATH'] = gem_path_entry.to_s
       end
 
       it "installs all dependencies, including ones in the GEM_PATH" do
@@ -202,6 +270,73 @@ describe ":gemjar packaging" do
           should be_a_jar_containing("specifications/a-1.0.gemspec")
       end
     end
+
+    describe 'with jars to unpack' do
+      shared_examples_for 'a gem including jars' do
+        let(:pkg) { test_package { |p| p.with_gem(*args).with :manifest => { 'Foo' => 'Bar' } } }
+
+        it 'unpacks jars under lib by default' do
+          pkg.should be_a_jar_containing('org/example/jr/lib.properties')
+        end
+
+        it 'does not unpack other jars by default' do
+          pkg.should_not be_a_jar_containing('org/example/jr/ext.properties')
+        end
+
+        describe 'with a glob' do
+          before do
+            args.last[:unpack_jars] = 'ext/**/*.jar'
+          end
+
+          it 'unpacks the requested jars' do
+            pkg.should be_a_jar_containing('org/example/jr/ext.properties')
+          end
+
+          it 'does not unpack other jars' do
+            pkg.should_not be_a_jar_containing('org/example/jr/lib.properties')
+          end
+        end
+
+        it 'unpacks everything for each glob' do
+          args.last[:unpack_jars] = ['ext/**/*.jar', 'lib/*.jar']
+          pkg.should be_a_jar_containing(
+            'org/example/jr/ext.properties', 'org/example/jr/lib.properties')
+        end
+
+        it 'unpacks nothing when :unpack_jars is false' do
+          args.last[:unpack_jars] = false
+          pkg.should_not be_a_jar_containing('org')
+        end
+
+        it 'does not include the manifest from unpacked jars' do
+          manifest_text_from(pkg).should_not include('Main-Class')
+        end
+      end
+
+      describe 'a named gem' do
+        let(:args) { ['jr', '1.0', {}] }
+
+        it_behaves_like 'a gem including jars'
+      end
+
+      describe 'a file-sourced gem' do
+        let(:args) { [{ :file => (repo_path + 'gems' + 'jr-1.0-java.gem').to_s}] }
+
+        it_behaves_like 'a gem including jars'
+      end
+
+      describe 'with jars in dependencies' do
+        let(:pkg) { test_package { |p| p.with_gem('jr-user') } }
+
+        it 'unpacks jars under lib' do
+          pkg.should be_a_jar_containing('org/example/jr/lib.properties')
+        end
+
+        it 'does not unpack other jars' do
+          pkg.should_not be_a_jar_containing('org/example/jr/ext.properties')
+        end
+      end
+    end
   end
 end
 

data/spec/repo_builder.rb

@@ -23,26 +23,70 @@ module BuildrGemjar
         create_gem "jr", "1.0" do |s|
           s.platform = 'java'
           s.add_dependency "b"
+          s.files = [
+            create_jar('lib/jr.jar', %w(org/example/jr/lib.properties), 'org.example.jar.Main'),
+            create_jar('ext/jr.jar', %w(org/example/jr/ext.properties))
+          ]
+        end
+
+        create_gem 'jr-user' do |s|
+          s.add_dependency 'jr'
         end
 
         `gem generate_index -q --directory '#{repo_path}'`
       end
 
       def create_gem(name, version='1.0', opts={})
-        spec = Gem::Specification.new do |s|
-          s.name    = name
-          s.version = version
-          s.summary = "A fake #{name}"
-        end
-        yield spec if block_given?
-
         target = opts[:path] || repo_path.join("gems")
         mkdir_p target
         cd target do
+          spec = Gem::Specification.new do |s|
+            s.name    = name
+            s.version = version
+            s.summary = "A fake #{name}"
+          end
+          yield spec if block_given?
+
+          Gem.configuration.verbose = false
           Gem::Builder.new(spec).build
+          Gem.configuration.verbose = true
+
+          spec.files.each do |f|
+            rm_rf f
+          end
         end
       end
 
+      # main_class is an option because it's a cheap way to get
+      # something specific to this jar into the manifest
+      def create_jar(path, filenames, main_class=nil)
+        mkdir File.dirname(path)
+
+        staging = tmp('jar-staging')
+        staging.mkpath
+        filenames.each do |fn|
+          pn = staging + fn
+          pn.dirname.mkpath
+          pn.open('w') { }
+        end
+
+        cmd = [
+          'jar',
+          main_class ? 'cfe' : 'cf',
+          "'#{path}'",
+          main_class,
+          "-C",
+          "'#{staging}'",
+          '.'
+        ].compact.join(' ')
+
+        out = %x[#{cmd} 2>&1]
+        fail "create_jar failed:\n#{out}" unless $? == 0
+
+        staging.rmtree
+        path
+      end
+
       def tmp(*path)
         Pathname.new(File.expand_path("../../tmp", __FILE__)).join(*path)
       end

metadata

@@ -2,12 +2,12 @@
 name: buildr-gemjar
 version: !ruby/object:Gem::Version 
   hash: 19
-  prerelease: 
+  prerelease: false
   segments: 
   - 1
+  - 1
   - 0
-  - 2
-  version: 1.0.2
+  version: 1.1.0
 platform: ruby
 authors: 
 - Rhett Sutphin
@@ -15,13 +15,11 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-03-15 00:00:00 -05:00
+date: 2012-02-09 00:00:00 -06:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
-  name: braid
-  prerelease: false
-  requirement: &id001 !ruby/object:Gem::Requirement 
+  version_requirements: &id001 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ~>
@@ -31,12 +29,12 @@ dependencies:
         - 0
         - 6
         version: "0.6"
+  requirement: *id001
   type: :development
-  version_requirements: *id001
-- !ruby/object:Gem::Dependency 
-  name: ci_reporter
+  name: braid
   prerelease: false
-  requirement: &id002 !ruby/object:Gem::Requirement 
+- !ruby/object:Gem::Dependency 
+  version_requirements: &id002 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ~>
@@ -46,12 +44,12 @@ dependencies:
         - 1
         - 6
         version: "1.6"
+  requirement: *id002
   type: :development
-  version_requirements: *id002
-- !ruby/object:Gem::Dependency 
-  name: rake
+  name: ci_reporter
   prerelease: false
-  requirement: &id003 !ruby/object:Gem::Requirement 
+- !ruby/object:Gem::Dependency 
+  version_requirements: &id003 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - "="
@@ -62,12 +60,12 @@ dependencies:
         - 8
         - 7
         version: 0.8.7
+  requirement: *id003
   type: :development
-  version_requirements: *id003
-- !ruby/object:Gem::Dependency 
-  name: builder
+  name: rake
   prerelease: false
-  requirement: &id004 !ruby/object:Gem::Requirement 
+- !ruby/object:Gem::Dependency 
+  version_requirements: &id004 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - "="
@@ -78,12 +76,12 @@ dependencies:
         - 1
         - 2
         version: 2.1.2
+  requirement: *id004
   type: :development
-  version_requirements: *id004
-- !ruby/object:Gem::Dependency 
-  name: net-ssh
+  name: builder
   prerelease: false
-  requirement: &id005 !ruby/object:Gem::Requirement 
+- !ruby/object:Gem::Dependency 
+  version_requirements: &id005 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - "="
@@ -94,12 +92,12 @@ dependencies:
         - 0
         - 23
         version: 2.0.23
+  requirement: *id005
   type: :development
-  version_requirements: *id005
-- !ruby/object:Gem::Dependency 
-  name: net-sftp
+  name: net-ssh
   prerelease: false
-  requirement: &id006 !ruby/object:Gem::Requirement 
+- !ruby/object:Gem::Dependency 
+  version_requirements: &id006 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - "="
@@ -110,12 +108,12 @@ dependencies:
         - 0
         - 4
         version: 2.0.4
+  requirement: *id006
   type: :development
-  version_requirements: *id006
-- !ruby/object:Gem::Dependency 
-  name: rubyzip
+  name: net-sftp
   prerelease: false
-  requirement: &id007 !ruby/object:Gem::Requirement 
+- !ruby/object:Gem::Dependency 
+  version_requirements: &id007 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - "="
@@ -126,12 +124,12 @@ dependencies:
         - 9
         - 4
         version: 0.9.4
+  requirement: *id007
   type: :development
-  version_requirements: *id007
-- !ruby/object:Gem::Dependency 
-  name: highline
+  name: rubyzip
   prerelease: false
-  requirement: &id008 !ruby/object:Gem::Requirement 
+- !ruby/object:Gem::Dependency 
+  version_requirements: &id008 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - "="
@@ -142,12 +140,12 @@ dependencies:
         - 5
         - 1
         version: 1.5.1
+  requirement: *id008
   type: :development
-  version_requirements: *id008
-- !ruby/object:Gem::Dependency 
-  name: json_pure
+  name: highline
   prerelease: false
-  requirement: &id009 !ruby/object:Gem::Requirement 
+- !ruby/object:Gem::Dependency 
+  version_requirements: &id009 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - "="
@@ -158,12 +156,12 @@ dependencies:
         - 4
         - 3
         version: 1.4.3
+  requirement: *id009
   type: :development
-  version_requirements: *id009
-- !ruby/object:Gem::Dependency 
-  name: rubyforge
+  name: json_pure
   prerelease: false
-  requirement: &id010 !ruby/object:Gem::Requirement 
+- !ruby/object:Gem::Dependency 
+  version_requirements: &id010 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - "="
@@ -174,12 +172,12 @@ dependencies:
         - 0
         - 3
         version: 2.0.3
+  requirement: *id010
   type: :development
-  version_requirements: *id010
-- !ruby/object:Gem::Dependency 
-  name: hoe
+  name: rubyforge
   prerelease: false
-  requirement: &id011 !ruby/object:Gem::Requirement 
+- !ruby/object:Gem::Dependency 
+  version_requirements: &id011 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - "="
@@ -190,12 +188,12 @@ dependencies:
         - 3
         - 3
         version: 2.3.3
+  requirement: *id011
   type: :development
-  version_requirements: *id011
-- !ruby/object:Gem::Dependency 
-  name: rjb
+  name: hoe
   prerelease: false
-  requirement: &id012 !ruby/object:Gem::Requirement 
+- !ruby/object:Gem::Dependency 
+  version_requirements: &id012 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - "="
@@ -206,12 +204,12 @@ dependencies:
         - 3
         - 3
         version: 1.3.3
+  requirement: *id012
   type: :development
-  version_requirements: *id012
-- !ruby/object:Gem::Dependency 
-  name: atoulme-Antwrap
+  name: rjb
   prerelease: false
-  requirement: &id013 !ruby/object:Gem::Requirement 
+- !ruby/object:Gem::Dependency 
+  version_requirements: &id013 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - "="
@@ -222,12 +220,12 @@ dependencies:
         - 7
         - 1
         version: 0.7.1
+  requirement: *id013
   type: :development
-  version_requirements: *id013
-- !ruby/object:Gem::Dependency 
-  name: rspec
+  name: atoulme-Antwrap
   prerelease: false
-  requirement: &id014 !ruby/object:Gem::Requirement 
+- !ruby/object:Gem::Dependency 
+  version_requirements: &id014 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ~>
@@ -238,12 +236,12 @@ dependencies:
         - 1
         - 0
         version: 2.1.0
+  requirement: *id014
   type: :development
-  version_requirements: *id014
-- !ruby/object:Gem::Dependency 
-  name: xml-simple
+  name: rspec
   prerelease: false
-  requirement: &id015 !ruby/object:Gem::Requirement 
+- !ruby/object:Gem::Dependency 
+  version_requirements: &id015 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - "="
@@ -254,12 +252,12 @@ dependencies:
         - 0
         - 12
         version: 1.0.12
+  requirement: *id015
   type: :development
-  version_requirements: *id015
-- !ruby/object:Gem::Dependency 
-  name: minitar
+  name: xml-simple
   prerelease: false
-  requirement: &id016 !ruby/object:Gem::Requirement 
+- !ruby/object:Gem::Dependency 
+  version_requirements: &id016 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - "="
@@ -270,8 +268,10 @@ dependencies:
         - 5
         - 3
         version: 0.5.3
+  requirement: *id016
   type: :development
-  version_requirements: *id016
+  name: minitar
+  prerelease: false
 description: 
 email: 
 - rhett@detailedbalance.net
@@ -563,7 +563,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements: []
 
 rubyforge_project: buildr-gemjar
-rubygems_version: 1.5.2
+rubygems_version: 1.3.7
 signing_key: 
 specification_version: 3
 summary: Provides buildr support for packaging gems in a JAR for JRuby