Skip to Content
Last modified by Bastian Triller on 2013/10/05 10:40
From version 199.1
edited by Kieran Kelleher
on 2010/09/14 15:43
Change comment: There is no comment for this version
To version 232.1
edited by Pascal Robert
on 2013/10/05 10:40
Change comment: There is no comment for this version

Summary

Details

Page properties
Title
... ... @@ -1,1 +1,1 @@
1 -Download Wonder Source, Build and Install
1 +Getting the Wonder Source Code
Author
... ... @@ -1,1 +1,1 @@
1 -XWiki.kieran
1 +XWiki.probert
Content
... ... @@ -1,112 +1,103 @@
1 -== Introduction ==
1 +{{tip title="Now with more Git"}}
2 +As of May 21th, 2013 the Wonder source code is now maintained on [[GitHub>>url:https://github.com/||shape="rect"]] at [[https:~~/~~/github.com/wocommunity/wonder>>url:https://github.com/wocommunity/wonder||shape="rect"]]. You'll need to be familiar with the [[Git>>url:http://git-scm.com/||shape="rect"]] Source Code Management system. [[Here's>>doc: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 +{{/tip}}
2 2  
3 -Instead of downloading the Wonder binaries, working from the latest source code directly can have some advantages such as:
5 +== Why? ==
4 4  
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
7 +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:
11 11  
12 -== Source Frameworks Initial Installation ==
9 +* You'll learn a lot about WebObjects, EOF and Object-Oriented Patterns
10 +* Easily search and browse Project Wonder
11 +* Work with a specific revision of Project Wonder, which is key for teams, quality control and development cycles
12 +* Add logging statements to Project Wonder so you can better understand what it is doing when tracking down hard to find bugs
13 +* Discover the Many Hidden Treasures of Wonder™.
13 13  
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:
15 +== Download It! ==
15 15  
16 -{{code title="Procedure for WebObjects 5.4.X"}}
17 +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.
17 17  
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/trunk/Wonder --revision HEAD WonderSource
19 +1. (((
20 +===== Clone the source repository from GitHub into a new directory named "WonderSource" or whatever you'd like. =====
21 21  
22 -# Navigate into the working copy root
23 -cd WonderSource
24 -
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
27 -
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 -
22 +{{code 0="none"}}
23 +git clone git://github.com/wocommunity/wonder.git WonderSource
32 32  {{/code}}
33 33  
34 -{{code title="Procedure for WebObjects 5.3.X"}}
26 +If "git:~/~/" does not work for you then use "http:~/~/"
35 35  
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
28 +{{note title="Wonder Committers"}}
29 +The URL above is the public, read-only URL.
30 + People with commit privileges for Project Wonder should use: **git@github.com:wocommunity/wonder.git**
39 39  
40 -# Navigate into the working copy root
41 -cd WonderSource
32 +{{warning}}
33 +Do **not** change "git@..." to be your username.
34 +{{/warning}}
35 +{{/note}}
42 42  
43 -# Build the frameworks from the source (BTW, they get built into a directory named Roots in your home dir)
44 -ant frameworks
37 +You should see output something like this:
45 45  
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
39 +{{noformat}}
40 +Cloning into WonderSource...
41 +remote: Counting objects: 174269, done.
42 +remote: Compressing objects: 100% (57304/57304), done.
43 +remote: Total 174269 (delta 107374), reused 173934 (delta 107067)
44 +Receiving objects: 100% (174269/174269), 137.94 MiB | 8.29 MiB/s, done.
45 +Resolving deltas: 100% (107374/107374), done.
49 49  
47 +{{/noformat}}
48 +)))
49 +1. (((
50 +===== Navigate into the working copy root =====
51 +
52 +{{code 0="none"}}
53 +cd WonderSource
50 50  {{/code}}
51 51  
52 -== Source Frameworks Upgrade Installation ==
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:
53 53  
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.
55 -
56 -{{code title="Procedure for WebObjects 5.4.X"}}
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 -# 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 -
59 +{{code}}
60 +git checkout --track origin/Wonder_5_0_0_Legacy
80 80  {{/code}}
81 81  
82 -{{code title="Procedure for WebObjects 5.3.X"}}
63 +You should get output like this:
83 83  
84 -# Navigate to the Roots directory that was automatically created by the initial Source installation procedure above
85 -cd ~/Roots/
65 +{{noformat}}
66 +Branch Wonder_5_0_0_Legacy set up to track remote branch Wonder_5_0_0_Legacy from origin.
67 +Switched to a new branch 'Wonder_5_0_0_Legacy'
86 86  
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
69 +{{/noformat}}
70 +{{/note}}
71 +)))
89 89  
90 -# Navigate to the original Wonder source directory that you created above during initial source installation
91 -cd /path/to/WonderSource
73 +{{info}}
74 +If you have any trouble or errors due to your local repository getting corrupted, simply delete the entire local repository (the {{code language="none"}}WonderSource{{/code}} directory) and start over using the same clone command above.
75 +{{/info}}
92 92  
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
77 +== Use It! ==
96 96  
97 -# Clean the previous build artifacts
98 -ant clean
79 +* (((
80 +===== Use Wonder source code projects in your Eclipse workspace =====
99 99  
100 -# Build from the latest source
101 -ant frameworks
82 +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: [[doc:Working with Wonder source in Eclipse]]
102 102  
103 -# Install the latest built frameworks
104 -sudo frameworks.install
84 +{{note title="Ant Builds on your Development Machine"}}
85 +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 locally>>doc:documentation.Installing and Configuring Jenkins]] 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** (% style="color: rgb(255,0,0);" %)**NOT**(%%) **do this for you.**
86 +{{/note}}
87 +)))
105 105  
106 -{{/code}}
89 +* (((
90 +===== Build and Install Project Wonder Binary Frameworks =====
107 107  
108 -{{info}}
92 +For building and installing the Wonder Frameworks, please see the standard [[Building and Installing WO Frameworks with Ant>>doc:documentation.Building and Installing a Framework with Ant]] pages.
109 109  
110 -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.
94 +{{note title="Using Both Binary and Source Code Frameworks on Your Development Machine"}}
95 +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.
96 +{{/note}}
97 +)))
111 111  
112 -{{/info}}
99 +* (((
100 +===== Build Project Wonder frameworks with Hudson/Jenkins =====
101 +
102 +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 [[doc:documentation.Installing and Configuring Jenkins]] page.
103 +)))