Changes for page Getting the Wonder Source Code
Last modified by Bastian Triller on 2013/10/05 10:40
From version 191.1
edited by Kieran Kelleher
on 2010/09/13 14:58
on 2010/09/13 14:58
Change comment:
There is no comment for this version
To version 195.1
edited by Kieran Kelleher
on 2011/03/25 19:18
on 2011/03/25 19:18
Change comment:
There is no comment for this version
Summary
-
Page properties (2 modified, 0 added, 0 removed)
Details
- Page properties
-
- Title
-
... ... @@ -1,1 +1,1 @@ 1 -Download Wonder Source, Build andInstall1 +Download Wonder Source, Build, Install and Upgrade - Content
-
... ... @@ -2,69 +2,101 @@ 2 2 3 3 Instead of downloading the Wonder binaries, working from the latest source code directly can have some advantages such as: 4 4 5 -* Ability to conveniently browse and search the source code and learn from the wisdom and experience of the WO committers 6 -* Put breakpoints in and step through Wonder source when debugging your projects 7 -* Provide opportunities to submit patches to bugs you might find in Wonder 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 8 8 * Add logging statements in Wonder source so you can better understand what is going when tracking down hard to find bugs 9 -* Work withspecificversionsofWonderina project - good practice for quality control,especiallyforteams10 +* Discover the many Hidden Treasures of Wonder 10 10 11 -== Downloading WonderSourcefromSubversion ==12 +== Source Frameworks Initial Installation == 12 12 13 - Opena terminal and navigate to adirectorywhereyouwanttomaintaina source"workingcopy"and justusethefollowingeasy-peasycommandstodownloadthe Wondersource.Note that thebuildand installationcommandsareslighlydifferent for WebObjects5.4.X. So proceduresfor both WebObjects5.4.X and5.3.X are shown below.Pick you poison:14 +As of March 25th, 2011, Wonder is maintained on github. So git is what we use to get a local clone of the repository allowing us to directly use Wonder source. 14 14 15 - {{code title="Procedure forWebObjects5.4.X"}}16 +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. 16 16 17 -# Checkout the source from subversion repository into a new directory named "WonderSource" 18 -svn co http://wonder.svn.sourceforge.net/svnroot/wonder/trunk/Wonder --revision <ARG> WonderSource 18 +{{code title="Cloning Project Wonder for the First Time"}} 19 19 20 +# Clone the source repository from github into a new directory named "WonderSource". 21 +# Note the URL shown here is the public read-only URL. Committers should use the SSH form of the URL for read-write 22 +git clone git://github.com/projectwonder/wonder.git WonderSource 23 + 20 20 # Navigate into the working copy root 21 21 cd WonderSource 22 22 23 -# Buildtheframeworksfromthesource(BTW,theygetbuiltintoirectorynamedRoots inyour home dir)24 - ant-Dwonder.patch=54frameworks27 +# If you are still using old WebObjects 5.3.3, then you need to execute one git command at this point 28 +# before you build Wonder to switch to the branch that is source-compatible with WO 5.3.3. See the tip at the bottom of the page. 25 25 26 -# Install the frameworks (this just copies the built frameworks from ~/Roots to the runtime Frameworks directory, usually at /Library/Framrworks 27 -sudo ant -Dwonder.patch=54 frameworks.install 30 +# Build the frameworks from the source (Assumes you are using WebObjects 5.4.3, 31 +# which is currently compatible with 'master' branch. See note below for WebObjects 5.3.3 compatible install) 32 +ant frameworks 28 28 34 +# Install the frameworks (this just copies the built frameworks from ~/Roots to 35 +# the runtime Frameworks directory, usually at /Library/Frameworks) 36 +sudo ant frameworks.install 37 + 29 29 {{/code}} 30 30 31 -* Open a terminal shell and navigate to the directory where you want to maintain the WonderSource directory and decide on a name of the folder that will contain the Wonder source. For this example, we will use the name //WonderSource// 32 -* Perform initial checkout of Wonder source tree from Subversion head using the following command. This checks out the source into the directory //WonderSource//, automatically creating //WonderSource// if it does not exist. 40 +{{info value="Legacy WebObjects 5.3.3 Compatability"}} 33 33 34 -{{noformat}} 42 +If you are still stuck on WebObjects 5.3.3, for whatever reason, then you need to checkout and switch to the Wonder_5_0_0_Legacy branch *before* you build (before you run 'ant frameworks'). And this is *much* easier with git than it used to be with subversion. Just one command: 43 + 44 +{code} 45 +git checkout --track origin/Wonder_5_0_0_Legacy 46 +{code} 47 + 35 35 36 - svn co http://wonder.svn.sourceforge.net/svnroot/wonder/trunk/Wonder WonderSource49 +{{/info}} 37 37 38 - {{/noformat}}51 +== Source Frameworks Upgrade Installation == 39 39 40 - *As often asyoupreferyou cankeepthisup todate asfollows:53 +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. 41 41 42 -{{no format}}55 +{{code title="Updating your Source"}} 43 43 57 +# Navigate to the Roots directory that was automatically created by the initial Source installation procedure above 58 +cd ~/Roots/ 59 + 60 +# Delete all installed frameworks whose names match the built frameworks in this Roots build folder 61 +for FRAMEWORK in `echo *.framework`; do sudo rm -r /Library/Frameworks/${FRAMEWORK}; done 62 + 63 +# Navigate to the original Wonder source directory that you created above during initial source installation 44 44 cd /path/to/WonderSource 45 -svn up 46 46 47 -{{/noformat}} 66 +# Pull the changes you do not have and merge them with your local repository 67 +git pull 48 48 49 -== Build and Install Wonder == 69 +# Clean, build and install the frameworks 70 +ant clean; ant frameworks; sudo ant frameworks.install 50 50 51 - * Follow the "Building with Ant" instructions in the BUILD.txtdocument in the Wonder directory72 +{{/code}} 52 52 53 - {{warningtitle="WebObjects 5.4.X Compatability"}}74 + 54 54 55 - The defaultinstructions in Wonder's BUILD.txt produce binaries that are compatable with WO 5.3.3. Ifyou are using WO 5.4.X, then you need to add the "-Dwonder.patch=54" option to the ant commands. For example:76 +{{info}} 56 56 57 -ant \-Dwonder.patch=54frameworks;sudoant \-Dwonder.patch=54frameworks.install78 +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. 58 58 59 - Alternatively, to avoid having to type the \-Dwonder.patch=54 option every time, one can put the line "wonder.patch=54" either in the wolips.properties file that resides in the \~/Library/ApplicationSupport/WOLips directory or in a build.propertiesfile in the Wonder source root directory.80 +{{/info}} 60 60 61 -{{ /warning}}82 +{{info value="Custom Development Enviroment File layout using Custom wolips.properties"}} 62 62 63 - ==Concepts==84 +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. 64 64 65 - This complete procedureresults in you having86 +For example: 66 66 67 -* a Wonder directory with the whole Wonder source tree (directories, projects, frameworks, example apps, miscellaneous, etc.) inside. 68 -* The binary Wonder frameworks ("ant frameworks") will be installed in /Library/Frameworks. 69 -* If you ran "ant applications", they will be installed in ... 70 -* If you ran "ant examples", they will be installed in ... 88 +{code} 89 +$ cd my/special/purpose/clone/of/Wonder 90 +$ ln -s ~/Library/Application\ Support/WOLips/wolips.custom.properties build.properties 91 +{code} 92 + 93 +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. 94 + 95 +*Tip:* Specify a custom build directory for Wonder by adding the property 'wo.external.root' to the custom wolips properties file, for example 96 +{code} 97 +wo.external.root=/Users/mike/Developer/special/directory/Roots 98 +{code} 99 + 100 +*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. 101 + 102 +{{/info}}