Untitled Document

This file contains important information on Ruby In Steel including:

Release Notes
Installation
Additional tools and documentation
Where to find more information
How to request support
Upgrade information
Troubleshooting

Release Notes

Database IntelliSense

1) Database IntelliSense not found?

Note that Database IntelliSense assumes standard pluralization (i.e. the table name will be the same as the class name plus an 's' at the end). If you have a tables named "posts" the matching class name will be Post. If Rails uses other types of pluralization you may need to edit the Ruby In Steel database IntelliSense reference file (tables.rb) which is generated after you create Database IntelliSense using the IntelliSense Librarian.

For example, if you run a migration to create a class named Xxx, Rails pluralizes the table name to "xxxes" (that is, it adds 'es', not just 's'). This will cause the Ruby In Steel Librarian to create enter the class name Xxxe into its Database reference. To correct this you should manually alter the name in tables.rb by following these steps:

1) Select File/Open/File, navigate to your application's ~intermediate directory (e.g. \RailsApp\~intermediate), select tables.rb and click 'Open'.

2) Edit and class names to match the correct singular name of the class. For example, if the class is called Xxxe but should be named Xxx edit the class definition as shown below:

class Xxx < ActiveRecord:: Base

3) Save tables.rb. Your database IntelliSense should now be available.

1) Adding Extra Features To Database IntelliSense

You may add additional features such as parameter information and RDoc tooltips to database IntelliSense by editing the file tables.rb. To do this open tables.rb as explained in step 1 above. Enter RDoc comments above the method names. For example, if you add this comment...

# This is the title of a new Blog post
def title; end

...when you hover the mouse pointer over the method name in the controller...

@post.title

The comment "This is the title of a new Blog post" will be shown in a tooltip.

Installation

BEFORE INSTALLING: YOU MUST UNINSTALL ANY OTHER VERSION OF RUBY IN STEEL

This includes any previous version of the Developer Edition (including the Trial Edition) or the Text Edition.

Installing for Visual Studio 2005 or Visual Studio 2008?

We have several different installers for Visual Studio 2005 and 2008. You must be sure to use the correct installer for your edition of Visual Studio. The zip archive identifies the version:

rubyinsteelde_2005.zip contains the Visual Studio 2005 installer
rubyinsteelde_2008.zip contains the Visual Studio 2008 installer
rubyinsteel_text_2008.zip contains the Text Edition installer (for VS 2008)
rubyinsteelde_allinone.zip contains the all-on-one installer (Developer edition for VS2008)

Installation Guide

The instructions in this ReadMe document provide a very brief installation summary only.
A detailed setup guide is provided in the download archive: Installation Instructions.pdf.

The All-in-One Installer

If you do not already have any of the following items installed and you wish to install them, you should use the Ruby In Steel ‘All-in-One’ installer:

Ruby
Rails
Gems
MySQL
Visual Studio 2008 (free edition)
.NET 3.5
Ruby In Steel Developer Edition (2008)

If you do not need the above items you may download one of the smaller Ruby In Steel installers in order to install the appropriate edition of Ruby In Steel into an existing copy of Visual Studio.

To install the All-in-One installer with the Text Edition:

- Install the items you need using the all-in-one installer (optionally you may install the free edition of Visual Studio) - but do not install Ruby In Steel at this time!
- Download and unzip Ruby In Steel Text Edition into its own directory.
- Run Setup.exe for the Text Edition to install Ruby In Steel.

To install as a 60-day Trial Edition:

Unzip the installation archive into a temporary directory of your choice on your hard drive (e.g. C:\Temp).
Double-click Setup.exe to begin installation.
Follow the instructions in the installation dialogs.
To install as a 60 day Trial, accept the default user name and serial number when prompted.

To install as a Registering Edition:

By default, the program will register as a 60 day Trial Edition. If you have a full license you may unlock the software as explained below.
If you have purchased a full license you will have received a new key.bin. You should keep this new key.bin in a safe location. You may either copy this new key.bin into the temporary directory containing your installation files (i.e. replace the existing key.bin) to register the software during installation or you may register after installation (as explained later).
Double-click Setup.exe to begin installation.
Follow the instructions in the installation dialogs.
The Setup program will ask for the following details:
The Registered User Name.
- If you have a full license, you may enter the name that the product is licensed to (without quotation marks).
The Serial Number.
- If you have a full license, enter the Order number which will have been sent with your order conformation.
You must enter these details EXACTLY as given in this email (uppercase and lowercase characters are significant).

Unlocking the software after installation:

If you installed the software as a Trial Edition and subsequently bought a full license, you may unlock the software by selecting the Ruby menu then Register. A dialog will ask for the following details:

