ruby-lsp-typeprof 0.3.0 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e970087c448a7fdf79627b8023da3d4172f5882709cfaa22ceebc61d627cae39
-  data.tar.gz: a2ab61b7d4a2b16db5b3e8d4788b016f92c258a083f1d39b3d697f672678ca86
+  metadata.gz: 1b0dc266b02ba9428bd88e6001b094436c17fe94407477e1e2f184825416a40a
+  data.tar.gz: 70fa07a521a222f5c9e1ac9a62e2458bd41308b1eb6559a7252d8cfe8298008c
 SHA512:
-  metadata.gz: 9b2fc7138694f993b4e80f98fc3496a914cbe4d03ae67bddc5a16ff6792709561a8f51a42d45b0041b3dca45975ef1cb677eb908503c8584334ae603148e2b38
-  data.tar.gz: 97a2e1aaf9d0e9c6fec4211764dbd26ea5a0e862b3ee3b099e6d863ae48da35e6edbfde577edda4dca8e1b0510221683317f7116ec198f3d22587876e58eb19a
+  metadata.gz: 4ed5ddf9b0a88bd9ad17fa748225ad62d23b1ab5e99f181b21a5dea1f10c2fecab850403c39470447487550b11f7a03989b648f7d61aa8ab586b5f8b75d5d50c
+  data.tar.gz: 33ea5a60eeb2295adff2ad7f73828d17dabe17cbcc01be64209bca361e8bb8bcd36f61f5b6e84a40601be2e9299817652dae9915024f90a8c6738d1447cdf1c7

data/README.md

@@ -27,7 +27,8 @@ Configure them in VS Code's `settings.json`:
   "rubyLsp.addonSettings": {
     "TypeProf": {
       "enabled": false,
-      "enableCodeLens": false
+      "enableCodeLens": false,
+      "enableDocumentSymbol": false
     }
   }
 }
@@ -45,6 +46,7 @@ You can place this configuration in either:
 | --- | --- | --- | --- |
 | `enabled` | boolean | `true` | Master switch. When `false`, the add-on skips loading TypeProf entirely and disables every feature. |
 | `enableCodeLens` | boolean | `true` | Show inferred type signatures as code lens above method definitions. Has no effect when `enabled` is `false`. |
+| `enableDocumentSymbol` | boolean | `true` | Add inferred type signatures as child symbols of method definitions in the document symbol response, so clients that do not support code lens (for example Claude Code) can see them. Has no effect when `enabled` is `false`. |
 
 After changing the setting, restart Ruby LSP via the "Ruby LSP: Restart"
 command for it to take effect.
@@ -53,7 +55,9 @@ command for it to take effect.
 
 After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
 
