RubyFrontier Documentation

Why RubyFrontier?

Why RubyFrontier?

There are plenty of Web site frameworks and generators out there, from the massive Dreamweaver or FrontPage down to alternative Ruby-based systems such as nanoc and webgen and jekyll, ZenWeb and many others, so who needs another one?

I do. RubyFrontier was written for me. It does what I want it to do. I had a particular problem and RubyFrontier solves it.

My problem was this. It all goes back (harp music here) to 1996 … when I started using UserLand Frontier’s ability to make Web sites. Frontier was way ahead of its time. I liked it so much that I wrote a tutorial about it, and eventually a book about Frontier that was published by O’Reilly (here’s the chapter about the Web site framework). More about all that here.

Flash forward to something more like the present. Frontier has gone from free to insanely expensive. But then an open-source version starts up. Hope springs eternal! But the open-source version isn’t going anywhere - on Leopard, it barfs, it crashes, it can’t do Apple events. Hope falls on its face. Also, I’ve made many tweaks and improvements in my copy of the Frontier Web-site framework code, and every time I update Frontier I run the risk of these being overwritten if I’m not careful; it’s become a maintenance nightmare.

Okay, hold that thought. Meanwhile, back at the ranch, I’ve written a book about AppleScript. AppleScript is useful for sending Apple events to scriptable Mac applications, but it’s not a very good language. Frontier is better as a way to send Apple events - but that’s not working on Leopard, remember? Then, Hamish Sanderson produces rb-appscript, which makes it very easy to send Apple events from Ruby.

So suddenly one of the two main things I use Frontier for, namely as an alternative to AppleScript for sending Apple events, no longer requires Frontier. I can use Ruby instead. So since Ruby has solved that problem, why shouldn’t Ruby solve the other problem? Perhaps, says I to myself says I, it would be possible to clone Frontier’s Web-site-making functionality, using Ruby.

Why a Clone?

But why a clone? Why not just adopt some existing Web site framework? Well, don’t forget the original problem: I’ve got numerous Web sites, containing hundreds of Web pages, that I already maintain through Frontier. I don’t want to start over on these. Plus, Frontier’s Web site framework is something I know very well and deeply. I don’t want to learn something new, and I don’t want to have to rewrite all my Web pages to suit some other framework. I want to keep using the knowledge and the material I’ve already got, with a minimum of fuss, effort, or change. That’s why I want a Ruby utility that effectively imitates what Frontier already does.

Thinking About the Problem

Now, at first this entire prospect seemed an improbable one. Frontier, after all, is much more than a language. It’s a kind of hierarchical database. All the materials from which a Web site is generated, including scripts and texts, are kept inside that database. Objects in the database are referred to as variables through a sort of namespace notation. Furthermore, the database makes use of “tables” whose entries are “scalar” values such as strings and numbers.

True, but then I got to thinking: For Web site generation, the database isn’t really necessary. Scripts are just scripts; it doesn’t matter how they are stored, so they can just as well be methods in one or more Ruby script files. Texts can be represented by text files, and the hierarchical arrangement of texts and tables in the Frontier database can be represented by the hierarchical arrangement of files and folders on disk. This, after all, is how most Web site frameworks work these days (e.g. Rails); and there was once even a variant of the Frontier Web site framework that worked this way (the so-called “BBSite suite”). In the distant past, repeated reading from files would have been considered “thrashing the disk”, but modern virtual memory and disk usage patterns have outmoded such concerns. Furthermore, thanks to TextMate, viewing and navigating a big hierarchy of files and folders is just as easy as navigating Frontier’s object hierarchy.

And what about Frontier’s “tables” of “scalars”? Well, Ruby has internal “tables” (hashes). In fact, they are a lot more efficient than Frontier’s, plus they have an on-disk human-readable representation — YAML.

So, it was starting to look like the project might be possible after all.

Still I hesitated, worried about one final piece of the puzzle — outlines. Outlining is one of Frontier’s great strengths, and not something I wanted to lose. But then, once more, I got to thinking: Where in the Web site framework are outlines really needed? The outline representation of scripts is taken care of by TextMate’s code folding feature. The outline representation of the hierarchy of file and folders on disk is handled by the TextMate project drawer. The one remaining place where outlines are important is this: in Frontier, an object to be turned into a Web page can be an outline, where a “renderer” transforms the outline into HTML. After some hesitation over this issue, I decided that I could use Opal to open and save outlines as OPML, which Ruby could then parse. True, this introduces an inconvenience in the writing/editing process: if a Web page is constructed as an outline, it must be edited using Opal (not TextMate directly). But such a slight inconvenience seemed insufficient to bar usability. (Later, I introduced a mechanism for converting indented text to OPML, thus allowing an outline to be maintained as pure text using TextMate alone.)

A Voyage of Discovery

Having finished the thought process, I started coding. Remember the goal here: to clone Frontier’s Web-site-making functionality in Ruby. So I began walking through Frontier’s code (most of which, fortunately, is open to view as UserTalk source), tracing the process by which a source object is transformed into a Web page. As I proceeded, I turned each Frontier script into a corresponding Ruby method. It took several weeks of coding before I achieved the satisfaction of being able to transform one single text file, complete, into a Web page! After that, things started to pick up steam.

Now, the process is effectively finished, in any case as a first working approximation. All my Frontier-based Web sites have now been migrated out of Frontier; they all live in TextMate projects and are all generated with RubyFrontier!

Of course, I’ve also cheated by leaving out, for now, all the Frontier functionality I wasn’t actually using. But that’s only “for now”. I have a clear, maintainable, well-structured Frontier clone in Ruby, so I can always add missing functionality later.

Department of Lessons Learned

Along the way, I was surprised to discover how cool Ruby is — and how bad UserTalk had been all along. Now, don’t get me wrong: for a long time, UserTalk was one of my favorite languages, and for what it did, especially back around 1990 or so, it was very slick; indeed, one of the things I like about Ruby is that it has some modes of expression that remind me of UserTalk. But things that were difficult or wordy in UserTalk turned out to be easy, compact, and simple in Ruby. For example:

Also, it turned out that there were a lot of inefficiencies in the Frontier Web-page building process. This is partly because of the language and partly because of the way the Frontier Web framework grew by accretion over time. Thus I was able not only to do the same thing with a lot less code, I was able to do it a lot more efficiently and clearly. As a result, RubyFrontier not only does what Frontier did, it does it better. And faster.

Next: Technical Details

This documentation prepared by Matt Neuburg, phd = matt at tidbits dot com (, using RubyFrontier.
Download RubyFrontier from GitHub.