Add Ruby linter with Steep

[lloeki]

Continuation of #4376

Fixes #3254

Where are the tests? Have you added tests? Have you updated the tests? Read the
comment above and the documentation referenced in it first. Write tests!

Seriously, read :help ale-dev and write tests.

Working on it (trying to run the test docker thingy).

Added tests (inspired by Rubocop ones)

[w0rp]

This is a complex handler function. Add a test for this too. There's a directory for testing functions for handling results.

[lloeki]

Sure, I will!

[lloeki]

I should finally be able to get back to complete this within a few weeks.

[lloeki]

"a few weeks" heh. On it.

[lloeki]

@w0rp I have rebased and added the handler test.

[stale]

This pull request has been automatically marked as stale because it has not been updated recently. Make sure to write tests and document your changes. See :help ale-dev for information on writing tests.
If your pull request is good to merge, bother w0rp or another maintainer again, and get them to merge it.

[lloeki]

Hmm, test failure on Appveyor because of Windows paths:

[00:02:18]   Starting Vader: C:\testplugin\test\linter\test_ruby_steep.vader
[00:02:18]     (1/3) [EXECUTE] Executable should default to steep
[00:02:18]     (1/3) [EXECUTE] (X) ['steep', 'steep check  ''C:\testplugin\test\linter\dummy.rb'''] should be equal to ['steep', 'steep check  ''testplugin/test/linter/dummy.rb''']
[00:02:18]     (2/3) [EXECUTE] Should be able to set a custom executable
[00:02:18]     (2/3) [EXECUTE] (X) ['bin/steep', 'bin/steep check  ''C:\testplugin\test\linter\dummy.rb'''] should be equal to ['bin/steep', 'bin/steep check  ''testplugin/test/linter/dummy.rb''']
[00:02:18]     (3/3) [EXECUTE] Setting bundle appends 'exec steep'
[00:02:18]     (3/3) [EXECUTE] (X) ['path to/bundle', '"path to/bundle" exec steep check  ''C:\testplugin\test\linter\dummy.rb'''] should be equal to ['path to/bundle', '"path to/bundle" exec steep check  ''testplugin/test/linter/dummy.rb''']
[00:02:18]   Success/Total: 0/3

[lloeki]

Noticed the separator was off for Windows, which would break the replacement and made a fix, but it insists on having C: in front still :(

[00:02:28]   Starting Vader: C:\testplugin\test\linter\test_ruby_steep.vader
[00:02:28]     (1/3) [EXECUTE] Executable should default to steep
[00:02:28]     (1/3) [EXECUTE] (X) ['steep', 'steep check  ''C:testplugin\test\linter\dummy.rb'''] should be equal to ['steep', 'steep check  ''testplugin/test/linter/dummy.rb''']
[00:02:28]     (2/3) [EXECUTE] Should be able to set a custom executable
[00:02:28]     (2/3) [EXECUTE] (X) ['bin/steep', 'bin/steep check  ''C:testplugin\test\linter\dummy.rb'''] should be equal to ['bin/steep', 'bin/steep check  ''testplugin/test/linter/dummy.rb''']
[00:02:28]     (3/3) [EXECUTE] Setting bundle appends 'exec steep'
[00:02:28]     (3/3) [EXECUTE] (X) ['path to/bundle', '"path to/bundle" exec steep check  ''C:testplugin\test\linter\dummy.rb'''] should be equal to ['path to/bundle', '"path to/bundle" exec steep check  ''testplugin/test/linter/dummy.rb''']
[00:02:28]   Success/Total: 0/3

Really tough to efficiently debug this as I don't have a Windows setup at hand.

[lloeki]

@w0rp there were a few corner-case bugs but it's all fixed and test-covered now. WDYT, good to merge?

[lloeki]

Hmm, missed that one locally, will fix:

========================================
Running Vint to lint our code
========================================
Vint warnings/errors follow:

ale_linters/ruby/steep.vim:26:21: Use robust operators `==#` or `==?` instead of `==` (see Google VimScript Style Guide (Matching))
ale_linters/ruby/steep.vim:64:19: Use robust operators `==#` or `==?` instead of `==` (see Google VimScript Style Guide (Matching))

Huh what? Not even whitespace appear to differ.

========================================
diff supported-tools.md and doc/ale-supported-languages-and-tools.txt tables
========================================
Differences follow:

--- /tmp/readme.XXMCAcHf
+++ /tmp/doc.XXoaBcKg
@@ -445 +444,0 @@
-Ruby - steep
@@ -446,0 +446 @@
+Ruby - steep

EDIT: from raw logs:

$ cat | od -xa
-Ruby - steep
^D
0000000      522d    6275    2079    202d    7473    6565    0a70        
           -   R   u   b   y  sp   -  sp   s   t   e   e   p  nl        
0000016
$ cat | od -xa
+Ruby - steep
^D
0000000      522b    6275    2079    202d    7473    6565    0a70        
           +   R   u   b   y  sp   -  sp   s   t   e   e   p  nl        
0000016

[hsanson]

Difference here is the sorting order. In supported-tools.md steep is listed below sorbet while in ale-supported-languages-and-tools.txt is listed below standardrb. Make sure is in same exact order on both files.

========================================
diff supported-tools.md and doc/ale-supported-languages-and-tools.txt tables
========================================
Differences follow:

--- /tmp/readme.XXMCAcHf
+++ /tmp/doc.XXoaBcKg
@@ -445 +444,0 @@
-Ruby - steep
@@ -446,0 +446 @@
+Ruby - steep

[lloeki]

Oh my, thanks @hsanson!

Just pushed fixes for the remaining bits. Let's see if CI is green now.

[hsanson]

Thanks for the contribution and patience.