guff 0.0.2 → 0.0.4

data/History.txt

@@ -0,0 +1,4 @@
+== 0.0.3 2008-02-04
+
+* 1 major enhancement:
+  * Initial release

data/License.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2008 Mike Hogan
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/Manifest.txt

@@ -1,21 +1,37 @@
-Rakefile
-README.txt
-CHANGELOG.txt
-Manifest.txt
-setup.rb
-lib/guff/version.rb
-lib/guff/java_source.rb
-lib/guff.rb
-test/test_helper.rb
-test/java_source/files/ClassWithAnnotatedFields.java
-test/java_source/files/ClassWithAnnotatedMethods.java
-test/java_source/files/ClassWithFields.java
-test/java_source/files/ClassWithMethods.java
-test/java_source/files/EmptyClass.java
-test/java_source/files/GenericClass.java
-test/java_source/annotation_declaration_test.rb
-test/java_source/class_declaration_test.rb
-test/java_source/field_declaration_test.rb
-test/java_source/method_declaration_test.rb
-test/java_source/test_helper.rb
-test/test_helper.rb
+History.txt
+License.txt
+Manifest.txt
+README.txt
+Rakefile
+config/hoe.rb
+config/requirements.rb
+lib/guff.rb
+lib/guff/java_source.rb
+lib/guff/version.rb
+script/destroy
+script/generate
+script/txt2html
+setup.rb
+tasks/deployment.rake
+tasks/environment.rake
+tasks/website.rake
+test/java_source/test_annotation_declaration.rb
+test/java_source/test_class_declaration.rb
+test/java_source/test_field_declaration.rb
+test/java_source/test_import_declaration.rb
+test/java_source/test_method_declaration.rb
+test/java_source/files/ClassWithAnnotatedFields.java
+test/java_source/files/ClassWithAnnotatedMethods.java
+test/java_source/files/ClassWithConstructors.java
+test/java_source/files/ClassWithFields.java
+test/java_source/files/ClassWithImports.java
+test/java_source/files/ClassWithMethods.java
+test/java_source/files/EmptyClass.java
+test/java_source/files/GenericClass.java
+test/java_source/test_helper.rb
+test/test_helper.rb
+website/index.html
+website/index.txt
+website/javascripts/rounded_corners_lite.inc.js
+website/stylesheets/screen.css
+website/template.rhtml

data/README.txt

@@ -1,3 +1 @@
-README for guff
-===============
-
+README

data/Rakefile

@@ -1,54 +1,4 @@
-require 'rubygems'
-require 'rake'
-require 'rake/clean'
-require 'rake/testtask'
-require 'rake/packagetask'
-require 'rake/gempackagetask'
-require 'rake/rdoctask'
-require 'rake/contrib/rubyforgepublisher'
-require 'fileutils'
-require 'hoe'
-include FileUtils
-require File.join(File.dirname(__FILE__), 'lib', 'guff', 'version')
+require 'config/requirements'
+require 'config/hoe' # setup Hoe + all gem configuration
 
-AUTHOR = "Mike Hogan"  # can also be an array of Authors
-EMAIL = "me@mikehogan.net"
-DESCRIPTION = "An API to describe and generate Java source code. The idea is to avoid writing all the 'guff' that is typical in java projects by generating it from more succinct ruby models."
-GEM_NAME = "guff" # what ppl will type to install your gem
-RUBYFORGE_PROJECT = "guff" # The unix name for your project
-HOMEPATH = "http://#{RUBYFORGE_PROJECT}.rubyforge.org"
-
-
-NAME = "guff"
-REV = nil # UNCOMMENT IF REQUIRED: File.read(".svn/entries")[/committed-rev="(d+)"/, 1] rescue nil
-VERS = ENV['VERSION'] || (Guff::VERSION::STRING + (REV ? ".#{REV}" : ""))
-                          CLEAN.include ['**/.*.sw?', '*.gem', '.config']
-RDOC_OPTS = ['--quiet', '--title', "guff documentation",
-    "--opname", "index.html",
-    "--line-numbers", 
-    "--main", "README",
-    "--inline-source"]
-
-class Hoe
-  def extra_deps 
-    @extra_deps.reject { |x| Array(x).first == 'hoe' } 
-  end 
-end
-
-# Generate all the Rake tasks
-# Run 'rake -T' to see list of generated tasks (from gem root directory)
-hoe = Hoe.new(GEM_NAME, VERS) do |p|
-  p.author = AUTHOR 
-  p.description = DESCRIPTION
-  p.email = EMAIL
-  p.summary = DESCRIPTION
-  p.url = HOMEPATH
-  p.rubyforge_name = RUBYFORGE_PROJECT if RUBYFORGE_PROJECT
-  p.test_globs = ["test/**/*_test.rb"]
-  p.clean_globs = CLEAN  #An array of file patterns to delete on clean.
-  
-  # == Optional
-  #p.changes        - A description of the release's latest changes.
-  #p.extra_deps     - An array of rubygem dependencies.
-  #p.spec_extras    - A hash of extra values to set in the gemspec.
-end
+Dir['tasks/**/*.rake'].each { |rake| load rake }

