ruby-lsp-rails-factory-bot 0.4.0 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 36e804a6875a0e627b7723e82840cbd502cc7dd4d352a740e9d7917379a2929a
-  data.tar.gz: e87ef45262a4740710ceae3229b7f681faaf002987d5a611f355e80a4e883378
+  metadata.gz: ecaef6088d61c2afa9d54e033f288ab6221f3e607214f31d7a2c4749a9c58450
+  data.tar.gz: 813d00d86a4f54c299ab0cd8db98760f8d0e33207d1621fc454813acd70914d7
 SHA512:
-  metadata.gz: a60ac6a177b638d4ecb930c2ccb0c0f59f1d457b421ebdcd6b64f55efe26aa179d8de68b80498b7701929c34a357410bc1e0d195835b51dc95312834648790ce
-  data.tar.gz: aa3ea96af8da24ef905db823967fac046a2a6900bb1f39033d8cbd20a5e284003df43669272ad48ff9eec49c5a433be534145d0855171d4423443114a9b2cc02
+  metadata.gz: 04755031614a46a02d65feb63b1f926e0ab4525d3e6b561f7964712ea9e46dfceccbfda8471586e518c2af5e308edb9050a1f36c8cff700b66804946e994c852
+  data.tar.gz: 822d8093fc8d3c113d17ddedd6e5fa7c37254b67c79227d6e7c6bbd97ee6bea436f17d7e387ed1a5b160b0e9841e37a23996cdf1ea19a17524e027ab12790c0f

data/README.md

@@ -12,30 +12,35 @@ If bundler is not being used to manage dependencies, install the gem by executin
 
     $ gem install ruby-lsp-rails-factory-bot
 
-Note that this currenlty uses a fork of ruby-lsp-rails (to extend its server to be able to provide factory information).
-
 ## Usage
 
-Hover over an attribute or factory definition
+Hover over a factory name, trait, or attribute
 
-![lsp-factory-bot-hover](https://github.com/user-attachments/assets/6f570288-3cf3-4d12-acf9-71c86e834cd8)
+![lsp-factory-bot-hover-all](https://github.com/user-attachments/assets/16e463cb-dddf-4d12-8a85-3357d47df6ff)
 
 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 (limitation of current implementation), 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"
@@ -37,6 +38,11 @@ module RubyLsp
           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
 
@@ -61,6 +61,12 @@ module RubyLsp
           end
         end
 
+        def build_response(title, documentation, link)
+          @response_builder.push(title, category: :title) if title
+          @response_builder.push(documentation, category: :documentation) if documentation
+          @response_builder.push(link, category: :links) if link
+        end
+
         def handle_attribute(symbol_node, factory_node)
           name = symbol_node.value.to_s
           attribute = make_request(
@@ -70,10 +76,14 @@ module RubyLsp
 
           return unless attribute
 
-          @response_builder.push(
-            "#{attribute[:name]} (#{attribute[:type]})",
-            category: :documentation,
-          )
+          build_response(attribute[:name].to_s, attribute[:type].to_s, link_location(attribute[:source_location]))
+        end
+
+        def factory_documentation(factory)
+          index_entry = @ruby_index.first_unqualified_const(factory[:name])
+          return markdown_from_index_entries(factory[:model_class], index_entry) if index_entry
+
+          factory[:model_class].to_s
         end
 
         def handle_factory(symbol_node)
@@ -81,20 +91,12 @@ module RubyLsp
           factory = make_request(:factories, name: name)&.find { |f| f[:name] == name }
           return unless factory
 
-          index_entry = @ruby_index.first_unqualified_const(factory[:name])
-
-          hint = if index_entry
-                   markdown_from_index_entries(factory[:model_class], index_entry)
-                 else
-                   "#{factory[:name]} (#{factory[:model_class]})"
-                 end
-
-          @response_builder.push(hint, category: :documentation)
+          build_response(factory[:name], factory_documentation(factory), nil)
         end
 
         def trait_tooltip(trait, factory_name)
           source = trait[:source]&.length&.positive? ? trait[:source] : nil
-          source || "#{trait[:name]} (trait of #{trait[:owner] || factory_name})"
+          source ? "```ruby\n#{source}\n```" : "trait of #{trait[:owner] || factory_name}"
         end
 
         def handle_trait(symbol_node, factory_node)
@@ -107,7 +109,7 @@ module RubyLsp
 
           return unless trait
 
-          @response_builder.push(trait_tooltip(trait, factory_name), category: :documentation)
+          build_response(trait[:name], trait_tooltip(trait, factory_name), link_location(trait[:source_location]))
         end
 
         def make_request(request_name, **params)
@@ -117,6 +119,14 @@ module RubyLsp
             **params,
           )
         end
+
+        def link_location(source_location)
+          return unless source_location
+
+          return if source_location.empty?
+
+          "[Definition](#{URI::Generic.from_path(path: source_location[0])}#L#{source_location[1]})"
+        end
       end
     end
   end

data/lib/ruby_lsp/rails/factory_bot/server_addon/base_handler.rb

@@ -26,7 +26,7 @@ module RubyLsp
           # helper - might be best to live elsewhere?
           def block_source(attr)
             blk = block_for(attr)
-            blk.source if blk.respond_to? :source
+            blk.source&.strip_heredoc if blk.respond_to? :source
           end
         end
       end

data/lib/ruby_lsp_rails_factory_bot.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ruby-lsp-rails-factory-bot
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 0.6.0
 platform: ruby
 authors:
 - johansenja
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2025-02-21 00:00:00.000000000 Z
+date: 2025-03-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: factory_bot
@@ -66,8 +66,8 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-description: A ruby-lsp-rails extension for factorybot, providing factory, trait and
-  attribute completion, and more
+description: A ruby-lsp-rails extension for factorybot, supporting hover, go-to-definition
+  and autocompletion - for factories, traits and attributes
 email:
 - 43235608+johansenja@users.noreply.github.com
 executables: []
@@ -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
@@ -113,8 +114,9 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.26
+rubygems_version: 3.5.11
 signing_key:
 specification_version: 4
-summary: A ruby-lsp-rails extension for factorybot
+summary: A ruby-lsp-rails extension for factorybot, supporting hover, go-to-definition
+  and autocompletion
 test_files: []