RubyMine 2024.1 Help

Rails navigation

RubyMine helps you navigate between the Rails components, such as controllers, views, models, tests, and so on. For example, from a model, you can navigate to a controller, a table schema in schema.rb or structure.sql, a test, or a corresponding factory. Navigation capabilities are available in the editor, tool windows, and model dependency diagrams.

To navigate between Rails components:

  1. In the main menu, go to Navigate | Related Symbol... Ctrl+Alt+Home.

  2. Select the desired target from the popup menu, or press a corresponding key, specified on the left.

    Below are few examples:

    • Controller action -> View

    • Controller action -> Route in routes.rb

    • Model -> Factory

    • Model -> Table schema in schema.rb or structure.sql

You can navigate between Rails components using gutter icons.

  • If you want to jump to a view file associated with an action, open the corresponding controller, locate the desired action, and click the Go to view gutter icon next to the action definition.

    To navigate back from a view to the corresponding action, open the view file in the editor, and click the Go to controller gutter icon.

  • You can quickly navigate from a model to a create_table call in schema.rb, and the other way round. Open a desired model in the editor, and use the Go to schema definition gutter icon for navigation.

    To navigate back from a create_table call to the model that uses the table, open schema.rb and click the Go to model definition gutter icon.

You can use the URL path inlay hints to navigate from a controller action to the respective declaration in the routes.rb file.

  1. Click an inlay hint above the required controller action to show the list of available actions for the URL.

  2. Select Go to declaration or usages from the list.

The Partial declarations gutter icon in the editor marks a partial declaration. Pointing to this icon shows information about the other parts of the same declaration. To navigate to a partial declaration, click the gutter icon and select the desired part of the declaration from the popup.

RubyMine allows you to jump from nodes/associations in a model dependency diagram to corresponding classes in code.

To do this, right-click the required node/association in the diagram and select Selected Element Actions | Jump to Source F4. If you have selected a one-to-many or many-to-many association, you can choose the desired association part.

Navigate from a model association
Last modified: 11 February 2024