Skip to Content
Version 128.1 by David Avendasora on 2011/04/25 15:18
Show last authors
1 {{toc maxLevel="2"}}{{/toc}}
2
3 == Introduction ==
4
5 Instead of downloading the Wonder binaries, working from the latest source code directly can have some advantages such as:
6
7 * Learn a lot about WebObjects and EOF (and Java development styles)
8 * Easily browse and search the source
9 * Work with a specific source control version (teams, quality control, development cycles)
10 * Provide opportunities to submit patches for bug fixes or enhancements
11 * Add logging statements in Wonder source so you can better understand what is going when tracking down hard to find bugs
12 * Discover the many Hidden Treasures of Wonder.
13
14 == Downloading ==
15
16 {{tip title="Now with more Git"}}
17 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.
18 {{/tip}}
19
20 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.
21
22 1. h5. Clone the source repository from github into a new directory named "WonderSource".
23
24 {{note title="Read Only"}}
25 Note the URL shown here is the public read-only URL. Committers should use the SSH form of the URL for read-write
26 {{/note}}
27
28 {{code value="none"}}
29 git clone git://github.com/projectwonder/wonder.git WonderSource
30 {{/code}}
31
32 You should see output something like this:
33
34 {{noformat}}
35
36 Cloning into WonderSource...
37 remote: Counting objects: 174269, done.
38 remote: Compressing objects: 100% (57304/57304), done.
39 remote: Total 174269 (delta 107374), reused 173934 (delta 107067)
40 Receiving objects: 100% (174269/174269), 137.94 MiB | 8.29 MiB/s, done.
41 Resolving deltas: 100% (107374/107374), done.
42
43 {{/noformat}}
44
45 1. h5. Navigate into the working copy root
46
47 {{code value="none"}}
48 cd WonderSource
49 {{/code}}
50
51 {{note title="WebObjects 5.3.3 Compatability"}}
52 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}
53 You should get output like this:
54 {noformat}
55 Branch Wonder_5_0_0_Legacy set up to track remote branch Wonder_5_0_0_Legacy from origin.
56 Switched to a new branch 'Wonder_5_0_0_Legacy'
57 {noformat}
58
59 {{/note}}
60
61 == Building ==
62
63 In general, it is recommended that you use Hudson/Jenkins to build your WebObjects frameworks and applications, but it is not required. You can build either from the Terminal as outlined below, or from within Eclipse directly.
64
65 {{tip title="Pro Tip"}}
66 If you use Hudson/Jenkins to build your WebObjects applications, then you do not need to actually build or install the Project Wonder frameworks on your development machine, just having the individual Wonder source code projects open in your eclipse workspace is sufficient. Your Hudson/Jenkins server will need the built frameworks installed. See the [Hudson/Jenkins Page|WO:Installing and Using the Hudson build server] for more information.
67 {{/tip}}
68
69 {{note title="Requires WebObjects"}}
70
71 These build instructions require the WebObjects frameworks to already be installed in the normal location:
72 * Mac OS X: {{/System/Library/Framworks/}}
73 * Linux: {{/Library/Frameworks}}
74
75 Otherwise you will get compiler errors like this:
76 {noformat}
77 [wocompile] /Wonder/WonderGit/WonderSource/Frameworks/Core/JavaWOExtensions/Sources/com/webobjects/woextensions/JSAlertPanel.java:10:
78 package com.webobjects.appserver does not exist
79 [wocompile] import com.webobjects.appserver.WOContext;
80 {noformat}
81
82 {{/note}}
83
84 You can build the Wonder frameworks from the source code you just cloned to the default (##/Roots##) directory with the following command:
85
86 ===== Build the frameworks from the "cloned" source. =====
87
88 {{code value="none"}}
89 ant frameworks
90 {{/code}}
91
92 == Installing ==
93
94 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.
95
96 ===== Install the frameworks =====
97
98 {{code value="none"}}
99 sudo ant frameworks.install
100 {{/code}}
101
102 This copies the built frameworks from ##/Roots## to the runtime Frameworks directory:
103
104 * Mac OS X: ##/Library/Framworks/##
105 * Linux: ##/Local/Library/Frameworks##
106
107 You can combine the build and install steps by simply executing this Ant command:
108
109 {{code value="none"}}
110 sudo ant frameworks frameworks.install
111 {{/code}}
112
113 == Upgrading ==
114
115 This will clean out the existing versions of the frameworks. This isn't strictly necessary, you could just re-install over the top of the old frameworks, but deleting then manually copying over the new ones will clean up any old frameworks that are no longer included in the standard build.
116
117 1. h5. Navigate to the original Wonder source directory that you created above during initial source installation
118
119 {{code value="none"}}
120 cd /path/to/WonderSource
121 {{/code}}
122
123 1. h5. Pull the changes you do not have and merge them with your local repository
124
125 {{code value="none"}}
126 git pull
127 {{/code}}
128
129 1. h5. Build the frameworks.
130
131 {{code value="none"}}
132 ant frameworks
133 {{/code}}
134
135 1. h5. Navigate to the Roots directory that was automatically created by the initial Source installation procedure above
136
137 {{code value="none"}}
138 cd ~/Roots/
139 {{/code}}
140
141 1. h5. Delete all installed frameworks whose names match the built frameworks in this Roots build folder
142
143 {{code value="none"}}
144 for FRAMEWORK in `echo *.framework`; do sudo rm -r /Library/Frameworks/${FRAMEWORK}; done
145 {{/code}}
146
147 {{info}}
148
149 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.
150
151 {{/info}}
152
153 {{info value="Custom Development Enviroment File layout using Custom wolips.properties"}}
154
155 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.
156
157 For example:
158
159 {code:none}
160 cd my/special/purpose/clone/of/Wonder
161 ln -s ~/Library/Application\ Support/WOLips/wolips.custom.properties build.properties
162 {code}
163
164 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.
165
166 *Tip:* Specify a custom build directory for Wonder by adding the property 'wo.external.root' to the custom wolips properties file, for example
167 {code:none}
168 wo.external.root=/Users/mike/Developer/special/directory/Roots
169 {code}
170
171 *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.
172
173 {{/info}}