From ff6bfc3d374706ab80d3dc40a4d3a15baffa8ad2 Mon Sep 17 00:00:00 2001
From: NiBo <nibocn@gmail.com>
Date: Mon, 18 May 2020 17:35:16 +0800
Subject: [PATCH] refactor(javac): ale_java_javac_sourcepath variable supports
 String and List types

---
 ale_linters/java/javac.vim                    | 17 +++-
 doc/ale-java.txt                              | 27 ++++--
 .../build/gen/main/java/com/something/dummy   |  0
 .../build/gen2/main/java/com/something/dummy  |  0
 .../test_javac_command_callback.vader         | 86 +++++++++++++++++++
 5 files changed, 117 insertions(+), 13 deletions(-)
 create mode 100644 test/command_callback/java_paths/build/gen/main/java/com/something/dummy
 create mode 100644 test/command_callback/java_paths/build/gen2/main/java/com/something/dummy

diff --git a/ale_linters/java/javac.vim b/ale_linters/java/javac.vim
index 928f555f..5ea40026 100644
--- a/ale_linters/java/javac.vim
+++ b/ale_linters/java/javac.vim
@@ -80,11 +80,20 @@ function! ale_linters#java#javac#GetCommand(buffer, import_paths, meta) abort
         endif
     endif
 
-    let l:sourcepath_item = ale#Var(a:buffer, 'java_javac_sourcepath')
+    let l:source_paths = []
+    let l:source_path = ale#Var(a:buffer, 'java_javac_sourcepath')
 
-    if !empty(l:sourcepath_item)
-        for l:sourcepath in l:sourcepath_item
-            let l:sp_path = ale#path#FindNearestDirectory(a:buffer, l:sourcepath)
+    if !empty(l:source_path) && type(l:source_path) is v:t_string
+        let l:source_paths = split(l:source_path, s:classpath_sep)
+    endif
+
+    if !empty(l:source_path) && type(l:source_path) is v:t_list
+        let l:source_paths = l:source_path
+    endif
+
+    if !empty(l:source_paths)
+        for l:path in l:source_paths
+            let l:sp_path = ale#path#FindNearestDirectory(a:buffer, l:path)
 
             if !empty(l:sp_path)
                 call add(l:sp_dirs, l:sp_path)
diff --git a/doc/ale-java.txt b/doc/ale-java.txt
index ea426f0d..3016aede 100644
--- a/doc/ale-java.txt
+++ b/doc/ale-java.txt
@@ -69,18 +69,27 @@ g:ale_java_javac_options                             *g:ale_java_javac_options*
 
 g:ale_java_javac_sourcepath                       *g:ale_java_javac_sourcepath*
                                                   *b:ale_java_javac_sourcepath*
-  Type: |List|
+  Type: |String| or |List|
   Default: `[]`
 
-  This variable can set multiple source code paths, the source code path is a
-  relative path (relative to the project root directory).
+This variable can set multiple source code paths, the source code path is a
+relative path (relative to the project root directory).
 
-  Example:
-  >
-    let g:ale_java_javac_sourcepath = [
-      \ 'build/generated/source/querydsl/main',
-      \ 'target/generated-sources/source/querydsl/main'
-    \ ]
+Example:
+
+String type:
+Note that the unix system separator is a colon(`:`) window system
+is a semicolon(`;`).
+>
+  let g:ale_java_javac_sourcepath = 'build/gen/source/xx/main:build/gen/source'
+<
+List type:
+>
+  let g:ale_java_javac_sourcepath = [
+    \ 'build/generated/source/querydsl/main',
+    \ 'target/generated-sources/source/querydsl/main'
+  \ ]
+<
 
 
 ===============================================================================
diff --git a/test/command_callback/java_paths/build/gen/main/java/com/something/dummy b/test/command_callback/java_paths/build/gen/main/java/com/something/dummy
new file mode 100644
index 00000000..e69de29b
diff --git a/test/command_callback/java_paths/build/gen2/main/java/com/something/dummy b/test/command_callback/java_paths/build/gen2/main/java/com/something/dummy
new file mode 100644
index 00000000..e69de29b
diff --git a/test/command_callback/test_javac_command_callback.vader b/test/command_callback/test_javac_command_callback.vader
index 42c64e54..7e612ae2 100644
--- a/test/command_callback/test_javac_command_callback.vader
+++ b/test/command_callback/test_javac_command_callback.vader
@@ -108,6 +108,92 @@ Execute(The javac callback should combine discovered classpaths and manual ones)
   \   . ' -d ' . ale#Escape('TEMP_DIR') . ' %t',
   \ substitute(b:command, '%e', '\=ale#Escape(''javac'')', 'g')
 
