java_testing_guff 0.0.2

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/test_builders_generation.rb

@@ -0,0 +1,19 @@
+require File.dirname(__FILE__) + '/test_helper.rb'
+
+class TestBuildersGeneration < AbstractGuffTestCase
+
+    def test_can_generate_concrete_builder_selector
+
+        generator(JavaTestingGuff::RealBuilderGuffGenerator).generate_selector_foreach(['org.rubyforge.Customer','org.rubyforge.Address'])
+
+        assert expected('GeneratedBuilderSelector').same_as(generated('GeneratedBuilderSelector'))
+    end
+
+    def test_can_generate_jmock_builder_selector
+
+        generator(JavaTestingGuff::JMockGuffGenerator).generate_selector_foreach(['org.rubyforge.Customer','org.rubyforge.Address'])
+
+        assert expected('GeneratedJMockBuilderSelector').same_as(generated('GeneratedJMockBuilderSelector'))
+    end
+
+end

data/test/test_helper.rb

@@ -0,0 +1,91 @@
+require 'test/unit'
+
+class JavaFileForTests
+    def initialize(testcase,path)
+        @testcase = testcase
+        @path = path
+    end
+
+    def same_as(path)
+        me = File.new(@path,"r")
+        other_lines = read_lines(path)
+        line_count=0
+        me.each_line do |line|
+            @testcase.assert_equal(line, other_lines[line_count],"#{path}:#{line_count.to_s}")
+            line_count = line_count + 1
+        end
+        me.close
+        true
+    end
+
+    def read_lines(path)
+        result = []
+        f = File.new(path,"r")
+        f.each_line do |line|
+            result << line
+        end
+        f.close
+        result
+    end
+
+end
+
+class AbstractGuffTestCase < Test::Unit::TestCase
+    def test_default
+        
+    end
+    
+    def setup
+        FileUtils::rm_rf(generated_dir)
+    end
+
+    def expected_files_dir
+        relative_dir('/src/expected_files')
+    end
+
+    def generated_dir
+        relative_dir('/src/generated')
+    end
+
+    def generated_package
+        'org.rubyforge.generated'
+    end
+
+    def relative_dir(p)
+        File.dirname(__FILE__) + p
+    end
+    
+    def expected(class_name)
+        JavaFileForTests.new(self,expected_files_dir + "/" + generated_package.gsub(".","/") + "/" + class_name + ".java")
+    end
+
+    def generated(class_name)
+        generated_dir + "/" + generated_package.gsub(".","/") + "/" + class_name + ".java"
+    end
+
+    def generator(generator_type)
+        javadocBuilder = JavaDocBuilder.new
+        javadocBuilder.add_source_tree(JFile.new(relative_dir("/src/java")))
+
+        generator_type.new(javadocBuilder).save_in(generated_dir).use_package(generated_package)
+    end
+    
+
+end
+
+module JavaSourceTestHelper
+    def tmp_dir
+        '.'
+    end
+
+    def prepared_file_for_tests(name)
+        JavaFileForTests.new(self,File.dirname(__FILE__) + "/files/#{name}.java")
+    end
+
+    def assert_source_file_equals(source, expected)
+        file_path = source.save_in(tmp_dir)
+        assert expected.same_as(file_path)
+    end
+end
+
+require File.dirname(__FILE__) + '/../lib/java_testing_guff'

data/test/test_java_testing_guff.rb

@@ -0,0 +1,25 @@
+require File.dirname(__FILE__) + '/test_helper.rb'
+
+class TestJavaTestingGuff < AbstractGuffTestCase
+
+    def test_can_generate_concrete_builder
+
+        generator(JavaTestingGuff::RealBuilderGuffGenerator).generate_guff_foreach(['org.rubyforge.Customer'])
+
+        assert expected('GeneratedCustomerBuilder').same_as(generated('GeneratedCustomerBuilder'))
+    end
+
+    def test_can_generate_eazymock_builder
+
+        generator(JavaTestingGuff::EasyMockGuffGenerator).generate_guff_foreach(['org.rubyforge.Customer'])
+
+        assert expected('GeneratedCustomerMockBuilder').same_as(generated('GeneratedCustomerMockBuilder'))
+    end
+
+    def test_can_generate_jmock_builder
+
+        generator(JavaTestingGuff::JMockGuffGenerator).generate_guff_foreach(['org.rubyforge.Customer'])
+
+        assert expected('GeneratedCustomerJMockBuilder').same_as(generated('GeneratedCustomerJMockBuilder'))
+    end
+end

