malagant-raw 0.4.13 → 0.8.1

data/History.txt

@@ -1,6 +1,3 @@
-=== 1.0.0 / 2009-01-29
-
-* 1 major enhancement
-
-  * Birthday!
+=== 0.8.1 / 2009-08-10
 
+* Initial release

data/Manifest.txt

@@ -1,5 +1,5 @@
 History.txt
 Manifest.txt
-README.txt
+README
 Rakefile
 bin/raw

data/{README.txt → README}

@@ -4,6 +4,7 @@ RAW is a gem that provides a wrapper for ant.
 You can use RAW to write ant scripts in Ruby instead of XML.
 
 More information will be provided asap.
+You can get initial support via malagant1969@googlemail.com (Michael Johann)
 
 == REQUIREMENTS
 

data/Rakefile

@@ -20,7 +20,7 @@ def apply_default_hoe_properties(hoe)
   hoe.remote_rdoc_dir = ''
   hoe.rubyforge_name = 'raw'
   hoe.author = 'Michael Johann'
-  hoe.email = 'malagant1969@gmail.com'
+  hoe.email = 'malagant1969@googlemail.com'
   hoe.url = 'http://kenai.com/projects/raw/'
   hoe.summary = 'A Ruby module that wraps the Apache Ant build tool. 
                  RAW can be used to invoke Ant Tasks from a Ruby or a JRuby script.'
@@ -42,8 +42,3 @@ Hoe.new('raw', RAW::VERSION) do |hoe|
   apply_default_hoe_properties hoe
   hoe.spec_extras = { :platform => 'java' }
 end
-
-Rake::TestTask.new('test') do |t|
-  t.ruby_opts = ['-r test/load_devcreek.rb']
-  t.test_files = ['test/*test.rb']
-end

data/bin/raw

@@ -1,3 +1,3 @@
-#!/usr/bin/env ruby
-require 'lib/raw_runner'
+#!/usr/bin/env jruby
+require '../lib/raw_runner'
 

data/lib/ant_libraries.rb

@@ -9,23 +9,28 @@
 # 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 'rjb_adapter'
 
 module RAW
+  # Defining some Java classes for building the ant tasks etc
   module ApacheAnt
+    # The default logger
     DefaultLogger = RjbAdapter.import_class("org.apache.tools.ant.DefaultLogger")
+    # The main class from Apache ANT
     Main = RjbAdapter.import_class("org.apache.tools.ant.Main")
+    # The ANT project class
     Project = RjbAdapter.import_class("org.apache.tools.ant.Project")
+    # The ANT RuntimeConfigurable
     RuntimeConfigurable = RjbAdapter.import_class("org.apache.tools.ant.RuntimeConfigurable")
+    # The ANT target class
     Target = RjbAdapter.import_class("org.apache.tools.ant.Target")
+    # ANT's class for dynamically wrapping taks
     UnknownElement = RjbAdapter.import_class("org.apache.tools.ant.UnknownElement")
   end
   
   module JavaLang
+    # Java's System class for access to System.out and System.err
     System = RjbAdapter.import_class("java.lang.System")
   end
-  
-  module XmlSax
-    AttributeListImpl = RjbAdapter.import_class("org.xml.sax.helpers.AttributeListImpl")
-  end
 end

data/lib/ant_project.rb

@@ -14,86 +14,122 @@ module RAW
   class AntProject
     require 'logger'
     require 'ant_task'
-    require 'ant_libraries'
 
-    private
     @@classes_loaded = false
 
+    # Here we go: Let's define some attributes
+    public
+    # getter and setter for the project instance,
+    # the logger, the declarative and the attribute ant_version
+    attr_accessor :project, :logger, :ant_version, :declarative
+
+    # 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, RAW will
+    #   load the classes from the ANT_HOME/lib dir. If ant_home is not provided, the ANT jar files
+    #   must be available on 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 => <em>true</em> 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
     # This is for further initializations inside the constructor
+    # and must be called once from the users ANT script
+    # Example usage:
+    # init_project :basedir => '/Users/mjohann/projects/jruby_raw',
+    #         :name => 'JRuby',
+    #         :default => 'jar',
+    #         :anthome => ANT_HOME
     def init_project(options)
-
+      # The ANT version used
+      logger.info RAW::ApacheAnt::Main.ant_version
+      @ant_version = RAW::ApacheAnt::Main.ant_version[/\d\.\d\.\d/].to_f
+      # instance of ANT project
       @project = RAW::ApacheAnt::Project.new
