ivy4r 0.9.15 → 0.10.0

data/lib/ivy/target.rb

@@ -3,16 +3,20 @@ require 'facets/to_hash'
 require 'facets/hash/op'
 require 'facets/hash/update_values'
 
-module Ivy
+require 'digest/md5'
 
+module Ivy
+  
   # Base class with general logic to call a Ivy ant target
   class Target
     attr_reader :params
-
-    def initialize(ant)
+    
+    def initialize(ant, cache_dir = nil)
+      raise "Cache result directory does not exists '#{cache_dir}'" if cache_dir != nil && !File.directory?(cache_dir)
       @ant = ant
+      @cache_dir = cache_dir
     end
-
+    
     # Executes this ivy target with given parameters returning a result.
     # __params__ can be a single Hash or an Array with or without a Hash as last value.
     # every value in array will be converted to string and set to __true__.
@@ -23,7 +27,35 @@ module Ivy
       @params = {}
       params.pop.each { |key, value| @params[key] = value } if Hash === params.last
       params.each { |key| @params[key.to_s] = true }
-
+      if caching_enabled? && File.exists?(cache_file_path)
+        load_from_yaml
+      else
+        result = execute_target
+        dump_to_yaml(result) if caching_enabled?
+        result
+      end
+    end
+    
+    protected
+    
+    def caching_enabled?
+      @cache_dir != nil
+    end
+    
+    def cache_file_path
+      @cache_file_path ||= File.expand_path(File.join(@cache_dir, Digest::MD5.hexdigest(self.class.to_s + @params.to_s) + '.yaml'))
+    end
+    
+    def load_from_yaml
+      File.open(cache_file_path) {|f| YAML::load(f)}
+    end
+    
+    def dump_to_yaml(result)
+      File.open(cache_file_path, 'w') {|f| YAML.dump(result, f)}
+    end
+    
+    # The bare bone execution of this target without any crosscutting concerns.
+    def execute_target
       validate
       before_hook
       execute_ivy
@@ -31,8 +63,6 @@ module Ivy
     ensure
       after_hook
     end
-
-    protected
     
     # Validates provided hash of parameters, raises an exception if any mandatory parameter is
     # missing or an unknown parameter has been provided.
@@ -42,17 +72,17 @@ module Ivy
       missing = symbols(mandatory_parameter).find_all { |p| params.keys.member?(p) == false }
       raise ArgumentError, "Missing mandatory parameters '#{missing.join(', ')}' for #{self.class}" unless missing.empty?
     end
-
+    
     # Hook method called after validation but before #execute_ivy
     # overwrite for special actions needed
     def before_hook
     end
-
-    # After hook is always called for #execute within +ensure+ block
+    
+    # After hook is always called for #execute_target within +ensure+ block
     # overwrite for special clean up
     def after_hook
     end
-
+    
     # Helper to call the nested ant targets recursively if nessecary. Must be called within +do+ +end+
     # block of ant target to work.
     def call_nested(nested)
@@ -70,7 +100,7 @@ module Ivy
         end
       end
     end
-
+    
     # Creates the result for the execution by default it iterates of the ant properties and fetches
     # all properties that match the result properties for target as a hash. Overwrite to provide
     # a different result
@@ -83,49 +113,49 @@ module Ivy
       result = ant_properties.map do |p|
         rp = result_property_values.find { |rp| rp.matcher === p[0] }
         rp ? [p[0], rp.parse(p[1])].flatten : nil
-      end.compact.to_h(:multi)
-      result.update_values do |v|
-        case v.size
-        when 0
-          nil
-        when 1
-          v[0]
-        else
-          v
+        end.compact.to_h(:multi)
+        result.update_values do |v|
+          case v.size
+            when 0
+            nil
+            when 1
+            v[0]
+          else
+            v
+          end
         end
+        
+        result
+      end
+      
+      def mandatory_parameter
+        parameter.find_all {|p| p.mandatory? }
+      end
+      
+      def symbols(params)
+        params.map{|p| p.symbol}
+      end
+      
+      def ant_properties
+        @ant.project.properties
+      end
+      
+      def ant_references
+        @ant.project.references
       end
-
-      result
-    end
-
-    def mandatory_parameter
-      parameter.find_all {|p| p.mandatory? }
-    end
-
-    def symbols(params)
-      params.map{|p| p.symbol}
     end
     
-    def ant_properties
-      @ant.project.properties
-    end
-
-    def ant_references
-      @ant.project.references
-    end
-  end
-
     COMMA_SPLITTER = Proc.new {|value| value.to_s.split(',').map(&:strip)}
