lock_jar 0.10.0 → 0.10.2

data/lib/lock_jar/version.rb

@@ -1,3 +1,3 @@
-module LockJar
-  VERSION = '0.10.0'
-end
+module LockJar
+  VERSION = '0.10.2'
+end

data/lib/lock_jar.rb

@@ -1,177 +1,172 @@
-# Licensed to the Apache Software Foundation (ASF) under one or more
-# contributor license agreements. See the NOTICE file distributed with this
-# work for additional information regarding copyright ownership. The ASF
-# licenses this file to you under the Apache License, Version 2.0 (the
-# "License"); you may not use this file except in compliance with the License.
-# You may obtain a copy of the License at
-#
-# http://www.apache.org/licenses/LICENSE-2.0
-#
-# Unless required by applicable law or agreed to in writing, software
-# distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
-# WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
-# License for the specific language governing permissions and limitations under
-# the License.
-
-require "yaml"
-require 'rubygems'
-require 'lock_jar/resolver'
-require 'lock_jar/runtime'
-require 'lock_jar/version'
-require 'lock_jar/domain/lockfile'
-require 'lock_jar/domain/dsl'
-
-#
-# LockJar manages Java Jars for Ruby.
-#
-# @author Michael Guymon
-#
-module LockJar
-  
-  #
-  # Override LockJar configuration
-  #
-  def self.config( opts )
-    Runtime.instance.resolver( opts )
-  end
-  
-  def self.install( *args, &blk )
-    lockfile = nil
-    opts = {}
-    groups = ['default']
-      
-    args.each do |arg|
-      if arg.is_a?(Hash)
-        opts.merge!( arg )
-      elsif arg.is_a?( String )
-        lockfile = arg
-      elsif arg.is_a?( Array )
-        groups = arg
-      end
-    end
-    
-    # default to Jarfile.lock
-    if blk.nil? && lockfile.nil?
-      lockfile = 'Jarfile.lock'
-    end
-    
-    Runtime.instance.install( lockfile, groups, opts, &blk )
-  end
-  
-  
-  # Lists all dependencies as notations for groups from the Jarfile.lock. Depending on the type of arg, a different configuration is set.
-  #
-  # * An arg of a String will set the Jarfile.lock, e.g. 'Better.lock'.  Default lock file is *Jarfile.lock*.
-  # * An arg of an Array will set the groups, e.g. ['development','test'].  Defaults group is *default*
-  # * An arg of a Hash will set the options, e.g. { :local_repo => 'path' }
-  #   * :local_repo [String] sets the local repo path
-  #   * :local_paths [Boolean] to true converts the notations to paths to jars in the local repo path
-  #   * :resolve [Boolean] to true will make transitive dependences resolve before loading to classpath
-  # 
-  # A block can be passed in, overriding values from a Jarfile.lock.
-  #
-  # @return [Array] of jar and mapped path
-  def self.list( *args, &blk )
-      lockfile = nil
-      opts = {}
-      groups = ['default']
-        
-      args.each do |arg|
-        if arg.is_a?(Hash)
-          opts.merge!( arg )
-        elsif arg.is_a?( String )
-          lockfile = arg
-        elsif arg.is_a?( Array )
-          groups = arg
-        elsif arg.is_a?( LockJar::Domain::Lockfile )
-          lockfile = arg
-        end
-      end
-      
-      # default to Jarfile.lock
-      if blk.nil? && lockfile.nil?
-        lockfile = 'Jarfile.lock'
-      end
-      
-      Runtime.instance.list( lockfile, groups, opts, &blk )
-  end
-    
-  # LockJar.load(*args): Loads all dependencies to the classpath for groups from the Jarfile.lock. Depending on the type of arg, a different configuration is set.
-  # * An arg of a String will set the Jarfile.lock, e.g. 'Better.lock'. Default lock file is *Jarfile.lock*.
-  # * An arg of an Array will set the groups, e.g. ['development','test'].Defaults group is *default*.
-  # * An arg of a Hash will set the options, e.g. { :local_repo => 'path' }
-  #    * :local_repo sets the local repo path
-  #    * :resolve to true will make transitive dependences resolve before loading to classpath
-  # 
-  # A block can be passed in, overriding values from a Jarfile.lock.
-  #
-  # @return [Array] of absolute paths of jars and mapped paths loaded into claspath
-  def self.load( *args, &blk )
-      lockfile = nil
-      opts = {}
-      groups = ['default']
-        
-      args.each do |arg|
-        if arg.is_a?(Hash)
-          opts.merge!( arg )
-        elsif arg.is_a?( String )
-          lockfile = arg
-        elsif arg.is_a?( Array )
-          groups = arg
-        elsif arg.is_a?( LockJar::Domain::Lockfile )
-          lockfile = arg
-        end
-      end
-      
-      # default to Jarfile.lock
-      if blk.nil? && lockfile.nil?
-        lockfile = 'Jarfile.lock'
-      end
-      
-      Runtime.instance.load( lockfile, groups, opts, &blk )
-  end
-  
-  # Lock a Jarfile and generate a Jarfile.lock. 
-  #
-  # LockJar.lock accepts an Array for parameters. Depending on the type of arg, a different configuration is set.
-  #
-  # * An arg of a String will set the Jarfile, e.g. 'Jarfile.different'. Default Jarfile is *Jarfile*.
-  # * An arg of a Hash will set the options, e.g. { :local_repo => 'path' }
-  #   * :download_artifacts if true, will download jars to local repo. Defaults to true.
-  #   * :local_repo sets the local repo path
-  #   * :lockfile sets the Jarfile.lock path. Default lockfile is *Jarfile.lock*.
-  #
-  # A block can be passed in, overriding values from a Jarfile.
-  #
-  # @return [Hash] Lock data
-  def self.lock( *args, &blk )
-    jarfile = nil
-    opts = {}
-      
-    args.each do |arg|
-      if arg.is_a?(Hash)
-        opts.merge!( arg )
-      elsif arg.is_a?( String ) || arg.is_a?( LockJar::Domain::Dsl )
-        jarfile = arg
-      end
-    end
-    
-    # default to Jarfile
-    if blk.nil? && jarfile.nil?
-      jarfile = 'Jarfile'
-    end
-    
-    Runtime.instance.lock( jarfile, opts, &blk )
-  end
-  
-  #
-  # Read a Jafile.lock and convert it to a LockJar::Domain::Lockfile
-  #
-  # @param [String] lockfile path to lockfile
-  # @return [Hash] Lock Data
-  def self.read( lockfile )
-    LockJar::Domain::Lockfile.read( lockfile )
-  end
- 
-end
-
+# Licensed to the Apache Software Foundation (ASF) under one or more
+# contributor license agreements. See the NOTICE file distributed with this
+# work for additional information regarding copyright ownership. The ASF
+# licenses this file to you under the Apache License, Version 2.0 (the
+# "License"); you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+# http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
+# WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
+# License for the specific language governing permissions and limitations under
+# the License.
+
+require "yaml"
+require 'rubygems'
+require 'lock_jar/resolver'
+require 'lock_jar/runtime'
+require 'lock_jar/version'
+require 'lock_jar/domain/lockfile'
+require 'lock_jar/domain/dsl'
+
+#
+# LockJar manages Java Jars for Ruby.
+#
+# @author Michael Guymon
+#
+module LockJar
+
+  #
+  # Override LockJar configuration
+  #
+  def self.config( opts )
+    Runtime.instance.resolver( opts )
+  end
+
+  def self.install( *args, &blk )
+    lockfile, groups, opts = extract_args :lockfile, args, &blk
+    Runtime.instance.install( lockfile, groups, opts, &blk )
+  end
+
+
+  # Lists all dependencies as notations for groups from the Jarfile.lock. Depending on the type of arg, a different configuration is set.
+  #
+  # * An arg of a String will set the Jarfile.lock, e.g. 'Better.lock'.  Default lock file is *Jarfile.lock*.
+  # * An arg of an Array will set the groups, e.g. ['development','test'].  Defaults group is *default*
+  # * An arg of a Hash will set the options, e.g. { :local_repo => 'path' }
+  #   * :local_repo [String] sets the local repo path
+  #   * :local_paths [Boolean] to true converts the notations to paths to jars in the local repo path
+  #   * :resolve [Boolean] to true will make transitive dependences resolve before loading to classpath
+  #
+  # A block can be passed in, overriding values from a Jarfile.lock.
+  #
+  # @return [Array] of jar and mapped path
+  def self.list( *args, &blk )
+    lockfile, groups, opts = extract_args :lockfile, args, &blk
+    Runtime.instance.list( lockfile, groups, opts, &blk )
+  end
+
+  # LockJar.load(*args): Loads all dependencies to the classpath for groups from the Jarfile.lock. Depending on the type of arg, a different configuration is set.
+  # * An arg of a String will set the Jarfile.lock, e.g. 'Better.lock'. Default lock file is *Jarfile.lock*.
+  # * An arg of an Array will set the groups, e.g. ['development','test'].Defaults group is *default*.
+  # * An arg of a Hash will set the options, e.g. { :local_repo => 'path' }
+  #    * :local_repo sets the local repo path
+  #    * :resolve to true will make transitive dependences resolve before loading to classpath
+  #
+  # A block can be passed in, overriding values from a Jarfile.lock.
+  #
+  # @return [Array] of absolute paths of jars and mapped paths loaded into claspath
+  def self.load( *args, &blk )
+    lockfile, groups, opts = extract_args :lockfile, args, &blk
+    Runtime.instance.load( lockfile, groups, opts, &blk )
+  end
+
+  # Lock a Jarfile and generate a Jarfile.lock.
+  #
+  # LockJar.lock accepts an Array for parameters. Depending on the type of arg, a different configuration is set.
+  #
+  # * An arg of a String will set the Jarfile, e.g. 'Jarfile.different'. Default Jarfile is *Jarfile*.
+  # * An arg of a Hash will set the options, e.g. { :local_repo => 'path' }
+  #   * :download_artifacts if true, will download jars to local repo. Defaults to true.
+  #   * :local_repo sets the local repo path
+  #   * :lockfile sets the Jarfile.lock path. Default lockfile is *Jarfile.lock*.
+  #
+  # A block can be passed in, overriding values from a Jarfile.
+  #
+  # @return [Hash] Lock data
+  def self.lock( *args, &blk )
+    jarfile, groups, opts = extract_args :jarfile, args, &blk
+    Runtime.instance.lock( jarfile, opts, &blk )
+  end
+
+  #
+  # Read a Jafile.lock and convert it to a LockJar::Domain::Lockfile
+  #
+  # @param [String] lockfile path to lockfile
+  # @return [Hash] Lock Data
+  def self.read( lockfile )
+    LockJar::Domain::Lockfile.read( lockfile )
+  end
+
+  # Add a Jarfile to be included when LockJar.lock_registered_jarfiles is called.
+  #
+  # @param [String] jarfile path to register
+  # @return [Array] All registered jarfiles
+  def self.register_jarfile( jarfile )
+    fail "Jarfile not found: #{ jarfile }" unless File.exists? jarfile
+    registered_jarfiles << jarfile
+  end
+
+  def self.reset_registered_jarfiles
+    @@registered_jarfiles = []
+  end
+
+  def self.registered_jarfiles
+    @@registered_jarfiles ||= []
+  end
+
+  # Lock the registered Jarfiles and generate a Jarfile.lock.
+  #
+  # Options and groups are passed through to the LockJar.lock method, but
+  # if a Jarfile is specified, it will be ignored. Use LockJar.register_jarfile
+  # to add dependencies.
+  #
+  # A block can be passed in, overriding values from the Jarfiles.
+  #
+  # @return [Hash] Lock data
+  def self.lock_registered_jarfiles( *args, &blk )
+    jarfiles = registered_jarfiles
+    return if jarfiles.empty?
+    instances = jarfiles.map do |jarfile|
+      LockJar::Domain::JarfileDsl.create jarfile
+    end
+    combined = instances.reduce do |result, inst|
+      LockJar::Domain::DslHelper.merge result, inst
+    end
+    args = args.reject { |arg| arg.is_a? String }
+    lock combined, *args, &blk
+  end
+
+  private
+
+  def self.extract_args(type, args, &blk )
+    lockfile_or_path = nil
+    opts = {}
+    groups = ['default']
+    args.each do |arg|
+      case arg
+      when Hash
+        opts.merge!( arg )
+      when String
+        lockfile_or_path = arg
+      when LockJar::Domain::Lockfile
+        lockfile_or_path = arg if type == :lockfile
+      when LockJar::Domain::Dsl
+        lockfile_or_path = arg if type == :jarfile
+      when Array
+        groups = arg
+      end
+    end
+    if blk.nil? && lockfile_or_path.nil?
+      if type == :lockfile
+        lockfile_or_path = opts.fetch(:lockfile, 'Jarfile.lock')
+      elsif type == :jarfile
+        lockfile_or_path = 'Jarfile'
+      end
+    end
+    [lockfile_or_path, groups, opts]
+  end
+end
+