+      # The default project name taken from the options hash or left blank
       @project.name = options[:name] || ''
+      # The default ANT target taken from the options hash or left blank
       @project.default = ''
+      # The project's base directory taken from the options hash or the current working directory
       @project.basedir = options[:basedir] || FileUtils::pwd
+      # intializing the ANT project
       @project.init
 
-      if options[:declarative] == nil
-        @logger.debug("declarative is nil")
-        self.declarative= true
+      # Sets the task definitions to be declared only or they get executed directly
+      # Default is true
+      unless options[:declarative]
+        logger.debug("declarative is nil")
+        self.declarative = true
       else
-        @logger.debug("declarative is #{options[:declarative]}")
-        self.declarative= options[:declarative]
+        logger.debug("declarative is #{options[:declarative]}")
+        self.declarative = options[:declarative]
       end
 
+      # Here we setup the default logger instance
       default_logger = ApacheAnt::DefaultLogger.new
-      default_logger.message_output_level = 2
+      default_logger.message_output_level = Logger::INFO
+      # Output is either Standard out or the stream in options hash
       default_logger.output_print_stream = options[:outputstr] || JavaLang::System.out
       default_logger.error_print_stream = options[:errorstr] || JavaLang::System.err
+      # Output will be like in log4j.properties configured
       default_logger.emacs_mode = false
-
+      # Set the default logger as the build listener
       @project.add_build_listener(default_logger)
     end
 
-    public
-    attr :project
-    attr :ant_version
-    attr_accessor(:declarative, :logger)
+    # Constructor will be called internally and consumes
+    # the options hash which can contain infos about a logger  
+    def initialize(options)
+      @logger = options[:logger] || Logger.new(STDOUT)
+      logger.level = options[:loglevel] || Logger::INFO
 
-    # 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, RAW 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)
+      @task_stack = Array.new
+    end
 
-      @logger = options[:logger] || Logger.new(STDOUT)
-      @logger.level = options[:loglevel] || Logger::ERROR
+    def property_value(name)
+      project.get_property(name)
+    end
 
-      if (!@@classes_loaded && options[:ant_home])
-        @logger.debug("loading ant jar files. ANT_HOME: #{options[:ant_home]}")
-        # Load all the jar files from ant
-        RAWClassLoader.load_ant_libs(options[:ant_home])
-        @@classes_loaded = true
+    def build_instance_variable(prop)
+      begin
+      instance_variable = "@#{instvar(prop[0])} = '#{prop[1]}'"
+      self.instance_eval instance_variable
+      logger.debug instance_variable
+      rescue SyntaxError => e
+        logger.error "Problem with #{instance_variable}. Cannot create valid instance variable."
+        raise e
       end
+    end
 
-      @logger.debug(RAW::ApacheAnt::Main.ant_version)
+    def build_properties
+      project.properties.each do |prop|
+        build_instance_variable(prop)
+      end
+      logger.debug instance_variables
+      # TODO: Hack
       @ant_version = RAW::ApacheAnt::Main.ant_version[/\d\.\d\.\d/].to_f
+    end
 
-      init_project(options)
-
-      @task_stack = Array.new
+    def instvar(name)
+      name = name.gsub('.', '_')
+      name.gsub('-', '_')
     end
 
+    
     def method_missing(sym, *args)
       begin
         task = AntTask.new(sym.to_s, self, args[0])

data/lib/ant_task.rb

@@ -13,8 +13,8 @@
 module RAW
   class AntTask
     attr_accessor :unknown_element, :project, :taskname, :logger, :executed
-    
-    public  
+
+    public
     # Creates an AntTask
     # taskname 
     #   -A String representing the name of an Ant Task. This name should correspond to 
@@ -28,8 +28,8 @@ module RAW
     #   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] == "_"
+
+      taskname = taskname[1, taskname.length-1] if taskname[0, 1] == "_"
       @logger = antProject.logger
       @taskname = taskname
       @project_wrapper = antProject
@@ -37,66 +37,66 @@ module RAW
       @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 
-    
+    end
+
     def create_unknown_element(project, taskname)
-      
+
       element = ApacheAnt::UnknownElement.new(taskname)
       element.project = project
       element.owning_target = ApacheAnt::Target.new
       element.task_name = taskname
-      
+
       #DNR. This initializes the Task's Wrapper object and prevents NullPointerExeption upon execution of the task
       element.runtime_configurable_wrapper