-
-  Parameter = Struct.new(:symbol, :mandatory) do
-    def mandatory?
-      mandatory
+    
+    Parameter = Struct.new(:symbol, :mandatory) do
+      def mandatory?
+        mandatory
+      end
     end
-  end
-
-  ResultValue = Struct.new(:matcher, :parser) do
-    def parse(value)
-      parser ? parser.call(value) : value
+    
+    ResultValue = Struct.new(:matcher, :parser) do
+      def parse(value)
+        parser ? parser.call(value) : value
+      end
     end
   end
-end

data/lib/ivy4r.rb

@@ -35,129 +35,142 @@ is
   }
 =end
 class Ivy4r
-  VERSION = '0.9.15'
-
+  VERSION = '0.10.0'
+  
   # Set the ant home directory to load ant classes from if no custom __antwrap__ is provided
   # and the default provided ant version 1.7.1 should not be used.
   # Must be set before any call to method that uses the ivy is made.
   attr_accessor :ant_home
-
+  
   # Defines the directory to load ivy libs and its dependencies from
   attr_accessor :lib_dir
-
+  
   # Optional ant variable <tt>ivy.project.dir</tt> to add to ant environment before loading ivy
   # defaults to the __lib_dir__
   attr_accessor :project_dir
-
+  
   # The ant property name to use for references to environment properties in ant and ivy,
   # defaults to 'env'
   attr_accessor :environment_property
-
+  
   # To provide a custom __antwrap__ to use instead of default one
-  attr_writer :ant
-
+  attr_accessor :ant
+  
   # Access to ivy settings set via configure or settings method.
   attr_accessor :settings_file
-
+  
+  # Donates the base directory for the cached files, if nil no caching is enabled
+  attr_accessor :cache_dir
+  
   # Initalizes ivy4r with optional ant wrapper object. Sets ant home dir and ivy lib dir
   # to default values from __Ivy4rJars__ gem.
-  def initialize(ant = nil)
+  def initialize(ant_instance = nil, &block)
     @ant_home = ::Ivy4rJars.ant_home_dir
     @lib_dir = ::Ivy4rJars.lib_dir
     @project_dir = @lib_dir
     @environment_property = 'env'
-    @ant = ant
+    @ant = ant_instance
+    
+    if block
+      if block.arity > 1
+        raise ArgumentError, "To many arguments expected=1 given=#{block.arity}"
+      elsif block.arity == 1
+        yield self
+      else
+        instance_eval(&block)
+      end
+    end
   end
-
+  
   # Calls the __cleancache__ ivy target with given parameters.
   def cleancache(*params)
-    Ivy::Cleancache.new(ant).execute(*params)
+    Ivy::Cleancache.new(ant, cache_dir).execute(*params)
   end
-
+  
   # Calls the __settings__ ivy target with given parameters.
   def settings(*params)
-    settings_task = Ivy::Settings.new(ant)
+    settings_task = Ivy::Settings.new(ant, nil) # do not cache settings
     result = settings_task.execute(*params)
     @settings_file = settings_task.params[:file]
     result
   end
-
+  
   # Calls the __configure__ ivy target with given parameters.
   def configure(*params)
-    configure_task = Ivy::Configure.new(ant)
+    configure_task = Ivy::Configure.new(ant, nil) # do not cache configure
     result = configure_task.execute(*params)
     @settings_file = configure_task.params[:file]
     result
   end
-
+  
   # Calls the __info__ ivy target with given parameters and returns info as hash.
   def info(*params)
-    Ivy::Info.new(ant).execute(*params)
+    Ivy::Info.new(ant, cache_dir).execute(*params)
   end
-
+  
   # Calls the __buildnumber__ ivy target with given parameters and returns info as hash.
   def buildnumber(*params)
-    Ivy::Buildnumber.new(ant).execute(*params)
+    Ivy::Buildnumber.new(ant, cache_dir).execute(*params)
   end
-
+  
   # Calls the __listmodules__ ivy target with given parameters and returns info as hash.
   def listmodules(*params) #:nodoc:
-    Ivy::Listmodules.new(ant).execute(*params)
+    Ivy::Listmodules.new(ant, cache_dir).execute(*params)
   end
-
+  
   # Calls the __makepom__ ivy target with given parameters and returns pom content.
   def makepom(*params)
-    Ivy::Makepom.new(ant).execute(*params)
+    Ivy::Makepom.new(ant, cache_dir).execute(*params)
   end
-
+  
   # Calls the __resolve__ ivy target with given parameters and returns info as hash.
   def resolve(*params)
-    Ivy::Resolve.new(ant).execute(*params)
+    Ivy::Resolve.new(ant, cache_dir).execute(*params)
   end
