BBRails Toolkit

Home :: Projects

The BBRails Toolkit is a collection of scripts for BBEdit designed to streamline the Ruby on Rails development process. The Toolkit is based on a simple underlying principle: performing routine tasks related to developing, deploying, and testing Rails apps should not necessarily require a trip to Terminal.

The BBRails Toolkit integrates BBEdit with a number of command-line tools (including Capistrano, Rake, Reek, and more) and brings common tasks only one menu-click or keyboard shortcut away. And because the scripts are just AppleScript, instead of compiled plug-ins, they're extensible and hackable.

The BBRails Toolkit is featured on the Bare Bones BBEdit support and resources page, and is currently the only 3rd-party resource to have that distinction. It's also described as an "excellent tool" on the 'Text Editors and IDEs' page on the official Rails wiki.

The BBRails Toolkit consists of a number of scripts for BBEdit designed to streamline the Ruby on Rails development process.

What's Included in the BBRails Toolkit

Capistrano
Presents a menu of Capistrano tasks available for your project. Select the task that you want to execute and click “Run”.
Cheatsheet
Integration with 'Cheat' cheatsheet generator from Err the Blog. Highlight a Ruby or Rails command to look up the associated cheat sheet. If nothing is highlighted, enter a command in a dialog box, get help with Cheat, or get a list of available cheatsheets.
Git
Execute a git status or git pull for the current project.

Rake
Presents a menu of Rake tasks available for the current project. Select the task that you want to execute and click “Run”.
Reek
Check how your code "smells"; with Kevin Rutherford's Reek, an analysis and refactoring tool that scans for duplication, long methods, long parameter lists, nested iterators, unnecessary complexity, and other indicators of code quality.
Start Application
Save yourself a trip to the command line! Start your Rails application right from BBEdit. Supply a port number, click on Start, and you're done.

Each of the BBRails Tools will attempt to determine the current Rails application root based on the project file that you have open. If it is unable to do so, you will be prompted to select your project root manually.

Installation

Start by downloading the BBRails Toolkit:
bbrails_toolkit.dmg (5 MB)
After you download the disk image, mount it in Finder.
To install the scripts in BBEdit, simply drag the "BBRails Tools" folder onto the "BBEdit 9 Script Folder" alias, or manually copy it to ~/Library/Application Support/BBEdit/Scripts/

Usage

The BBRails Toolkit scripts are now accessible via BBEdit's Scripts menu item. You can set up keyboard shortcuts through Window > Palettes > Scripts, clicking the disclosure triangle next to BBRails Tools, selecting the script you want, and clicking the "Set Key..." button.