ruby-lsp-cell 0.1.2 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d26cf866d9c38fe88db134b7da05d7c883aa8cab0907b064042ef41a01dce7c7
-  data.tar.gz: d91237300c2695320827a43142dcb84d3392d66486fa72a6f7df16750f490743
+  metadata.gz: be16f412b1af125c90034244af33444ce8cb494d3cf442b59159cad19ba4f592
+  data.tar.gz: 80db8e5cbf2a28037dd5d44a50d822efc8a65783587573667818204db9cc6294
 SHA512:
-  metadata.gz: 3d0b35cd0593bcdc3c71cb18c19c7ffd8202763ce75a26389c1538e6f5ab4650e8996c69efcd8a16dd6e31e3d9c1b7013d869759b1a0bd922fec4f71a384f2be
-  data.tar.gz: 46d0d9e866cdc4a8a0a75f6b930a31d40861616f5f2212069937cfdd4ba3a7077fe542b2b398f0dca1f6b5b9aa9d1a2a113c4bb5eeda349f03f3b86dc679f1dc
+  metadata.gz: fb9a1b6e99c6676aa57732da0c06fb98ba8176ee4252e00c07e3c7206c1e2bdfd2ed65d8a558130233dfb007eb49677cb77089bf366277b6cc75264d3327fa6b
+  data.tar.gz: 79b318cf629b1d2d9b9b7eae5607692c88cb902ff9978494b4c6781dd5fb854b40bcd9c616e53fb56bc66dd6ac80548be6c65290b9d694d0607779feccb2af92

data/.rubocop.yml

@@ -19,4 +19,7 @@ Style/MethodCallWithArgsParentheses:
   Enabled: false
 
 Naming/PredicatePrefix:
-  Enabled: false
+  Enabled: false
+
+Layout/LeadingCommentSpace:
+  AllowRBSInlineAnnotation: true

data/CHANGELOG.md

@@ -1,3 +1,7 @@
+## [0.2.0] - 2025-07-21
+
+- Add compatibility with Ruby LSP 0.26.0
+
 ## [0.1.1] - 2025-06-09
 - Add compatibility with Ruby LSP 0.24.1
 
@@ -6,4 +10,4 @@
 - Start of the main project
 
 ## [0.0.1] - 2024-06-22
-- Add compatibility with Ruby LSP 0.17.17
+- Add compatibility with Ruby LSP 0.17.17

data/README.md

@@ -44,6 +44,8 @@ Or install it yourself as:
   * **Top of the class** – lets you jump directly to the default template (`app/cells/user/show.erb` unless you changed `defaultViewFileName` in `.vscode/settings.json`).
   * **Any instance method that calls `render`** – jumps to the template rendered by that method.
 
