guff 0.0.2 → 0.0.4

data/tasks/deployment.rake

@@ -0,0 +1,34 @@
+desc 'Release the website and new gem version'
+task :deploy => [:check_version, :website, :release] do
+  puts "Remember to create SVN tag:"
+  puts "svn copy svn+ssh://#{rubyforge_username}@rubyforge.org/var/svn/#{PATH}/trunk " +
+    "svn+ssh://#{rubyforge_username}@rubyforge.org/var/svn/#{PATH}/tags/REL-#{VERS} "
+  puts "Suggested comment:"
+  puts "Tagging release #{CHANGES}"
+end
+
+desc 'Runs tasks website_generate and install_gem as a local deployment of the gem'
+task :local_deploy => [:website_generate, :install_gem]
+
+task :check_version do
+  unless ENV['VERSION']
+    puts 'Must pass a VERSION=x.y.z release version'
+    exit
+  end
+  unless ENV['VERSION'] == VERS
+    puts "Please update your version.rb to match the release version, currently #{VERS}"
+    exit
+  end
+end
+
+desc 'Install the package as a gem, without generating documentation(ri/rdoc)'
+task :install_gem_no_doc => [:clean, :package] do
+  sh "#{'sudo ' unless Hoe::WINDOZE }gem install pkg/*.gem --no-rdoc --no-ri"
+end
+
+namespace :manifest do
+  desc 'Recreate Manifest.txt to include ALL files'
+  task :refresh do
+    `rake check_manifest | patch -p0 > Manifest.txt`
+  end
+end

data/tasks/environment.rake

@@ -0,0 +1,7 @@
+task :ruby_env do
+  RUBY_APP = if RUBY_PLATFORM =~ /java/
+    "jruby"
+  else
+    "ruby"
+  end unless defined? RUBY_APP
+end

data/tasks/website.rake

