Rails for Eclipse(转载)

来源：互联网发布：宾馆住宿客房软件编辑：程序博客网时间：2024/06/10 06:16

Setting up a Rails Development Environment on Windows Using Eclipse

By Brian Hogan

Last updated on September 7, 2006 1:33 PM

I've updated all of the broken links and tested this against the new Eclipse 3.2 and Web Tools 1.5. This is the most stable, most responsive version ever!

This latest updated goes hand in hand with the release of Eclipse for Rails, a pre-packaged version for developers looking to try Eclipse. If you're already using Eclipse for development in other areas such as Flex or Java, then you should follow the steps in this tutorial.

I also added a Downloads section where I'll be placing some templates and helper files to speed up the process.

Please, as always, provide some feedback. I can't answer emails about issues not directly related to the setup of this plugin.

This is a quick yet detailed guide on how to set up a very easy-to-use development environment for Ruby On Rails. This guide is for Windows users but there's no reason that it couldn't be adapted for Linux users as well. The guide assumes that you already have a working database installed or available and that you have Ruby installed to c:/ruby.

Lastly, this is not a guide on how to get started with Ruby on Rails! This is simply one method to create a useful IDE for Rails development.

Download and install Ruby and Rails
Install Eclipse
Configure Eclipse for Rails
- Install the Ruby Developer Tools package
- Configure the RDT plugin
Launching External Rails Scripts within Eclipse (Now with downloadable goodness! )
- Configure Eclipse to Create Rails Projects

Configure Eclipse to Launch WEBrick server
Configure Eclipse to Create Rails Models
Configure Eclipse to Create Rails Controllers
Configure Eclipse to Generate Scaffold for Controllers and Views
Setting up the Favorites

Working with Rails Projects in Eclipse
- Configure WEBrick's Output for Eclipse

Create a new Rails Project
Show All Files

Install the DBEdit Eclipse plugin
- Connect to a Database
Configure Eclipse to handle you View files
Add code hints for the views
Debugging within Eclipse
- Setting up Breakpointer
- Using Breakpointer
Installing SubClipse
Troubleshooting (Updated!)
Downloads (New!)
Screenshots

Download and install Ruby and Rails

I am operating under the assumption that you're going to use the One-Click Ruby Installer created by Curt Hibbs. If you don't, then you're going to have to modify these instructions yourself.

Download and install the One-Click Ruby Installer for Windows
- http://rubyforge.org/projects/rubyinstaller/
- Grab 1.8.4-20 stable (Direct download)
- These instructions assume you have installed this to c:/ruby (the default location)
Open a command prompt and type
- gem install rails --include-dependencies

Install Eclipse

Eclipse is going to need the Sun Java JRE in order to run. A lot of developers already have this. However, if you are one of the few that doesn't have this installed already, you need to grab it from here. Install it with all of the defaults and then continue with this guide.

Download Eclipse 3.2.0 with the Web Tools Plugin 1.5 already installed from this page.
- Direct Download
Unzip the files to C:/java/eclipse
Make a shortcut to C:/java/eclipse/eclipse.exe
Start Eclipse and set the workspace to C:/java/workspace
- One user had trouble with using the default workspace location for Eclipse, and setting it to a simple path with no spaces solved the problem

Configure Eclipse for Rails

Install the Ruby Developer Tools package
The Ruby Developer Tools plugin is a great set of tools that turn Eclipse into a nice Ruby IDE. The current version (0.6.0 as of this writing) now supports Eclipse 3.1. However, I will continue to use the nightly build for this tutorial.

Launch Eclipse

Choose Help->Software Updates->Find and Install

Choose "Search for new features to install" and select Next

Select "New Remote Site",

Use the name “Ruby Developer Tools”

Use http://updatesite.rubypeople.org/release for the URL

You can use http://updatesite.rubypeople.org/nightly if you wish to use the most current nightly build.

Press OK

Check RDT and push Next

Select the feature RDT and push Next. You should confirm any messages relating to installing unsigned plugins. RDT will be installed and be available after restart.

Configure the RDT plugin

Select Windows > Prefrences > Ruby

Select Installed Interpreters

Click Add

Enter Ruby as the interpreter name (You might want to include the version number if you know it)

Enter the path to your ruby.exe file (usually c:/ruby/bin/rubyw.exe)

Select OK

