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, Install and Upgrade
	1	+Download Wonder Source, Build and Install

Content

...	...	@@ -2,101 +2,108 @@
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		-* 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
	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
9	9	* Add logging statements in Wonder source so you can better understand what is going when tracking down hard to find bugs
10		-* Discover the many Hidden Treasures of Wonder
	9	+* Work with specific versions of Wonder in a project - good practice for quality control, especially for teams
11	11
12		-== Source Frameworks Initial Installation ==
	11	+== Source Frameworks Initial Installation Procedure ==
13	13
14		-As of March 25th, 2011, Wonder is maintained on github. So git is what we use to get a local clone of the repository allowing us to directly use Wonder source.
	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:
15	15
16		-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 own hard-drive.
	15	+{{code title="Procedure for WebObjects 5.4.X"}}
17	17
18		-{{code title="Cloning Project Wonder for the First Time"}}
	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	19
20		-# Clone the source repository from github into a new directory named "WonderSource".
21		-# Note the URL shown here is the public read-only URL. Committers should use the SSH form of the URL for read-write
22		-git clone git://github.com/projectwonder/wonder.git WonderSource
23		-
24	24	# Navigate into the working copy root
25	25	cd WonderSource
26	26
27		-# If you are still using old WebObjects 5.3.3, then you need to execute one git command at this point
28		-# before you build Wonder to switch to the branch that is source-compatible with WO 5.3.3. See the tip at the bottom of the page.
	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
29	29
30		-# Build the frameworks from the source (Assumes you are using WebObjects 5.4.3,
31		-# which is currently compatible with 'master' branch. See note below for WebObjects 5.3.3 compatible install)
32		-ant frameworks
	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
33	33
34		-# Install the frameworks (this just copies the built frameworks from ~/Roots to
35		-# the runtime Frameworks directory, usually at /Library/Frameworks)
36		-sudo ant frameworks.install
37		-
38	38	{{/code}}
39	39
40		-{{info value="Legacy WebObjects 5.3.3 Compatability"}}
	32	+{{code title="Procedure for WebObjects 5.3.X"}}
41	41
42		-If you are still stuck on WebObjects 5.3.3, for whatever reason, then you need to checkout and switch to the Wonder_5_0_0_Legacy branch *before* you build (before you run 'ant frameworks'). And this is *much* easier with git than it used to be with subversion. Just one command:
43		-
44		-{code}
45		-git checkout --track origin/Wonder_5_0_0_Legacy
46		-{code}
47		-
	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
48	48
49		-{{/info}}
	37	+# Navigate into the working copy root
	38	+cd WonderSource
50	50
	40	+# Build the frameworks from the source (BTW, they get built into a directory named Roots in your home dir)
	41	+ant frameworks
	42	+
	43	+# Install the frameworks (this just copies the built frameworks from ~/Roots to
	44	+# the runtime Frameworks directory, usually at /Library/Framrworks
	45	+sudo ant frameworks.install
	46	+
	47	+{{/code}}
	48	+
51	51	== Source Frameworks Upgrade Installation ==
52	52
53		-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.
	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	54
55		-{{code title="Updating your Source"}}
	53	+{{code title="Procedure for WebObjects 5.4.X"}}
56	56
57	57	# Navigate to the Roots directory that was automatically created by the initial Source installation procedure above
58	58	cd ~/Roots/
59	59
60	60	# Delete all installed frameworks whose names match the built frameworks in this Roots build folder
61		-for FRAMEWORK in `echo *.framework`; do sudo rm -r /Library/Frameworks/${FRAMEWORK}; done
	59	+$ for FRAMEWORK in `echo *.framework`; do sudo rm -r /Library/Frameworks/${FRAMEWORK}; done
62	62
63	63	# Navigate to the original Wonder source directory that you created above during initial source installation
64		-cd /path/to/WonderSource
	62	+$ cd /path/to/WonderSource
65	65
66		-# Pull the changes you do not have and merge them with your local repository
67		-git pull
	64	+# Update the source to the HEAD revision (aka latest). You can also use a specific svn
	65	+# repository version instead of the term 'HEAD', for example 11272
	66	+svn update --force --accept theirs-full --revision HEAD
68	68
69		-# Clean, build and install the frameworks
70		-ant clean; ant frameworks; sudo ant frameworks.install
	68	+# Clean the previous build artifacts
	69	+ant -Dwonder.patch=54 clean
71	71
	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	+
72	72	{{/code}}
73	73
74		-
	79	+{{code title="Procedure for WebObjects 5.3.X"}}
75	75
76		-{{info}}
	81	+# Navigate to the Roots directory that was automatically created by the initial Source installation procedure above
	82	+cd ~/Roots/
77	77
78		-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.
	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
79	79
80		-{{/info}}
	87	+# Navigate to the original Wonder source directory that you created above during initial source installation
	88	+$ cd /path/to/WonderSource
81	81
82		-{{info value="Custom Development Enviroment File layout using Custom wolips.properties"}}
	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
83	83
84		-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.
	94	+# Clean the previous build artifacts
	95	+ant clean
85	85
86		-For example:
	97	+# Build from the latest source
	98	+ant frameworks
87	87
88		-{code}
89		-$ cd my/special/purpose/clone/of/Wonder
90		-$ ln -s ~/Library/Application\ Support/WOLips/wolips.custom.properties build.properties
91		-{code}
	100	+# Install the latest built frameworks
	101	+sudo frameworks.install
92	92
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.
	103	+{{/code}}
94	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}
	105	+{{info}}
99	99
100		-*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.
	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.
101	101
102	102	{{/info}}