ruby-lsp-rails 0.3.15 → 0.3.17

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8864e641f204eaafb608b703228bd98d5a2234413f48ee1d1232f277b7385144
-  data.tar.gz: 3db424bb7e32fbd1a1dce231d56b9d98d92e23b0c9ef70f56cbab86b878f9133
+  metadata.gz: ba36df033667789339419a3ed19740d35ad9b91a3463cf2438bd390c4580aeb4
+  data.tar.gz: 7aa58db6217944f945ca3bb9bcdefeb4f018759acf8673e222ae8fb3b5c523ee
 SHA512:
-  metadata.gz: 3820483222f6b082c3f939e9b797a71e775776fd3e5a3d9422a99ab1c3af992dce883a69781cf4b2a07e8492c87e3054a351df4f22c398fd12cb20c6a4472ff8
-  data.tar.gz: 72e7715cefc65926b7d8011933e0152f90ee896b6530cea5edec0b41c70be701ae55619ea9c73dbb60e4becaf73df9f48ce122448ab2f6688204eda1d85edfb8
+  metadata.gz: a4ddf589e0065c32ee9087a4cfd0347d4e3dbdf5d1d667f1ca6a440ac1c6b2d1c18f41acfa2264f72114ecc4bfafec4c3c40748a3f6639a80c86093ca8e51cef
+  data.tar.gz: 2dbb86bd0f701865f3d833fb13079cfd9bd27310cdca2410664c7112db73e9915c9b633de1f527220a64055d3956009a738c367c956c3c08cd5c3ae71e04d7f1

data/README.md

