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,99 +2,69 @@
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	+== Downloading Wonder Source from Subversion ==
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 the runtime Frameworks directory, usually at /Library/Framrworks
	27	+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		-== Source Frameworks Upgrade Installation ==
	31	+* 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//
	32	+* 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.
41	41
42		-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.
	34	+{{noformat}}
43	43
44		-{{code title="Updating your Source"}}
	36	+svn co http://wonder.svn.sourceforge.net/svnroot/wonder/trunk/Wonder WonderSource
45	45
46		-# Navigate to the Roots directory that was automatically created by the initial Source installation procedure above
47		-cd ~/Roots/
	38	+{{/noformat}}
48	48
49		-# Delete all installed frameworks whose names match the built frameworks in this Roots build folder
50		-for FRAMEWORK in `echo *.framework`; do sudo rm -r /Library/Frameworks/${FRAMEWORK}; done
	40	+* As often as you prefer you can keep this up to date as follows:
51	51
52		-# Navigate to the original Wonder source directory that you created above during initial source installation
	42	+{{noformat}}
	43	+
53	53	cd /path/to/WonderSource
	45	+svn up
54	54
55		-# Pull the changes you do not have and merge them with your local repository
56		-git pull
	47	+{{/noformat}}
57	57
58		-# Clean, build and install the frameworks
59		-ant clean; ant frameworks; sudo ant frameworks.install
	49	+== Build and Install Wonder ==
60	60
61		-{{/code}}
	51	+* Follow the "Building with Ant" instructions in the BUILD.txt document in the Wonder directory
62	62
63		-{{info}}
	53	+{{warning title="WebObjects 5.4.X Compatability"}}
64	64
65		-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.
	55	+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:
66	66
67		-{{/info}}
	57	+ant \-Dwonder.patch=54 frameworks; sudo ant \-Dwonder.patch=54 frameworks.install
68	68
69		-{{info value="Custom Development Enviroment File layout using Custom wolips.properties"}}
	59	+Alternatively, to avoid having to type the \-Dwonder.patch=54 option every time, one can put the line "wonder.patch=54" either in the wolips.properties file that resides in the \~/Library/Application Support/WOLips directory or in a build.properties file in the Wonder source root directory.
70	70
71		-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.
	61	+{{/warning}}
72	72
73		-For example:
	63	+== Concepts ==
74	74
75		-{code}
76		-$ cd my/special/purpose/clone/of/Wonder
77		-$ ln -s ~/Library/Application\ Support/WOLips/wolips.custom.properties build.properties
78		-{code}
	65	+This complete procedure results in you having
79	79
80		-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.
81		-
82		-*Tip:* Specify a custom build directory for Wonder by adding the property 'wo.external.root' to the custom wolips properties file, for example
83		-{code}
84		-wo.external.root=/Users/mike/Developer/special/directory/Roots
85		-{code}
86		-
87		-*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.
88		-
89		-{{/info}}
90		-
91		-{{info value="Legacy WebObjects 5.3.3 Compatability"}}
92		-
93		-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:
94		-
95		-{code}
96		-git checkout --track origin/Wonder_5_0_0_Legacy
97		-{code}
98		-
99		-
100		-{{/info}}
	67	+* a Wonder directory with the whole Wonder source tree (directories, projects, frameworks, example apps, miscellaneous, etc.) inside.
	68	+* The binary Wonder frameworks ("ant frameworks") will be installed in /Library/Frameworks.
	69	+* If you ran "ant applications", they will be installed in ...
	70	+* If you ran "ant examples", they will be installed in ...