ruby-lsp-cell 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: ef542283838f0b02db357300bd9eb16dbd29df6473451799350e7a9000464efc
+  data.tar.gz: 6502422f819758a0f20ce099d93c172f5508d9d115219b3696cb8bf59fe28785
+SHA512:
+  metadata.gz: b7a02eb7ecd15d9894347674c1be575ef4d16e4de5cf54703981df112bb1f8a78ad06e26b2a51f76bb1d3aa0473948aac6df4ed740d31ed1b64fe1171813e1be
+  data.tar.gz: 7885de047e0c9c287ec04fddfe69e26da9b1023a0666c480a2c89b2bc9cc9be91b6f9fc5ac848cdfdd07ee381500164714af26ab333d0d7fcbeac2791ae5864e

data/.rubocop.yml

@@ -0,0 +1,22 @@
+inherit_gem:
+  rubocop-shopify: rubocop.yml
+
+plugins:
+  - rubocop-sorbet
+require:
+ - rubocop-rake
+
+AllCops:
+  NewCops: disable
+  DisplayCopNames: true
+  SuggestExtensions: false
+  DisabledByDefault: false
+
+Style/StderrPuts:
+  Enabled: true
+
+Style/MethodCallWithArgsParentheses:
+  Enabled: false
+
+Naming/PredicatePrefix:
+  Enabled: false

data/.ruby-version

@@ -0,0 +1 @@
+3.4.3

data/.vscode/settings.json

