jbundler 0.7.4 → 0.8.0.pre

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: dc4286a98195cdf083ea85bb0588b4b83dc1abb9
-  data.tar.gz: 55ffe445eb0d1ce2b18eecfac24058a5fadb70a1
+  metadata.gz: 5ac6a9fb5c574bba0b316c3a86a7779371a334cc
+  data.tar.gz: 750f10fa9bb8a767a3d0b850318bf57132c9f3cc
 SHA512:
-  metadata.gz: 819d359c43ce3a44cbdb055f8aa94daba3b5b8456bf799e90df1748c9f91da40017c3d4daea02462acd4e26d542a220f5dec38945c1c80028ee9ef29bb4b2066
-  data.tar.gz: 7c5085c964ed472f9de4915a07d71093d4556d6f4d15b043b7de719c81a3a1c098a49561b572264be99f033252a180f72d55ee35fd8d109643252231958edc98
+  metadata.gz: 55749212e56d0cb339dc95dca63ac6c2454dfbdeb3b5f4f6105e5c5183fc5fdb0218f5e3e08cf1ba0b9255038d1fc29c3e8bce5cfeaa90568f9fb609fb4ea25c
+  data.tar.gz: ff954ccee92c476835a455150ab6fd84b1aebef43f61c5c153614a537c3fab882e9d32216ba2531af8423ee8a840a9e02b47fe36005c27647a1f6cb04c068b78

data/Gemfile.lock

@@ -3,8 +3,8 @@ PATH
   specs:
     jbundler (0.7.3)
       bundler (~> 1.5)
-      jar-dependencies (~> 0.1.8)
-      maven-tools (~> 1.0.6)
+      jar-dependencies (~> 0.1.11)
+      maven-tools (~> 1.0.8)
       ruby-maven (>= 3.1.1.0.6, < 3.1.2)
 
 GEM
@@ -20,7 +20,7 @@ GEM
       thread_safe (~> 0.3, >= 0.3.1)
     equalizer (0.0.9)
     ice_nine (0.11.1)
-    jar-dependencies (0.1.8)
+    jar-dependencies (0.1.11)
     maven-tools (1.0.8)
       virtus (~> 1.0)
     minitest (5.5.1)

data/Gemfile.lock~

@@ -0,0 +1,46 @@
+PATH
+  remote: .
+  specs:
+    jbundler (0.7.3)
+      bundler (~> 1.5)
+      jar-dependencies (~> 0.1.8)
+      maven-tools (~> 1.0.6)
+      ruby-maven (>= 3.1.1.0.6, < 3.1.2)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    axiom-types (0.1.1)
+      descendants_tracker (~> 0.0.4)
+      ice_nine (~> 0.11.0)
+      thread_safe (~> 0.3, >= 0.3.1)
+    coercible (1.0.0)
+      descendants_tracker (~> 0.0.1)
+    descendants_tracker (0.0.4)
+      thread_safe (~> 0.3, >= 0.3.1)
+    equalizer (0.0.9)
+    ice_nine (0.11.1)
+    jar-dependencies (0.1.8)
+    maven-tools (1.0.8)
+      virtus (~> 1.0)
+    minitest (5.5.1)
+    rake (10.4.2)
+    ruby-maven (3.1.1.0.11)
+      maven-tools (~> 1.0.8)
+      ruby-maven-libs (= 3.1.1)
+    ruby-maven-libs (3.1.1)
+    thread_safe (0.3.5-java)
+    virtus (1.0.4)
+      axiom-types (~> 0.1)
+      coercible (~> 1.0)
+      descendants_tracker (~> 0.0, >= 0.0.3)
+      equalizer (~> 0.0, >= 0.0.9)
+
+PLATFORMS
+  java
+
+DEPENDENCIES
+  copyright-header (= 1.0.8)
+  jbundler!
+  minitest (~> 5.3)
+  rake (~> 10.0)

data/Readme.md