-
+  
   # Calls the __retrieve__ ivy target with given parameters.
   def retrieve(*params)
-    Ivy::Retrieve.new(ant).execute(*params)
+    Ivy::Retrieve.new(ant, cache_dir).execute(*params)
   end
-
+  
   # Calls the __publish__ ivy target with given parameters.
   def publish(*params)
-    Ivy::Publish.new(ant).execute(*params)
+    Ivy::Publish.new(ant, cache_dir).execute(*params)
   end
-
+  
   # Calls the __cachepath__ ivy target with given parameters and returns
   # array containing absolute file paths to all artifacts contained in result
   def cachepath(*params)
-    Ivy::Cachepath.new(ant).execute(*params)
+    Ivy::Cachepath.new(ant, cache_dir).execute(*params)
   end
-
+  
   # Calls the __findrevision__ ivy target with given parameters and returns
   # array containing absolute file paths to all artifacts contained in result
   def findrevision(*params)
-    Ivy::Findrevision.new(ant).execute(*params)
+    Ivy::Findrevision.new(ant, cache_dir).execute(*params)
   end
-
+  
   # Calls the __artifactproperty__ ivy target with given parameters and returns
   # map with all defined properties
   def artifactproperty(*params)
-    Ivy::Artifactproperty.new(ant).execute(*params)
+    Ivy::Artifactproperty.new(ant, cache_dir).execute(*params)
   end
-    
+  
   # Calls the __buildlist__ ivy target with given parameters and returns
   # the resulting buildlist
   def buildlist(*params)
-    Ivy::Buildlist.new(ant).execute(*params)
+    Ivy::Buildlist.new(ant, cache_dir).execute(*params)
   end
-
+  
   # Calls the __artifactreport__ ivy target with given parameters and returns
   # the created xml.
   def artifactreport(*params)
-    Ivy::Artifactreport.new(ant).execute(*params)
+    Ivy::Artifactreport.new(ant, cache_dir).execute(*params)
   end
-
+  
   # Calls the __report__ ivy target with given parameters
   def report(*params)
-    Ivy::Report.new(ant).execute(*params)
+    Ivy::Report.new(ant, cache_dir).execute(*params)
   end
   
   # Used to get or set ant properties.
@@ -166,7 +179,7 @@ class Ivy4r
   def property
     AntPropertyHelper.new(ant, ant_properties)
   end
-
+  
   # Returns the __antwrap__ instance to use for all internal calls creates a default
   # instance if no instance has been set before.
   def ant
@@ -175,12 +188,12 @@ class Ivy4r
     init(@ant) if should_init?
     @ant
   end
-
+  
   private
   def should_init?
     @init_done.nil? || @init_done == false
   end
-
+  
   def init(ant)
     @init_done = true
     ant.property :environment => environment_property
@@ -188,7 +201,7 @@ class Ivy4r
     ant.path :id => 'ivy.lib.path' do
       ant.fileset :dir => lib_dir, :includes => '*.jar'
     end
-
+    
     ant.typedef :name => "ivy_settings", :classname => "org.apache.ivy.ant.IvyAntSettings", :classpathref => "ivy.lib.path", :loaderRef => 'ivy.lib.path.loader', :loaderRef => 'ivy.lib.path.loader'
     ant.taskdef :name => "ivy_configure", :classname => "org.apache.ivy.ant.IvyConfigure", :classpathref => "ivy.lib.path", :loaderRef => 'ivy.lib.path.loader'
     ant.taskdef :name => "ivy_resolve", :classname => "org.apache.ivy.ant.IvyResolve", :classpathref => "ivy.lib.path", :loaderRef => 'ivy.lib.path.loader'
@@ -215,7 +228,7 @@ class Ivy4r
     ant.taskdef :name => "ivy_buildnumber", :classname => "org.apache.ivy.ant.IvyBuildNumber", :classpathref => "ivy.lib.path", :loaderRef => 'ivy.lib.path.loader'
     ant.taskdef :name => "ivy_cleancache", :classname => "org.apache.ivy.ant.IvyCleanCache", :classpathref => "ivy.lib.path", :loaderRef => 'ivy.lib.path.loader'
   end
-
+  
   # Returns the ant properties, note that this are java objects.
   def ant_properties
     ant.project.properties
@@ -226,7 +239,7 @@ AntPropertyHelper = Struct.new(:ant, :ant_properties) do #:nodoc:
   def []=(name, value) #:nodoc:
     ant.property :name => name, :value => value
   end
-
+  
   def [](matcher) #:nodoc:
     property = ant_properties.find {|p| matcher === p[0] }
     property ? property[1] : nil