-      
-      if(@project_wrapper.ant_version >= 1.6)
+
+      if (@project_wrapper.ant_version >= 1.6)
         element.task_type = taskname
         element.namespace = ''
         element.qname = 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.task_name)
-      
-      if(@project_wrapper.ant_version >= 1.6)
-        attributes.each do |key, val| 
-          apply_to_wrapper(wrapper, key.to_s, val){ |k,v| wrapper.set_attribute(k, v)}
+
+      if (@project_wrapper.ant_version >= 1.6)
+        attributes.each do |key, val|
+          apply_to_wrapper(wrapper, key.to_s, val){ |k, v| wrapper.set_attribute(k, v)}
         end
-      else  
+      else
         @unknown_element.runtime_configurable_wrapper = wrapper
         attribute_list = XmlSax::AttributeListImpl.new()
-        attributes.each do |key, val| 
-          apply_to_wrapper(wrapper, key.to_s, val){ |k,v| attribute_list.add_attribute(k, 'CDATA', v)}
+        attributes.each do |key, val|
+          apply_to_wrapper(wrapper, key.to_s, val){ |k, v| attribute_list.add_attribute(k, 'CDATA', v)}
         end
         wrapper.set_attributes(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')
+        if (key == 'pcdata')
           wrapper.add_text(value.to_s)
         else
           yield key, value.to_s
@@ -104,22 +104,38 @@ module RAW
       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.add_child(child.unknown_element())
       @unknown_element.runtime_configurable_wrapper.add_child(child.unknown_element().runtime_configurable_wrapper)
     end
-    
+
     # Invokes the AntTask. 
     def execute
       @unknown_element.maybe_configure
       @unknown_element.execute
+      build_instance_variable(@unknown_element.wrapper)
       @executed = true
       return nil
     end
-    
+
+    private
+
+    def build_instance_variable(wrapper)
+      variable = wrapper.attributeMap.get('property')
+
+      if variable
+        logger.debug "creating variable = @#{variable} with value #{@project_wrapper.property_value(variable.to_s)}"
+        unless @project_wrapper.instance_variable_defined? "@#{variable.to_s}".to_sym
+          instance_eval <<-END
+            @project_wrapper.instance_variable_set(:@#{@project_wrapper.instvar(variable)}, @project_wrapper.property_value(variable.to_s))
+          END
+        end
+      end
+    end
+
   end
 end

data/lib/raw.rb

@@ -9,10 +9,10 @@
 # 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 'rubygems'
 require 'raw_utilities'
 require 'ant_project'
-require 'ant_task'
-require 'raw_runner'
 require 'fileutils'
 
 module RAW

data/lib/raw_runner.rb

@@ -1,19 +1,29 @@
+# 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(File.dirname(__FILE__) + '/../lib')
 
 require 'open-uri'
 require 'fileutils'
+require 'optparse'
 require 'raw'
 
 module RAW
   class RawRunner < RAW::AntProject
-    attr_reader :root
-    attr_writer :logger
+    attr_reader :root, :targets
 
     def initialize(template, root = '', options = {})
       super(options)
       @targets = Hash.new
-      logger = options[:logger] || Logger.new(STDOUT)
-      @logger.level = options[:loglevel] || Logger::INFO
       @root = File.expand_path(File.directory?(root) ? root : File.join(Dir.pwd, root))
 
       if template
@@ -45,31 +55,20 @@ module RAW
       end
     end
 
-    def property_value(name)
-      project.get_property(name)
-    end
+    def condition(options)
+      property = options[:property]
+      environment = options[:value]
 
-    def build_instance_variable(prop)
-      instance_variable = "@#{instvar(prop[0])} = '#{prop[1]}'"
-      self.instance_eval instance_variable
-      logger.debug instance_variable
-    end
 
-    def build_properties
-      project.properties.each do |prop|
-        build_instance_variable(prop)
+      if name
+        build_instance_variable([name, options[:location] || options[:value]])
+      elsif file || environment
+        build_properties
+      else
+        logger.debug options.inspect
+        raise "No name or file attribute given for property!"
       end
-      logger.debug instance_variables
-      # TODO: Hack
-      @ant_version = RAW::ApacheAnt::Main.ant_version[/\d\.\d\.\d/].to_f
-    end
-
-    def instvar(name)
-      name.gsub('.', '_')
-    end
-
-    def self.parse!(args=ARGV)
-      RawRunner.new(args[0], args[1], args[2])
+      method_missing(:property, options)
     end
 
 
@@ -84,14 +83,88 @@ module RAW
     end
 
     def target(name, depends = [], &block)
-      @targets[name] = block
+      targets[name] = block
     end
 
     def build(task)
-      block = @targets[task]
+      block = targets[task]
       block.call
     end
   end
+
+  # Handles the startup of RAW with parsing options etc.
+  class RawTool
+    def parse!(args)
+      if args.length == 0
+        puts options
+      elsif args.length == 1 && args[0] == ('-h' || '--help')
+        options.parse!(args)
+      else
+        general, sub = split_args(args)
+        options.parse!(args)
+
+        if general.empty?
+          puts options
+        else
+          @root_dir = '.' if @root_dir.nil?
+          RawRunner.new(general[0], @root_dir, {:loglevel => @loglevel})
+        end
+      end
+    end
+
+    def split_args(args)
+      left = []
+      while args[0] and args[0] =~ /^-/ do
+        left << args.shift
+      end
+      left << args.shift if args[0]
+      return [left, args]
+    end
+
+    def self.parse!(args = ARGV)
+      RawTool.new.parse!(args)
+    end
+
+    def loglevel(level)
+      case level
+        when 'debug'
+         Logger::DEBUG
+        when 'info'
+         Logger::INFO
+        when 'warn'
+         Logger::WARN
+        when 'error'
+         Logger::ERROR
+        when 'fatal'
+         Logger::FATAL
+      end
+    end
+
+    # Options and how they are used
+    def options
+      OptionParser.new do |o|
+        o.set_summary_indent('  ')
+        o.banner =    "Usage: raw raw-script-url [OPTIONS]"
+        o.define_head "Ruby ANT Wrapper (RAW)."
+
+        o.separator ""
+        o.separator "GENERAL OPTIONS"
+
+        o.on("-v", "--verbose", "Turn on verbose ant output.") { |verbose| $verbose = verbose }
+        o.on("-h", "--help", "Show this help message.") { puts o; exit }
+        o.on("-r", "--root directory", "Set the root path of the script. Defaults to '.'") { |root| $root_dir = root}
+        o.on("-l", "--loglevel level", "Set the log level. Default is info. Possible values are: error, warn, info, debug") { |level| @loglevel = loglevel(level)}
+        o.separator ""
+        o.separator "EXAMPLES"
+        o.separator "  run example script:"
+        o.separator "    raw scripts/ant.rb -r ../.. -v \n"
+        o.separator "  Run a raw-script from a pastie URL:"
+        o.separator "    raw http://www.pastie.org/508302 -r ../.. -v -l debug \n"
+        o.separator "  Run a script without parameters:"
+        o.separator "    raw ant.rb\n"
+      end
+    end
+  end
 end
 
-RAW::RawRunner.parse!
+RAW::RawTool.parse!

data/lib/raw_utilities.rb

@@ -9,6 +9,7 @@
 # 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 'rjb_adapter'
 
 module RAW

data/lib/rjb_adapter.rb

@@ -16,7 +16,7 @@ module RAW
     # If true we will use JRuby
     # If false we will use Rjb gem
     def is_jruby?
-      return RUBY_PLATFORM == 'java'
+      return Gem.ruby =~ /jruby/
     end
 
     # Wrapper for import_class from JRuby

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: malagant-raw
 version: !ruby/object:Gem::Version 
-  version: 0.4.13
+  version: 0.8.1
 platform: ruby
 authors: 
 - Michael Johann
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-06-10 00:00:00 -07:00
+date: 2009-08-10 00:00:00 -07:00
 default_executable: raw
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -31,12 +31,12 @@ extensions: []
 extra_rdoc_files: 
 - History.txt
 - Manifest.txt
-- README.txt
+- README
 - LICENSE
 files: 
 - History.txt
 - Manifest.txt
-- README.txt
+- README
 - LICENSE
 - Rakefile
 - bin/raw
@@ -52,10 +52,11 @@ files:
 - spec/spec_helper.rb
 has_rdoc: true
 homepage: http://kenai.com/projects/raw
+licenses: 
 post_install_message: 
 rdoc_options: 
 - --main
-- README.txt
+- README
 require_paths: 
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement 
@@ -73,7 +74,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements: []
 
 rubyforge_project: 
-rubygems_version: 1.2.0
+rubygems_version: 1.3.5
 signing_key: 
 specification_version: 2
 summary: RAW is a Ruby ANT Wrapper for describing Apache ANT tasks in ruby instead of XML.