jar-dependencies 0.0.5 → 0.0.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 9af7f3df159b3a9eb53f8af55f533107b73bc88d
-  data.tar.gz: bac89ca7cf7f7db5d2e2c5f14c153100dd8eb87f
+  metadata.gz: 1ef94c824badc66c5d18e6e2795e59cde096da4b
+  data.tar.gz: 399a2d77b39d6f58304d1b341566efd493b1f883
 SHA512:
-  metadata.gz: 8a3e4898522d92e63d8088ffdd32e5e4143061078ab7feef26f3c98281f6f3a0a3f72c4bdce6c5c39e34e7ffce14a954ea0a44422aa74e5decd854ffe0c0cce9
-  data.tar.gz: 47b2c9bf2e6a8fda74c3a6baeadd96284d022da54dbc36cbf1477e4017f4a899b8fa3553d69162810cd55cd640cd202a341d5033c74899f6ffb009c6238ba8f7
+  metadata.gz: aca337598e947a4d0c95b25f2b10378e9472aef02bd86c881d6a88b3166fd56b93bf61e902065dbeec19b32dedb1cc92110efafb279c23f7d722420003befbaa
+  data.tar.gz: def85fcc93e6fbc41ec7837941842f083d8c43266438dda1d8d375b038e5a2add5bac0ec068cfcd0451142adb8c50620864ce0308d568c3a8ca09974e145fed1

data/Readme.md

@@ -5,22 +5,50 @@
 
 add gem dependencies for jar files to ruby gems.
 
-## features ##
+## getting control back over your jar ##
 
