From ad7ea3630758af51f6be826fcd453dfc42a6cd75 Mon Sep 17 00:00:00 2001 From: Eddie Lebow Date: Sat, 11 Nov 2017 21:59:18 -0500 Subject: [PATCH] [eruby] Add GetCommand to erubis linter GetCommand conditionally adds a filter (implemented as inline Ruby code in the command line) to transform some of the problematic Rails-specific eRuby syntax. Specifically, <%= tags are replaced with <%. This does not reduce the effectiveness of the linter, because the transformed code is still evaluated. This solution was suggested by @rgo at https://github.com/w0rp/ale/issues/580#issuecomment-337676607. --- ale_linters/eruby/erubis.vim | 18 +++++++++++++--- .../test_erubis_command_callback.vader | 21 +++++++++++++++++++ 2 files changed, 36 insertions(+), 3 deletions(-) create mode 100644 test/command_callback/test_erubis_command_callback.vader diff --git a/ale_linters/eruby/erubis.vim b/ale_linters/eruby/erubis.vim index be9332d..ac356ae 100644 --- a/ale_linters/eruby/erubis.vim +++ b/ale_linters/eruby/erubis.vim @@ -1,11 +1,23 @@ -" Author: Jake Zimmerman +" Author: Jake Zimmerman , Eddie Lebow https://github.com/elebow " Description: eruby checker using `erubis`, instead of `erb` +function! ale_linters#eruby#erubis#GetCommand(buffer) abort + let l:rails_root = ale#ruby#FindRailsRoot(a:buffer) + + if empty(l:rails_root) + return 'erubis -x %t | ruby -c' + endif + + " Rails-flavored eRuby does not comply with the standard as understood by + " Erubis, so we'll have to do some substitution. This does not reduce the + " effectiveness of the linter—the translated code is still evaluated. + return 'ruby -r erubis -e ' . ale#Escape('puts Erubis::Eruby.new($stdin.read.gsub(%{<%=},%{<%})).src') . ' | ruby -c' +endfunction + call ale#linter#Define('eruby', { \ 'name': 'erubis', \ 'executable': 'erubis', \ 'output_stream': 'stderr', -\ 'command': 'erubis -x %t | ruby -c', +\ 'command_callback': 'ale_linters#eruby#erubis#GetCommand', \ 'callback': 'ale#handlers#ruby#HandleSyntaxErrors', \}) - diff --git a/test/command_callback/test_erubis_command_callback.vader b/test/command_callback/test_erubis_command_callback.vader new file mode 100644 index 0000000..68624ec --- /dev/null +++ b/test/command_callback/test_erubis_command_callback.vader @@ -0,0 +1,21 @@ +Before: + runtime ale_linters/eruby/erubis.vim + call ale#test#SetDirectory('/testplugin/test/command_callback') + +After: + call ale#linter#Reset() + call ale#test#RestoreDirectory() + +Execute(Executable should not contain any filter code by default): + call ale#test#SetFilename('../ruby_fixtures/not_a_rails_app/file.rb') + + AssertEqual + \ 'erubis -x %t | ruby -c', + \ ale_linters#eruby#erubis#GetCommand(bufnr('')) + +Execute(Executable should filter invalid eRuby when inside a Rails project): + call ale#test#SetFilename('../ruby_fixtures/valid_rails_app/app/views/my_great_view.html.erb') + + AssertEqual + \ 'ruby -r erubis -e ' . ale#Escape('puts Erubis::Eruby.new($stdin.read.gsub(%{<%=},%{<%})).src') . ' | ruby -c', + \ ale_linters#eruby#erubis#GetCommand(bufnr(''))