Downloading, Building, Installing and Upgrading Wonder Source Code

Version 122.1 by David Avendasora on 2011/04/25 12:43

Introduction

Instead of downloading the Wonder binaries, working from the latest source code directly can have some advantages such as:

  • Learn a lot about WebObjects and EOF (and Java development styles)
  • Easily browse and search the source
  • Work with a specific source control version (teams, quality control, development cycles)
  • Provide opportunities to submit patches for bug fixes or enhancements
  • Add logging statements in Wonder source so you can better understand what is going when tracking down hard to find bugs
  • Discover the many Hidden Treasures of Wonder.

Downloading

Success

Now with more Git

As of March 25th, 2011 the Wonder source code is now maintained on [GitHub|https://github.com/] at [https://github.com/projectwonder]. So you'll need to be familiar with the [Git|http://git-scm.com/] Source Code Management system. You will use it to checkout a local copy of the repository (a "clone" in Git terms) allowing you to have direct access to the Wonder source.

Open a terminal and navigate to a directory where you want to maintain a source "working copy" and just use the following easy-peasy commands to clone Wonder source to your computer.

  1. Clone the source repository from github into a new directory named "WonderSource".
Warning

Read Only

Note the URL shown here is the public read-only URL. Committers should use the SSH form of the URL for read-write

git clone git://github.com/projectwonder/wonder.git WonderSource
  1. Navigate into the working copy root
cd WonderSource
Warning

WebObjects 5.3.3 Compatability

If you are still using old WebObjects 5.3.3, then you need to execute this git command to switch to the branch for WebObjects 5.3.3:{code}git checkout track origin/Wonder_5_0_0_Legacy{code}

Building

Assuming you now have a "cloned" copy of the Wonder source code, you can build the frameworks to the default (/Roots) with the following command:

  1. Build the frameworks from the "cloned" source.
ant frameworks
  1. Install the frameworks (this just copies the built frameworks from /Roots to the runtime Frameworks directory, usually at /Library/Frameworks)
sudo ant frameworks.install

Installing and Upgrading

Assuming you already cloned and installed Wonder from source using the method outlined above, you can use the following procedure pull the latest changes into your local repository.

  1. Navigate to the Roots directory that was automatically created by the initial Source installation procedure above
cd ~/Roots/
  1. Delete all installed frameworks whose names match the built frameworks in this Roots build folder
for FRAMEWORK in `echo *.framework`; do sudo rm -r /Library/Frameworks/${FRAMEWORK}; done
  1. Navigate to the original Wonder source directory that you created above during initial source installation
cd /path/to/WonderSource
  1. Pull the changes you do not have and merge them with your local repository
git pull
  1. Clean, build and install the frameworks

ant clean
ant frameworks
sudo ant frameworks.install
Information

If you have any trouble or errors due to your local repository getting hosed, then simply delete the entire local repository directory, the \/Roots directory and just start over using the initial source clone and installation procedure outlined above.

Information

If you have a custom wolips properties file for a specific workspace and you want to have a specific Wonder clone for that workspace, you can simply link your custom wolips properties file to a soft link named build.properties in the working copy root directory. The Wonder build script will supersede all other filesystem layout poperties with the properties in that file.

For example:

{code}
$ cd my/special/purpose/clone/of/Wonder
$ ln -s /Library/Application\ Support/WOLips/wolips.custom.properties build.properties
{code}

An example of where this approach might be used would be when you have different projects (perhaps in a specially designated workspace) that use a specific version of WebObjects and a specific version or branch of Wonder.

*Tip:* Specify a custom build directory for Wonder by adding the property 'wo.external.root' to the custom wolips properties file, for example
{code}
wo.external.root=/Users/mike/Developer/special/directory/Roots
{code}

*Tip:* A custom WebServer install directory can be specified to Wonder by adding the property 'wo.server.root' to the custom wolips properties file also.