-    * vendors jar dependencies during installion of the gem
-	* jar dependencies are declared in the gemspec of the gem
-	* jar declaration uses the same notation as jbundler
-	* transitive jar dependencies will be resolved as well using (ruby-)maven
-	* when there are two gems with different versions of the same jar dependency an warning will be given and the first version wins, i.e. **only one** version of the a library inside the jruby-classloader
-	* it hooks into gem, i.e. once the jar-dependency gem is installed the feature can be used by any gem
-	* offer 'bundle-with-jars' command which hooks the jar_installer into rubytems before delegating all arguments to bundler
-	* it integrates with an existing maven local repository and obeys the maven setup in ~/.m2/settings.xml, like mirrors, proxieds, etc
+jar dependencies are declared in the gemspec of the gem using the same notation as <https://github.com/mkristian/jbundler>.
+
+when using ```require_jar``` to load the jar into JRuby's classloader then an version conflict will be detected and only **ONE** jar gets loaded. jbundler allows to select the version suitable for you application.
+
+most maven-artifact do **NOT** use versions ranges but depends pick a version. then jbundler can always **overwrite** any such version.
+
+## vendoring your jars before packing the jar ##
+
+add to your Rakefile following:
+
+    require 'jar_installer'
+    task :install_jars do
+      Jars::JarInstaller.vendor_jars
+    end
+
+which will install download the dependent jars into **JARS_HOME** and creats a file **lib/my_gem_jars.rb** which is just an enumeration of ```require_jars``` statements to load all the jars. the **vendor_jars** will copy them into the **lib** directory of the gem.
+
+the location where jars are cached is per default **$HOME/.m2/repository** the same default as maven has to cache the jar-artifacts. it respects **$HOME/.m2/settings.xml** from maven with all its mirror and other settings or the environment variable **JARS_HOME**.
+
+IMPORTANT: make sure that jar-dependencies is only a **development dependency** of your gem. if it is a runtime dependencies the require_jars file will be overwritten during installation.
+
+## reduce the download and reuse the jars from maven local repository ##
+
+if you do not vendor the jars into gem then the **jar-dependency** gem can vendor them when you install the gem. just skip use **Jars::JarInstaller.install_jars** from the above rake tasks.
+
+until JRuby itself comes with this jar-dependencies as default gem, for this feature to work you need to install the **jar-dependencies** gem first and for bundler you need to use the **bundle-with-jars** command :(
+
+IMPORTANT: make sure that jar-dependencies is a **runtime dependency** of your gem so the require_jars file will be overwritten during installation with the "correct" versions of the jars.
+
+## for development you do not need to vendor the jars at all ##
+
+just set an environment variable
+
+    export JARS_VENDOR=false
+
+this tells the jar_installer not vendor any jars but only create the file with the ```require_jar``` statements. this ```require_jars``` method will find the jar inside the maven local repository and loads it from there.
 
 ## some drawbacks ##
 
     * first you need to install the jar-dependency gem with its development dependencies installed (then ruby-maven gets installed as well)
-	* bundler does not install the jar-dependencies
-	* gems need an extra dependency on jar-dependencies during runtime and for development and installation you need ruby-maven installed as well (which you get via the development dependencies)
+	* bundler does not install the jar-dependencies (unless JRuby adds the gem as default gem)
+	* you need ruby-maven doing the job of dependency resolution and downloading them. gems not part of <http://rubygems.org> will not work currently
 
 ## just look at the example ##
 

data/jar-dependencies.gemspec

@@ -2,7 +2,7 @@
 
 Gem::Specification.new do |s|
   s.name = 'jar-dependencies'
-  s.version = "0.0.5"
+  s.version = "0.0.6"
   s.author = 'christian meier'
   s.email = [ 'mkristian@web.de' ]
   s.summary = 'manage jar dependencies for gems'

data/lib/jar_installer.rb

@@ -55,8 +55,12 @@ module Jars
       end
     end
 
-    def self.install_jars
-      new.install_jars
+    def self.install_jars( write_require_file = false )
+      new.install_jars( write_require_file )
+    end
+
+    def self.vendor_jars( write_require_file = false )
+      new.vendor_jars( write_require_file )
     end
 
     def self.load_from_maven( file )
@@ -113,20 +117,31 @@ module Jars
     private :find_spec
 
     def initialize( spec = nil )
+      setup( spec )
+    end
+
+    def setup( spec = nil )
       spec ||= find_spec
 
       case spec
       when String
-        @basedir = File.dirname( File.expand_path( spec ) )
-        @specfile = spec
+        @specfile = File.expand_path( spec )
+        @basedir = File.dirname( @specfile )
         spec =  eval( File.read( spec ) )
-      when
+      when Gem::Specification
         if File.exists?( spec.spec_file )
           @basedir = spec.gem_dir
           @specfile = spec.spec_file
         else
-          initialize( nil )
+          # this happens with bundle and local gems
+          # there the spec_file is "not installed" but inside
+          # the gem_dir directory
+          Dir.chdir( spec.gem_dir ) do
+            setup( nil )
+          end
         end
+      else
+        raise 'spec must be either String or Gem::Specification'
       end
 
       @spec = spec
@@ -136,15 +151,15 @@ module Jars
       @options = options.dup
     end
 
-    def vendor_jars
+    def vendor_jars( write_require_file = true )
       return unless has_jars?
       # do not vendor only if set explicitly via ENV/system-properties
-      do_install( Jars.to_prop( Jars::VENDOR ) != 'false', false )
+      do_install( Jars.to_prop( Jars::VENDOR ) != 'false', write_require_file )
     end
 
-    def install_jars
+    def install_jars( write_require_file = true )
       return unless has_jars?
-      do_install( false, true )
+      do_install( false, write_require_file )
     end
 
     private
@@ -158,14 +173,16 @@ module Jars
 
     def do_install( vendor, write_require_file )
       vendor_dir = File.join( @basedir, @spec.require_path )
-      if write_require_file
-        jars_file = File.join( vendor_dir, "#{@spec.name}_jars.rb" )
-
-        # do not generate file if specfile is older then the generated file
-        if File.exists?( jars_file ) && 
-            File.mtime( @specfile ) < File.mtime( jars_file )
-          jars_file = nil
-        end
+      jars_file = File.join( vendor_dir, "#{@spec.name}_jars.rb" )
+
+      # write out new jars_file it write_require_file is true or 
+      # check timestamps: 
+      # do not generate file if specfile is older then the generated file
+      if ! write_require_file &&
+          File.exists?( jars_file ) && 
+          File.mtime( @specfile ) < File.mtime( jars_file )
+        # leave jars_file as is
+        jars_file = nil
       end
       self.class.install_deps( install_dependencies, vendor_dir,
                                jars_file, vendor )

data/lib/rubygems_plugin.rb

@@ -23,7 +23,7 @@ if defined?( JRUBY_VERSION ) && Gem.post_install_hooks.empty?
   Gem.post_install do |gem_installer|
     require 'jar_installer'
     jars = Jars::JarInstaller.new( gem_installer.spec )
-    jars.ruby_maven_install_options = gem_installer.options 
+    jars.ruby_maven_install_options = gem_installer.options || {}
     jars.vendor_jars
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: jar-dependencies
 version: !ruby/object:Gem::Version
-  version: 0.0.5
+  version: 0.0.6
 platform: ruby
 authors:
 - christian meier
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2014-07-14 00:00:00.000000000 Z
+date: 2014-07-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: minitest