summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorEddie Lebow <elebow@users.noreply.github.com>2017-11-11 21:10:03 -0500
committerEddie Lebow <elebow@users.noreply.github.com>2017-11-12 23:33:30 -0500
commitea7f68226ecdc0e6be3d6300c46bc8c88a00c756 (patch)
tree111c50184b5f481918b55f0abe2c25ae798f0293
parente9e29e003c23de2e2499f4c641437021891f9269 (diff)
downloadale-ea7f68226ecdc0e6be3d6300c46bc8c88a00c756.zip
[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.
-rw-r--r--ale_linters/eruby/erb.vim20
-rw-r--r--test/command_callback/test_erb_command_callback.vader21
-rw-r--r--test/ruby_fixtures/valid_rails_app/app/views/my_great_view.html.erb0
3 files changed, 38 insertions, 3 deletions
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
--- /dev/null
+++ b/test/ruby_fixtures/valid_rails_app/app/views/my_great_view.html.erb