RubyMine 6.3.0 Web Help

Everything you do in RubyMine, is done within the context of a project. A project represents a complete software solution, and defines project-wide settings.

On this page:

Project files

A project in RubyMine is represented in the Directory Based Format. A project directory is marked with a ruby_ProjectIcon.png icon.

Such project directory contains a .idea directory, with the following files:

  • *.iml file that describes the project structure.
  • workspace.xml that contains your workspace preferences.
  • A number of .xml files. Each .xml file is responsible for its own set of settings, that can be recognized by its name: projectCodeStyle.xml, encodings.xml, vcs.xml etc.

    Thus, for example, adding a new run/debug configuration and changing encoding will affect different .xml files. This helps avoid merge conflicts when the project settings are stored in a version control system and modified by the different team members.

Note

All the settings files in the .idea directory should be put under version control except the workspace.xml, which stores your local preferences. The workspace.xml file should be marked as ignored by VCS.

3.0+

Note

.idea directory is not visible in the Project view.

Project types

RubyMine suggests the following types of projects:

  • Empty project is intended for pure Ruby programming. The directory structure of such project contains the .idea directory for the RubyMine-specific settings and the project file, and libraries.

    Create a plain Ruby project as described in the section Creating Empty Project.

    Warning

    Ruby must be installed on your machine.

  • Rails application intended for the Ruby-on-Rails development. This project type contains the specific infrastructure of the Rails applications, and all the necessary artifacts. For the Rails applications, RubyMine provides a dedicated view in the Project tool window.

    Create a Rails application as described in the section Creating Rails Application and Rails Mountable Engine Projects.

    Warning

    • Ruby SDK and Rails must be installed on your machine.
    • Working with Rails applications requires a database. You have to install one of the supported databases (MySQL, Oracle, MySQLite2, MySQLite3, PostgreSQL), and have the daemon running in the background.
  • 4.5+ Rails mountable engine intended for the development of the Rails applications to be used as plugins in the other Rails applications. This project type contains the specific infrastructure of the Rails and Rails engine applications, and all the necessary artifacts. For the projects of this type, RubyMine provides Rails view in the Project tool window.

    Create a Rails mountable engine application as described in the section Creating Rails Application and Rails Mountable Engine Projects. Define the Rains mountable engine specific settings and embed the engine into a Rails application as described in the section Working with Rails Mountable Engine Projects.

    Warning

    • Ruby SDK and Rails must be installed on your machine.
    • Rails version should be 3.2.x or higher.
    • Working with Rails applications requires a database. You have to install one of the supported databases (MySQL, Oracle, MySQLite2, MySQLite3, PostgreSQL), and have the daemon running in the background.
  • 5.0+ Gem application project for developing, building and pushing gems to github. This project type provides the necessary infrastructure and artifacts, required for creating gems. Refer to the section Creating Gem Application Project for details.

    Warning

    The very first push must be performed via console, outside of RubyMine. The subsequent pushes can be done via RubyMine.

  • 5.0+ RubyMotion application intended for the development of applications for iOS. This project type provides the necessary infrastructure and artifacts, required for the RubyMotion applications. Refer to the section RubyMotion for details.

    Warning

    RubyMotion and Xcode must be downloaded and installed.

  • 4.5+ Client-side projects HTML5 Boilerplate, Twitter Bootstrap, and Foundation.

    For the client-side applications, RubyMine creates specific infrastructure, with the required files and directories.

    Create project as described in the section Creating Projects from Scratch in RubyMine.

See Also

Procedures:

Reference:

Web Resources: