lock_jar 0.6.2 → 0.7.0

data/lib/lock_jar/domain/dsl.rb

@@ -0,0 +1,177 @@
+# 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 'lock_jar/maven'
+require 'lock_jar/domain/dsl_helper'
+require 'lock_jar/domain/artifact'
+
+module LockJar
+  module Domain
+    class Dsl
+  
+      DEFAULT_GROUP = ['default']
+      
+      attr_accessor :artifacts, :remote_repositories, :local_repository, :groups,
+                    :maps, :excludes, :merged
+                    
+      attr_reader :file_path
+      
+      class << self
+      
+        def create(jarfile = nil, &blk)
+          builder = new
+          evaluate(builder, jarfile, &blk)
+        end
+        
+        def evaluate(builder, jarfile = nil, &blk)
+          if jarfile.nil? && blk.nil?
+            raise "jarfile or block must be set"
+          end
+          
+          if jarfile
+            builder.instance_eval(DslHelper.read_file(jarfile.to_s), jarfile.to_s, 1)
+          end      
+              
+          if blk
+            builder.instance_eval(&blk)
+          end      
+          
+          builder
+        end
+        
+      end
+      
+      def initialize
+  
+        @remote_repositories = []
+        @artifacts = { 'default' => [] }
+         
+        @group_changed = false
+          
+        @present_group = 'default'
+        
+        @local_repository = nil
+        @maps = {}
+        
+        @excludes = []
+        
+        @merged = []
+      end
+      
+      def exclude(*notations)
+        @excludes += notations
+      end
+      
+      def jar(notation, *args)
+        opts = {}
+        if args.last.is_a? Hash
+          opts.merge!( args.last )
+        end
+        
+        artifact = Jar.new( notation )
+        
+        assign_groups( artifact, opts[:group] )
+      end
+      
+      def local( *args )
+        if !args.empty? && File.directory?( File.expand_path( args.first ) )
+          warn "[DEPRECATION] `local` to set local_repository is deprecated.  Please use `local_repo` instead."
+          local_repo(args.first)
+        else
+          # XXX: support local artifacts
+        end
+      end
+  
+      def local_repo( path )
+        @local_repository = path
+      end
+      
+      alias_method :name, :local_repository
+      
+      # Map a dependency to another dependency or local directory.
+      def map( notation, *args )
+        @maps[notation] = args
+      end
+      
+      # 
+      def pom(path, *args)
+        unless path =~ /\.xml$/i
+          raise "#{path} is an invalid pom path"  
+        end
+        
+        opts = { :scopes => ['runtime', 'compile'] }
+          
+        if args.last.is_a? Hash
+          opts.merge! args.last
+        end
+        
+        artifact = Pom.new( path, opts[:scopes] )
+        
+        assign_groups( artifact, opts[:groups] )
+      end
+  
+      def remote_repo( url, opts = {} )
+        @remote_repositories << url
+      end
+      alias_method :remote_repository, :remote_repo
+      alias_method :repository, :remote_repo
+      
+      def group(*groups, &blk)
+         @group_changed = true
+         groups.each do |group|
+           @present_group = group.to_s
+           yield
+         end
+         @group_changed = false
+         @present_group = 'default'
+      end   
+      
+      # @deprecated Please use {#group} instead
+      def scope(*scopes, &blk)
+        warn "[DEPRECATION] `scope` is deprecated.  Please use `group` instead."
+        group(*scopes,&blk)
+      end
+      
+      private 
+      def assign_groups(artifact, groups=nil)
+        
+        if groups
+          
+          unless groups.is_a? Array
+            groups = [groups]
+          end
+          
+          # include present group if within a group block
+          if @group_changed
+            groups << @present_group
+          end
+          
+        else
+          groups = [@present_group]
+        end
+        
+        if artifact
+          groups.uniq.each do |group|
+            group_key = group.to_s
+            @artifacts[group_key] = [] unless @artifacts[group_key]
+            @artifacts[group_key] << artifact
+          end
+        end
+        
+      end
+      
+    end
+  end
+end

data/lib/lock_jar/domain/dsl_helper.rb

@@ -0,0 +1,66 @@
+# 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.
+
+module LockJar
+  module Domain
+    class DslHelper
+  
+      class << self
+      
+        #
+        # Merge LockJar::Domain::Dsl
+        #
+        def merge( into_dsl, from_dsl )
+          into_dsl.remote_repositories = (into_dsl.remote_repositories + from_dsl.remote_repositories).uniq
+          
+          from_dsl.artifacts.each do |group, artifacts|
+            group_artifacts = into_dsl.artifacts[group] || []
+            artifacts.each do |art|
+              unless group_artifacts.include? art
+                group_artifacts << art
+              end
+            end
+            into_dsl.artifacts[group] = group_artifacts
+          end
+          
+          from_dsl.maps.each do |artifact,paths|
+            existing_map = into_dsl.maps[artifact]
+            if existing_map
+              into_dsl.maps[artifact] = (existing_map + paths).uniq
+            else
+              into_dsl.maps[artifact] = paths
+            end
+          end
+          
+          from_dsl.excludes.each do |exclude|
+            unless into_dsl.include? exclude
+              into_dsl.excludes << exclude
+            end
+          end
+          
+          if from_dsl.file_path
+            into_dsl.merged << from_dsl.file_path
+          end
+          
+          into_dsl
+        end
+      
+        def read_file(file)
+          File.open(file, "rb") { |f| f.read }
+        end
+      end
+    end
+  end
+end

data/lib/lock_jar/domain/gem_dsl.rb

@@ -0,0 +1,45 @@
+# 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 'lock_jar/maven'
+require 'lock_jar/domain/jarfile_dsl'
+require 'lock_jar/domain/dsl_helper'
+
+module LockJar
+  module Domain
+    class GemDsl < JarfileDsl
+  
+      attr_accessor :gem_dir
+      
+      class << self
+        alias :overriden_create :create
+        def create(spec, jarfile)
+          builder = new
+          builder.gem_dir = spec.gem_dir
+          
+          jarfile = File.join( spec.gem_dir, jarfile )
+          builder.file_path = "gem:#{spec.name}:#{jarfile.gsub( "#{spec.base_dir}/", "" )}"
+          
+          evaluate(builder, jarfile)
+        end
+      end
+      
+      alias :overriden_pom :pom
+      def pom(path, *args)
+        overriden_pom( File.join( gem_dir, path), *args)
+      end
+    end
+  end
+end

data/lib/lock_jar/domain/jarfile_dsl.rb

@@ -0,0 +1,37 @@
+# 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 'lock_jar/maven'
+require 'lock_jar/domain/dsl_helper'
+
+module LockJar
+  module Domain
+    class JarfileDsl < Dsl
+  
+      attr_accessor :file_path
+      
+      class << self
+        alias :overriden_create :create
+        def create(jarfile)
+          builder = new
+          builder.file_path = jarfile
+          
+          evaluate(builder, jarfile)
+        end
+      end
+  
+    end
+  end
+end

data/lib/lock_jar/domain/lockfile.rb

@@ -0,0 +1,114 @@
+# 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 'lock_jar/version'
+
+module LockJar
+  module Domain
+    class Lockfile
+      
+      attr_accessor :local_repository, :maps, :excludes, :remote_repositories, 
+                    :version, :groups, :gems, :merged
+      attr_reader :force_utf8
+      
+      
+      def self.read( path )
+        lockfile = Lockfile.new
+        
+        lock_data = YAML.load_file( path )
+        
+        lockfile.version = lock_data['version'] || LockJar::VERSION
+        
+        lockfile.local_repository = lock_data['local_repository']
+        lockfile.merged = lock_data['merged'] || []
+        lockfile.maps = lock_data['maps'] || []
+        lockfile.excludes = lock_data['excludes'] || []
+        lockfile.groups = lock_data['groups'] || lock_data['scopes'] || {}
+        lockfile.remote_repositories = lock_data['remote_repositories'] || lock_data['repositories'] || []
+        lockfile.gems = lock_data['gems'] || []
+        lockfile
+      end
+      
+      def initialize
+        @force_utf8 ||= RUBY_VERSION =~ /^1.9/
+        @groups = { 'default' => {} }
+        @maps = []
+        @excludes = []
+        @remote_repositories = []
+        @gems = []
+        @merged = []
+        
+        @version = LockJar::VERSION # default version
+      end
+      
+      def to_hash
+        lock_data = { 'version' => @version }
+  
+        unless local_repository.nil?
+          lock_data['local_repository'] = local_repository
+          
+          if @force_utf8
+            lock_data['local_repository'] = lock_data['local_repository'].force_encoding("UTF-8")
+          end
+        end
+            
+        unless merged.empty?
+          lock_data['merged'] = merged
+        end
+        
+        if maps.size > 0
+          lock_data['maps'] = maps
+        end
+        
+        if excludes.size > 0 
+          lock_data['excludes'] = excludes
+            
+          if @force_utf8
+            lock_data['excludes'].map! { |exclude| exclude.force_encoding("UTF-8") }
+          end
+        end
+        
+        unless gems.empty?
+          lock_data['gems'] = gems
+        end
+        
+        lock_data['groups'] = groups
+        
+        #if @force_utf8
+        #  lock_data['groups'].each do |group, group_notations|
+        #    group_notations.map! { |notation| notation.force_encoding("UTF-8") }
+        #  end
+        #end
+        
+        if remote_repositories.size > 0
+          lock_data['remote_repositories'] = remote_repositories
+        end
+        
+        lock_data
+      end
+      
+      def to_yaml
+        to_hash.to_yaml
+      end
+      
+      def write( path )
+        File.open( path, "w") do |f|
+          f.write( to_yaml )
+        end
+      end
+    end
+  end
+end

