From 783949810855556dd12ed2685e62fb37a4c9504d Mon Sep 17 00:00:00 2001
From: Kevin Robayna <me@kevinrobayna.com>
Date: Fri, 19 Jul 2024 10:09:57 +0100
Subject: [PATCH] feat(extras): improve ruby extra by letting user chose
 (#3652)

## What is this PR for?

Shopify started working on its own LSP
(https://github.com/Shopify/ruby-lsp) and it performs way better than
Solargraph which has a lot of limitations. This paired with sorbet gives
better IntelliSense when navigating the code.

This PR follows the same approach as Python and lets the user configure
through vim.g options the lsp and formatter for ruby, without overriding
any configuration.

## Does this PR fix an existing issue?

One caveat though is that RubyLsp does not work very well with NeoVim <
0.10 https://github.com/Shopify/ruby-lsp/blob/main/EDITORS.md#neovim

## Checklist

- [x] I've read the
[CONTRIBUTING](https://github.com/LazyVim/LazyVim/blob/main/CONTRIBUTING.md)
guidelines.
---
 lua/lazyvim/plugins/extras/lang/ruby.lua | 43 +++++++++++++++++++++++-
 1 file changed, 42 insertions(+), 1 deletion(-)

diff --git a/lua/lazyvim/plugins/extras/lang/ruby.lua b/lua/lazyvim/plugins/extras/lang/ruby.lua
index c70e645d..6eb4fce5 100644
--- a/lua/lazyvim/plugins/extras/lang/ruby.lua
+++ b/lua/lazyvim/plugins/extras/lang/ruby.lua
@@ -1,3 +1,17 @@
+if lazyvim_docs then
+  -- LSP Server to use for Ruby.
+  -- Set to "solargraph" to use solargraph instead of ruby_lsp.
+  vim.g.lazyvim_ruby_lsp = "ruby_lsp"
+  vim.g.lazyvim_ruby_formatter = "rubocop"
+end
+
+local lsp = vim.g.lazyvim_ruby_lsp or "ruby_lsp"
+if vim.fn.has("nvim-0.10") == 0 then
+  -- ruby_lsp does not work well with Neovim < 0.10
+  lsp = vim.g.lazyvim_ruby_lsp or "solargraph"
+end
+local formatter = vim.g.lazyvim_ruby_formatter or "rubocop"
+
 return {
   recommended = function()
     return LazyVim.extras.wants({
@@ -11,12 +25,29 @@ return {
   },
   {
     "neovim/nvim-lspconfig",
+    ---@class PluginLspOpts
     opts = {
+      ---@type lspconfig.options
       servers = {
-        solargraph = {},
+        ruby_lsp = {
+          enabled = lsp == "ruby_lsp",
+        },
+        solargraph = {
+          enabled = lsp == "solargraph",
+        },
+        rubocop = {
+          enabled = formatter == "rubocop",
+        },
+        standardrb = {
+          enabled = formatter == "standardrb",
+        },
       },
     },
   },
+  {
+    "williamboman/mason.nvim",
+    opts = { ensure_installed = { "erb-formatter", "erb-lint" } },
+  },
   {
     "mfussenegger/nvim-dap",
     optional = true,
@@ -27,6 +58,16 @@ return {
       end,
     },
   },
+  {
+    "stevearc/conform.nvim",
+    optional = true,
+    opts = {
+      formatters_by_ft = {
+        ruby = { formatter },
+        eruby = { "erb-format" },
+      },
+    },
+  },
   {
     "nvim-neotest/neotest",
     optional = true,