Ruby layer

• Version manager (rbenv, rvm or chruby)
• Integration with bundler
• Test runner (ruby-test and rspec)
• Rake runner
• Linter (rubocop)
• Formatter (prettier)
• Interactive REPL and code navigation (robe)
• Interactive debugger using dap-mode

To choose a default backend set the layer variable ruby-backend:

(ruby :variables ruby-backend 'robe)

Alternatively the lsp backend will be automatically chosen if the layer lsp is used and you did not specify any value for ruby-backend.

Backend can be chosen on a per project basis using directory local variables (files named .dir-locals.el at the root of a project), an example to use the lsp backend:

;;; Directory Local Variables
;;; For more information see (info "(emacs) Directory Variables")

((ruby-mode (ruby-backend . lsp)))

Note: you can easily add a directory local variable with SPC f v d.

Some of the advanced features supported by this layer depend on external gems that need to be installed in the context of your project (see below for guidance based on your version manager):

• pry and pry-doc are required for jump to definition and code documentation (robe-mode)
• ruby_parser is required for goto-step_definition in feature-mode
• rubocop is required for rubocop integration
• prettier is required for formatter
• solargraph is required for using the language server protocol in ruby-mode

You can install the gems in the context of your current project by adding them to the Gemfile, e.g.:

gem 'pry'

or on the command line (please refer to your ruby version manager specific documentation for details and caveats):

gem install pry

This layer supports RVM, Rbenv, and Chruby. You can choose the default version manager by setting the variable ruby-version-manager in your dotfile, for example:

(defun dotspacemacs-configuration-layers ()
   '((ruby :variables ruby-version-manager 'rvm)))

When a version manager is enabled it will use the currently activated ruby except if a .ruby-version file exists in which case the ruby version of this file is used. rvm will also try to look for a .rvmrc and gemfile, the priority order is .rvmrc then .ruby-version then gemfile.

Note: Only one version manager at a time can be enabled.

This layer supports RSpec, ruby-test and minitest test runners (frameworks). By default ruby-test is used, to change to another frameworks set the layer variable ruby-test-runner.

Example to set the test runner to RSpec:

(defun dotspacemacs-configuration-layers ()
   '((ruby :variables ruby-test-runner 'rspec)))

Tip: You can enable different test runners for different projects by using directory local variables.

If you'd like to use prettier/plugin-ruby to format on save:

(defun dotspacemacs-configuration-layers ()
   '((ruby :variables ruby-prettier-on-save t)))

Note that the prettier binary must be available in the project's node_modules/.bin/ or on exec-path.

Using the dap layer you'll get access to all the DAP key bindings, see the complete list of key bindings on the dap layer description.

Note that ruby-mode and enh-ruby-mode will automatically insert the encoding comment # coding: utf-8 at the top of a `.rb file, if it contains UTF-8 characters. This might not be desired in Ruby 2.0+, since UTF-8 has become the default encoding. In fact, this will trigger an error with Robocop.

The fix is to set the variable ruby-insert-encoding-magic-comment (ruby-mode) or enh-ruby-add-encoding-comment-on-save (enh-ruby-mode) to nil, e.g.

(defun dotspacemacs-configuration-layers ()
   '((ruby :variables ruby-insert-encoding-magic-comment nil)))