Contents

# typed: strict
# frozen_string_literal: true

module RubyLsp
  module Rails
    # ![Hover demo](../../hover.gif)
    #
    # Augment [hover](https://microsoft.github.io/language-server-protocol/specification#textDocument_hover) with
    # information about a model.
    #
    # # Example
    #
    # ```ruby
    # User.all
    # # ^ hovering here will show information about the User model
    # ```
    class Hover < ::RubyLsp::Listener
      extend T::Sig
      extend T::Generic

      ResponseType = type_member { { fixed: T.nilable(::RubyLsp::Interface::Hover) } }

      ::RubyLsp::Requests::Hover.add_listener(self)

      sig { override.returns(ResponseType) }
      attr_reader :response

      sig { params(emitter: RubyLsp::EventEmitter, message_queue: Thread::Queue).void }
      def initialize(emitter, message_queue)
        super

        @response = T.let(nil, ResponseType)
        emitter.register(self, :on_const)
      end

      sig { params(node: SyntaxTree::Const).void }
      def on_const(node)
        model = RailsClient.instance.model(node.value)
        return if model.nil?

        schema_file = model[:schema_file]
        content = +""
        if schema_file
          content << "[Schema](file://#{schema_file})\n\n"
        end
        content << model[:columns].map { |name, type| "**#{name}**: #{type}\n" }.join("\n")
        contents = RubyLsp::Interface::MarkupContent.new(kind: "markdown", value: content)
        @response = RubyLsp::Interface::Hover.new(range: range_from_syntax_tree_node(node), contents: contents)
      end
    end
  end
end

Version data entries

3 entries across 3 versions & 1 rubygems

Version	Path
ruby-lsp-rails-0.2.2	lib/ruby_lsp/ruby_lsp_rails/hover.rb
ruby-lsp-rails-0.2.1	lib/ruby_lsp/ruby_lsp_rails/hover.rb
ruby-lsp-rails-0.2.0	lib/ruby_lsp/ruby_lsp_rails/hover.rb