commit c09d91f76a80269ab99345c9c5ad475de57dc16f Author: Jim Myhrberg Date: Fri Jan 20 22:50:46 2017 +0000 Initial commit diff --git a/README.md b/README.md new file mode 100644 index 0000000..7140c7c --- /dev/null +++ b/README.md @@ -0,0 +1,58 @@ +# rubocopfmt-mode + +Emacs minor-mode to format Ruby code with [rubocopfmt][] on save. + +Core parts of `rubocopfmt-mode` are borrowed from [`go-mode`][go-mode] and it's +invocation of `gofmt`. + +## Installing + +Install [rubocopfmt][]: + +``` +gem install rubocopfmt --pre +``` + +Drop `rubocopfmt.el` somewhere into you `load-path`. I favour the folder +`~/.emacs.d/vendor`: + +``` +(add-to-list 'load-path "~/.emacs.d/vendor") +(require 'rubocopfmt) +``` + +## Usage + +To enable formatting `ruby-mode` buffers with rubocopfmt on save, simply enable +`rubocop-mode` within `ruby-mode` with something like this in your config: + +``` +(add-hook 'ruby-mode-hook #'rubocopfmt-mode) +``` + +You can also toggle `rubocopfmt-mode` on/off with `M-x rubocopfmt-mode`. + +## License + +Copyright (C) 2017 Jim Myhrberg + +Permission is hereby granted, free of charge, to any person obtaining a copy of +this software and associated documentation files (the "Software"), to deal in +the Software without restriction, including without limitation the rights to +use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of +the Software, and to permit persons to whom the Software is furnished to do so, +subject to the following conditions: + +The above copyright notice and this permission notice shall be included in all +copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS +FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR +COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER +IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN +CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. + + +[rubocopfmt]: https://github.com/jimeh/rubocopfmt +[go-mode]: https://github.com/dominikh/go-mode.el diff --git a/rubocopfmt.el b/rubocopfmt.el new file mode 100644 index 0000000..041574d --- /dev/null +++ b/rubocopfmt.el @@ -0,0 +1,159 @@ +;;; rubocopfmt.el --- Format ruby code with rubocopfmt. + +;; Copyright (C) 2017 Jim Myhrberg + +;; Author: Jim Myhrberg +;; Keywords: ruby rubocop rubocopfmt +;; URL: https://github.com/jimeh/rubocopfmt-emacs +;; Version: 0.1.0 + +;; This file is not part of GNU Emacs. + +;;; License: +;; +;; Permission is hereby granted, free of charge, to any person obtaining a +;; copy of this software and associated documentation files (the "Software"), +;; to deal in the Software without restriction, including without limitation +;; the rights to use, copy, modify, merge, publish, distribute, sublicense, +;; and/or sell copies of the Software, and to permit persons to whom the +;; Software is furnished to do so, subject to the following conditions: +;; +;; The above copyright notice and this permission notice shall be included in +;; all copies or substantial portions of the Software. +;; +;; THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +;; IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +;; FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE +;; AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER +;; LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING +;; FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER +;; DEALINGS IN THE SOFTWARE. + +;;; Commentary: +;; +;; The core parts of rubocopfmt.el are borrowed from the gofmt related parts of +;; go-mode.el 1.4.0. So most credit goes to The Go Authors. + +;;; Code: + +(defgroup rubocopfmt nil + "Minor mode for formatting Ruby buffers with rubocopfmt." + :link '(url-link "https://github.com/jimeh/rubocopfmt.el")) + +(defcustom rubocopfmt-command "rubocopfmt" + "The 'rubocopfmt' command." + :type 'string + :group 'rubocopfmt) + +(defun rubocopfmt () + "Format the current buffer with rubocopfmt." + (interactive) + (let ((patchbuf (get-buffer-create "*Rubocopfmt patch*")) + (coding-system-for-read 'utf-8) + (coding-system-for-write 'utf-8) + (rubocopfmt-args + (list "--diff-format" "rcs" + "--src-dir" (file-name-directory (file-truename buffer-file-name))))) + + (unwind-protect + (save-restriction + (widen) + (with-current-buffer patchbuf (erase-buffer)) + (message "Calling rubocopfmt: %s %s" + rubocopfmt-command rubocopfmt-args) + (apply #'call-process-region (point-min) (point-max) + rubocopfmt-command nil patchbuf nil rubocopfmt-args) + (if (= (buffer-size patchbuf) 0) + (message "Buffer is already rubocopfmted") + (progn + (rubocopfmt--apply-rcs-patch patchbuf) + (message "Applied rubocopfmt"))))) + (kill-buffer patchbuf))) + +(defun rubocopfmt--apply-rcs-patch (patch-buffer) + "Apply an RCS-formatted diff from PATCH-BUFFER to the current buffer." + (let ((target-buffer (current-buffer)) + ;; Relative offset between buffer line numbers and line numbers + ;; in patch. + ;; + ;; Line numbers in the patch are based on the source file, so + ;; we have to keep an offset when making changes to the + ;; buffer. + ;; + ;; Appending lines decrements the offset (possibly making it + ;; negative), deleting lines increments it. This order + ;; simplifies the forward-line invocations. + (line-offset 0)) + (save-excursion + (with-current-buffer patch-buffer + (goto-char (point-min)) + (while (not (eobp)) + (unless (looking-at "^\\([ad]\\)\\([0-9]+\\) \\([0-9]+\\)") + (error "invalid rcs patch or internal error in rubocopfmt--apply-rcs-patch")) + (forward-line) + (let ((action (match-string 1)) + (from (string-to-number (match-string 2))) + (len (string-to-number (match-string 3)))) + (cond + ((equal action "a") + (let ((start (point))) + (forward-line len) + (let ((text (buffer-substring start (point)))) + (with-current-buffer target-buffer + (cl-decf line-offset len) + (goto-char (point-min)) + (forward-line (- from len line-offset)) + (insert text))))) + ((equal action "d") + (with-current-buffer target-buffer + (rubocopfmt--goto-line (- from line-offset)) + (cl-incf line-offset len) + (rubocopfmt--delete-whole-line len))) + (t + (error "invalid rcs patch or internal error in rubocopfmt--apply-rcs-patch"))))))))) + +(defun rubocopfmt--delete-whole-line (&optional arg) + "Delete the current line without putting it in the `kill-ring'. +Derived from function `kill-whole-line'. ARG is defined as for that +function." + (setq arg (or arg 1)) + (if (and (> arg 0) + (eobp) + (save-excursion (forward-visible-line 0) (eobp))) + (signal 'end-of-buffer nil)) + (if (and (< arg 0) + (bobp) + (save-excursion (end-of-visible-line) (bobp))) + (signal 'beginning-of-buffer nil)) + (cond ((zerop arg) + (delete-region (progn (forward-visible-line 0) (point)) + (progn (end-of-visible-line) (point)))) + ((< arg 0) + (delete-region (progn (end-of-visible-line) (point)) + (progn (forward-visible-line (1+ arg)) + (unless (bobp) + (backward-char)) + (point)))) + (t + (delete-region (progn (forward-visible-line 0) (point)) + (progn (forward-visible-line arg) (point)))))) + +(defun rubocopfmt--goto-line (line) + (goto-char (point-min)) + (forward-line (1- line))) + +;;;###autoload +(define-minor-mode rubocopfmt-mode + "Enable format-on-save for `ruby-mode' buffers via rubocopfmt." + :lighter " fmt" + (if rubocopfmt-mode + (add-hook 'before-save-hook 'rubocopfmt-before-save t t) + (remove-hook 'before-save-hook 'rubocopfmt-before-save t))) + +(defun rubocopfmt-before-save () + "Format buffer via rubocopfmt if major mode is `ruby-mode'." + (interactive) + (when (eq major-mode 'ruby-mode) (rubocopfmt))) + +(provide 'rubocopfmt) +;;; rubocopfmt.el ends here