@@ -0,0 +1,17 @@
+desc 'Generate website files'
+task :website_generate => :ruby_env do
+  (Dir['website/**/*.txt'] - Dir['website/version*.txt']).each do |txt|
+    sh %{ #{RUBY_APP} script/txt2html #{txt} > #{txt.gsub(/txt$/,'html')} }
+  end
+end
+
+desc 'Upload website files to rubyforge'
+task :website_upload do
+  host = "#{rubyforge_username}@rubyforge.org"
+  remote_dir = "/var/www/gforge-projects/#{PATH}/"
+  local_dir = 'website'
+  sh %{rsync -aCv #{local_dir}/ #{host}:#{remote_dir}}
+end
+
+desc 'Generate and upload website files'
+task :website => [:website_generate, :website_upload, :publish_docs]

data/test/java_source/files/ClassWithConstructors.java

@@ -0,0 +1,22 @@
+package guff.test;
+
+public class ClassWithConstructors{
+    private int anIntField;
+    private String aStringField;
+
+    public ClassWithConstructors(int ignored) throws SomeWeirdException{
+    }
+
+    public ClassWithConstructors(java.util.Date ignored,boolean active){
+        super();
+    }
+
+    public ClassWithConstructors(int anIntField){
+        this.anIntField=anIntField;
+    }
+
+    public ClassWithConstructors(int anIntField,String aStringField){
+        this.anIntField=anIntField;
+        this.aStringField=aStringField;
+    }
+}

data/test/java_source/files/ClassWithFields.java

@@ -4,6 +4,10 @@ public class ClassWithFields{
     private static final String name = "Fred";
     private long id = 0;
     private some.other.pkg.User user = new some.other.pkg.User(0,2);
+    /**
+      * This field has one line of javadoc
+      * And another line of javadoc too!
+      */
     int otherId;
     protected char c;
     public boolean flag = false;

data/test/java_source/files/ClassWithImports.java

@@ -0,0 +1,8 @@
+package guff.test;
+
+import java.util.List;
+import static java.util.Collection.WHATEVER;
+import some.pkg.SomeClass;
+
+public class ClassWithImports{
+}

data/test/java_source/files/ClassWithMethods.java

@@ -2,10 +2,14 @@ package guff.test;
 
 public class ClassWithMethods{
 
-    private static final String getName(){
+    private static final String getName() throws NullPointerException, java.lang.RuntimeException{
         return "Fred";
     }
 
+    /**
+      * This is some javadoc
+      * This is some more javadoc
+      */
     protected boolean isHappy(String name,pkg.Person p,pkg.Friend f){
         if(f.hasMoney()){
             if(p.hasHealth()){

data/test/java_source/files/GenericClass.java

@@ -1,4 +1,7 @@
 package guff.test;
 
+/**
+  * This class has a line of javadoc.  With a little follow on.
+  */
 public class GenericClass<T extends SomethingElse>{
 }

data/test/java_source/{class_declaration_test.rb → test_class_declaration.rb}

@@ -43,11 +43,31 @@ class ClassDeclarationTest < Test::Unit::TestCase
         source = new_source_file.package('guff.test')
         source.begin_class('GenericClass') {|c|
             c.genericized_using('<T extends SomethingElse>')
+            c.add_javadoc("This class has a line of javadoc.  With a little follow on.")
         }
 
         assert_source_file_equals(source,prepared_file_for_tests('GenericClass'))
     end
 
+    def test_can_generate_a_class_with_constructors
+        source = new_source_file.package('guff.test')
+
+        source.begin_class('ClassWithConstructors') {|c|
+            c.add_field("anIntField",:int)
+            c.add_field("aStringField",:String)
+
+            c.add_constructor.taking("ignored","int").throws("SomeWeirdException").body {|body|
+            }
+            c.add_constructor.taking("ignored","java.util.Date").taking("active","boolean").body {|body|
+                body.line("super();")
+            }
+            c.add_constructor.for_field("anIntField")
+            c.add_constructor.for_fields("anIntField","aStringField")
+        }
+
+        assert_source_file_equals(source,prepared_file_for_tests('ClassWithConstructors'))
+    end
+
 
     def prepared_empty_class
         prepared_file_for_tests('EmptyClass')

data/test/java_source/{field_declaration_test.rb → test_field_declaration.rb}

@@ -9,7 +9,7 @@ class FieldDeclarationTest < Test::Unit::TestCase
             c.add_field('name',:String).static.final.initial('"Fred"')
             c.add_field('id',:long).initial('0')
             c.add_field('user','some.other.pkg.User').initial('new some.other.pkg.User(0,2)')
-            c.add_field('otherId',:int).package_local
+            c.add_field('otherId',:int).package_local.add_javadoc('This field has one line of javadoc').add_javadoc('And another line of javadoc too!')
             c.add_field('c',:char).protected
             c.add_field('flag',:boolean).public.initial('false')
         }

data/test/java_source/test_helper.rb

@@ -76,5 +76,3 @@ module JavaSourceTestHelper
     end
 end
 
-require File.dirname(__FILE__) + '/../test_helper.rb'
-require File.dirname(__FILE__) + '/../../lib/guff/java_source.rb'

data/test/java_source/test_import_declaration.rb

@@ -0,0 +1,14 @@
+require File.dirname(__FILE__) + '/test_helper.rb'
+
+class ImportDeclarationTest < Test::Unit::TestCase
+    include JavaSourceTestHelper
+
+    def test_can_generate_an_empty_class
+        source = new_source_file.package('guff.test').import('java.util.List').import('static java.util.Collection.WHATEVER')
+        source.begin_class('ClassWithImports') { |c|
+            c.import('some.pkg.SomeClass').import('some.pkg.SomeClass')
+        }
+
+        assert_source_file_equals(source, prepared_file_for_tests('ClassWithImports'))
+    end
+end

data/test/java_source/{method_declaration_test.rb → test_method_declaration.rb}

@@ -6,11 +6,13 @@ class MethodDeclarationTest < Test::Unit::TestCase
     def test_can_declare_methods
         source = new_source_file.package('guff.test')
         source.begin_class('ClassWithMethods') {|c|
-            c.add_method("getName").private.static.final.returns(:String).body { |body|
+            c.add_method("getName").private.static.final.returns(:String).throws('NullPointerException').throws('java.lang.RuntimeException').body { |body|
                 body.line('return "Fred";')
             }
 
-            c.add_method('isHappy').protected.takes('name', :String).takes('p', 'pkg.Person').takes('f', 'pkg.Friend').returns(:boolean).body { |body|
+            method_builder = c.add_method('isHappy')
+            method_builder.add_javadoc("This is some javadoc").add_javadoc("This is some more javadoc")
+            method_builder.protected.takes('name', :String).takes('p', 'pkg.Person').takes('f', 'pkg.Friend').returns(:boolean).body { |body|
                 body.append('if(f.hasMoney())').body { |nested|
                     nested.append('if(p.hasHealth())').body { |nested2|
                         nested2.line('return true;')

data/test/test_helper.rb

@@ -1 +1,2 @@
-require 'test/unit'
+require 'test/unit'
+require File.dirname(__FILE__) + '/../lib/guff'

data/website/index.html

@@ -0,0 +1,326 @@
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
+"http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
+<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
+<head>
+  <link rel="stylesheet" href="stylesheets/screen.css" type="text/css" media="screen" />
+  <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
+  <title>
+      Java Source Code Generator
+  </title>
+  <script src="javascripts/rounded_corners_lite.inc.js" type="text/javascript"></script>
+<style>
+
+</style>
+  <script type="text/javascript">
+    window.onload = function() {
+      settings = {
+          tl: { radius: 10 },
+          tr: { radius: 10 },
+          bl: { radius: 10 },
+          br: { radius: 10 },
+          antiAlias: true,
+          autoPad: true,
+          validTags: ["div"]
+      }
+      var versionBox = new curvyCorners(settings, document.getElementById("version"));
+      versionBox.applyCornersToAll();
+    }
+  </script>
+</head>
+<body>
+<div id="main">
+
+    <h1>Java Source Code Generator</h1>
+    <div id="version" class="clickable" onclick='document.location = "http://rubyforge.org/projects/guff"; return false'>
+      <p>Get Version</p>
+      <a href="http://rubyforge.org/projects/guff" class="numbers">0.0.4</a>
+    </div>
+    <h1>&#x2192; &#8216;guff&#8217;</h1>
+
+
+	<h2>What</h2>
+
+
+<code>guff</code> is a ruby gem containing classes that let you produce nicely formatted Java code.  Its intended to be used
+by code generation scripts that eliminate a lot of the &#8216;guff&#8217; that often ends up being written on Java projects.  One
+example of this is the <a href="http://rubyforge.org/projects/jbuilder-guff">java_testing_guff</a> project, which generates java classes
+that provide fluent interfaces to configure mock objects.
+
+	<h2>Installing</h2>
+
+
+	<p><pre class='syntax'><span class="ident">sudo</span> <span class="ident">gem</span> <span class="ident">install</span> <span class="ident">guff</span></pre></p>
+
+
+	<h2>The basics</h2>
+
+
+<code>guff</code> consists of classes that model a Java source file: SourceFile, Class, Constructor, Method, Field, Annotation etc.
+You begin by constructing a SourceFile.  Then, in a series of nested method calls, you can add the class, fields, method etc.
+Finally you can tell the source file to save itself.  All these classes live in the <code>Guff::JavaSource</code> module.
+
+	<h2>Generating a Java source file</h2>
+
+
+	<p>You begin by creating a new source file in a particular package:</p>
+
+
+	<p><pre class='syntax'>
+<span class="ident">source</span><span class="punct">=</span><span class="constant">Guff</span><span class="punct">::</span><span class="constant">JavaSource</span><span class="punct">::</span><span class="constant">SourceFile</span><span class="punct">.</span><span class="ident">new</span><span class="punct">.</span><span class="ident">package</span><span class="punct">('</span><span class="string">guff.test</span><span class="punct">')</span>
+</pre></p>
+
+
+	<p>You may add some import statements if you need.  Import statements can be added later in your code generation script
+if you do not know all your imports at this stage.  Its common to learn that you need to import a particular class only
+deep down in the guts of your code generation script.  But, if you do know you need an import or two:</p>
+
+
+	<p><pre class='syntax'>
+<span class="ident">source</span><span class="punct">.</span><span class="ident">import</span><span class="punct">(&quot;</span><span class="string">java.util.Collections</span><span class="punct">&quot;).</span><span class="ident">import</span><span class="punct">(&quot;</span><span class="string">some.other.Thing.*</span><span class="punct">&quot;)</span>
+</pre></p>
+
+
+	<p>These imported classes are just strings as far as <code>guff</code> is concerned.  It makes no attempt to do anything
+smart with them like checking for their existence on the classpath or what have you.  It will make sure that any given
+class is imported only once though.</p>
+
+
+	<h3>Adding a new class</h3>
+
+
+	<p>Now that you have a source file, you can add a class to it:</p>
+
+
+	<p><pre class='syntax'>
+<span class="ident">source</span><span class="punct">.</span><span class="ident">begin_class</span><span class="punct">('</span><span class="string">GenericClass</span><span class="punct">')</span> <span class="punct">{|</span><span class="ident">c</span><span class="punct">|</span>
+            <span class="ident">c</span><span class="punct">.</span><span class="ident">genericized_using</span><span class="punct">('</span><span class="string">&lt;T extends SomethingElse&gt;</span><span class="punct">')</span>
+            <span class="ident">c</span><span class="punct">.</span><span class="ident">extends</span><span class="punct">('</span><span class="string">guff.test.SuperClass</span><span class="punct">')</span>
+            <span class="ident">c</span><span class="punct">.</span><span class="ident">implements</span><span class="punct">('</span><span class="string">guff.test.Interface</span><span class="punct">',</span> <span class="punct">'</span><span class="string">java.io.Serializable</span><span class="punct">')</span>
+            <span class="ident">c</span><span class="punct">.</span><span class="ident">add_javadoc</span><span class="punct">(&quot;</span><span class="string">This class has a line of javadoc.</span><span class="punct">&quot;).</span><span class="ident">add_javadoc</span><span class="punct">(&quot;</span><span class="string">With a little follow on.</span><span class="punct">&quot;)</span>
+        <span class="punct">}</span>
+</pre></p>
+
+
+	<h3>Adding fields to the class</h3>
+
+
+	<p>You can add fields to a class like this:</p>
+
+
+	<p><pre class='syntax'>
+<span class="ident">source</span><span class="punct">.</span><span class="ident">begin_class</span><span class="punct">('</span><span class="string">SomeClass</span><span class="punct">')</span> <span class="punct">{|</span><span class="ident">c</span><span class="punct">|</span>
+            <span class="ident">c</span><span class="punct">.</span><span class="ident">add_field</span><span class="punct">('</span><span class="string">name</span><span class="punct">',</span><span class="symbol">:String</span><span class="punct">).</span><span class="ident">static</span><span class="punct">.</span><span class="ident">final</span><span class="punct">.</span><span class="ident">initial</span><span class="punct">('</span><span class="string">&quot;Fred&quot;</span><span class="punct">')</span>
+            <span class="ident">c</span><span class="punct">.</span><span class="ident">add_field</span><span class="punct">('</span><span class="string">id</span><span class="punct">',</span><span class="symbol">:long</span><span class="punct">).</span><span class="ident">initial</span><span class="punct">('</span><span class="string">0</span><span class="punct">')</span>
+            <span class="ident">c</span><span class="punct">.</span><span class="ident">add_field</span><span class="punct">('</span><span class="string">user</span><span class="punct">','</span><span class="string">some.other.pkg.User</span><span class="punct">').</span><span class="ident">initial</span><span class="punct">('</span><span class="string">new some.other.pkg.User(0,2)</span><span class="punct">')</span>
+            <span class="ident">c</span><span class="punct">.</span><span class="ident">add_field</span><span class="punct">('</span><span class="string">otherId</span><span class="punct">',</span><span class="symbol">:int</span><span class="punct">).</span><span class="ident">package_local</span>
+            <span class="ident">c</span><span class="punct">.</span><span class="ident">add_field</span><span class="punct">('</span><span class="string">c</span><span class="punct">',</span><span class="symbol">:char</span><span class="punct">).</span><span class="ident">protected</span><span class="punct">.</span><span class="ident">add_javadoc</span><span class="punct">('</span><span class="string">javadoc</span><span class="punct">').</span><span class="ident">add_javadoc</span><span class="punct">('</span><span class="string">More javadoc!</span><span class="punct">')</span>
+            <span class="ident">c</span><span class="punct">.</span><span class="ident">add_field</span><span class="punct">('</span><span class="string">flag</span><span class="punct">',</span><span class="symbol">:boolean</span><span class="punct">).</span><span class="ident">public</span><span class="punct">.</span><span class="ident">initial</span><span class="punct">('</span><span class="string">false</span><span class="punct">')</span>
+        <span class="punct">}</span>
+</pre></p>
+
+
+	<p>By default fields are <code>private</code>.</p>
+
+
+	<h3>Adding a constructor</h3>
+
+
+	<p>You can add constructors to a class like this:</p>
+
+
+	<p><pre class='syntax'>
+<span class="ident">source</span><span class="punct">.</span><span class="ident">begin_class</span><span class="punct">('</span><span class="string">SomeClass</span><span class="punct">')</span> <span class="punct">{|</span><span class="ident">c</span><span class="punct">|</span>
+            <span class="ident">c</span><span class="punct">.</span><span class="ident">add_constructor</span><span class="punct">.</span><span class="ident">taking</span><span class="punct">(&quot;</span><span class="string">date</span><span class="punct">&quot;,&quot;</span><span class="string">java.util.Date</span><span class="punct">&quot;).</span><span class="ident">taking</span><span class="punct">(&quot;</span><span class="string">active</span><span class="punct">&quot;,&quot;</span><span class="string">boolean</span><span class="punct">&quot;).</span><span class="ident">body</span> <span class="punct">{|</span><span class="ident">body</span><span class="punct">|</span>
+                <span class="ident">body</span><span class="punct">.</span><span class="ident">line</span><span class="punct">(&quot;</span><span class="string">super();</span><span class="punct">&quot;)</span>
+            <span class="punct">}</span>
+        <span class="punct">}</span>
+</pre></p>
+
+
+	<p>You can string together as many <code>taking</code> clauses as you need (<code>taking</code> and <code>takes</code>
+are aliases by the way).</p>
+
+
+	<h3>Defining the body of the constructor</h3>
+
+
+	<p>When you want to define the body of a constructor (or method), you call the <code>body</code> method on the constructor
+and use a single argument block to define the contents of the body.  The body instance that is passed to this block supports
+the following methods:</p>
+
+
+	<p><pre class='syntax'>
+    <span class="comment"># an entire line of java code including new line</span>
+    <span class="ident">body</span><span class="punct">.</span><span class="ident">line</span><span class="punct">(&quot;</span><span class="string">super();</span><span class="punct">&quot;)</span>
+
+    <span class="comment"># append the supplied text to the current line</span>
+    <span class="ident">body</span><span class="punct">.</span><span class="ident">append</span><span class="punct">(&quot;</span><span class="string">this.</span><span class="punct">&quot;).</span><span class="ident">append</span><span class="punct">(&quot;</span><span class="string">execute()</span><span class="punct">&quot;)</span> 
+
+    <span class="comment"># a nested block - call body again</span>
+    <span class="ident">body</span><span class="punct">.</span><span class="ident">body</span> <span class="punct">{</span> <span class="punct">|</span><span class="ident">nested_body</span><span class="punct">|</span>
+        <span class="ident">nested_body</span><span class="punct">.</span><span class="ident">line</span><span class="punct">('</span><span class="string">System.out.println(&quot;Nested&quot;);</span><span class="punct">');</span>
+    <span class="punct">}</span>
+</pre></p>
+
+
+	<h3>Adding a method</h3>
+
+
+	<p>You can add methods to a class like this:</p>
+
+
+	<p><pre class='syntax'>
+<span class="ident">source</span><span class="punct">.</span><span class="ident">begin_class</span><span class="punct">('</span><span class="string">SomeClass</span><span class="punct">')</span> <span class="punct">{|</span><span class="ident">c</span><span class="punct">|</span>
+            <span class="ident">c</span><span class="punct">.</span><span class="ident">add_method</span><span class="punct">.</span><span class="ident">taking</span><span class="punct">(&quot;</span><span class="string">active</span><span class="punct">&quot;,&quot;</span><span class="string">boolean</span><span class="punct">&quot;).</span><span class="ident">returns</span><span class="punct">(&quot;</span><span class="string">java.util.Date</span><span class="punct">&quot;).</span><span class="ident">body</span> <span class="punct">{|</span><span class="ident">body</span><span class="punct">|</span>
+                <span class="ident">body</span><span class="punct">.</span><span class="ident">line</span><span class="punct">(&quot;</span><span class="string">super();</span><span class="punct">&quot;)</span>
+            <span class="punct">}</span>
+        <span class="punct">}</span>
+</pre></p>
+
+
+	<p>Which is the same as adding a constructor, except for the <code>returns</code> clause.
+By default methods are <code>public</code> and return <code>void</code>.
+The body of a method is defined in the same way as the body of a constructor (above).</p>
+
+
+	<h3>Adding a throws clause</h3>
+
+
+	<p>You can add as many throws clauses as you need to methods and constructors like this:</p>
+
+
+	<p><pre class='syntax'>
+<span class="ident">source</span><span class="punct">.</span><span class="ident">begin_class</span><span class="punct">('</span><span class="string">SomeClass</span><span class="punct">')</span> <span class="punct">{|</span><span class="ident">c</span><span class="punct">|</span>
+            <span class="ident">c</span><span class="punct">.</span><span class="ident">add_method</span><span class="punct">.</span><span class="ident">throws</span><span class="punct">(&quot;</span><span class="string">guff.SomeWeirdException</span><span class="punct">&quot;).</span><span class="ident">throws</span><span class="punct">(&quot;</span><span class="string">guff.SomeOtherException</span><span class="punct">&quot;).</span><span class="ident">body</span> <span class="punct">{|</span><span class="ident">body</span><span class="punct">|</span>
+                <span class="ident">body</span><span class="punct">.</span><span class="ident">line</span><span class="punct">(&quot;</span><span class="string">super();</span><span class="punct">&quot;)</span>
+            <span class="punct">}</span>
+        <span class="punct">}</span>
+</pre></p>
+
+
+	<h3>Adding annotations</h3>
+
+
+	<p>You can add as many annotations as you need to classes, fields, methods and constructors like this:</p>
+
+
+	<p><pre class='syntax'>
+<span class="ident">source</span><span class="punct">.</span><span class="ident">begin_class</span><span class="punct">('</span><span class="string">ClassWithAnnotatedMethods</span><span class="punct">')</span> <span class="punct">{|</span><span class="ident">c</span><span class="punct">|</span>
+            <span class="ident">c</span><span class="punct">.</span><span class="ident">add_annotation</span><span class="punct">(&quot;</span><span class="string">javax.persistence.Entity</span><span class="punct">&quot;)</span>
+
+            <span class="ident">m</span> <span class="punct">=</span> <span class="ident">c</span><span class="punct">.</span><span class="ident">add_method</span><span class="punct">(&quot;</span><span class="string">getAddressID</span><span class="punct">&quot;).</span><span class="ident">returns</span><span class="punct">(</span><span class="symbol">:String</span><span class="punct">)</span>
+            <span class="ident">m</span><span class="punct">.</span><span class="ident">add_annotation</span><span class="punct">(&quot;</span><span class="string">javax.persistence.Column</span><span class="punct">&quot;)</span> <span class="punct">{|</span><span class="ident">a</span><span class="punct">|</span>
+                <span class="ident">a</span><span class="punct">.</span><span class="ident">add_property</span><span class="punct">(&quot;</span><span class="string">name</span><span class="punct">&quot;,</span> <span class="punct">'</span><span class="string">&quot;addressID&quot;</span><span class="punct">')</span>
+                <span class="ident">a</span><span class="punct">.</span><span class="ident">add_property</span><span class="punct">(&quot;</span><span class="string">table</span><span class="punct">&quot;,</span> <span class="punct">'</span><span class="string">&quot;EMP_DETAIL&quot;</span><span class="punct">')</span>
+            <span class="punct">}</span>
+            <span class="ident">m</span><span class="punct">.</span><span class="ident">add_annotation</span><span class="punct">(&quot;</span><span class="string">SuppressWarnings</span><span class="punct">&quot;,'</span><span class="string">&quot;unchecked&quot;</span><span class="punct">')</span>
+            <span class="ident">m</span><span class="punct">.</span><span class="ident">body</span> <span class="punct">{|</span><span class="ident">body</span><span class="punct">|</span>
+                <span class="ident">body</span><span class="punct">.</span><span class="ident">line</span><span class="punct">('</span><span class="string">return &quot;0&quot;;</span><span class="punct">')</span>
+            <span class="punct">}</span>
+</pre></p>
+
+
+	<p>And you can generate complex annotations like this:</p>
+
+
+	<p><pre class='syntax'>
+<span class="ident">source</span><span class="punct">.</span><span class="ident">begin_class</span><span class="punct">('</span><span class="string">ClassWithAnnotatedMethods</span><span class="punct">')</span> <span class="punct">{|</span><span class="ident">c</span><span class="punct">|</span>
+            <span class="ident">c</span><span class="punct">.</span><span class="ident">add_annotation</span><span class="punct">(&quot;</span><span class="string">javax.persistence.Entity</span><span class="punct">&quot;)</span>
+
+            <span class="ident">m</span> <span class="punct">=</span> <span class="ident">c</span><span class="punct">.</span><span class="ident">add_method</span><span class="punct">(&quot;</span><span class="string">getAddressID</span><span class="punct">&quot;).</span><span class="ident">returns</span><span class="punct">(</span><span class="symbol">:String</span><span class="punct">)</span>
+            <span class="ident">m</span><span class="punct">.</span><span class="ident">add_annotation</span><span class="punct">(&quot;</span><span class="string">JoinTable</span><span class="punct">&quot;)</span> <span class="punct">{|</span><span class="ident">a</span><span class="punct">|</span>
+                <span class="ident">a</span><span class="punct">.</span><span class="ident">add_property</span><span class="punct">(&quot;</span><span class="string">name</span><span class="punct">&quot;,</span> <span class="punct">'</span><span class="string">&quot;CUSTOMERBEANSUBSCRIPTIONBEAN&quot;</span><span class="punct">')</span>
+                <span class="ident">a</span><span class="punct">.</span><span class="ident">add_property</span><span class="punct">(&quot;</span><span class="string">joinColumns</span><span class="punct">&quot;,</span> <span class="ident">annotation</span><span class="punct">(&quot;</span><span class="string">JoinColumn</span><span class="punct">&quot;){|</span><span class="ident">aa</span><span class="punct">|</span>
+                    <span class="ident">aa</span><span class="punct">.</span><span class="ident">add_property</span><span class="punct">(&quot;</span><span class="string">name</span><span class="punct">&quot;,</span> <span class="punct">'</span><span class="string">&quot;CUSTOMERBEAN_CUSTOMERID96&quot;</span><span class="punct">')</span>
+                    <span class="ident">aa</span><span class="punct">.</span><span class="ident">add_property</span><span class="punct">(&quot;</span><span class="string">referencedColumnName</span><span class="punct">&quot;,</span> <span class="punct">'</span><span class="string">&quot;customerid&quot;</span><span class="punct">')</span>
+                <span class="punct">})</span>
+                <span class="ident">a</span><span class="punct">.</span><span class="ident">add_property</span><span class="punct">(&quot;</span><span class="string">inverseJoinColumns</span><span class="punct">&quot;,</span> <span class="ident">annotation</span><span class="punct">(&quot;</span><span class="string">JoinColumn</span><span class="punct">&quot;){|</span><span class="ident">aa</span><span class="punct">|</span>
+                    <span class="ident">aa</span><span class="punct">.</span><span class="ident">add_property</span><span class="punct">(&quot;</span><span class="string">name</span><span class="punct">&quot;,</span> <span class="punct">'</span><span class="string">&quot;SUBSCRIPTION_TITLE&quot;</span><span class="punct">')</span>
+                    <span class="ident">aa</span><span class="punct">.</span><span class="ident">add_property</span><span class="punct">(&quot;</span><span class="string">referencedColumnName</span><span class="punct">&quot;,</span> <span class="punct">'</span><span class="string">&quot;TITLE&quot;</span><span class="punct">')</span>
+                <span class="punct">})</span>
+            <span class="punct">}</span>
+</pre></p>
+
+
+	<h3>Scope and modifiers</h3>
+
+
+	<p>Classes, fields and methods support scoping and addition of modifiers as follows:</p>
+
+
+	<p><pre class='syntax'>
+    <span class="ident">method</span><span class="punct">.</span><span class="ident">public</span><span class="punct">.</span><span class="ident">abstract</span>
+    <span class="ident">field</span><span class="punct">.</span><span class="ident">private</span><span class="punct">.</span><span class="ident">final</span>
+    <span class="ident">clazz</span><span class="punct">.</span><span class="ident">package_local</span><span class="punct">.</span><span class="ident">abstract</span>
+</pre></p>
+
+
+	<p>The supported scopes are <code>public</code>, <code>protected</code>, <code>package_local</code> and <code>private</code>.
+The supported modifiers are <code>abstract</code>, <code>final</code> and <code>static</code></p>
+
+
+	<h3>Adding javadoc</h3>
+
+
+	<p>Classes, constructors, methods and fields support javadoc as follows:</p>
+
+
+	<p><pre class='syntax'>
+    <span class="ident">method</span><span class="punct">.</span><span class="ident">add_javadoc</span><span class="punct">(&quot;</span><span class="string">Line of javadoc</span><span class="punct">&quot;).</span><span class="ident">add_javadoc</span><span class="punct">(&quot;</span><span class="string">Nudder line of javadoc</span><span class="punct">&quot;)</span>
+</pre></p>
+
+
+	<h3>Adding imports</h3>
+
+
+	<p>Source files, classes, fields, constructors and methods all support the <code>import</code> statement, but all imports will be written
+out in the right place when the file is saved (i.e. between the package statement and the class declaration).  If you
+import a given class more than once, it will be imported only once in the generated java source file.</p>
+
+
+	<h3>Saving the generated code</h3>
+
+
+	<p>Once you have all your fields, constructors and methods added you can save your source file as follows:</p>
+
+
+	<p><pre class='syntax'>
+    <span class="ident">source</span><span class="punct">.</span><span class="ident">save_in</span><span class="punct">(&quot;</span><span class="string">../src/generated</span><span class="punct">&quot;)</span>
+</pre></p>
+
+
+	<h2>Forum</h2>
+
+
+	<p><a href="http://groups.google.com/group/guff">http://groups.google.com/group/guff</a></p>
+
+
+	<h2>How to submit patches</h2>
+
+
+	<p>Read the <a href="http://drnicwilliams.com/2007/06/01/8-steps-for-fixing-other-peoples-code/">8 steps for fixing other people&#8217;s code</a> and for section <a href="http://drnicwilliams.com/2007/06/01/8-steps-for-fixing-other-peoples-code/#8b-google-groups">8b: Submit patch to Google Groups</a>, use the Google Group above.</p>
+
+
+	<p>The project is hosted <a href="http://rubyforge.org/projects/jbuilder-guff/">here</a> and you can find details of how to get anonymous svn access there.</p>
+
+
+	<h2>License</h2>
+
+
+	<p>This code is free to use under the terms of the <span class="caps">MIT</span> license.</p>
+
+
+	<h2>Contact</h2>
+
+
+	<p>Comments are welcome. Send an email to the <a href="http://groups.google.com/group/guff">forum</a></p>
+    <p class="coda">
+      <a href="mailto:me@mikehogan.net">Mike Hogan</a>, 7th February 2008<br>
+      Theme extended from <a href="http://rb2js.rubyforge.org/">Paul Battley</a>
+    </p>
+</div>
+
+<!-- insert site tracking codes here, like Google Urchin -->
+
+</body>
+</html>