lock_jar 0.3.1 → 0.3.2

data/Gemfile

@@ -8,4 +8,5 @@ group :development do
   gem "rspec", "~> 2.9.0"
   gem "bundler", "~> 1.1.0"
   gem "jeweler", "~> 1.6.4"
+  gem "yard", "~> 0.8.0"
 end

data/README.rdoc

@@ -7,6 +7,8 @@ The Jarfile.lock can be used to populate the classpath.
 
 https://github.com/mguymon/lock_jar
 
+{RDoc}[http://rubydoc.info/github/mguymon/lock_jar/master/frames]
+
 == Install
 
 gem install lock_jar
@@ -46,11 +48,11 @@ Example Jarfile
 	
 ==== Resolving dependencies
 
-* LockJar.lock( *args ): Using a Jarfile, creates a lock file. Default jarfile is *Jarfile* and default lockfile is *Jarfile.lock*.
-  * An arg of a String will set the Jarfile, e.g. 'Jarfile.different'
+* LockJar.lock( *args ): Using a Jarfile, creates a lock file. 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' }
     * :local_repo sets the local repo path
-    * :lockfile sets the Jarfile.lock path
+    * :lockfile sets the Jarfile.lock path. Default lockfile is *Jarfile.lock*.
 
 When the Jarfile is locked, the transitive dependencies are resolved and saved to the Jarfile.lock file.
 
@@ -100,9 +102,9 @@ The Jarfile.lock
   
 ==== Accessing Jars
 
-* LockJar.list(*args): Lists all dependencies as notations for scopes from the Jarfile.lock. Defaults scopes are *compile* and *runtime*. Default lock file is *Jarfile.lock*.
-  * An arg of a String will set the Jarfile.lock, e.g. 'Better.lock'
-  * An arg of an Array will set the scopes, e.g. ['compile','test']
+* LockJar.list(*args): Lists all dependencies as notations for scopes 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 scopes, e.g. ['compile','test']. Defaults scopes are *compile* and *runtime*.
   * An arg of a Hash will set the options, e.g. { :local_repo => 'path' }
     * :local_repo sets the local repo path
     * :local_paths converts the notations to paths to jars in the local repo path
@@ -129,19 +131,19 @@ Do not forget, if you change your Jarfile, you have to re-generate the Jarfile.l
 
 You can skip the Jarfile and Jarfile.lock to directly play with dependencies by passing a block to LockJar.lock, LockJar.list, LockJar.load
 
-===== Lock with a Jarfile
+===== Lock without a Jarfile
 
     LockJar.lock do
       jar 'org.eclipse.jetty:example-jetty-embedded:jar:8.1.2.v20120308'
     end
 
-===== List with a Jarfile
+===== List without a Jarfile.lock
     
     LockJar.list do
       jar 'org.eclipse.jetty:example-jetty-embedded:jar:8.1.2.v20120308'
     end
 
-===== Load with a Jarfile
+===== Load without a Jarfile.lock
     
     LockJar.load do
       jar 'org.eclipse.jetty:example-jetty-embedded:jar:8.1.2.v20120308'

data/VERSION

@@ -1 +1 @@
-0.3.1
+0.3.2

data/lib/lock_jar/maven.rb

@@ -16,22 +16,58 @@
 require 'lock_jar/runtime'
 
 module LockJar
+  
+  # Helper for providing Maven specific operations
+  #
+  # @author Michael Guymon
+  # 
   class Maven
     
     class << self
       
+      #
+      # Get the version of a POM
+      #
+      # @param [String] pom_path path to the pom
+      # @param [Hash] options
+      #
+      # @return [String] version of POM
+      #
       def pom_version( pom_path, opts = {} )
         Runtime.instance.resolver(opts).naether.pom_version( pom_path )
       end
       
-      def write_pom( notation, file_path, opts = {} )
-        Runtime.instance.resolver(opts).naether.write_pom( notation, file_path )
+      #
+      # Write a POM from list of notations
+      #
+      # @param [Array] notations 
+      # @param [String] file_path path of new pom
+      # @param [Hash] options
+      def write_pom( notations, file_path, opts = {} )
+        Runtime.instance.resolver(opts).naether.write_pom( notations, file_path )
       end
       
+      #
+      # Deploy an artifact to a Maven repository
+      #
+      # @param [String] notation of artifact
+      # @param [String] file_path path to the Jar
+      # @param [String] url Maven repository deploying to
+      # @param [Hash] deploy_opts options for deploying 
+      # @param [Hash] lockjar_opts options for initializing LockJar
+      #
       def deploy_artifact( notation, file_path, url, deploy_opts = {}, lockjar_opts = {} )
         Runtime.instance.resolver(lockjar_opts).naether.deploy_artifact( notation, file_path, url, deploy_opts )
       end
       
+      #
+      # Install an artifact to a local repository
+      #
+      # @param [String] notation of artifact
+      # @param [String] pom_path path to the pom
+      # @param [String] jar_path path to the jar
+      # @param [Hash] opts options
+      #
       def install( notation, pom_path, jar_path, opts = {} )
         Runtime.instance.resolver(opts).naether.install( notation, pom_path, jar_path )
       end

data/lib/lock_jar/resolver.rb

@@ -35,7 +35,7 @@ module LockJar
         deps = Naether::Bootstrap.download_dependencies( temp_jar_dir, deps.merge( :local_repo => local_repo ) )
         if deps[:downloaded].size > 0
                     
-          unless Dir.exists?( temp_jar_dir )
+          unless File.directory?( temp_jar_dir )
             FileUtils.mkdir_p jar_dir
           end
           

data/lib/lock_jar/runtime.rb

@@ -84,23 +84,19 @@ module LockJar
           lock_data['repositories'] = lock_jar_file.repositories
             
           if needs_force_encoding
-            lock_data['repositories'].map { |repo| repo.force_encoding("UTF-8") }
+            lock_data['repositories'].map! { |repo| repo.force_encoding("UTF-8") }
           end
         end
         
         if lock_jar_file.maps.size > 0
           lock_data['maps'] = lock_jar_file.maps
-            
-          #if needs_force_encoding
-          #  lock_data['maps'].map { |maps| maps.map { |map| map.force_encoding("UTF-8") } }
-          #end
         end
         
         if lock_jar_file.excludes.size > 0 
           lock_data['excludes'] = lock_jar_file.excludes
             
           if needs_force_encoding
-            lock_data['excludes'].map { |exclude| exclude.force_encoding("UTF-8") }
+            lock_data['excludes'].map! { |exclude| exclude.force_encoding("UTF-8") }
           end
         end
         
@@ -109,7 +105,7 @@ module LockJar
         lock_jar_file.notations.each do |scope, notations|
           
           if needs_force_encoding
-            notations.map { |notation| notation.force_encoding("UTF-8") }
+            notations.map! { |notation| notation.force_encoding("UTF-8") }
           end
           
           dependencies = []

data/lib/lock_jar.rb

@@ -19,15 +19,32 @@ require 'lock_jar/resolver'
 require 'lock_jar/dsl'
 require 'lock_jar/runtime'
 
+#
+# LockJar manages Java Jars for Ruby.
+#
+# @author Michael Guymon
+#
 module LockJar
   
+  #
+  # Override LockJar configuration
+  #
   def self.config( opts )
     Runtime.instance.resolver( opts )
   end
   
-  # Lock a Jarfile and generate a Jarfile.lock
+  # 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.
   #
-  # Accepts path to the jarfile and hash of options to configure LockJar
+  # * 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' }
+  #   * :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 = {}
@@ -48,9 +65,18 @@ module LockJar
     Runtime.instance.lock( jarfile, opts, &blk )
   end
   
-  # List jars for an array of scope in a lockfile
+  # Lists all dependencies as notations for scopes 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 scopes, e.g. ['compile','test'].  Defaults scopes are *compile* and *runtime*
+  # * An arg of a Hash will set the options, e.g. { :local_repo => 'path' }
+  #   * :local_repo sets the local repo path
+  #   * :local_paths converts the notations to paths to jars in 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.
   #
-  # Accepts path to the lockfile, array of scopes, and hash of options to configure LockJar
+  # @return [Array] of jar and mapped path
   def self.list( *args, &blk )
       lockfile = nil
       opts = {}
@@ -74,10 +100,16 @@ module LockJar
       Runtime.instance.list( lockfile, scopes, opts, &blk )
   end
     
-  # Load jars for an array of scopes in a lockfile. Defaults lockfile to Jarfile.lock
+  # LockJar.load(*args): Loads all dependencies to the classpath for scopes 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 scopes, e.g. ['compile','test'].Defaults scopes are *compile* and *runtime*.
+  # * 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.
   #
-  # Accepts a path to the lockfile, array scopes, and hash of options to configure LockJar. A
-  # block of LockJar::Dsl can be set.
+  # @return [Array] of absolute paths of jars and mapped paths loaded into claspath
   def self.load( *args, &blk )
       lockfile = nil
       opts = {}
@@ -101,6 +133,11 @@ module LockJar
       Runtime.instance.load( lockfile, scopes, opts, &blk )
   end
   
+  #
+  # Read a Jafile.lock and convert it to a Hash
+  #
+  # @param [String] lockfile path to lockfile
+  # @return [Hash] Lock Data
   def self.read( lockfile )
     Runtime.instance.read_lockfile( lockfile )
   end

data/lock_jar.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = "lock_jar"
-  s.version = "0.3.1"
+  s.version = "0.3.2"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Michael Guymon"]
-  s.date = "2012-05-14"
+  s.date = "2012-05-17"
   s.description = "Manage Jar files for Ruby. In the spirit of Bundler, a Jarfile\n  is used to generate a Jarfile.lock that contains all the resolved jar dependencies for scopes runtime, compile, and test.\n  The Jarfile.lock can be used to populate the classpath"
   s.email = "michael.guymon@gmail.com"
   s.extra_rdoc_files = [
@@ -45,7 +45,7 @@ Gem::Specification.new do |s|
   s.homepage = "http://github.com/mguymon/lock_jar"
   s.licenses = ["Apache"]
   s.require_paths = ["lib"]
-  s.rubygems_version = "1.8.15"
+  s.rubygems_version = "1.8.24"
   s.summary = "Manage Jar files for Ruby"
 
   if s.respond_to? :specification_version then
@@ -56,17 +56,20 @@ Gem::Specification.new do |s|
       s.add_development_dependency(%q<rspec>, ["~> 2.9.0"])
       s.add_development_dependency(%q<bundler>, ["~> 1.1.0"])
       s.add_development_dependency(%q<jeweler>, ["~> 1.6.4"])
+      s.add_development_dependency(%q<yard>, ["~> 0.8.0"])
     else
       s.add_dependency(%q<naether>, ["~> 0.8.0"])
       s.add_dependency(%q<rspec>, ["~> 2.9.0"])
       s.add_dependency(%q<bundler>, ["~> 1.1.0"])
       s.add_dependency(%q<jeweler>, ["~> 1.6.4"])
+      s.add_dependency(%q<yard>, ["~> 0.8.0"])
     end
   else
     s.add_dependency(%q<naether>, ["~> 0.8.0"])
     s.add_dependency(%q<rspec>, ["~> 2.9.0"])
     s.add_dependency(%q<bundler>, ["~> 1.1.0"])
     s.add_dependency(%q<jeweler>, ["~> 1.6.4"])
+    s.add_dependency(%q<yard>, ["~> 0.8.0"])
   end
 end
 

data/spec/lock_jar/bundler_spec.rb

@@ -11,7 +11,6 @@ describe Bundler do
     
     before(:all) do
       FileUtils.rm_rf( bundled_app ) if File.exists? bundled_app
-      FileUtils.mkdir_p tmp('bundler')
     end
     
     before(:each) do
@@ -27,6 +26,9 @@ describe Bundler do
           pom "#{File.join(root, 'spec', 'pom.xml')}", :scope => :development
         end
       G
+      
+      ENV['BUNDLE_GEMFILE'] = bundled_app("Gemfile").to_s
+      
       in_app_root
     end
     
@@ -36,10 +38,13 @@ describe Bundler do
     end
   
   it "provides a list of the env dependencies" do
-    Bundler.load.dependencies.should have_dep("naether", ">= 0")
+    dep = Bundler.load.dependencies.first
+    dep.name.should eql("naether")
+    (dep.requirement >= ">= 0").should be_true
   end
     
   it "provides a list of the jar and pom dependencies" do
+    # XXX: In JRuby - works in autotest, fails directly from rspec. *sigh*
     Bundler.load.lock_jar.notations.should eql( {"compile"=>[File.expand_path(File.join(File.dirname(__FILE__), "../../spec/pom.xml"))], "runtime"=>[], "test"=>["junit:junit:jar:4.10"]} )
   end
   

data/spec/lock_jar/runtime_spec.rb

@@ -4,11 +4,11 @@ require 'lib/lock_jar/runtime'
 describe LockJar::Runtime do
   context "Singleton" do
     it "should set local repo" do
-      LockJar::Runtime.instance.load( nil ) do 
+      LockJar::Runtime.instance.load( nil, [], :resolve => true, :local_repo => 'tmp/test-repo' ) do 
         jar 'junit:junit:4.10'
       end
       
-      LockJar::Runtime.instance.current_resolver.naether.local_repo_path.should eql File.expand_path('~/.m2/repository')
+      LockJar::Runtime.instance.current_resolver.naether.local_repo_path.should eql File.expand_path('tmp/test-repo') 
       
       LockJar::Runtime.instance.load( nil, [], :local_repo => 'tmp/param_config' ) do 
         local 'dsl_config'

data/spec/spec_helper.rb

@@ -1,6 +1,6 @@
 $:.unshift File.expand_path('.')
 $:.unshift File.expand_path(File.join('..', File.dirname(__FILE__)))
-$:.unshift File.expand_path(File.join('../lib', File.dirname(__FILE__)))
+$:.unshift File.expand_path(File.join('..', File.dirname(__FILE__), 'lib'))
 
 require 'rubygems'
 require 'rspec'

metadata

@@ -1,71 +1,115 @@
---- !ruby/object:Gem::Specification
+--- !ruby/object:Gem::Specification 
 name: lock_jar
-version: !ruby/object:Gem::Version
-  version: 0.3.1
+version: !ruby/object:Gem::Version 
+  hash: 23
   prerelease: 
+  segments: 
+  - 0
+  - 3
+  - 2
+  version: 0.3.2
 platform: ruby
-authors:
+authors: 
 - Michael Guymon
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-05-14 00:00:00.000000000 Z
-dependencies:
-- !ruby/object:Gem::Dependency
-  name: naether
-  requirement: &15583440 !ruby/object:Gem::Requirement
+
+date: 2012-05-17 00:00:00 Z
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
     none: false
-    requirements:
+    requirements: 
     - - ~>
-      - !ruby/object:Gem::Version
+      - !ruby/object:Gem::Version 
+        hash: 63
+        segments: 
+        - 0
+        - 8
+        - 0
         version: 0.8.0
   type: :runtime
+  name: naether
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
   prerelease: false
-  version_requirements: *15583440
-- !ruby/object:Gem::Dependency
-  name: rspec
-  requirement: &15580160 !ruby/object:Gem::Requirement
+  requirement: &id002 !ruby/object:Gem::Requirement 
     none: false
-    requirements:
+    requirements: 
     - - ~>
-      - !ruby/object:Gem::Version
+      - !ruby/object:Gem::Version 
+        hash: 43
+        segments: 
+        - 2
+        - 9
+        - 0
         version: 2.9.0
   type: :development
+  name: rspec
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
   prerelease: false
-  version_requirements: *15580160
-- !ruby/object:Gem::Dependency
-  name: bundler
-  requirement: &15700940 !ruby/object:Gem::Requirement
+  requirement: &id003 !ruby/object:Gem::Requirement 
     none: false
-    requirements:
+    requirements: 
     - - ~>
-      - !ruby/object:Gem::Version
+      - !ruby/object:Gem::Version 
+        hash: 19
+        segments: 
+        - 1
+        - 1
+        - 0
         version: 1.1.0
   type: :development
+  name: bundler
+  version_requirements: *id003
+- !ruby/object:Gem::Dependency 
   prerelease: false
-  version_requirements: *15700940
-- !ruby/object:Gem::Dependency
-  name: jeweler
-  requirement: &15697920 !ruby/object:Gem::Requirement
+  requirement: &id004 !ruby/object:Gem::Requirement 
     none: false
-    requirements:
+    requirements: 
     - - ~>
-      - !ruby/object:Gem::Version
+      - !ruby/object:Gem::Version 
+        hash: 7
+        segments: 
+        - 1
+        - 6
+        - 4
         version: 1.6.4
   type: :development
+  name: jeweler
+  version_requirements: *id004
+- !ruby/object:Gem::Dependency 
   prerelease: false
-  version_requirements: *15697920
-description: ! "Manage Jar files for Ruby. In the spirit of Bundler, a Jarfile\n  is
-  used to generate a Jarfile.lock that contains all the resolved jar dependencies
-  for scopes runtime, compile, and test.\n  The Jarfile.lock can be used to populate
-  the classpath"
+  requirement: &id005 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 63
+        segments: 
+        - 0
+        - 8
+        - 0
+        version: 0.8.0
+  type: :development
+  name: yard
+  version_requirements: *id005
+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
 email: michael.guymon@gmail.com
 executables: []
+
 extensions: []
-extra_rdoc_files:
+
+extra_rdoc_files: 
 - LICENSE
 - README.rdoc
-files:
+files: 
 - Gemfile
 - LICENSE
 - README.rdoc
@@ -91,31 +135,37 @@ files:
 - spec/pom.xml
 - spec/spec_helper.rb
 homepage: http://github.com/mguymon/lock_jar
-licenses:
+licenses: 
 - Apache
 post_install_message: 
 rdoc_options: []
-require_paths:
+
+require_paths: 
 - lib
-required_ruby_version: !ruby/object:Gem::Requirement
+required_ruby_version: !ruby/object:Gem::Requirement 
   none: false
-  requirements:
-  - - ! '>='
-    - !ruby/object:Gem::Version
-      version: '0'
-      segments:
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
       - 0
-      hash: -3207536742551290776
-required_rubygems_version: !ruby/object:Gem::Requirement
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
   none: false
-  requirements:
-  - - ! '>='
-    - !ruby/object:Gem::Version
-      version: '0'
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
 requirements: []
+
 rubyforge_project: 
-rubygems_version: 1.8.15
+rubygems_version: 1.8.24
 signing_key: 
 specification_version: 3
 summary: Manage Jar files for Ruby
 test_files: []
+