+![example-ruby-lsp](example-ruby-lsp.gif)
+
 ## Development
 
 After checking out the repo, run `bin/setup` to install dependencies. Then, run `bundle exec rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.

data/lib/ruby_lsp/cell/version.rb

@@ -3,6 +3,6 @@
 
 module RubyLsp
   module Cell
-    VERSION = "0.1.2"
+    VERSION = "0.2.0"
   end
 end

data/lib/ruby_lsp/ruby-lsp-cell/addon.rb

@@ -1,4 +1,4 @@
-# typed: false
+# typed: true
 # frozen_string_literal: true
 
 require "ruby_lsp/addon"
@@ -7,28 +7,28 @@ require "ruby_lsp/internal"
 require_relative "code_lens"
 require_relative "../cell/version"
 
-RubyLsp::Addon.depend_on_ruby_lsp!("~> 0.24.0")
+RubyLsp::Addon.depend_on_ruby_lsp!("~> 0.26.0")
 
 module RubyLsp
   module Cell
-    #
     # Addon for Ruby LSP Cell Context
     #
     class Addon < ::RubyLsp::Addon
-      extend T::Sig
-
-      sig { void }
+      #: -> void
       def initialize
         super
-        @global_state = T.let(nil, T.nilable(RubyLsp::GlobalState))
-        @message_queue = T.let(nil, T.nilable(Thread::Queue))
-        @settings = T.let(nil, T.nilable(T::Hash[String, T.untyped]))
-        @enabled = T.let(nil, T.nilable(T::Boolean))
-        @default_view_filename = T.let(nil, T.nilable(String))
+        @global_state = nil #: RubyLsp::GlobalState?
+        @message_queue = nil #: Thread::Queue?
+        @settings = nil #: Hash[Symbol, untyped]?
+        @enabled = nil #: bool?
+        @default_view_filename = nil #: String?
       end
 
-      sig { params(global_state: RubyLsp::GlobalState, message_queue: Thread::Queue).void }
+      # @override
+      #: (RubyLsp::GlobalState global_state, Thread::Queue message_queue) -> void
       def activate(global_state, message_queue)
+        return unless are_required_libraries_installed?
+
         @message_queue = message_queue
         @global_state = global_state
         @settings = @global_state.settings_for_addon(name) || {}
@@ -36,36 +36,42 @@ module RubyLsp
         @default_view_filename = @settings.fetch(:defaultViewFileName, "show.erb")
       end
 
-      sig { void }
+      # @override
+      #: -> void
       def deactivate; end
 
-      sig { returns(String) }
+      # @override
+      #: -> String
       def name
         "Ruby LSP Cell"
       end
 
-      sig do
-        params(
-          response_builder: ResponseBuilders::CollectionResponseBuilder,
-          uri: URI::Generic,
-          dispatcher: Prism::Dispatcher,
-        ).void
-      end
+      # @override
+      #: (RubyLsp::ResponseBuilders::CollectionResponseBuilder[untyped] response_builder, URI::Generic uri, Prism::Dispatcher dispatcher) -> void
       def create_code_lens_listener(response_builder, uri, dispatcher)
         CodeLens.new(
           response_builder,
           uri,
           dispatcher,
-          T.must(@global_state),
-          enabled: T.must(@enabled),
-          default_view_filename: T.must(@default_view_filename),
+          @global_state, #: as !nil
+          enabled: @enabled, #: as !nil
+          default_view_filename: @default_view_filename, #: as !nil
         )
       end
 
-      sig { returns(String) }
+      # @override
+      #: -> String
       def version
         RubyLsp::Cell::VERSION
       end
+
+      def are_required_libraries_installed?
+        Bundler.definition.specs.any? do |spec|
+          spec.name == "cells"
+        end
+      rescue Bundler::GemNotFound
+        false
+      end
     end
   end
 end

data/lib/ruby_lsp/ruby-lsp-cell/code_lens.rb

@@ -1,124 +1,127 @@
-# typed: strict
+# typed: false
 # frozen_string_literal: true
 
 module RubyLsp
   module Cell
     class CodeLens
-      extend T::Sig
-      extend T::Generic
-
       include ::RubyLsp::Requests::Support::Common
 
-      REQUIRED_LIBRARY = T.let("cells-rails", String)
-
-      ResponseType = type_member { { fixed: T::Array[CodeRay] } }
-
-      sig do
-        params(
-          response_builder: RubyLsp::ResponseBuilders::CollectionResponseBuilder,
-          uri: URI::Generic,
-          dispatcher: Prism::Dispatcher,
-          global_state: RubyLsp::GlobalState,
-          enabled: T::Boolean,
-          default_view_filename: String,
-        ).void
-      end
+      #: (
+      #|  RubyLsp::ResponseBuilders::CollectionResponseBuilder[untyped] response_builder,
+      #|  URI::Generic uri,
+      #|  Prism::Dispatcher dispatcher,
+      #|  RubyLsp::GlobalState global_state,
+      #|  enabled: bool,
+      #|  default_view_filename: String
+      #| ) -> void
       def initialize(response_builder, uri, dispatcher, global_state, enabled:, default_view_filename:)
         return unless enabled
 
         @response_builder = response_builder
         @global_state = global_state
 
-        @path = T.let(uri.to_standardized_path, String)
-        @class_name = T.let("", String)
-        @pattern = T.let("_cell", String)
-        @default_view_filename = T.let(default_view_filename, String)
-        dispatcher.register(self, :on_class_node_enter, :on_def_node_leave)
+        @path = uri.to_standardized_path #: String
+        @class_name = ""
+        @pattern = "_cell"
+        @default_view_filename = default_view_filename
+        @in_cell_class = false
+        @nesting = [] #: Array[String]
+        dispatcher.register(
+          self,
+          :on_module_node_enter,
+          :on_module_node_leave,
+          :on_class_node_enter,
+          :on_class_node_leave,
+          :on_def_node_enter,
+        )
       end
 
-      sig { params(node: Prism::ClassNode).void }
+      #: (Prism::ModuleNode node) -> void
+      def on_module_node_enter(node)
+        @nesting.push(node.constant_path.slice)
+      end
+
+      #: (Prism::ModuleNode node) -> void
+      def on_module_node_leave(node)
+        @nesting.pop
+      end
+
+      #: (Prism::ClassNode node) -> void
       def on_class_node_enter(node)
-        @class_name = node.constant_path.slice
-        return unless @class_name.end_with?("Cell")
-        return unless @global_state.index.linearized_ancestors_of(@class_name).include?("Cell::ViewModel")
+        @nesting.push(node.constant_path.slice)
+        class_name = @nesting.join("::")
+        return unless class_name.end_with?("Cell")
+        return unless @global_state.index.linearized_ancestors_of(class_name).include?("Cell::ViewModel")
 
+        @in_cell_class = true
         add_default_goto_code_lens(node)
       end
 
-      sig { params(node: Prism::ClassNode).void }
+      #: (Prism::ClassNode node) -> void
       def on_class_node_leave(node)
-        @class_name = ""
+        @nesting.pop
+        @in_cell_class = false
       end
 
-      sig { params(node: Prism::DefNode).void }
-      def on_def_node_leave(node)
-        return unless @class_name.end_with?("Cell")
+      #: (Prism::DefNode node) -> void
+      def on_def_node_enter(node)
+        return unless @in_cell_class
         return unless contains_render_call?(node.body)
-        return unless @global_state.index.linearized_ancestors_of(@class_name).include?("Cell::ViewModel")
 
         add_function_goto_code_lens(node, node.name.to_s)
       end
 
       private
 
-      sig { params(node: Prism::Node).void }
+      #: (Prism::Node node) -> void
       def add_default_goto_code_lens(node)
-        return unless are_required_libraries_installed?
-
         erb_filename = remove_last_pattern_in_string @default_view_filename, ".erb"
         uri = compute_erb_view_path @default_view_filename
 
-        @response_builder << create_code_lens(
-          node,
-          title: "Go to #{erb_filename}",
-          command_name: "vscode.open",
-          arguments: [uri],
-          data: { type: "goToFile" },
-        )
+        create_go_to_file_code_lens(node, erb_filename, uri)
       end
 
-      sig { params(node: T.nilable(Prism::Node)).returns(T::Boolean) }
+      #: (Prism::Node? node) -> bool
       def contains_render_call?(node)
         return false if node.nil?
 
-        return true if node.is_a?(Prism::CallNode) &&
-          node.receiver.nil? &&
-          node.message == "render"
+        if node.is_a?(Prism::CallNode)
+          return true if node.receiver.nil? && node.name == :render
+        end
 
         node.child_nodes.any? { |child| contains_render_call?(child) }
       end
 
-      sig { params(node: Prism::Node, name: String).void }
+      #: (Prism::Node node, String name) -> void
       def add_function_goto_code_lens(node, name)
-        return unless are_required_libraries_installed?
-
         uri = compute_erb_view_path("#{name}.erb")
-
-        @response_builder << create_code_lens(
-          node,
-          title: "Go to #{name}",
-          command_name: "vscode.open",
-          arguments: [uri],
-          data: { type: "goToFile" },
-        )
+        create_go_to_file_code_lens(node, name, uri)
       end
 
-      sig { params(string: String, pattern: String).returns(String) }
+      #: (String string, String pattern) -> String
       def remove_last_pattern_in_string(string, pattern)
         string.sub(/#{pattern}$/, "")
       end
 
-      sig { params(name: String).returns(String) }
+      #: (String name) -> String
       def compute_erb_view_path(name)
         escaped_pattern = Regexp.escape(@pattern)
         base_path = @path.sub(/#{escaped_pattern}\.rb$/, "")
         folder = File.basename(base_path)
-        File.join(File.dirname(base_path), folder, name)
+        path = File.join(File.dirname(base_path), folder, name)
+        uri = URI::File.from_path(path: path).to_s
+        uri
       end
 
-      sig { returns(T::Boolean) }
-      def are_required_libraries_installed?
-        Bundler.locked_gems.dependencies.keys.include?(REQUIRED_LIBRARY)
+      #: (Prism::Node node, String name, String uri) -> void
+      def create_go_to_file_code_lens(node, name, uri)
+        @response_builder << create_code_lens(
+          node,
+          title: "Go to #{name}",
+          command_name: "rubyLsp.openFile",
+          arguments: [[uri]],
+          data: { type: "file" },
+        )
       end
     end
   end

data/tools/cell_fake.rb

@@ -1,4 +1,4 @@
-# typed: false
+# typed: strict
 # frozen_string_literal: true
 
 raise "Do not load this file!" unless defined?(RubyIndexer)

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: ruby-lsp-cell
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.2.0
 platform: ruby
 authors:
 - Edgar Guzmán
@@ -24,6 +24,7 @@ files:
 - LICENSE.txt
 - README.md
 - Rakefile
+- example-ruby-lsp.gif
 - lib/ruby_lsp/cell.rb
 - lib/ruby_lsp/cell/version.rb
 - lib/ruby_lsp/ruby-lsp-cell/addon.rb