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

Author

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

Content

...	...	@@ -1,67 +1,100 @@
1		-{{tip title="Now with more Git"}}
	1	+== Introduction ==
2	2
3		-As of March 25th, 2011 the Wonder source code is now maintained on [GitHub|https://github.com/] at [https://github.com/projectwonder]. You'll need to be familiar with the [Git|http://git-scm.com/] Source Code Management system. [Here's|WO:Getting Started with Git] a good place to start. You will use Git to checkout a local copy of the repository (a "clone" in Git terms) allowing you to have direct access to the Wonder source.
	3	+Instead of downloading the Wonder binaries, working from the latest source code directly can have some advantages such as:
4	4
5		-{{/tip}}
	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
	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
6	6
7		-== Why? ==
	12	+== Source Frameworks Initial Installation ==
8	8
9		-Instead of constantly re-downloading and installing the latest Wonder binaries you should work directly with the latest source code. It has several advantages including:
	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.
10	10
11		-* You'll learn a lot about WebObjects, EOF and Object-Oriented Patterns
12		-* Easily search, browse and even modify and improve Wonder
13		-* Work with a specific revision, which is key for teams, quality control and development cycles
14		-* Add logging statements in Wonder source so you can better understand what is going when tracking down hard to find bugs
15		-* Discover the many Hidden Treasures of Wonder.
	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.
16	16
17		-== Downloading ==
	18	+{{code title="Cloning Project Wonder for the First Time"}}
18	18
19		-Open a terminal and navigate to a directory where you want to maintain a source "working copy" and just use the following commands to clone Wonder source to your computer.
	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
20	20
21		-1. h5. Clone the source repository from GitHub into a new directory named "WonderSource" or whatever you'd like.
	24	+# Navigate into the working copy root
	25	+cd WonderSource
22	22
23		-{{note title="Read Only"}}
24		-Note the URL shown here is the public read-only URL. Committers should use the SSH form of the URL for read-write
25		-{{/note}}
	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.
26	26
27		-{{code value="none"}}
28		-git clone git://github.com/projectwonder/wonder.git WonderSource
	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
	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	+
29	29	{{/code}}
30	30
31		-You should see output something like this:
	40	+== Source Frameworks Upgrade Installation ==
32	32
33		-{{noformat}}
	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	34
35		-Cloning into WonderSource...
36		-remote: Counting objects: 174269, done.
37		-remote: Compressing objects: 100% (57304/57304), done.
38		-remote: Total 174269 (delta 107374), reused 173934 (delta 107067)
39		-Receiving objects: 100% (174269/174269), 137.94 MiB | 8.29 MiB/s, done.
40		-Resolving deltas: 100% (107374/107374), done.
	44	+{{code title="Updating your Source"}}
41	41
42		-{{/noformat}}
	46	+# Navigate to the Roots directory that was automatically created by the initial Source installation procedure above
	47	+cd ~/Roots/
43	43
44		-1. h5. Navigate into the working copy root
	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
45	45
46		-{{code value="none"}}
47		-cd WonderSource
	52	+# Navigate to the original Wonder source directory that you created above during initial source installation
	53	+cd /path/to/WonderSource
	54	+
	55	+# Pull the changes you do not have and merge them with your local repository
	56	+git pull
	57	+
	58	+# Clean, build and install the frameworks
	59	+ant clean; ant frameworks; sudo ant frameworks.install
	60	+
48	48	{{/code}}
49	49
50		-{{note title="WebObjects 5.3.3 Compatability"}}
51		-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		-You should get output like this:
53		-{noformat}
54		-Branch Wonder_5_0_0_Legacy set up to track remote branch Wonder_5_0_0_Legacy from origin.
55		-Switched to a new branch 'Wonder_5_0_0_Legacy'
56		-{noformat}
	63	+{{info value="Legacy WebObjects 5.3.3 Compatability"}}
57	57
58		-{{/note}}
	65	+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:
	66	+
	67	+{code}
	68	+git checkout --track origin/Wonder_5_0_0_Legacy
	69	+{code}
	70	+
59	59
60		-1. h5. Build and Install
61		-For building and installing the Wonder Frameworks, please see the standard [[Building and Installing WO Frameworks with Ant>>WO:Building and Installing a WO Framework with Ant]] pages.
	72	+{{/info}}
62	62
63	63	{{info}}
64	64
65		-If you have any trouble or errors due to your local repository getting corrupted, simply delete the entire local repository (the {{\~/Roots}} directory) and start over using this source clone procedure.
	76	+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.
66	66
67	67	{{/info}}
	79	+
	80	+{{info value="Custom Development Enviroment File layout using Custom wolips.properties"}}
	81	+
	82	+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.
	83	+
	84	+For example:
	85	+
	86	+{code}
	87	+$ cd my/special/purpose/clone/of/Wonder
	88	+$ ln -s ~/Library/Application\ Support/WOLips/wolips.custom.properties build.properties
	89	+{code}
	90	+
	91	+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.
	92	+
	93	+*Tip:* Specify a custom build directory for Wonder by adding the property 'wo.external.root' to the custom wolips properties file, for example
	94	+{code}
	95	+wo.external.root=/Users/mike/Developer/special/directory/Roots
	96	+{code}
	97	+
	98	+*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.
	99	+
	100	+{{/info}}