jar-dependencies 0.0.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 2f27be364d8c8f32d577aef905556c4cd660fe8e
+  data.tar.gz: 3e7a4d1af9b4156354f47be93a4b03f7c333a6f2
+SHA512:
+  metadata.gz: 6d1c68ce4acf5dfb0e95c919761ba653cb1bf24088744cba40a3801395b80f9db27091bbe922f4edef80367e8f37252349a276f4883895b4fd9d6d34fe26d074
+  data.tar.gz: 031880f018fe453260aaa5f8e852c93a512d22adbb613df1e1176368527b58c69db2167c2663c5474b383c124ff43bc3dd612088466e12604b64805351243439

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2014 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.

data/Readme.md

@@ -0,0 +1,36 @@
+# jar-dependencies #
+
+manage jar dependencies for gems and keep track which jar was already loaded using maven artifact coordinates. it warns on version conflicts and loads only ONE jar assuming the first one is compatible to the second one otherwise your project needs to lock down the right version.
+
+via environment variable or system properties the jar loading can be switched of completely, allowing the servlet container or jbundler or any other container to take care of the jar loading.
+
+in case the jars are vendored using the following path convention
+
+**{group\_id}/{artifact\_id}-{version}.jar**
+
+it will be loaded in case the local maven repository does not have it (maybe the preference should be the other way around ?).
+
+the gem is tiny on purpose since the all gems with jar dependencies should use and funny double loaded jars can be avoided in future. also java project using the jruby ScriptingContainer can manage their jar dependencies including those coming from the gem files.
+
+# create a gem with jar dependencies #
+
+see add you jar dependency declaration in gemspec via the **requirements**, see [example.gemspec](example/example.gemspec). create an extension **ext/extconf.rb** and use the **setup** from [ruby-maven](http://rubygems.org/gem/ruby-maven) to install the jar dependencies on installation of the gem - see [ext/extconf.rb](example/ext/extconf.rb). this setup will create **{gem.name}\_jars.rb** inside the lib directory (**require_path** of the gemspec) of your gem .
+
+note: you need ruby-maven-3.1.1.0.3.dev or newer for the GemSetup class
+
+your gem just need require this **{gem.name}_jars.rb** in your code whenever you want to load these jars (see [lib/example.rb](example/lib/example.rb)).
+
+the gem itself also needs the **jar-dependencies** gem as runtime-dependency since that is used to load the jar or let [jbundler](http://rubygems.org/gem/jbundler) or similar frameworks deal with the jar dependencies.
+
+# motivation #
+
+just today I tumbled across [https://github.com/arrigonialberto86/ruby-band](https://github.com/arrigonialberto86/ruby-band) which usees jbundler to manage their jar dependencies which happens on the first 'require "ruby-band"'. their is no easy or formal way to find out which jars are added to jruby-classloader.
+
+another issue was brought to my notice yesterday [https://github.com/hqmq/derelicte/issues/1](https://github.com/hqmq/derelicte/issues/1)
+
+or the question of how to manage jruby projects with maven [http://ruby.11.x6.nabble.com/Maven-dependency-management-td4996934.html](http://ruby.11.x6.nabble.com/Maven-dependency-management-td4996934.html)
+
+or a few days ago an issue for the rake-compile [https://github.com/luislavena/rake-compiler/issues/87](https://github.com/luislavena/rake-compiler/issues/87)
+
+with jruby-9000 coming it is the right time to get the jar dependencies right - the current situation is like the time before bundler for gems.
+

data/jar-dependencies.gemspec

@@ -0,0 +1,22 @@
+#-*- mode: ruby -*-
+
+Gem::Specification.new do |s|
+  s.name = 'jar-dependencies'
+  s.version = "0.0.2"
+  s.author = 'christian meier'
+  s.email = [ 'mkristian@web.de' ]
+  s.summary = 'manage jar dependencies for gems'
+  s.homepage = 'https://github.com/mkristian/jar-dependencies'
+
+  s.license = 'MIT'
+
+  s.files = Dir[ 'lib/*rb' ]
+  s.files += [ 'Readme.md', 'jar-dependencies.gemspec', 'MIT-LICENSE' ]
+
+  s.description = 'manage jar dependencies for gems and keep track which jar was already loaded using maven artifact coordinates. it warns on version conflicts and loads only ONE jar assuming the first one is compatible to the second one otherwise your project needs to lock down the right version.'
+
+  s.add_runtime_dependency 'rake', '~> 10.2.2'
+  s.add_runtime_dependency 'ruby-maven', '~> 3.1.1.0'
+end
+
+# vim: syntax=Ruby

data/lib/jar-dependencies.rb

@@ -0,0 +1,22 @@
+#
+# Copyright (C) 2014 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 'jar_dependencies'

data/lib/jar_dependencies.rb

@@ -0,0 +1,57 @@
+#
+# Copyright (C) 2014 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.
+#
+
+def require_jar( group_id, artifact_id, *classifier_version )
+  require_jarfile( nil, group_id, artifact_id, *classifier_version )
+end
+
+def require_jarfile( file, group_id, artifact_id, *classifier_version )
+  skip = java.lang.System.get_property( 'jruby.jars.skip' ) || ENV[ 'JRUBY_JARS_SKIP' ] || java.lang.System.get_property( 'jbundler.skip' ) || ENV[ 'JBUNDLER_SKIP' ]
+  return false if skip == 'true'
+
+  version = classifier_version[ -1 ]
+  classifier = classifier_version[ -2 ]
+
+  # if no file given than it is vendored
+  # if the file does not exists we assume it is vendored
+  if file.nil? || !File.exists?( file )
+    file = "#{group_id.gsub( /\./, '/' )}/#{artifact_id}/#{version}/#{artifact_id}-#{version}"
+    file += "-#{classifier}" if classifier
+    file += '.jar'
+  end
+
+  @@jars ||= {}
+  coordinate = "#{group_id}:#{artifact_id}"
+  coordinate += ":#{classifier}" if classifier
+  if @@jars.key? coordinate
+    if @@jars[ coordinate ] != version
+      warn "coordinate #{coordinate} already loaded with version #{@@jars[ coordinate ]}"
+    end
+    false
+  else
+    require file
+    @@jars[ coordinate ] = version
+    true
+  end
+rescue LoadError => e
+  warn 'you might need to reinstall the gem which depends on the missing jar'
+  raise e
+end

data/lib/jar_installer.rb

@@ -0,0 +1,153 @@
+class JarInstaller
+
+  class Dependency
+    
+    attr_reader :path, :file, :gav, :scope, :type, :coord
+
+    def self.new( line )
+      if line.match /:jar:|:pom:/
+        super
+      end
+    end
+
+    def initialize( line )
+      if line.match /:pom:/
+        @type = :pom
+      elsif line.match /:jar:/
+        @type = :jar
+      end
+      line.sub!( /^\s+/, '' )
+      @coord = line.sub( /:[^:]+:[^:]+$/, '' )
+      first, second = line.sub( /:[^:]+:[^:]+$/, '' ).split( /:#{type}:/ )
+      group_id, artifact_id = first.split( /:/ ) 
+      parts = group_id.split( '.' ) 
+      parts << artifact_id
+      parts << second.split( /:/ )[ -1 ]
+      parts << File.basename( line.sub /.:/, '' ) 
+      @path = File.join( parts ).strip
+      
+      @scope = 
+        case line
+        when /:provided:/
+          :provided
+        when /:test:/
+          :test
+        else
+          :runtime
+        end
+      line.gsub!( /:jar:|:pom:|:test:|:compile:|:runtime:|:provided:/, ':' )
+      @file = line.sub( /^.*:/, '' ).strip
+      @gav = line.sub( /:[^:]+$/, '' )
+    end
+  end
+
+  def self.install_jars
+    new.install_jars
+  end
+
+  def self.load_from_maven( file )
+    result = []
+    File.read( file ).each_line do |line|
+      dep = Dependency.new( line )
+      result << dep if dep
+    end
+    result
+  end
+
+  def self.install_deps( deps, dir, require_filename, vendor )
+    FileUtils.mkdir_p( File.dirname( require_filename ) )
+    File.open( require_filename, 'w' ) do |f|
+      f.puts "require 'jar_dependencies'"
+      f.puts
+      deps.each do |dep|
+        next if dep.type != :jar || dep.scope != :runtime
+        args = dep.gav.gsub( /:/, "', '" )
+        if vendor
+          vendored = File.join( dir, dep.path )
+          FileUtils.mkdir_p( File.dirname( vendored ) )
+          FileUtils.cp( dep.file, vendored )
+          f.puts( "require_jar( '#{args}' )" )
+        else
+          f.puts( "require_jarfile( '#{dep.file}', '#{args}' )" )
+        end
+      end
+    end
+  end
+
+  def initialize( spec = nil )
+    if spec.nil?
+      specs = Dir[ '*.gemspec' ]
+      case specs.size
+      when 0
+        raise 'no gemspec found'
+      when 1
+        spec = specs.first
+      else
+        raise 'more then one gemspec found. please specify a specfile' 
+      end
+    end
+    if spec.is_a? String
+      @basedir = File.dirname( File.expand_path( spec ) )
+      @specfile = spec
+      spec =  eval( File.read( spec ) )
+    else
+      @basedir = spec.gem_dir
+      @specfile = spec.spec_file
+    end
+    @spec = spec
+  end
+
+  def vendor_jars
+    return if @spec.requirements.empty?
+    really_vendor = java.lang.System.get_property( 'jruby.jars.vendor' ) || ENV[ 'JRUBY_JARS_VENDOR' ] || 'true'
+    do_install( really_vendor == 'true' )
+  end
+
+  def install_jars
+    return if @spec.requirements.empty?
+    do_install( false )
+  end
+
+  private
+
+  def do_install( vendor )
+    vendor_dir = File.join( @basedir, @spec.require_path )
+    jars_file = File.join( vendor_dir, "#{@spec.name}_jars.rb" )
+
+    return if File.exists?( jars_file ) && 
+      File.mtime( @specfile ) < File.mtime( jars_file )
+
+    self.class.install_deps( install_dependencies, vendor_dir, 
+                             jars_file, vendor )
+  end
+
+  def install_dependencies
+    deps = File.join( @basedir, 'deps.lst' )
+
+    # lazy load ruby-maven
+    begin
+
+      require 'maven/ruby/maven'
+
+    rescue LoadError
+      raise 'please install ruby-maven gem so the jar dependencies can be installed'
+    end
+   
+    # monkey patch to NOT include gem dependencies
+    require 'maven/tools/gemspec_dependencies'
+    eval <<EOF
+      class ::Maven::Tools::GemspecDependencies
+        def runtime; []; end
+        def development; []; end
+      end
+EOF
+
+    maven = Maven::Ruby::Maven.new
+    maven.exec 'dependency:list', "-DoutputFile=#{deps}", '-DincludeScope=runtime', '-DoutputAbsoluteArtifactFilename=true', '-DincludeTypes=jar', '-DoutputScope=true', '-f', @specfile, '--quiet'
+
+    self.class.load_from_maven( deps )
+  ensure
+    FileUtils.rm_f( deps ) if deps
+  end
+end
+

data/lib/rubygems_plugin.rb

@@ -0,0 +1,27 @@
+#
+# Copyright (C) 2014 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.
+#
+
+if defined?( JRUBY_VERSION ) && Gem.post_install_hooks.empty?
+  Gem.post_install do |gem_installer|
+    require 'jar_installer'
+    ::JarInstaller.new( gem_installer.spec ).vendor_jars
+  end
+end

metadata

@@ -0,0 +1,79 @@
+--- !ruby/object:Gem::Specification
+name: jar-dependencies
+version: !ruby/object:Gem::Version
+  version: 0.0.2
+platform: ruby
+authors:
+- christian meier
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2014-04-10 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rake
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 10.2.2
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 10.2.2
+  prerelease: false
+  type: :runtime
+- !ruby/object:Gem::Dependency
+  name: ruby-maven
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 3.1.1.0
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 3.1.1.0
+  prerelease: false
+  type: :runtime
+description: manage jar dependencies for gems and keep track which jar was already loaded using maven artifact coordinates. it warns on version conflicts and loads only ONE jar assuming the first one is compatible to the second one otherwise your project needs to lock down the right version.
+email:
+- mkristian@web.de
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/jar_dependencies.rb
+- lib/jar_installer.rb
+- lib/jar-dependencies.rb
+- lib/rubygems_plugin.rb
+- Readme.md
+- jar-dependencies.gemspec
+- MIT-LICENSE
+homepage: https://github.com/mkristian/jar-dependencies
+licenses:
+- MIT
+metadata: {}
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project:
+rubygems_version: 2.1.9
+signing_key:
+specification_version: 4
+summary: manage jar dependencies for gems
+test_files: []