ruby-lsp-view_component 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f750624290fc729f716c2bb2c20b13d56baa7fad7878014e795342cbdb61f148
-  data.tar.gz: 3b28ec82ce7c86cddf56b35595f472161b526cb0eb57ee2fb11204edb4355d24
+  metadata.gz: b6a116e228f6b21375f00e88b1d1f00f11013c9f132e381edc5a08461efd74f5
+  data.tar.gz: 523da12a2ef3e17ba2b72c61218cb87c97af8e1c3440a0a7612e39aa14ff2a47
 SHA512:
-  metadata.gz: 4738e8c1e9240ac1444aebdbf7f5ddb93df0d0374604811c234b36f5a14334b51d8638d813460e5f1bc66fe088e1233faaa38febaabbde17649f105079f39f77
-  data.tar.gz: 2e47b3801dde3a15a8757f3e767282a25bf0038d794a81dc5ab3b246b5b77cc2a8d870d07b7af9b01902ecf4f69f628385a1a95c8ab6e74ac0da9c29e3ce6030
+  metadata.gz: 642cef99fc71c8d9536c83f9f6bd17f88a5c83d36e1dc08f73b768ac7b38c61df40b8216cf35f5e6b43c9d3740f81d5d189f7cb4470d8ca21e00f132a3438e3b
+  data.tar.gz: 0a52380b179d23b4f6cd41de1873533990085aa6538761ca90752dab8605aa6b948c46eb35d71ec36016740fa242954f34bc49fa28e343bc80bcb5e75490f5ae

data/CHANGELOG.md

@@ -1,5 +1,9 @@
 ## [Unreleased]
 
+## [0.2.0]
+
+- `Jump to template` also shows on components that need a template and have none. It opens the missing `.html.erb` next to the class, and VS Code offers to create it.
+
 ## [0.1.0]
 
 - `Jump to template` CodeLens on ViewComponent classes. It opens the component template, or a picker when the component has variants or sub-templates.

data/README.md

@@ -1,6 +1,6 @@
 # ruby-lsp-view_component
 
