summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorLynn Dylan Hurley <lynn.dylan.hurley@gmail.com>2017-06-25 14:04:14 -0500
committerw0rp <w0rp@users.noreply.github.com>2017-06-25 20:04:14 +0100
commit7f6e5dc65b9275d9a1a9905e11e990dc90b9e328 (patch)
tree6f3b4f41e50d3c9a1634bdc98297a4f756d9dae3
parent7d73a1602b80e31f87abecf6c76ff9c1e117771a (diff)
downloadale-7f6e5dc65b9275d9a1a9905e11e990dc90b9e328.zip
Add ruby fixer using `rubocop --auto-correct` (#689)
* add ruby fixer for `rubocop --auto-correct`
-rw-r--r--autoload/ale/fix/registry.vim5
-rw-r--r--autoload/ale/fixers/rubocop.vim31
-rw-r--r--test/command_callback/ruby_paths/dummy.rb0
-rw-r--r--test/fixers/test_rubocop_fixer_callback.vader28
4 files changed, 64 insertions, 0 deletions
diff --git a/autoload/ale/fix/registry.vim b/autoload/ale/fix/registry.vim
index 05126fff..020946fb 100644
--- a/autoload/ale/fix/registry.vim
+++ b/autoload/ale/fix/registry.vim
@@ -42,6 +42,11 @@ let s:default_registry = {
\ 'suggested_filetypes': ['python'],
\ 'description': 'Fix Python files with yapf.',
\ },
+\ 'rubocop': {
+\ 'function': 'ale#fixers#rubocop#Fix',
+\ 'suggested_filetypes': ['ruby'],
+\ 'description': 'Fix ruby files with rubocop --auto-correct.',
+\ },
\}
" Reset the function registry to the default entries.
diff --git a/autoload/ale/fixers/rubocop.vim b/autoload/ale/fixers/rubocop.vim
new file mode 100644
index 00000000..7bc6c9e6
--- /dev/null
+++ b/autoload/ale/fixers/rubocop.vim
@@ -0,0 +1,31 @@
+" Set this option to change Rubocop options.
+if !exists('g:ale_ruby_rubocop_options')
+ " let g:ale_ruby_rubocop_options = '--lint'
+ let g:ale_ruby_rubocop_options = ''
+endif
+
+if !exists('g:ale_ruby_rubocop_executable')
+ let g:ale_ruby_rubocop_executable = 'rubocop'
+endif
+
+function! ale#fixers#rubocop#GetExecutable(buffer) abort
+ return ale#Var(a:buffer, 'ruby_rubocop_executable')
+endfunction
+
+function! ale#fixers#rubocop#GetCommand(buffer) abort
+ let l:executable = ale#Var(a:buffer, 'ruby_rubocop_executable')
+ let l:exec_args = l:executable =~? 'bundle$'
+ \ ? ' exec rubocop'
+ \ : ''
+
+ return ale#Escape(l:executable) . l:exec_args
+ \ . ' --auto-correct %t'
+
+endfunction
+
+function! ale#fixers#rubocop#Fix(buffer) abort
+ return {
+ \ 'command': ale#fixers#rubocop#GetCommand(a:buffer),
+ \ 'read_temporary_file': 1,
+ \}
+endfunction
diff --git a/test/command_callback/ruby_paths/dummy.rb b/test/command_callback/ruby_paths/dummy.rb
new file mode 100644
index 00000000..e69de29b
--- /dev/null
+++ b/test/command_callback/ruby_paths/dummy.rb
diff --git a/test/fixers/test_rubocop_fixer_callback.vader b/test/fixers/test_rubocop_fixer_callback.vader
new file mode 100644
index 00000000..e9352e73
--- /dev/null
+++ b/test/fixers/test_rubocop_fixer_callback.vader
@@ -0,0 +1,28 @@
+Before:
+ Save g:ale_ruby_rubocop_executable
+
+ " Use an invalid global executable, so we don't match it.
+ let g:ale_ruby_rubocop_executable = 'xxxinvalid'
+
+ silent! execute 'cd /testplugin/test/command_callback'
+ silent cd ..
+ silent cd command_callback
+ let g:dir = getcwd()
+
+After:
+ Restore
+
+ silent execute 'cd ' . fnameescape(g:dir)
+ " Set the file to something else,
+ " or we'll cause issues when running other tests
+ silent file 'dummy.rb'
+ unlet! g:dir
+
+Execute(The rubocop callback should return the correct default values):
+ silent execute 'file ' . fnameescape(g:dir . '/ruby_paths/dummy.rb')
+
+ AssertEqual
+ \ {'read_temporary_file': 1,
+ \ 'command': "'" . g:ale_ruby_rubocop_executable . "' "
+ \ . '--auto-correct %t' },
+ \ ale#fixers#rubocop#Fix(bufnr(''))