diff --git a/ale_linters/eruby/erb.vim b/ale_linters/eruby/erb.vim new file mode 100644 index 00000000..5d0b4003 --- /dev/null +++ b/ale_linters/eruby/erb.vim @@ -0,0 +1,25 @@ +" 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_callback': 'ale_linters#eruby#erb#GetCommand', +\ 'callback': 'ale#handlers#ruby#HandleSyntaxErrors', +\}) + diff --git a/ale_linters/eruby/erubis.vim b/ale_linters/eruby/erubis.vim index be9332df..ac356aeb 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/ale_linters/eruby/erubylint.vim b/ale_linters/eruby/erubylint.vim deleted file mode 100644 index 2ff03c32..00000000 --- a/ale_linters/eruby/erubylint.vim +++ /dev/null @@ -1,11 +0,0 @@ -" Author: Matthias Guenther - https://wikimatze.de -" Description: erb-lint for eruby/erb files - -call ale#linter#Define('eruby', { -\ 'name': 'erubylint', -\ 'executable': 'erb', -\ 'output_stream': 'stderr', -\ 'command': 'erb -P -x %t | ruby -c', -\ 'callback': 'ale#handlers#ruby#HandleSyntaxErrors', -\}) - diff --git a/doc/ale-eruby.txt b/doc/ale-eruby.txt index b9cd3cbf..bfbe9ad2 100644 --- a/doc/ale-eruby.txt +++ b/doc/ale-eruby.txt @@ -3,7 +3,7 @@ ALE Eruby Integration *ale-eruby-options* There are two linters for `eruby` files: -- `erubylint` +- `erb` - `erubis` If you don't know which one your project uses, it's probably `erb`. 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/command_callback/test_erubis_command_callback.vader b/test/command_callback/test_erubis_command_callback.vader new file mode 100644 index 00000000..68624ec6 --- /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('')) 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