attractor 2.7.2 → 2.8.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8f25163f3110bce204d78b6bbffb42973582b2950f7a3905949c255ad2392588
-  data.tar.gz: 1bf00d54220e67400a7eadcb6f9b33ab34e6a60100df5e3997861151d2ad2410
+  metadata.gz: 48389ab1e67aacc626f598cbcaf4b899b95dc8bcacd1ca4403802981ec52cd72
+  data.tar.gz: f6366aa8f6b10cb75e235f2ce6216dea5597601da575eb7dcc16ab8311347757
 SHA512:
-  metadata.gz: 29d2e731e695406b7e247806c7a1e3cab15f555df0fd0dd90d455d14513db6722d77f8747b2f64426ecb611599eef91bcf39824066d60536503d52e3fd1b4292
-  data.tar.gz: f71bc7dd89144521716bd9a4671c5e065113c6bb727b9da19001f3a73d5cdf4c942c7d829242c911a90811cf4404ba84094cd094b8033b92600763de21e28963
+  metadata.gz: 699db99bb212c7a1aab465dacb7a2e9ce1796b18e5a44005fc0bd619a5baeb55cae9dd2c0a4750c5bb2b5f93232efc1b4d503df2cc92da6ee14a9a21e294ce6c
+  data.tar.gz: f7485127a0e46fcaae2bf809b1ad71d28cad9caebeaa70978d117d19a0d6a6d728121f96dfe1139a193a8a0921a493e5e65c67bab355ecb7b526a7192f50e3fe

data/lib/attractor/calculators/lizard_calculator.rb

@@ -0,0 +1,59 @@
+# frozen_string_literal: true
+
+require "attractor/lizard"
+
+module Attractor
+  # Base calculator for languages scored with lizard. A plugin subclasses it and fixes the
+  # language and extension:
+  #
+  #   class SwiftCalculator < LizardCalculator
+  #     def initialize(**options)
+  #       super(language: "swift", file_extension: "swift", **options)
+  #       @type = "Swift"
+  #     end
+  #   end
+  #
+  # Complexity is the sum of the per-function cyclomatic complexity (McCabe, lizard's CCN),
+  # which is a different scale from flog's Ruby score; attractor reports per language, so
+  # the two are never summed. Details carry the same shape as attractor-ruby >= 0.4:
+  # `{ "name" => { "score" => ccn, "line" => start, "end_line" => end } }`.
+  class LizardCalculator < BaseCalculator
+    attr_reader :language
+
+    def initialize(language:, file_extension:, **options)
+      super(file_extension: file_extension, **options)
+      @language = language
+      @type = language.capitalize
+    end
+
+    def calculate
+      super do |change|
+        functions = Lizard.analyze(change[:file_path], language: language)
+        [functions.sum(&:ccn), details_for(functions)]
+      end
+    end
+
+    private
+
+    # lizard reports bare function names without their type, so overloads and same-named
+    # methods in different types collide. A key must not depend on what else is in the file
+    # or on line numbers, or `diff` cannot pair a function with itself across refs; the
+    # signature (lizard's long name) is what actually differs between overloads, so it is
+    # the key on collision, and the start line only when even the signatures match.
+    def details_for(functions)
+      by_name = functions.group_by(&:name)
+      by_long_name = functions.group_by(&:long_name)
+
+      functions.each_with_object({}) do |fn, details|
+        key = if by_name[fn.name].size == 1
+          fn.name
+        elsif by_long_name[fn.long_name].size == 1
+          fn.long_name
+        else
+          "#{fn.long_name}@#{fn.start_line}"
+        end
+        details[key] = {"score" => fn.ccn, "line" => fn.start_line, "end_line" => fn.end_line}
+      end
+    end
+  end
+end

data/lib/attractor/lizard.rb

