Getting the Wonder Source Code

As of March 25th, 2011 the Wonder source code is now maintained on [GitHub|https://github.com/] at [https://github.com/wocommunity]. 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.

4

5

== Why? ==

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:

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™.

== Download It ==

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

24

git clone git://github.com/projectwonder/wonder.git WonderSource

25

26

27

If "git:~/~/" does not work for you then use "http:~/~/"

The URL above is the public, read-only URL.

32

People with commit privileges for Project Wonder should use: *git@github.com:wocommunity/*{*}wonder.git*

33

{warning}Do *not* change "git@..." to be your username.{warning}

You should see output something like this:

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.

1. h5. Navigate into the working copy root

cd WonderSource

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'

{noformat}

If you have any trouble or errors due to your local repository getting corrupted, simply delete the entire local repository (the {{WonderSource}} directory) and start over using the same clone command above.

== Work with the Latest Changes - Integration Branch ==

73

74

The integration branch of Wonder is where the most recent fixes, additions, new features, etc., are merged in for testing and vetting by the community. By checking out integration you can benefit from all of these latest commits to the Wonder project before they are pulled into master/trunk. And the community can benefit by having another contributor to the improvement of Wonder. To work with the integration branch in Git, you will simply checkout that branch from your repository like so:

cd WonderSource

git checkout integration

== Use It ==

* h5. Use Wonder source code projects in your Eclipse workspace

87

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: [[Working with Wonder source in Eclipse]]

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.*

* h5. Build and Install Project Wonder Binary Frameworks

96

For building and installing the Wonder Frameworks, please see the standard [[Building and Installing WO Frameworks with Ant>>Building and Installing a Framework with Ant]] pages.

97

98

{{note title="Using Both Binary and Source Code Frameworks on Your Development Machine"}}

99

100

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.

* h5. Build Project Wonder frameworks with Hudson/Jenkins

105

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 [[Installing and Configuring Jenkins]] page.

Wiki source code of Getting the Wonder Source Code

Applications

Navigation

My Recent Modifications

Need help?

author	version	line-number	content
		1	{{tip title="Now with more Git"}}
		2
		3	As of March 25th, 2011 the Wonder source code is now maintained on [GitHub\|https://github.com/] at [https://github.com/wocommunity]. 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.
		4
		5	{{/tip}}
		6
		7	== Why? ==
		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:
		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
		17	== Download It ==
		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	{{code value="none"}}
		24	git clone git://github.com/projectwonder/wonder.git WonderSource
		25	{{/code}}
		26
		27	If "git:~/~/" does not work for you then use "http:~/~/"
		28
		29	{{note title="Wonder Committers"}}
		30
		31	The URL above is the public, read-only URL.
		32	People with commit privileges for Project Wonder should use: git@github.com:wocommunity/{}wonder.git
		33	{warning}Do not change "git@..." to be your username.{warning}
		34
		35	{{/note}}
		36
		37	You should see output something like this:
		38
		39	{{noformat}}
		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.
		47
		48	{{/noformat}}
		49
		50	1. h5. Navigate into the working copy root
		51
		52	{{code value="none"}}
		53	cd WonderSource
		54	{{/code}}
		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}
		63
		64	{{/note}}
		65
		66	{{info}}
		67
		68	If you have any trouble or errors due to your local repository getting corrupted, simply delete the entire local repository (the {{WonderSource}} directory) and start over using the same clone command above.
		69
		70	{{/info}}
		71
		72	== Work with the Latest Changes - Integration Branch ==
		73
		74	The integration branch of Wonder is where the most recent fixes, additions, new features, etc., are merged in for testing and vetting by the community. By checking out integration you can benefit from all of these latest commits to the Wonder project before they are pulled into master/trunk. And the community can benefit by having another contributor to the improvement of Wonder. To work with the integration branch in Git, you will simply checkout that branch from your repository like so:
		75
		76	{{code value="none"}}
		77	cd WonderSource
		78	{{/code}}
		79
		80	{{code}}
		81	git checkout integration
		82	{{/code}}
		83
		84	== Use It ==
		85
		86	* h5. Use Wonder source code projects in your Eclipse workspace
		87	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: [[Working with Wonder source in Eclipse]]
		88
		89	{{note title="Ant Builds on your Development Machine"}}
		90
		91	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.
		92
		93	{{/note}}
		94
		95	* h5. Build and Install Project Wonder Binary Frameworks
		96	For building and installing the Wonder Frameworks, please see the standard [[Building and Installing WO Frameworks with Ant>>Building and Installing a Framework with Ant]] pages.
		97
		98	{{note title="Using Both Binary and Source Code Frameworks on Your Development Machine"}}
		99
		100	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.
		101
		102	{{/note}}
		103
		104	* h5. Build Project Wonder frameworks with Hudson/Jenkins
		105	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 [[Installing and Configuring Jenkins]] page.