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,133 +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 value="none"}}
27		-git clone git://github.com/projectwonder/wonder.git WonderSource
	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
	27	+
	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	+
28	28	{{/code}}
29	29
30		-You should see output something like this:
	34	+{{code title="Procedure for WebObjects 5.3.X"}}
31	31
32		-{{noformat}}
	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
33	33
34		-Cloning into WonderSource...
35		-remote: Counting objects: 174269, done.
36		-remote: Compressing objects: 100% (57304/57304), done.
37		-remote: Total 174269 (delta 107374), reused 173934 (delta 107067)
38		-Receiving objects: 100% (174269/174269), 137.94 MiB | 8.29 MiB/s, done.
39		-Resolving deltas: 100% (107374/107374), done.
	40	+# Navigate into the working copy root
	41	+cd WonderSource
40	40
41		-{{/noformat}}
	43	+# Build the frameworks from the source (BTW, they get built into a directory named Roots in your home dir)
	44	+ant frameworks
42	42
43		-1. Navigate into the working copy root
	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
44	44
45		-{{code value="none"}}
46		-cd WonderSource
47	47	{{/code}}
48	48
49		-{{note title="WebObjects 5.3.3 Compatability"}}
50		-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}
	52	+== Source Frameworks Upgrade Installation ==
51	51
52		-{{/note}}
	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.
53	53
54		-== Building ==
	56	+{{code title="Procedure for WebObjects 5.4.X"}}
55	55
56		-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:
	58	+# Navigate to the Roots directory that was automatically created by the initial Source installation procedure above
	59	+cd ~/Roots/
57	57
58		-1. Build the frameworks from the "cloned" source.
	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
59	59
60		-{{code value="none"}}
61		-ant frameworks
62		-{{/code}}
	64	+# Navigate to the original Wonder source directory that you created above during initial source installation
	65	+cd /path/to/WonderSource
63	63
64		-1. Install the frameworks (this just copies the built frameworks from /Roots to the runtime Frameworks directory, usually at /Library/Frameworks)
	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
65	65
66		-{{code value="none"}}
67		-sudo ant frameworks.install
68		-{{/code}}
	71	+# Clean the previous build artifacts
	72	+ant -Dwonder.patch=54 clean
69	69
70		-== Installing and Upgrading ==
	74	+# Build from the latest source
	75	+ant -Dwonder.patch=54 frameworks
71	71
72		-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.
	77	+# Install the latest built frameworks
	78	+sudo ant -Dwonder.patch=54 frameworks.install
73	73
74		-1. Navigate to the Roots directory that was automatically created by the initial Source installation procedure above
75		-
76		-{{code value="none"}}
77		-cd ~/Roots/
78	78	{{/code}}
79	79
80		-1. Delete all installed frameworks whose names match the built frameworks in this Roots build folder
	82	+{{code title="Procedure for WebObjects 5.3.X"}}
81	81
82		-{{code value="none"}}
	84	+# Navigate to the Roots directory that was automatically created by the initial Source installation procedure above
	85	+cd ~/Roots/
	86	+
	87	+# Delete all installed frameworks whose names match the built frameworks in this Roots build folder
83	83	for FRAMEWORK in `echo *.framework`; do sudo rm -r /Library/Frameworks/${FRAMEWORK}; done
84		-{{/code}}
85	85
86		-1. Navigate to the original Wonder source directory that you created above during initial source installation
87		-
88		-{{code value="none"}}
	90	+# Navigate to the original Wonder source directory that you created above during initial source installation
89	89	cd /path/to/WonderSource
90		-{{/code}}
91	91
92		-1. Pull the changes you do not have and merge them with your local repository
	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
93	93
94		-{{code value="none"}}
95		-git pull
96		-{{/code}}
	97	+# Clean, build and install the frameworks
	98	+ant clean; ant frameworks; sudo ant frameworks.install
97	97
98		-1. Clean, build and install the frameworks
99	99
100		-{{code value="none"}}
101		-
102		-ant clean
103		-ant frameworks
104		-sudo ant frameworks.install
105		-
106	106	{{/code}}
107	107
108	108	{{info}}
109	109
110		-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.
111	111
112	112	{{/info}}
113	113
114	114	{{info value="Custom Development Enviroment File layout using Custom wolips.properties"}}
115	115
116		-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.
117	117
118	118	For example:
119	119
120		-{code:none}
121		-cd my/special/purpose/clone/of/Wonder
122		-ln -s ~/Library/Application\ Support/WOLips/wolips.custom.properties build.properties
123	123	{code}
	116	+$ cd my/special/purpose/working/copy/of/Wonder
	117	+$ ln -s ~/Library/Application\ Support/WOLips/wolips.custom.properties build.properties
	118	+{code}
124	124
125	125	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.
126	126
127		-*Tip:* Specify a custom build directory for Wonder by adding the property 'wo.external.root' to the custom wolips properties file, for example
128		-{code:none}
129		-wo.external.root=/Users/mike/Developer/special/directory/Roots
130		-{code}
131		-
132		-*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.
133		-
134	134	{{/info}}