Configure the rest of your Ruby settings and then select OK to save the settings.

Launching External Rails Scripts Within Eclipse

You should know that hese settings are tied to your workspace. If you change workspaces then you will need to reconfigure these options. Hopefully the fine developers of RDT will build these into the plugin at some point so they appear on the context menus.

At this point, you're going to want to open the Ruby perspective. To do this, go to Window -> Open Perspective -> Other and choose Ruby

If you don't want to go through the trouble of creating these external tools, you can download this file and unzip it to the root of your c: drive. The files should then extact to c:/java/workspace/.metadata/.plugins/org.eclipse.debug.core/.launches (assuming you've followed along so far). Be sure to set up the favorites once you import these settings!

Configure Eclipse to Create Rails Projects

Select Run -> External Tools -> External Tools

Select "Program" from the configuration tree

Select New to create a new program

Enter “Create Rails Application in Project” as the name

Enter C:/ruby/bin/rails.cmd for the Location

Enter ${project_loc} for the Working Directory

Enter ../${project_name} for the Arguments

Select the refresh tab and check Refresh Resources Upon Completion

Select the Common tab

Find the section for Display in Favorites Menu

Check the box next to External Tools

Select Apply
Configure Eclipse to Launch WEBrick server

Select Run -> External Tools -> External Tools

Select "Program" from the configuration tree

Select New to create a new program

Enter “Start WEBrick” as the name

Enter C:/ruby/bin/ruby.exe for the Location

For the Working Directory, use
${project_loc}

Enter script/server for the Arguments

Select the refresh tab and check Refresh Resources Upon Completion

Select the Common tab

Find the section for Display in Favorites Menu

Check the box next to External Tools

Select Apply

Configure Eclipse to Create Rails Models

Select Run -> External Tools -> External Tools

Select "Program" from the configuration tree

Select New to create a new program

Enter “Generate Model” as the name

Enter C:/ruby/bin/ruby.exe for the Location

For the Working Directory, use
${project_loc}

Enter for the arguments

script/generate model ${string_prompt:Model name} -f

Select the refresh tab and check Refresh Resources Upon Completion

Select the Common tab

Find the section for Display in Favorites Menu

Check the box next to External Tools

Select Apply
Configure Eclipse to Create Rails Controllers
As many have noted, you could simply duplicate the previous entry and simply change the arguments

Select Run -> External Tools -> External Tools

Select "Program" from the configuration tree

Select New to create a new program

Enter “Generate Controller” as the name

Enter C:/ruby/bin/ruby.exe for the Location

For the Working Directory, use
${project_loc}

Enter for the arguments

script/generate controller ${string_prompt:Controller name} -f

Select the refresh tab and check Refresh Resources Upon Completion

Select the Common tab

Find the section for Display in Favorites Menu

Check the box next to External Tools

Select Apply

(You could just copy the "generate model" example above and change the argument).
Configure Eclipse to Generate Scaffold for Controllers and Views
As many have noted, you could simply duplicate the previous entry and simply change the arguments

Select Run -> External Tools -> External Tools

Select "Program" from the configuration tree

Select New to create a new program

Enter “Generate Scaffold” as the name

Enter C:/ruby/bin/ruby.exe for the Location

For the Working Directory, use
${project_loc}

Enter for the arguments

script/generate scaffold ${string_prompt:Model name} ${string_prompt:Controller name} ${string_prompt:Actions separated with spaces} -f

Select the refresh tab and check Refresh Resources Upon Completion

Select the Common tab

Find the section for Display in Favorites Menu

Check the box next to External Tools

Select Apply
Setting Up the Favorites
Sometimes, all of these external commands won't show up under the External Commands icon. We can fix that by making them "Favorites".

Select Run > External Tools > Organize Favorites

Add each external tool that you want to appear on your menu of External Tools

Select Add...

Select the tools you wish to add to your menu and press OK

Use the Up and Down buttons to change the order of the items in the menu

Select OK to save the items

Working with Rails Projects in Eclipse

