AntBuilder 0.4.1

data/docs/publish.bat

@@ -0,0 +1,4 @@
+cd \dev\DynamicFun\AntBuilder\docs
+C:\cygwin\bin\scp.exe index.html rubyforge.org:/var/www/gforge-projects/antbuilder/
+C:\cygwin\bin\scp.exe index_html_7cda332d.jpg rubyforge.org:/var/www/gforge-projects/antbuilder/
+pause

data/examples/basic/check_install.rb

@@ -0,0 +1,6 @@
+require 'builder/antbuilder'
+
+ant = Builder::AntBuilder.new    
+ant.echo(:text => "AntBuilder installed ok")
+
+

data/examples/jruby/build.rb

@@ -0,0 +1,361 @@
+require 'builder/antbuilder'
+require 'date'
+
+
+class Build < Builder::AntBuilder
+
+  #   JRuby is a pure Java implementation of a Ruby interpreter.
+    
+  def initialize
+    
+    super() # super(:debug=>true)
+    
+    @basedir = "."
+   
+    # First try to load machine-specific properties.
+    property(:file=>"build.properties")
+    
+    #And then load the defaults. It seems backwards to set defaults AFTER setting local overrides, but that's how Ant works
+    property(:file=>"default.build.properties")
+
+    mkdir(:dir=> @lib_dir)                                               # Not in original build
+
+    path(:id =>"build.classpath") {
+      fileset(:dir =>  @lib_dir, :includes => "*.jar", :excludes => "built_by_antbuilder.jruby.jar jruby.jar")
+    }        
+    
+    patternset(:id => "java.src.pattern") {
+      include(:name=>"**/*.java")
+      exclude(:unless=>"bsf.present", :name=>"org/jruby/javasupport/bsf/**/*.java")
+      exclude(:unless=>"jdk1.4+", :name=>"**/XmlAstMarshal.java")
+      exclude(:unless=>"jdk1.4+", :name=>"**/AstPersistenceDelegates.java")
+    }
+
+    patternset(:id => "ruby.src.pattern") {
+      include(:name=>"**/*.rb")
+    }
+      
+  end
+    
+  def init
+  
+    depends # depends on nothing - (this will just print "init:")
+
+    # Copied from the original build.xml - ant properties will also be declared as ruby instance variables
+    xmlproperty(:file=>"build-config.xml", :keeproot=>"false", :collapseAttributes=>"true")
+    
+    # Copied from the original build.xml as closely as possible. The ant property version.ruby will get copied to @version_ruby
+    # Note that you can't say ${version.ruby.major}.${version.ruby.minor} below
+    property(:name=>"version.ruby", :value=>"#{@version_ruby_major}.#{@version_ruby_minor}")
+    # equivalent to:
+    # property(:name=>"version_ruby", :value=>"#{@version_ruby_major}#{@version_ruby_minor}")
+    # equivalent to:
+    # @version_ruby = "#{@version_ruby_major}#{@version_ruby_minor}"
+
+    # The tstamp was tricky to get working : 'format' is a kernel module alias for sprintf - so we have to undefine 'format' explicitly
+    # (Or just use this instead: @build_date = Date.today.to_s)
+    
+    tstamp{
+      format(:property=>"build.date", :pattern=>"yyyy-MM-dd")
+    }  
+
+    # this will define a load of ruby instance variables called env_CLASSPATH, env_JAVA_HOME etc.    
+    property(:environment=>"env")
+
+    @ruby_home = @env_RUBY_HOME if @ruby_home == nil 
+  end
+    
+  def prepare
+    
+    depends :init
+    
+    # Creates the directories needed for building
+    mkdir(:dir=> @build_dir)
+    mkdir(:dir=> @classes_dir)
+    mkdir(:dir=> @jruby_classes_dir)
+    mkdir(:dir=> @test_classes_dir)
+    mkdir(:dir=> @test_results_dir)
+    mkdir(:dir=> @html_test_results_dir)
+    mkdir(:dir=> @docs_dir)
+    mkdir(:dir=> @api_docs_dir)
+    
+  end
+    
+  def check_for_optional_packages # check if specific libs and versions are avaiable
+      
+    depends :init
+    
+    available(:property=>"jdk1.4+", :classname=>"java.lang.CharSequence")
+    available(:property=>"jdk1.5+", :classname=>"java.lang.StringBuilder")
+    available(:property=>"bsf.present", :classname=>"org.apache.bsf.BSFManager", :classpathref=>"build.classpath")
+    available(:property=>"junit.present", :classname=>"junit.framework.TestCase", :classpathref=>"build.classpath")
+    available(:property=>"cglib.present", :classname=>"net.sf.cglib.reflect.FastClass", :classpathref=>"build.classpath")
+    
+  end
+    
+  def compile_tasks # Builds the Ant tasks that we need later on in the build
+  
+    depends :prepare
+
+    javac(
+      :destdir => @jruby_classes_dir,  
+      :debug => "true", 
+      :srcdir => @src_dir,
+      :includes => "org/jruby/util/ant/**/*.java" ,
+      :source => @javac_version,
+      :failonerror=>"true", 
+      :classpathref => "build.classpath"              
+    )   
+
+    taskdef(:name =>"jruby_serialize", :classname=>"org.jruby.util.ant.JRubySerialize") {
+      # NB AntBuilder ignores the classpath entry because leafcutter does not use it, so you have to make sure that the class is on the claspath already
+      classpath(:path => @jruby_classes_dir)
+    }
+
+    copy(:todir => @jruby_classes_dir) {
+      fileset(:dir => @src_dir, :includes => "**/*.properties")
+    }
+    
+  end
+
+  def compile # Compile the source files for the project
+
+    depends :compile_tasks, :check_for_optional_packages  
+
+    javac(
+      :destdir => @jruby_classes_dir, 
+      :debug => "true", 
+      :source=> @javac_version 
+    ) {
+      src(:path => @src_dir)
+      classpath(:refid => "build.classpath" )
+      patternset(:refid => "java.src.pattern")
+    }
+    
+  end
+
+  def serialize # Serializes builting Ruby libraries into Java format
+  
+    depends :compile
+    
+    jruby_serialize(:destdir => @jruby_classes_dir, :verbose=>"true") {
+      fileset(:dir => @src_dir) {
+        patternset(:refid=>"ruby.src.pattern")
+      }
+    }
+  end    
+
+
+  def serialize_rubylib # Serializes the core Ruby library into Java format
+  
+    depends :compile
+    
+    jruby_serialize(:destdir =>@jruby_classes_dir, :verbose=>"true") {
+      fileset(:dir =>"#{@ruby_home}/lib/ruby/1.8") {
+        patternset(:refid=>"ruby.src.pattern")
+      }
+    }
+  end    
+
+  # Can't call this method "jar" because we want to call the ant jar task and they can't have the same name !!!! 
+  def create_jar   # Create the jruby.jar file
+      
+    depends :serialize
+    
+    jar(:destfile => "#{@lib_dir}/built_by_antbuilder.jruby.jar") {
+      fileset(:dir => "#{@jruby_classes_dir}") {
+        include(:name => "**/*.class")
+        include(:name => "**/*.properties")
+        include(:name => "**/*.rb.ast.ser")
+        exclude(:name => "org/jruby/util/ant/**/*.class")
+      }
+      manifest{
+        attribute(:name => "Built-By", :value => "AntBuilder")
+        attribute(:name => "Main-Class", :value => "org.jruby.Main")
+      }
+    }
+  end
+
+  def create_jar_standalone     # Create a standalone jruby.jar file using libraries from RUBY_HOME/lib/ruby/1.8"
+      
+    depends :serialize, :serialize_rubylib, :create_jar
+
+   end 
+
+  def compile_test       # Compile the unit tests
+  
+    depends :create_jar
+
+    javac(
+      :destdir => @test_classes_dir, 
+      :deprecation=>"true", 
+      :debug => "true", 
+      :source=> @javac_version,
+      :classpathref => "build.classpath" 
+    ) {
+      classpath(){
+        # moved to classpathref: path refid="build.classpath"
+        # path(:refid =>"build.classpath")
+        pathelement(:path => "#{@jruby_classes_dir}")
+        pathelement(:path => "#{@lib_dir}/built_by_antbuilder.jruby.jar")
+      }
+      src(:path => @test_dir)
+      patternset(:refid => "java.src.pattern")
+    }
+    
+  end
+
+  def copy_test_files
+    # Make tests fails available as resources
+    depends :compile_test
+
+    copy(:todir => @test_classes_dir) {
+      fileset(:dir => @test_dir, :includes => "org/**/*.rb")
+    }
+  end
+
+  def do_test #runs junit tests
+      
+    depends :copy_test_files
+
+    junit(:fork=> "yes", :haltonfailure=> "false", :dir => @basedir) {
+      classpath{
+        # tried moving "path(:refid => "build.classpath")" to classpathref  but its not supported in the junit task
+        # so just inline the "build.classpath" definition
+        fileset(:dir =>  @lib_dir, :includes => "*.jar", :excludes => "built_by_antbuilder.jruby.jar")
+        pathelement(:path => "#{@lib_dir}/built_by_antbuilder.jruby.jar")
+        pathelement(:path => "#{@test_classes_dir}")
+        pathelement(:path => "#{@test_dir}/requireTest.jar")
+      }
+      sysproperty(:key => "jruby_base", :value => @basedir)
+      sysproperty(:key => "jruby_home", :value => @basedir)
+      sysproperty(:key => "jruby_lib", :value => @lib_dir)
+
+      formatter(:type => "xml")
+      formatter(:type => "brief", :usefile => "false")
+
+      test(:name => "org.jruby.test.MainTestSuite", :todir => @test_results_dir)
+    }
+
+
+# The following does not work with leafcutter so that code above is used. Not sure why this doesn't work.
+#    path(:id =>"test.classpath") {
+#      fileset(:dir =>  @lib_dir, :includes => "*.jar", :excludes => "built_by_antbuilder.jruby.jar jruby.jar")
+#      pathelement(:path => "#{@lib_dir}/built_by_antbuilder.jruby.jar")
+#      pathelement(:path => "#{@test_classes_dir}")
+#      pathelement(:path => "#{@test_dir}/requireTest.jar")      
+#    }        
+#    
+#    junit(:fork=> "yes", :haltonfailure=> "false", :dir => @basedir) {
+#      classpath(:refid => "test.classpath" )
+#      sysproperty(:key => "jruby_base", :value => @basedir)
+#      sysproperty(:key => "jruby_home", :value => @basedir)
+#      sysproperty(:key => "jruby_lib", :value => @lib_dir)
+#
+#      formatter(:type => "xml")
+#      formatter(:type => "brief", :usefile => "false")
+#
+#      test(:name => "org.jruby.test.MainTestSuite", :todir => @test_results_dir)
+#    }
+
+    junitreport(:todir => @test_results_dir){
+      fileset(:dir => @test_results_dir, :includes => "TEST-*.xml")
+      report(:format => "frames", :todir => @html_test_results_dir)
+    }
+  end
+
+  def create_apidocs # Creates the Java API docs
+          
+    depends :prepare
+    
+    javadoc(:destdir=> @api_docs_dir, :author=>"true", :version=>"true", :use=>"true", :windowtitle=>"JRuby API", :source => @javac_version) {
+      fileset(:dir => @src_dir)
+      fileset(:dir => @test_dir)
+      doctitle(
+        :text => "<h1>JRuby</h1>"
+      )
+      bottom(
+        :text => "<i>Copyright &#169; 2002-2005 JRuby Team. All Rights Reserved.</i>"
+      )
+    }
+  end
+
+  def dist_bin
+
+    depends :create_jar
+
+    tar(:destfile=>"jruby-bin-#{@version_jruby}.tar.gz", :compression=>"gzip") {
+      tarfileset(:dir => ".", :mode => "755", :prefix => "jruby_#{@version_jruby}") {
+        include(:name => "bin/**")
+      }
+      tarfileset(:dir=>".", :prefix=>"jruby_#{@version_jruby}") {
+        include(:name=>"lib/**")
+        include(:name=>"samples/**")
+        include(:name=>"docs/**")
+        include(:name=>"COPYING*")
+        include(:name=>"README")
+        # Just in case we have link to real ruby dist
+        exclude(:name=>"lib/ruby/**")
+        exclude(:name=>"lib/ant.jar")
+      }
+    }
+  end
+
+  def dist_src
+
+    depends :create_jar
+
+    tar(:destfile=>"jruby-src-#{@version_jruby}.tar.gz", :compression=>"gzip") {
+      tarfileset(:dir => ".", :mode => "755", :prefix => "jruby_#{@version_jruby}") {
+        include(:name => "bin/**")
+      }
+      tarfileset(:dir=>".", :prefix=>"jruby_#{@version_jruby}") {
+        include(:name=>"lib/**")
+        include(:name=>"samples/**")
+        include(:name=>"docs/**")
+        include(:name=>"src/**")
+        include(:name=>"test/**")
+        include(:name=>"build.xml")
+        include(:name=>"build-config.xml")
+        include(:name=>"COPYING*")
+        include(:name=>"README")
+        include(:name=>".project")
+        include(:name=>".classpath")
+        include(:name=>"default.build.properties")
+        # Just in case we have link to real ruby dist
+        exclude(:name=>"lib/ruby/**")
+        exclude(:name=>"lib/ant.jar")
+      }
+    }
+  end
+
+  def dist
+    depends :dist_bin, :dist_src        
+  end
+    
+  def clean # clean almost everything
+
+    depends :init
+
+    delete(:dir => @build_dir)
+    delete(:file => "#{@lib_dir}/built_by_antbuilder.jruby.jar", :quiet=>"true")
+    delete(:dir => @api_docs_dir)
+        
+  end
+
+  # required for tstamp task which uses the format keyword..
+  undef_method :format
+
+
+  # To run a standard jruby build, from the command line run 
+  #     jruby build.rb clean serialize create_jar_standalone
+  run_targets_from_command_line      
+
+  # Or hard code a specific build e.g. =>
+  #  'Standard build'
+  #  builder = Build.new
+  #  builder.clean
+  #  builder.serialize
+  #  builder.create_jar_standalone
+
+end