data/config/hoe.rb

@@ -0,0 +1,71 @@
+require 'guff/version'
+
+AUTHOR = 'Mike Hogan'  # can also be an array of Authors
+EMAIL = "me@mikehogan.net"
+DESCRIPTION = "Provides a set of classes to describe and save java classes. The idea is to avoid writing all the 'guff' that is typical in java projects by generating it from more succinct ruby models"
+GEM_NAME = 'guff' # what ppl will type to install your gem
+RUBYFORGE_PROJECT = 'guff' # The unix name for your project
+HOMEPATH = "http://#{RUBYFORGE_PROJECT}.rubyforge.org"
+DOWNLOAD_PATH = "http://rubyforge.org/projects/#{RUBYFORGE_PROJECT}"
+
+@config_file = "~/.rubyforge/user-config.yml"
+@config = nil
+RUBYFORGE_USERNAME = "unknown"
+def rubyforge_username
+  unless @config
+    begin
+      @config = YAML.load(File.read(File.expand_path(@config_file)))
+    rescue
+      puts <<-EOS
+ERROR: No rubyforge config file found: #{@config_file}
+Run 'rubyforge setup' to prepare your env for access to Rubyforge
+ - See http://newgem.rubyforge.org/rubyforge.html for more details
+      EOS
+      exit
+    end
+  end
+  RUBYFORGE_USERNAME.replace @config["username"]
+end
+
+
+REV = nil 
+# UNCOMMENT IF REQUIRED: 
+# REV = `svn info`.each {|line| if line =~ /^Revision:/ then k,v = line.split(': '); break v.chomp; else next; end} rescue nil
+VERS = Guff::VERSION::STRING + (REV ? ".#{REV}" : "")
+RDOC_OPTS = ['--quiet', '--title', 'guff documentation',
+    "--opname", "index.html",
+    "--line-numbers", 
+    "--main", "README",
+    "--inline-source"]
+
+class Hoe
+  def extra_deps 
+    @extra_deps.reject! { |x| Array(x).first == 'hoe' } 
+    @extra_deps
+  end 
+end
+
+# Generate all the Rake tasks
+# Run 'rake -T' to see list of generated tasks (from gem root directory)
+hoe = Hoe.new(GEM_NAME, VERS) do |p|
+  p.author = AUTHOR 
+  p.description = DESCRIPTION
+  p.email = EMAIL
+  p.summary = DESCRIPTION
+  p.url = HOMEPATH
+  p.rubyforge_name = RUBYFORGE_PROJECT if RUBYFORGE_PROJECT
+  p.test_globs = ["test/**/test_*.rb"]
+  p.clean_globs |= ['**/.*.sw?', '*.gem', '.config', '**/.DS_Store']  #An array of file patterns to delete on clean.
+  
+  # == Optional
+  p.changes = p.paragraphs_of("History.txt", 0..1).join("\n\n")
+#  p.extra_deps = []     # An array of rubygem dependencies [name, version], e.g. [ ['active_support', '>= 1.3.1'] ]
+  
+  #p.spec_extras = {}    # A hash of extra values to set in the gemspec.
+  
+end
+
+CHANGES = hoe.paragraphs_of('History.txt', 0..1).join("\\n\\n")
+PATH    = (RUBYFORGE_PROJECT == GEM_NAME) ? RUBYFORGE_PROJECT : "#{RUBYFORGE_PROJECT}/#{GEM_NAME}"
+hoe.remote_rdoc_dir = File.join(PATH.gsub(/^#{RUBYFORGE_PROJECT}\/?/,''), 'rdoc')
+hoe.rsync_args = '-av --delete --ignore-errors'

data/config/requirements.rb

@@ -0,0 +1,17 @@
+require 'fileutils'
+include FileUtils
+
+require 'rubygems'
+%w[rake hoe newgem rubigen].each do |req_gem|
+  begin
+    require req_gem
+  rescue LoadError
+    puts "This Rakefile requires the '#{req_gem}' RubyGem."
+    puts "Installation: gem install #{req_gem} -y"
+    exit
+  end
+end
+
+$:.unshift(File.join(File.dirname(__FILE__), %w[.. lib]))
+
+require 'guff'

data/lib/guff.rb

@@ -1,2 +1,8 @@
-require 'fileutils'
-require 'guff/java_source'
+$:.unshift File.dirname(__FILE__)
+
+require 'fileutils'
+require 'guff/java_source'
+
+module Guff
+  
+end

data/lib/guff/java_source.rb

@@ -36,27 +36,65 @@ module Guff
             end
         end
 
+
+        module ClassMember
+            def import(i)
+                @owning_class.import(i)
+            end
+        end
+
         module AnnotationSupport
-            def add_annotation(type,value=nil)
-                annotation = Annotation.new(type,value)
-                @annotations << annotation
+            def add_annotation(type, value=nil)
+                annotation = Annotation.new(type, value)
+                annotations << annotation
                 yield annotation if block_given?
                 self
             end
 
+            def annotations
+                @annotations ||= []
+            end
+
             def write_annotations_to(writer)
-                @annotations.each {|a|
+                annotations.each {|a|
                     a.write_to(writer)
                     writer.new_line
                 }
             end
         end
 
+        module Named
+            def named?(query)
+                @name == query
+            end
+
+            def name
+                @name
+            end
+        end
+
         module ParameterSupport
             def takes(name, type)
-                @parameters << Parameter.new(name, type)
+                parameters << Parameter.new(name, type)
                 self
             end
+
+            def taking(name,type)
+                takes(name,type)
+            end
+
+            def parameters_list
+                result = []
+                parameters.each {|p|
+                    result << p.as_source
+                }
+                result.join(',')
+            end
+            
+
+            def parameters
+                @parameters ||= []
+            end
         end
 
         module ScopeSupport
@@ -83,19 +121,62 @@ module Guff
 
         module ModifierSupport
             def static
-                @modifiers << 'static'
+                modifiers << 'static'
                 self
             end
 
             def final
-                @modifiers << 'final'
+                modifiers << 'final'
                 self
             end
 
             def abstract
-                @modifiers << 'abstract'
+                modifiers << 'abstract'
                 self
             end
+
+            def modifiers
+                @modifiers ||= []
+            end
+        end
+
+        module JavadocSupport
+            def add_javadoc(d)
+                javadoc_lines << d
+                self
+            end
+
+            def write_javadoc_to(writer)
+                if (!javadoc_lines.empty?)
+                    writer.line("/**")
+                    javadoc_lines.each do |line|
+                        writer.line("  * #{line}")
+                    end
+                    writer.line("  */")
+                end
+            end
+
+
+            def javadoc_lines
+                @javadoc_lines ||= []
+            end
+        end
+
+        module ThrowsSupport
+            def throws(exception)
+                exceptions << exception
+                self
+            end
+
+            def append_throws_clause(writer)
+                if (!exceptions.empty?)
+                    writer.append(' throws ').append(exceptions.join(', '))
+                end
+            end
+
+            def exceptions
+                @exceptions ||= []
+            end
         end
 
         class UnnamedProperty
@@ -127,7 +208,7 @@ module Guff
         end
 
         class Annotation
-            def initialize(type,value=nil)
+            def initialize(type, value=nil)
                 @type = type
                 @properties = []
                 @properties << UnnamedProperty.new(value) unless value.nil?
@@ -173,13 +254,12 @@ module Guff
         end
 
         class Constructor
-            include ArgumentsHelper, ParameterSupport, AnnotationSupport
+            include ArgumentsHelper, ParameterSupport, AnnotationSupport, JavadocSupport, ThrowsSupport, ClassMember
 
-            def initialize(name)
+            def initialize(owning_class,name)
+                @owning_class=owning_class
                 @name = name
-                @parameters = []
                 @body = Body.default_body
-                @annotations = []
             end
 
             def body
@@ -188,23 +268,40 @@ module Guff
                 self
             end
 
-            def parameters
-                result = []
-                @parameters.each {|p|
-                    result << p.as_source
+            def for_field(field_name)
+                add_takes_clause_for_field(field_name)
+                body {|body|
+                    add_assignment_for_field_name(body,field_name)
                 }
-                result.join(',')
+            end
+
+            def for_fields(*field_names)
+                field_names.each {|field_name| add_takes_clause_for_field(field_name)}
+                body {|body|
+                    field_names.each {|field_name| add_assignment_for_field_name(body,field_name)}
+                }
+            end
+
+            def add_assignment_for_field_name(body,field_name)
+                body.line("this.#{field_name}=#{field_name};")
+            end
+
+            def add_takes_clause_for_field(field_name)
+                field=@owning_class.get_field_named(field_name)
+                takes(field.name, field.declared_type)
             end
 
             def write_to(writer)
                 writer.ensure_member_separation_line
+                write_javadoc_to(writer)
                 write_annotations_to(writer)
                 write_declaration(writer)
+                append_throws_clause(writer)
                 @body.write_to(writer) unless @body.nil?
             end
 
             def write_declaration(writer)
-                writer.append("public #{@name}(" ).append(parameters).append(")")
+                writer.append("public #{@name}(" ).append(parameters_list).append(")")
             end
         end
 
@@ -284,10 +381,10 @@ module Guff
         class Method < Constructor
             include ScopeSupport, ModifierSupport, AnnotationSupport
 
-            def initialize(name)
-                super(name)
+            def initialize(owning_class,name)
+                super(owning_class,name)
                 @return_type = 'void'
-                @modifiers = []
+                @exceptions = []
                 @scope = 'public'
             end
 
@@ -296,6 +393,11 @@ module Guff
                 self
             end
 
+            def throws(e)
+                @exceptions << e
+                self
+            end
+
             def returns_list_of(t)
                 @return_type= "List<#{t}>"
                 self
@@ -305,35 +407,41 @@ module Guff
                 @return_type
             end
 
+
             def write_declaration(writer)
-                writer.word(@scope).words(@modifiers).word(@return_type).word("#{@name}(").append(parameters).append(")")
+                writer.word(@scope).words(modifiers).word(@return_type).word("#{@name}(").append(parameters_list).append(")")
             end
+
         end
 
         class Field
-            include ScopeSupport, ModifierSupport, AnnotationSupport
-            def initialize(name, type)
+            include ScopeSupport, ModifierSupport, AnnotationSupport, JavadocSupport, ClassMember, Named
+            def initialize(owning_class,name, type)
+                @owning_class=owning_class
                 @name = name
                 @type = type
                 @scope = 'private'
-                @modifiers = []
                 @initializer = ''
-                @annotations = []
             end
 
             def write_to(writer)
+                write_javadoc_to(writer)
                 write_annotations_to(writer)
-                writer.word(@scope).words(@modifiers).word(@type).word(@name).word(@initializer).semi_colon.new_line
+                writer.word(@scope).words(modifiers).word(@type).word(@name).word(@initializer).semi_colon.new_line
             end
 
             def initial(i)
                 @initializer = "= #{i}"
                 self
             end
+
+            def declared_type
+                @type
+            end
         end
 
         class Class
-            include ScopeSupport, ModifierSupport, AnnotationSupport
+            include ScopeSupport, ModifierSupport, AnnotationSupport, JavadocSupport
 
             def initialize(name, package, source_file)
                 @name = name;
@@ -346,16 +454,25 @@ module Guff
                 @source_file=source_file
                 @genericized_using = ''
                 @interfaces = nil
-                @annotations = []
                 @implements = nil
             end
 
             def add_field(name, type)
-                f = Field.new(name, type)
+                f = Field.new(self,name, type)
                 @fields << f
                 f
             end
 
+            def get_field_named(name)
+                candidates = @fields.select {|field| field.named?(name)}
+                return candidates.size == 1 ? candidates.first : nil;
+            end
+
+            def import(i)
+                @source_file.import(i)
+                self
+            end
+
             def genericized_using(g)
                 @genericized_using = g
                 self
@@ -380,20 +497,21 @@ module Guff
             end
 
             def add_method(name)
-                result = Method.new(name)
+                result = Method.new(self,name)
                 @instance_methods << result
                 result
             end
 
             def add_constructor
-                result = Constructor.new(@name)
+                result = Constructor.new(self,@name)
                 @constructors << result
                 result
             end
 
             def write_to(writer)
+                write_javadoc_to(writer)
                 write_annotations_to(writer)
-                writer.words(@modifiers).word("class").word(@name).append(@genericized_using).word_with_prefix('extends', @extends).list_with_prefix('implements', @implements).open_brace
+                writer.words(modifiers).word("class").word(@name).append(@genericized_using).word_with_prefix('extends', @extends).list_with_prefix('implements', @implements).open_brace
 
                 @fields.each {|f|
                     f.write_to(writer)
@@ -412,12 +530,13 @@ module Guff
             def initialize
                 @package = 'set the package'
                 @classes = []
+                @imports = []
             end
 
             def save_in(root)
                 writer = Printer.new
                 write_to(writer)
-                directory = root << "/" + package_as_directory
+                directory = "#{root}/#{package_as_directory}"
                 if (!FileTest.exist?(directory))
                     FileUtils.mkdir_p(directory)
                 end
@@ -428,6 +547,13 @@ module Guff
                 filename
             end
 
+            def import(i)
+                if (!@imports.include?(i))
+                    @imports << i
+                end
+                self
+            end
+
             def package_as_directory
                 @package.split('.').join('/')
             end
@@ -447,6 +573,12 @@ module Guff
 
             def write_to(writer)
                 writer.line(package_def).line
+                @imports.each do |import|
+                    writer.line("import #{import};")
+                end
+                if (!@imports.empty?)
+                    writer.line
+                end
                 @classes.each {|c|
                     c.write_to(writer)
                 }