Skip to Content
Last modified by Bastian Triller on 2013/10/05 10:40
From version 111.1
edited by David Avendasora
on 2011/06/16 18:24
Change comment: There is no comment for this version
To version 145.1
edited by Kieran Kelleher
on 2010/09/27 04:02
Change comment: There is no comment for this version

Summary

Details

Page properties
Title
... ... @@ -1,1 +1,1 @@
1 -Getting the Wonder Source Code
1 +Download Wonder Source, Build and Install
Author
... ... @@ -1,1 +1,1 @@
1 -XWiki.avendasora
1 +XWiki.kieran
Content
... ... @@ -1,93 +1,122 @@
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 Project Wonder binaries you should work directly with the latest source code. It has several advantages including:
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:
10 10  
11 -* You'll learn a lot about WebObjects, EOF and Object-Oriented Patterns
12 -* Easily search and browse Project Wonder
13 -* Work with a specific revision of Project Wonder, which is key for teams, quality control and development cycles
14 -* Add logging statements to Project Wonder so you can better understand what it is doing when tracking down hard to find bugs
15 -* Discover the Many Hidden Treasures of Wonder™.
16 +{{code title="Procedure for WebObjects 5.4.X"}}
16 16  
17 -== Download It ==
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
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.
22 +# Navigate into the working copy root
23 +cd WonderSource
20 20  
21 -1. h5. Clone the source repository from GitHub into a new directory named "WonderSource" or whatever you'd like.
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
22 22  
23 -{{code value="none"}}
24 -git clone git://github.com/projectwonder/wonder.git WonderSource
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 +
25 25  {{/code}}
26 26  
27 -If "git:~/~/" does not work for you then use "http:~/~/"
34 +{{code title="Procedure for WebObjects 5.3.X"}}
28 28  
29 -{{note title="Wonder Committers"}}
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
30 30  
31 -The URL above is the public, read-only URL.
32 -People with commit privileges for Project Wonder should use: *{{git@github.com:projectwonder/wonder.git}}*
33 -{warning}Do *not* change "git@..." to be your username.{warning}
40 +# Navigate into the working copy root
41 +cd WonderSource
34 34  
35 -{{/note}}
43 +# Build the frameworks from the source (BTW, they get built into a directory named Roots in your home dir)
44 +ant frameworks
36 36  
37 -You should see output something like this:
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
38 38  
39 -{{noformat}}
50 +{{/code}}
40 40  
41 -Cloning into WonderSource...
42 -remote: Counting objects: 174269, done.
43 -remote: Compressing objects: 100% (57304/57304), done.
44 -remote: Total 174269 (delta 107374), reused 173934 (delta 107067)
45 -Receiving objects: 100% (174269/174269), 137.94 MiB | 8.29 MiB/s, done.
46 -Resolving deltas: 100% (107374/107374), done.
52 +== Source Frameworks Upgrade Installation ==
47 47  
48 -{{/noformat}}
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.
49 49  
50 -1. h5. Navigate into the working copy root
56 +{{code title="Procedure for WebObjects 5.4.X"}}
51 51  
52 -{{code value="none"}}
53 -cd WonderSource
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 +# 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
70 +
71 +# Clean the previous build artifacts
72 +ant -Dwonder.patch=54 clean
73 +
74 +# Build from the latest source
75 +ant -Dwonder.patch=54 frameworks
76 +
77 +# Install the latest built frameworks
78 +sudo ant -Dwonder.patch=54 frameworks.install
79 +
54 54  {{/code}}
55 55  
56 -{{note title="WebObjects 5.3.3 Compatability"}}
57 -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}
58 -You should get output like this:
59 -{noformat}
60 -Branch Wonder_5_0_0_Legacy set up to track remote branch Wonder_5_0_0_Legacy from origin.
61 -Switched to a new branch 'Wonder_5_0_0_Legacy'
62 -{noformat}
82 +{{code title="Procedure for WebObjects 5.3.X"}}
63 63  
64 -{{/note}}
84 +# Navigate to the Roots directory that was automatically created by the initial Source installation procedure above
85 +cd ~/Roots/
65 65  
66 -{{info}}
87 +# Delete all installed frameworks whose names match the built frameworks in this Roots build folder
88 +for FRAMEWORK in `echo *.framework`; do sudo rm -r /Library/Frameworks/${FRAMEWORK}; done
67 67  
68 -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 the same clone command above.
90 +# Navigate to the original Wonder source directory that you created above during initial source installation
91 +cd /path/to/WonderSource
69 69  
70 -{{/info}}
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
71 71  
72 -== Use It ==
97 +# Clean, build and install the frameworks
98 +ant clean; ant frameworks; sudo ant frameworks.install
73 73  
74 -* h5. Use Wonder source code projects in your Eclipse workspace
75 -The best way to make use of Project Wonder is obviously to import the source code projects directly into your Eclipse workspace. Why would you be reading this page if that isn't what you are trying to do? Detailed instructions are here: [[WONDER:Working with Wonder source in Eclipse]]
76 76  
77 -{{note title="Ant Builds on your Development Machine"}}
101 +{{/code}}
78 78  
79 -WOlips' "Incremental Builder" is an incredibly helpful feature during development, but it does things that the Ant deployment build does not do. If you are *either* using WOLips to build your WebObjects Applications (_WOLips Ant Tools > Install_) *or* are [running Hudson/Jenkins|WO:Installing and Using the Hudson build server] locally to do it, you *must* also build and install your workspace's Frameworks that your Application depends upon -- including your own, Project Wonder's and any others. *The standard Ant build does* {color:#ff0000}{*}NOT{*}{color} *do this for you.*
103 +{{info}}
80 80  
81 -{{/note}}
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.
82 82  
83 -* h5. Build and Install Project Wonder Binary Frameworks
84 -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.
107 +{{/info}}
85 85  
86 -{{note title="Using Both Binary and Source Code Frameworks on Your Development Machine"}}
109 +{{info value="Custom Development Enviroment File layout using Custom wolips.properties"}}
87 87  
88 -If you have both Source Code projects and the built, Binary Frameworks installed, you need to make sure you build all source code frameworks that your project depends upon first. _The standard Ant build does not do this for you._ Ant builds only use binary frameworks so if the installed frameworks are not up to date your Ant build could fail, or worse, succeed but contain run-time errors.
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.
89 89  
90 -{{/note}}
113 +For example:
91 91  
92 -* h5. Build Project Wonder frameworks with Hudson/Jenkins
93 -The ideal way to build WebObjects frameworks and applications is to use a "Continuous Integration Server" or "Build Server" like Hudson or Jenkins. This allows you to automate the often complex process of building WebObjects projects that have several dependencies on frameworks. Instructions on how to setup a Hudson/Jenkins server is are available on the [[WO:Installing and Using Jenkins and Hudson Build Servers]] page.
115 +{code}
116 +$ cd my/special/purpose/working/copy/of/Wonder
117 +$ ln -s ~/Library/Application\ Support/WOLips/wolips.custom.properties build.properties
118 +{code}
119 +
120 +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.
121 +
122 +{{/info}}