data/lib/rake/ivy_extension.rb

@@ -7,35 +7,50 @@ end
 module Rake
   module Ivy
     class IvyConfig
-
+      
       # The directory to load ivy jars and its dependencies from, leave __nil__ to use default
       attr_accessor :lib_dir
-
+      
       # The extension directory containing ivy settings, the local repository and cache
       attr_accessor :extension_dir
-
+      
       # Returns the resolve result
       attr_reader :resolved
       
       attr_reader :post_resolve_tasks
-
+      
       # Store the current rake application and initialize ivy ant wrapper
       def initialize(application)
         @application = application
         @extension_dir = File.join("#{@application.original_dir}", "#{ENV['IVY_EXT_DIR']}")
         @post_resolve_tasks = []
       end
-
+      
       # Returns the correct ant instance to use.
       def ivy4r
         unless @ivy4r
-          @ivy4r = ::Ivy4r.new
+          @ivy4r = ::Ivy4r.new do |i|
+            if caching_enabled?
+            end
+          end
           @ivy4r.lib_dir = lib_dir if lib_dir
           @ivy4r.project_dir = @extension_dir
         end
         @ivy4r
       end
-
+      
+      # Returns if ivy result caching is enabled by existence of the marker file.
+      def caching_enabled?
+        File.exists? 'use_ivy_caching'
+      end
+      
+      # Returns the dir to store ivy caching results in.
+      def result_cache_dir
+        dir = File.expand_path('ivycaching')
+        FileUtils.mkdir_p dir
+        dir
+      end
+      
       # Returns the artifacts for given configurations as array
       # this is a post resolve task.
       # the arguments are checked for the following:
@@ -59,17 +74,17 @@ module Rake
           pathid = "ivy.deps." + confs.join('.') + '.' + types.join('.')
           params = {:conf => confs.join(','), :pathid => pathid}
           params[:type] = types.join(',') unless types.nil? || types.size == 0
-
+          
           ivy4r.cachepath params
         end
       end
-
+      
       # Returns ivy info for configured ivy file.
       def info
         ivy4r.settings :id => 'ivy.info.settingsref'
         ivy4r.info :file => file, :settingsRef => 'ivy.info.settingsref'
       end
-
+      
       # Configures the ivy instance with additional properties and loading the settings file if it was provided
       def configure
         unless @configured
@@ -79,7 +94,7 @@ module Rake
           @configured = ivy4r.settings :file => settings if settings
         end
       end
-
+      
       # Resolves the configured file once.
       def __resolve__
         unless @resolved
@@ -88,12 +103,12 @@ module Rake
         end
         @resolved
       end
-
+      
       # Creates the standard ivy dependency report
       def report
         ivy4r.report :todir => report_dir
       end
-
+      
       # Publishs the project as defined in ivy file if it has not been published already
       def __publish__
         unless @published
@@ -105,19 +120,19 @@ module Rake
           @published = true
         end
       end
-
+      
       def home
         @ivy_home_dir ||= "#{@extension_dir}/ivy-home"
       end
-
+      
       def settings
         @settings ||= "#{@extension_dir}/ant-scripts/ivysettings.xml"
       end
-
+      
       def file
         @ivy_file ||= 'ivy.xml'
       end
-
+      
       # Sets the revision to use for the project, this is useful for development revisions that
       # have an appended timestamp or any other dynamic revisioning.
       #
@@ -142,7 +157,7 @@ module Rake
           self
         end
       end
-
+      
       # Sets the status to use for the project, this is useful for custom status handling
       # like integration, alpha, gold.
       #
@@ -167,7 +182,7 @@ module Rake
           self
         end
       end
-
+      
       # Sets the publish options to use for the project. The options are merged with the default
       # options including value set via #publish_from and overwrite all of them.
       #
@@ -194,7 +209,7 @@ module Rake
           end
         end
       end
-
+      
       # Sets the additional properties for the ivy process use a Hash with the properties to set.
       def properties(*properties)
         if properties.empty?
@@ -205,7 +220,7 @@ module Rake
           self
         end
       end
-
+      
       # Sets the local repository for ivy files
       def local_repository(*local_repository)
         if local_repository.empty?
@@ -216,7 +231,7 @@ module Rake
           self
         end
       end
-
+      
       # Sets the directory to publish artifacts from.
       def publish_from(*publish_dir)
         if publish_dir.empty?
@@ -227,7 +242,7 @@ module Rake
           self
         end
       end
-
+      
       # Sets the directory to create dependency reports in.
       def report_dir(*report_dir)
         if report_dir.empty?
@@ -239,46 +254,46 @@ module Rake
         end
       end
     end
