From e9e29e003c23de2e2499f4c641437021891f9269 Mon Sep 17 00:00:00 2001 From: Eddie Lebow Date: Sat, 11 Nov 2017 20:52:16 -0500 Subject: [PATCH 1/3] =?UTF-8?q?[eruby]=20Rename=20`erubylint`=20=E2=86=92?= =?UTF-8?q?=20`erb`=20to=20match=20tool=20name?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- ale_linters/eruby/{erubylint.vim => erb.vim} | 4 ++-- doc/ale-eruby.txt | 2 +- 2 files changed, 3 insertions(+), 3 deletions(-) rename ale_linters/eruby/{erubylint.vim => erb.vim} (73%) diff --git a/ale_linters/eruby/erubylint.vim b/ale_linters/eruby/erb.vim similarity index 73% rename from ale_linters/eruby/erubylint.vim rename to ale_linters/eruby/erb.vim index 2ff03c32..18f92b3b 100644 --- a/ale_linters/eruby/erubylint.vim +++ b/ale_linters/eruby/erb.vim @@ -1,8 +1,8 @@ " Author: Matthias Guenther - https://wikimatze.de -" Description: erb-lint for eruby/erb files +" Description: ERB from the Ruby standard library, for eruby/erb files call ale#linter#Define('eruby', { -\ 'name': 'erubylint', +\ 'name': 'erb', \ 'executable': 'erb', \ 'output_stream': 'stderr', \ 'command': 'erb -P -x %t | ruby -c', 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`. From ea7f68226ecdc0e6be3d6300c46bc8c88a00c756 Mon Sep 17 00:00:00 2001 From: Eddie Lebow Date: Sat, 11 Nov 2017 21:10:03 -0500 Subject: [PATCH 2/3] [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 From ad7ea3630758af51f6be826fcd453dfc42a6cd75 Mon Sep 17 00:00:00 2001 From: Eddie Lebow Date: Sat, 11 Nov 2017 21:59:18 -0500 Subject: [PATCH 3/3] [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 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/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(''))