RubyMine
 
2024.1
Shortcuts: Windows
Get RubyMine
You are viewing the documentation for an earlier version of RubyMine.
  1. Write code
  2. Diagrams

Diagrams

Last modified: 08 April 2024

Show a diagram: CtrlAltShift0U or CtrlAlt0U

Diagram settings: Settings | Tools | Diagrams

RubyMine lets you utilize UML diagrams to analyze Ruby classes, Rails models, gem dependencies, and so on. Depending on the project type and current context (for example, a file/folder selected in a project view or a caret position in the editor), you can use the following diagram types:

Show a class diagram

To display a diagram for a class, do the following:

You can edit a generated diagram in various ways: add Space or remove Delete classes, display methods and class variables, add notes, and so on.

Show a Rails model diagram

If you work with a Rails project, you can display a dependency diagram for a Rails model. To do this:

As for class diagrams, you can edit a model diagram: add Space and remove Delete tables, display association, and migration fields, add notes, and so on.

RubyMine also lets you create new models right from a diagram. To do this, right-click a diagram and select New | ActiveRecord Model. Learn more at Create models.

Work with a diagram

Select elements in a diagram

  • To select an element, click it in the diagram.

  • To select multiple adjacent elements, keep Shift pressed and click the desired elements, or drag a lasso around the elements to be selected.

  • To select multiple non-adjacent elements, keep CtrlShift pressed and click the desired elements.

  • To select a member of a node element, double-click the node element, and then use the arrow keys, or the mouse pointer.

Manage the diagram layout

  • Right-click the diagram background and select the desired layout from the Layout submenu.

  • Drag the diagram elements manually.

  • If necessary, reset the customized layout to the selected from the context menu by clicking the Apply Current Layout button.

Zoom in and out

  • Use the Zoom In and Zoom Out toolbar buttons.

  • Keeping Ctrl key pressed, rotate your mouse wheel up or down.

  • Press NumPad + or NumPad -.

Use the magnifier tool

  • Keep the Alt key pressed, and hover over the desired areas of the diagram.

    Magnifier tool

Use the Structure view

  1. Open the Structure view Alt07 to get a "10,000-feet" look on a diagram.

    Preview a diagram

    The shadow area represents the visible part of a diagram.

  2. To navigate through the diagram, keep the left mouse button pressed and move the shadow area to obtain the desired view.

Work with source code

Diagrams help you to work with source code in several ways. Right-click the desired node in a diagram and select one of the following actions:

  • Jump to Source F4

    Allows you to jump to a class selected in a diagram.

  • Find Usages AltF7

    Finds usages of a class in a project.

  • Refactor

    Allows you to perform various refactoring actions such as renaming a class or extracting a superclass.

Analyze graph

The Analyze Graph action group lets you analyze the graph in various ways such as perform auto clusterization, measure the node centrality, search cycles, filter path between two nodes, and so on.

Filter paths between two nodes

Most of the time, generated diagrams are big and complicated. Typically, you want to concentrate only on the specific part of the diagram. RubyMine lets you filter paths between two diagram elements.

  1. In the diagram editor, select two nodes on which you want to focus and right-click one of them to open the context menu.

  2. From the context menu, select Analyze Graph | Focus On Paths Between Two Nodes.

    note

    If you want to focus not only on just two nodes, but on how the selected node is connected with its neighbors, select the Focus on Node Neighborhood option from the context menu.

  3. In the dialog that opens, select additional options if needed and click Find.

    the Focus on Paths between Two Nodes dialog

    RubyMine displays connections associated only with the selected nodes.

Measure diagram centrality

You can use this action to identify the important nodes in the graph.

  1. In the diagram editor, right-click anywhere in the editor to open the context menu.

  2. From the context menu, select Analyze Graph | Measure Centrality.

  3. In the dialog that opens, select additional options if needed and click Measure.

    Measure Centrality

    The node "importance" is expressed via fractional value from 0.0 to 1.0 measurement, and the brightest node selection should be explored first.

tip

Press Ctrl0Z to cancel the actions.

Configure diagram settings

To configure default settings for diagrams, open the Settings dialog and go to the Tools | Diagrams page. Here you can configure the diagram layout, specify various options for different kinds of diagrams, and so on.