Changes for page Getting the Wonder Source Code

Summary

• Page properties (2 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

Content

...	...	@@ -2,30 +2,32 @@
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		-== Source Frameworks Initial Installation Procedure ==
	12	+== Source Frameworks Initial Installation ==
12	12
13		-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 the build and installation commands are slighly different for WebObjects 5.4.X. So procedures for both WebObjects 5.4.X and 5.3.X are shown below. Pick you poison:
	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.
14	14
15	15	{{code title="Procedure for WebObjects 5.4.X"}}
16	16
17	17	# Checkout the source from subversion repository into a new directory named "WonderSource"
18		-svn co http://wonder.svn.sourceforge.net/svnroot/wonder/trunk/Wonder --revision <ARG> 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	20	# Navigate into the working copy root
21	21	cd WonderSource
22	22
23	23	# Build the frameworks from the source (BTW, they get built into a directory named Roots in your home dir)
24		-ant -Dwonder.patch=54 frameworks
	26	+ant frameworks
25	25
26		-# Install the frameworks (this just copies the built frameworks from ~/Roots to
27		-# the runtime Frameworks directory, usually at /Library/Framrworks
28		-sudo ant -Dwonder.patch=54 frameworks.install
	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
29	29
30	30	{{/code}}
31	31
...	...	@@ -32,7 +32,8 @@
32	32	{{code title="Procedure for WebObjects 5.3.X"}}
33	33
34	34	# Checkout the source from subversion repository into a new directory named "WonderSource"
35		-svn co http://wonder.svn.sourceforge.net/svnroot/wonder/trunk/Wonder --revision <ARG> 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
36	36
37	37	# Navigate into the working copy root
38	38	cd WonderSource
...	...	@@ -40,8 +40,8 @@
40	40	# Build the frameworks from the source (BTW, they get built into a directory named Roots in your home dir)
41	41	ant frameworks
42	42
43		-# Install the frameworks (this just copies the built frameworks from ~/Roots to
44		-# the runtime Frameworks directory, usually at /Library/Framrworks
	46	+# Install the frameworks (this just copies the built frameworks from ~/Roots to
	47	+# the runtime Frameworks directory, usually at /Library/Frameworks)
45	45	sudo ant frameworks.install
46	46
47	47	{{/code}}
...	...	@@ -48,62 +48,52 @@
48	48
49	49	== Source Frameworks Upgrade Installation ==
50	50
51		-Assuming you already installed Wonder from source using the method outlined above, you can use the following procedure to upgrade to a newer, or just different version. Note that the procedure for both WebObjects 5.4.X and 5.3.X are outlined below. They are the same except for the last 3 ant commands.
	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).
52	52
53		-{{code title="Procedure for WebObjects 5.4.X"}}
	56	+{{code title="Procedure for WebObjects 5.3.X or 5.4.X"}}
54	54
55	55	# Navigate to the Roots directory that was automatically created by the initial Source installation procedure above
56	56	cd ~/Roots/
57	57
58	58	# Delete all installed frameworks whose names match the built frameworks in this Roots build folder
59		-$ for FRAMEWORK in `echo *.framework`; do sudo rm -r /Library/Frameworks/${FRAMEWORK}; done
	62	+for FRAMEWORK in `echo *.framework`; do sudo rm -r /Library/Frameworks/${FRAMEWORK}; done
60	60
61	61	# Navigate to the original Wonder source directory that you created above during initial source installation
62		-$ cd /path/to/WonderSource
	65	+cd /path/to/WonderSource
63	63
64		-# Update the source to the HEAD revision (aka latest). You can also use a specific svn
	67	+# Update the source to the HEAD revision (aka latest). You can also use a specific svn
65	65	# repository version instead of the term 'HEAD', for example 11272
66	66	svn update --force --accept theirs-full --revision HEAD
67	67
68		-# Clean the previous build artifacts
69		-ant -Dwonder.patch=54 clean
	71	+# Clean, build and install the frameworks
	72	+ant clean; ant frameworks; sudo ant frameworks.install
70	70
71		-# Build from the latest source
72		-ant -Dwonder.patch=54 frameworks
73		-
74		-# Install the latest built frameworks
75		-sudo ant -Dwonder.patch=54 frameworks.install
76		-
77	77	{{/code}}
78	78
79		-{{code title="Procedure for WebObjects 5.3.X"}}
	76	+{{info}}
80	80
81		-# Navigate to the Roots directory that was automatically created by the initial Source installation procedure above
82		-cd ~/Roots/
	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.
83	83
84		-# Delete all installed frameworks whose names match the built frameworks in this Roots build folder
85		-$ for FRAMEWORK in `echo *.framework`; do sudo rm -r /Library/Frameworks/${FRAMEWORK}; done
	80	+{{/info}}
86	86
87		-# Navigate to the original Wonder source directory that you created above during initial source installation
88		-$ cd /path/to/WonderSource
	82	+{{info value="Custom Development Enviroment File layout using Custom wolips.properties"}}
89	89
90		-# Update the source to the HEAD revision (aka latest). You can also use a specific svn
91		-# repository version instead of the term 'HEAD', for example 11272
92		-svn update --force --accept theirs-full --revision HEAD
	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.
93	93
94		-# Clean the previous build artifacts
95		-ant clean
	86	+For example:
96	96
97		-# Build from the latest source
98		-ant frameworks
	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}
99	99
100		-# Install the latest built frameworks
101		-sudo frameworks.install
	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.
102	102
103		-{{/code}}
	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}
104	104
105		-{{info}}
	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.
106	106
107		-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.
108		-
109	109	{{/info}}