+Execute(The javac callback should use string type g:ale_java_javac_sourcepath correctly):
+  let g:ale_java_javac_sourcepath = 'java_paths/build/gen/main'
+
+  AssertLinter 'javac',
+  \ g:prefix
+  \   . ' -sourcepath ' . ale#Escape(
+  \     ale#path#Simplify(g:dir . '/java_paths/build/gen/main/')
+  \   )
+  \   . ' -d ' . ale#Escape('TEMP_DIR') . ' %t'
+
+Execute(The javac callback should use list type g:ale_java_javac_sourcepath correctly):
+  let g:ale_java_javac_sourcepath = ['java_paths/build/gen/main']
+
+  AssertLinter 'javac',
+  \ g:prefix
+  \   . ' -sourcepath ' . ale#Escape(
+  \     ale#path#Simplify(g:dir . '/java_paths/build/gen/main/')
+  \   )
+  \   . ' -d ' . ale#Escape('TEMP_DIR') . ' %t'
+
+Execute(The javac callback shouldn't add -sourcepath when g:ale_java_javac_sourcepath variable path doesn't exist):
+  let g:ale_java_javac_sourcepath = 'java_paths/build/gen3/main'
+
+  AssertLinter 'javac',
+  \ g:prefix
+  \   . ' -d ' . ale#Escape('TEMP_DIR') . ' %t'
+
+Execute(The javac callback should combine discovered sourcepath and manual ones):
+  call ale#engine#Cleanup(bufnr(''))
+  call ale#test#SetFilename('java_paths/src/main/java/com/something/dummy.java')
+  call ale#engine#InitBufferInfo(bufnr(''))
+
+  let g:ale_java_javac_sourcepath = 'java_paths/build/gen/main'
+  let b:command = ale_linters#java#javac#GetCommand(bufnr(''), [], {})
+
+  AssertEqual
+  \ ale#path#CdString(expand('%:p:h')) . ale#Escape('javac') . ' -Xlint'
+  \   . ' -sourcepath ' . ale#Escape(join([
+  \     ale#path#Simplify(g:dir . '/java_paths/src/main/java/'),
+  \     ale#path#Simplify(g:dir . '/java_paths/build/gen/main/'),
+  \   ], g:cp_sep))
+  \   . ' -d ' . ale#Escape('TEMP_DIR') . ' %t',
+  \ substitute(b:command, '%e', '\=ale#Escape(''javac'')', 'g')
+
+  let g:ale_java_javac_sourcepath = 'java_paths/build/gen/main'
+  \ . g:cp_sep . 'java_paths/build/gen2/main'
+  let b:command = ale_linters#java#javac#GetCommand(bufnr(''), [], {})
+
+  AssertEqual
+  \ ale#path#CdString(expand('%:p:h')) . ale#Escape('javac') . ' -Xlint'
+  \   . ' -sourcepath ' . ale#Escape(join([
+  \     ale#path#Simplify(g:dir . '/java_paths/src/main/java/'),
+  \     ale#path#Simplify(g:dir . '/java_paths/build/gen/main/'),
+  \     ale#path#Simplify(g:dir . '/java_paths/build/gen2/main/')
+  \   ], g:cp_sep))
+  \   . ' -d ' . ale#Escape('TEMP_DIR') . ' %t',
+  \ substitute(b:command, '%e', '\=ale#Escape(''javac'')', 'g')
+
+  let g:ale_java_javac_sourcepath = ['java_paths/build/gen/main']
+  let b:command = ale_linters#java#javac#GetCommand(bufnr(''), [], {})
+
+  AssertEqual
+  \ ale#path#CdString(expand('%:p:h')) . ale#Escape('javac') . ' -Xlint'
+  \   . ' -sourcepath ' . ale#Escape(join([
+  \     ale#path#Simplify(g:dir . '/java_paths/src/main/java/'),
+  \     ale#path#Simplify(g:dir . '/java_paths/build/gen/main/')
+  \   ], g:cp_sep))
+  \   . ' -d ' . ale#Escape('TEMP_DIR') . ' %t',
+  \ substitute(b:command, '%e', '\=ale#Escape(''javac'')', 'g')
+
+  let g:ale_java_javac_sourcepath = [
+    \ 'java_paths/build/gen/main',
+    \ 'java_paths/build/gen2/main'
+  \ ]
+  let b:command = ale_linters#java#javac#GetCommand(bufnr(''), [], {})
+
+  AssertEqual
+  \ ale#path#CdString(expand('%:p:h')) . ale#Escape('javac') . ' -Xlint'
+  \   . ' -sourcepath ' . ale#Escape(join([
+  \     ale#path#Simplify(g:dir . '/java_paths/src/main/java/'),
+  \     ale#path#Simplify(g:dir . '/java_paths/build/gen/main/'),
+  \     ale#path#Simplify(g:dir . '/java_paths/build/gen2/main/')
+  \   ], g:cp_sep))
+  \   . ' -d ' . ale#Escape('TEMP_DIR') . ' %t',
+  \ substitute(b:command, '%e', '\=ale#Escape(''javac'')', 'g')
+
 Execute(The javac callback should detect source directories):
   call ale#engine#Cleanup(bufnr(''))
   noautocmd e! java_paths/src/main/java/com/something/dummy