David Chelimsky: RSpec-1.1.2 and ZenTest-3.8.0

RSpec-1.1.2 and ZenTest-3.8.0

David — Tue, 15 Jan 2008 01:15:55 -0500

The RSpec-1.1.2 release includes changes to keep RSpec compatible with autotest in ZenTest-3.8.0. This new ZenTest release boasts an improved cascading configuration model that works well for subclasses (like those that ship with RSpec) and allows users to override the mappings of specs (or tests) to code as well as the list of files that get ignored by autotest.

To support this, Autotest now loads the following files in the following order:


Autotest
AutotestSubClass
~/.autotest
./.autotest

This allows RSpec (or any other library) to override defaults set in Autotest, and then provides users both generic (~/.autotest) and project specific (./.autotest) control over the mappings and exceptions.

How can you take advantage of this?

When autotest begins to run, it calls its :initialize hook. This hook is exposed by the add_hook method. You can use this to access the mappings and exceptions using the following methods on Autotest:


clear_mappings()
add_mapping(regexp, proc)
remove_mapping(regexp)

clear_exceptions()
add_exception(string)
remove_exception(string)

add_mapping

The add_mapping method adds a key/value pair to a hash that maps regexps to procs. Whenever autotest senses that a file is touched, it looks for the regexp that matches the file name and the runs all the files returned by the associated proc.

Imagine you’re working on a shopping cart app. You have some currency conversion behaviour in a Product model that you’d like to extract to an acts_as_currency plugin, and you want autotest to observe the process. You might add a mapping like this to .autotest:


Autotest.add_hook :initialize do |at|
  at.add_mapping(%r%^plugins/acts_as_currency/lib/.*\.rb$%) {
    at.files_matching %r%^spec/models/product_spec\.rb$% +
    at.files_matching %r%^plugins/acts_as_currency/spec/.*_spec\.rb$%
  }
end

In this case, a change to any of the files in the plugin’s lib directory would cause all the plugins specs to run, as well as the spec for the Product model.

add_exception

The add_exception method adds paths to a list of paths that Autotest ignores.

I like to run autotest in verbose mode (autotest -v) because it tells me when I change a file that it doesn’t know what to do with. The drawback is that it wants to tell me every time I commit because files in the .svn/.hg/.git directories change. So I’ve got these all listed as exceptions in my ~/.autotest file, along with assorted others:


Autotest.add_hook :initialize do |at|
  %w{.svn .hg .git}.each {|exception|at.add_exception(exception)}
end

Note that autotest compiles this list to a Regexp with no anchors, so .hgignore and .gitignore would also get ignored in this case.

Cascading config and granular control

One of the coolest changes in ZenTest-3.8.0 is that autotest loads both ~/.autotest and ./.autotest. So now you can have the hooks you like on every project (like growl notifation) all in one place and still have project specific settings.

This also allows you to set up global mappings/exceptions and modify them at the project level. See Autotest’s RDoc for more info.

"RSpec-1.1.2 and ZenTest-3.8.0" by Luis Lavena

Tue, 22 Jan 2008 21:31:25 -0500

@Tick: you should try setting the environment variable HOME.

Try with %HOMEDRIVE%%HOMEPATH% (in System Properties, Advanced, Environment Variables).

That will solve the expansion of "~" on Windows.

HTH,

Luis

"RSpec-1.1.2 and ZenTest-3.8.0" by Tick

Thu, 17 Jan 2008 16:43:12 -0500

I will.

"RSpec-1.1.2 and ZenTest-3.8.0" by David Chelimsky

Thu, 17 Jan 2008 15:28:02 -0500

@Tick – you should post a request to http://rubyforge.org/projects/zentest for that.

"RSpec-1.1.2 and ZenTest-3.8.0" by Tick

Thu, 17 Jan 2008 13:49:02 -0500

I’m using autotest and rspec on WinXP. Now the annoying “Dunno!” messages are gone but I had to change the homepath in autotest.rb. The microsoft commandline can’t handle ’~/.autotest’. ’$home/.autotest” works better.

"RSpec-1.1.2 and ZenTest-3.8.0" by Mike Subelsky

Thu, 17 Jan 2008 13:44:47 -0500

David,

This was really helpful to me. I posted the .autotest files I setup using your example in case anyone needs inspiration or would like to see how add_mapping works:

http://www.subelsky.com/2008/01/autotest-with-verbose-flag-on.html

-Mike

"RSpec-1.1.2 and ZenTest-3.8.0" by David Chelimsky

Tue, 15 Jan 2008 13:11:15 -0500

@Wincent – Nice screencast. And yes, the modification methods (rather than simple accessors) were just added to 3.8.0.

"RSpec-1.1.2 and ZenTest-3.8.0" by Wincent Colaiuta

Tue, 15 Jan 2008 10:27:43 -0500

I published a screencast about this this morning, but I wasn’t sure whether add_mapping and friends were new in 3.8.0, or had been in for longer and I just hadn’t noticed them… I had tried to override mappings in the past without this and it was fiendishly hacky and difficult.

"RSpec-1.1.2 and ZenTest-3.8.0" by Scott Nedderman

Tue, 15 Jan 2008 02:31:14 -0500

Thanks Ryan and David. This works great.