New outline queries produce invalid $ZED_SYMBOL for runnables

[vitallium]

Hey @kaspth and @andyw8 👋

is this working for you folks? I've replaced my task setup from use line number to use -n pattern like you folks suggested.

[
  {
    "label": "test $ZED_RELATIVE_FILE -n /$ZED_SYMBOL/",
    "command": "bin/rails test $ZED_RELATIVE_FILE -n /$ZED_SYMBOL/",
    "tags": ["ruby-test"]
  }
]

this works when I run the class test BUT running a single test case it adds a space between / and the " character from $ZED_SYMBOL

⏵ Task `test test/models/cnae_test.rb -n / "formats a CNAE code"/` finished with non-zero error code: 1
⏵ Command: /bin/zsh -i -c 'bin/rails test test/models/cnae_test.rb -n / "formats a CNAE code"/'

see that it is trying to run / "formats a CNAE code"/' instead of `/"formats a CNAE code"/'? this makes my command to fails:

<internal:dir>:411:in `glob': Operation not permitted - //Library/Application Support/com.apple.TCC (Errno::EPERM)
	from /Users/cadu/.local/share/mise/installs/ruby/3.3.4/lib/ruby/gems/3.3.0/gems/rake-13.2.1/lib/rake/file_list.rb:408:in `glob'
	from /Users/cadu/.local/share/mise/installs/ruby/3.3.4/lib/ruby/gems/3.3.0/gems/rake-13.2.1/lib/rake/file_list.rb:351:in `add_matching'
	from /Users/cadu/.local/share/mise/installs/ruby/3.3.4/lib/ruby/gems/3.3.0/gems/rake-13.2.1/lib/rake/file_list.rb:223:in `resolve_add'
	from /Users/cadu/.local/share/mise/installs/ruby/3.3.4/lib/ruby/gems/3.3.0/gems/rake-13.2.1/lib/rake/file_list.rb:213:in `block in resolve'
	from /Users/cadu/.local/share/mise/installs/ruby/3.3.4/lib/ruby/gems/3.3.0/gems/rake-13.2.1/lib/rake/file_list.rb:213:in `each'
	from /Users/cadu/.local/share/mise/installs/ruby/3.3.4/lib/ruby/gems/3.3.0/gems/rake-13.2.1/lib/rake/file_list.rb:213:in `resolve'
	from /Users/cadu/.local/share/mise/installs/ruby/3.3.4/lib/ruby/gems/3.3.0/gems/rake-13.2.1/lib/rake/file_list.rb:177:in `to_a'

when running the class test, it does not prepend the space character:

⏵ Task `test test/models/cnae_test.rb -n /CnaeTest/` finished successfully
⏵ Command: /bin/zsh -i -c 'bin/rails test test/models/cnae_test.rb -n /CnaeTest/'

this is on Zed Preview 0.186.5. Are you folks facing this problem as well?

Originally posted by @duduribeiro in #56

[vitallium]

Most likely caused by eed46d3

[vitallium]

I think this query causes the problem:

; Class macros such as `alias_method`, `include`, `belongs_to`, `has_many`, `attr_reader`
(class
    (body_statement
        (call
            method: (identifier) @name
            arguments: (argument_list . [
                    (string) @name
                    (simple_symbol) @name
                    (scope_resolution) @name
                    (constant) @name
                    "," @context
                ]* [
                    (string) @name
                    (simple_symbol) @name
                    (scope_resolution) @name
                    (constant) @name
                ]
            )
        ) @item
    )
)

[vitallium]

I think the fix in #93 is not correct. I think losing ability to search through additional information of methods like include Bar (Bar) is important. Instead we can rely on captures from the Runnables query because Zed supports custom captures as variables in task templates. Consider the following query

(
    (call
        method: (identifier) @run (#eq? @run "test")
        arguments: (argument_list (string (string_content) @name))
    ) @_ruby-test
    (#set! tag ruby-test)
)

This query has 3 captures: @run, @name, and @_ruby-test. The @run capture is ZED_RUNNABLE_SYMBOL, which is used to determine the position of the Run task button. All other captures are mapped to ZED_CUSTOM_(capture_name) and can be used in task templates:

• @name -> ZED_CUSTOM_name
• @_ruby-test -> N/A. Captures prefixed with an underscore (_) are not mapped.

The task template in such a scenario will be like this:

[
  {
    "label": "test $ZED_RELATIVE_FILE -n /$ZED_CUSTOM_name/",
    "command": "bin/rails",
    "args": ["test", "$ZED_RELATIVE_FILE", "-n", "/$ZED_CUSTOM_name/"],
    "tags": ["ruby-test"]
  }
]

This isn't the best option, but it should work. I'll open another PR using this approach.

[kaspth]

This isn't the best option, but it should work. I'll open another PR using this approach.

Nice!

[vitallium]

Fixed in #94

[vitallium]

Actually, I'm reopening this, sorry. I wonder if it makes more sense to use $ZED_CUSTOM_TEST_NAME rather than the cryptic ZED_CUSTOM_name.

[andyw8]

Yeah, the mixed case is a little odd. Perhaps $ZED_CUSTOM_RUBY_TEST_NAME to help indicate that this is Ruby-specific.

[vitallium]

Yeah, the mixed case is a little odd. Perhaps $ZED_CUSTOM_RUBY_TEST_NAME to help indicate that this is Ruby-specific.

Yeah, this is even better, given that we use ruby-test as a tag name in tree-sitter queries. Thanks for the suggestion!

[vitallium]

Now we can treat this as completed via #97