Rename refactorings allow you to rename symbols and files with all the references to them in the code corrected automatically.
The following rename refactorings are available in RubyMine:
- Ruby scripts. Renaming in Ruby scripts applies to all symbols and propagates changes to all their usages across the project.
- Ruby classes. Results of renaming a Ruby class depends on the place of invocation and on the containing file name. First, if a Ruby class has been created from a template, the containing file name matches the specified class name. Thus, renaming a Ruby class from the editor results in generating the new file name according to the Ruby naming conventions. If the name of a containing file doesn't match class name, only the class and its usages are renamed.
Second, if rename refactoring is invoked from the Project tool window, only file name will be changed; the name of the contained class will be left intact.
- Components of Rails applications. Renaming in Rails applications applies to the application elements (classes, controllers, actions, helpers, tests, views) and their usages. It is advisable to use the Rails View of the Project tool window, or the editor, to rename elements of the Rails applications.
Rename refactoring in Rails applications has certain subtleties mentioned below:
- On renaming an action or a view template, all associated entities are renamed, including tests. However, on renaming a test, its related entities are not renamed.
- When renaming, keep in mind that the new name should meet Rails naming conventions; otherwise the name will not be properly recognized. It means that when you rename, for example,
YourController, you only have to change
Your, leaving the
- On renaming a controller or view, its usages in an RSpec test will only be renamed if the options Search in comments and strings is enabled.
- When renaming Rails models, all usages are renamed too: the underlying files, classes, test classes and fixtures. RubyMine creates a migration with the instruction to rename the corresponding table. When a field in a model is renamed, RubyMine creates a migration with the instruction to rename the corresponding column in a table, and its foreign key, if any.
- Named scopes. So doing, the lines of code where the renamed scope is called as a method, are also renamed.
- Sass selector
- Rename Method. The following usages are renamed:
- All calls of the method.
- All overridden/implemented methods in subclasses.
- Rename Field.
- Rename Function.
- Rename Variable.
- Rename Parameter. The following usages are renamed:
- All usages of the parameter.
- The corresponding
paramtag in documentation comment.
- Rename CSS color value.
- Rename File.
- Rename Directory.
Renaming Ruby/Rails symbols
This feature is only supported when the Ruby plugin is installed.
|Renaming Ruby class with the matching file name|
| || |
|Renaming Rails method|
| || |
|Renaming Rails model|
The following symbols should be renamed:
As a result of performing the Rename refactoring, RubyMine creates a migration. Execute the migration to have the following symbols actually renamed:
|Renaming a scope and its usages|
| || |
Renaming a symbol
To rename a symbol, follow these general steps
- Select the item to be renamed.
- To select a file, click the desired file in the Project Tool Window.
- To select a symbol in the editor, place the caret at the name of the symbol to be renamed.
- To select a symbol in the Project Tool Window, make sure that the members are shown, and then click the desired symbol.
- To select a symbol in the Structure view, click the desired symbol in the Structure tool window.
- Choose on the main menu or on the context menu, or press Shift+F6.
- The subsequent behavior depends on the checkbox Enable in-place mode (Settings/Preferences dialog, Editor).
- If this checkbox is selected, the suggested name appears right below the symbol in question. You can either accept suggestion, or type a new name. However, if you press Shift+F6 once more, RubyMine will display the Rename dialog box with more options.
- If this checkbox is not selected, the Rename dialog box opens immediately.
The set of controls and their names depend on the type of the symbol to be renamed.
- Preview and apply changes.
Renaming a file or directory
To rename a file or directory
- Select a desired file in the Project tool window.
- Choose on the main or context menu or press Shift+F6.
- In Rename File dialog box that opens, specify the new file name. Select Search in comments and strings checkbox to let RubyMine apply changes to comments and strings.
Press Preview to observe possible changes in Find Tool Window. Press Refactor to proceed.RubyMine finds all the occurrences of the file name and changes them respectively.
- Local variables are renamed in-place.
To be able to use the Rename dialog when renaming local variables, you should disable in-place refactoring in the editor settings.