Antwrap 0.6.0 → 0.7.0

data/Rakefile

@@ -0,0 +1,85 @@
+# Copyright 2008 Caleb Powell 
+# Licensed 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.
+
+$LOAD_PATH.push(FileUtils::pwd + '/lib')
+require 'rubygems'
+require 'hoe'
+require './lib/antwrap.rb'
+
+def apply_default_hoe_properties(hoe)
+  hoe.remote_rdoc_dir = ''
+  hoe.rubyforge_name = 'antwrap'
+  hoe.author = 'Caleb Powell'
+  hoe.email = 'caleb.powell@gmail.com'
+  hoe.url = 'http://rubyforge.org/projects/antwrap/'
+  hoe.summary = 'A Ruby module that wraps the Apache Ant build tool. Antwrap can be used to invoke Ant Tasks from a Ruby or a JRuby script.'
+  hoe.description = hoe.paragraphs_of('README.txt', 2..5).join("\n\n")
+  hoe.changes = hoe.paragraphs_of('History.txt', 0..1).join("\n\n")
+  puts "Current changes in this release_______________ "
+  puts "#{hoe.changes}"
+  puts "----------------------------------------------"
+end
+
+#builds the MRI Gem
+Hoe.new('Antwrap', Antwrap::VERSION) do |hoe|
+  apply_default_hoe_properties hoe
+  hoe.extra_deps << ["rjb", ">= 1.0.3"]
+end
+
+#builds the JRuby Gem
+Hoe.new('Antwrap', Antwrap::VERSION) do |hoe|
+  apply_default_hoe_properties hoe
+  hoe.spec_extras = {:platform => 'java'}
+end
+#Gem::manage_gems
+#require 'rake/gempackagetask'
+#
+#def create_spec(spec, platform)
+#  spec.name          = 'Antwrap'
+#  spec.version       = '0.6.0'
+#  spec.author        = 'Caleb Powell'
+#  spec.email         = 'caleb.powell@gmail.com'
+#  spec.homepage      = 'http://rubyforge.org/projects/antwrap/'
+#  spec.platform      = platform
+#  spec.summary       = "A Ruby module that wraps the Apache Ant build tool, enabling Ant Tasks to be invoked from a Ruby/JRuby scripts."
+#  candidates      = Dir.glob("{lib,test,docs}/**/*")
+#  spec.files         = candidates.delete_if do |item|
+#    item.include?(".svn") || item.include?("apache-ant-1.7.0")
+#  end
+#  spec.require_path  = 'lib'
+#  spec.autorequire   = 'antwrap'
+#  spec.test_file     = 'test/antwrap_test.rb'
+#  spec.has_rdoc      = true
+#  spec.extra_rdoc_files  = ['README', 'COPYING']
+#end        
+#
+#jruby_spec = Gem::Specification.new do |spec| 
+#  create_spec(spec, 'java')
+#end
+#
+#ruby_spec = Gem::Specification.new do |spec| 
+#  create_spec(spec, Gem::Platform::RUBY) 
+#  spec.add_dependency("rjb", ">= 1.0.3")
+#end
+#
+#Rake::GemPackageTask.new(ruby_spec) do |pkg|
+#  puts "Creating Ruby Gem"
+#end
+#
+#Rake::GemPackageTask.new(jruby_spec) do |pkg|
+#  puts "Creating JRuby Gem"
+#end
+
+#task :gems => [:pkg => '/Antwrap-0.5.1.gem'] 
+
+

data/lib/ant_project.rb

@@ -1,133 +1,141 @@
-# ant_project.rb
-#
-# Copyright Caleb Powell 2007
-#
-# Licensed under the LGPL, see the file COPYING in the distribution
+# Copyright 2008 Caleb Powell 
+# Licensed 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.
 
