ruby-lsp-rails-factory-bot 0.3.0 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 01d1b4f936612100587a05ace6ca2c46fd654484c7d1125245e3c3afd7ce2fb2
-  data.tar.gz: cd15946860a27dbaa31ba14b8f429c5afb7f4bd21a9eeb1aca0f01411006bebf
+  metadata.gz: 74a733cd2866ef2bf14eef3cb4a7dd97dec52c7a315bed5ea884860bcb268f10
+  data.tar.gz: b3ff978e4038960010882e6b51bf079aa057de8ba7ce60acb37b278aaec304ba
 SHA512:
-  metadata.gz: e09bd8301b1003c30ba6efdba15c6c945f4f0ca0adbda81e8f290bcf4a0dff480c1c482e28499a5477d80a656a358018788a6a5022441da8698c940272089e2c
-  data.tar.gz: 3b145ca533d21b291cd545dde273f4c6f333ea255beca536c01f44e488b02a813d4beab114a4d4269b3c0add785b020df3cc875777d28183b2f338a7005a38df
+  metadata.gz: f32b35548606386cf6bfdac973f5437d5a182984f8285f512f47f90f5a49d46598415de52661ed1c4962538b5c1dc29af29a497e2083de4e14a2981d62fe8b5d
+  data.tar.gz: 98bfeb00adb8386588921797416174e6a7121f678b6b081c678f3367cf4e327aded286423ff93879f190524891c3274464d3ec191eb568727b9b947d2cb4b3f9

data/README.md

