ruby-lsp-rails 0.3.27 → 0.3.31

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2df24f43b3e6666c310cb91e43d3b4311eea8326e27aa7bb4278c9fd03de42d1
-  data.tar.gz: 116f736d81055adf4a287d3d76a4f9e641cf2ac81f2a39b63ccb9603bfbd351e
+  metadata.gz: b1d9f0d516dcad6d833e05e05defd6ba7ea0bbb3fb2b0c48e7edb9709306d854
+  data.tar.gz: 41b2f9dec0e1ba1d3d4d92a5eb1b4ad5dfd6b6d8c3e62b69822ac156f3232bfd
 SHA512:
-  metadata.gz: c462629b903ebbee663323f52385423fb697bd338bcf7c57574874de21f323230d381c5d6e5eb30602248f33021bc2d0082602fa3b5c0b65d674f9c9c1668ff5
-  data.tar.gz: e909ea43dc3a8012f1de165e1aa4cbf4ad0873134199273103e329fec5ac141792113adb5eb1eb788f065f63e3c2fba299c0501a837719a816b2698e119e50bf
+  metadata.gz: f4421fb81f4cffaa89abe05244ec8bcc2da8ffa0e27b5f7c310c49747d7b2e20a6eec85b58dfe77f5107bd8281ca9d2e61a5f70b2d100c5938f4a2932deedfd0
+  data.tar.gz: aa8476c6f72a66782d9d8b3225944c862f708cd9fc60fd17cf871d9f3332885bd0b7060cbf778710e9213686d5e24c1e415327c14a00a738e28f934dfae156c7

data/lib/ruby-lsp-rails.rb

@@ -2,15 +2,3 @@
 # frozen_string_literal: true
 
 require "ruby_lsp_rails/version"
-require "ruby_lsp_rails/railtie"
-
-module RubyLsp
-  # # Supported features
-  #
-  # - [Hover](rdoc-ref:RubyLsp::Rails::Hover)
-  # - [CodeLens](rdoc-ref:RubyLsp::Rails::CodeLens)
-  # - [DocumentSymbol](rdoc-ref:RubyLsp::Rails::DocumentSymbol)
-  # - [Definition](rdoc-ref:RubyLsp::Rails::Definition)
-  module Rails
-  end
-end

data/lib/ruby_lsp/ruby_lsp_rails/addon.rb

@@ -13,6 +13,7 @@ require_relative "hover"
 require_relative "code_lens"
 require_relative "document_symbol"
 require_relative "definition"
+require_relative "completion"
 require_relative "indexing_enhancement"
 
 module RubyLsp
@@ -119,6 +120,18 @@ module RubyLsp
         Definition.new(@rails_runner_client, response_builder, node_context, index, dispatcher)
       end
 
+      sig do
+        override.params(
+          response_builder: ResponseBuilders::CollectionResponseBuilder[Interface::CompletionItem],
+          node_context: NodeContext,
+          dispatcher: Prism::Dispatcher,
+          uri: URI::Generic,
+        ).void
+      end
+      def create_completion_listener(response_builder, node_context, dispatcher, uri)
+        Completion.new(@rails_runner_client, response_builder, node_context, dispatcher, uri)
+      end
+
       sig { params(changes: T::Array[{ uri: String, type: Integer }]).void }
       def workspace_did_change_watched_files(changes)
         if changes.any? { |c| c[:uri].end_with?("db/schema.rb") || c[:uri].end_with?("structure.sql") }
@@ -210,12 +223,7 @@ module RubyLsp
                 id: "workspace/didChangeWatchedFilesRails",
                 method: "workspace/didChangeWatchedFiles",
                 register_options: Interface::DidChangeWatchedFilesRegistrationOptions.new(
-                  watchers: [
-                    Interface::FileSystemWatcher.new(
-                      glob_pattern: "**/*structure.sql",
-                      kind: Constant::WatchKind::CREATE | Constant::WatchKind::CHANGE | Constant::WatchKind::DELETE,
-                    ),
-                  ],
+                  watchers: [structure_sql_file_watcher, fixture_file_watcher],
                 ),
               ),
             ],
@@ -223,6 +231,22 @@ module RubyLsp
         )
       end
 
+      sig { returns(Interface::FileSystemWatcher) }
+      def structure_sql_file_watcher
+        Interface::FileSystemWatcher.new(
+          glob_pattern: "**/*structure.sql",
+          kind: Constant::WatchKind::CREATE | Constant::WatchKind::CHANGE | Constant::WatchKind::DELETE,
+        )
+      end
+
+      sig { returns(Interface::FileSystemWatcher) }
+      def fixture_file_watcher
+        Interface::FileSystemWatcher.new(
+          glob_pattern: "**/fixtures/**/*.{yml,yaml,yml.erb,yaml.erb}",
+          kind: Constant::WatchKind::CREATE | Constant::WatchKind::CHANGE | Constant::WatchKind::DELETE,
+        )
+      end
+
       sig { void }
       def offer_to_run_pending_migrations
         return unless @outgoing_queue

data/lib/ruby_lsp/ruby_lsp_rails/code_lens.rb

