railroads

Railroads is a plugin for RubyMine that lists rails routes results and transitions to files.

There was a great plugin called Railways that I loved very much. However, since IDE version 2023.3, it is no longer available for installation, so I created this plugin.

Features

• Displays routes of Ruby on Rails application/engine in a separate "Railroads" panel
• The listed path and name can be copied from the context menu
• Provides quick routes filtering by route path, controller/action or route name

Unsupported Features

• IDE versions earlier than 2023.2.* .
  • if you want to use that version, please use the Railways plugin.
  • for ease of feature comparison with Railways, 2023.2.* is supported at this time. However, if Railroads finds it difficult to support 2023.2.* in the future, it may no longer do so.
• Old format output from rails routes
  • for example, the format of the following test data from Railways
    • https://github.com/basgren/railways/blob/master/test/data/parserTest_1.txt
  • because there is no environment that can output the old format

Compatibility

• Railroads version 0.2.* and earlier
  • Supports IDE versions from 2023.3.* up to 2024.*
• Railroads version 0.3.* and later
  • Supports IDE versions 2024.2.* and later

TODOs

• Run rails routes when ToolWindow is opened.
• Caching of rails routes results.
• Customize environment, task names, etc.
• Navigation in the code editor.
• Highlight when narrowing down the path.
• Add test code.

Screenshot

Installation

• Using the IDE built-in plugin system:

  Settings/Preferences > Plugins > Marketplace > Search for "railroads" > Install

• Manually:

  Download the latest release and install it manually using Settings/Preferences > Plugins > ⚙️ > Install plugin from disk...

IntelliJ IDEA Ultimate settings for development

• Open IntelliJ IDEA.
• Select File > New > Project from Version Control .
• Set URL is this repository, and Click Clone .
• Open Project Structure and Select Platform Settings > SDKs .
• Set JDK path.
  • example
    • Windows + RubyMine's JBR: C:\Users\<UserName>\AppData\Local\JetBrains\Toolbox\apps\RubyMine\ch-0\233.14808.14\jbr
    • macOS + RubyMine's JBR: /Library/Java/JavaVirtualMachines/jbrsdk-21.0.6-osx-aarch64-b895.109/Contents/Home
• Select Project Settings > Project .
• Set the following values, and click OK .
  • Name: railroads
  • SDK: Select the JDK configured above
  • Language Level: SDK default
• Rename local.properties.examples to local.properties .
• Open local.properties and Set ideDir .
• Select Run > Run Plugin, and The IDE with Railroads plugin will start.

License

see LICENSE file.

---

Plugin based on the IntelliJ Platform Plugin Template.