data/lock_jar.gemspec

@@ -1,27 +1,27 @@
-# coding: utf-8
-lib = File.expand_path('../lib', __FILE__)
-$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
-
-require 'lock_jar/version'
-
-Gem::Specification.new do |s|
-  s.name = 'lock_jar'
-  s.version = LockJar::VERSION
-  s.authors = ['Michael Guymon']
-  s.date = '2014-03-06'
-  s.description = 'Manage Jar files for Ruby. In the spirit of Bundler, a Jarfile is used to generate a Jarfile.lock that contains all the resolved jar dependencies for scopes runtime, compile, and test. The Jarfile.lock can be used to populate the classpath'
-  s.email = 'michael@tobedevoured.com'
-  s.files         = `git ls-files -z`.split("\x0")
-  s.executables   = s.files.grep(%r{^bin/}) { |f| File.basename(f) }
-  s.test_files    = s.files.grep(%r{^(test|spec|features)/})
-  s.extra_rdoc_files = %w(LICENSE README.md)
-  s.homepage = 'http://github.com/mguymon/lock_jar'
-  s.licenses = %w(Apache)
-  s.require_paths = %w(lib)
-  s.summary = 'Manage Jar files for Ruby'
-
-  s.add_dependency(%q<naether>, ['~> 0.13.1'])
-  s.add_dependency(%q<thor>, ['>= 0.18.1'])
-
-end
-
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+
+require 'lock_jar/version'
+
+Gem::Specification.new do |s|
+  s.name = 'lock_jar'
+  s.version = LockJar::VERSION
+  s.authors = ['Michael Guymon']
+  s.date = '2014-03-06'
+  s.description = 'Manage Jar files for Ruby. In the spirit of Bundler, a Jarfile is used to generate a Jarfile.lock that contains all the resolved jar dependencies for scopes runtime, compile, and test. The Jarfile.lock can be used to populate the classpath'
+  s.email = 'michael@tobedevoured.com'
+  s.files         = `git ls-files -z`.split("\x0")
+  s.executables   = s.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  s.test_files    = s.files.grep(%r{^(test|spec|features)/})
+  s.extra_rdoc_files = %w(LICENSE README.md)
+  s.homepage = 'http://github.com/mguymon/lock_jar'
+  s.licenses = %w(Apache)
+  s.require_paths = %w(lib)
+  s.summary = 'Manage Jar files for Ruby'
+
+  s.add_dependency(%q<naether>, ['~> 0.13.1'])
+  s.add_dependency(%q<thor>, ['>= 0.18.1'])
+
+end
+