@@ -24,18 +24,25 @@ Receive completion suggestions as you type
 
 ![lsp-factory-bot-completion](https://github.com/user-attachments/assets/4255a86a-8f36-4de2-8d10-8cb5a3f49e50)
 
+Click through to definitions
+
+![lsp-factory-bot-definition-trait](https://github.com/user-attachments/assets/92a4b224-b587-442d-9463-50d526872039)
+
+![lsp-factory-bot-definition-attribute](https://github.com/user-attachments/assets/d8650678-6759-42c8-b015-0fdbd4045494)
+
+
 ### Supports
 
 |         | Hover           | Completion  | Go to definition |
 | ------------- |-------------| -----| ----|
-| Factory name      | ✅ | ⭕️ | ❌ |
-| Trait      | ✅      |  ⭕️ | ❌ |
-| Attribute | ✅      |  ✅ | ❌ |
+| Attribute | ✅      |  ✅ | ✅ |
+| Trait      | ✅      |  ⭕️ | ✅ 
+| Factory name      | ✅ | ⭕️ | ❌ ||
 
 Notes:
 
 - The extension has "understanding" of factory/trait completion items, but due to limitations on when ruby-lsp displays the completion suggestions, they aren't visible for Symbols (eg. factory/trait names) :/ though they happen to be visible for symbols in Hash/Kw notation (ie with `:` after - `key: ...`)
-- Go to definition not supported yet but might come soon
+- Factory definition is not supported at the moment (current limitation of factory bot), but might come in due course
 
 
 ## Development

data/lib/ruby_lsp/rails/factory_bot/addon.rb

@@ -5,6 +5,7 @@ require "ruby_lsp/ruby_lsp_rails/addon"
 
 require_relative "completion"
 require_relative "hover"
+require_relative "definition"
 require_relative "addon_name"
 require_relative "../factory_bot"
 require_relative "../../../ruby_lsp_rails_factory_bot"
@@ -32,16 +33,16 @@ module RubyLsp
           Completion.new(response_builder, node_context, dispatcher, runner_client)
         end
 
-        # TODO: need URI param to be able to filter by file name
         def create_hover_listener(response_builder, node_context, dispatcher)
-          unless @addon_registered
-            register_addon!
-            return
-          end
-
+          register_addon!
           Hover.new(response_builder, node_context, dispatcher, runner_client, @ruby_index)
         end
 
+        def create_definition_listener(response_builder, _uri, node_context, dispatcher)
+          register_addon!
+          Definition.new(response_builder, node_context, dispatcher, runner_client)
+        end
+
         def workspace_did_change_watched_files(changes)
           return unless changes.any? do |change|
             change[:uri].match?(/(?:spec|test).+factor.+\.rb/)

data/lib/ruby_lsp/rails/factory_bot/definition.rb

@@ -0,0 +1,108 @@
+# frozen_string_literal: true
+
+require "ruby_lsp/internal"
+
+require_relative "addon_name"
+
+module RubyLsp
+  module Rails
+    module FactoryBot
+      # Definition listener - calls the registered methods when the appropriate nodes are entered
+      class Definition
+        include RubyLsp::Requests::Support::Common
+
+        def initialize(response_builder, node_context, dispatcher, server_client)
+          @response_builder = response_builder
+          @node_context = node_context
+          @server_client = server_client
+
+          dispatcher.register self, :on_symbol_node_enter
+        end
+
+        def on_symbol_node_enter(symbol_node)
+          parent = @node_context.parent
+          call_node = @node_context.call_node
+
+          return unless call_node
+
+          # "parent" isn't strictly speaking the immediate parent as in the AST - the
+          # element it refers to is a bit opinionated... in this case, it is always the call node,
+          # whether the symbol is an argument in the call_node args, or a symbol in a kw hash :/
+          unless parent.is_a?(Prism::CallNode) || FactoryBot::FACTORY_BOT_METHODS.include?(call_node.message.to_sym)
+            return
+          end
+
+          process_arguments_pattern(symbol_node, call_node.arguments.arguments)
+        end
+
+        private
+
+        def process_arguments_pattern(symbol_node, arguments) # rubocop:disable Metrics/MethodLength
+          case arguments
+          in [^symbol_node, *]
+            # factory location currently not available
+            #
+            # handle_factory(symbol_node)
+          in [Prism::SymbolNode => _factory_node, *, ^symbol_node] |
+             [Prism::SymbolNode => _factory_node, *, ^symbol_node, Prism::KeywordHashNode] |
+             [Prism::SymbolNode => _factory_node, *, ^symbol_node, Prism::HashNode] |
+             [Prism::SymbolNode => _factory_node, ^symbol_node, *] |
+             [Prism::SymbolNode => _factory_node, Prism::IntegerNode, ^symbol_node, *] |
+             [Prism::SymbolNode => _factory_node, Prism::IntegerNode, *, ^symbol_node, Prism::KeywordHashNode] |
+             [Prism::SymbolNode => _factory_node, Prism::IntegerNode, *, ^symbol_node, Prism::HashNode]
+
+            handle_trait(symbol_node, _factory_node)
+
+          in [Prism::SymbolNode => _factory_node, *, Prism::KeywordHashNode => _kw_hash] |
+             [Prism::SymbolNode => _factory_node, *, Prism::HashNode => _kw_hash]
+
+            handle_attribute(symbol_node, _factory_node) if _kw_hash.elements.any? { |e| e.key == symbol_node }
+          else
+            nil
+          end
+        end
+
+        def handle_attribute(symbol_node, factory_node)
+          name = symbol_node.value.to_s
+          attribute = make_request(
+            :attributes,
+            factory_name: factory_node.value.to_s, name: name,
+          )&.find { |attr| attr[:name] == name }
+
+          return unless attribute && attribute[:source_location]&.length&.positive?
+
+          @response_builder << Support::LocationBuilder.line_location_from_s(attribute[:source_location].join(":"))
+        end
+
+        def handle_factory(symbol_node)
+          name = symbol_node.value.to_s
+          factory = make_request(:factories, name: name)&.find { |f| f[:name] == name }
+          return unless factory && factory[:source_location]&.length&.positive?
+
+          @response_builder << Support::LocationBuilder.line_location_from_s(factory[:source_location].join(":"))
+        end
+
+        def handle_trait(symbol_node, factory_node)
+          factory_name = factory_node.value.to_s
+          trait_name = symbol_node.value.to_s
+
+          trait = make_request(:traits, factory_name: factory_name, name: trait_name)&.find do |tr|
+            tr[:name] == trait_name
+          end
+
+          return unless trait && trait[:source_location]&.length&.positive?
+
+          @response_builder << Support::LocationBuilder.line_location_from_s(trait[:source_location].join(":"))
+        end
+
+        def make_request(request_name, **params)
+          @server_client.delegate_request(
+            server_addon_name: FactoryBot::ADDON_NAME,
+            request_name: request_name.to_s,
+            **params,
+          )
+        end
+      end
+    end
+  end
+end

data/lib/ruby_lsp/rails/factory_bot/hover.rb

@@ -7,7 +7,7 @@ require_relative "addon_name"
 module RubyLsp
   module Rails
     module FactoryBot
-      # The listener that is created during relevant hover actions
+      # Hover listener - calls the registered methods when the appropriate nodes are entered
       class Hover
         include RubyLsp::Requests::Support::Common
 
@@ -43,8 +43,12 @@ module RubyLsp
           in [^symbol_node, *]
             handle_factory(symbol_node)
           in [Prism::SymbolNode => _factory_node, *, ^symbol_node] |
+             [Prism::SymbolNode => _factory_node, *, ^symbol_node, Prism::KeywordHashNode] |
+             [Prism::SymbolNode => _factory_node, *, ^symbol_node, Prism::HashNode] |
              [Prism::SymbolNode => _factory_node, ^symbol_node, *] |
-             [Prism::SymbolNode => _factory_node, Integer, ^symbol_node, *]
+             [Prism::SymbolNode => _factory_node, Prism::IntegerNode, ^symbol_node, *] |
+             [Prism::SymbolNode => _factory_node, Prism::IntegerNode, *, ^symbol_node, Prism::KeywordHashNode] |
+             [Prism::SymbolNode => _factory_node, Prism::IntegerNode, *, ^symbol_node, Prism::HashNode]
 
             handle_trait(symbol_node, _factory_node)
 
@@ -88,6 +92,11 @@ module RubyLsp
           @response_builder.push(hint, category: :documentation)
         end
 
+        def trait_tooltip(trait, factory_name)
+          source = trait[:source]&.length&.positive? ? trait[:source] : nil
+          source || "#{trait[:name]} (trait of #{trait[:owner] || factory_name})"
+        end
+
         def handle_trait(symbol_node, factory_node)
           factory_name = factory_node.value.to_s
           trait_name = symbol_node.value.to_s
@@ -98,10 +107,7 @@ module RubyLsp
 
           return unless trait
 
-          @response_builder.push(
-            "#{trait[:name]} (trait of #{trait[:owner] || factory_name})",
-            category: :documentation,
-          )
+          @response_builder.push(trait_tooltip(trait, factory_name), category: :documentation)
         end
 
         def make_request(request_name, **params)

data/lib/ruby_lsp_rails_factory_bot.rb

@@ -3,7 +3,7 @@
 module RubyLsp
   module Rails
     module FactoryBot
-      VERSION = "0.3.0"
+      VERSION = "0.5.0"
       REQUIRED_RUBY_LSP_RAILS_VERSION = "~> 0.4"
     end
   end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: ruby-lsp-rails-factory-bot
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.5.0
 platform: ruby
 authors:
 - johansenja
@@ -82,6 +82,7 @@ files:
 - lib/ruby_lsp/rails/factory_bot/addon.rb
 - lib/ruby_lsp/rails/factory_bot/addon_name.rb
 - lib/ruby_lsp/rails/factory_bot/completion.rb
+- lib/ruby_lsp/rails/factory_bot/definition.rb
 - lib/ruby_lsp/rails/factory_bot/hover.rb
 - lib/ruby_lsp/rails/factory_bot/server_addon.rb
 - lib/ruby_lsp/rails/factory_bot/server_addon/attribute_handler.rb