Can't jump to the nested module's class in `enh-ruby-mode`, but ruby-mode works

[zw963]

Following is a example:

module Types
  module UserQuery
    class UserQueryType < Types::BaseObject
      field :current_user, resolver: Types::UserQuery::Resolvers::CurrentUserResolver # case 1
      field :current_user, resolver: Resolvers::CurrentUserResolver  # case 2
  end
end

above case 1 and case 2 field have same effect.

When cursor on the case 1 CurrentUserResolver, robe jump feature is works!

But.

When cursour on the case 2 CurrentUserResolver, will tip Can't find the locatin.
but code case 2 actually is working code, totally same as case 1, because Resolvers::CurrentUserResolver
is under namespaced module, module Types => module => UserQuery => Resolvers::CurrentUserResolver

I can reproduce this on ruby 3.1.0 with inf-ruby newest master.

Thank you.

---

Added:

CurrentUserResolver defined like this,

class Types::UserQuery::Resolvers::CurrentUserResolver < Resolvers::Base
end

though, i consider this should not the reason, because another class define like this, not work too.

module Types
  module UserQuery
    class UserNameType
    end
  end
end

And, i use rails 6, autoloading feature use zeitwerk.

[zw963]

BTW, this never be a issue anyway, because i prefer write the full name in this cause, like this:

module Types
  module UserQuery
    class UserQueryType < Types::BaseObject
     field :user_info, resolver: Types::UserQuery::Resolvers::UserInfoResolver
      field :current_user, resolver: Types::UserQuery::Resolvers::CurrentUserResolver
      field :current_user_wallet, resolver: Types::UserQuery::Resolvers::CurrentUserWalletResolver
  end
end

And, i define class like this too.

class Types::UserQuery::Resolvers::CurrentUserWalletResolver
end

because even if no robe or TAGS, i can find out where this class defined and used very easy with grep full name. like this: Types::UserQuery::Resolvers::CurrentUserWalletResolver.

---

But, my co-worker prefer less is better, it always prefer write code like this:

module Types
  module UserQuery
    class UserQueryType < Types::BaseObject
     field :user_info, resolver: Resolvers::UserInfoResolver
      field :current_user, resolver: Resolvers::CurrentUserResolver
      field :current_user_wallet, resolver: Resolvers::CurrentUserWalletResolver
  end
end

and define class like this:

module Types
  module UserQuery
    module Resolvers
     class CurrentUserWalletResolver
     end
end

If use like this, we can't use robe to skip the actually definition position, so, i just curious, if is was possible to support this.

[dgutov]

Hi!

Please clarify: do you both use ruby-mode, or enh-ruby-mode?

[zw963]

Hi!

Please clarify: do you both use ruby-mode, or enh-ruby-mode?

Not sure, actually, i only use enh-ruby-mode for a long time, current major-mode is enh-ruby-mode too.
but, i am not sure if emacs builtin ruby-mode was loaded before.

[dgutov]

Could you try the same scenario with ruby-mode first, too?

[zw963]

Could you try the same scenario with ruby-mode first, too?

Yes, it works.

it can jump from

field :user_info, resolver: Resolvers::UserInfoResolver

to

class Types::UserQuery::Resolvers::UserInfoResolver < Resolvers::Base
end

In fact, i found inf-ruby always require ruby-mode, so, it only not work when enable enh-ruby-mode.

[zw963]

Maybe i should switch back to builtin ruby-mode, anyway, some of advantage of enh-ruby-mode was exists on solargraph when use with lsp (though, i disable it), and @zenspider is busy, enh-ruby-mode not updated almost one year.

Which mode you use for ruby programming?

[zw963]

i can reproduce on a very simple config, following is log:

