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		-Downloading, Building, Installing and Upgrading Wonder Source Code
	1	+Download Wonder Source, Build and Install

Author

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

Content

...	...	@@ -2,120 +2,121 @@
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 a lot about WebObjects and EOF (and Java development styles)
	5	+* Learn very much about WebObjects and EOF (and java dev styles?)
6	6	* Easily browse and search the source
7		-* Work with a specific source control version (teams, quality control, development cycles)
	7	+* Work with a specific svn version (teams, quality control, development cycles)
8	8	* Provide opportunities to submit patches for bug fixes or enhancements
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.
	10	+* Discover the many Hidden Treasures of Wonder
11	11
12		-== Downloading ==
	12	+== Source Frameworks Initial Installation ==
13	13
14		-{{tip title="Now with more Git"}}
15		-As of March 25th, 2011 the Wonder source code is now maintained on [GitHub|https://github.com/] at [https://github.com/projectwonder]. So you'll need to be familiar with the [Git|http://git-scm.com/] Source Code Management system. You will use it to checkout a local copy of the repository (a "clone" in Git terms) allowing you to have direct access to the Wonder source.
16		-{{/tip}}
	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 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:
17	17
18		-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.
	16	+{{code title="Procedure for WebObjects 5.4.X"}}
19	19
20		-1. Clone the source repository from github into a new directory named "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
21	21
22		-{{note title="Read Only"}}
23		-Note the URL shown here is the public read-only URL. Committers should use the SSH form of the URL for read-write
24		-{{/note}}
	22	+# Navigate into the working copy root
	23	+cd WonderSource
25	25
26		-{{code}}
27		-git clone git://github.com/projectwonder/wonder.git WonderSource
28		-{{/code}}
	25	+# Build the frameworks from the source (BTW, they get built into a directory named Roots in your home dir)
	26	+ant -Dwonder.patch=54 frameworks
29	29
30		-1. Navigate into the working copy root
	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 -Dwonder.patch=54 frameworks.install
31	31
32		-{{code}}
33		-cd WonderSource
34	34	{{/code}}
35	35
36		-{{note title="WebObjects 5.3.3 Compatability"}}
37		-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}git checkout --track origin/Wonder_5_0_0_Legacy{code}
	34	+{{code title="Procedure for WebObjects 5.3.X"}}
38	38
39		-{{/note}}
	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
40	40
41		-== Building ==
	40	+# Navigate into the working copy root
	41	+cd WonderSource
42	42
43		-Assuming you now have a "cloned" copy of the Wonder source code, you can build the frameworks to the default (##/Roots##) with the following command:
44		-
45		-1. Build the frameworks from the "cloned" source.
46		-
47		-{{code}}
	43	+# Build the frameworks from the source (BTW, they get built into a directory named Roots in your home dir)
48	48	ant frameworks
49		-{{/code}}
50	50
51		-1. Install the frameworks (this just copies the built frameworks from /Roots to the runtime Frameworks directory, usually at /Library/Frameworks)
52		-
53		-{{code}}
	46	+# Install the frameworks (this just copies the built frameworks from ~/Roots to
	47	+# the runtime Frameworks directory, usually at /Library/Frameworks)
54	54	sudo ant frameworks.install
	49	+
55	55	{{/code}}
56	56
57		-== Installing and Upgrading ==
	52	+== Source Frameworks Upgrade Installation ==
58	58
59		-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.
	54	+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.
60	60
61		-1. Navigate to the Roots directory that was automatically created by the initial Source installation procedure above
	56	+{{code title="Procedure for WebObjects 5.4.X"}}
62	62
63		-{{code}}
	58	+# Navigate to the Roots directory that was automatically created by the initial Source installation procedure above
64	64	cd ~/Roots/
65		-{{/code}}
66	66
67		-1. Delete all installed frameworks whose names match the built frameworks in this Roots build folder
68		-
69		-{{code}}
	61	+# Delete all installed frameworks whose names match the built frameworks in this Roots build folder
70	70	for FRAMEWORK in `echo *.framework`; do sudo rm -r /Library/Frameworks/${FRAMEWORK}; done
71		-{{/code}}
72	72
73		-1. Navigate to the original Wonder source directory that you created above during initial source installation
74		-
75		-{{code}}
	64	+# Navigate to the original Wonder source directory that you created above during initial source installation
76	76	cd /path/to/WonderSource
77		-{{/code}}
78	78
79		-1. Pull the changes you do not have and merge them with your local repository
	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
80	80
81		-{{code}}
82		-git pull
	71	+# Clean the previous build artifacts
	72	+ant -Dwonder.patch=54 clean
	73	+
	74	+# Build from the latest source
	75	+ant -Dwonder.patch=54 frameworks
	76	+
	77	+# Install the latest built frameworks
	78	+sudo ant -Dwonder.patch=54 frameworks.install
	79	+
83	83	{{/code}}
84	84
85		-1. Clean, build and install the frameworks
	82	+{{code title="Procedure for WebObjects 5.3.X"}}
86	86
87		-{{code}}
	84	+# Navigate to the Roots directory that was automatically created by the initial Source installation procedure above
	85	+cd ~/Roots/
88	88
89		-ant clean
90		-ant frameworks
91		-sudo ant frameworks.install
	87	+# Delete all installed frameworks whose names match the built frameworks in this Roots build folder
	88	+for FRAMEWORK in `echo *.framework`; do sudo rm -r /Library/Frameworks/${FRAMEWORK}; done
92	92
	90	+# Navigate to the original Wonder source directory that you created above during initial source installation
	91	+cd /path/to/WonderSource
	92	+
	93	+# Update the source to the HEAD revision (aka latest). You can also use a specific svn
	94	+# repository version instead of the term 'HEAD', for example 11272
	95	+svn update --force --accept theirs-full --revision HEAD
	96	+
	97	+# Clean, build and install the frameworks
	98	+ant clean; ant frameworks; sudo ant frameworks.install
	99	+
	100	+
93	93	{{/code}}
94	94
95	95	{{info}}
96	96
97		-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.
	105	+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.
98	98
99	99	{{/info}}
100	100
101	101	{{info value="Custom Development Enviroment File layout using Custom wolips.properties"}}
102	102
103		-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.
	111	+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.
104	104
105	105	For example:
106	106
107	107	{code}
108		-$ cd my/special/purpose/clone/of/Wonder
	116	+$ cd my/special/purpose/working/copy/of/Wonder
109	109	$ ln -s ~/Library/Application\ Support/WOLips/wolips.custom.properties build.properties
110	110	{code}
111	111
112	112	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.
113	113
114		-*Tip:* Specify a custom build directory for Wonder by adding the property 'wo.external.root' to the custom wolips properties file, for example
115		-{code}
116		-wo.external.root=/Users/mike/Developer/special/directory/Roots
117		-{code}
118		-
119		-*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.
120		-
121	121	{{/info}}