-class AntProject 
-  require 'logger'
-  require 'ant_task'
-  
-  private
-  @@classes_loaded = false
-  
-  def init_project(options)
-  
-    @project= ApacheAnt::Project.new
-    @project.setName(options[:name] || '')
-    @project.setDefault('')
-    @project.setBasedir(options[:basedir] || FileUtils::pwd)
-    @project.init
-    if options[:declarative] == nil
-      @logger.debug("declarative is nil")
-      self.declarative= true
-    else
-      @logger.debug("declarative is #{options[:declarative]}")
-      self.declarative= options[:declarative]
-    end      
-    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 :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.
-  # :basedir=><em>project_basedir</em>
-  #   -A String indicating the basedir of this project. Corresponds to the 'basedir' attribute 
-  #   on an Ant project.  
-  # :declarative=><em>declarative_mode</em>
-  #   -A boolean value indicating wether Ant tasks created by this project instance should 
-  #   have their execute() method invoked during their creation. For example, with 
-  #   the option :declarative=>true the following task would execute; 
-  #   @antProject.echo(:message => "An Echo Task")
-  #   However, with the option :declarative=>false, the programmer is required to execute the 
-  #   task explicitly; 
-  #   echoTask = @antProject.echo(:message => "An Echo Task")
-  #   echoTask.execute()
-  #   Default value is <em>true</em>.
-  # :logger=><em>Logger</em>
-  #   -A Logger instance. Defaults to Logger.new(STDOUT)
-  # :loglevel=><em>The level to set the logger to</em>
-  #   -Defaults to Logger::ERROR
-  def initialize(options=Hash.new)
+module Antwrap
+  class AntProject 
+    require 'logger'
+    require 'ant_task'
     
-    @logger = options[:logger] || Logger.new(STDOUT)
-    @logger.level = options[:loglevel] || Logger::ERROR
+    private
+    @@classes_loaded = false
     
-    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
+    def init_project(options)
+      
+      @project= Antwrap::ApacheAnt::Project.new
+      @project.setName(options[:name] || '')
+      @project.setDefault('')
+      @project.setBasedir(options[:basedir] || FileUtils::pwd)
+      @project.init
+      if options[:declarative] == nil
+        @logger.debug("declarative is nil")
+        self.declarative= true
+      else
+        @logger.debug("declarative is #{options[:declarative]}")
+        self.declarative= options[:declarative]
+      end      
+      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
     
-    @logger.debug(ApacheAnt::Main.getAntVersion())
-    @ant_version = ApacheAnt::Main.getAntVersion()[/\d\.\d\.\d/].to_f
-    init_project(options)
+    public
+    attr :project, false
+    attr :ant_version, false
+    attr_accessor(:declarative, :logger)
     
-    @task_stack = Array.new
-    
-  end
-  
-  def method_missing(sym, *args)
-    
-    begin
-      task = AntTask.new(sym.to_s, self, args[0])
+    # 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.
+    # :basedir=><em>project_basedir</em>
+    #   -A String indicating the basedir of this project. Corresponds to the 'basedir' attribute 
+    #   on an Ant project.  
+    # :declarative=><em>declarative_mode</em>
+    #   -A boolean value indicating wether Ant tasks created by this project instance should 
+    #   have their execute() method invoked during their creation. For example, with 
+    #   the option :declarative=>true the following task would execute; 
+    #   @antProject.echo(:message => "An Echo Task")
+    #   However, with the option :declarative=>false, the programmer is required to execute the 
+    #   task explicitly; 
+    #   echoTask = @antProject.echo(:message => "An Echo Task")
+    #   echoTask.execute()
+    #   Default value is <em>true</em>.
+    # :logger=><em>Logger</em>
+    #   -A Logger instance. Defaults to Logger.new(STDOUT)
+    # :loglevel=><em>The level to set the logger to</em>
+    #   -Defaults to Logger::ERROR
+    def initialize(options=Hash.new)
       
-      parent_task = @task_stack.last
-      @task_stack << task
+      @logger = options[:logger] || Logger.new(STDOUT)
+      @logger.level = options[:loglevel] || Logger::ERROR
+      
+      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
       
-      yield self if block_given?
+      @logger.debug(Antwrap::ApacheAnt::Main.getAntVersion())
+      @ant_version = Antwrap::ApacheAnt::Main.getAntVersion()[/\d\.\d\.\d/].to_f
+      init_project(options)
       
-      parent_task.add(task) if parent_task
+      @task_stack = Array.new
       