-A [Ruby LSP](https://github.com/Shopify/ruby-lsp) add-on for [ViewComponent](https://viewcomponent.org). It adds a `Jump to template` CodeLens to each component class that opens the component's template.
+A [Ruby LSP](https://github.com/Shopify/ruby-lsp) add-on for [ViewComponent](https://viewcomponent.org). It adds a `Jump to template` CodeLens to each component class that opens the component's template, or lets you create it when it is missing.
 
 ## Features
 
@@ -14,18 +14,31 @@ When the component has more than one template, the click opens a picker with the
 
 ![Pick a template](.github/assets/pick_template.gif)
 
-For `app/components/bar_component.rb`, the lens lists:
+For `app/components/foo_component.rb` with all of these templates, the lens lists:
 
 | File | What it is |
 |---|---|
-| `bar_component.html.erb` | [Main template](https://viewcomponent.org/guide/templates.html#sibling-file) |
-| `bar_component.html+phone.erb` | Variant of the main template |
-| `bar_component/bar_component.html.erb` | [Main template in a subdirectory](https://viewcomponent.org/guide/templates.html#subdirectory) |
-| `bar_component/list.html.erb` | Sub-template rendered with `call_list`, from [view_component_subtemplates](https://github.com/bukhr/view_component_subtemplates) |
+| `foo_component.html.erb` | [Main template](https://viewcomponent.org/guide/templates.html#sibling-file) |
+| `foo_component.html+phone.erb` | Variant of the main template |
+| `foo_component/foo_component.html.erb` | [Main template in a subdirectory](https://viewcomponent.org/guide/templates.html#subdirectory) |
+| `foo_component/list.html.erb` | Sub-template rendered with `call_list`, from [view_component_subtemplates](https://github.com/bukhr/view_component_subtemplates) |
 
-ERB, Haml and Slim templates are supported. Templates of nested components in the subdirectory, such as `bar_component/item_component.html.erb` next to `bar_component/item_component.rb`, belong to that component and are left out.
+ERB, Haml and Slim templates are supported. Templates of nested components in the subdirectory, such as `foo_component/item_component.html.erb` next to `foo_component/item_component.rb`, belong to that component and are left out.
 
-Components without a template file of their own get no lens. That covers [inline](https://viewcomponent.org/guide/templates.html#inline) and [`call`](https://viewcomponent.org/guide/templates.html#call) components, and components that [inherit](https://viewcomponent.org/guide/templates.html#inherited) their template from a parent class.
+### Missing template
+
+When a component needs a template and has none, the lens opens `foo_component.html.erb` next to the class. VS Code reports that the file does not exist and offers a **Create File** button. Once the file exists, the same lens opens it.
+
+![Create a missing template](.github/assets/create_template.gif)
+
+A component counts as needing a template only when it renders through a template file. There is no lens for components that:
+
+- define [`call`](https://viewcomponent.org/guide/templates.html#call), themselves or in a parent class
+- declare an [inline template](https://viewcomponent.org/guide/templates.html#inline) with `erb_template`, `haml_template` or `slim_template`
+- [inherit](https://viewcomponent.org/guide/templates.html#inherited) a template from a parent class
+- are marked `abstract!`
+
+A base class that is never rendered on its own still gets the lens. Mark it `abstract!` to hide it.
 
 ## Installation
 

data/lib/ruby_lsp/ruby_lsp_view_component/addon.rb

@@ -11,7 +11,9 @@ module RubyLsp
     class Addon < ::RubyLsp::Addon
       # @override
       #: (GlobalState, Thread::Queue) -> void
-      def activate(global_state, outgoing_queue); end
+      def activate(global_state, outgoing_queue)
+        @index = global_state.index #: RubyIndexer::Index?
+      end
 
       # @override
       #: -> void
@@ -32,7 +34,8 @@ module RubyLsp
       # @override
       #: (ResponseBuilders::CollectionResponseBuilder[Interface::CodeLens], URI::Generic, Prism::Dispatcher) -> void
       def create_code_lens_listener(response_builder, uri, dispatcher)
-        CodeLens.new(response_builder, uri, dispatcher)
+        index = @index #: as !nil
+        CodeLens.new(response_builder, uri, dispatcher, index)
       end
     end
   end

data/lib/ruby_lsp/ruby_lsp_view_component/code_lens.rb

@@ -6,37 +6,78 @@ module RubyLsp
       include Requests::Support::Common
 
       TEMPLATE_EXTENSIONS = "{erb,haml,slim}"
+      NO_TEMPLATE_CALLS = [:abstract!, :erb_template, :haml_template, :slim_template].freeze
 
-      #: (ResponseBuilders::CollectionResponseBuilder[Interface::CodeLens], URI::Generic, Prism::Dispatcher) -> void
-      def initialize(response_builder, uri, dispatcher)
+      #: (ResponseBuilders::CollectionResponseBuilder[Interface::CodeLens], URI::Generic, Prism::Dispatcher, RubyIndexer::Index) -> void
+      def initialize(response_builder, uri, dispatcher, index)
         @response_builder = response_builder
+        @index = index
         @path = uri.to_standardized_path #: String?
-        @seen_class = false
-        dispatcher.register(self, :on_class_node_enter) if @path&.end_with?(".rb")
+        @nesting = [] #: Array[String]
+        @class_node = nil #: Prism::ClassNode?
+        return unless @path&.end_with?(".rb")
+
+        dispatcher.register(self, :on_module_node_enter, :on_module_node_leave, :on_class_node_enter, :on_class_node_leave)
+      end
+
+      #: (Prism::ModuleNode) -> void
+      def on_module_node_enter(node)
+        @nesting << node.constant_path.slice
+      end
+
+      #: (Prism::ModuleNode) -> void
+      def on_module_node_leave(node)
+        @nesting.pop
       end
 
       #: (Prism::ClassNode) -> void
       def on_class_node_enter(node)
-        return if @seen_class
+        @class_node ||= node
+      end
 
-        @seen_class = true
-        uris = templates.map { |path| URI::Generic.from_path(path: path).to_s }
-        return if uris.empty?
+      #: (Prism::ClassNode) -> void
+      def on_class_node_leave(node)
+        return unless node.equal?(@class_node)
+
+        path = @path #: as !nil
+        paths = templates(path)
+        paths = ["#{path.delete_suffix(".rb")}.html.erb"] if paths.empty? && needs_template?(node)
+        return if paths.empty?
 
         @response_builder << create_code_lens(
           node,
           title: "Jump to template",
           command_name: "rubyLsp.openFile",
-          arguments: [uris],
+          arguments: [paths.map { |path| URI::Generic.from_path(path: path).to_s }],
           data: { type: "file" },
         )
       end
 
       private
 
-      #: -> Array[String]
-      def templates
-        path = @path #: as !nil
+      #: (Prism::ClassNode) -> bool
+      def needs_template?(node)
+        name = [*@nesting, node.constant_path.slice].join("::").delete_prefix("::")
+        ancestors = @index.linearized_ancestors_of(name)
+        base = ancestors.index("ViewComponent::Base")
+        return false unless base
+        return false if @index.resolve_method("call", name)
+        return false if (ancestors.take(base) - [name]).any? { |ancestor| inherited_template?(ancestor) }
+
+        Array(node.body&.child_nodes).none? do |child|
+          child.is_a?(Prism::CallNode) && child.receiver.nil? && NO_TEMPLATE_CALLS.include?(child.name)
+        end
+      rescue RubyIndexer::Index::NonExistingNamespaceError
+        false
+      end
+
+      #: (String) -> bool
+      def inherited_template?(ancestor)
+        @index[ancestor]&.any? { |entry| entry.file_path && templates(entry.file_path).any? } || false
+      end
+
+      #: (String) -> Array[String]
+      def templates(path)
         dir = File.dirname(path)
         name = File.basename(path, ".rb")
         Dir.glob(["#{name}.*#{TEMPLATE_EXTENSIONS}", "#{name}/*.#{TEMPLATE_EXTENSIONS}"], base: dir)

data/lib/ruby_lsp_view_component/version.rb

@@ -2,6 +2,6 @@
 
 module RubyLsp
   module RubyLspViewComponent
-    VERSION = "0.1.0"
+    VERSION = "0.2.0"
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: ruby-lsp-view_component
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Daniel Retamal