The Registered User Name.
- Enter the name that the product is licensed to (without quotation marks).
The Serial Number.
- Enter the Order number which will have been sent with your order conformation.
You must enter these details EXACTLY as given in this email (uppercase and lowercase characters are significant).
Click 'Next' and browse to the location of the key.bin file which you received after purchasing your license. Select this and click 'Open'.
A message should inform you that the software has been successfully registered.

NOTE: If the registration dialog informs you that there was a problem, please check that you have entered the registered users name correctly (uppercase, lowercase, punctuation and spaces are all significant) and that you have entered the correct serial number. Also ensure that you have selected the key.bin which you received with your license and not the key.bin that was supplied with the Trial Edition of the software.

Setting the Ruby path:

The installation attempts to locate a Ruby interpreter on your system. Following installation we recommend that you verify that the appropriate path to the Ruby interpreter has been set up. The path can be verified (and changed, if necessary) by selecting the Visual Studio Tools menu, then Options, Projects and Solutions, Ruby In Steel. Ensure that the Ruby Interpreter and the Ruby Interpreter (no debugger) paths are set to a directory containing a Ruby interpreter (ruby.exe).

Minimum Requirements: Ruby In Steel Developer requires Visual Studio 2005 or 2008 Standard Edition or above; alternatively, you may use our 'all in one installer' to install a free Ruby-language version of VS 2008; Windows XP (service pack 2). It has been tested with Ruby 1.8.5 and 1.8.6 and Rails 1.2 and 2.x.

Additional Tools and Documentation

- Snippet Editor

Ruby In Steel Developer includes Sniped!, a standalone Visual Studio snippet editor for Ruby (and other languages) plus a macro library to add some additional functionality for Ruby and Rails development.

- The Ruby Connector

The Ruby Connector is a drag-and-drop control that connects your .NET applications to Ruby. Using the Ruby Connector, you can design visual front-ends to Ruby programs using a .NET language (such as C#, VB.NET or Chrome).

The snippet editor, Ruby Connector and macro library can be found in subfolders of the \Extras directory which is located beneath the directory into which Ruby In Steel was installed (typically, this will be: \Program Files\SapphireSteel Software\Ruby In Steel\v1.0\Extras). Sniped!, the Ruby Connector and the macro library each comes with its own PDF-format documentation located in the same directories.

Where To Find More Information

1) The Manual / User Guide

The pdf-format manual/user guide, Ruby In Steel Manual.pdf, supplied with the software is your primary source of information on the features of Ruby In Steel.

2) Integrated Help

Ruby In Steel provides documentation integrated into the Visual Studio help system.

3) Online Information

The SapphireSteel web site is your primary source of Information on Ruby In Steel. In particular:

The Developers' Blog: http://www.sapphiresteel.com/-Blog-
The Forum: http://www.sapphiresteel.com/forum/

How To Request Support

There is a support forum for registered users of Ruby In Steel Developer. As an alternative you may also request support by contacting support@sapphiresteel.com. However, we recommend the forum as your primary means of requesting support.

The Support Forum

You may join the forum at http://www.sapphiresteel.com/forum. Your application for membership of the forum must be confirmed by a moderator (this is to avoid forum spamming by unregistered members). Initially you will have access only to the public areas of the forum. To request access to the software support forum, please send a personal message to a moderator, giving your Ruby In Steel registered user name and serial number.

Upgrade information

As a registered owner of Ruby In Steel Developer 1.x, you are entitled to free upgrades to all versions of the software up to and including version 1.5. The latest versions of the software can be downloaded from the Download Page. As updates become available these will be announced in the Blog and in the Forum. For versions of the software beyond 1.5 we shall offer a low cost upgrade path for existing users.

SQL Server Development

We have supplied the file ADO.rb in the installation archive. This is only required for integration of SQL Server (or MS SQL Express). If you plan to do development using SQLServer, you should copy the file ADO.rb into the \lib\ruby\site_ruby\1.8\DBD\ADO directory beneath your Ruby installation. For example, if Ruby is installed in C:\ruby you would need to copy ADO.rb into:
ruby\lib\ruby\site_ruby\1.8\DBD\ADO\
You may need to create the \ADO directory. If you do not use SQL Server, this file is not required.

Changes

For details of changes see the online changelog: http://www.sapphiresteel.com/Ruby-In-Steel-Developer-Edition

Troubleshooting

See the online FAQ

Credits

ANTLR version 2.7.6
(parser generator)
http://www.antlr.org/

HTML Tidy
(parser and pretty printer)
http://tidy.sourceforge.net/
Copyright (c) 1998-2003 World Wide Web Consortium
(Massachusetts Institute of Technology, European Research
Consortium for Informatics and Mathematics, Keio University).
All Rights Reserved.