ruby-lsp-rails 0.3.2 → 0.3.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7b68f8a0b2e4d7d4fa32aa2712865dea5c4734c86aa6a490c2a7ace718e3405a
-  data.tar.gz: a146d2ff4091073a9517147dffd3f5326337b947563ed39848d3a823662b5fdc
+  metadata.gz: 0c6faaac7ecd3824bd041d7273207db6c8611306ef0a33d7d02eb42cc8e931c0
+  data.tar.gz: 26ee8d231aab1512d52547056838f42a194265645fceb80dc9c02d77eba0e286
 SHA512:
-  metadata.gz: 8902056649daff38b9c6e73231ecc0fb55485d4789d52b9dbf92afe4983104082a959b242b1a9f898d3697344663a678da952b0c0a4f76db026ef07c4744fe52
-  data.tar.gz: 7550880a0a82da99734d38178c5aa47a1909b1787f2070bbf960f2b70ea177a3dd330484428b220de10d3d511a93b7f87a736dfbaf5c47bd12c50f547da15858
+  metadata.gz: e6d4711e5a31d9a59b4648e693796ab1398c04abe9b00e55627a6815b989751b8764d0c33a26679a4530aeadf8900d0f7d0f59b0dd0ab55fb68365be831f2199
+  data.tar.gz: e55de08bde09f2b065ec8820ac29f831ec094efdb23eb8ce930f488c851ad3b4e183ef7f0dafca5d16d511ffa87ae0be20bba4c903a0d4b6d9b2dee2532df369

data/README.md