data/lib/lock_jar/maven.rb

@@ -30,7 +30,6 @@ module LockJar
       # Get the version of a POM
       #
       # @param [String] pom_path path to the pom
-      # @param [Hash] options
       #
       # @return [String] version of POM
       #
@@ -39,6 +38,19 @@ module LockJar
         maven.version()
       end
       
+      #
+      # Get dependencies of a Pom
+      #
+      # @param [String] pom_path path to the pom
+      # @param [Array] scopes
+      #
+      # @return [String] version of POM
+      #
+      def dependencies( pom_path, scopes = ['compile', 'runtime'] )
+        maven = Naether::Maven.create_from_pom( pom_path )
+        maven.dependencies(scopes)
+      end
+      
       #
       # Write a POM from list of notations
       #

data/lib/lock_jar/registry.rb

@@ -1,13 +1,46 @@
+# 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.
 
+#
+# Registry of resources loaded by LockJar
+#
+# @author Michael Guymon
+#
 class LockJar::Registry
     include Singleton
     
     attr_accessor :loaded_gems
     attr_accessor :loaded_jars
+    attr_accessor :loaded_lockfiles
     
     def initialize
       @loaded_gems = {}
       @loaded_jars = []
+      @loaded_lockfiles = []
+    end
+    
+    def lockfile_registered?( lockfile )
+      if lockfile
+        @loaded_lockfiles.include? File.expand_path( lockfile )
+      end
+    end
+    
+    def register_lockfile( lockfile )
+      if lockfile && !lockfile_registered?( lockfile )
+        @loaded_lockfiles << File.expand_path( lockfile )
+      end
     end
     
     def register_jars( jars )
@@ -20,9 +53,17 @@ class LockJar::Registry
       end
     end
     
+    def register_gem( spec )
+      @loaded_gems[spec.name] = spec
+    end
+    
+    def gem_registered?( spec )
+      !@loaded_gems[spec.name].nil?
+    end
+    
     def load_gem( spec )
-      if @loaded_gems[spec.name].nil?
-        @loaded_gems[spec.name] = spec
+      unless gem_registered?( spec )
+        register_gem(spec)
         gem_dir = spec.gem_dir
   		
         lockfile = File.join( gem_dir, "Jarfile.lock" )
@@ -37,9 +78,9 @@ class LockJar::Registry
     def load_jars_for_gems      
       specs = Gem.loaded_specs
       if specs 
-        gems_to_check = specs.keys - @loaded_gems.keys
-        if gems_to_check.size > 0
-          gems_to_check.each do |key|
+        gems = specs.keys - @loaded_gems.keys
+        if gems.size > 0
+          gems.each do |key|
             spec = specs[key]
             load_gem( spec )
           end 

data/lib/lock_jar/resolver.rb

@@ -22,7 +22,7 @@ module LockJar
     
     attr_reader :opts
     attr_reader :naether
-    
+        
     def initialize( opts = {} )
 
       @opts = opts
@@ -53,6 +53,10 @@ module LockJar
       @naether.dependencies_notation
     end
     
+    def dependencies_graph
+      @naether.dependencies_graph
+    end
+    
     def download( dependencies )
       @naether.download_artifacts( dependencies )
     end