This repository has been archived on 2024-10-22. You can view files and clone it, but cannot push or open issues or pull requests.
spacemacs/layers/+lang/ruby/funcs.el

168 lines
4.7 KiB
EmacsLisp
Raw Blame History

This file contains invisible Unicode characters

This file contains invisible Unicode characters that are indistinguishable to humans but may be processed differently by a computer. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

;;; funcs.el --- Ruby Layer functions File
;;
;; Copyright (c) 2012-2021 Sylvain Benner & Contributors
;;
;; Author: Sylvain Benner <sylvain.benner@gmail.com>
;; URL: https://github.com/syl20bnr/spacemacs
;;
;; This file is not part of GNU Emacs.
;;
;; This program is free software; you can redistribute it and/or modify
;; it under the terms of the GNU General Public License as published by
;; the Free Software Foundation, either version 3 of the License, or
;; (at your option) any later version.
;;
;; This program is distributed in the hope that it will be useful,
;; but WITHOUT ANY WARRANTY; without even the implied warranty of
;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
;; GNU General Public License for more details.
;;
;; You should have received a copy of the GNU General Public License
;; along with this program. If not, see <http://www.gnu.org/licenses/>.
;; backend
(defun spacemacs//ruby-setup-backend ()
"Conditionally configure Ruby backend"
(spacemacs//ruby-setup-version-manager)
(pcase ruby-backend
('lsp (spacemacs//ruby-setup-lsp))
('robe (spacemacs//ruby-setup-robe))))
(defun spacemacs//ruby-setup-company ()
"Configure backend company"
;; Company is automatically set up by lsp
(when (eq ruby-backend 'robe)
(spacemacs//ruby-setup-robe-company)))
(defun spacemacs//ruby-setup-dap ()
"Conditionally setup elixir DAP integration."
;; currently DAP is only available using LSP
(when (eq ruby-backend 'lsp)
(spacemacs//ruby-setup-lsp-dap)))
;; lsp
(defun spacemacs//ruby-setup-lsp ()
"Setup Ruby lsp."
(if (configuration-layer/layer-used-p 'lsp)
(lsp-deferred)
(message "`lsp' layer is not installed, please add `lsp' layer to your dotfile.")))
(defun spacemacs//ruby-setup-lsp-dap ()
"Setup DAP integration."
(require 'dap-ruby))
;; robe
(defun spacemacs//ruby-setup-robe ()
(robe-mode))
(defun spacemacs//ruby-setup-robe-company ()
"Setup robe auto-completion."
(when (configuration-layer/package-used-p 'robe)
(spacemacs|add-company-backends
:backends company-robe
:modes ruby-mode enh-ruby-mode))
(with-eval-after-load 'company-dabbrev-code
(dolist (mode '(ruby-mode enh-ruby-mode))
(add-to-list 'company-dabbrev-code-modes mode))))
;; version manager
(defun spacemacs//ruby-setup-version-manager ()
"Setup ruby version manager."
(when (eq ruby-version-manager 'rbenv)
(spacemacs//enable-rbenv)))
;; rbenv
(defun spacemacs//enable-rbenv ()
"Enable rbenv, use .ruby-version if exists."
(require 'rbenv)
(let ((version-file-path (rbenv--locate-file ".ruby-version")))
(global-rbenv-mode)
;; try to use the ruby defined in .ruby-version
(if version-file-path
(progn
(rbenv-use (rbenv--read-version-from-file
version-file-path))
(message (concat "[rbenv] Using ruby version "
"from .ruby-version file.")))
(message "[rbenv] Using the currently activated ruby."))))
;; rspec
(defun spacemacs//ruby-enable-rspec-mode ()
"Conditionally enable `rspec-mode'"
(when (eq 'rspec ruby-test-runner)
(rspec-enable-appropriate-mode)))
(defun ruby/rspec-verify-directory (dir)
"Launch tests in DIR directory.
Called interactively it prompts for a directory."
(interactive "Drspec directory: ")
(rspec-run-single-file dir (rspec-core-options)))
(defun spacemacs//inf-ruby-auto-enter ()
"Automatically enters inf-ruby-mode in ruby modes' debugger breakpoints."
(add-hook 'compilation-filter-hook 'inf-ruby-auto-enter nil t))
;; ruby-test
(defun spacemacs//ruby-enable-ruby-test-mode ()
"Conditionally enable `ruby-test-mode'"
(when (eq 'ruby-test ruby-test-runner)
(ruby-test-mode)))
;; minitest
(defun spacemacs//ruby-enable-minitest-mode ()
"Conditionally enable `minitest-mode'"
(when (eq 'minitest ruby-test-runner)
(minitest-enable-appropriate-mode)))
;; highlight debugger keywords
(defun spacemacs/ruby-maybe-highlight-debugger-keywords ()
"Highlight break point lines."
(interactive)
(when ruby-highlight-debugger-keywords
(highlight-lines-matching-regexp "byebug")
(highlight-lines-matching-regexp "binding.irb")
(highlight-lines-matching-regexp "binding.pry")))
;; Insert text
(defun spacemacs/ruby-insert-frozen-string-literal-comment ()
(interactive)
(save-excursion
(goto-char (point-min))
(insert "# frozen_string_literal: true\n")))
(defun spacemacs/ruby-insert-shebang ()
(interactive)
(save-excursion
(goto-char (point-min))
(insert "#!/usr/bin/env ruby\n")))
;; Prettier
(defun spacemacs/ruby-format ()
(interactive)
(call-interactively 'prettier-js))
(defun spacemacs/ruby-fmt-before-save-hook ()
(add-hook 'before-save-hook 'spacemacs/ruby-format t t))