@@ -7,9 +7,13 @@ manage jar dependencies similar than **bundler** manages gem dependencies.
 * the DSL mimics the one from bundler
 * you can use maven like version declaration or rubygems/bundler like version ranges
 * it locks down the jar versions inside "Jarfile.lock"
-* you can declare jar dependency within a rubygems using the requirements directive of the gem specification. jbundler will include those jar dependencies into its classpath
-* on the first run everything get resolved, any further run just the setup of classpath is done (without any maven involved)
-* it integrates nicely with bundler when Bundler.require is used (like Rails does it)
+* you can declare jar dependency within a gem using the requirements directive of the gem specification. jbundler will include those jar dependencies into its classpath
+
+the difference to **bundler**
+
+* it is just a development gem - no need for it during runtime. just add ```Jars.require_jars_lock!``` to your code and for older JRuby add ```gem 'jar-dependencies', '~> 0.1.11'``` as runtime dependency.
+* you need to run ```bundle install``` first if any of the gems has jar dependencies.
+* all one command ```jbundle```, see ```jbundle --help``` on the possible options and how to update a single jar, etc.
 
 ## get started
 
@@ -19,91 +23,28 @@ install JBundler with
 	
 first create a **Jarfile**, something like
     
-	jar 'org.yaml:snakeyaml'
+	jar 'org.yaml:snakeyaml', '1.14'
 	jar 'org.slf4j:slf4j-simple', '>1.1'
 
