RubyMine 5.4.3 Web Help

2.0+

The Extract Constant refactoring makes your source code easier to read and maintain. It also helps you avoid using hard coded constants without any explanations about their values or purpose.

Example

BeforeAfter
 a = 1
 result = foo(a)*123
 if some_cond
         a = a + result
         else a = a - result
 end
              
    a = 1
    result = foo(a)*FIXNUM
    FIXNUM = 123
    if some_cond
        a = a + result
        else a = a - result
    end
              
class Person
   def greet()
       puts "Mr. #{'Bob'}  greets you!"
   end
end
              
class Person
       BOB = 'Bob'
       def greet()
            puts "Mr. #{BOB}  greets you!"
       end
end
To extract a Ruby constant in-place

The in-place refactorings are enabled in RubyMine by default. So, if you haven't changed this setting, the Extract Constant refactoring for Ruby is performed in-place, right in the editor:

  1. Place the cursor within the expression or declaration of a variable to be replaced by a constant.
  2. Do one of the following:
    • Press Ctrl+Alt+CCtrl+Alt+CCtrl+Alt+CCtrl+Alt+CCtrl+Alt+CCtrl+Alt+CAlt+Shift+CCtrl+Alt+CCtrl+Alt+CMeta Alt CMeta Alt CMeta Alt CMeta Alt C.
    • Choose Refactor | Extract Constant in the main menu, or on the context menu.
  3. If more than one expression is detected for the current cursor position, the Expressions list appears. If this is the case, select the required expression. To do that, click the expression. Alternatively, use the Up and Down arrow keys to navigate to the expression of interest, and then press EnterEnterEnterEnterEnterEnterEnterEnterEnterEnterEnterEnterEnter to select it.
  4. If more than one occurrence of the expression is found within the class, specify whether you wish to replace only the selected occurrence, or all the found occurrences with the new constant:
  5. Specify the name of the constant. Select the name from the list or type the name in the box with a red border.
  6. To complete the refactoring, press TabTabTabTabTabTabTabTabTab or Meta+Close BracketTabTabTabTab or EnterEnterEnterEnterEnterEnterEnterEnterEnterEnterEnterEnterEnter.

    If you haven't completed the refactoring and want to cancel the changes you have made, press EscapeEscapeEscapeEscapeEscape, Escape or Ctrl+GEscapeEscapeEscapeEscapeEscapeEscapeEscapeEscape.

    Note that sometimes you may need to press the corresponding key more than once.

To extract a constant using the dialog box

If the Enable in place refactorings check box is cleared on the Editor settings, the Extract Constant refactoring is performed by means of the Extract Constant Dialog dialog box.

enableInplaceRefactoringCleared

  1. In the Extract Constant Dialog dialog that opens, specify the name of the new constant.
  2. To automatically replace all occurrences of the selected expression (if it is found more than once), select the option Replace all occurrences.
  3. Click OK to create the constant.

See Also

Reference:

Web Resources: