ruby-lsp-rails 0.3.13 → 0.3.15

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e2543aa7d39f0a6b231112f9ddb365692c7e8d06eb14681da551ab55fd8f5a4d
-  data.tar.gz: e466ccd6d90934e083e638efdcedfb5d6b8f85fbce70b139e1542eeb2ab8a139
+  metadata.gz: 8864e641f204eaafb608b703228bd98d5a2234413f48ee1d1232f277b7385144
+  data.tar.gz: 3db424bb7e32fbd1a1dce231d56b9d98d92e23b0c9ef70f56cbab86b878f9133
 SHA512:
-  metadata.gz: 8f7c82462682d93fd6b944c2705c8b62b424b4abc3636d1f2540eeee1ab9f7e2896eb77d338697bb65a0a64752529085f38e49bd5a75bfc668fa9d31dd5b0d10
-  data.tar.gz: a8978fdebb07ba8b76dd10a725b3b3c736961f103cefa806fbc0302b494516e0a196105bf7fac9d114c963a62c8a706959d53f1509a4ed343e2e9d24633c4372
+  metadata.gz: 3820483222f6b082c3f939e9b797a71e775776fd3e5a3d9422a99ab1c3af992dce883a69781cf4b2a07e8492c87e3054a351df4f22c398fd12cb20c6a4472ff8
+  data.tar.gz: 72e7715cefc65926b7d8011933e0152f90ee896b6530cea5edec0b41c70be701ae55619ea9c73dbb60e4becaf73df9f48ce122448ab2f6688204eda1d85edfb8

data/README.md

@@ -2,15 +2,7 @@
 
 # Ruby LSP Rails
 