Configure WEBrick's Output for Eclipse
For some strange reason, WEBrick's output doesn't always get piped to Eclipse's console. We can hack this a bit to make this work for us. We need to add these two lines to the Rails server script:
Provided that you've installed Ruby to c:/ruby as instructed above, you can navigate to
C:/ruby/lib/ruby/gems/1.8/gems/rails-1.1.6/bin
and edit the server file with a good text editor (anything except for notepad or wordpad).
Add this to the second line of the script:
$stdout.sync=true
$stderr.sync=true
Alternatively, you could just add these two lines to WEBrick once you've created your Rails project by modifying the server file under /scripts in your Rails project.
Create a new Rails Project

Select File > New > Other : Ruby > Ruby Project

Enter a name for your project.

This name will be the name you'll use for your Rails project name when you generate the Rails application files

Make sure to use the Eclipse Workspace for the project contents!

Select the project in the Ruby Resources view

Go to Run -> External Tools and choose Create Rails Project. A few seconds later, your Eclipse Console should show the results of the file creation and your file project tree should be populated with your ruby files.

At this point, you'll want to edit your config/database.yml file with your database properties.
Show All Files
Under Ruby Resources, select the down arrow icon and deselect Show Ruby Files Only so you can see all the files in your project and not just the .rb files (If you don't see Ruby Resources, it's most likely because you didn't change to the Ruby perspective. (Eclipse defaults to the Java perspective!)

Install the DBEdit Eclipse plugin

The DBEdit plugin for Eclipse will allow you to view and edit your database tables from Eclipse as well as run various SQL statements against your database.

Shut down Eclipse
Download the DBEdit plugin version 1.0.3_1 from http://prdownloads.sourceforge.net/dbedit/dbedit_1.0.3_1.bin.dist_3.X.zip?download
Unzip the file to your c:/java/eclipse folder. The file should place new files in your features and plugins folder.
Download and the appropriate driver for your database
Extract the contents of this driver to c:/java/drivers
Launch Eclipse
Select Window -> Show View -> Other
- Select DBEdit and choose Tables

Connect to a Database

Connecting to a database is pretty straight-forward. I'll use MySQL for an example. In this article, I assume you're using MySQL 4.1 and that you have installed the appropriate driver.

Right-click anywhere in the whitespace of the Tables pallette and select Connection -> Configure from the popup menu
Select New
Enter a name for the connection in the Name field
Select the Classpath tab and press Add to Archive. Navigate to your drivers folder and select the appropriate driver jar file.
- For MySQL, choose mysql-connector-java-3.1.12-bin.jar
Select the Commom tab
Select com.mysql.jdbc.Driver for the Driver
Enter jdbc:mysql://host/dbname for your database
Enter your database username
- For MySql, remove the entry in the Schema field!
Enter your passwod and select Save Password
Press Connect to save and connect to the database.
You can go to Window -> Show View -> Other ->DBEdit ->Instant SQL to bring up a SQL editor panel. Here you can execute statements against your database!

Configure Eclipse to handle your Rails Presentation files

Eclipse can handle your rhtml files with syntax highlighting! All you have to do is associate the .rhtml extention with the JSP editor. Once you do that, you can add templates for all of the ActionView helper functions to make development even easier.

Select Window -> Preferences
Expand the General section
Select the Content Types option
Expand Text
Select JSP
Select Add
Enter *.rhtml and press OK
Select Add
Enter *.rxml and press OK
Press OK to save the changes

Add Code Hints for the Views

Now, let's add the Rails Link_to tag to the templates library

Selct Window -> Preferences
Expand the Web and XML section
Expand the JSP Files section
Select JSP Templates
Select New
Enter link_to for the name
- The context should be ALL JSP
- Automatically Insert should be checked
Enter the following for the pattern:
<%= link_to "${url}", :controller=>"${controller}", :action=>"${action}", :id=>"${id}" %>

Create a new .rhtml file and press CTRL+Spacebar

Your Link_to tag should be in that list. When you type the < character, your list of options should appear. Type link to filter the list of results.

When the template is first inserted, the cursor is placed at the url variable, if you hit tab, it will cycle to the next variable in the list.

You can repeat these steps with other helper tags to speed up development. To get you started, I've provided this starter template. Import this into the JSP Templates section via the Import button.

Debugging in Eclipse

Ruby on Rails has some interesting techniques to debug projects. One technique is the Breakpointer script. The Breakpointer connects an IRB session to your running web application.

Setting up Breakpointer

Select Run -> External Tools -> External Tools
Select New to create a new program
Enter “Start Breakpointer ” as the name
Enter C:/ruby/bin/ruby.exe for the Location
For the Working Directory, use
${project_loc}
Enter script/breakpointer for the Arguments
Select the refresh tab and check Refresh Resources Upon Completion
Select the Common tab
- Find the section for Display in Favorites Menu
- Check the box next to External Tools
Select Apply

Using Breakpointer

In your project, place the following line of code in any method where you want to stop code execution:
breakpoint
Start up WEBrick:
- Go to Run -> External Tools ->Start WEBrick
Start up Breakpointer
- Go to Run -> External Tools ->Start Breakpointer
Open a browser and navigate to your project (should be at port 3000)
Once you hit your breakpoint, return to Eclipse and you should see an IRB console that you can use to inspect your local variables, objects, request data and session data.
To stop processing the breakpoint and allow the application to continue, type exit in the console. Breakpointer will begin waiting for a new breakpoint.

Installing SubClipse

If you use Subversion (and you should if you're serious about Rails development) then you can install the SubClipse SubVersion client plugin.

Visit http://subclipse.tigris.org/install.html and follow their directions, or simply follow the same process as RDT and use their update site at http://subclipse.tigris.org/update

Choose Help->Software Updates->Find and Install
Choose "Search for new features to install" and select Next
Select "New Remote Site ",
- Use the name “SubClipse”
- Use the URL: http://subclipse.tigris.org/update
- Press OK
Check SubClipse and push Next
Select the feature RDT and push Next. You should confirm any messages relating to installing unsigned plugins. RDT will be installed and be available after restart.

Troubleshooting

DBEdit gives me errors when I attempt to connect to MySQL
- "Fetching children of MySQL" is a common error that I've seen. It seems to be related to the version of DBEdit that you use. SourceForge isn't very helpful with the proper version; sometimes you get lucky. If you get this error, uninstall DBEdit and redownload a new version.
I used Cygwin and all the paths in your tutoral arewrong. You should change them or make a note about this.
- You're on your own. This guide uses a specific method. It can easily be adapted for other uses, such as Cygwin or even Linux. However, please understand that I can't support all of those configurations. Compared to developing useful web applications, configuring these plugins should be pretty easy.
When I try to run one of the external programs, I get an error stating something about "not valid in prolog"
- You probably set up all of your external apps as Ant Buids instead of programs.
The breakpointer hangs up on me... I can't exit out
- Just hit the red stop button on the console to kill the breakpointer. Do the same for the console that contains WEBrick.
WhenI run one of the external programs, the message says "variable references empty selection"
- It usually means that the project isn't selected. Just click on the project name before you run one of the programs.
I've set up SubClipse but whenever I try to open one of the SubClipse views, it says my workspace path is invalid and needs to be changed. The suggested path for the change is the same path I'm currently using!
- SubClipse is picky. It wants the drive letter to be capitalized. Change your workspace path from c:/java/workspace to C:/java/workspace and restart Eclipse

Downloads

Sun Java SDK
One Click Ruby Installer
Eclipse with Web Tools
externals.zip
External Programs launchers for
- Create Rails Structure in Project
- Generate Model
- Generate Controller
- Generate Scaffold for Model and Controller
- Generate Migration
- Install Plugin via SVN
- Rake
- Rake - Migrate
- Rake - Migrate to Version
- Rake - Run Functional Tests
- Rake - Run Unit Tests
- Start Breakpointer
- Start Webrick Server
- Open Explorer in Project Folder
- Command Prompt
- Start Console
rails-model-controller.xml
Contains code templates for various Ruby on Rails code methods. Import this into Ruby Templates. (Remove existing Ruby templates or you may get duplicates.)
rails-rhtml.xml
Contains code templates for various Rails helpers used in views. Import into JSP Templates

That about does it. I'll keep looking for other things to add to this procedure since this is the method I am now using for my development environment. If anyone has any feedback that I should add, please send it to ror_dev (at) napcs.com

Thanks to Tom Davies for his comments regarding project locations and his tips about the Rails templates.

Thanks to Chris Williams for the information about WEBrick's output.

Thanks to everyone on the RDT team for working so hard on a great plugin.

Brian Hogan is the owner of New Auburn Personal Computer Services, a small web design company that specializes in standards-based design and accessibility for the disabled. He has been developing web sites for ten years. He also works at the University of Wisconsin-Eau Claire where he oversees development of various web-based applications.