@@ -0,0 +1,19 @@
+{
+    "cSpell.words": [
+        "rubocop",
+        "shopify",
+        "cell",
+    ],
+    "github.copilot.enable": {
+        "*": true,
+        "plaintext": false,
+        "markdown": false,
+        "scminput": false
+    },
+    "rubyLsp.addonSettings": {
+        "Ruby LSP Cell": {
+            "enabled": true,
+            "defaultViewFileName": "show.erb"
+        }
+    }
+}

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2025 Edgar Guzmán
+
+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,59 @@
+# Ruby::Lsp::Cell
+
+ruby-lsp-cell is an **addon for [Ruby LSP][ruby-lsp]** that adds smart CodeLens
+links and navigation helpers for projects that use **[ViewComponent::Cell][cells]**
+or any other *Cell-based* view layer. Its goal is to make jumping between a *Cell* class and its ERB/Haml template.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'ruby-lsp-cell'
+```
+
+And then execute:
+
+>  $ bundle install
+
+Or install it yourself as:
+
+>  $ gem install ruby-lsp-cell
+
+## Usage
+
+1. Enable the addon:
+
+  Create (or edit) `.vscode/settings.json` in your project root:
+
+   ```json
+   {
+     "rubyLsp.addonSettings": {
+       "Ruby LSP Cell": {
+         "enabled": true,
+         "defaultViewFileName": "show.erb"
+       }
+     }
+   }
+   ```
+
+2. Open a Cell file:
+
+  When you open `app/cells/user_cell.rb` Ruby LSP Cell inserts a single **Go to template** CodeLens in two places:
+
+  * **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.
+
+## 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.
+
+To release a new version, update the version number in `version.rb`.
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/guzmanem/ruby-lsp-cell.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.pattern = "test/**/*_test.rb"
+end
+
+require "rubocop/rake_task"
+
+RuboCop::RakeTask.new
+
+task default: [:test, :rubocop]

data/lib/ruby_lsp/cell/version.rb

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

data/lib/ruby_lsp/cell.rb

@@ -0,0 +1,11 @@
+# typed: strict
+# frozen_string_literal: true
+
+require_relative "cell/version"
+
+module RubyLsp
+  module Cell
+    class Error < StandardError; end
+    # Your code goes here...
+  end
+end

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

@@ -0,0 +1,71 @@
+# typed: false
+# frozen_string_literal: true
+
+require "ruby_lsp/addon"
+require "ruby_lsp/internal"
+
+require_relative "code_lens"
+require_relative "../cell/version"
+
+RubyLsp::Addon.depend_on_ruby_lsp!("~> 0.23.0")
+
+module RubyLsp
+  module Cell
+    #
+    # Addon for Ruby LSP Cell Context
+    #
+    class Addon < ::RubyLsp::Addon
+      extend T::Sig
+
+      sig { 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))
+      end
+
+      sig { params(global_state: RubyLsp::GlobalState, message_queue: Thread::Queue).void }
+      def activate(global_state, message_queue)
+        @message_queue = message_queue
+        @global_state = global_state
+        @settings = @global_state.settings_for_addon(name) || {}
+        @enabled = @settings.fetch(:enabled, true)
+        @default_view_filename = @settings.fetch(:defaultViewFileName, "show.erb")
+      end
+
+      sig { void }
+      def deactivate; end
+
+      sig { returns(String) }
+      def name
+        "Ruby LSP Cell"
+      end
+
+      sig do
+        params(
+          response_builder: ResponseBuilders::CollectionResponseBuilder,
+          uri: URI::Generic,
+          dispatcher: Prism::Dispatcher,
+        ).void
+      end
+      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),
+        )
+      end
+
+      sig { returns(String) }
+      def version
+        RubyLsp::Cell::VERSION
+      end
+    end
+  end
+end

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

@@ -0,0 +1,123 @@
+# typed: strict
+# 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
+      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)
+      end
+
+      sig { params(node: Prism::ClassNode).void }
+      def on_class_node_enter(node)
+        @class_name = node.constant_path.slice
+        return unless @class_name.end_with?("Cell")
+
+        add_default_goto_code_lens(node)
+      end
+
+      sig { params(node: Prism::ClassNode).void }
+      def on_class_node_leave(node)
+        @class_name = ""
+      end
+
+      sig { params(node: Prism::DefNode).void }
+      def on_def_node_leave(node)
+        return unless @class_name.end_with?("Cell")
+        return unless contains_render_call?(node.body)
+
+        add_function_goto_code_lens(node, node.name.to_s)
+      end
+
+      private
+
+      sig { params(node: Prism::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" },
+        )
+      end
+
+      sig { params(node: T.nilable(Prism::Node)).returns(T::Boolean) }
+      def contains_render_call?(node)
+        return false if node.nil?
+
+        return true if node.is_a?(Prism::CallNode) &&
+          node.receiver.nil? &&
+          node.message == "render"
+
+        node.child_nodes.any? { |child| contains_render_call?(child) }
+      end
+
+      sig { params(node: Prism::Node, name: String).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" },
+        )
+      end
+
+      sig { params(string: String, pattern: String).returns(String) }
+      def remove_last_pattern_in_string(string, pattern)
+        string.sub(/#{pattern}$/, "")
+      end
+
+      sig { params(name: String).returns(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)
+      end
+
+      sig { returns(T::Boolean) }
+      def are_required_libraries_installed?
+        Bundler.locked_gems.dependencies.keys.include?(REQUIRED_LIBRARY)
+      end
+    end
+  end
+end

data/ruby-lsp-cell.gemspec

@@ -0,0 +1,48 @@
+# frozen_string_literal: true
+
+lib = File.expand_path("lib", __dir__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "ruby_lsp/cell/version"
+
+Gem::Specification.new do |spec|
+  spec.name = "ruby-lsp-cell"
+  spec.version = RubyLsp::Cell::VERSION
+  spec.authors = ["Edgar Guzmán"]
+  spec.email = ["guzmanem@hotmail.com"]
+
+  spec.summary = "Ruby LSP addon for cell-based development support"
+  spec.description = "A Ruby LSP extension that provides additional language server features for cell-based development workflows"
+  spec.homepage = "https://github.com/guzmanem/ruby-lsp-cell"
+  spec.license = "MIT"
+  spec.required_ruby_version = ">= 3.0.0"
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = "https://github.com/guzmanem/ruby-lsp-cell"
+  spec.metadata["changelog_uri"] = "https://github.com/guzmanem/ruby-lsp-cell/blob/main/CHANGELOG.md"
+  spec.metadata["rubygems_mfa_required"] = "true"
+
+  # Specify which files should be added to the gem when it is released.
+  spec.files = Dir.chdir(__dir__) do
+    %x(git ls-files -z).split("\x0").reject do |f|
+      (File.expand_path(f) == __FILE__) ||
+        f.start_with?(
+          "bin/",
+          "test/",
+          "spec/",
+          "features/",
+          "examples/",
+          ".git",
+          ".circleci",
+          "rubocop.yml",
+          "appveyor",
+          "Gemfile",
+          "misc/",
+          "sorbet/",
+        )
+    end
+  end
+
+  spec.bindir = "exe"
+  spec.executables = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+end

metadata

@@ -0,0 +1,56 @@
+--- !ruby/object:Gem::Specification
+name: ruby-lsp-cell
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Edgar Guzmán
+bindir: exe
+cert_chain: []
+date: 1980-01-02 00:00:00.000000000 Z
+dependencies: []
+description: A Ruby LSP extension that provides additional language server features
+  for cell-based development workflows
+email:
+- guzmanem@hotmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rubocop.yml"
+- ".ruby-version"
+- ".vscode/settings.json"
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/ruby_lsp/cell.rb
+- lib/ruby_lsp/cell/version.rb
+- lib/ruby_lsp/ruby-lsp-cell/addon.rb
+- lib/ruby_lsp/ruby-lsp-cell/code_lens.rb
+- ruby-lsp-cell.gemspec
+homepage: https://github.com/guzmanem/ruby-lsp-cell
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/guzmanem/ruby-lsp-cell
+  source_code_uri: https://github.com/guzmanem/ruby-lsp-cell
+  changelog_uri: https://github.com/guzmanem/ruby-lsp-cell/blob/main/CHANGELOG.md
+  rubygems_mfa_required: 'true'
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.0.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.6.7
+specification_version: 4
+summary: Ruby LSP addon for cell-based development support
+test_files: []