-Ruby LSP Rails is a [Ruby LSP](https://github.com/Shopify/ruby-lsp) addon for extra Rails editor features, such as:
-
-* Hover over an ActiveRecord model to reveal its schema.
-* Run or debug a test by clicking on the code lens which appears above the test class, or an individual test.
-* Navigate to associations, validations, callbacks and test cases using your editor's "Go to Symbol" feature, or outline view.
-* Jump to the definition of callbacks using your editor's "Go to Definition" feature.
-* Jump to the declaration of a route.
-* Code Lens allowing fast-forwarding or rewinding of migrations.
-* Code Lens showing the path that a route action corresponds to.
+Ruby LSP Rails is a [Ruby LSP](https://github.com/Shopify/ruby-lsp) addon for extra [Rails editor features](https://shopify.github.io/ruby-lsp-rails/FEATURES_md.html).
 
 ## Installation
 
@@ -22,7 +14,7 @@ There is no need to add the gem to your bundle.
 ## Documentation
 
 See the [documentation](https://shopify.github.io/ruby-lsp-rails) for more in-depth details about the
-[supported features](https://shopify.github.io/ruby-lsp-rails/RubyLsp/Rails.html).
+[supported features](https://shopify.github.io/ruby-lsp-rails/FEATURES_md.html).
 
 ## How Runtime Introspection Works
 

data/Rakefile

@@ -23,6 +23,7 @@ RDoc::Task.new do |rdoc|
   rdoc.rdoc_files.include("*.md", "lib/**/*.rb")
   rdoc.rdoc_dir = "docs"
   rdoc.markup = "markdown"
+  rdoc.title = "Ruby LSP Rails"
   rdoc.generator = "snapper"
   rdoc.options.push("--copy-files", "misc")
   rdoc.options.push("--copy-files", "LICENSE.txt")

data/lib/ruby_lsp/ruby_lsp_rails/addon.rb

@@ -26,23 +26,27 @@ module RubyLsp
 
         # We first initialize the client as a NullClient, so that we can start the server in a background thread. Until
         # the real client is initialized, features that depend on it will not be blocked by using the NullClient
-        @client = T.let(NullClient.new, RunnerClient)
+        @rails_runner_client = T.let(NullClient.new, RunnerClient)
+        @global_state = T.let(nil, T.nilable(GlobalState))
       end
 
+      sig { returns(RunnerClient) }
+      attr_reader :rails_runner_client
+
       sig { override.params(global_state: GlobalState, message_queue: Thread::Queue).void }
       def activate(global_state, message_queue)
-        @global_state = T.let(global_state, T.nilable(RubyLsp::GlobalState))
+        @global_state = global_state
         $stderr.puts("Activating Ruby LSP Rails addon v#{VERSION}")
         # Start booting the real client in a background thread. Until this completes, the client will be a NullClient
-        Thread.new { @client = RunnerClient.create_client }
+        Thread.new { @rails_runner_client = RunnerClient.create_client }
         register_additional_file_watchers(global_state: global_state, message_queue: message_queue)
 
-        T.must(@global_state).index.register_enhancement(IndexingEnhancement.new)
+        @global_state.index.register_enhancement(IndexingEnhancement.new)
       end
 
       sig { override.void }
       def deactivate
-        @client.shutdown
+        @rails_runner_client.shutdown
       end
 
       # Creates a new CodeLens listener. This method is invoked on every CodeLens request
@@ -54,7 +58,7 @@ module RubyLsp
         ).void
       end
       def create_code_lens_listener(response_builder, uri, dispatcher)
-        CodeLens.new(@client, T.must(@global_state), response_builder, uri, dispatcher)
+        CodeLens.new(@rails_runner_client, T.must(@global_state), response_builder, uri, dispatcher)
       end
 
       sig do
@@ -65,7 +69,7 @@ module RubyLsp
         ).void
       end
       def create_hover_listener(response_builder, node_context, dispatcher)
-        Hover.new(@client, response_builder, node_context, T.must(@global_state), dispatcher)
+        Hover.new(@rails_runner_client, response_builder, node_context, T.must(@global_state), dispatcher)
       end
 
       sig do
@@ -90,7 +94,7 @@ module RubyLsp
       end
       def create_definition_listener(response_builder, uri, node_context, dispatcher)
         index = T.must(@global_state).index
-        Definition.new(@client, response_builder, node_context, index, dispatcher)
+        Definition.new(@rails_runner_client, response_builder, node_context, index, dispatcher)
       end
 
       sig { params(changes: T::Array[{ uri: String, type: Integer }]).void }
@@ -98,7 +102,7 @@ module RubyLsp
         if changes.any? do |change|
              change[:uri].end_with?("db/schema.rb") || change[:uri].end_with?("structure.sql")
            end
-          @client.trigger_reload
+          @rails_runner_client.trigger_reload
         end
       end
 

data/lib/ruby_lsp/ruby_lsp_rails/code_lens.rb

@@ -138,22 +138,23 @@ module RubyLsp
         class_name = node.constant_path.slice
         superclass_name = node.superclass&.slice
 
+        # We need to use a stack because someone could define a nested class
+        # inside a controller. When we exit that nested class declaration, we are
+        # back in a controller context. This part is used in other places in the LSP
+        @constant_name_stack << [class_name, superclass_name]
+
         if class_name.end_with?("Test")
-          command = "#{test_command} #{@path}"
+          fully_qualified_name = @constant_name_stack.map(&:first).join("::")
+          command = "#{test_command} #{@path} --name \"/#{Shellwords.escape(fully_qualified_name)}(#|::)/\""
           add_test_code_lens(node, name: class_name, command: command, kind: :group)
           @group_id_stack.push(@group_id)
           @group_id += 1
         end
 
-        if superclass_name&.start_with?("ActiveRecord::Migration")
+        if @path && superclass_name&.start_with?("ActiveRecord::Migration")
           command = "#{migrate_command} VERSION=#{migration_version}"
           add_migrate_code_lens(node, name: class_name, command: command)
         end
-
-        # We need to use a stack because someone could define a nested class
-        # inside a controller. When we exit that nested class declaration, we are
-        # back in a controller context. This part is used in other places in the LSP
-        @constant_name_stack << [class_name, superclass_name]
       end
 
       sig { params(node: Prism::ClassNode).void }

data/lib/ruby_lsp/ruby_lsp_rails/document_symbol.rb

@@ -151,7 +151,8 @@ module RubyLsp
               selection_range: range_from_location(argument.location),
             )
           when Prism::ConstantReadNode, Prism::ConstantPathNode
-            name = argument.full_name
+            name = constant_name(argument)
+            next unless name
             next if name.empty?
 
             append_document_symbol(

data/lib/ruby_lsp/ruby_lsp_rails/runner_client.rb

@@ -63,8 +63,11 @@ module RubyLsp
         @stdout = T.let(stdout, IO)
         @stderr = T.let(stderr, IO)
         @wait_thread = T.let(wait_thread, Process::Waiter)
-        @stdin.binmode # for Windows compatibility
-        @stdout.binmode # for Windows compatibility
+
+        # We set binmode for Windows compatibility
+        @stdin.binmode
+        @stdout.binmode
+        @stderr.binmode
 
         $stderr.puts("Ruby LSP Rails booting server")
         count = 0
@@ -158,8 +161,6 @@ module RubyLsp
         [@stdin, @stdout, @stderr].all?(&:closed?) && !@wait_thread.alive?
       end
 
-      private
-
       sig do
         params(
           request: String,
@@ -171,6 +172,12 @@ module RubyLsp
         read_response
       end
 
+      # Notifications are like messages, but one-way, with no response sent back.
+      sig { params(request: String, params: T.nilable(T::Hash[Symbol, T.untyped])).void }
+      def send_notification(request, params = nil) = send_message(request, params)
+
+      private
+
       sig { overridable.params(request: String, params: T.nilable(T::Hash[Symbol, T.untyped])).void }
       def send_message(request, params = nil)
         message = { method: request }
@@ -184,10 +191,6 @@ module RubyLsp
         # The server connection died
       end
 
-      # Notifications are like messages, but one-way, with no response sent back.
-      sig { params(request: String, params: T.nilable(T::Hash[Symbol, T.untyped])).void }
-      def send_notification(request, params = nil) = send_message(request, params)
-
       sig { overridable.returns(T.nilable(T::Hash[Symbol, T.untyped])) }
       def read_response
         raw_response = @mutex.synchronize do

data/lib/ruby_lsp/ruby_lsp_rails/server.rb

@@ -12,10 +12,22 @@ module RubyLsp
       VOID = Object.new
 
       def initialize
-        $stdin.sync = true
-        $stdout.sync = true
-        $stdin.binmode
-        $stdout.binmode
+        # Grab references to the original pipes so that we can change the default output device further down
+        @stdin = $stdin
+        @stdout = $stdout
+        @stderr = $stderr
+        @stdin.sync = true
+        @stdout.sync = true
+        @stderr.sync = true
+        @stdin.binmode
+        @stdout.binmode
+        @stderr.binmode
+
+        # # Set the default output device to be $stderr. This means that using `puts` by itself will default to printing
+        # # to $stderr and only explicit `$stdout.puts` will go to $stdout. This reduces the chance that output coming
+        # # from the Rails app will be accidentally sent to the client
+        $> = $stderr
+
         @running = true
       end
 
@@ -25,18 +37,18 @@ module RubyLsp
         routes_reloader.execute_unless_loaded if routes_reloader&.respond_to?(:execute_unless_loaded)
 
         initialize_result = { result: { message: "ok", root: ::Rails.root.to_s } }.to_json
-        $stdout.write("Content-Length: #{initialize_result.length}\r\n\r\n#{initialize_result}")
+        @stdout.write("Content-Length: #{initialize_result.length}\r\n\r\n#{initialize_result}")
 
         while @running
-          headers = $stdin.gets("\r\n\r\n")
-          json = $stdin.read(headers[/Content-Length: (\d+)/i, 1].to_i)
+          headers = @stdin.gets("\r\n\r\n")
+          json = @stdin.read(headers[/Content-Length: (\d+)/i, 1].to_i)
 
           request = JSON.parse(json, symbolize_names: true)
           response = execute(request.fetch(:method), request[:params])
           next if response == VOID
 
           json_response = response.to_json
-          $stdout.write("Content-Length: #{json_response.length}\r\n\r\n#{json_response}")
+          @stdout.write("Content-Length: #{json_response.length}\r\n\r\n#{json_response}")
         end
       end
 

data/lib/ruby_lsp/ruby_lsp_rails/support/location_builder.rb

@@ -11,18 +11,18 @@ module RubyLsp
           sig { params(location_string: String).returns(Interface::Location) }
           def line_location_from_s(location_string)
             *file_parts, line = location_string.split(":")
-
-            raise ArgumentError, "Invalid location string given" unless file_parts
+            raise ArgumentError, "Invalid location string given" if file_parts.empty?
 
             # On Windows, file paths will look something like `C:/path/to/file.rb:123`. Only the last colon is the line
             # number and all other parts compose the file path
             file_path = file_parts.join(":")
+            line_as_number = line ? Integer(line.to_i) - 1 : 0
 
             Interface::Location.new(
               uri: URI::Generic.from_path(path: file_path).to_s,
               range: Interface::Range.new(
-                start: Interface::Position.new(line: Integer(line) - 1, character: 0),
-                end: Interface::Position.new(line: Integer(line) - 1, character: 0),
+                start: Interface::Position.new(line: line_as_number, character: 0),
+                end: Interface::Position.new(line: line_as_number, character: 0),
               ),
             )
           end

data/lib/ruby_lsp_rails/version.rb

@@ -3,6 +3,6 @@
 
 module RubyLsp
   module Rails
-    VERSION = "0.3.13"
+    VERSION = "0.3.15"
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ruby-lsp-rails
 version: !ruby/object:Gem::Version
-  version: 0.3.13
+  version: 0.3.15
 platform: ruby
 authors:
 - Shopify
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-08-15 00:00:00.000000000 Z
+date: 2024-09-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: ruby-lsp
@@ -80,7 +80,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.17
+rubygems_version: 3.5.18
 signing_key:
 specification_version: 4
 summary: A Ruby LSP addon for Rails