Changes for page Getting the Wonder Source Code

Summary

• Page properties (3 modified, 0 added, 0 removed)

Details

Page properties

Title

...	...	@@ -1,1 +1,1 @@
1		-Download Wonder Source, Build and Install
	1	+Download Wonder Source, Build, Install and Upgrade

Author

...	...	@@ -1,1 +1,1 @@
1		-XWiki.tmk
	1	+XWiki.kieran

Content

...	...	@@ -2,51 +2,101 @@
2	2
3	3	Instead of downloading the Wonder binaries, working from the latest source code directly can have some advantages such as:
4	4
5		-* Ability to conveniently browse and search the source code and learn from the wisdom and experience of the WO committers
6		-* Put breakpoints in and step through Wonder source when debugging your projects
7		-* Provide opportunities to submit patches to bugs you might find in Wonder
	5	+* Learn very much about WebObjects and EOF (and java dev styles?)
	6	+* Easily browse and search the source
	7	+* Work with a specific svn version (teams, quality control, development cycles)
	8	+* Provide opportunities to submit patches for bug fixes or enhancements
8	8	* Add logging statements in Wonder source so you can better understand what is going when tracking down hard to find bugs
9		-* Work with specific versions of Wonder in a project - good practice for quality control, especially for teams
	10	+* Discover the many Hidden Treasures of Wonder
10	10
11		-== Downloading Wonder Source from Subversion ==
	12	+== Source Frameworks Initial Installation ==
12	12
13		-* Open a terminal shell and navigate to the directory where you want to maintain the WonderSource directory and decide on a name of the folder that will contain the Wonder source. For this example, we will use the name //WonderSource//
14		-* Perform initial checkout of Wonder source tree from Subversion head using the following command. This checks out the source into the directory //WonderSource//, automatically creating //WonderSource// if it does not exist.
	14	+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 download the Wonder source. Note that as of repository version 11387 (Sep 27, 2010) the Wonder repository URL is the only difference between the Wonder source procedure for WebObjects 5.3.3 and WebObjects 5.4.3 installation. For your copy/paste convenience, the full procedures for both WebObjects 5.4.X and 5.3.X are shown below. WebObjects 5.4.3 and the Wonder branch for same is recommended and is where the most features are expected to be found.
15	15
16		-{{noformat}}
	16	+{{code title="Procedure for WebObjects 5.4.X"}}
17	17
18		-svn co http://wonder.svn.sourceforge.net/svnroot/wonder/trunk/Wonder WonderSource
	18	+# Checkout the source from subversion repository into a new directory named "WonderSource"
	19	+# Note instead of HEAD, you can use a specific svn version number if you want
	20	+svn co http://wonder.svn.sourceforge.net/svnroot/wonder/branches/Wonder_5_0_0_WebObjects_5_4_Branch/Wonder --revision HEAD WonderSource
19	19
20		-{{/noformat}}
	22	+# Navigate into the working copy root
	23	+cd WonderSource
21	21
22		-* As often as you prefer you can keep this up to date as follows:
	25	+# Build the frameworks from the source (BTW, they get built into a directory named Roots in your home dir)
	26	+ant frameworks
23	23
24		-{{noformat}}
	28	+# Install the frameworks (this just copies the built frameworks from ~/Roots to
	29	+# the runtime Frameworks directory, usually at /Library/Frameworks)
	30	+sudo ant frameworks.install