-To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+To install this gem onto your local machine, run `bundle exec rake install`.
+
+To release a new version, run `bin/bump.rb` (pass `--minor` or `--major` to bump those segments) and push the resulting commit to `main`. The release workflow then publishes the gem to [rubygems.org](https://rubygems.org) and creates a GitHub release.
 
 ## Contributing
 

data/lib/ruby_lsp/ruby_lsp_typeprof/addon.rb

@@ -5,29 +5,34 @@ require "ruby_lsp/addon"
 require "uri"
 
 require_relative "code_lens_listener"
+require_relative "document_symbol_listener"
+require_relative "loggable"
 
 module RubyLsp
   module Typeprof
     class Addon < ::RubyLsp::Addon
+      include Loggable
+
       def initialize
         super
         @service = nil
         @mutex = Mutex.new
         @enabled = true
         @code_lens_enabled = true
+        @document_symbol_enabled = true
       end
 
-      def activate(global_state, _outgoing_queue)
-        settings = global_state.settings_for_addon(name)
-        @enabled = settings&.dig(:enabled) != false
+      def activate(global_state, outgoing_queue)
+        @outgoing_queue = outgoing_queue
+        log_message("Activating Ruby LSP TypeProf add-on v#{VERSION}")
+
+        load_settings(global_state)
         return unless @enabled
 
         require "typeprof"
-
-        @code_lens_enabled = settings&.dig(:enableCodeLens) != false
         @service = build_service(global_state.workspace_path)
       rescue StandardError => e
-        warn "ruby-lsp-typeprof: Failed to activate: #{e.message}"
+        log_error("Ruby LSP TypeProf failed to activate: #{e.full_message(highlight: false)}")
       end
 
       def deactivate
@@ -46,7 +51,14 @@ module RubyLsp
         return unless @service
         return unless @code_lens_enabled
 
-        CodeLensListener.new(response_builder, uri, dispatcher, @service, @mutex)
+        CodeLensListener.new(response_builder, uri, dispatcher, @service, @mutex, @outgoing_queue)
+      end
+
+      def create_document_symbol_listener(response_builder, dispatcher)
+        return unless @service
+        return unless @document_symbol_enabled
+
+        DocumentSymbolListener.new(response_builder, dispatcher, @service, @mutex, @outgoing_queue)
       end
 
       def workspace_did_change_watched_files(changes)
@@ -59,6 +71,13 @@ module RubyLsp
 
       private
 
+      def load_settings(global_state)
+        settings = global_state.settings_for_addon(name)
+        @enabled = settings&.dig(:enabled) != false
+        @code_lens_enabled = settings&.dig(:enableCodeLens) != false
+        @document_symbol_enabled = settings&.dig(:enableDocumentSymbol) != false
+      end
+
       def build_service(workspace_path)
         conf = load_typeprof_conf(workspace_path) || default_conf
         rbs_dir = File.expand_path(conf[:rbs_dir], workspace_path)
@@ -92,7 +111,7 @@ module RubyLsp
 
         @service.update_file(path, nil)
       rescue StandardError => e
-        warn "ruby-lsp-typeprof: Failed to update file #{path}: #{e.message}"
+        log_error("Ruby LSP TypeProf failed to update file #{path}: #{e.full_message(highlight: false)}")
       end
     end
   end

data/lib/ruby_lsp/ruby_lsp_typeprof/code_lens_listener.rb

@@ -1,20 +1,20 @@
 # frozen_string_literal: true
 
+require_relative "signature_cache"
+
 module RubyLsp
   module Typeprof
     class CodeLensListener
-      def initialize(response_builder, uri, dispatcher, service, mutex)
+      def initialize(response_builder, uri, dispatcher, service, mutex, outgoing_queue)
         @response_builder = response_builder
-        @path = uri.to_standardized_path
-        @lens_cache = {}
+        @signatures = SignatureCache.new(service, mutex, uri.to_standardized_path, outgoing_queue, feature: "code lens")
 
-        cache_code_lens_results(service, mutex)
-        dispatcher.register(self, :on_def_node_enter) unless @lens_cache.empty?
+        dispatcher.register(self, :on_def_node_enter) unless @signatures.empty?
       end
 
       def on_def_node_enter(node)
         line = node.location.start_line
-        hint = @lens_cache[line]
+        hint = @signatures[line]
         return unless hint
 
         @response_builder << build_code_lens(line, hint)
@@ -30,16 +30,6 @@ module RubyLsp
           command: LanguageServer::Protocol::Interface::Command.new(title: "#: #{hint}", command: "")
         )
       end
-
-      def cache_code_lens_results(service, mutex)
-        mutex.synchronize do
-          service.code_lens(@path) do |code_range, hint|
-            @lens_cache[code_range.first.lineno] = hint
-          end
-        end
-      rescue StandardError => e
-        warn "ruby-lsp-typeprof: Code lens error: #{e.message}"
-      end
     end
   end
 end

data/lib/ruby_lsp/ruby_lsp_typeprof/document_symbol_listener.rb

@@ -0,0 +1,63 @@
+# frozen_string_literal: true
+
+require_relative "signature_cache"
+
+module RubyLsp
+  module Typeprof
+    # Appends the inferred method signature as a child symbol of each method
+    # definition symbol produced by Ruby LSP's own DocumentSymbol listener.
+    #
+    # Ruby LSP does not pass the document URI to `create_document_symbol_listener`,
+    # so the URI is read from the core listener already registered on the dispatcher.
+    class DocumentSymbolListener
+      def initialize(response_builder, dispatcher, service, mutex, outgoing_queue)
+        @response_builder = response_builder
+        path = document_path(dispatcher)
+        @signatures = SignatureCache.new(service, mutex, path, outgoing_queue, feature: "document symbol")
+
+        dispatcher.register(self, :on_def_node_enter) unless @signatures.empty?
+      end
+
+      def on_def_node_enter(node)
+        hint = @signatures[node.location.start_line]
+        return unless hint
+
+        parent = @response_builder.last
+        return unless parent.is_a?(LanguageServer::Protocol::Interface::DocumentSymbol)
+
+        parent.children << build_signature_symbol(node, hint)
+      end
+
+      private
+
+      def document_path(dispatcher)
+        core_listener = dispatcher.listeners.each_value.flat_map(&:itself).find do |listener|
+          listener.is_a?(::RubyLsp::Listeners::DocumentSymbol)
+        end
+        core_listener&.instance_variable_get(:@uri)&.to_standardized_path
+      end
+
+      def build_signature_symbol(node, hint)
+        range = range_from_location(node.name_loc)
+
+        LanguageServer::Protocol::Interface::DocumentSymbol.new(
+          name: hint,
+          kind: ::RubyLsp::Constant::SymbolKind::TYPE_PARAMETER,
+          range: range,
+          selection_range: range
+        )
+      end
+
+      def range_from_location(location)
+        LanguageServer::Protocol::Interface::Range.new(
+          start: LanguageServer::Protocol::Interface::Position.new(
+            line: location.start_line - 1, character: location.start_column
+          ),
+          end: LanguageServer::Protocol::Interface::Position.new(
+            line: location.end_line - 1, character: location.end_column
+          )
+        )
+      end
+    end
+  end
+end