@@ -254,7 +254,7 @@ module RubyLsp
 
         @response_builder << create_code_lens(
           node,
-          title: "Run",
+          title: "▶ Run",
           command_name: "rubyLsp.runTask",
           arguments: [command],
           data: { type: "migrate" },
@@ -283,7 +283,7 @@ module RubyLsp
 
         @response_builder << create_code_lens(
           node,
-          title: "Run",
+          title: "▶ Run",
           command_name: "rubyLsp.runTest",
           arguments: arguments,
           data: { type: "test", **grouping_data },
@@ -291,7 +291,7 @@ module RubyLsp
 
         @response_builder << create_code_lens(
           node,
-          title: "Run In Terminal",
+          title: "▶ Run In Terminal",
           command_name: "rubyLsp.runTestInTerminal",
           arguments: arguments,
           data: { type: "test_in_terminal", **grouping_data },

data/lib/ruby_lsp/ruby_lsp_rails/completion.rb

@@ -0,0 +1,92 @@
+# typed: strict
+# frozen_string_literal: true
+
+module RubyLsp
+  module Rails
+    class Completion
+      extend T::Sig
+      include Requests::Support::Common
+
+      sig do
+        override.params(
+          client: RunnerClient,
+          response_builder: ResponseBuilders::CollectionResponseBuilder[Interface::CompletionItem],
+          node_context: NodeContext,
+          dispatcher: Prism::Dispatcher,
+          uri: URI::Generic,
+        ).void
+      end
+      def initialize(client, response_builder, node_context, dispatcher, uri)
+        @response_builder = response_builder
+        @client = client
+        @node_context = node_context
+        dispatcher.register(
+          self,
+          :on_call_node_enter,
+        )
+      end
+
+      sig { params(node: Prism::CallNode).void }
+      def on_call_node_enter(node)
+        call_node = @node_context.call_node
+        return unless call_node
+
+        receiver = call_node.receiver
+        if call_node.name == :where && receiver.is_a?(Prism::ConstantReadNode)
+          handle_active_record_where_completions(node: node, receiver: receiver)
+        end
+      end
+
+      private
+
+      sig { params(node: Prism::CallNode, receiver: Prism::ConstantReadNode).void }
+      def handle_active_record_where_completions(node:, receiver:)
+        resolved_class = @client.model(receiver.name.to_s)
+        return if resolved_class.nil?
+
+        arguments = T.must(@node_context.call_node).arguments&.arguments
+        indexed_call_node_args = T.let({}, T::Hash[String, Prism::Node])
+
+        if arguments
+          indexed_call_node_args = index_call_node_args(arguments: arguments)
+          return if indexed_call_node_args.values.any? { |v| v == node }
+        end
+
+        range = range_from_location(node.location)
+
+        resolved_class[:columns].each do |column|
+          next unless column[0].start_with?(node.name.to_s)
+          next if indexed_call_node_args.key?(column[0])
+
+          @response_builder << Interface::CompletionItem.new(
+            label: column[0],
+            filter_text: column[0],
+            label_details: Interface::CompletionItemLabelDetails.new(
+              description: "Filter #{receiver.name} records by #{column[0]}",
+            ),
+            text_edit: Interface::TextEdit.new(range: range, new_text: "#{column[0]}: "),
+            kind: Constant::CompletionItemKind::FIELD,
+          )
+        end
+      end
+
+      sig { params(arguments: T::Array[Prism::Node]).returns(T::Hash[String, Prism::Node]) }
+      def index_call_node_args(arguments:)
+        indexed_call_node_args = {}
+        arguments.each do |argument|
+          next unless argument.is_a?(Prism::KeywordHashNode)
+
+          argument.elements.each do |e|
+            next unless e.is_a?(Prism::AssocNode)
+
+            key = e.key
+            if key.is_a?(Prism::SymbolNode)
+              indexed_call_node_args[key.value] = e.value
+            end
+          end
+        end
+        indexed_call_node_args
+      end
+    end
+  end
+end

data/lib/ruby_lsp/ruby_lsp_rails/definition.rb

@@ -144,15 +144,9 @@ module RubyLsp
         return unless methods
 
         methods.each do |target_method|
-          location = target_method.location
-          file_path = target_method.file_path
-
           @response_builder << Interface::Location.new(
-            uri: URI::Generic.from_path(path: file_path).to_s,
-            range: Interface::Range.new(
-              start: Interface::Position.new(line: location.start_line - 1, character: location.start_column),
-              end: Interface::Position.new(line: location.end_line - 1, character: location.end_column),
-            ),
+            uri: target_method.uri.to_s,
+            range: range_from_location(target_method.location),
           )
         end
       end

data/lib/ruby_lsp/ruby_lsp_rails/runner_client.rb

@@ -105,6 +105,8 @@ module RubyLsp
             while (content = @stderr.gets("\n"))
               log_message(content, type: RubyLsp::Constant::MessageType::LOG)
             end
+          rescue IOError
+            # The server was shutdown and stderr is already closed
           end,
           Thread,
         )
@@ -281,7 +283,7 @@ module RubyLsp
         json = message.to_json
 
         @mutex.synchronize do
-          @stdin.write("Content-Length: #{json.length}\r\n\r\n", json)
+          @stdin.write("Content-Length: #{json.bytesize}\r\n\r\n", json)
         end
       rescue Errno::EPIPE
         # The server connection died

data/lib/ruby_lsp/ruby_lsp_rails/server.rb

@@ -4,16 +4,13 @@
 require "json"
 require "open3"
 
-# NOTE: We should avoid printing to stderr since it causes problems. We never read the standard error pipe from the
-# client, so it will become full and eventually hang or crash. Instead, return a response with an `error` key.
-
 module RubyLsp
   module Rails
     module Common
       # Write a message to the client. Can be used for sending notifications to the editor
       def send_message(message)
         json_message = message.to_json
-        @stdout.write("Content-Length: #{json_message.length}\r\n\r\n#{json_message}")
+        @stdout.write("Content-Length: #{json_message.bytesize}\r\n\r\n#{json_message}")
       end
 
       # Log a message to the editor's output panel
@@ -125,6 +122,7 @@ module RubyLsp
 
       def start
         load_routes
+        clear_file_system_resolver_hooks
         send_result({ message: "ok", root: ::Rails.root.to_s })
 
         while @running
@@ -302,6 +300,18 @@ module RubyLsp
           routes_reloader.execute_unless_loaded if routes_reloader&.respond_to?(:execute_unless_loaded)
         end
       end
+
+      # File system resolver hooks spawn file watcher threads which introduce unnecessary overhead since the LSP already
+      # watches files. Since the Rails application is already booted by the time we reach this script, we can't no-op
+      # the file watcher implementation. Instead, we clear the hooks to prevent the registered file watchers from being
+      # instantiated
+      def clear_file_system_resolver_hooks
+        return unless defined?(::ActionView::PathRegistry)
+
+        with_notification_error_handling("clear_file_system_resolver_hooks") do
+          ::ActionView::PathRegistry.file_system_resolver_hooks.clear
+        end
+      end
     end
   end
 end

data/lib/ruby_lsp_rails/version.rb

@@ -3,6 +3,6 @@
 
 module RubyLsp
   module Rails
-    VERSION = "0.3.27"
+    VERSION = "0.3.31"
   end
 end

metadata

@@ -1,14 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: ruby-lsp-rails
 version: !ruby/object:Gem::Version
-  version: 0.3.27
+  version: 0.3.31
 platform: ruby
 authors:
 - Shopify
-autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-11-22 00:00:00.000000000 Z
+date: 2025-01-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: ruby-lsp
@@ -16,20 +15,20 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.22.0
+        version: 0.23.0
     - - "<"
       - !ruby/object:Gem::Version
-        version: 0.23.0
+        version: 0.24.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.22.0
+        version: 0.23.0
     - - "<"
       - !ruby/object:Gem::Version
-        version: 0.23.0
+        version: 0.24.0
 description: A Ruby LSP addon that adds extra editor functionality for Rails applications
 email:
 - ruby@shopify.com
@@ -43,6 +42,7 @@ files:
 - lib/ruby-lsp-rails.rb
 - lib/ruby_lsp/ruby_lsp_rails/addon.rb
 - lib/ruby_lsp/ruby_lsp_rails/code_lens.rb
+- lib/ruby_lsp/ruby_lsp_rails/completion.rb
 - lib/ruby_lsp/ruby_lsp_rails/definition.rb
 - lib/ruby_lsp/ruby_lsp_rails/document_symbol.rb
 - lib/ruby_lsp/ruby_lsp_rails/hover.rb
@@ -53,7 +53,6 @@ files:
 - lib/ruby_lsp/ruby_lsp_rails/support/associations.rb
 - lib/ruby_lsp/ruby_lsp_rails/support/callbacks.rb
 - lib/ruby_lsp/ruby_lsp_rails/support/location_builder.rb
-- lib/ruby_lsp_rails/railtie.rb
 - lib/ruby_lsp_rails/version.rb
 - lib/tasks/ruby_lsp_rails_tasks.rake
 homepage: https://github.com/Shopify/ruby-lsp-rails
@@ -65,7 +64,6 @@ metadata:
   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:
 - lib
@@ -80,8 +78,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.23
-signing_key:
+rubygems_version: 3.6.2
 specification_version: 4
 summary: A Ruby LSP addon for Rails
 test_files: []

data/lib/ruby_lsp_rails/railtie.rb

@@ -1,21 +0,0 @@
-# typed: strict
-# frozen_string_literal: true
-
-require "rails"
-
-module RubyLsp
-  module Rails
-    class Railtie < ::Rails::Railtie
-      config.ruby_lsp_rails = ActiveSupport::OrderedOptions.new
-
-      initializer "ruby_lsp_rails.setup" do |_app|
-        config.after_initialize do |_app|
-          unless config.ruby_lsp_rails.server.nil?
-            ActiveSupport::Deprecation.new.warn("The `ruby_lsp_rails.server` configuration option is no longer " \
-              "needed and will be removed in a future release.")
-          end
-        end
-      end
-    end
-  end
-end