data/website/index.html

@@ -0,0 +1,294 @@
+<!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>
+      Generate Java test classes
+  </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>Generate Java test classes</h1>
+    <div id="version" class="clickable" onclick='document.location = "http://rubyforge.org/projects/java_testing_guff"; return false'>
+      <p>Get Version</p>
+      <a href="http://rubyforge.org/projects/java_testing_guff" class="numbers">0.0.1</a>
+    </div>
+    <h1>&#x2192; &#8216;java_testing_guff&#8217;</h1>
+
+
+	<h2>What</h2>
+
+
+	<p>java_testing_guff consists of a number of Ruby classes that generate Java classes that enable
+a fluent interface style specification of mock behaviours in tests.  It also generates fluent interfaces for setting
+up java objects in particular states.  For example:</p>
+
+
+	<p><pre class='syntax'>mock().customer().withId(10).notLoggedIn().expectingNewAddress().build()</pre>
+<pre class='syntax'>real().order().withId(2).withOrderLine(line).withCustomer(customer).build()</pre></p>
+
+
+	<p>It does this by parsing your production code and creating java classes that implement a sensible fluent interface.</p>
+
+
+	<p>Both JMock and EasyMock are supported.</p>
+
+
+	<p>The gem works only with JRuby.</p>
+
+
+	<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">java_testing_guff</span></pre></p>
+
+
+	<p>java_guff_builder makes use of the gem &#8216;guff&#8217; to generate nicely formatted java code.  &#8216;guff&#8217; will be installed as a dependent
+gem while installing java_guff_builder.</p>
+
+
+	<p>Also, QDox
+(currently qdox-1.7-20070527.154641-2.jar) is needed on the JRuby classpath, to parse your production java source
+files.  So make sure you download <a href="http://qdox.codehaus.org">QDox</a> and install it:</p>
+
+
+	<p><pre class='syntax'>cp qdox-1.7-20070527.154641-2.jar $JRUBY_HOME/lib</pre></p>
+
+
+	<h2>The basics</h2>
+
+
+	<p>To generate one of these fluent interfaces, write a jruby script that does the following:</p>
+
+
+	<ol>
+	<li>instantiates a QDox JavaDocBuilder</li>
+		<li>configures the builder with the path(s) that contain your production code</li>
+		<li>instantiate and configure a particular generator (EasyMock, JMock, Concrete object)</li>
+		<li>tell the generate to go to work on an array of class names</li>
+	</ol>
+
+
+	<p>Optionally bind the generated classes into a subclass of TestCase so the syntax flows naturally (see below).</p>
+
+
+	<h2>Demonstration of usage</h2>
+
+
+	<p>Lets say you have two production classes, Customer and Order, that you want to generate EasyMock builders and a &#8216;real&#8217;
+builder for.  And the source code for these classes sits in &#8216;src/java&#8217;.</p>
+
+
+	<p>All builders require a configured JavaDocBuilder.  JavaDocBuilder may seem like a weird name in terms of what we are
+trying to do here, but thats what QDox calls it, so pretend its called &#8216;ProductionCodeParser&#8217; :-)</p>
+
+
+	<p><pre class='syntax'>
+require 'rubygems'
+require 'java_testing_guff'
+
+javadocBuilder = JavaDocBuilder.new
+javadocBuilder.add_source_tree(JFile.new('src/java'))
+javadocBuilder.add_source_tree(JFile.new('maybe some other paths?'))
+</pre></p>
+
+
+	<p>No we go ahead and use the EasyMockGuffGenerator combined with that JavaDocBuilder:</p>
+
+
+	<p><pre class='syntax'>
+easyMockGuffGenerator=JavaTestingGuff::EasyMockGuffGenerator.new(javadocBuilder)
+                        .save_in('src/test')
+                        .use_package('org.rubyforge.generated.mockbuilders')
+
+easyMockGuffGenerator.generate_guff_foreach(['org.rubyforge.Customer','org.rubyforge.Order'])
+</pre></p>
+
+
+	<p>This will generate org.rubyforge.generated.mockbuilders.GeneratedCustomerMockBuilder.java
+and org.rubyforge.generated.mockbuilders.GeneratedOrderMockBuilder.java in the directory src/test.</p>
+
+
+	<p>The same kind of thing works for JMock and &#8220;real&#8221; builders:</p>
+
+
+	<p><pre class='syntax'>
+jMockGuffGenerator=JavaTestingGuff::JMockGuffGenerator.new(javadocBuilder)
+                        .save_in('src/test')
+                        .use_package('org.rubyforge.generated.mockbuilders')
+
+jMockGuffGenerator.generate_guff_foreach(['org.rubyforge.Customer','org.rubyforge.Order'])
+</pre></p>
+
+
+	<p><pre class='syntax'>
+realMockGuffGenerator=JavaTestingGuff::RealBuilderGuffGenerator.new(javadocBuilder)
+                        .save_in('src/test')
+                        .use_package('org.rubyforge.generated.realbuilders')
+
+realMockGuffGenerator.generate_guff_foreach(['org.rubyforge.Customer','org.rubyforge.Order'])
+</pre></p>
+
+
+	<p>One hint: if you want to use more than one generator on your project, use the same JavaDocBuilder instance,
+because it takes quite some time to build this class as it parses all your production code.</p>
+
+
+	<h3>A word about EasyMock and MockCreator</h3>
+
+
+	<p>EasyMock provides two ways of creating mock instances:</p>
+
+
+	<p><pre class='syntax'>Customer customer = EasyMock.createMock(Customer.class)</pre></p>
+
+
+	<p>and</p>
+
+
+	<p><pre class='syntax'>
+IMocksControl strictControl = EasyMock.createStrictControl();
+Customer customer = strictControl.createMock(Customer.class)
+</pre></p>
+
+
+	<p>Strict controls allow you to be explicit about ordering of method calls on mocks.  The generated classes support
+strict and nice (non-strick) mock construction as follows:</p>
+
+
+	<p><pre class='syntax'>
+Customer niceCustomer = new GeneratedCustomerMockBuilder(new NiceMockCreator()).build();
+
+IMocksControl strictControl = EasyMock.createStrictControl();
+Customer strictCustomer = new GeneratedCustomerMockBuilder(new StrictMockCreator(strictControl)).build();
+Customer anotherStrictCustomer = new GeneratedCustomerMockBuilder(new StrictMockCreator(strictControl)).build();
+</pre></p>
+
+
+	<h3>java_testing_guff Java classes</h3>
+
+
+	<p>Some of the generated code makes use of Java classes that are distributed as part of this gem.  You will find
+the jar (java_testing_guff-x.y.z.jar) in the lib of this gem.  You will need to include this jar on your classpath
+to use the generated classes.</p>
+
+
+	<h3>Integration of generated classes</h3>
+
+
+	<p>You can use the generated classes like this if you please:</p>
+
+
+	<p><pre class='syntax'>
+Customer customer = new GeneratedCustomerBuilder().withId(10).notLoggedIn().expectingNewAddress().build()
+</pre></p>
+
+
+	<p>But personally I find that increases the noise in a test, taking away from clarity of intent. So I prefer to integrate
+the generated classes into my own testing super class and provide more fluency:</p>
+
+
+	<p><pre class='syntax'>
+public class MyTestCase extends TestCase {
+    public RealBuilders real() {
+        return new RealBuilders();
+    }
+
+    public MockBuilders mock() {
+        return new MockBuilders(new NiceMockCreator());
+    }
+
+    public MockBuilders mock(IMocksControl control) {
+        return new MockBuilders(new StrictMockCreator(control));
+    }
+
+    public class RealBuilders {
+        public GeneratedCustomerBuilder customer() {
+            return new GeneratedCustomerBuilder();
+        }
+    }
+
+    public class MockBuilders {
+        private final MockCreator mockCreator;
+
+        public MockBuilders(MockCreator mockCreator) {
+            this.mockCreator = mockCreator;
+        }
+
+        public GeneratedCustomerMockBuilder customer() {
+            return new GeneratedCustomerMockBuilder(mockCreator);
+        }
+    }
+}
+</pre></p>
+
+
+	<p>and now anything that inherits from MyTestCase can do</p>
+
+
+	<p><pre class='syntax'>
+Customer customer = real().customer().withId(10).notLoggedIn().build();
+Customer mockCustomer = mock().customer().withId(10).notLoggedIn().expectingNewAddress().build();
+</pre></p>
+
+
+	<p>Suits me!</p>
+
+
+	<h2>Forum</h2>
+
+
+	<p><a href="http://groups.google.com/group/java-testing-guff">http://groups.google.com/group/java-testing-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 trunk repository is <code>svn://rubyforge.org/var/svn/jbuilder-guff</code> for anonymous access.</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 a suggestion/question to the <a href="http://groups.google.com/group/java-testing-guff">forum</a></p>
+    <p class="coda">
+      <a href="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>