From ea7f68226ecdc0e6be3d6300c46bc8c88a00c756 Mon Sep 17 00:00:00 2001 From: Eddie Lebow Date: Sat, 11 Nov 2017 21:10:03 -0500 Subject: [PATCH] [eruby] Add GetCommand to erb 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/erb.vim | 20 +++++++++++++++--- .../test_erb_command_callback.vader | 21 +++++++++++++++++++ .../app/views/my_great_view.html.erb | 0 3 files changed, 38 insertions(+), 3 deletions(-) create mode 100644 test/command_callback/test_erb_command_callback.vader create mode 100644 test/ruby_fixtures/valid_rails_app/app/views/my_great_view.html.erb diff --git a/ale_linters/eruby/erb.vim b/ale_linters/eruby/erb.vim index 18f92b3b..5d0b4003 100644 --- a/ale_linters/eruby/erb.vim +++ b/ale_linters/eruby/erb.vim @@ -1,11 +1,25 @@ -" Author: Matthias Guenther - https://wikimatze.de +" Author: Matthias Guenther - https://wikimatze.de, Eddie Lebow https://github.com/elebow " Description: ERB from the Ruby standard library, for eruby/erb files +function! ale_linters#eruby#erb#GetCommand(buffer) abort + let l:rails_root = ale#ruby#FindRailsRoot(a:buffer) + + if empty(l:rails_root) + return 'erb -P -x %t | ruby -c' + endif + + " Rails-flavored eRuby does not comply with the standard as understood by + " ERB, 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 erb -e ' . ale#Escape('puts ERB.new($stdin.read.gsub(%{<%=},%{<%}), nil, %{-}).src') . ' | ruby -c' +endfunction + call ale#linter#Define('eruby', { \ 'name': 'erb', +\ 'aliases': ['erubylint'], \ 'executable': 'erb', -\ 'output_stream': 'stderr', -\ 'command': 'erb -P -x %t | ruby -c', +\ 'output_stream': 'stderr', +\ 'command_callback': 'ale_linters#eruby#erb#GetCommand', \ 'callback': 'ale#handlers#ruby#HandleSyntaxErrors', \}) diff --git a/test/command_callback/test_erb_command_callback.vader b/test/command_callback/test_erb_command_callback.vader new file mode 100644 index 00000000..2cfff7ed --- /dev/null +++ b/test/command_callback/test_erb_command_callback.vader @@ -0,0 +1,21 @@ +Before: + runtime ale_linters/eruby/erb.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 + \ 'erb -P -x %t | ruby -c', + \ ale_linters#eruby#erb#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 erb -e ' . ale#Escape('puts ERB.new($stdin.read.gsub(%{<%=},%{<%}), nil, %{-}).src') . ' | ruby -c', + \ ale_linters#eruby#erb#GetCommand(bufnr('')) diff --git a/test/ruby_fixtures/valid_rails_app/app/views/my_great_view.html.erb b/test/ruby_fixtures/valid_rails_app/app/views/my_great_view.html.erb new file mode 100644 index 00000000..e69de29b