25	25
	32	+{{/code}}
	33	+
	34	+{{code title="Procedure for WebObjects 5.3.X"}}
	35	+
	36	+# Checkout the source from subversion repository into a new directory named "WonderSource"
	37	+# Note instead of HEAD, you can use a specific svn version number if you want
	38	+svn co http://wonder.svn.sourceforge.net/svnroot/wonder/trunk/Wonder --revision HEAD WonderSource
	39	+
	40	+# Navigate into the working copy root
	41	+cd WonderSource
	42	+
	43	+# Build the frameworks from the source (BTW, they get built into a directory named Roots in your home dir)
	44	+ant frameworks
	45	+
	46	+# Install the frameworks (this just copies the built frameworks from ~/Roots to
	47	+# the runtime Frameworks directory, usually at /Library/Frameworks)
	48	+sudo ant frameworks.install
	49	+
	50	+{{/code}}
	51	+
	52	+== Source Frameworks Upgrade Installation ==
	53	+
	54	+Assuming you already installed Wonder from source using the method outlined above, and you are using the branch of Wonder appropriate to your WebObjects version, you can use the following procedure to upgrade to a newer, or just different version, as long as that version is greater than repository version 11387 (Sep 27, 2010, which was when the WO 5.4 branch was first introduced).
	55	+
	56	+{{code title="Procedure for WebObjects 5.3.X or 5.4.X"}}
	57	+
	58	+# Navigate to the Roots directory that was automatically created by the initial Source installation procedure above
	59	+cd ~/Roots/
	60	+
	61	+# Delete all installed frameworks whose names match the built frameworks in this Roots build folder
	62	+for FRAMEWORK in `echo *.framework`; do sudo rm -r /Library/Frameworks/${FRAMEWORK}; done
	63	+
	64	+# Navigate to the original Wonder source directory that you created above during initial source installation
26	26	cd /path/to/WonderSource
27		-svn up
28	28
29		-{{/noformat}}
	67	+# Update the source to the HEAD revision (aka latest). You can also use a specific svn
	68	+# repository version instead of the term 'HEAD', for example 11272
	69	+svn update --force --accept theirs-full --revision HEAD
30	30
31		-== Build and Install Wonder ==
	71	+# Clean, build and install the frameworks
	72	+ant clean; ant frameworks; sudo ant frameworks.install
32	32
33		-* Follow the "Building with Ant" instructions in the BUILD.txt document in the Wonder directory
	74	+{{/code}}
34	34
35		-{{warning title="WebObjects 5.4.X Compatability"}}
	76	+{{info}}
36	36
37		-The default instructions in Wonder's BUILD.txt produce binaries that are compatable with WO 5.3.3. If you are using WO 5.4.X, then you need to add the "-Dwonder.patch=54" option to the ant commands. For example:
	78	+If you have any trouble or errors due to your working copy getting hosed, then simply delete the entire working copy directory, the \~/Roots directory and just start over using the initial source installation procedure outlined above.
38	38
39		-ant \-Dwonder.patch=54 frameworks; sudo ant \-Dwonder.patch=54 frameworks.install
	80	+{{/info}}
40	40
41		-Alternatively, to avoid having to type the \-Dwonder.patch=54 option every time, one can create a build.properties file at the root of the Wonder directory that contains the following line : wonder.patch=54
	82	+{{info value="Custom Development Enviroment File layout using Custom wolips.properties"}}
42	42
43		-{{/warning}}
	84	+If you have a custom wolips properties file for a specific workspace and you want to have a specific Wonder source working copy 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.
44	44
45		-== Concepts ==
	86	+For example:
46	46
47		-This complete procedure results in you having
	88	+{code}
	89	+$ cd my/special/purpose/working/copy/of/Wonder
	90	+$ ln -s ~/Library/Application\ Support/WOLips/wolips.custom.properties build.properties
	91	+{code}
48	48
49		-* a Wonder directory with the whole Wonder source tree (directories, projects, frameworks, example apps, miscellaneous, etc.) inside.
50		-* The binary Wonder frameworks ("ant frameworks") will be installed in /Library/Frameworks.
51		-* If you ran "ant applications", they will be installed in ...
52		-* If you ran "ant examples", they will be installed in ...
	93	+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.
	94	+
	95	+*Tip:* Specify a custom build directory for Wonder by adding the property 'wo.external.root' to the custom wolips properties file, for example
	96	+{code}
	97	+wo.external.root=/Users/mike/Developer/special/directory/Roots
	98	+{code}
	99	+
	100	+*Tip:* A custom WebServer install directory can be specified to Wonder by adding the property 'wo.server.root' to the custom wilips properties file also.
	101	+
	102	+{{/info}}