-
-      # Adds given block as post resolve action that is executed directly after #resolve has been called.
-      # Yields this ivy config object into block.
-      # <tt>project.ivy.post_resolve { |ivy| p "all deps:" + ivy.deps('all').join(", ") }</tt>
-      def post_resolve(&block)
-        post_resolve_tasks << block if block
+    
+    # Adds given block as post resolve action that is executed directly after #resolve has been called.
+    # Yields this ivy config object into block.
+    # <tt>project.ivy.post_resolve { |ivy| p "all deps:" + ivy.deps('all').join(", ") }</tt>
+    def post_resolve(&block)
+      post_resolve_tasks << block if block
+    end
+    
+    # Filter artifacts for given configuration with provided filter values, this is a post resolve
+    # task like #deps.
+    # <tt>project.ivy.filter('server', 'client', :include => /b.*.jar/, :exclude => [/a\.jar/, /other.*\.jar/])</tt>
+    def filter(*confs)
+      filter = confs.last.kind_of?(Hash) ? confs.pop : {}
+      unless (filter.keys - (TYPES - [:conf])).empty?
+        raise ArgumentError, "Invalid filter use :include and/or :exclude only: given #{filter.keys.inspect}"
       end
-
-      # Filter artifacts for given configuration with provided filter values, this is a post resolve
-      # task like #deps.
-      # <tt>project.ivy.filter('server', 'client', :include => /b.*.jar/, :exclude => [/a\.jar/, /other.*\.jar/])</tt>
-      def filter(*confs)
-        filter = confs.last.kind_of?(Hash) ? confs.pop : {}
-        unless (filter.keys - (TYPES - [:conf])).empty?
-          raise ArgumentError, "Invalid filter use :include and/or :exclude only: given #{filter.keys.inspect}"
-        end
-        includes, excludes, types = filter[:include] || [], filter[:exclude] || [], filter[:type] || []
-
-        artifacts = deps(confs.flatten, types.flatten)
-        if artifacts
-          artifacts = artifacts.find_all do |lib|
-            lib = File.basename(lib)
-            includes = includes.reject {|i| i.nil? || i.blank? }
-            should_include = includes.empty? || includes.any? {|include| include === lib }
-            should_include && !excludes.any? {|exclude| exclude === lib}
-          end
+      includes, excludes, types = filter[:include] || [], filter[:exclude] || [], filter[:type] || []
+      
+      artifacts = deps(confs.flatten, types.flatten)
+      if artifacts
+        artifacts = artifacts.find_all do |lib|
+          lib = File.basename(lib)
+          includes = includes.reject {|i| i.nil? || i.blank? }
+          should_include = includes.empty? || includes.any? {|include| include === lib }
+          should_include && !excludes.any? {|exclude| exclude === lib}
         end
-
-        artifacts
       end
-
+      
+      artifacts
+    end
+    
     class Tasks < ::Rake::TaskLib
       def initialize(ivy = nil, &block)
         @ivy = ivy || Rake::Ivy::IvyConfig.new(Rake.application)
         yield @ivy if block_given?
         Rake.application.ivy = @ivy
-
+        
         define
       end
-
+      
       private
       def define
         namespace 'ivy' do
@@ -290,21 +305,39 @@ module Rake
           task :resolve => "ivy:configure" do
             Rake.application.ivy.__resolve__
           end
-
+          
           desc 'Publish the artifacts to ivy repository'
           task :publish => "ivy:resolve" do
             Rake.application.ivy.__publish__
           end
-
+          
           desc 'Creates a dependency report for the project'
           task :report => "ivy:resolve" do
             Rake.application.ivy.report
           end
-
+          
           desc 'Clean the local Ivy cache and the local ivy repository'
           task :clean do
             Rake.application.ivy.ivy4r.clean
           end
+          
+          desc 'Clean the local Ivy result cache to force execution of ivy targets'
+          task :cleanresultcache do
+            puts "Deleting IVY result cache dir '#{Rake.application.ivy.result_cache_dir}'"
+            rm_rf Rake.application.ivy.result_cache_dir
+          end
+          
+          desc 'Enable the local Ivy result cache by creating the marker file'
+          task :enableresultcache do
+            puts "Creating IVY caching marker file '#{Rake.application.ivy.caching_marker}'"
+            touch Rake.application.ivy.caching_marker
+          end
+          
+          desc 'Disable the local Ivy result cache by removing the marker file'
+          task :disableresultcache do
+            puts "Deleting IVY aching marker file '#{Rake.application.ivy.caching_marker}'"
+            rm_f Rake.application.ivy.caching_marker
+          end
         end
       end
     end