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

Author

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

Content

...	...	@@ -2,32 +2,100 @@
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 browse 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 a lot about WebObjects and EOF (and Java development styles)
	6	+* Easily browse and search the source
	7	+* Work with a specific source control 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
	10	+* Discover the many Hidden Treasures of Wonder.
9	9
10		-This documents my 'ideal' setup on my own system. I am sure there are variations. Wiki contributors may want to add other pages for what they consider other ideal Wonder setups
	12	+== Source Frameworks Initial Installation ==
11	11
12		-== Downloading Wonder Source from CVS ==
	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 get a local copy of the repository (a "clone" in Git terms) allowing us to have direct access to the Wonder source.
	16	+{{/tip}}
13	13
14		-* Decide on a directory where you will maintain the latest Wonder source tree on your hard drive. I have a directory ',,/WonderLatest' in my home folder.,,
15		-* Open a terminal shell and navigate to the directory
	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 own hard-drive.
16	16
17		-{{noformat}}
	20	+1. Clone the source repository from github into a new directory named "WonderSource".
	21	+1. Note the URL shown here is the public read-only URL. Committers should use the SSH form of the URL for read-write
18	18
19		-cd ~/WonderLatest
	23	+{{code}}
	24	+git clone git://github.com/projectwonder/wonder.git WonderSource
	25	+{{/code}}
20	20
21		-{{/noformat}}
	27	+1. Navigate into the working copy root
22	22
23		-* Next perform initial checkout of Wonder source tree from CVS head using the following command. This creates a folder named Wonder
	29	+{{code}}
	30	+cd WonderSource
	31	+{{/code}}
24	24
25		-{{noformat}}
	33	+{{note title="WebObjects 5.3.3 Compatability"}}
	34	+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}
26	26
27		-cvs -z3 -d:pserver:anonymous@wonder.cvs.sourceforge.net:/cvsroot/wonder co -P Wonder
	36	+{{/note}}
28	28
29		-{{/noformat}}
	38	+1. Build the frameworks from the source.
30	30
31		-== Build and Install Wonder ==
	40	+{{code}}
	41	+ant frameworks
	42	+{{/code}}
32	32
33		-(to be continued...)
	44	+1. Install the frameworks (this just copies the built frameworks from /Roots to the runtime Frameworks directory, usually at /Library/Frameworks)
	45	+
	46	+{{code}}
	47	+sudo ant frameworks.install
	48	+{{/code}}
	49	+
	50	+œ
	51	+
	52	+== Source Frameworks Upgrade Installation ==
	53	+
	54	+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.
	55	+
	56	+{{code title="Updating your Source"}}
	57	+
	58	+# Navigate to the Roots directory that was automatically created by the initial Source installation procedure above
	59	+cd ~/Roots/
	60	+
	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
	63	+
	64	+# Navigate to the original Wonder source directory that you created above during initial source installation
	65	+cd /path/to/WonderSource
	66	+
	67	+# Pull the changes you do not have and merge them with your local repository
	68	+git pull
	69	+
	70	+# Clean, build and install the frameworks
	71	+ant clean; ant frameworks; sudo ant frameworks.install
	72	+
	73	+{{/code}}
	74	+
	75	+{{info}}
	76	+
	77	+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.
	78	+
	79	+{{/info}}
	80	+
	81	+{{info value="Custom Development Enviroment File layout using Custom wolips.properties"}}
	82	+
	83	+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.
	84	+
	85	+For example:
	86	+
	87	+{code}
	88	+$ cd my/special/purpose/clone/of/Wonder
	89	+$ ln -s ~/Library/Application\ Support/WOLips/wolips.custom.properties build.properties
	90	+{code}
	91	+
	92	+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.
	93	+
	94	+*Tip:* Specify a custom build directory for Wonder by adding the property 'wo.external.root' to the custom wolips properties file, for example
	95	+{code}
	96	+wo.external.root=/Users/mike/Developer/special/directory/Roots
	97	+{code}
	98	+
	99	+*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.
	100	+
	101	+{{/info}}