ruby-lsp-factory_bot 0.3.0 → 0.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e53f81bee237aa1380533073b84434270af2452c98ad6edbb9edbf1663cdbc43
-  data.tar.gz: 24d5309b51a16ef658f2b15f3f44a5f9bd6fb18743e5f4517344ca130f0aa82d
+  metadata.gz: f4ae7bc8179ba4962a90e3adc74721712416deeceb295f410bf67e857c6e7f85
+  data.tar.gz: a5186ec32f38cf6013509c4deef814f1c21fe8da584972cca76c59d0c549e654
 SHA512:
-  metadata.gz: 27b794a78d67d2ae305f0f099340a183eb92fed59741f4b1264dbffc8f86cdaffbc3efdcd81fa4586b908c71abe260df8f0e3c896197b5478833aa6e466a5426
-  data.tar.gz: 5f357307d3e982e759a8da970a4aca79886cbb1853c66809c0c00ebb8fd7eaa5cc6da8077038e70e7a0141f1646b9466a22eb8a4d03c0cc22eb11bdb64d27ef4
+  metadata.gz: 61d0eff2bd0fdca96578d1440e1182159cd2972a0bce5528e3d14616b984b1d51ac63f841622f88508359f9a99ad29eaeda74b872f2fc57fd790593241005e4b
+  data.tar.gz: 56e61ef4a900e2712a8c0e03307c8a19079733ef79382531dddc4bbfe4ac71fbc048ec946c03d4fef0343732daaaa1fe228b21ff15bd6a1c36de2e42c95fe0e2

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.rubocop.yml

@@ -0,0 +1,8 @@
+AllCops:
+  TargetRubyVersion: 3.0
+
+Style/StringLiterals:
+  EnforcedStyle: double_quotes
+
+Style/StringLiteralsInInterpolation:
+  EnforcedStyle: double_quotes

data/README.md

