klaas1979-ivy4r 0.2.0 → 0.3.0

data/Manifest.txt

@@ -3,6 +3,9 @@ Manifest.txt
 README.txt
 Rakefile
 bin/ivy4r
+jars/lib/ant-1.7.1.jar
+jars/lib/ant-launcher-1.7.1.jar
+jars/lib/ant-trax-1.7.1.jar
 lib/buildr/ivy_extension.rb
 lib/ivy/artifactproperty.rb
 lib/ivy/artifactreport.rb

data/Rakefile

@@ -8,6 +8,7 @@ require 'ivy4r'
 hoe = Hoe.spec 'ivy4r' do |p|
   # self.rubyforge_name = 'ivy4rx' # if different than 'ivy4r'
   p.developer('Klaas Prause', 'klaas.prause@googlemail.com')
+  p.remote_rdoc_dir = '' # Release to root only one project
   p.extra_deps = [['Antwrap', '>=0.7.0']]
   File.open(File.join(File.dirname(__FILE__), 'VERSION'), 'w') do |file|
     file.puts Ivy4r::VERSION

data/lib/buildr/ivy_extension.rb

@@ -64,7 +64,7 @@ module Buildr
         @ant
       end
 
-      # Returns name of publish target to use for this project
+      # Returns name of the project the ivy file belongs to.
       def file_project
         own_file? ? @project : @base_ivy.file_project
       end
@@ -369,7 +369,26 @@ module Buildr
       end
     end
 
-    # The Ivy Buildr extension adding the new tasks for ivy.
+=begin rdoc
+The Ivy Buildr extension adding the new tasks for ivy.
+
+To use ivy in a +buildfile+ do something like:
+  ENV['BUILDR_EXT_DIR'] ||= '../Ivy'
+  require 'buildr/ivy_extension'
+    define 'ivy_project' do
+    [...]
+    ivy.compile_conf('compile').test_conf('test').package_conf('prod', 'server')
+    [...]
+  end
+
+- This will add the +compile+ configuration to compile and test tasks
+- Add the +test+ configuration to test compilation and execution
+- include the artifacts from +prod+ and +server+ to any generated war or ear
+- The ENV variable is needed to automatically configure the load path for ivy libs.
+  It assumes that you have the following dir structure <tt>[BUILDR_EXT_DIR]/ivy-home/jars</tt>
+
+For more configuration options see IvyConfig.
+=end
     module IvyExtension
       include Buildr::Extension
 

data/lib/ivy4r.rb

@@ -1,10 +1,44 @@
 require 'antwrap'
 require 'ivy/targets'
 
+=begin rdoc
+Simple wrapper that maps the ant ivy targets one to one to ruby. See the {Apache Ivy}[http://ant.apache.org/ivy/index.html]
+for more informations about the parameters for a call. All ivy ant targets have the equivalent
+name in this class.
+
+The standard parameters are provided as Hash, i.e.:
+  <ivy:configure file="settings.xml" settingsId="my.id" />
+is
+  ivy4r.configure :file => "settings.xml", :settingsId => 'my.id'
+
+You can use nested options via the nested attribute:
+  <ivy:buildlist reference="testpath">
+    <fileset dir="target/p1" includes="buildfile" />
+  </ivy:buildlist>
+is
+  @ivy4r.buildlist :reference => 'testpath', :nested => {
+    :fileset => {:dir => 'target/p1', :includes => 'buildfile'}
+  }
+
+you can nest more than on element of the same type using an array:
+  <ivy:buildlist reference="testpath">
+    <fileset dir="target/sub" includes="**/buildfile" />
+    <fileset dir="target/p1" includes="buildfile" />
+  </ivy:buildlist>
+is
+  @ivy4r.buildlist :reference => 'testpath', :nested => {
+    :fileset => [
+      {:dir => 'target/sub', :includes => '**/buildfile'},
+      {:dir => 'target/p1', :includes => 'buildfile'}
+    ]
+  }
+=end
 class Ivy4r
-  VERSION = '0.2.0'
+  VERSION = '0.3.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
@@ -105,9 +139,9 @@ class Ivy4r
     Ivy::Report.new(ant).execute(*params)
   end
 
-  # Used to get or set an ant properties
+  # Used to get or set ant properties.
   # [set] <tt>property['name'] = value</tt> sets the ant property with name to given value no overwrite
-  # [get] <tt>property[matcher]/tt> gets property that is equal via case equality operator (+===+)
+  # [get] <tt>property[matcher]</tt> gets property that is equal via case equality operator (<tt>===</tt>)
   def property
     AntPropertyHelper.new(ant_properties)
   end
@@ -115,8 +149,8 @@ class Ivy4r
   # Returns the __antwrap__ instance to use for all internal calls creates a default
   # instance if no instance has been set before.
   def ant
-    @ant ||= ::Antwrap::AntProject.new(:ant_home => ant_home, :name => "ivy-ant",
-      :basedir => Dir.pwd, :declarative => true)
+    @ant ||= ::Antwrap::AntProject.new(:ant_home => ant_home || File.expand_path(File.join(File.dirname(__FILE__), '..', 'jars')),
+      :name => "ivy-ant", :basedir => Dir.pwd, :declarative => true)
     init(@ant) if should_init?
     @ant
   end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: klaas1979-ivy4r
 version: !ruby/object:Gem::Version 
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors: 
 - Klaas Prause
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-06-18 00:00:00 -07:00
+date: 2009-06-19 00:00:00 -07:00
 default_executable: ivy4r
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -30,7 +30,7 @@ dependencies:
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        version: 2.1.0
+        version: 2.2.0
     version: 
 description: Apache Ivy dependency manager wrapper for ruby (see {Apache Ivy}[http://ant.apache.org/ivy/index.html] for more information). Use {Apache Ivy}[http://ant.apache.org/ivy/index.html] via a ruby wrapper without the need to use Apache Ant. The wrapper uses Antwrap[http://antwrap.rubyforge.org/] to interface with Ivy.  Includes a Extension for Buildr[http://buildr.apache.org/] to use {Apache Ivy}[http://ant.apache.org/ivy/index.html] for dependency management.
 email: 
@@ -49,6 +49,9 @@ files:
 - README.txt
 - Rakefile
 - bin/ivy4r
+- jars/lib/ant-1.7.1.jar
+- jars/lib/ant-launcher-1.7.1.jar
+- jars/lib/ant-trax-1.7.1.jar
 - lib/buildr/ivy_extension.rb
 - lib/ivy/artifactproperty.rb
 - lib/ivy/artifactreport.rb