ruby-lsp 0.6.0 → 0.6.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4d7205054d59bb5a292bc8e2d87a984663ce1f0dac527d6d69d3940bc6e86735
-  data.tar.gz: 9b760d79ca5406fe3e78e4bd1276cb507464d72d2fc2e68cf5abf1f9920df1a6
+  metadata.gz: 11dd3401d408ed456da9b4dd0aca906b991a45a0103ca8786eafbf34d4659c85
+  data.tar.gz: 8469dd62a3660965daee589835e1481fe09e17b55cbd9d61c461d4ba94db833e
 SHA512:
-  metadata.gz: bf465a2d9af7e109b21ecd861cb88b556ee872e4d46e292e791f8f85ce131af7791254187bcc68216b9df0f1276296b5cf80e78be7193c11fdf16831b8da4f0f
-  data.tar.gz: 57fa298a96b7cd3eeb2be68d21261ae634f8e70d818a5c68b2e7cdcfa464d7d27b16e90aecbfb8192a4a3ff9fecc4fa8b94baa3b3b51d9c7c887f4fba2b07bd5
+  metadata.gz: 6d2e0c3d9c5bf11068b1d5e3092d4b5f3b233066a33b7e74ea218f115fbb8b154798a8b8b0634569781245f1dedcb6da3e5ca3a23db04f78fc105c496d2a3280
+  data.tar.gz: 529ce841833605ac40c67536bbca1eb1a9568b742de854f4698ced147813ec63569fd926d4035d518f7bb0ab54d2bbd4665e7ad2564923b49036573a0d4625e7

data/VERSION

@@ -1 +1 @@
-0.6.0
+0.6.1

data/lib/ruby_lsp/check_docs.rb

@@ -6,23 +6,26 @@ require "objspace"
 
 module RubyLsp
   # This rake task checks that all requests or extensions are fully documented. Add the rake task to your Rakefile and
-  # specify the absolute path for all files that must be required in order to discover all listeners
+  # specify the absolute path for all files that must be required in order to discover all listeners and their
+  # related GIFs
   #
   #   # Rakefile
   #   request_files = FileList.new("#{__dir__}/lib/ruby_lsp/requests/*.rb") do |fl|
   #     fl.exclude(/base_request\.rb/)
   #   end
-  #   RubyLsp::CheckDocs.new(request_files)
+  #   gif_files = FileList.new("#{__dir__}/**/*.gif")
+  #   RubyLsp::CheckDocs.new(request_files, gif_files)
   #   # Run with bundle exec rake ruby_lsp:check_docs
   class CheckDocs < Rake::TaskLib
     extend T::Sig
 
-    sig { params(require_files: Rake::FileList).void }
-    def initialize(require_files)
+    sig { params(require_files: Rake::FileList, gif_files: Rake::FileList).void }
+    def initialize(require_files, gif_files)
       super()
 
       @name = T.let("ruby_lsp:check_docs", String)
       @file_list = require_files
+      @gif_list = gif_files
       define_task
     end
 
@@ -34,6 +37,13 @@ module RubyLsp
       task(@name) { run_task }
     end
 
+    sig { params(request_path: String).returns(T::Boolean) }
+    def gif_exists?(request_path)
+      request_gif = request_path.gsub(".rb", ".gif").split("/").last
+
+      @gif_list.any? { |gif_path| gif_path.end_with?(request_gif) }
+    end
+
     sig { void }
     def run_task
       # Require all files configured to make sure all listeners are loaded
@@ -93,6 +103,14 @@ module RubyLsp
 
             # [Inlay hint demo](../../inlay_hint.gif)
           DOCS
+        elsif !gif_exists?(file_path)
+          T.must(missing_docs[class_name]) << <<~DOCS
+            The GIF for the request documentation does not exist. Make sure to add it,
+            with the same naming as the request. For example:
+
+            # lib/ruby_lsp/requests/code_lens.rb
+            # foo/bar/code_lens.gif
+          DOCS
         end
       end
 

data/lib/ruby_lsp/requests/code_lens.rb

@@ -80,11 +80,13 @@ module RubyLsp
 
       sig { params(node: SyntaxTree::DefNode).void }
       def on_def(node)
+        class_name = @class_stack.last
+        return unless class_name
+
         visibility, _ = @visibility_stack.last
         if visibility == "public"
           method_name = node.name.value
           if method_name.start_with?("test_")
-            class_name = T.must(@class_stack.last)
             add_test_code_lens(
               node,
               name: method_name,
@@ -193,8 +195,10 @@ module RubyLsp
 
       sig { params(node: SyntaxTree::Command).returns(T.nilable(String)) }
       def resolve_gem_remote(node)
-        gem_name = node.arguments.parts.flat_map(&:child_nodes).first.value
-        spec = Gem::Specification.stubs.find { |gem| gem.name == gem_name }&.to_spec
+        gem_statement = node.arguments.parts.flat_map(&:child_nodes).first
+        return unless gem_statement
+
+        spec = Gem::Specification.stubs.find { |gem| gem.name == gem_statement.value }&.to_spec
         return if spec.nil?
 
         [spec.homepage, spec.metadata["source_code_uri"]].compact.find do |page|

data/lib/ruby_lsp/requests/inlay_hints.rb

@@ -3,7 +3,7 @@
 
 module RubyLsp
   module Requests
-    # ![Inlay hint demo](../../inlay_hint.gif)
+    # ![Inlay hint demo](../../inlay_hints.gif)
     #
     # [Inlay hints](https://microsoft.github.io/language-server-protocol/specification#textDocument_inlayHint)
     # are labels added directly in the code that explicitly show the user something that might

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ruby-lsp
 version: !ruby/object:Gem::Version
-  version: 0.6.0
+  version: 0.6.1
 platform: ruby
 authors:
 - Shopify
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2023-06-16 00:00:00.000000000 Z
+date: 2023-06-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: language_server-protocol