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	+Getting the Wonder Source Code

Content

...	...	@@ -1,101 +1,67 @@
1		-== Introduction ==
	1	+{{tip title="Now with more Git"}}
2	2
3		-Instead of downloading the Wonder binaries, working from the latest source code directly can have some advantages such as:
	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.
4	4
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
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.
11		-
12		-== Source Frameworks Initial Installation ==
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 get a local copy of the repository (a "clone" in Git terms) allowing us to have direct access to the Wonder source.
16	16	{{/tip}}
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 own hard-drive.
	7	+== Why? ==
19	19
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
	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:
22	22
23		-{{code}}
24		-git clone git://github.com/projectwonder/wonder.git WonderSource
25		-{{/code}}
	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.
26	26
27		-1. Navigate into the working copy root
	17	+== Downloading ==
28	28
29		-{{code}}
30		-cd WonderSource
31		-{{/code}}
	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.
32	32
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}
	21	+1. h5. Clone the source repository from GitHub into a new directory named "WonderSource" or whatever you'd like.
35	35
	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
36	36	{{/note}}
37	37
38		-1. Build the frameworks from the source.
39		-
40		-{{code}}
41		-ant frameworks
	27	+{{code value="none"}}
	28	+git clone git://github.com/projectwonder/wonder.git WonderSource
42	42	{{/code}}
43	43
44		-1. Install the frameworks (this just copies the built frameworks from /Roots to the runtime Frameworks directory, usually at /Library/Frameworks)
	31	+You should see output something like this:
45	45
46		-{{code}}
47		-sudo ant frameworks.install
48		-{{/code}}
	33	+{{noformat}}
49	49
50		-œ
	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.
51	51
52		-== Source Frameworks Upgrade Installation ==
	42	+{{/noformat}}
53	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.
	44	+1. h5. Navigate into the working copy root
55	55
56		-{{code title="Updating your Source"}}
	46	+{{code value="none"}}
	47	+cd WonderSource
	48	+{{/code}}
57	57
58		-# Navigate to the Roots directory that was automatically created by the initial Source installation procedure above
59		-cd ~/Roots/
	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}
60	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
	58	+{{/note}}
63	63
64		-# Navigate to the original Wonder source directory that you created above during initial source installation
65		-cd /path/to/WonderSource
	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.
66	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	75	{{info}}
76	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.
	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.
78	78
79	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}}