data/examples/jruby/readme.txt

@@ -0,0 +1,14 @@
+build.rb is can be used to build JRuby using JRuby
+steps.
+- check out the CVS HEAD of JRuby
+- copy the AntBuilder 'builder' directory to the lib/ruby/site_ruby directory of the JRuby project
+- copy the AntBuilder 'build.rb' file to the root of the JRuby project
+- Open a command prompt in the root of the Jruby project and make sure you can run "jruby --version" (e.g. add jruby/bin to your path)
+- put leafcutter.jar (from the AntBuilder project) on the classpath
+- put tools.jar from your jdk on the classpath (required for the javac ant task)
+- put the JRuby jruby\build\classes\jruby directory on the classpath (required by the JRubySerialize task)
+- Open a command prompt in the root of the Jruby project and run: 'jruby build.rb clean serialize create_jar_standalone'
+
+
+
+

data/examples/script1/readme.txt

@@ -0,0 +1,16 @@
+update_version.rb is an example jruby script that uses AntBuilder
+============================================================
+
++ Gest the last Version Number from version.txt
++ Updates the environment.xml file in each environment.jar file in each subdirectory of env
+   so that the versionNNNN part in <VersionInformation environment="..." buildVersion="versionNNNN"/>
+   is updated with last Version Number from version.txt
+
+Setup steps.
+- See the docs for JRuby install instructions
+- Add a new entry with a new 'Project Version' to the end of version.txt
+- Run 'jruby update_version.rb' 
+- Check that the 3 environment.jar files contain an environment.xml file with the correct version number
+
+
+