@@ -0,0 +1,79 @@
+# frozen_string_literal: true
+
+require "csv"
+require "open3"
+
+module Attractor
+  # Runs lizard (https://github.com/terryyin/lizard), a multi-language cyclomatic complexity
+  # analyzer, and parses its CSV. Language plugins that have no native metric tool subclass
+  # LizardCalculator and pass their lizard language name; this module is the only place that
+  # knows how lizard is invoked.
+  module Lizard
+    Function = Struct.new(:name, :long_name, :ccn, :nloc, :start_line, :end_line)
+
+    INSTALL_HINT = "lizard is not installed. Install uv (https://docs.astral.sh/uv/) so `uvx lizard` works, " \
+      "or `pip install lizard`."
+
+    # nloc, ccn, tokens, params, length, location, file, name, long name, start, end
+    CSV_COLUMNS = 11
+
+    module_function
+
+    # Resolution order: a lizard on PATH (pip/pipx/brew), then uvx (fetches lizard on first run),
+    # then a clear error. Memoized per process; set ATTRACTOR_LIZARD to force a command.
+    # Windows note: this looks for the bare names, not PATHEXT variants; attractor is not
+    # tested there, and ATTRACTOR_LIZARD covers it.
+    def command
+      @command ||= begin
+        forced = ENV["ATTRACTOR_LIZARD"].to_s.split
+        if forced.any?
+          forced
+        elsif executable?("lizard")
+          ["lizard"]
+        elsif executable?("uvx")
+          ["uvx", "lizard"]
+        else
+          raise Attractor::Error, INSTALL_HINT
+        end
+      end
+    end
+
+    def reset!
+      @command = nil
+    end
+
+    def analyze(file_path, language:)
+      stdout, stderr, status = Open3.capture3(*command, "-l", language, "--csv", file_path)
+      raise Attractor::Error, "lizard failed on #{file_path}: #{stderr.strip}" unless status.success?
+
+      parse(stdout, file_path: file_path)
+    end
+
+    # `--csv` prints no header. Anything that is not a full row (a warning lizard writes to
+    # stdout, a blank line) is dropped rather than turned into a phantom function; a source
+    # file with bytes lizard echoes verbatim must not take the whole run down either.
+    def parse(csv, file_path: nil)
+      clean = csv.dup.force_encoding(Encoding::UTF_8).scrub("?")
+
+      CSV.parse(clean).filter_map do |row|
+        next unless row.size >= CSV_COLUMNS && integer?(row[1]) && integer?(row[9]) && integer?(row[10])
+
+        Function.new(row[7].to_s, row[8].to_s, row[1].to_i, row[0].to_i, row[9].to_i, row[10].to_i)
+      end
+    rescue CSV::MalformedCSVError => e
+      where = file_path ? " for #{file_path}" : nil
+      raise Attractor::Error, "lizard produced unreadable CSV#{where}: #{e.message}"
+    end
+
+    def integer?(value)
+      value.to_s.match?(/\A-?\d+\z/)
+    end
+
+    def executable?(name)
+      ENV.fetch("PATH", "").split(File::PATH_SEPARATOR).any? do |dir|
+        candidate = File.join(dir, name)
+        File.file?(candidate) && File.executable?(candidate)
+      end
+    end
+  end
+end

data/lib/attractor/version.rb

@@ -1,3 +1,3 @@
 module Attractor
-  VERSION = "2.7.2"
+  VERSION = "2.8.0"
 end

data/lib/attractor.rb

@@ -5,6 +5,7 @@ require "attractor/gem_names"
 require "attractor/duration_parser"
 require "attractor/config"
 require "attractor/calculators/base_calculator"
+require "attractor/calculators/lizard_calculator"
 require "attractor/detectors/base_detector"
 require "attractor/reporters/base_reporter"
 require "attractor/suggester"

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: attractor
 version: !ruby/object:Gem::Version
-  version: 2.7.2
+  version: 2.8.0
 platform: ruby
 authors:
 - Julian Rubisch
@@ -429,6 +429,7 @@ files:
 - lib/attractor/cache.rb
 - lib/attractor/calculators/base_calculator.rb
 - lib/attractor/calculators/base_calculator.rb~
+- lib/attractor/calculators/lizard_calculator.rb
 - lib/attractor/cli.rb
 - lib/attractor/cli.rb~
 - lib/attractor/config.rb
@@ -446,6 +447,7 @@ files:
 - lib/attractor/formatters/targets/diff.rb
 - lib/attractor/gem_names.rb
 - lib/attractor/git.rb
+- lib/attractor/lizard.rb
 - lib/attractor/registry_entry.rb
 - lib/attractor/reporters/base_reporter.rb
 - lib/attractor/reporters/base_reporter.rb~