-      if @task_stack.nitems == 1 
-        if declarative == true
-          @logger.debug("Executing #{task}")
-          task.execute 
-        else 
-          @logger.debug("Returning #{task}")
-          return task
-        end  
+    end
+    
+    def method_missing(sym, *args)
+      
+      begin
+        task = AntTask.new(sym.to_s, self, args[0])
+        
+        parent_task = @task_stack.last
+        @task_stack << task
+        
+        yield self if block_given?
+        
+        parent_task.add(task) if parent_task
+        
+        if @task_stack.nitems == 1 
+          if declarative == true
+            @logger.debug("Executing #{task}")
+            task.execute 
+          else 
+            @logger.debug("Returning #{task}")
+            return task
+          end  
+        end
+        
+      rescue
+        @logger.error("Error instantiating '#{sym.to_s}' task: " + $!)
+        raise
+      ensure
+        @task_stack.pop
       end
+      
+    end
     
-    rescue
-      @logger.error("Error instantiating '#{sym.to_s}' task: " + $!)
-      raise
-    ensure
-      @task_stack.pop
+    #The Ant Project's name. Default is ''
+    def name
+      return @project.getName
     end
     
+    #The Ant Project's basedir. Default is '.'
+    def basedir
+      return @project.getBaseDir().getAbsolutePath();
+    end
+    
+    #Displays the Class name followed by the AntProject name
+    # -e.g.  AntProject[BigCoProject]
+    def to_s
+      return self.class.name + "[#{name}]"
+    end 
+    
   end
-  
-  #The Ant Project's name. Default is ''
-  def name
-    return @project.getName
-  end
-  
-  #The Ant Project's basedir. Default is '.'
-  def basedir
-    return @project.getBaseDir().getAbsolutePath();
-  end
-  
-  #Displays the Class name followed by the AntProject name
-  # -e.g.  AntProject[BigCoProject]
-  def to_s
-    return self.class.name + "[#{name}]"
-  end 
-  
 end

data/lib/ant_task.rb

@@ -1,118 +1,126 @@
-# ant_task.rb
-#
-# Copyright Caleb Powell 2007
-#
-# Licensed under the LGPL, see the file COPYING in the distribution
+# Copyright 2008 Caleb Powell 
+# Licensed 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.
 
-class AntTask
-  attr_accessor :unknown_element, :project, :taskname, :logger, :executed
-  
-  public  
-  # Creates an AntTask
-  # taskname 
-  #   -A String representing the name of an Ant Task. This name should correspond to 
-  #   the element name of the Ant xml task (e.g. javac, jar, war, etc).
-  # antProject
-  #   -An instance of an AntProject
-  # attributes
-  #   -A Hash of task name/values to be applied to the task.
-  #   
-  # For example:
-  #   antProject = AntProject.new()
-  #   antTask = AntTask.new('javac', antProject, {:debug => 'on', :verbose => 'no', :fork => 'no'})     
-  def initialize(taskname, antProject, attributes)
-    
-    taskname = taskname[1, taskname.length-1] if taskname[0,1] == "_"
-    @logger = antProject.logger
-    @taskname = taskname
-    @project_wrapper = antProject
-    @project = antProject.project()
-    @logger.debug(antProject.to_s)
-    @unknown_element = create_unknown_element(@project, taskname)
-    @logger.debug(to_s)
-    
-    add_attributes(attributes)
-    
-  end
-  
-  # Displays the Class name followed by the Task name
-  # -e.g.  AntTask[javac]
-  def to_s
-    return self.class.name + "[#{@taskname}]"
-  end 
-  
-  def create_unknown_element(project, taskname)
+module Antwrap
+  class AntTask
+    attr_accessor :unknown_element, :project, :taskname, :logger, :executed
     
-    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)
+    public  
+    # Creates an AntTask
+    # taskname 
+    #   -A String representing the name of an Ant Task. This name should correspond to 
+    #   the element name of the Ant xml task (e.g. javac, jar, war, etc).
+    # antProject
+    #   -An instance of an AntProject
+    # attributes
+    #   -A Hash of task name/values to be applied to the task.
+    #   
+    # For example:
+    #   antProject = AntProject.new()
+    #   antTask = AntTask.new('javac', antProject, {:debug => 'on', :verbose => 'no', :fork => 'no'})     
+    def initialize(taskname, antProject, attributes)
+      
+      taskname = taskname[1, taskname.length-1] if taskname[0,1] == "_"
+      @logger = antProject.logger
+      @taskname = taskname
+      @project_wrapper = antProject
+      @project = antProject.project()
+      @logger.debug(antProject.to_s)
+      @unknown_element = create_unknown_element(@project, taskname)
+      @logger.debug(to_s)
+      
+      add_attributes(attributes)
+      
     end
     
