RubyGems - Antwrap - Versions diffs - 0.5.0 → 0.5.2 - Mend

Antwrap 0.5.0 → 0.5.2

Files changed (9) hide show

data/docs/index.html CHANGED

@@ -1,12 +1,14 @@
-<html><head><title>Antwrap - Invoke Ant tasks from your JRuby script!</title></head><body><ul>
+<html><head><title>Antwrap - Invoke Ant tasks from your Ruby/JRuby scripts!</title></head><body><ul>
 <pre><li>Sample code of the Antwrap library looks like this;
 <code lang="ruby">
     #All options are optional. The defaults are as follows;
     #{:name=&gt'', :basedir=&gt'.', :declarative=&gt true, :logger=&gt Logger.new(STDOUT), :loglevel=&gt Logger::DEBUG}
-    #so you can call AntProject.new() if you like.
+    #so you can call AntProject.new() if you like. If you specify an :ant_home property, Antwrap will load the jar files
+    for you dynamically. If not, it is assumed that they are in your Classpath.
-    @ant = AntProject.new({:name=&gt"FooProject",
+    @ant = AntProject.new({:ant_home=&gt"/Users/fooman/tools/apache-ant-1.7.0",
+    					   :name=&gt"FooProject",
                            :basedir=&gt current_dir,
                            :declarative=&gt true,
                            :logger=&gt Logger.new(STDOUT),
@@ -88,7 +90,9 @@ underscore (see above).
 </li>
 <li>Antwrap is a Beta release. I'd love any feedback you can provide on your experence with it.
-There are no 3rd party jars required other than the Ant jar files in your JRuby Classpath.
+There are no 3rd party jars required other than the Ant jar files in your Classpath. Antwrap will run
+on both the Ruby and the JRuby platforms. The Ruby gem requires the Ruby Java Bridge (RJG) gem
+in order to instantiate Java objects.
 </li></pre>
 </ul>

data/lib/antwrap.rb CHANGED

@@ -1,48 +1,15 @@
-# antwrap
+# antwrap.rb
 #
 # Copyright Caleb Powell 2007
 #
 # Licensed under the LGPL, see the file COPYING in the distribution
 #
-if(RUBY_PLATFORM == 'java')
-  require 'jruby_modules.rb'
-else
-  require 'rjb_modules.rb'
-end
+require 'antwrap_utilities'
 class AntTask
-  private
   @@task_stack = Array.new
   attr_accessor(:unknown_element, :project, :taskname, :logger, :executed)
-  def create_unknown_element(project, taskname)
-    element = ApacheAnt::UnknownElement.new(taskname)
-    element.setProject(project)
-    element.setOwningTarget(ApacheAnt::Target.new())
-    element.setTaskName(taskname)
-    if(@project_wrapper.ant_version >= 1.6)
-      element.setTaskType(taskname)
-      element.setNamespace('')
-      element.setQName(taskname)
-    end
-    return element
-  end
-  def method_missing(sym, *args)
-    begin
-      @logger.debug("AntTask.method_missing sym[#{sym.to_s}]")
-      task = AntTask.new(sym.to_s, @project_wrapper, args[0], block_given? ? Proc.new : nil)
-      self.add(task)
-    rescue StandardError
-      @logger.error("AntTask.method_missing error:" + $!)
-    end
-  end
   public
   def initialize(taskname, antProject, attributes, proc)
     taskname = taskname[1, taskname.length-1] if taskname[0,1] == "_"
@@ -54,10 +21,10 @@ class AntTask
     @unknown_element = create_unknown_element(@project, taskname)
     @logger.debug(to_s)
-    addAttributes(attributes)
+    add_attributes(attributes)
     if proc
-#      @logger.debug("task_stack.push #{taskname} >> #{@@task_stack}")
+      @logger.debug("task_stack.push #{taskname} >> #{@@task_stack}")
       @@task_stack.push self
       singleton_class = class << proc; self; end
@@ -72,10 +39,44 @@ class AntTask
   end
+  def to_s
+    return self.class.name + "[#{@taskname}]"
+  end
+  def create_unknown_element(project, taskname)
+    element = ApacheAnt::UnknownElement.new(taskname)
+    element.setProject(project)
+    element.setOwningTarget(ApacheAnt::Target.new())
+    element.setTaskName(taskname)
+    #DNR. This initializes the Task's Wrapper object and prevents NullPointerExeption upon execution of the task
+    element.getRuntimeConfigurableWrapper()
+    if(@project_wrapper.ant_version >= 1.6)
+      element.setTaskType(taskname)
+      element.setNamespace('')
+      element.setQName(taskname)
+    end
+    return element
+  end
+  def method_missing(sym, *args)
+    begin
+      @logger.debug("AntTask.method_missing sym[#{sym.to_s}]")
+      task = AntTask.new(sym.to_s, @project_wrapper, args[0], block_given? ? Proc.new : nil)
+      self.add(task)
+    rescue StandardError
+      @logger.error("AntTask.method_missing error:" + $!)
+    end
+  end
   # Sets each attribute on the AntTask instance.
   # :attributes - is a Hash.
-  def addAttributes(attributes)
+  def add_attributes(attributes)
     return if attributes == nil
@@ -99,14 +100,10 @@ class AntTask
   #Add <em>child</em> as a child of this task.
   def add(child)
-#    @logger.debug("adding child[#{child.taskname()}] to [#{@taskname}]")
-    @unknown_element.addChild(child.getUnknownElement())
-    @unknown_element.getRuntimeConfigurableWrapper().addChild(child.getUnknownElement().getRuntimeConfigurableWrapper())
-  end
-  def getUnknownElement
-    return @unknown_element
+    @unknown_element.addChild(child.unknown_element())
+    @unknown_element.getRuntimeConfigurableWrapper().addChild(child.unknown_element().getRuntimeConfigurableWrapper())
   end
   #Invokes the AntTask.
   def execute
     @unknown_element.maybeConfigure
@@ -114,24 +111,41 @@ class AntTask
     @executed = true
   end
-  def to_s
-    return self.class.name + "[#{@taskname}]"
-  end
 end
 class AntProject
   require 'logger'
+  private
+  @@classes_loaded = false
+  def init_project(options)
+    @project= ApacheAnt::Project.new
+    @project.setName(options[:name] || '')
+    @project.setDefault('')
+    @project.setBasedir(options[:basedir] || '.')
+    @project.init
+    self.declarative= options[:declarative] || true
+    default_logger = ApacheAnt::DefaultLogger.new
+    default_logger.setMessageOutputLevel(2)
+    default_logger.setOutputPrintStream(options[:outputstr] || JavaLang::System.out)
+    default_logger.setErrorPrintStream(options[:errorstr] || JavaLang::System.err)
+    default_logger.setEmacsMode(false)
+    @project.addBuildListener(default_logger)
+  end
+  public
   attr :project, false
-  attr :version, false
-  attr :ant_version, true
-  attr :declarative, true
-  attr :logger, true
+  attr :ant_version, false
+  attr_accessor(:declarative, :logger)
   # Create an AntProject. Parameters are specified via a hash:
+  # :ant_home=><em>Ant basedir</em>
+  #   -A String indicating the location of the ANT_HOME directory. If provided, Antwrap will
+  #   load the classes from the ANT_HOME/lib dir. If ant_home is not provided, the Ant jar files
+  #   must be available in the CLASSPATH.
   # :name=><em>project_name</em>
-  #   -A String indicating the name of this project. Corresponds to the
-  #   'name' attrbute on an Ant project.
+  #   -A String indicating the name of this project.
   # :basedir=><em>project_basedir</em>
   #   -A String indicating the basedir of this project. Corresponds to the 'basedir' attribute
   #   on an Ant project.
@@ -150,49 +164,41 @@ class AntProject
   # :loglevel=><em>The level to set the logger to</em>
   #   -Defaults to Logger::ERROR
   def initialize(options=Hash.new)
-    @project= ApacheAnt::Project.new
-    @project.setName(options[:name] || '')
-    @project.setDefault('')
-    @project.setBasedir(options[:basedir] || '.')
-    @project.init
-    self.declarative= options[:declarative] || true
-    default_logger = ApacheAnt::DefaultLogger.new
-    default_logger.setMessageOutputLevel(2)
-    default_logger.setOutputPrintStream(options[:outputstr] || JavaLang::System.out)
-    default_logger.setErrorPrintStream(options[:errorstr] || JavaLang::System.err)
-    default_logger.setEmacsMode(false)
-    @project.addBuildListener(default_logger)
-    @version = ApacheAnt::Main.getAntVersion
-    @ant_version = @version[/\d\.\d\.\d/].to_f
     @logger = options[:logger] || Logger.new(STDOUT)
     @logger.level = options[:loglevel] || Logger::ERROR
-    @logger.debug(@version)
-  end
-  def create_task(taskname, attributes, proc)
-    @logger.debug("AntProject.create_task.taskname = " + taskname)
-    @logger.debug("AntProject.create_task.attributes = " + attributes.to_s)
-    task = AntTask.new(taskname, self, attributes, proc)
-    task.execute if declarative
-    return task
+    if(!@@classes_loaded && options[:ant_home])
+      @logger.debug("loading ant jar files. Ant_Home: #{options[:ant_home]}")
+      AntwrapClassLoader.load_ant_libs(options[:ant_home])
+      @@classes_loaded = true
+    end
+    @logger.debug(ApacheAnt::Main.getAntVersion())
+    @ant_version = ApacheAnt::Main.getAntVersion()[/\d\.\d\.\d/].to_f
+    init_project(options)
   end
   def method_missing(sym, *args)
     begin
       @logger.debug("AntProject.method_missing sym[#{sym.to_s}]")
-      return create_task(sym.to_s, args[0], block_given? ? Proc.new : nil)
+      task = AntTask.new(sym.to_s, self, args[0], block_given? ? Proc.new : nil)
+      task.execute if declarative
+      return task
     rescue
       @logger.error("Error instantiating task[#{sym.to_s}]" + $!)
+      throw $!
     end
   end
-  #The Ant Project's name. Default is ''.
+  #The Ant Project's name. Default is ''
   def name()
     return @project.getName
   end
-  #The Ant Project's basedir. Default is '.'.
+  #The Ant Project's basedir. Default is '.'
   def basedir()
     return @project.getBaseDir().getAbsolutePath();
   end
@@ -200,11 +206,5 @@ class AntProject
   def to_s
     return self.class.name + "[#{@project.getName()}]"
   end
-  #This method invokes create_task. It is here to prevent conflicts wth the JRuby library
-  #over the 'java' symbol.
-  def java(attributes=Hash.new)
-    create_task('java', attributes, (block_given? ? Proc.new : nil))
-  end
 end

data/lib/antwrap_utilities.rb ADDED

@@ -0,0 +1,29 @@
+if(RUBY_PLATFORM == 'java')
+  require 'java'
+  autoload :ApacheAnt, 'jruby_modules.rb'
+  autoload :JavaLang, 'jruby_modules.rb'
+else
+  require 'rubygems'
+  require 'rjb'
+  autoload :ApacheAnt, 'rjb_modules.rb'
+  autoload :JavaLang, 'rjb_modules.rb'
+end
+module AntwrapClassLoader
+  require 'find'
+  def match(*paths)
+    matched=[]
+    Find.find(*paths){ |path| matched << path if yield path }
+    return matched
+  end
+  def load_ant_libs(ant_home)
+    jars = match(ant_home + '/lib') {|p| ext = p[-4...p.size]; ext && ext.downcase == '.jar'}
+    if(RUBY_PLATFORM == 'java')
+      jars.each {|jar| require jar }
+    else
+      Rjb::load(jars.join(":"), [])
+    end
+  end
+  module_function :match, :load_ant_libs
+end

data/lib/convert.rb ADDED

@@ -0,0 +1,104 @@
+# antwrap
+#
+# Copyright Caleb Powell 2007
+#
+# Licensed under the LGPL, see the file COPYING in the distribution
+#
+require 'rexml/document'
+if ARGV.empty?
+    puts "Usage: #{$0} [antfile] [rakefile]"
+    exit! 1
+end
+@antfile = File.open(ARGV[0])
+@rakefile = File.new(ARGV[1], 'w+')
+@@reserved_words = ['alias',  'and',  'BEGIN',  'begin',  'break',  'case',  'class',
+                    'def',  'defined',  'do',  'else',  'elsif',  'END',  'end',  'ensure',
+                    'false',  'for',  'if',  'in',  'module',  'next',  'nil',  'not',  'or',
+                    'redo',  'rescue',  'retry',  'return',  'self',  'super',  'then',  'true',
+                    'undef',  'unless',  'until',  'when',  'while',  'yield', 'java']
+xml = REXML::Document.new(@antfile)
+puts "Converting from Ant build script[#{@antfile.path}] == to ==> \n Rakefile[#{@rakefile.path}]"
+def create_symbol(str)
+    str = rubyize(str)
+    return str.gsub(/(\w*[^,\s])/, ':\1')
+end
+def rubyize(str)
+  if (str == nil)
+    str = ''
+  elsif (@@reserved_words.index(str) != nil)
+    str = '_' + str
+  else
+    str = str.gsub(/(\w*)[\-|\.](\w*)/, '\1_\2')
+  end
+  return str
+end
+@rakefile.print "require_gem 'Antwrap'\n"
+@rakefile.print "@ant = AntProject.new()\n"
+@one_tab= '   '
+def print_task(task, tab=@one_tab, prefix='')
+  task_name = rubyize(task.name)
+  @rakefile.print "#{tab}#{prefix}#{task_name}("
+  if(task_name == 'macrodef')
+    task.attributes['name'] = rubyize(task.attributes['name'])
+  elsif(task_name == 'java')
+    task_name = 'jvm'
+  end
+  isFirst = true;
+  task.attributes.each do |key, value|
+    if !isFirst
+      @rakefile.print(",\n#{tab+@one_tab}")
+    end
+    @rakefile.print ":#{key} => \"#{value}\""
+    isFirst = false;
+  end
+  if task.has_text?
+    pcdata = task.texts().join
+    if(pcdata.strip() != '')
+      @rakefile.print ":pcdata => \"#{pcdata}\""
+    end
+  end
+  @rakefile.print ")"
+  if task.elements.size > 0
+    @rakefile.print "{"
+    task.elements.each do |child|
+      @rakefile.print "\n"
+      print_task(child, (tab+@one_tab), '')
+    end
+    @rakefile.print "\n#{tab}}"
+  end
+end
+xml.elements.each("/project/*") do |node|
+  if node.name != 'target'
+    print_task(node, '', '@ant.')
+    @rakefile.print "\n\n"
+  end
+end
+xml.elements.each("/project/target") do |node|
+    task = "\ntask " + create_symbol(node.attributes['name']) +
+         " => [" + create_symbol(node.attributes['depends']) + "] do\n"
+    @rakefile.print task
+    node.elements.each do |child|
+      print_task(child, @one_tab, '@ant.')
+      @rakefile.print "\n"
+    end
+    @rakefile.print "end\n"
+end

data/lib/jruby_modules.rb CHANGED

@@ -1,5 +1,4 @@
 module ApacheAnt
-  require 'java'
   include_class "org.apache.tools.ant.DefaultLogger"
   include_class "org.apache.tools.ant.Main"
   include_class "org.apache.tools.ant.Project"
@@ -9,6 +8,5 @@ module ApacheAnt
 end
 module JavaLang
-  require 'java'
   include_class "java.lang.System"
 end

data/lib/rjb_modules.rb CHANGED

@@ -1,6 +1,4 @@
 module ApacheAnt
-  require 'rubygems'
-  require 'rjb'
   DefaultLogger =  Rjb::import("org.apache.tools.ant.DefaultLogger")
   Main = Rjb::import("org.apache.tools.ant.Main")
   Project = Rjb::import("org.apache.tools.ant.Project")
@@ -10,7 +8,5 @@ module ApacheAnt
 end
 module JavaLang
-  require 'rubygems'
-  require 'rjb'
   System = Rjb::import("java.lang.System")
 end

data/test/build.xml ADDED

@@ -0,0 +1,15 @@
+<project name="antwrap" default="run-java" basedir=".">
+    <target name="run-java" description="Antwrap: run a trivial Java class">
+        <java classpath="output/classes:test-resources/parent.jar" classname="foo.bar.FooBar" fork="true">
+            <jvmarg value="-Dantwrap=coolio"/>
+            <arg value="argOne"/>
+            <arg value="argTwo"/>
+        </java>
+    </target>
+</project>

data/test/tc_antwrap.rb CHANGED

@@ -32,16 +32,19 @@ class TestAntwrap < Test::Unit::TestCase
   def setup
     @current_dir = ENV['PWD']
+    @output_dir = @current_dir + '/test/output'
+    @resource_dir = @current_dir + '/test/test-resources'
+    @ant_home = @resource_dir + "/apache-ant-1.7.0"
+#    @ant_home = "/Users/caleb/tools/apache-ant-1.6.5"
+#    @ant_home = "/Users/caleb/tools/apache-ant-1.5.4"
     @ant_proj_props = {:name=>"testProject", :basedir=>@current_dir, :declarative=>true,
-                        :logger=>Logger.new(STDOUT), :loglevel=>Logger::DEBUG}
+                        :logger=>Logger.new(STDOUT), :loglevel=>Logger::DEBUG, :ant_home => @ant_home}
     @ant = AntProject.new(@ant_proj_props)
     assert(@ant_proj_props[:name] == @ant.name())
     assert(@ant_proj_props[:basedir] == @ant.basedir())
     assert(@ant_proj_props[:declarative] == @ant.declarative())
-    @output_dir = @current_dir + '/test/output'
-    @resource_dir = @current_dir + '/test/test-resources'
     if File.exists?(@output_dir)
       FileUtils.remove_dir(@output_dir)
@@ -221,7 +224,7 @@ class TestAntwrap < Test::Unit::TestCase
   def test_ant_contrib
-    return if @ant.ant_version < 1.6
+    return if @ant.ant_version() < 1.6
     @ant.taskdef(:resource => "net/sf/antcontrib/antlib.xml")
@@ -249,6 +252,9 @@ class TestAntwrap < Test::Unit::TestCase
   end
+  def test_tstamp
+    @ant.tstamp
+  end
   private
   def assert_exists(file_path)
     assert(File.exists?(file_path), "Does not exist[#{file_path}]")

metadata CHANGED

@@ -3,8 +3,8 @@ rubygems_version: 0.8.10
 specification_version: 1
 name: Antwrap
 version: !ruby/object:Gem::Version
-  version: 0.5.0
-date: 2007-03-15
+  version: 0.5.2
+date: 2007-04-17
 summary: "A Ruby module that wraps the Apache Ant build tool, enabling Ant Tasks to be
   invoked from a Ruby/JRuby scripts."
 require_paths:
@@ -29,8 +29,11 @@ authors:
   - Caleb Powell
 files:
   - lib/antwrap.rb
+  - lib/antwrap_utilities.rb
+  - lib/convert.rb
   - lib/jruby_modules.rb
   - lib/rjb_modules.rb
+  - test/build.xml
   - test/output
   - test/tc_antwrap.rb
   - test/tc_convert.rb