-### together with Bundler
-
-just add it as **first** entry in your *Gemfile* 
-
-```gem 'jbundler'```
-
-and now install the bundle both **gems and jars**
-
-    jbundle install
-
-#### Building
-
-building the jar
-```rake jar```
-
-building the gem
-```rake build```
-
-running the junit test
-```rake junit```
-
-running the minitest
-```rake minitest```
-
-make sure you use jruby ;)
-
-#### Gemfile and Jarfile
-
-if there is only a **Gemfile** and no Jarfile **jbundler** handles all the declared [jar dependencies of gems](https://github.com/mkristian/jbundler/wiki/Build) as well all the jars from the Jarfile. it will only look into gems which bundler loaded.
-
-### without Bundler - Jarfile only
-
-requiring **jbundler** will trigger the classpath setup
-
-```require 'jbundler'```
-
-this you can use with **rubygems** or **isolate** or . . .
-
 ### Jarfile
 
 more info about the **[Jarfile](https://github.com/torquebox/maven-tools/wiki/Jarfile)** and about [versions](https://github.com/torquebox/maven-tools/wiki/Versions).
 
 for adding a maven repository see [Jarfile](https://github.com/torquebox/maven-tools/wiki/Jarfile).
-    
-## console ##
-
-like bundler there is a console which sets up the gems (if there is Gemfile otherwise that part get skipped) and sets up the classloader:
 
-    jbundle console
+# Building the jbundler gem
 
-further it adds two methods to the root level:
+running the integration test
 
-    > jars
+    ./mvnw verify
 
-to list the loaded jars and
+building the gem (see ./pkg)
 
-    > jar 'org.yaml:snakeyaml'
+    ./mvnw package -Dinvoker.skip
 
-using the same syntax as use in the **Jarfile**. there are limitations with such a lazy jar loading but it is very convenient when trying out things.
+or just
 
-## lazy jar loading ##
-
-    require 'jbundler/lazy'
-	include JBundler::Lazy
-	
-will offer the same `jar`/`jars` method than you have inside the console.
-
-# extra commands
-
-## jbundler tree
-
-shows the dependency tree - without the locked version. i.e. an install or update would result in the shown version.
-
-with locked down versions that tree is more hint then a real picture of the situation !!
-
-## jruby executable -b start.rb
-
-will create an executable jar file using the given ruby script as bootstrap script. it will include the comple jruby and all the dependent jars as well all the gems packed into it as well. the
-
-     jruby '1.7.4'
-
-declaration in the *Jarfile* will determinate the jruby version to use for the executable jar.
+    gem build jbundler.gemspec
 
 ## example ##
 
@@ -117,37 +58,8 @@ execute *src/example/my_project/info.rb* to see it in action:
 
 ## limitations ##
 
-update of single artifacts is not possible.
-
 since the version resolution happens in two steps - first the gems then the jars/poms - it is possible in case of a failure that there is a valid gems/jars version resolution which satisfies all version contraints. so there is plenty of space for improvements (like maven could resolve the gems as well, etc)
 
-**Jarfile** is **not** a DSL but it could use a ruby DSL to read the data (any contribution welcome).
-
-jbundler does not completely obey the **$HOME/.m2/settings.xml** from maven where you usually declare proxies, mirrors, etc. see [jbundler configuration](https://github.com/mkristian/jbundler/wiki/Configuration) for what is already possible.
-
-## RVM and/or rubygems-bundler ##
-
-some tests did not work with RVM and/or rubygems-bundler - there are some weird classloader issue popping up. there is a problem with the way the classloader gets setup. but a manual jruby installion or using rbenv is just working fine.
-
-those issue might pop up with ```jbundle tree``` and ```jbundle executable```
-
-## running tests ##
-
-* ```rake``` will execute all tests without integration tests
-* ```rake all``` will execute all tests
-* ```rake minitest``` runs the minitest specs
-* ```rake integration``` runs the integration tests where poms are used (might fail due to hardcoded absolute paths)
-* ```rake junit``` runs the junit java tests
-* ```jruby spec/abc_spec.rb``` runs that given tests (just use the right file)
-* ```mvn test``` will also run all tests
-* ```rmvn test`` same as ```mvn test```
-
-## update ##
-
-update of a single artifact is not possible (yet). but to update the whole set of artifacts just delete the lockfile *Jarfile.lock*
-
-if jbundler sees that **Gemfile.lock** or **Jarfile** is newer then the **.jbundler/classpath.rb** file then jbundler tries to gracefully upgrade towards the changes.
-
 # special thanks #
 
 the whole project actually started with a controversial discussion on a [pull request on bundler](https://github.com/carlhuda/bundler/pull/1683). this very same pull request were the starting point of that project here. probably by now there is no much left of the original code but many thanks to [ANithian](https://github.com/ANithian) for given the seed of that project.

data/bin/jbundle

@@ -1,70 +1,51 @@
 #!/usr/bin/env ruby
-if ARGV[0] == 'help'
-
-  # ensure we use the right version
-  gem 'ruby-maven', '>=3.1.0'
-
-  require 'jbundler/cli'
-
-  JBundler::Cli.start
-
-else
-
-  if ARGV == [] || ARGV.all?{ |a| a.match( /^-/ ) }
-    ARGV.unshift 'install'
+require 'jbundler'
+require 'optparse' 
+options = {}  
+optparse = OptionParser.new do|opts| 
+
+  opts.banner = "Usage: jbundle [options]"
+
+  opts.separator ''
+  opts.separator '* load jars: `Jars.require_jars_lock!`'
+  opts.separator '* classpath features: see `Jars::Classpath'
+  opts.separator ''
+  opts.separator 'NOTE: JBundler is not need during runtime !'
+  opts.separator ''
+  opts.separator 'Options:'
+  opts.separator ''
+
+  opts.on( '-v', '--verbose', 'Output more information' ) do |t|
+    options[:verbose] = t
   end
 
-  if ARGV[0] == 'console'
-    # ensure we use the right version
-    gem 'ruby-maven', '>=3.1.0'
-
-    require 'irb'
-    require 'jbundler'
-    require 'jbundler/lazy'
-    include JBundler::Lazy
-
-    ARGV.shift
-    require 'jbundler'
-    if defined? JBUNDLER_CLASSPATH
-      warn 'Jarfile dependencies loaded'
-    else
-      warn 'Could not locate a Jarfile'
-    end
+  opts.on( '-d', '--debug', 'Output debug information' ) do |t|
+    options[:debug] = t
+  end
 
-    IRB.start
+  opts.on( '-f', '--force', 'Force creation of Jars.lock' ) do |t|
+    options[:force] = t
+  end
 
-  else
-    if ['lock_down', 'install', 'update', 'show'].member?( ARGV[0] )
+  opts.on( '-t', '--tree', 'Show dependency tree' ) do |t|
+    options[:tree] = t
+  end
 
-      is_lock_down = ARGV.delete( 'lock_down' )
-      is_vendor = ARGV.delete( '--vendor' ) 
-      is_debug = ARGV.delete( '--debug' )
-      ARGV.delete( '--skip-vendor' )
-      ARGV.delete( '--skip-debug' )
-      ARGV.delete( '--skip-verbose' )
-      
-      # HACK get the module-class hierachy in place
-      gem 'bundler'
-      if Gem.loaded_specs['bundler'].version >= Gem::Version.new('1.9.0')
-        module Bundler
-          class Thor
-            module Actions
-            end
-          end
-        end
-      end
-      load Gem.bin_path('bundler', 'bundle') 
-      
-      ARGV.insert( 0, 'lock_down' ) if is_lock_down
-      ARGV.insert( 1, '--debug' ) if is_debug
-      ARGV.insert( 1, '--vendor' ) if is_vendor
-    end
+  opts.on( '-u', '--update JAR_COORDINATE', 'Resolves given dependency and use  latest version' ) do |u|
+    options[:update] = u
+  end
 
-    # ensure we use the right version
-    gem 'ruby-maven', '>=3.1.0'
-    
-    require 'jbundler/cli'
-    JBundler::Cli.start
+  opts.on( '--vendor-dir DIRECTORY', 'Vendor directory where to copy the installed jars.', 'add this directory to $LOAD_PATH or set JARS_HOME respectively.' ) do |dir|
+    options[:vendor_dir] = dir
   end
 
+  opts.on( '-h', '--help', 'Display this screen' ) do
+    puts opts
+    exit
+  end
 end
+optparse.parse!
+
+require 'jbundler/executor'
+mvn = JBundler::Executor.new( options[:debug], options[:verbose] )
+mvn.lock_down( options )

data/lib/jbundler/executor.rb

@@ -0,0 +1,107 @@
+require 'maven/ruby/maven'
+require 'maven/tools/artifact'
+require 'maven/tools/gemspec_dependencies'
+require 'fileutils'
+require 'jar_dependencies'
+module JBundler
+  
+  class Executor
+
+    attr_reader :debug, :verbose
+
+    def initialize( debug = false, verbose = false )
+      @debug = debug
+      @verbose = verbose
+    end
+
+    def maven_new
+      m = Maven::Ruby::Maven.new
+      m.property( 'jbundler.basedir', File.expand_path( basedir ) )
+      m.property( 'jbundler.jarfile', File.expand_path( JBundler.jarfile ) )
+      m.property( 'verbose', (debug || verbose) == true )
+      if debug
+        m.options[ '-X' ] = nil
+      elsif verbose
+        m.options[ '-e' ] = nil
+      else
+        m.options[ '-q' ] = nil
+      end
+      m.verbose = debug
+      attach_jar_coordinates( m )
+      m
+    end
+    private :maven_new
+
+    def maven
+      @maven ||= maven_new
+    end
+
+    def basedir
+      File.expand_path( '.' )
+    end
+
+    def exec( *args )
+      maven.options[ '-f' ] = File.expand_path( '../pom.rb', __FILE__ )
+      maven.exec( *args )
+    end
+
+    def attach_jar_coordinates( maven )
+      load_path = $LOAD_PATH.dup
+      require 'bundler/setup'
+      done = []
+      index = 0
+      Gem.loaded_specs.each do |name, spec|
+        # TODO get rid of this somehow
+        deps = Maven::Tools::GemspecDependencies.new( spec )
+        deps.java_dependency_artifacts.each do |a|
+          unless done.include? a.key
+            maven.property( "jbundler.jars.#{index}", a.to_s )
+            index += 1
+            done << a.key
+          end
+        end
+      end
+    rescue LoadError
+      warn "no bundler found - ignore Gemfile if exists"
+    ensure
+      $LOAD_PATH.replace( load_path )
+    end
+
+    def lock_down( options = {} )
+      vendor_dir = File.expand_path( options[ :vendor_dir ] ) if options[ :vendor_dir ]
+      out = File.expand_path( '.jbundler.output' )
+      tree = File.expand_path( '.jbundler.tree' )
+      maven.property( 'jars.outputFile', out )
+      maven.property( 'maven.repo.local', Jars.home )
+      maven.property( 'jars.home', vendor_dir ) if vendor_dir
+      # TODO move into jar-dependencies
+      maven.property( 'jars.lock', File.expand_path( Jars.lock ) )
+      maven.property( 'jars.force', options[ :force ] == true )
+      maven.property( 'jars.update', options[ :update ] ) if options[ :update ]
+
+      args = [ 'gem:jars-lock' ]
+      if options[ :tree ]
+        args += [ 'dependency:tree', '-P -gemfile.lock', '-DoutputFile=' + tree ]
+      end
+
+      puts
+      puts '-- jar root dependencies --'
+      puts
+      status = exec( *args )
+      exit 1 unless status
+      if File.exists?( tree )
+        puts
+        puts '-- jar dependency tree --'
+        puts
+        puts File.read( tree )
+        puts
+      end
+      puts
+      puts File.read( out ).gsub( /#{File.dirname(out)}\//, '' )
+      puts
+    ensure
+      FileUtils.rm_f out
+      FileUtils.rm_f tree
+    end
+  end
+end

data/lib/jbundler/pom.rb

@@ -1,153 +1,35 @@
-#
-# Copyright (C) 2013 Christian Meier
-#
-# 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.
-#
-require 'fileutils'
-require 'tempfile'
-require 'maven/tools/coordinate'
-require 'securerandom'
+bdir = java.lang.System.getProperty( "jbundler.basedir" )
+jfile = java.lang.System.getProperty( "jbundler.jarfile" )
 
-module JBundler
-
-  class Pom
-
-    include Maven::Tools::Coordinate
-
-    private
-    
-    def temp_dir
-      @temp_dir ||=
-        begin
-          # on travis the mktmpdir failed
-          d = Dir.mktmpdir rescue FileUtils.mkdir( ".tmp" + SecureRandom.hex( 12) ).first
-          at_exit { FileUtils.rm_rf(d.dup) }
-          # for jruby-1.7.4 1.8 mode add expand_path
-          File.expand_path( d )
-        end
-    end
-      
-    def writeElement(xmlWriter,element_name, text)
-      xmlWriter.writeStartElement(element_name.to_java)
-      xmlWriter.writeCharacters(text.to_java)
-      xmlWriter.writeEndElement        
-    end
-    
-    def java_imports
-      %w(
-           javax.xml.stream.XMLStreamWriter
-           javax.xml.stream.XMLOutputFactory
-           javax.xml.stream.XMLStreamException
-          ).each {|i| java_import i }
-    end
-
-    GROUP_ID = 'ruby.bundler'
-
-    def start_write_pom( out, name, version, packaging )
-      outputFactory = XMLOutputFactory.newFactory()
-      xmlStreamWriter = outputFactory.createXMLStreamWriter( out )
-
-      xmlStreamWriter.writeStartDocument
-      xmlStreamWriter.writeStartElement("project")
-      
-      writeElement(xmlStreamWriter,"modelVersion","4.0.0")
-      writeElement(xmlStreamWriter,"groupId", GROUP_ID)
-      writeElement(xmlStreamWriter,"artifactId", name)
-      writeElement(xmlStreamWriter,"version", version.to_s.to_java)
-      writeElement(xmlStreamWriter,"packaging", packaging) if packaging  
-      xmlStreamWriter
-    end
-
-    def to_classifier_version( coords )
-      if coords.size == 4
-        [ nil, coords[3] ]
-      else
-        [ coords[3], coords[4] ]
-      end
-    end
-
-    def write_dep( xmlStreamWriter, coord )
-      coords = coord.split(/:/)
-      group_id = coords[0]
-      artifact_id = coords[1]
-      extension = coords[2]
-      classifier, version = to_classifier_version( coords )
-      
-      xmlStreamWriter.writeStartElement("dependency".to_java)
-      writeElement(xmlStreamWriter,"groupId", group_id)
-      writeElement(xmlStreamWriter,"artifactId", artifact_id)
-      writeElement(xmlStreamWriter,"version", version)
-      
-      writeElement(xmlStreamWriter,"type", extension) if extension != 'jar'
-      writeElement(xmlStreamWriter,"classifier", classifier) if classifier
-      xmlStreamWriter.writeEndElement #dependency
-    end
-
-    def write_dependencies( xmlStreamWriter, deps )
-      xmlStreamWriter.writeStartElement("dependencies".to_java)
-      
-      deps.each do |line|
-        coord = to_coordinate(line)
-        write_dep( xmlStreamWriter, coord ) if coord
-      end
-
-      xmlStreamWriter.writeEndElement #dependencies
-    end
-
-    def end_write_pom( xmlStreamWriter )
-      xmlStreamWriter.writeEndElement #project
-      
-      xmlStreamWriter.writeEndDocument
-      xmlStreamWriter.close
-    end
-
-    public
-    
-    def coordinate
-      @coord ||= "#{GROUP_ID}:#{@name}:#{@packaging}:#{@version}"
-    end
-    
-    def file
-      @file
-    end
+basedir( bdir )
+if basedir != bdir
+  # older maven-tools needs this
+  self.instance_variable_set( :@basedir, bdir )
+end
 
-    def initialize(name, version, deps, packaging = nil)
-      unless defined? XMLOutputFactory
-        java_imports
-      end
+( 0..10000 ).each do |i|
+  coord = java.lang.System.getProperty( "jbundler.jars.#{i}" )
+  break unless coord
+  artifact = Maven::Tools::Artifact.from_coordinate( coord.to_s )
+  # HACK around broken maven-tools
+  if artifact.exclusions
+    ex = artifact.classifier[1..-1] + ':' +  artifact.exclusions.join(':')
+    artifact.classifier = nil
+    artifact.exclusions = ex.split /,/
+  end
+  dependency_artifact( artifact ) 
+end
 
-      @name = name
-      @packaging = packaging || 'jar'
-      @version = version
+jarfile( jfile )
 
-      @file = File.join(temp_dir, 'pom.xml')
+properties( 'project.build.sourceEncoding' => 'utf-8' )
 
-      out = java.io.BufferedOutputStream.new( java.io.FileOutputStream.new( @file.to_java ) )
+plugin_repository :id => 'sonatype-snapshots', :url => 'https://oss.sonatype.org/content/repositories/snapshots'
+jruby_plugin :gem, '1.0.10-SNAPSHOT'
 
-      xmlStreamWriter = start_write_pom( out, name, version, packaging )
-      
-      write_dependencies( xmlStreamWriter, deps )
+plugin :dependency, '2.8'
 
-      end_write_pom( xmlStreamWriter )
-      
-    ensure
-      out.close
-    end
-    
-  end
+# some output
+model.dependencies.each do |d|
+  puts "      " + d.group_id + ':' + d.artifact_id + (d.classifier ? ":" + d.classifier : "" ) + ":" + d.version + ':' + (d.scope || 'compile')
 end