atoulme-Antwrap 0.7.1

data/lib/ant_project.rb

@@ -0,0 +1,141 @@
+# 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.
+
+module Antwrap
+  class AntProject 
+    require 'logger'
+    require 'ant_task'
+    
+    private
+    @@classes_loaded = false
+    
+    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
+    
+    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)
+      
+      @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
+      
+      @logger.debug(Antwrap::ApacheAnt::Main.getAntVersion())
+      @ant_version = Antwrap::ApacheAnt::Main.getAntVersion()[/\d\.\d\.\d/].to_f
+      init_project(options)
+      
+      @task_stack = Array.new
+      
+    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.size == 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
+    
+    #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
+end

data/lib/ant_task.rb

@@ -0,0 +1,126 @@
+# 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.
+
+module Antwrap
+  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)
+      
+      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
+    
+    # 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
+      
+    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
+        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
+    
+  end
+end

data/lib/antwrap.rb

@@ -0,0 +1,22 @@
+# 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.
+
+require 'antwrap_utilities'
+require 'ant_project'
+require 'ant_task'
+module Antwrap
+  autoload :ApacheAnt, 'ant_libraries.rb'
+  autoload :JavaLang, 'ant_libraries.rb'
+  autoload :XmlOrg, 'ant_libraries.rb'
+  VERSION = "0.7.1"
+end

data/lib/antwrap_utilities.rb

@@ -0,0 +1,32 @@
+# 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.
+require 'java_adapter'
+module Antwrap
+  module AntwrapClassLoader
+    require 'find'
+    
+    def match(*paths)
+      matched = Array.new 
+      Find.find(*paths){ |path| matched << path if yield path }
+      return matched
+    end
+    
+    def load_ant_libs(ant_home)
+      jars = match(ant_home + File::SEPARATOR + 'lib') {|p| ext = p[-4...p.size]; ext && ext.downcase == '.jar'} 
+      Antwrap::JavaAdapter.load(jars)
+    end
+    
+    module_function :match, :load_ant_libs
+    
+  end
+end

data/lib/java_adapter.rb

@@ -0,0 +1,52 @@
+# 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.
+
+module Antwrap
+  module JavaAdapter
+    
+    def is_jruby_interpreter?
+      return RUBY_PLATFORM =~ /java/
+    end
+
+    def import_class(name)
+      if is_jruby_interpreter?
+        return import_using_jruby(name)
+      else
+        return Rjb::import(name)
+      end
+    end
+
+    def load(files=[], args=[])
+      if is_jruby_interpreter?
+        files.each {|jar| require jar }
+      else
+        Rjb::load(files.join(File::PATH_SEPARATOR), [])
+      end
+    end
+    
+    module_function :import_class, :load, :is_jruby_interpreter?
+
+    if is_jruby_interpreter?
+      require 'java'
+    else
+      require 'rubygems'
+      require 'rjb'
+    end
+    
+    private    
+    def JavaAdapter.import_using_jruby(name)
+      include_class(name) 
+      return remove_const(name.scan(/[_a-zA-Z0-9$]+/).last)
+    end
+  end
+end

metadata

@@ -0,0 +1,124 @@
+--- !ruby/object:Gem::Specification 
+name: atoulme-Antwrap
+version: !ruby/object:Gem::Version 
+  hash: 1
+  prerelease: false
+  segments: 
+  - 0
+  - 7
+  - 1
+  version: 0.7.1
+platform: ruby
+authors: 
+- Caleb Powell
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-07-20 00:00:00 -07:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: rjb
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 17
+        segments: 
+        - 1
+        - 0
+        - 3
+        version: 1.0.3
+  type: :runtime
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: hoe
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 5
+        segments: 
+        - 2
+        - 3
+        - 3
+        version: 2.3.3
+  type: :development
+  version_requirements: *id002
+description: "\tA Ruby module that wraps the Apache Ant build tool. Antwrap can be used to invoke Ant Tasks from a Ruby or a JRuby script.\n\n\
+  == FEATURES/PROBLEMS:\n\n\
+  \tAntwrap runs on the native Ruby interpreter via the RJB (Ruby Java Bridge gem) and on the JRuby interpreter. Antwrap is compatible with Ant versions 1.5.4, \n\
+  \t1.6.5 and 1.7.0. For more information, \tsee the Project Info (http://rubyforge.org/projects/antwrap/) page. \n\
+  \t \n\
+  == SYNOPSIS:\n\n\
+  \tAntwrap is a Ruby library that can be used to invoke Ant tasks. It is being used in the Buildr (http://incubator.apache.org/buildr/) project to execute \n\
+  \tAnt (http://ant.apache.org/) tasks in a Java project. If you are tired of fighting with Ant or Maven XML files in your Java project, take some time to \n\
+  \tcheck out Buildr!"
+email: caleb.powell@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- History.txt
+- Manifest.txt
+- README.txt
+files: 
+- History.txt
+- LICENSE
+- Manifest.txt
+- README.txt
+- Rakefile
+- docs/index.html
+- docs/index_files/Brander.css
+- docs/index_files/blankdot.gif
+- docs/index_files/blankdot.html
+- docs/index_files/urchin.js
+- lib/ant_project.rb
+- lib/ant_task.rb
+- lib/antwrap.rb
+- lib/antwrap_utilities.rb
+- lib/ant_libraries.rb
+- lib/java_adapter.rb
+has_rdoc: true
+homepage: http://rubyforge.org/projects/antwrap/
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --main
+- README.txt
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: antwrap
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+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.
+test_files: []
+