rspec-let-analyzer 0.1.0

data/lib/rspec_let_analyzer/visitors/prism_visitor.rb

@@ -0,0 +1,125 @@
+# frozen_string_literal: true
+
+require 'prism'
+
+module RSpecLetAnalyzer
+  module Visitors
+    class PrismVisitor < Prism::Visitor
+    attr_reader :root_lets, :total_its, :redefinitions, :nesting_counts, :factory_usage, :before_creates
+
+    def initialize(max_nesting_depth, track_factories)
+      @root_lets = 0
+      @total_its = 0
+      @redefinitions = 0
+      @depth = 0
+      @let_names_by_depth = {}
+      @max_nesting_depth = max_nesting_depth
+      @nesting_counts = Array.new(max_nesting_depth, 0) if max_nesting_depth
+      @track_factories = track_factories
+      @factory_usage = Hash.new(0) if track_factories
+      @before_creates = 0
+      @in_before_block = false
+    end
+
+    def visit_call_node(node)
+      method_name = node.name
+
+      case method_name
+      when :describe, :context, :shared_examples, :shared_context
+        @depth += 1
+        super
+        @depth -= 1
+        # Clean up let names at this depth when exiting
+        @let_names_by_depth.delete(@depth + 1)
+      when :before
+        # Check if this is before or before(:each)
+        arg = node.arguments&.arguments&.first
+        is_before_each = arg.nil? || (arg.is_a?(Prism::SymbolNode) && arg.unescaped == 'each')
+
+        if is_before_each
+          @in_before_block = true
+          super
+          @in_before_block = false
+        else
+          super
+        end
+      when :let, :let!
+        # Get the let variable name
+        let_name = extract_let_name(node)
+
+        if let_name
+          # Check if this let redefines one from an outer scope
+          @redefinitions += 1 if redefinition?(let_name)
+
+          # Track this let name at current depth
+          @let_names_by_depth[@depth] ||= []
+          @let_names_by_depth[@depth] << let_name
+        end
+
+        # Count by nesting depth
+        if @depth == 1
+          @root_lets += 1
+        elsif @max_nesting_depth
+          # Track nesting counts: depth 2 -> index 0, depth 3 -> index 1, etc.
+          nesting_index = @depth - 2
+          if nesting_index < @max_nesting_depth - 1
+            @nesting_counts[nesting_index] += 1
+          else
+            # Everything at max depth or beyond goes into the last bucket
+            @nesting_counts[@max_nesting_depth - 1] += 1
+          end
+        end
+        super
+      when :it, :specify
+        @total_its += 1
+        super
+      when :create, :build, :build_stubbed
+        # Track if create is inside a before block
+        if @in_before_block && method_name == :create
+          @before_creates += 1
+        end
+
+        # Track FactoryBot usage
+        if @track_factories
+          factory_name = extract_factory_name(node)
+          @factory_usage[factory_name] += 1 if factory_name
+        end
+        super
+      else
+        super
+      end
+    end
+
+    private
+
+    def extract_let_name(node)
+      # The first argument to let() is typically a symbol representing the variable name
+      return nil unless node.arguments&.arguments&.any?
+
+      first_arg = node.arguments.arguments.first
+      case first_arg
+      when Prism::SymbolNode
+        first_arg.unescaped
+      end
+    end
+
+    def extract_factory_name(node)
+      # Handle both create(:factory) and FactoryBot.create(:factory)
+      return nil unless node.arguments&.arguments&.any?
+
+      first_arg = node.arguments.arguments.first
+      case first_arg
+      when Prism::SymbolNode
+        first_arg.unescaped.to_sym
+      end
+    end
+
+    def redefinition?(let_name)
+      # Check all outer scopes (lower depths) for this let name
+      (1...@depth).any? do |outer_depth|
+        @let_names_by_depth[outer_depth]&.include?(let_name)
+      end
+    end
+  end
+end
+end

data/lib/rspec_let_analyzer.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+require 'prism'
+require_relative 'rspec_let_analyzer/version'
+require_relative 'rspec_let_analyzer/adapter'
+require_relative 'rspec_let_analyzer/visitors/prism_visitor'
+require_relative 'rspec_let_analyzer/visitors/parser_visitor'
+require_relative 'rspec_let_analyzer/analyzer'
+require_relative 'rspec_let_analyzer/progress_reporter'
+require_relative 'rspec_let_analyzer/formatters/ascii_formatter'
+require_relative 'rspec_let_analyzer/formatters/json_formatter'
+require_relative 'rspec_let_analyzer/formatters/html_formatter'
+require_relative 'rspec_let_analyzer/formatters/llm_formatter'
+
+module RSpecLetAnalyzer
+end

metadata

@@ -0,0 +1,103 @@
+--- !ruby/object:Gem::Specification
+name: rspec-let-analyzer
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- James Cook
+bindir: bin
+cert_chain: []
+date: 2025-10-08 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: prism
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.19'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.19'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.12'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.12'
+description: A tool that parses RSpec test files to identify let/let! declarations
+  that could be refactored to use test-prof's let_it_be helper for improved test performance
+email:
+- ''
+executables:
+- rspec-let-analyzer
+extensions: []
+extra_rdoc_files: []
+files:
+- README.md
+- bin/rspec-let-analyzer
+- lib/rspec_let_analyzer.rb
+- lib/rspec_let_analyzer/adapter.rb
+- lib/rspec_let_analyzer/adapters/parser_adapter.rb
+- lib/rspec_let_analyzer/adapters/prism_adapter.rb
+- lib/rspec_let_analyzer/analyzer.rb
+- lib/rspec_let_analyzer/formatters/ascii_formatter.rb
+- lib/rspec_let_analyzer/formatters/html_formatter.rb
+- lib/rspec_let_analyzer/formatters/json_formatter.rb
+- lib/rspec_let_analyzer/formatters/llm_formatter.rb
+- lib/rspec_let_analyzer/progress_reporter.rb
+- lib/rspec_let_analyzer/version.rb
+- lib/rspec_let_analyzer/visitors/parser_visitor.rb
+- lib/rspec_let_analyzer/visitors/prism_visitor.rb
+homepage: https://github.com/jamescook/rspec-let-analyzer
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/jamescook/rspec-let-analyzer
+  source_code_uri: https://github.com/jamescook/rspec-let-analyzer
+  rubygems_mfa_required: 'true'
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.7.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.6.2
+specification_version: 4
+summary: Analyze RSpec let declarations to identify refactoring opportunities for
+  let_it_be
+test_files: []