Page History

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

Why?

Instead of constantly re-downloading and installing the latest Project Wonder binaries you should work directly with the latest source code. It has several advantages including:

• You'll learn a lot about WebObjects, EOF and Object-Oriented Patterns
• Easily search and browse Project Wonder
• Work with a specific revision of Project Wonder, which is key for teams, quality control and development cycles
• Add logging statements to Project Wonder so you can better understand what it is doing when tracking down hard to find bugs
• Discover the Many Hidden Treasures of Wonder™.

Download It!

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

   GitHub into a new directory named "WonderSource"

   .

   Note
   title 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

   or whatever you'd like.

   Code Block
   none none
   git clone git://github.com/projectwonderwocommunity/wonder.git WonderSource

   If "git://" does not work for you then use "http://"

   Note
   title Wonder Committers
   The URL above is the public, read-only URL. People with commit privileges for Project Wonder should use: git@github.com:wocommunity/wonder.git Warning Do not change "git@..." to be your username.

   You should see output something like this:

   No Format
   Cloning into WonderSource... remote: Counting objects: 174269, done. remote: Compressing objects: 100% (57304/57304), done. remote: Total 174269 (delta 107374), reused 173934 (delta 107067) Receiving objects: 100% (174269/174269), 137.94 MiB | 8.29 MiB/s, done. Resolving deltas: 100% (107374/107374), done.

2. Navigate into the working copy root

   Code Block
   none none
   cd WonderSource

   Note
   title 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 Block git checkout --track origin/Wonder_5_0_0_Legacy You should get output like this: No Format

...

1. Branch Wonder_5_0_0_Legacy set up to track remote branch Wonder_5_0_0_Legacy from origin. Switched to a new branch 'Wonder_5_0_0_Legacy'

Building

In general, it is recommended that you use Hudson/Jenkins to build your WebObjects frameworks and applications, but it is not required. You can build either from the Terminal as outlined below, or from within Eclipse directly.

[wocompile] /Wonder/WonderGit/WonderSource/Frameworks/Core/JavaWOExtensions/Sources/com/webobjects/woextensions/JSAlertPanel.java:10: 
     package com.webobjects.appserver does not exist
[wocompile] import com.webobjects.appserver.WOContext;

You can build the Wonder frameworks from the source code you just cloned to the default (~/Roots) directory with the following command:

Build the frameworks from the "cloned" source.

...

ant frameworks

Installing

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.

Install the frameworks

...

sudo ant frameworks.install

This copies the built frameworks from ~/Roots to the runtime Frameworks directory:

• Mac OS X: /Library/Framworks/
• Linux: /Local/Library/Frameworks

You can combine the build and install steps by simply executing this Ant command:

...

sudo ant frameworks frameworks.install

Upgrading

This will clean out the existing versions of the frameworks. This isn't strictly necessary, you could just re-install over the top of the old frameworks, but deleting then manually copying over the new ones will clean up any old frameworks that are no longer included in the standard build.

Navigate to the original Wonder source directory that you created above during initial source installation

...

cd /path/to/WonderSource

Pull the changes you do not have and merge them with your local repository

...

git pull

Build the frameworks.

...

ant frameworks

Navigate to the Roots directory that was automatically created by the initial Source installation procedure above

...

cd ~/Roots/

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

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:

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

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

wo.external.root=/Users/mike/Developer/special/directory/Roots

Use It!

• Use Wonder source code projects in your Eclipse workspace

  The best way to make use of Project Wonder is obviously to import the source code projects directly into your Eclipse workspace. Why would you be reading this page if that isn't what you are trying to do?! Detailed instructions are here: Working with Wonder source in Eclipse

  Note
  title Ant Builds on your Development Machine
  WOlips' "Incremental Builder" is an incredibly helpful feature during development, but it does things that the Ant deployment build does not do. If you are either using WOLips to build your WebObjects Applications (WOLips Ant Tools > Install) or are running Hudson/Jenkins locally to do it, you must also build and install your workspace's Frameworks that your Application depends upon – including your own, Project Wonder's and any others. The standard Ant build does NOT do this for you.

• Build and Install Project Wonder Binary Frameworks

  For building and installing the Wonder Frameworks, please see the standard Building and Installing WO Frameworks with Ant pages.

  Note
  title Using Both Binary and Source Code Frameworks on Your Development Machine
  If you have both Source Code projects and the built, Binary Frameworks installed, you need to make sure you build all source code frameworks that your project depends upon first. The standard Ant build does not do this for you. Ant builds only use binary frameworks so if the installed frameworks are not up to date your Ant build could fail, or worse, succeed but contain run-time errors.

• Build Project Wonder frameworks with Hudson/Jenkins

  The ideal way to build WebObjects frameworks and applications is to use a "Continuous Integration Server" or "Build Server" like Hudson or Jenkins. This allows you to automate the often complex process of building WebObjects projects that have several dependencies on frameworks. Instructions on how to setup a Hudson/Jenkins server is are available on the Installing and Configuring Jenkins page.