Just A Summary : Tag acts_as_resource, everything about acts_as_resource

Initial release of acts_as_resource

pdcawley@bofh.org.uk (Piers Cawley) — Thu, 25 Jan 2007 12:56:00 -0600

Right. I’ve bundled acts_as_resource up and stuck it on the typosphere SVN server. You can grab it from http://svn.typosphere.org/typo/plugins/acts_as_resource if you’re interested.

It’s currently in what I’d call an all convention, no configuration state – if your resources don’t look pretty similar to the kind of things you get from the resource scaffolding, you’ll probably have some pain, but I expect to rectify that with coming releases. One thing I want/need to do for instance is to allow for ‘relative’ ids in your resource url. For instance, if you’re looking at /albums/10/tracks/982, it’s not the most readable of permalinks… next trick is to allow you to have urls like /albums/because-its-there/tracks/1, ie: the first track on the album ‘Because it’s There’. I’m sort of expecting that you’d do that by doing:

class Album
  has_many :tracks
  acts_as_resource :uri_field => :name_dasherized
end

class Track
  belongs_to :album
  acts_as_list
  acts_as_resource :uri_field => :position, :parent => :album
end

However, my first priority is to add some tests (or, more likely,Rspec specifications) so I’ve got some confidence that I’m not breaking things as I go.

Anyhow, go grab the plugin, have a play, let me know what you think.

'acts_as_resource' progress

pdcawley@bofh.org.uk (Piers Cawley) — Thu, 25 Jan 2007 09:30:00 -0600

I’m very nearly ready to release acts_as_resource, I just have to pull up and tidy code that’s currently in my working directory’s ApplicationController and we’re laughing. However, I thought you’d like to see what my nested controller looks like.

class ChildrenController < ApplicationController
  before_filter :fetch_resources
end

def index
end

def show
end

def edit
end

def create
  @child = @children.build(params[:child])
  if @child.save
    flash[:notice] = 'Child was successfully created.'
    redirect_to child_path(@child)
  end
end

def update
  if @child.update_attributes(params[:child])
    redirect_to child_path(@child)
  else
    render :action => 'edit'
  end
end

def destroy
  @child.destroy
  redirect_to children_path
end

I’ve removed the XML responses to save vertical space, but they work pretty straightforwardly.

Note that fetch_resources is absolutely generic. It is unscaffolded, uses the resourceful conventions and extra information provided by each model’s acts_as_resource declations to work out what instance variables should be called and sets them appropriately.

With a little work to set up a generically named variable as well as the conventionally named ones (say, resource_chain) and a wee bit of simply_helpful pixie dust (polymorphic paths), it should be possible to write a ResourceController class that does all the work for you but allows you to alter behaviour without having to rewrite an entire action method. But that’s definitely for the next release of the plugin.

My first 'acts_as' plugin

pdcawley@bofh.org.uk (Piers Cawley) — Tue, 23 Jan 2007 17:39:00 -0600

So, you’ve upgraded to Rails 1.2.1 and you’re working on a tool to maintain a database of all the tunes you have in your various songbooks and (eventually) your record collection. You start with:

$ ./script/generate rspec_resource MusicBook title:string author_id:integer \
  abstract:text
$ ./script/generate rspec_resource Tune title:string composer_id:integer \
  abc:text book_id:integer

You decide to come back to composers and authors later, so you set up your models¹:

MusicBook.has_many :tunes
Tune.belongs_to :music_book

And your routes:

map.resource :music_books do |book|
  book.resource :tunes
end

Problems start here

Being a cautious sort, before you start adding behaviour, you fire up a development server and go and check things with the browser. The /music_books/ stuff works fine, but once you start looking at /music_books/1/tunes things start to get weird; all of a sudden your links aren’t making sense.

The problem is, that your scaffolding is calling named routes with something like: edit_tune_url @tune, when, because of the nesting of your resources, they should really be calling edit_tune_url @tune.book, @tune. But how to fix things?

Well, you could go through all your controllers and views, replacing all the calls to named_routes with the right version. But, if you’re anything like me, you’ll get bored stiff of the repetition after you’ve fixed up the first file. And that’s before you start fixing up your controllers to do

@tune = Book.find(params[:book_id]).tunes.find(params[:id])

So, I’m going to suggest that a better bet is to install the acts_as_resource plugin I’m in the process of writing.

Making the model pull its weight

Once you’ve got acts_as_resource installed, you can just do:

Book.acts_as_resource
Tune.acts_as_resource :parent => :book

And your models will magically acquire a resource_chain which returns exactly the list of objects that your named routes need. I’m currently investigating the innards of named routes, but the plan is that you’ll never have to call resource_chain yourself, the named_route helper will do it for you and use the resulting list to build the url.

Your model class, meanwhile, gets a handy

Tune.find_resource(params)

which will find your resource, verifying that it can be reached through the chain of resources specified in your params hash, which means we can fix up the scaffolding generator to use find_resource (or, more likely, a helper method that will set appropriately named instance variables in the controller).

If I understand what simply_helpful is up to, the named_routes hack should play well with that too, which means that form_for @tune will get its url right without you having to remember to call form_for @tune.book, @tune.

Release date?

I’m not quite ready to release yet, I’m busy wrapping my head around how named routes work so I can fix ‘em up to use resource_chain. find_resource is written though.

It’s amazing how much leverage you can get, simply by adding one class attribute and a support method to your model…

Expect a release some time next week. However, if you’re desperate for a look, drop me a line and I’ll send you my local snapshot.

¹ Look, vertical space is precious. Pretend this is in the usual blocky type stuff you usually find in the files you’ll find in app/models/whatever.rb