data/examples/script1/update_version.rb

@@ -0,0 +1,91 @@
+require 'builder/antbuilder'
+
+#
+# Gets the last Version Number from version.txt
+# Updates the environment.xml file in each environment.jar file in each subdirectory of env
+# so that the versionNNNN part in <VersionInformation environment="..." buildVersion="versionNNNN"/>
+# is updated with last Version Number from version.txt
+
+
+def get_version
+  ################################
+  # get the version number out of QuotesClient/version.txt
+  ################################
+  
+  search1 = /Project Version *: *([A-Za-z0-9\-_.]*)/
+  versionFileName = "version.txt"
+  versionNumber = ""
+  
+  File.foreach(versionFileName) { |line| versionNumber = $1 if line =~ search1 }
+  
+  raise "Can't get a version number from #{versionFileName}" if versionNumber == ""
+  
+  puts "Found version number #{versionNumber}. Press enter to continue.................................."
+  gets
+  return versionNumber
+
+end
+
+def replace_in_file(filename, searchPattern, replaceString)
+
+  new_filename = filename + ".new"
+  
+  File.open(new_filename, "w") do |new_file| 
+    File.foreach(filename) do |line|
+      line.sub!(searchPattern) { eval('"' + replaceString + '"') }
+      new_file.puts line
+    end
+  end
+
+    
+  File.rename(new_filename, filename)
+
+  # ant.delete(:file => filename)
+  # ant.move(:file => newFilename, :tofile => filename)
+
+
+end
+
+
+versionNumber = get_version
+
+
+################################
+# Define paths
+################################
+
+root = "." 
+envdirs = "#{root}/env/" 
+
+ant = Builder::AntBuilder.new
+
+################################
+# Updates the environment.xml file in each environment.jar file in  each subdirectory of env
+# so that the versionNNNN part in <VersionInformation environment="..." buildVersion="versionNNNN"/>
+# is updated with versionNumber from version.txt
+################################
+
+Dir.foreach(envdirs) do |dirname| 
+  # ignore . and ..
+  next if File.basename(dirname) =~ /^\.+/
+  
+  dirname = "#{envdirs}#{dirname}/"
+  xmlFileName = dirname + "environment.xml"
+  jarFileName = dirname + "environment.jar"
+
+  ant.unjar(:src => jarFileName, :dest => dirname)
+  
+  # replace the versionNumber in the file with the new version number found in the version.txt file
+  # the single quotes around '#{$1}' rather than double quotes, stop the immediate evaluation of $1
+  replace_in_file(xmlFileName, /(<VersionInformation.*buildVersion.*=").*(".*$)/, '#{$1}'+ versionNumber + '#{$2}')
+
+
+  ant.delete(:file => jarFileName)
+  
+  # Jar up the environment.xml to environment.jar
+  # use ant.zip rather than ant.jar because ant.jar creates a manifest file in the jar, whreas zip doesn't  
+  ant.zip(:basedir => dirname, :destfile => jarFileName)
+
+  ant.delete(:file => xmlFileName)
+
+end