@@ -1,35 +1,20 @@
 [![Ruby DX Slack](https://img.shields.io/badge/Slack-Ruby%20DX-success?logo=slack)](https://join.slack.com/t/ruby-dx/shared_invite/zt-2c8zjlir6-uUDJl8oIwcen_FS_aA~b6Q)
 
-# Ruby LSP Rails
+# Rails add-on
 
-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).
+The Rails add-on is a [Ruby LSP](https://github.com/Shopify/ruby-lsp) [add-on](https://shopify.github.io/ruby-lsp/add-ons.html) for extra [Rails editor features](https://shopify.github.io/ruby-lsp/rails-add-on.html).
 
 ## Installation
 
-If you haven't already done so, you'll need to first [set up Ruby LSP](https://github.com/Shopify/ruby-lsp#usage).
+If you haven't already done so, you'll need to first [set up Ruby LSP](https://shopify.github.io/ruby-lsp/#usage).
 
-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.
+As of v0.3.0, Ruby LSP will automatically include the Ruby LSP Rails add-on in its custom bundle when a Rails app is detected.
 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/FEATURES_md.html).
-
-## How Runtime Introspection 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).
-The addon communicates with this process over a pipe (i.e. `stdin` and `stdout`) to fetch runtime information about the application.
-
-When extension is stopped (e.g. by quitting the editor), the server instance is shut down.
-
-> [!NOTE]
-> 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.
+See the [documentation](https://shopify.github.io/ruby-lsp/rails-add-on.html) for more in-depth details about the
+[supported features](https://shopify.github.io/ruby-lsp/rails-add-on.html#features).
 
 ## Contributing
 

data/Rakefile

@@ -9,8 +9,6 @@ load "rails/tasks/statistics.rake"
 
 require "bundler/gem_tasks"
 require "rake/testtask"
-require "ruby_lsp/check_docs"
-require "rdoc/task"
 
 Rake::TestTask.new(:test) do |t|
   t.libs << "test"
@@ -18,17 +16,4 @@ Rake::TestTask.new(:test) do |t|
   t.test_files = FileList["test/**/*_test.rb"]
 end
 
-RDoc::Task.new do |rdoc|
-  rdoc.main = "README.md"
-  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")
-end
-
-RubyLsp::CheckDocs.new(FileList["#{__dir__}/lib/ruby_lsp/**/*.rb"], FileList["#{__dir__}/misc/**/*.gif"])
-
 task default: [:"db:setup", :test]

data/lib/ruby_lsp/ruby_lsp_rails/addon.rb

@@ -28,20 +28,32 @@ module RubyLsp
         # the real client is initialized, features that depend on it will not be blocked by using the NullClient
         @rails_runner_client = T.let(NullClient.new, RunnerClient)
         @global_state = T.let(nil, T.nilable(GlobalState))
+        @addon_mutex = T.let(Mutex.new, Mutex)
+        @client_mutex = T.let(Mutex.new, Mutex)
+        @client_mutex.lock
+
+        Thread.new do
+          @addon_mutex.synchronize do
+            # We need to ensure the Rails client is fully loaded before we activate the server addons
+            @client_mutex.synchronize { @rails_runner_client = RunnerClient.create_client }
+          end
+        end
       end
 
       sig { returns(RunnerClient) }
-      attr_reader :rails_runner_client
+      def rails_runner_client
+        @addon_mutex.synchronize { @rails_runner_client }
+      end
 
       sig { override.params(global_state: GlobalState, message_queue: Thread::Queue).void }
       def activate(global_state, message_queue)
         @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 { @rails_runner_client = RunnerClient.create_client }
+        $stderr.puts("Activating Ruby LSP Rails add-on v#{version}")
         register_additional_file_watchers(global_state: global_state, message_queue: message_queue)
-
         @global_state.index.register_enhancement(IndexingEnhancement.new)
+
+        # Start booting the real client in a background thread. Until this completes, the client will be a NullClient
+        @client_mutex.unlock
       end
 
       sig { override.void }
@@ -49,6 +61,11 @@ module RubyLsp
         @rails_runner_client.shutdown
       end
 
+      sig { override.returns(String) }
+      def version
+        VERSION
+      end
+
       # Creates a new CodeLens listener. This method is invoked on every CodeLens request
       sig do
         override.params(

data/lib/ruby_lsp/ruby_lsp_rails/code_lens.rb

@@ -198,9 +198,13 @@ module RubyLsp
           .gsub("::", "/")
           .downcase
 
-        view_uris = Dir.glob("#{@client.rails_root}/app/views/#{controller_name}/#{action_name}*").map! do |path|
+        view_uris = Dir.glob("#{@client.rails_root}/app/views/#{controller_name}/#{action_name}*").filter_map do |path|
+          # it's possible we could have a directory with the same name as the action, so we need to skip those
+          next if File.directory?(path)
+
           URI::Generic.from_path(path: path).to_s
         end
+
         return if view_uris.empty?
 
         @response_builder << create_code_lens(

data/lib/ruby_lsp/ruby_lsp_rails/indexing_enhancement.rb

@@ -59,7 +59,8 @@ module RubyLsp
           file_path,
           name_arg.location,
           name_arg.location,
-          [],
+          nil,
+          index.configuration.encoding,
           [RubyIndexer::Entry::Signature.new([])],
           RubyIndexer::Entry::Visibility::PUBLIC,
           owner,
@@ -71,7 +72,8 @@ module RubyLsp
           file_path,
           name_arg.location,
           name_arg.location,
-          [],
+          nil,
+          index.configuration.encoding,
           [RubyIndexer::Entry::Signature.new([RubyIndexer::Entry::RequiredParameter.new(name: name.to_sym)])],
           RubyIndexer::Entry::Visibility::PUBLIC,
           owner,

data/lib/ruby_lsp/ruby_lsp_rails/runner_client.rb

@@ -96,6 +96,14 @@ module RubyLsp
         raise InitializationError, @stderr.read
       end
 
+      sig { params(server_addon_path: String).void }
+      def register_server_addon(server_addon_path)
+        send_notification("server_addon/register", server_addon_path: server_addon_path)
+      rescue IncompleteMessageError
+        $stderr.puts("Ruby LSP Rails failed to register server addon #{server_addon_path}")
+        nil
+      end
+
       sig { params(name: String).returns(T.nilable(T::Hash[Symbol, T.untyped])) }
       def model(name)
         make_request("model", name: name)

data/lib/ruby_lsp/ruby_lsp_rails/server.rb

@@ -8,13 +8,56 @@ require "json"
 
 module RubyLsp
   module Rails
-    class Server
-      VOID = Object.new
+    class ServerAddon
+      @server_addon_classes = []
+      @server_addons = {}
+
+      class << self
+        # We keep track of runtime server add-ons the same way we track other add-ons, by storing classes that inherit
+        # from the base one
+        def inherited(child)
+          @server_addon_classes << child
+          super
+        end
+
+        # Delegate `request` with `params` to the server add-on with the given `name`
+        def delegate(name, request, params)
+          @server_addons[name]&.execute(request, params)
+        end
+
+        # Instantiate all server addons and store them in a hash for easy access after we have discovered the classes
+        def finalize_registrations!(stdout)
+          until @server_addon_classes.empty?
+            addon = @server_addon_classes.shift.new(stdout)
+            @server_addons[addon.name] = addon
+          end
+        end
+      end
+
+      def initialize(stdout)
+        @stdout = stdout
+      end
 
-      def initialize
+      # Write a response back. Can be used for sending notifications to the editor
+      def write_response(response)
+        json_response = response.to_json
+        @stdout.write("Content-Length: #{json_response.length}\r\n\r\n#{json_response}")
+      end
+
+      def name
+        raise NotImplementedError, "Not implemented!"
+      end
+
+      def execute(request, params)
+        raise NotImplementedError, "Not implemented!"
+      end
+    end
+
+    class Server
+      def initialize(stdout: $stdout, override_default_output_device: true)
         # Grab references to the original pipes so that we can change the default output device further down
         @stdin = $stdin
-        @stdout = $stdout
+        @stdout = stdout
         @stderr = $stderr
         @stdin.sync = true
         @stdout.sync = true
@@ -26,7 +69,7 @@ module RubyLsp
         # # 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
+        $> = $stderr if override_default_output_device
 
         @running = true
       end
@@ -44,11 +87,7 @@ module RubyLsp
           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}")
+          execute(request.fetch(:method), request[:params])
         end
       end
 
@@ -56,27 +95,35 @@ module RubyLsp
         case request
         when "shutdown"
           @running = false
-          VOID
         when "model"
-          resolve_database_info_from_model(params.fetch(:name))
+          write_response(resolve_database_info_from_model(params.fetch(:name)))
         when "association_target_location"
-          resolve_association_target(params)
+          write_response(resolve_association_target(params))
         when "reload"
           ::Rails.application.reloader.reload!
-          VOID
         when "route_location"
-          route_location(params.fetch(:name))
+          write_response(route_location(params.fetch(:name)))
         when "route_info"
-          resolve_route_info(params)
-        else
-          VOID
+          write_response(resolve_route_info(params))
+        when "server_addon/register"
+          require params[:server_addon_path]
+          ServerAddon.finalize_registrations!(@stdout)
+        when "server_addon/delegate"
+          server_addon_name = params.delete(:server_addon_name)
+          request_name = params.delete(:request_name)
+          ServerAddon.delegate(server_addon_name, request_name, params)
         end
       rescue => e
-        { error: e.full_message(highlight: false) }
+        write_response({ error: e.full_message(highlight: false) })
       end
 
       private
 
+      def write_response(response)
+        json_response = response.to_json
+        @stdout.write("Content-Length: #{json_response.length}\r\n\r\n#{json_response}")
+      end
+
       def resolve_route_info(requirements)
         if requirements[:controller]
           requirements[:controller] = requirements.fetch(:controller).underscore.delete_suffix("_controller")

data/lib/ruby_lsp_rails/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ruby-lsp-rails
 version: !ruby/object:Gem::Version
-  version: 0.3.15
+  version: 0.3.17
 platform: ruby
 authors:
 - Shopify
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-09-16 00:00:00.000000000 Z
+date: 2024-10-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: ruby-lsp
@@ -16,20 +16,20 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.17.12
+        version: 0.19.0
     - - "<"
       - !ruby/object:Gem::Version
-        version: 0.18.0
+        version: 0.20.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.17.12
+        version: 0.19.0
     - - "<"
       - !ruby/object:Gem::Version
-        version: 0.18.0
+        version: 0.20.0
 description: A Ruby LSP addon that adds extra editor functionality for Rails applications
 email:
 - ruby@shopify.com
@@ -65,6 +65,7 @@ metadata:
   homepage_uri: https://github.com/Shopify/ruby-lsp-rails
   source_code_uri: https://github.com/Shopify/ruby-lsp-rails
   changelog_uri: https://github.com/Shopify/ruby-lsp-rails/releases
+  documentation_uri: https://shopify.github.io/ruby-lsp/rails-add-on.html
 post_install_message:
 rdoc_options: []
 require_paths:
@@ -80,7 +81,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.18
+rubygems_version: 3.5.20
 signing_key:
 specification_version: 4
 summary: A Ruby LSP addon for Rails