@@ -0,0 +1,26 @@
+# FactoryBot add-on
+
+The FactoryBot add-on is a [Ruby LSP](https://github.com/Shopify/ruby-lsp) [add-on](https://shopify.github.io/ruby-lsp/add-ons.html) for extra FactoryBot editor features.
+
+## Installation
+
+If you haven't already done so, you'll need to first [set up Ruby LSP](https://shopify.github.io/ruby-lsp/#usage).
+
+Add the following to your application's Gemfile:
+```ruby
+# Gemfile
+gem "ruby-lsp-factory_bot", require: false, group: :development
+```
+
+run `bundle install` and restart Ruby LSP server.
+
+## Features
+
+- [x] Go-to-definition for factories
+- [x] Go-to-definition for factory traits
+- [ ] Completions for factories and traits
+
+## 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,12 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+require "rubocop/rake_task"
+
+RuboCop::RakeTask.new
+
+task default: %i[spec rubocop]

data/lib/ruby-lsp-factory_bot.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+require "sorbet-runtime"
+require "ruby_lsp/factory_bot/version"
+require "ruby_lsp/factory_bot/addon"
+
+module RubyLsp
+  module FactoryBot
+  end
+end

data/lib/ruby_lsp/factory_bot/addon.rb

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+# parts << 'gem "ruby-lsp-factory_bot", require: false, group: :development, path: "~/Projects/ruby-lsp-factory_bot"'
+require "ruby_lsp/addon"
+require "ruby_lsp/internal"
+
+require_relative "definition"
+require_relative "indexing_enhancement"
+
+module RubyLsp
+  module FactoryBot
+    class Addon < ::RubyLsp::Addon
+      def name
+        "Ruby LSP - Factory Bot"
+      end
+
+      def version
+        VERSION
+      end
+
+      def activate(global_state, _message_queue)
+        @index = global_state.index
+      end
+
+      def deactivate; end
+
+      def create_definition_listener(response_builder, uri, node_context, dispatcher)
+        Definition.new(response_builder, uri, node_context, @index, dispatcher)
+      end
+    end
+  end
+end

data/lib/ruby_lsp/factory_bot/definition.rb

@@ -0,0 +1,134 @@
+# frozen_string_literal: true
+
+require_relative "utils"
+
+module RubyLsp
+  module FactoryBot
+    class Definition
+      include ::RubyLsp::Requests::Support::Common
+
+      FACTORY_BOT_STRATEGIES = %i[
+        create
+        build
+        build_stubbed
+        attributes_for
+      ].flat_map { |attr| [attr, :"#{attr}_list", :"#{attr}_pair"] }.freeze
+
+      def initialize(response_builder, uri, node_context, index, dispatcher)
+        @response_builder = response_builder
+        @uri = uri
+        @node_context = node_context
+        @index = index
+        dispatcher.register(self, :on_symbol_node_enter, :on_call_node_enter)
+      end
+
+      def on_symbol_node_enter(node)
+        return unless (call_node = @node_context&.call_node)
+
+        case call_node.name
+        when *FACTORY_BOT_STRATEGIES then factory_or_trait_location_for(call_node, node)
+        when :generate then sequence_location_for(node.value)
+        when :factory then target_class_location_for(node)
+        end
+      end
+
+      def on_call_node_enter(node)
+        return unless @node_context&.call_node&.message == "factory"
+        return if node.arguments || node.block
+
+        factory_location_for(node.message)
+      end
+
+      private
+
+      def factory_or_trait_location_for(call_node, node)
+        called_factory_name = Utils.name_from_node(call_node.arguments&.arguments&.first)
+        return unless called_factory_name
+
+        return factory_location_for(node.value) if node.value == called_factory_name
+
+        trait_location_for(node.value, called_factory_name)
+      end
+
+      def factory_location_for(factory_name)
+        @index["#{factory_name}FactoryBot"]&.each do |entry|
+          @response_builder << Interface::LocationLink.new(
+            target_uri: URI::Generic.from_path(path: entry.file_path).to_s,
+            target_range: range_from_location(entry.location),
+            target_selection_range: range_from_location(entry.name_location)
+          )
+        end
+      end
+
+      def trait_location_for(trait_name, called_factory_name)
+        @index["#{called_factory_name}-t-#{trait_name}FactoryBot"]&.each do |entry|
+          @response_builder << Interface::LocationLink.new(
+            target_uri: URI::Generic.from_path(path: entry.file_path).to_s,
+            target_range: range_from_location(entry.location),
+            target_selection_range: range_from_location(entry.name_location)
+          )
+        end
+      end
+
+      def sequence_location_for(sequence_name)
+        @index["#{sequence_name}-s-FactoryBot"]&.each do |entry|
+          @response_builder << Interface::LocationLink.new(
+            target_uri: URI::Generic.from_path(path: entry.file_path).to_s,
+            target_range: range_from_location(entry.location),
+            target_selection_range: range_from_location(entry.name_location)
+          )
+        end
+      end
+
+      def target_class_location_for(node)
+        call_node = @node_context.call_node
+        return unless call_node&.message == "factory"
+        return unless inside_factory_bot_define?
+
+        class_name = resolve_target_class_name_for_factory(call_node, node)
+
+        @index[class_name]&.each do |entry|
+          @response_builder << Interface::LocationLink.new(
+            target_uri: URI::Generic.from_path(path: entry.file_path).to_s,
+            target_range: range_from_location(entry.location),
+            target_selection_range: range_from_location(entry.name_location)
+          )
+        end
+      end
+
+      def inside_factory_bot_define?
+        nesting_nodes = @node_context.instance_variable_get :@nesting_nodes
+        body_statements = nesting_nodes.find { |node| node.is_a?(Prism::ProgramNode) }&.statements&.body
+
+        factory_bot_define = body_statements.find do |statement_body|
+          statement_body.is_a?(Prism::CallNode) && statement_body.message == "define"
+        end
+
+        factory_bot_define.block&.body&.body&.any? do |node|
+          node.is_a?(Prism::CallNode) && node == @node_context.call_node
+        end
+      end
+
+      def resolve_target_class_name_for_factory(call_node, node)
+        kwargs_node = call_node&.arguments&.arguments&.find do |argument|
+          argument.type == :keyword_hash_node || argument.type == :hash_node
+        end
+
+        class_name_value = kwargs_node&.elements&.find do |element|
+          Utils.name_from_node(element.key) == "class_name"
+        end&.value
+
+        case class_name_value
+        when Prism::StringNode then return class_name_value.content
+        when Prism::SymbolNode then return class_name_value.value.to_s
+        when Prism::ConstantReadNode then return class_name_value.name.to_s
+        end
+
+        factory_name = Utils.name_from_node(node)
+        return unless factory_name
+
+        Utils.snake_to_camel(factory_name)
+      end
+    end
+  end
+end

data/lib/ruby_lsp/factory_bot/indexing_enhancement.rb

@@ -0,0 +1,114 @@
+# frozen_string_literal: true
+
+require_relative "utils"
+
+module RubyLsp
+  module FactoryBot
+    class IndexingEnhancement < RubyIndexer::Enhancement
+      def initialize(...)
+        super
+        @inside_define_block = false
+        @factory_stack = []
+      end
+
+      FACTORIES_PATH = "spec/factories"
+
+      def on_call_node_enter(node)
+        @inside_define_block = true if node.message == "define"
+        return unless @inside_define_block
+
+        case node.message
+        when "factory"
+          @factory_stack << register_factory(node)
+        when "trait"
+          register_trait(node)
+        when "sequence"
+          register_sequence(node) if @factory_stack.empty?
+        end
+      end
+
+      def on_call_node_leave(node)
+        @inside_define_block = false if node.message == "define"
+        @factory_stack.pop if node.message == "factory"
+      end
+
+      private
+
+      def register_factory(node)
+        factory_names = resolve_factory_names(node)
+        factory_names&.each do |factory_name|
+          @listener.add_method(
+            "#{factory_name}FactoryBot",
+            node.location,
+            [RubyIndexer::Entry::Signature.new([])]
+          )
+        end
+
+        factory_names
+      end
+
+      def resolve_factory_names(node)
+        arguments = node.arguments&.arguments
+        return unless arguments
+
+        factory_names = []
+        factory_names << Utils.name_from_node(arguments.first)
+
+        keyword_hash_node = arguments.find do |argument|
+          argument.type == :keyword_hash_node || argument.type == :hash_node
+        end
+        return factory_names unless keyword_hash_node
+
+        aliases_node = keyword_hash_node.elements.find do |element|
+          Utils.name_from_node(element.key) == "aliases"
+        end&.value
+        return factory_names unless aliases_node
+
+        case aliases_node
+        when Prism::ArrayNode
+          factory_names += aliases_node.elements.map { |element| Utils.name_from_node(element) }
+        when Prism::SymbolNode, Prism::StringNode
+          factory_names << Utils.name_from_node(aliases_node)
+        end
+
+        factory_names
+      end
+
+      def register_trait(node)
+        return if !current_factory_names || current_factory_names.empty?
+
+        arguments = node.arguments&.arguments
+        return unless arguments
+
+        trait_name = Utils.name_from_node(arguments.first)
+        return unless trait_name
+
+        current_factory_names.each do |factory_name|
+          @listener.add_method(
+            "#{factory_name}-t-#{trait_name}FactoryBot",
+            node.location,
+            [RubyIndexer::Entry::Signature.new([])]
+          )
+        end
+      end
+
+      def current_factory_names
+        @factory_stack.last
+      end
+
+      def register_sequence(node)
+        arguments = node.arguments&.arguments
+        return unless arguments
+
+        sequence_name = Utils.name_from_node(arguments.first)
+        return unless sequence_name
+
+        @listener.add_method(
+          "#{sequence_name}-s-FactoryBot",
+          node.location,
+          [RubyIndexer::Entry::Signature.new([])]
+        )
+      end
+    end
+  end
+end

data/lib/ruby_lsp/factory_bot/utils.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+module Utils
+  module_function
+
+  def name_from_node(name_node)
+    case name_node
+    when Prism::StringNode
+      name_node.content
+    when Prism::SymbolNode
+      name_node.value
+    end
+  end
+
+  def snake_to_camel(snake_str)
+    snake_str.split("_").map(&:capitalize).join
+  end
+end

data/lib/ruby_lsp/factory_bot/version.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module RubyLsp
+  module FactoryBot
+    VERSION = "0.3.1"
+  end
+end

data/ruby-lsp-factory_bot.gemspec

@@ -0,0 +1,47 @@
+# frozen_string_literal: true
+
+require_relative "lib/ruby_lsp/factory_bot/version"
+
+Gem::Specification.new do |spec|
+  spec.name = "ruby-lsp-factory_bot"
+  spec.version = RubyLsp::FactoryBot::VERSION
+  spec.authors = ["donny741"]
+
+  spec.summary = "Ruby LSP FactoryBot Addon"
+  spec.description = "Provides go to definition and completion for FactoryBot attributes in Ruby LSP"
+  spec.homepage = "https://github.com/donny741/ruby-lsp-factory_bot"
+  spec.required_ruby_version = ">= 3.0.0"
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = spec.homepage
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files = Dir.chdir(__dir__) do
+    `git ls-files -z`.split("\x0").reject do |f|
+      (File.expand_path(f) == __FILE__) ||
+        f.start_with?(
+          "bin/",
+          "test/",
+          "spec/",
+          "features/",
+          ".git",
+          ".circleci",
+          "appveyor",
+          "Gemfile",
+          "misc/",
+          "sorbet/"
+        )
+    end
+  end
+  spec.bindir = "exe"
+  spec.executables = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  # Uncomment to register a new dependency of your gem
+  # spec.add_dependency "example-gem", "~> 1.0"
+  spec.add_dependency("ruby-lsp", ">= 0.23.0", "< 0.24.0")
+
+  # For more information and examples about making a new gem, check out our
+  # guide at: https://bundler.io/guides/creating_gem.html
+end

data/sig/ruby_lsp/factory_bot.rbs

@@ -0,0 +1,6 @@
+module RubyLsp
+  module FactoryBot
+    VERSION: String
+    # See the writing guide of rbs: https://github.com/ruby/rbs#guides
+  end
+end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: ruby-lsp-factory_bot
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.3.1
 platform: ruby
 authors:
 - donny741
 bindir: exe
 cert_chain: []
-date: 2025-01-18 00:00:00.000000000 Z
+date: 2025-03-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: ruby-lsp
@@ -34,7 +34,19 @@ description: Provides go to definition and completion for FactoryBot attributes
 executables: []
 extensions: []
 extra_rdoc_files: []
-files: []
+files:
+- ".rspec"
+- ".rubocop.yml"
+- README.md
+- Rakefile
+- lib/ruby-lsp-factory_bot.rb
+- lib/ruby_lsp/factory_bot/addon.rb
+- lib/ruby_lsp/factory_bot/definition.rb
+- lib/ruby_lsp/factory_bot/indexing_enhancement.rb
+- lib/ruby_lsp/factory_bot/utils.rb
+- lib/ruby_lsp/factory_bot/version.rb
+- ruby-lsp-factory_bot.gemspec
+- sig/ruby_lsp/factory_bot.rbs
 homepage: https://github.com/donny741/ruby-lsp-factory_bot
 licenses: []
 metadata: