ruby-lsp-rails 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 0cdbd01ae2a03195931208bf88504c5e06ae95b321e32e1c07a5fcef993817dc
+  data.tar.gz: 8ee3dbd7f7b0bc4851e98a51e624700526f0fbbd7535495e52bd7f9fe43d581a
+SHA512:
+  metadata.gz: c2adee12e7cf92359ee6b26b64ade207c3507e2f881d0b2d00ee6b30e45e3bff1025735e616d1da062d6bde2d70bbd72ae73114f1cc13f17a30f47e48171b6a7
+  data.tar.gz: 67307e0b0388f38e254f1fbc1822b8814075cd5ded94b73e674b1ef35cc1c989dfd2286bac4eaa901e45caa6335e024d80480470c30d08c74a2a812bf377e365

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2023-present, Shopify Inc.
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,48 @@
+# Ruby LSP Rails
+
+Ruby LSP Rails is a [Ruby LSP](https://github.com/Shopify/ruby-lsp) extension for extra Rails editor features, such as:
+
+- Displaying an ActiveRecord model's database columns and types when hovering over it
+- (More to come!)
+
+
+## Installation
+
+To install, add the following line to your application's Gemfile:
+
+```ruby
+group :development do
+  gem "ruby-lsp-rails"
+end
+```
+
+## Usage
+
+1. Start your Rails server
+1. Hover over an ActiveRecord model to see its details
+
+## How It Works
+
+This gem consists of two components that enable enhanced Rails functionality in the editor:
+
+1. A Rails engine that automatically exposes APIs when Rails server is running
+1. A Ruby LSP extension that connects to the exposed APIs to fetch runtime information from the Rails server
+
+This is why the Rails server needs to be running for features to work.
+
+> **Note**
+>
+> There is no need to restart the Ruby LSP every time the Rails server is booted.
+> If the server is shut down, the extra features will temporarily disappear and reappear once the server is running again.
+
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/Shopify/ruby-lsp-rails. This project is
+intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the
+[Contributor Covenant](https://github.com/Shopify/ruby-lsp-rails/blob/main/CODE_OF_CONDUCT.md) code of conduct.
+
+## License
+
+The gem is available as open source under the terms of the
+[MIT License](https://github.com/Shopify/ruby-lsp-rails/blob/main/LICENSE.txt).

data/Rakefile

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+require "bundler/setup"
+
+APP_RAKEFILE = File.expand_path("test/dummy/Rakefile", __dir__)
+
+load "rails/tasks/engine.rake"
+load "rails/tasks/statistics.rake"
+
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList["test/**/*_test.rb"]
+end
+
+task default: :test

data/lib/ruby-lsp-rails.rb

@@ -0,0 +1,13 @@
+# typed: strict
+# frozen_string_literal: true
+
+require "sorbet-runtime"
+require "pathname"
+
+require "ruby_lsp_rails/version"
+require "ruby_lsp_rails/railtie"
+
+module RubyLSP
+  module Rails
+  end
+end

data/lib/ruby_lsp/ruby_lsp_rails/extension.rb

@@ -0,0 +1,26 @@
+# typed: strict
+# frozen_string_literal: true
+
+require "ruby_lsp/extension"
+
+require_relative "rails_client"
+require_relative "hover"
+
+module RubyLsp
+  module Rails
+    class Extension < ::RubyLsp::Extension
+      extend T::Sig
+
+      sig { override.void }
+      def activate
+        # Must be the last statement in activate since it raises to display a notification for the user
+        RubyLsp::Rails::RailsClient.instance.check_if_server_is_running!
+      end
+
+      sig { override.returns(String) }
+      def name
+        "Ruby LSP Rails"
+      end
+    end
+  end
+end

data/lib/ruby_lsp/ruby_lsp_rails/hover.rb

@@ -0,0 +1,41 @@
+# typed: strict
+# frozen_string_literal: true
+
+module RubyLsp
+  module Rails
+    class Hover < ::RubyLsp::Listener
+      extend T::Sig
+      extend T::Generic
+
+      ResponseType = type_member { { fixed: T.nilable(::RubyLsp::Interface::Hover) } }
+
+      ::RubyLsp::Requests::Hover.add_listener(self)
+
+      sig { override.returns(ResponseType) }
+      attr_reader :response
+
+      sig { void }
+      def initialize
+        @response = T.let(nil, ResponseType)
+        super
+      end
+
+      listener_events do
+        sig { params(node: SyntaxTree::Const).void }
+        def on_const(node)
+          model = RailsClient.instance.model(node.value)
+          return if model.nil?
+
+          schema_file = model[:schema_file]
+          content = +""
+          if schema_file
+            content << "[Schema](file://#{schema_file})\n\n"
+          end
+          content << model[:columns].map { |name, type| "**#{name}**: #{type}\n" }.join("\n")
+          contents = RubyLsp::Interface::MarkupContent.new(kind: "markdown", value: content)
+          @response = RubyLsp::Interface::Hover.new(range: range_from_syntax_tree_node(node), contents: contents)
+        end
+      end
+    end
+  end
+end

data/lib/ruby_lsp/ruby_lsp_rails/rails_client.rb

@@ -0,0 +1,82 @@
+# typed: strict
+# frozen_string_literal: true
+
+require "singleton"
+require "net/http"
+
+module RubyLsp
+  module Rails
+    class RailsClient
+      class ServerNotRunningError < StandardError; end
+      class NeedsRestartError < StandardError; end
+
+      extend T::Sig
+      include Singleton
+
+      SERVER_NOT_RUNNING_MESSAGE = "Rails server is not running. " \
+        "To get Rails features in the editor, boot the Rails server"
+
+      sig { returns(String) }
+      attr_reader :root
+
+      sig { void }
+      def initialize
+        project_root = Pathname.new(ENV["BUNDLE_GEMFILE"]).dirname
+
+        if project_root.basename.to_s == ".ruby-lsp"
+          project_root = project_root.join("../")
+        end
+
+        dummy_path = File.join(project_root, "test", "dummy")
+        @root = T.let(Dir.exist?(dummy_path) ? dummy_path : project_root.to_s, String)
+        app_uri_path = "#{@root}/tmp/app_uri.txt"
+
+        unless File.exist?(app_uri_path)
+          raise NeedsRestartError, <<~MESSAGE
+            The Ruby LSP Rails extension needs to be initialized. Please restart the Rails server and the Ruby LSP
+            to get Rails features in the editor
+          MESSAGE
+        end
+
+        base_uri = File.read(app_uri_path).chomp
+        @uri = T.let("#{base_uri}/ruby_lsp_rails", String)
+      end
+
+      sig { params(name: String).returns(T.nilable(T::Hash[Symbol, T.untyped])) }
+      def model(name)
+        response = request("models/#{name}")
+        return unless response.code == "200"
+
+        JSON.parse(response.body.chomp, symbolize_names: true)
+      rescue Errno::ECONNREFUSED
+        raise ServerNotRunningError, SERVER_NOT_RUNNING_MESSAGE
+      end
+
+      sig { void }
+      def check_if_server_is_running!
+        # Check if the Rails server is running. Warn the user to boot it for Rails features
+        pid_file = ENV.fetch("PIDFILE") { File.join(@root, "tmp", "pids", "server.pid") }
+
+        # If the PID file doesn't exist, then the server hasn't been booted
+        raise ServerNotRunningError, SERVER_NOT_RUNNING_MESSAGE unless File.exist?(pid_file)
+
+        pid = File.read(pid_file).to_i
+
+        begin
+          # Issuing an EXIT signal to an existing process actually doesn't make the server shutdown. But if this
+          # call succeeds, then the server is running. If the PID doesn't exist, Errno::ESRCH is raised
+          Process.kill(T.must(Signal.list["EXIT"]), pid)
+        rescue Errno::ESRCH
+          raise ServerNotRunningError, SERVER_NOT_RUNNING_MESSAGE
+        end
+      end
+
+      private
+
+      sig { params(path: String).returns(Net::HTTPResponse) }
+      def request(path)
+        Net::HTTP.get_response(URI("#{@uri}/#{path}"))
+      end
+    end
+  end
+end

data/lib/ruby_lsp_rails/middleware.rb

@@ -0,0 +1,61 @@
+# typed: strict
+# frozen_string_literal: true
+
+module RubyLsp
+  module Rails
+    class Middleware
+      extend T::Sig
+
+      PATH_REGEXP = %r{/ruby_lsp_rails/models/(?<model_name>.+)}
+
+      sig { params(app: T.untyped).void }
+      def initialize(app)
+        @app = app
+      end
+
+      sig { params(env: T::Hash[T.untyped, T.untyped]).returns(T::Array[T.untyped]) }
+      def call(env)
+        request = ActionDispatch::Request.new(env)
+        # TODO: improve the model name regex
+        match = request.path.match(PATH_REGEXP)
+
+        if match
+          resolve_database_info_from_model(match[:model_name])
+        else
+          @app.call(env)
+        end
+      rescue
+        @app.call(env)
+      end
+
+      private
+
+      sig { params(model_name: String).returns(T::Array[T.untyped]) }
+      def resolve_database_info_from_model(model_name)
+        const = ActiveSupport::Inflector.safe_constantize(model_name)
+
+        if const && const < ActiveRecord::Base
+          begin
+            schema_file = ActiveRecord::Tasks::DatabaseTasks.schema_dump_path(const.connection.pool.db_config)
+          rescue => e
+            warn("Could not locate schema: #{e.message}")
+          end
+
+          body = JSON.dump({
+            columns: const.columns.map { |column| [column.name, column.type] },
+            schema_file: schema_file,
+          })
+
+          [200, { "Content-Type" => "application/json" }, [body]]
+        else
+          not_found
+        end
+      end
+
+      sig { returns(T::Array[T.untyped]) }
+      def not_found
+        [404, { "Content-Type" => "text/plain" }, ["Not Found"]]
+      end
+    end
+  end
+end

data/lib/ruby_lsp_rails/railtie.rb

@@ -0,0 +1,22 @@
+# typed: strict
+# frozen_string_literal: true
+
+require "ruby_lsp_rails/middleware"
+
+module RubyLsp
+  module Rails
+    class Railtie < ::Rails::Railtie
+      initializer "ruby_lsp_rails.setup" do |app|
+        app.config.middleware.insert_after(ActionDispatch::ShowExceptions, RubyLsp::Rails::Middleware)
+
+        config.after_initialize do |_app|
+          if defined?(::Rails::Server)
+            ssl_enable, host, port = ::Rails::Server::Options.new.parse!(ARGV).values_at(:SSLEnable, :Host, :Port)
+            app_uri = "#{ssl_enable ? "https" : "http"}://#{host}:#{port}"
+            File.write("#{::Rails.root}/tmp/app_uri.txt", app_uri)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/ruby_lsp_rails/version.rb

@@ -0,0 +1,8 @@
+# typed: strict
+# frozen_string_literal: true
+
+module RubyLsp
+  module Rails
+    VERSION = "0.1.0"
+  end
+end

data/lib/tasks/ruby_lsp_rails_tasks.rake

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

metadata

@@ -0,0 +1,100 @@
+--- !ruby/object:Gem::Specification
+name: ruby-lsp-rails
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Shopify
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2023-04-21 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '6.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '6.0'
+- !ruby/object:Gem::Dependency
+  name: ruby-lsp
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.4.5
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.4.5
+- !ruby/object:Gem::Dependency
+  name: sorbet-runtime
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.5.9897
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.5.9897
+description: A Ruby LSP extension that adds extra editor functionality for Rails applications
+email:
+- ruby@shopify.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/ruby-lsp-rails.rb
+- lib/ruby_lsp/ruby_lsp_rails/extension.rb
+- lib/ruby_lsp/ruby_lsp_rails/hover.rb
+- lib/ruby_lsp/ruby_lsp_rails/rails_client.rb
+- lib/ruby_lsp_rails/middleware.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
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+  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
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.4.12
+signing_key: 
+specification_version: 4
+summary: A Ruby LSP extension for Rails
+test_files: []