Debugger entered--Lisp error: (error "Can’t find the location")
  error("Can't find the location")
  robe-jump-to-module(#("Resolvers::UserInfoResolver" 0 9 (font-lock-face font-lock-type-face fontified t) 9 11 (font-lock-face enh-ruby-op-face fontified t) 11 27 (font-lock-face font-lock-type-face fontified t)))
  robe-jump(nil)
  funcall-interactively(robe-jump nil)
  command-execute(robe-jump)

[zw963]

consider check this: zenspider/enhanced-ruby-mode#182

[dgutov]

i can reproduce on a very simple config, following is log:

Only with enh-ruby-mode, right?

I'm guessing it's rather because of this much older issue: zenspider/enhanced-ruby-mode#156, which I originally filed as zenspider/enhanced-ruby-mode#96.

While admittedly robe is doing something a little unusual (using add-log-current-defun-function as a method to determine the current calling context), it shouldn't take 5 years to fix.

some of advantage of enh-ruby-mode was exists on solargraph when use with lsp

Is there some advantage when used together with LSP? I'm not aware of any.

IIUC people have been using it because of some different indentation behavior in certain examples. And maybe some differences in syntax coloring, though I don't know which.

Which mode you use for ruby programming?

I use ruby-mode. I'm maintaining it, after all.

[zw963]

Only with enh-ruby-mode, right?

Yes.

Is there some advantage when used together with LSP? I'm not aware of any.

1. it have auto complete/jump to function feature, but it should not better than robe-company.
2. it have flycheck, but, that just use rubocop, i used to use it.
3. it have formatter feature, but, i guess, that just ruby mode sexp format.
4. i remember lsp can support semantic tokens, it can give better highlight feature than ruby-mode, i guess this is what you said IIUC people used, but, lsp semantic tokens a little slower since i used it long time ago.(monthly), in fact, i consider enh-ruby-mode give better highlight too, even load large .rb file more quickly then ruby-mode, that was the reason i keep use enh-ruby-mode.
5. ruby dap (debug feature) never works for me, maybe ruby 3.1.0 new built debugger feature can improve on this.

the advantage is, lsp use static analyze, it not need start a REPL to make those feature available. i consider ruby will give better
support for lsp the next few years as said by @matz, in fact, we have seen many improvement since ruby 3.1.0.

but, the shortcoming is same, when open ruby-lsp first time, it will spend 4~5 seconds to open a ruby buffer because static analyze, i guess.

Anyway, in fact, i never use lsp-ruby for a long time use, not so useful, but, it very very awesome for use Strong type language, like dart, go, rust, it almost can not do anything no lsp if you ever use it.

[zw963]

I use ruby-mode. I'm maintaining it, after all.

I will try to switch back to ruby-mode, BTW, where is the official repo of ruby-mode? i never saw it on https://github.com/ruby

[dgutov]

i consider enh-ruby-mode give better highlight too, even load large .rb file more quickly then ruby-mode, that was the reason i keep use enh-ruby-mode

That's interesting. I should compare it sometime.

As for the rest, I was asking for reasons to use enh-ruby-mode, not about LSP. They are not tied together: you can just as well use LSP with ruby-mode.

where is the official repo of ruby-mode?

It lived inside https://github.com/ruby/ruby/tree/master/misc originally, but about a decade ago it was contributed to Emacs, and has been living it its official repo ever since.

[zw963]

As for the rest, I was asking for reasons to use enh-ruby-mode

1. more better highlight.
2. more better performance when open and edit a large rb file.

it was contributed to Emacs, and has been living it its official repo ever since.

What you said official repo is https://git.savannah.gnu.org/git/emacs.git/, right?

I know ruby-mode was builtin, and Richard Stallman give @matz a award for the contribute of emacs.

i just curious how you maintain ruby-mode.el, and where i can create issue or discuss about it.

[dgutov]

more better highlight

Any particular examples?

What you said official repo is https://git.savannah.gnu.org/git/emacs.git/, right?

Yup. And I have commit access.

and Richard Stallman give @matz a award for the contribute of emacs.

Not for Emacs, just for Ruby (the award was for contributing to free software).

and where i can create issue or discuss about it

You do that with M-x report-emacs-bug.