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

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 74a733cd2866ef2bf14eef3cb4a7dd97dec52c7a315bed5ea884860bcb268f10
-  data.tar.gz: b3ff978e4038960010882e6b51bf079aa057de8ba7ce60acb37b278aaec304ba
+  metadata.gz: ecaef6088d61c2afa9d54e033f288ab6221f3e607214f31d7a2c4749a9c58450
+  data.tar.gz: 813d00d86a4f54c299ab0cd8db98760f8d0e33207d1621fc454813acd70914d7
 SHA512:
-  metadata.gz: f32b35548606386cf6bfdac973f5437d5a182984f8285f512f47f90f5a49d46598415de52661ed1c4962538b5c1dc29af29a497e2083de4e14a2981d62fe8b5d
-  data.tar.gz: 98bfeb00adb8386588921797416174e6a7121f678b6b081c678f3367cf4e327aded286423ff93879f190524891c3274464d3ec191eb568727b9b947d2cb4b3f9
+  metadata.gz: 04755031614a46a02d65feb63b1f926e0ab4525d3e6b561f7964712ea9e46dfceccbfda8471586e518c2af5e308edb9050a1f36c8cff700b66804946e994c852
+  data.tar.gz: 822d8093fc8d3c113d17ddedd6e5fa7c37254b67c79227d6e7c6bbd97ee6bea436f17d7e387ed1a5b160b0e9841e37a23996cdf1ea19a17524e027ab12790c0f

data/README.md

@@ -12,13 +12,11 @@ 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
 
@@ -42,7 +40,7 @@ Click through to definitions
 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: ...`)
-- Factory definition is not supported at the moment (current limitation of factory bot), but might come in due course
+- 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/hover.rb

@@ -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.5.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.5.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: []
@@ -114,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: []