-    return element
-    
-  end
-  
-  # Sets each attribute on the AntTask instance.
-  # :attributes - is a Hash.
-  def add_attributes(attributes)
-    
-    return if attributes == nil
+    # Displays the Class name followed by the Task name
+    # -e.g.  AntTask[javac]
+    def to_s
+      return self.class.name + "[#{@taskname}]"
+    end 
     
-    wrapper = ApacheAnt::RuntimeConfigurable.new(@unknown_element, @unknown_element.getTaskName());
-    
-    if(@project_wrapper.ant_version >= 1.6)
-      attributes.each do |key, val| 
-        apply_to_wrapper(wrapper, key.to_s, val){ |k,v| wrapper.setAttribute(k, v)}
+    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
-    else  
-      @unknown_element.setRuntimeConfigurableWrapper(wrapper)
-      attribute_list = XmlSax::AttributeListImpl.new()
-      attributes.each do |key, val| 
-        apply_to_wrapper(wrapper, key.to_s, val){ |k,v| attribute_list.addAttribute(k, 'CDATA', v)}
+      
+      return element
+      
+    end
+    
+    # Sets each attribute on the AntTask instance.
+    # :attributes - is a Hash.
+    def add_attributes(attributes)
+      
+      return if attributes == nil
+      
+      wrapper = ApacheAnt::RuntimeConfigurable.new(@unknown_element, @unknown_element.getTaskName());
+      
+      if(@project_wrapper.ant_version >= 1.6)
+        attributes.each do |key, val| 
+          apply_to_wrapper(wrapper, key.to_s, val){ |k,v| wrapper.setAttribute(k, v)}
+        end
+      else  
+        @unknown_element.setRuntimeConfigurableWrapper(wrapper)
+        attribute_list = XmlSax::AttributeListImpl.new()
+        attributes.each do |key, val| 
+          apply_to_wrapper(wrapper, key.to_s, val){ |k,v| attribute_list.addAttribute(k, 'CDATA', v)}
+        end
+        wrapper.setAttributes(attribute_list)
       end
-      wrapper.setAttributes(attribute_list)
+      
     end
     
-  end
-  
-  def apply_to_wrapper(wrapper, key, value)
-  
-    raise ArgumentError, "ArgumentError: You cannot use an Array as an argument. Use the :join method instead; i.e ['file1', 'file2'].join(File::PATH_SEPARATOR)." if value.is_a?(Array)
-        
-    begin
-      if(key == 'pcdata')
-        wrapper.addText(value.to_s)
-      else
-        yield key, value.to_s
+    def apply_to_wrapper(wrapper, key, value)
+      
+      raise ArgumentError, "ArgumentError: You cannot use an Array as an argument. Use the :join method instead; i.e ['file1', 'file2'].join(File::PATH_SEPARATOR)." if value.is_a?(Array)
+      
+      begin
+        if(key == 'pcdata')
+          wrapper.addText(value.to_s)
+        else
+          yield key, value.to_s
+        end
+      rescue StandardError
+        raise ArgumentError, "ArgumentError: Unable to set :#{key} attribute with value => '#{value}'"
       end
-    rescue StandardError
-      raise ArgumentError, "ArgumentError: Unable to set :#{key} attribute with value => '#{value}'"
+      
     end
     
-  end
+    # Add <em>child</em> as a child of this task. 
+    def add(child)
+      @unknown_element.addChild(child.unknown_element())
+      @unknown_element.getRuntimeConfigurableWrapper().addChild(child.unknown_element().getRuntimeConfigurableWrapper())
+    end
+    
+    # Invokes the AntTask. 
+    def execute
+      @unknown_element.maybeConfigure
+      @unknown_element.execute
+      @executed = true
+      return nil
+    end
     
-  # Add <em>child</em> as a child of this task. 
-  def add(child)
-    @unknown_element.addChild(child.unknown_element())
-    @unknown_element.getRuntimeConfigurableWrapper().addChild(child.unknown_element().getRuntimeConfigurableWrapper())
-  end
-
-  # Invokes the AntTask. 
-  def execute
-    @unknown_element.maybeConfigure
-    @unknown_element.execute
-    @executed = true
-    return nil
   end
-  
-end
+end