data/lib/ruby_lsp/ruby_lsp_typeprof/loggable.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+module RubyLsp
+  module Typeprof
+    module Loggable
+      private
+
+      def log_message(message, type: ::RubyLsp::Constant::MessageType::LOG)
+        return if @outgoing_queue.nil? || @outgoing_queue.closed?
+
+        @outgoing_queue << ::RubyLsp::Notification.window_log_message(message, type: type)
+      end
+
+      def log_error(message)
+        log_message(message, type: ::RubyLsp::Constant::MessageType::ERROR)
+      end
+    end
+  end
+end

data/lib/ruby_lsp/ruby_lsp_typeprof/signature_cache.rb

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+require_relative "loggable"
+
+module RubyLsp
+  module Typeprof
+    # Collects the method signatures TypeProf inferred for a single file,
+    # keyed by the 1-based line number of the method definition.
+    class SignatureCache
+      include Loggable
+
+      def initialize(service, mutex, path, outgoing_queue, feature:)
+        @outgoing_queue = outgoing_queue
+        @hints = {}
+        return unless path
+
+        mutex.synchronize do
+          service.code_lens(path) do |code_range, hint|
+            @hints[code_range.first.lineno] = hint
+          end
+        end
+      rescue StandardError => e
+        log_error("Ruby LSP TypeProf failed to compute #{feature} for #{path}: #{e.full_message(highlight: false)}")
+      end
+
+      def [](line)
+        @hints[line]
+      end
+
+      def empty?
+        @hints.empty?
+      end
+    end
+  end
+end

data/lib/ruby_lsp_typeprof/version.rb

@@ -2,6 +2,6 @@
 
 module RubyLsp
   module Typeprof
-    VERSION = "0.3.0"
+    VERSION = "0.5.0"
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: ruby-lsp-typeprof
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.5.0
 platform: ruby
 authors:
 - Takumi Shotoku
@@ -44,8 +44,6 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- ".tagpr"
-- CHANGELOG.md
 - CODE_OF_CONDUCT.md
 - LICENSE.txt
 - README.md
@@ -53,6 +51,9 @@ files:
 - lib/ruby-lsp-typeprof.rb
 - lib/ruby_lsp/ruby_lsp_typeprof/addon.rb
 - lib/ruby_lsp/ruby_lsp_typeprof/code_lens_listener.rb
+- lib/ruby_lsp/ruby_lsp_typeprof/document_symbol_listener.rb
+- lib/ruby_lsp/ruby_lsp_typeprof/loggable.rb
+- lib/ruby_lsp/ruby_lsp_typeprof/signature_cache.rb
 - lib/ruby_lsp_typeprof/version.rb
 - sig/ruby_lsp_typeprof/version.rbs
 homepage: https://github.com/sinsoku/ruby-lsp-typeprof
@@ -60,8 +61,8 @@ licenses:
 - MIT
 metadata:
   homepage_uri: https://github.com/sinsoku/ruby-lsp-typeprof
-  source_code_uri: https://github.com/sinsoku/ruby-lsp-typeprof/tree/v0.3.0
-  changelog_uri: https://github.com/sinsoku/ruby-lsp-typeprof/blob/v0.3.0/CHANGELOG.md
+  source_code_uri: https://github.com/sinsoku/ruby-lsp-typeprof/tree/v0.5.0
+  changelog_uri: https://github.com/sinsoku/ruby-lsp-typeprof/releases
   rubygems_mfa_required: 'true'
 rdoc_options: []
 require_paths:
@@ -77,7 +78,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 4.0.6
+rubygems_version: 4.0.16
 specification_version: 4
 summary: A Ruby LSP addon for TypeProf
 test_files: []

data/.tagpr

@@ -1,5 +0,0 @@
-[tagpr]
-  vPrefix = true
-  releaseBranch = main
-  versionFile = lib/ruby_lsp_typeprof/version.rb
-  postVersionCommand = BUNDLE_FROZEN=false bundle install

data/CHANGELOG.md

@@ -1,11 +0,0 @@
-## [v0.3.0](https://github.com/sinsoku/ruby-lsp-typeprof/compare/v0.2.0...v0.3.0) - 2026-05-08
-- feat: Add enabled setting to toggle the entire add-on by @sinsoku in https://github.com/sinsoku/ruby-lsp-typeprof/pull/5
-
-## [v0.2.0](https://github.com/sinsoku/ruby-lsp-typeprof/compare/v0.1.1...v0.2.0) - 2026-05-03
-- feat: Add enableCodeLens setting via addonSettings by @sinsoku in https://github.com/sinsoku/ruby-lsp-typeprof/pull/4
-
-## [v0.1.1](https://github.com/sinsoku/ruby-lsp-typeprof/compare/v0.1.0...v0.1.1) - 2026-04-27
-
-## [0.1.0] - 2026-04-27
-
-- feat: Display type declarations using Code Lens