Skip to Content
Last modified by Bastian Triller on 2013/10/05 10:40
From version 99.1
edited by David Avendasora
on 2011/05/13 20:59
Change comment: There is no comment for this version
To version 115.1
edited by David Avendasora
on 2011/04/25 12:42
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 +Downloading, Building, Installing and Upgrading Wonder Source Code
Content
... ... @@ -1,87 +1,121 @@
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 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.
6 6  
7 -== Why? ==
12 +== Download Project Wonder Source Code ==
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 +{{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 checkout a local copy of the repository (a "clone" in Git terms) allowing you to have direct access to the Wonder source.
16 +{{/tip}}
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™.
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 computer.
16 16  
17 -== Download It ==
20 +1. Clone the source repository from github into a new directory named "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.
20 -
21 -1. h5. Clone the source repository from GitHub into a new directory named "WonderSource" or whatever you'd like.
22 -
23 23  {{note title="Read Only"}}
24 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 25  {{/note}}
26 26  
27 -{{code value="none"}}
26 +{{code}}
28 28  git clone git://github.com/projectwonder/wonder.git WonderSource
29 29  {{/code}}
30 30  
31 -You should see output something like this:
30 +1. Navigate into the working copy root
32 32  
33 -{{noformat}}
32 +{{code}}
33 +cd WonderSource
34 +{{/code}}
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.
36 +{{note title="WebObjects 5.3.3 Compatability"}}
37 +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}
41 41  
42 -{{/noformat}}
39 +{{/note}}
43 43  
44 -1. h5. Navigate into the working copy root
41 +== Build Frameworks ==
45 45  
46 -{{code value="none"}}
47 -cd WonderSource
43 +Assuming you now have a "cloned" copy of the Wonder source code, you can build the frameworks to the default (##/Roots##) with the following command:
44 +
45 +1. Build the frameworks from the "cloned" source.
46 +
47 +{{code}}
48 +ant frameworks
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}
51 +1. Install the frameworks (this just copies the built frameworks from /Roots to the runtime Frameworks directory, usually at /Library/Frameworks)
57 57  
58 -{{/note}}
53 +{{code}}
54 +sudo ant frameworks.install
55 +{{/code}}
59 59  
60 -{{info}}
57 +== Built Frameworks Upgrade Installation ==
61 61  
62 -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.
59 +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.
63 63  
64 -{{/info}}
61 +1. Navigate to the Roots directory that was automatically created by the initial Source installation procedure above
65 65  
66 -== Use It ==
63 +{{code}}
64 +cd ~/Roots/
65 +{{/code}}
67 67  
68 -* h5. Use Wonder source code projects in your Eclipse workspace
69 -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]]
67 +1. Delete all installed frameworks whose names match the built frameworks in this Roots build folder
70 70  
71 -{{note title="Ant Builds on your Development Machine"}}
69 +{{code}}
70 +for FRAMEWORK in `echo *.framework`; do sudo rm -r /Library/Frameworks/${FRAMEWORK}; done
71 +{{/code}}
72 72  
73 -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.*
73 +1. Navigate to the original Wonder source directory that you created above during initial source installation
74 74  
75 -{{/note}}
75 +{{code}}
76 +cd /path/to/WonderSource
77 +{{/code}}
76 76  
77 -* h5. Build and Install Project Wonder Binary Frameworks
78 -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.
79 +1. Pull the changes you do not have and merge them with your local repository
79 79  
80 -{{note title="Using Both Binary and Source Code Frameworks on Your Development Machine"}}
81 +{{code}}
82 +git pull
83 +{{/code}}
81 81  
82 -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.
85 +1. Clean, build and install the frameworks
83 83  
84 -{{/note}}
87 +{{code}}
85 85  
86 -* h5. Build Project Wonder frameworks with Hudson/Jenkins
87 -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 the Hudson build server]] page.
89 +ant clean
90 +ant frameworks
91 +sudo ant frameworks.install
92 +
93 +{{/code}}
94 +
95 +{{info}}
96 +
97 +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.
98 +
99 +{{/info}}
100 +
101 +{{info value="Custom Development Enviroment File layout using Custom wolips.properties"}}
102 +
103 +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.
104 +
105 +For example:
106 +
107 +{code}
108 +$ cd my/special/purpose/clone/of/Wonder
109 +$ ln -s ~/Library/Application\ Support/WOLips/wolips.custom.properties build.properties
110 +{code}
111 +
112 +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.
113 +
114 +*Tip:* Specify a custom build directory for Wonder by adding the property 'wo.external.root' to the custom wolips properties file, for example
115 +{code}
116 +wo.external.root=/Users/mike/Developer/special/directory/Roots
117 +{code}
118 +
119 +*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.
120 +
121 +{{/info}}