data/spec/fixtures/Jarfile

@@ -1,14 +1,14 @@
-local_repo '~/.m2/repository'
-repository 'http://mirrors.ibiblio.org/pub/mirrors/maven2'
-
-jar "org.apache.mina:mina-core:2.0.4"
-local "spec/fixtures/naether-0.13.0.jar"
-pom 'spec/pom.xml'
-    
-group 'development' do
-    jar 'com.typesafe:config:jar:0.5.0'
-end
-
-group 'test' do
-    jar 'junit:junit:jar:4.10'
+local_repo '~/.m2/repository'
+repository 'http://mirrors.ibiblio.org/pub/mirrors/maven2'
+
+jar "org.apache.mina:mina-core:2.0.4"
+local "spec/fixtures/naether-0.13.0.jar"
+pom 'spec/pom.xml'
+    
+group 'development' do
+    jar 'com.typesafe:config:jar:0.5.0'
+end
+
+group 'test' do
+    jar 'junit:junit:jar:4.10'
 end

data/spec/fixtures/Jarfile2

@@ -0,0 +1 @@
+jar "org.eclipse.jetty:jetty-servlet:8.1.3.v20120416"

data/spec/lock_jar/class_loader_spec.rb

@@ -1,57 +1,57 @@
-require 'spec_helper'
-require 'lock_jar/class_loader'
-
-
-describe LockJar::ClassLoader, "#isolate" do
- 
-  if Naether.platform != 'java'
-    pending "need tests for RJB backed classloader"
-  else
-    it "should create a SimpleEmail" do
-      # Generate the IsolateJarfile.lock 
-      LockJar.lock( :lockfile => "#{TEMP_DIR}/IsolateJarfile.lock" ) do
-       jar 'org.apache.commons:commons-email:1.2'
-      end
-      
-      email = LockJar::ClassLoader.new( "#{TEMP_DIR}/IsolateJarfile.lock" ).isolate do
-          email = new_instance( 'org.apache.commons.mail.SimpleEmail' )
-          email.setSubject( 'test subject' )     
-          
-          email
-      end
-      
-      email.getSubject().should eql 'test subject'
-      
-      unless $CLASSPATH.nil?
-        $CLASSPATH.to_a.join(' ').should_not =~ /commons-email-1\.2\.jar/
-      end
-      
-      expect { org.apache.commons.mail.SimpleEmail.new }.to raise_error
-    end
-  
-    it "should create a JsonFactory and ObjectMapper" do
-      # Generate the IsolateJarfile.lock 
-      LockJar.lock( :lockfile => "#{TEMP_DIR}/IsolateJarfile.lock" ) do
-       jar 'com.fasterxml.jackson.core:jackson-core:2.0.6'
-       jar 'com.fasterxml.jackson.core:jackson-databind:2.0.6'
-      end
-      
-      json = '{ "test1": "1test1", "test2": "2test2"}'
-      
-      map = LockJar::ClassLoader.new( "#{TEMP_DIR}/IsolateJarfile.lock" ).isolate do
-          factory = new_instance( 'com.fasterxml.jackson.core.JsonFactory' )
-          mapper = new_instance( 'com.fasterxml.jackson.databind.ObjectMapper', factory) 
-          mapper.readValue(json, java.util.Map.java_class)
-      end
-      
-      map.get('test1').should eql "1test1"
-      map.get('test2').should eql "2test2"
-      
-      unless $CLASSPATH.nil?
-        $CLASSPATH.to_a.join(' ').should_not =~ /jackson-databind-2\.0\.6\.jar/
-      end
-      
-      expect { com.fasterxml.jackson.core.JsonFactory.new }.to raise_error
-    end
-  end
-end
+require 'spec_helper'
+require 'lock_jar/class_loader'
+
+
+describe LockJar::ClassLoader, "#isolate" do
+ 
+  if Naether.platform != 'java'
+    pending "need tests for RJB backed classloader"
+  else
+    it "should create a SimpleEmail" do
+      # Generate the IsolateJarfile.lock 
+      LockJar.lock( :lockfile => "#{TEMP_DIR}/IsolateJarfile.lock" ) do
+       jar 'org.apache.commons:commons-email:1.2'
+      end
+      
+      email = LockJar::ClassLoader.new( "#{TEMP_DIR}/IsolateJarfile.lock" ).isolate do
+          email = new_instance( 'org.apache.commons.mail.SimpleEmail' )
+          email.setSubject( 'test subject' )     
+          
+          email
+      end
+      
+      email.getSubject().should eql 'test subject'
+      
+      unless $CLASSPATH.nil?
+        $CLASSPATH.to_a.join(' ').should_not =~ /commons-email-1\.2\.jar/
+      end
+      
+      expect { org.apache.commons.mail.SimpleEmail.new }.to raise_error
+    end
+  
+    it "should create a JsonFactory and ObjectMapper" do
+      # Generate the IsolateJarfile.lock 
+      LockJar.lock( :lockfile => "#{TEMP_DIR}/IsolateJarfile.lock" ) do
+       jar 'com.fasterxml.jackson.core:jackson-core:2.0.6'
+       jar 'com.fasterxml.jackson.core:jackson-databind:2.0.6'
+      end
+      
+      json = '{ "test1": "1test1", "test2": "2test2"}'
+      
+      map = LockJar::ClassLoader.new( "#{TEMP_DIR}/IsolateJarfile.lock" ).isolate do
+          factory = new_instance( 'com.fasterxml.jackson.core.JsonFactory' )
+          mapper = new_instance( 'com.fasterxml.jackson.databind.ObjectMapper', factory) 
+          mapper.readValue(json, java.util.Map.java_class)
+      end
+      
+      map.get('test1').should eql "1test1"
+      map.get('test2').should eql "2test2"
+      
+      unless $CLASSPATH.nil?
+        $CLASSPATH.to_a.join(' ').should_not =~ /jackson-databind-2\.0\.6\.jar/
+      end
+      
+      expect { com.fasterxml.jackson.core.JsonFactory.new }.to raise_error
+    end
+  end
+end