ruby-lsp-rails 0.3.14 → 0.3.16

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: '030969e625bedc49a1365d04226c7f8d63bafaf2ad211438e4c438f8977630da'
-  data.tar.gz: af273b69dc8d2d86e08709e25a3b8d5f7c549bbeefd9003a6fa43951a7dc7eee
+  metadata.gz: bab18094b00d6c5e6a61b22061f927fbca1f4b57ce40da04eca22081ab264385
+  data.tar.gz: 7a253986008708cb5d5af08b6409039aeba2b54d0d605270f652fba9178a99ac
 SHA512:
-  metadata.gz: 4dfdfee466a27d8f1f4c9a2b8baba4fb43cab15a4f59a164c3fb65d9e22532e334f31e1d46c8394d898099340707c581ec0d096c06be7dadef50ad98a638a2df
-  data.tar.gz: 9608fa839313f2438827b4e64fbda19ce090b4d79109002f003ceb8ee24689bddea454a0c0e21f736275488548cd72b5f57df4b915f37c4af2ee4b5d19f8a674
+  metadata.gz: b5021b0f2dadbb18464e473f26d9bfee94ed22b02b53eec5c1c44ade37f1ab989c0b80c4169f722ca4e38c498344ccd5e19334324508aac8f6d3c0e21bd6ec35
+  data.tar.gz: 26813fab8da91e99d6f708dadc1ef631df0d1791addb608e06a366bfebcac5643c5d0978d0bc0778d76c3d74572a78a0a8b361fba90f373db759b54a81f9a388

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 addon
 
-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 addon is a [Ruby LSP](https://github.com/Shopify/ruby-lsp) [addon](https://shopify.github.io/ruby-lsp/addons.html) for extra [Rails editor features](https://shopify.github.io/ruby-lsp/rails-addon.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.
 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-addon.html) for more in-depth details about the
+[supported features](https://shopify.github.io/ruby-lsp/rails-addon.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/code_lens.rb

@@ -151,7 +151,7 @@ module RubyLsp
           @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

data/lib/ruby_lsp/ruby_lsp_rails/indexing_enhancement.rb

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

data/lib/ruby_lsp/ruby_lsp_rails/server.rb

@@ -9,13 +9,23 @@ require "json"
 module RubyLsp
   module Rails
     class Server
-      VOID = Object.new
+      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
+        @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 if override_default_output_device
 
-      def initialize
-        $stdin.sync = true
-        $stdout.sync = true
-        $stdin.binmode
-        $stdout.binmode
         @running = true
       end
 
@@ -25,18 +35,14 @@ 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}")
+          execute(request.fetch(:method), request[:params])
         end
       end
 
@@ -44,27 +50,28 @@ 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))
         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.14"
+    VERSION = "0.3.16"
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ruby-lsp-rails
 version: !ruby/object:Gem::Version
-  version: 0.3.14
+  version: 0.3.16
 platform: ruby
 authors:
 - Shopify
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-09-12 00:00:00.000000000 Z
+date: 2024-09-19 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.18.0
     - - "<"
       - !ruby/object:Gem::Version
-        version: 0.18.0
+        version: 0.19.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.17.12
+        version: 0.18.0
     - - "<"
       - !ruby/object:Gem::Version
-        version: 0.18.0
+        version: 0.19.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-addon.html
 post_install_message:
 rdoc_options: []
 require_paths: