As I have already said, I presented at Smalltalks 2011 a talk called “Building your own images with Metacello”. I thought it could be interesting to write down the details of such presentation for those who couldn’t attend or those who want to follow what I did.
Background and Motivations
To help the Pharo community I find myself using new tools (even if they are not completely finished), using/fighting with latest versions (a.k.a bleeding edge), finding/reporting/fixing/testing bugs and issues. So…. I am downloading hundred of images every day. An image can last me a maximum of a couple of days.
Apart from that, after 3 years with Squeak/Pharo I have my own preferences/settings which are different from the defaults. In addition, I often use tools which are not present in the standard Pharo image. I am also working in several projects at the same time. So….. I spend a lot of time building my own images.
If I am downloading hundred of images every day, an image can last me a maximum of a couple of days, and I spend a lot of time building my own images, then there is something that it is not working.
Moreover, I am lazy, I don’t like loosing time with it, and my memory is bad. Hence, I have come to the solution that I will show you in this post.
Types of Operations and Softwares
To explain you what I did, I will use an example my own projects and tools.
Types of Operations
When I am working with Pharo, there are usually 2 types of operations I perform with a particular project: load and build.
Load means that I will just load a project or package into the image where I am working. No more than that. This is useful when I am working with a project with a particular image, and I just want to load another one to see something.
Build, however, not only loads the project or package but also builds my own image for that project. What does it mean to build my own image? well, I install all the tools I use that are not present by default in Pharo, I set my personal settings, etc.
Types of software
There are also 2 types of software: own software and external tools.
Own software are all those projects I own or that I contribute. For these projects, I develop, hence I always want to load the very last version of all packages. In the example of this post, there is Fuel, DBXTalk, Marea and Cog.
External tools are those development tools, addons, themes, or whatever I install when I build my own images. Since I don’t develop these tools, I don’t want the very last version of every package, but instead the last “stable” version. In the example, there are TilingWindowManager, ‘SimpleLogger’, ‘CodeStats’, ‘Glamoroust’, ‘Keymapping’, ‘SandcastlesThemes’, etc.
Metacello part of the solution
If you have used Metacello before, you are used to see classes like ConfigurationOfSeaside, ConfigurationOfDBXTalk, ConfigurationOfFuel, ConfigurationOfMoose, etc. What I propose is to that you create your own ConfigurationOf. In my case, I have ConfigurationOfMariano. If you want to follow the post watching the real code in your image, then just evaluate:
Gofer new url: 'http://ss3.gemstone.com/ss/MarianoBuilder'; package: 'MarianoBuilder'; load.
Such configuration has no versions and only one baseline method. The (summary) of such method is:
baseline10: spec <version: '1.0-baseline'> spec for: #pharo do: [ spec blessing: #baseline. " ========================================= The following the list of projects that I DO DEVELOP. Hence, I always want the bleedingEdge, and most of the times, I want to build an image for them. =========================================" spec project: 'Fuel' with: [ spec className: 'ConfigurationOfFuel'; loads: #('DevelopmentGroup' ); file: 'ConfigurationOfFuel'; versionString: #bleedingEdge; repository: 'http://ss3.gemstone.com/ss/Fuel' ]. spec project: 'DBXTalk' with: [ spec className: 'ConfigurationOfGlorpDBX'; loads: #('default' ); file: 'ConfigurationOfGlorpDBX'; versionString: #bleedingEdge; repository: 'http://www.squeaksource.com/DBXTalk' ]. "....ACTUALLY, THERE ARE MORE PROJECTS...." " ========================================= The following the list of TOOLS, ADDONS that I use for my own images. Since they are not my projects, I usually use the latest available metacello version and not the bleedingEdge. In addition, not all tools and addons are loaded in all type of images I build. Each image decides what to include. =========================================" spec project: 'TilingWindowManager' with: [ spec className: 'ConfigurationOfTilingWindowManager'; loads: #('default'); file: 'ConfigurationOfTilingWindowManager'; repository: 'http://www.squeaksource.com/TilingWindowManager' ]. spec project: 'Glamoroust' with: [ spec className: 'ConfigurationOfGlamoroust'; loads: #('GT-Inspector' 'GT-Playground' ); file: 'ConfigurationOfGlamoroust'; repository: 'http://www.squeaksource.com/glamoroust' ]. spec project: 'Keymapping' with: [ spec className: 'ConfigurationOfKeymapping'; loads: #('forDeveloper' ); file: 'ConfigurationOfKeymapping'; repository: 'http://www.squeaksource.com/ShortWays' ]. "....ACTUALLY, THERE ARE MORE TOOLS...." " ========================================= The following is a list of groups for building my own images. Notice that for each image group there should be a class side method #buildXXXImage =========================================" spec group: 'FuelImage' with: #( 'BaseImage' 'SandcastlesThemes' 'Fuel'); group: 'MareaImage' with: #( 'BaseImage' 'Marea'); group: 'DBXTalkImage' with: #( 'BaseImage' 'DBXTalk'); group: 'CogVMImage' with: #( 'BaseImage' 'CogVM'); group: 'BaseImage' with: #('TilingWindowManager' 'SimpleLogger' 'CodeStats' 'Glamoroust' 'Keymapping'). ].
Forget for a moment the last lines about groups. The basic idea is that in such configuration you group both types of software, your own or the one you contribute, and the external tools. There are a couple of interesting things to notice:
- Whenever I want to install something with Metacello, I never remember whether the ConfigurationOf is in MetacelloRepository or in the same repository of the project. I don’t remember which group/packages I have to load either. This way such information is stored directly in ConfigurationOfMariano. For example, for Fuel, I have to load ‘DevelopmentGroup’ and the ConfigurationOfFuel is in ‘http://ss3.gemstone.com/ss/Fuel’. For DBXTalk I have to load ‘default’ and the ConfigurationOfGlorpDBX is in ‘http://www.squeaksource.com/DBXTalk’. Conclusion? I don’t have to remember that anymore.
- Notice that for my own projects (Fuel, DBXTalk, Marea, etc) I set #bleedingEdge as the #versionString. This is because of what I have already explained that I always want the last version of each package. In the contrary, for the external tools such as Glamoroust, KeyMapping, etc, I don’t specify anything in #versionString. Hence, the default will be the last stable version, exactly what I want for those cases.
In the class side of ConfigurationOfMariano there is a category called ‘loading’ and there you can find methods like #loadFuel, #loadDBXTalk, #loadMarea, etc. As an example:
loadFuel FuelImageBuilder new loadPackages: 'Fuel'
For the moment, forget what FuelImageBuilder does, but imagine it just loads ‘Fuel’ (this is the parameter to #loadPackage:) from ConfigurationOfMariano. Of course, the rest of the #load* methods are the same and they only change the package to load and the builder class.
Conclusion? I can take any Pharo image, Gofer MarianoBuilder and then all I need to do is to send #loadXXX message to ConfigurationOfMariano :) No need to remember anything nor loosing time. In fact what I do is to have sticky note in my Mac with this code:
Gofer new url: 'http://ss3.gemstone.com/ss/MarianoBuilder'; package: 'MarianoBuilder'; load. (Smalltalk at: #ConfigurationOfMariano) perform: #loadFuel.
I copy paste such code and I change #loadFuel for what I want at that moment.
Building my own images
Now let’s see the interesting part. To build your own images with this approach, there are 2 parts. The first part is done in ConfigurationOfMariano. Take a look to the groups defined in the baseline at the beginning of the post.
Basically, we create a Metacello group for each image we want to build. For example, there is a group ‘FuelImage’, ‘DBXTalkImage’, etc. In such groups we can put all external tools that are exclusively needed when we build images for such project. For example, in Fuel I add ‘SandcastlesThemes’ because for Fuel images I want to use such theme. Besides particular tools that each image needs, there is also a group called ‘BaseImage’, where I put all the external tools I want for all images. In this example, ‘TilingWindowManager’ ‘SimpleLogger’ ‘CodeStats’ ‘Glamoroust’ and ‘Keymapping’.
So…all we do in the baseline of ConfigurationOfMariano related to building images is just to define which packages/projects to load. Now we have to really build the image. Most of the code for building my own images is quite similar among different projects. For example, the code to build a Fuel image will be quite similar to the one to build a DBXTalk image. The image builder is done in Pharo as well so the easiest solution is to use subclassification to customize the build process for each project. The abstract class is GeneralImageBuilder and there are subclasses such as MareaImageBuilder, FuelImageBuilder, DBXTalkImageBuilder, CogVMImageBuilder, etc.
The last part of ConfigurationOfMariano is the class side category called ‘building’, which contains methods such as #buildFuelImage, #buildDBXTalkImage, etc. You can imagine what they do:
buildFuelImage FuelImageBuilder new buildImage.
The main method is #buildImage
buildImage self loadImagePackages. self generalImagePreferences. self customPreferences. self cleanSystem. self lastActions. self saveImage.
The first step is to load all the packages defined as part of the image. Each subclass of GeneralImageBuilder understands #imageGroupNameToLoad which answers the metacello group defined in ConfigurationOfMariano. For example, FuelImageBuilder >> #imageGroupNameToLoad just answers ‘FuelImage’.
The second line is to set all preferences/settings which are general to all images. Line 3 is a hook that allow subclasses to set custom settings. For example, Fuel and Marea they both set their own background picture, logo, theme, log file name, etc (check implementors of #customPreferences).
With #cleanSystem we execute some cleanings to let the image in a nice and clean state. Then #lastActions is another hook where each subclass can execute something at the end. For example, to set my username and password for all SqueakSource repositories, to set a global/shared package-cache for all projects, etc.
Finally, we save the image. In my case, I want that the image is saved with a particular name and in a particular place. For example, I want that all Fuel images are called Fuel.N.image and to be placed in ‘/Users/mariano/PhD/Marea/Fuel/imagenes/’. Implementing #imageDirectory and #baseImageName subclasses can customize that.
Conclusion? I can take any Pharo image, Gofer MarianoBuilder and just sending #buildFuelImage or #buildXXX I can automatically build my own image with my own tools, settings and customizations. The image will be named and placed exactly where I want.
My final proposal
As said, you can find the code in http://ss3.gemstone.com/ss/MarianoBuilder and the license is MIT. I didn’t call it MarianoBuilder because of ego, but on purpose to make it clear that MarianoBuilder is just for me, it has my own preferences, my own settings, my own projects. What you should copy is the procedure. Copy the idea of using Metacello for something else than managing projects. Create your own ConfigurationOfYou and YourBuilder. Of course, you are very welcome to take a look to MarianoBuilder to get an idea of how to set certain preferences or settings. You are invited to take it as a base and fork it.
There are more things I would like to tell about this topic but the post is already too long so I will continue after…