@@ -7,37 +7,26 @@ Ruby LSP Rails is a [Ruby LSP](https://github.com/Shopify/ruby-lsp) addon for ex
 
 ## Installation
 
-To install, add the following line to your application's Gemfile:
+If you haven't already done so, you'll need to first [set up Ruby LSP](https://github.com/Shopify/ruby-lsp#usage).
 
-```ruby
-# Gemfile
-group :development do
-  gem "ruby-lsp-rails"
-end
-```
+As of v0.3.0, Ruby LSP will automatically include the Ruby LSP Rails addon in its custom bundle when a Rails app is detected.
+There is no need to add the gem to your bundle.
 
-## Usage
+## Features
 
-### Hover to reveal ActiveRecord schema
+* 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 validations, callbacks and test cases using your editor's "Go to Symbol" feature, or outline view.
 
-1. Start your Rails server
-1. Hover over an ActiveRecord model to see its details
-
-### Documentation
+## 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).
 
-### Running Tests
-
-1. Open a test which inherits from `ActiveSupport::TestCase` or one of its descendants, such as `ActionDispatch::IntegrationTest`.
-2. Click on the "Run", "Run in Terminal" or "Debug" code lens which appears above the test class, or an individual test.
-
-> [!NOTE]
-> When using the Test Explorer view, if your code contains a statement to pause execution (e.g. `debugger`) it will
-> cause the test runner to hang.
+## How Runtime Introspection Works
 
-## How It Works
+LSP tooling is typically based on static analysis, but `ruby-lsp-rails` actually communicates with your Rails app for
+some features.
 
 When Ruby LSP Rails starts, it spawns a `rails runner` instance which runs
 [`server.rb`](https://github.com/Shopify/ruby-lsp-rails/blob/main/lib/ruby_lsp/ruby_lsp_rails/server.rb).
@@ -46,7 +35,7 @@ The addon communicates with this process over a pipe (i.e. `stdin` and `stdout`)
 When extension is stopped (e.g. by quitting the editor), the server instance is shut down.
 
 > [!NOTE]
-> Prior to v0.3, `ruby-lsp-rails` used a different approach which involved mounting a Rack application within the Rails app.
+> Prior to v0.3.0, `ruby-lsp-rails` used a different approach which involved mounting a Rack application within the Rails app.
 > That approach was brittle and susceptible to the application's configuration, such as routing and middleware.
 
 ## Contributing

data/lib/ruby-lsp-rails.rb

@@ -9,6 +9,7 @@ module RubyLsp
   #
   # - [Hover](rdoc-ref:RubyLsp::Rails::Hover)
   # - [CodeLens](rdoc-ref:RubyLsp::Rails::CodeLens)
+  # - [DocumentSymbol](rdoc-ref:RubyLsp::Rails::DocumentSymbol)
   module Rails
   end
 end

data/lib/ruby_lsp/ruby_lsp_rails/addon.rb

@@ -68,6 +68,15 @@ module RubyLsp
         DocumentSymbol.new(response_builder, dispatcher)
       end
 
+      sig { params(changes: T::Array[{ uri: String, type: Integer }]).void }
+      def workspace_did_change_watched_files(changes)
+        if changes.any? do |change|
+             change[:uri].end_with?("db/schema.rb") || change[:uri].end_with?("structure.sql")
+           end
+          @client.trigger_reload
+        end
+      end
+
       sig { override.returns(String) }
       def name
         "Ruby LSP Rails"

data/lib/ruby_lsp/ruby_lsp_rails/code_lens.rb

@@ -12,7 +12,9 @@ module RubyLsp
     #
     # The
     # [code lens](https://microsoft.github.io/language-server-protocol/specification#textDocument_codeLens)
-    # request informs the editor of runnable commands such as tests
+    # request informs the editor of runnable commands such as tests.
+    # It's available for tests which inherit from `ActiveSupport::TestCase` or one of its descendants, such as
+    # `ActionDispatch::IntegrationTest`.
     #
     # # Example:
     #
@@ -32,6 +34,9 @@ module RubyLsp
     # ````
     #
     # The code lenses will be displayed above the class and above each test method.
+    #
+    # Note: When using the Test Explorer view, if your code contains a statement to pause execution (e.g. `debugger`) it
+    # will cause the test runner to hang.
     class CodeLens
       extend T::Sig
       include Requests::Support::Common

data/lib/ruby_lsp/ruby_lsp_rails/document_symbol.rb

@@ -12,6 +12,63 @@ module RubyLsp
       include Requests::Support::Common
       include ActiveSupportTestCaseHelper
 
+      MODEL_CALLBACKS = T.let(
+        [
+          "before_validation",
+          "after_validation",
+          "before_save",
+          "around_save",
+          "after_save",
+          "before_create",
+          "around_create",
+          "after_create",
+          "after_commit",
+          "after_rollback",
+          "before_update",
+          "around_update",
+          "after_update",
+          "before_destroy",
+          "around_destroy",
+          "after_destroy",
+          "after_initialize",
+          "after_find",
+          "after_touch",
+        ].freeze,
+        T::Array[String],
+      )
+
+      CONTROLLER_CALLBACKS = T.let(
+        [
+          "after_action",
+          "append_after_action",
+          "append_around_action",
+          "append_before_action",
+          "around_action",
+          "before_action",
+          "prepend_after_action",
+          "prepend_around_action",
+          "prepend_before_action",
+          "skip_after_action",
+          "skip_around_action",
+          "skip_before_action",
+        ].freeze,
+        T::Array[String],
+      )
+
+      JOB_CALLBACKS = T.let(
+        [
+          "after_enqueue",
+          "after_perform",
+          "around_enqueue",
+          "around_perform",
+          "before_enqueue",
+          "before_perform",
+        ].freeze,
+        T::Array[String],
+      )
+
+      CALLBACKS = T.let((MODEL_CALLBACKS + CONTROLLER_CALLBACKS + JOB_CALLBACKS).freeze, T::Array[String])
+
       sig do
         params(
           response_builder: ResponseBuilders::DocumentSymbol,
@@ -28,13 +85,161 @@ module RubyLsp
       def on_call_node_enter(node)
         content = extract_test_case_name(node)
 
-        return unless content
+        if content
+          append_document_symbol(
+            name: content,
+            selection_range: range_from_node(node),
+            range: range_from_node(node),
+          )
+        end
+
+        receiver = node.receiver
+        return if receiver && !receiver.is_a?(Prism::SelfNode)
+
+        message = node.message
+        case message
+        when *CALLBACKS, "validate"
+          handle_all_arg_types(node, T.must(message))
+        when "validates", "validates!", "validates_each"
+          handle_symbol_and_string_arg_types(node, T.must(message))
+        when "validates_with"
+          handle_class_arg_types(node, T.must(message))
+        end
+      end
+
+      private
+
+      sig { params(node: Prism::CallNode, message: String).void }
+      def handle_all_arg_types(node, message)
+        block = node.block
+
+        if block
+          append_document_symbol(
+            name: "#{message}(<anonymous>)",
+            range: range_from_location(node.location),
+            selection_range: range_from_location(block.location),
+          )
+          return
+        end
+
+        arguments = node.arguments&.arguments
+        return unless arguments&.any?
+
+        arguments.each do |argument|
+          case argument
+          when Prism::SymbolNode
+            name = argument.value
+            next unless name
+
+            append_document_symbol(
+              name: "#{message}(#{name})",
+              range: range_from_location(argument.location),
+              selection_range: range_from_location(T.must(argument.value_loc)),
+            )
+          when Prism::StringNode
+            name = argument.content
+            next if name.empty?
+
+            append_document_symbol(
+              name: "#{message}(#{name})",
+              range: range_from_location(argument.location),
+              selection_range: range_from_location(argument.content_loc),
+            )
+          when Prism::LambdaNode
+            append_document_symbol(
+              name: "#{message}(<anonymous>)",
+              range: range_from_location(node.location),
+              selection_range: range_from_location(argument.location),
+            )
+          when Prism::CallNode
+            next unless argument.name == :new
+
+            arg_receiver = argument.receiver
+
+            name = arg_receiver.name if arg_receiver.is_a?(Prism::ConstantReadNode)
+            name = arg_receiver.full_name if arg_receiver.is_a?(Prism::ConstantPathNode)
+            next unless name
 
+            append_document_symbol(
+              name: "#{message}(#{name})",
+              range: range_from_location(argument.location),
+              selection_range: range_from_location(argument.location),
+            )
+          when Prism::ConstantReadNode, Prism::ConstantPathNode
+            name = argument.full_name
+            next if name.empty?
+
+            append_document_symbol(
+              name: "#{message}(#{name})",
+              range: range_from_location(argument.location),
+              selection_range: range_from_location(argument.location),
+            )
+          end
+        end
+      end
+
+      sig { params(node: Prism::CallNode, message: String).void }
+      def handle_symbol_and_string_arg_types(node, message)
+        arguments = node.arguments&.arguments
+        return unless arguments&.any?
+
+        arguments.each do |argument|
+          case argument
+          when Prism::SymbolNode
+            name = argument.value
+            next unless name
+
+            append_document_symbol(
+              name: "#{message}(#{name})",
+              range: range_from_location(argument.location),
+              selection_range: range_from_location(T.must(argument.value_loc)),
+            )
+          when Prism::StringNode
+            name = argument.content
+            next if name.empty?
+
+            append_document_symbol(
+              name: "#{message}(#{name})",
+              range: range_from_location(argument.location),
+              selection_range: range_from_location(argument.content_loc),
+            )
+          end
+        end
+      end
+
+      sig { params(node: Prism::CallNode, message: String).void }
+      def handle_class_arg_types(node, message)
+        arguments = node.arguments&.arguments
+        return unless arguments&.any?
+
+        arguments.each do |argument|
+          case argument
+          when Prism::ConstantReadNode, Prism::ConstantPathNode
+            name = argument.full_name
+            next if name.empty?
+
+            append_document_symbol(
+              name: "#{message}(#{name})",
+              range: range_from_location(argument.location),
+              selection_range: range_from_location(argument.location),
+            )
+          end
+        end
+      end
+
+      sig do
+        params(
+          name: String,
+          range: RubyLsp::Interface::Range,
+          selection_range: RubyLsp::Interface::Range,
+        ).void
+      end
+      def append_document_symbol(name:, range:, selection_range:)
         @response_builder.last.children << RubyLsp::Interface::DocumentSymbol.new(
-          name: content,
-          kind: LanguageServer::Protocol::Constant::SymbolKind::METHOD,
-          selection_range: range_from_node(node),
-          range: range_from_node(node),
+          name: name,
+          kind: RubyLsp::Constant::SymbolKind::METHOD,
+          range: range,
+          selection_range: selection_range,
         )
       end
     end

data/lib/ruby_lsp/ruby_lsp_rails/runner_client.rb

@@ -12,10 +12,18 @@ module RubyLsp
 
         sig { returns(RunnerClient) }
         def create_client
-          new
+          if File.exist?("bin/rails")
+            new
+          else
+            $stderr.puts(<<~MSG)
+              Ruby LSP Rails failed to locate bin/rails in the current directory: #{Dir.pwd}"
+            MSG
+            $stderr.puts("Server dependent features will not be available")
+            NullClient.new
+          end
         rescue Errno::ENOENT, StandardError => e # rubocop:disable Lint/ShadowedException
-          warn("Ruby LSP Rails failed to initialize server: #{e.message}\n#{e.backtrace&.join("\n")}")
-          warn("Server dependent features will not be available")
+          $stderr.puts("Ruby LSP Rails failed to initialize server: #{e.message}\n#{e.backtrace&.join("\n")}")
+          $stderr.puts("Server dependent features will not be available")
           NullClient.new
         end
       end
@@ -50,14 +58,14 @@ module RubyLsp
         @stdin.binmode # for Windows compatibility
         @stdout.binmode # for Windows compatibility
 
-        warn("Ruby LSP Rails booting server")
+        $stderr.puts("Ruby LSP Rails booting server")
         read_response
-        warn("Finished booting Ruby LSP Rails server")
+        $stderr.puts("Finished booting Ruby LSP Rails server")
 
         unless ENV["RAILS_ENV"] == "test"
           at_exit do
             if @wait_thread.alive?
-              warn("Ruby LSP Rails is force killing the server")
+              $stderr.puts("Ruby LSP Rails is force killing the server")
               sleep(0.5) # give the server a bit of time if we already issued a shutdown notification
               Process.kill(T.must(Signal.list["TERM"]), @wait_thread.pid)
             end
@@ -71,13 +79,22 @@ module RubyLsp
       def model(name)
         make_request("model", name: name)
       rescue IncompleteMessageError
-        warn("Ruby LSP Rails failed to get model information: #{@stderr.read}")
+        $stderr.puts("Ruby LSP Rails failed to get model information: #{@stderr.read}")
+        nil
+      end
+
+      sig { void }
+      def trigger_reload
+        $stderr.puts("Reloading Rails application")
+        send_notification("reload")
+      rescue IncompleteMessageError
+        $stderr.puts("Ruby LSP Rails failed to trigger reload")
         nil
       end
 
       sig { void }
       def shutdown
-        warn("Ruby LSP Rails shutting down server")
+        $stderr.puts("Ruby LSP Rails shutting down server")
         send_message("shutdown")
         sleep(0.5) # give the server a bit of time to shutdown
         [@stdin, @stdout, @stderr].each(&:close)
@@ -121,7 +138,7 @@ module RubyLsp
         response = JSON.parse(T.must(raw_response), symbolize_names: true)
 
         if response[:error]
-          warn("Ruby LSP Rails error: " + response[:error])
+          $stderr.puts("Ruby LSP Rails error: " + response[:error])
           return
         end
 

data/lib/ruby_lsp/ruby_lsp_rails/server.rb

@@ -57,16 +57,19 @@ module RubyLsp
       sig do
         params(
           request: String,
-          params: T::Hash[Symbol, T.untyped],
+          params: T.nilable(T::Hash[Symbol, T.untyped]),
         ).returns(T.any(Object, T::Hash[Symbol, T.untyped]))
       end
-      def execute(request, params = {})
+      def execute(request, params)
         case request
         when "shutdown"
           @running = false
           VOID
         when "model"
-          resolve_database_info_from_model(params.fetch(:name))
+          resolve_database_info_from_model(T.must(params).fetch(:name))
+        when "reload"
+          ::Rails.application.reloader.reload!
+          VOID
         else
           VOID
         end

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

@@ -11,8 +11,6 @@ module RubyLsp
         message_value = node.message
         return unless message_value == "test" || message_value == "it"
 
-        return unless node.arguments
-
         arguments = node.arguments&.arguments
         return unless arguments&.any?
 

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

@@ -66,7 +66,7 @@ module RubyLsp
           private def build_search_index
             return unless RAILTIES_VERSION
 
-            warn("Fetching Rails Documents...")
+            $stderr.puts("Fetching Rails Documents...")
 
             response = Net::HTTP.get_response(URI("#{RAILS_DOC_HOST}/v#{RAILTIES_VERSION}/js/search_index.js"))
 
@@ -79,13 +79,13 @@ module RubyLsp
               response = Net::HTTP.get_response(URI("#{RAILS_DOC_HOST}/js/search_index.js"))
               response.body if response.is_a?(Net::HTTPSuccess)
             else
-              warn("Response failed: #{response.inspect}")
+              $stderr.puts("Response failed: #{response.inspect}")
               nil
             end
 
             process_search_index(body) if body
           rescue StandardError => e
-            warn("Exception occurred when fetching Rails document index: #{e.inspect}")
+            $stderr.puts("Exception occurred when fetching Rails document index: #{e.inspect}")
           end
 
           sig { params(js: String).returns(T::Hash[String, T::Array[T::Hash[Symbol, String]]]) }

data/lib/ruby_lsp_rails/version.rb

@@ -3,6 +3,6 @@
 
 module RubyLsp
   module Rails
-    VERSION = "0.3.2"
+    VERSION = "0.3.3"
   end
 end

data/lib/tasks/ruby_lsp_rails_tasks.rake

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 # desc "Explaining what the task does"
 # task :ruby_lsp_rails do
 #   # Task goes here

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ruby-lsp-rails
 version: !ruby/object:Gem::Version
-  version: 0.3.2
+  version: 0.3.3
 platform: ruby
 authors:
 - Shopify
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2024-02-29 00:00:00.000000000 Z
+date: 2024-03-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: actionpack