Skip to content

Configure RubyMine

Note

This guide is written for RubyMine but also applies to IntelliJ Ultimate with the Ruby plugins. IntelliJ offers the same options but some might be located in different places.

Rails

The Rails project root is typically detected automatically. If necessary, right-click on the respective project root and select Mark as… > Ruby Project Root from the context menu.

Tip

You might want to set a custom UNICORN_TIMEOUT as environment variable to a higher value (e.g., 3600 which represents one hour) to avoid timeouts when debugging the application.

Background Services

Many of our services (i.e. the Rails apps) use background services (e.g. Sidekiq for asynchronous background jobs and Msgr for asynchronous event communication). Although there are not too many use cases that require the background services to be running when working on code, it is necessary in specific cases.

When working with overmind this is not an issue as these services are started anyway using the Procfile configuration. For RubyMine, this is different, i.e. the background services need to be run explicitly. Of course, this can be done manually via console, but there is also a possibility to run them via RubyMine, which has the advantage to combine them into a Multirun configuration.

Sidekiq

  1. Go to your Run/Debug Configurations (e.g. click on Edit configurations in the upper bar).
  2. Create a new Gem Command.
  3. Select the correct Working directory for your service.
  4. Select the correct Ruby SDK (typically the project SDK for the service).
  5. Enter/select the Gem name: xikolo-sidekiq (also sidekiq seems to be working).
  6. Enter/select the Executable name: sidekiq.
  7. Switch to the bundler tab of your configuration and check the box Run the script in context of the bundle (bundle exec).
  8. Save your configuration.

Msgr

  1. Follow steps 1. - 4. from above.
  2. Enter/select the Gem name: msgr.
  3. Enter/select the Executable name: msgr.
  4. Switch to the bundler tab of your configuration and check the box Run the script in context of the bundle (bundle exec).
  5. Save your configuration.

“Mark Directory as”

Tip

You might speed up indexing and improve search results by marking some files and folders with their respective use case or exclude them (e.g. logs, node_modules, coverage)

  1. Right-click on the folder to be marked.
  2. Select Mark Directory as….
  3. Select the most-suitable element from the list.

In order to mark single files, you need to jump over to the project settings and add a comma-separated list of files.