attractor 2.7.0 → 2.7.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 00c69c27486cc5730d2524b7c25c69a3aecc58b6ba1bf516e34390e802deea2b
-  data.tar.gz: c5056b6a4046b02d10702d33a4dd38c5b4de6c5c87f92e04e9c96c9eecf07fc5
+  metadata.gz: f92fa88c85c572827d8a18feba00fcbd156c70a4642bbb9544beb90d7242af8f
+  data.tar.gz: d146f48f098cfb0e12ea135ed05279e1accf7ad44be1dbdd7009f8a1441efe60
 SHA512:
-  metadata.gz: 4cb863d6c362c6a9e98c2ca968bcd7fee4d565d1cc843c461ed0572a20d30c6e684e350138692bb632f285ce671fbe6a9ed3bffa85936426b3b80a1006f841ff
-  data.tar.gz: e8202453d0bdee8e9f009b229c834656d5aa00014c47de97c4c258735be51974b2be76195070d23a8737ab2d6b82adc68bb97bb02715091eebb2d8915c3094e9
+  metadata.gz: 379f288757d88603c45617ffc626c14498bcefc6e14c6442b1b95adf85afef07bb8b064833b2ceed36ebd582f6b0fafe2799fe972593f56f8755a757c330cf90
+  data.tar.gz: c89dcdb9f88391c072bec3af06f2efa2c962b70e95e04bbcc7899ba5dc61473d0461c7d23d9ebf59479c60a99d5c3d2e5dac6394cc427a352c96f4881ac56a25

data/README.md

@@ -238,6 +238,30 @@ attractor calc
   --config path/to/.attractor.yml
 ```
 
+Calculate the complexity delta between two git refs:
+
+```sh
+attractor diff
+  --base main
+  --head HEAD
+  --file_prefix|-p app/models
+  --type|-t rb|js
+  --start_ago|-s  (e.g. 5y, 3m, 7w)
+  --minimum_churn|-c (minimum times a file must have changed to be processed)
+  --ignore|-i 'spec/*_spec.rb,db/schema.rb,tmp'
+  --files 'app/models/user.rb,app/models/post.rb'
+  --files -
+  --format|-f table|markdown|json
+  --config path/to/.attractor.yml
+```
+
+The `markdown` format produces a PR/MR-ready summary with Stats, Trends, and To-dos sections, followed by the full per-file table wrapped in a collapsible `<details>` block. Pipe it into a GitHub or GitLab comment:
+
+```sh
+attractor diff --base main --head HEAD --format markdown | gh pr comment 123 --body-file -
+attractor diff --base main --head HEAD --format markdown | glab mr note 45 --message "$(cat)"
+```
+
 Generate a full report
 
 ```sh

data/lib/attractor/calculators/base_calculator.rb

@@ -34,7 +34,10 @@ module Attractor
       end
 
       target_paths = if @files && !@files.empty?
-        @files.uniq.select { |file_path| file_path.end_with?(".#{@file_extension}") }
+        # `file_extension` is a pattern, not a literal: the JavaScript calculator
+        # passes "(js|jsx)". `end_with?` would drop every file it lists.
+        extension = /\.(?:#{@file_extension})\z/
+        @files.uniq.select { |file_path| file_path.match?(extension) }
       else
         changes_by_path.keys
       end

data/lib/attractor/diff_calculator.rb

@@ -62,12 +62,13 @@ module Attractor
     def build_diff(base_values, head_values, files)
       base_by_path = flatten_values(base_values)
       head_by_path = flatten_values(head_values)
+      file_types = build_file_types(base_values, head_values)
 
       base_refactor_files = refactor_files(base_by_path.values)
       head_refactor_files = refactor_files(head_by_path.values)
 
       rows = files.uniq.map do |file_path|
-        build_row(file_path, base_by_path[file_path], head_by_path[file_path], base_refactor_files, head_refactor_files)
+        build_row(file_path, base_by_path[file_path], head_by_path[file_path], base_refactor_files, head_refactor_files, file_types[file_path])
       end
 
       rows.sort_by! { |row| -row[:delta].abs }
@@ -86,8 +87,20 @@ module Attractor
     end
 
     def flatten_values(values_by_type)
-      values_by_type.values.flatten.compact.each_with_object({}) do |value, hash|
-        hash[value.file_path] = value
+      values_by_type.each_with_object({}) do |(_type, values), hash|
+        Array(values).compact.each do |value|
+          hash[value.file_path] = value
+        end
+      end
+    end
+
+    def build_file_types(base_values, head_values)
+      [base_values, head_values].each_with_object({}) do |values_by_type, hash|
+        values_by_type.each do |type, values|
+          Array(values).compact.each do |value|
+            hash[value.file_path] ||= type
+          end
+        end
       end
     end
 
@@ -95,7 +108,7 @@ module Attractor
       Suggester.new(values).suggest.map(&:file_path)
     end
 
-    def build_row(file_path, base_value, head_value, base_refactor_files, head_refactor_files)
+    def build_row(file_path, base_value, head_value, base_refactor_files, head_refactor_files, type)
       complexity_base = base_value&.complexity
       complexity_head = head_value&.complexity
 
@@ -112,10 +125,12 @@ module Attractor
 
       {
         file_path: file_path,
+        type: type,
         complexity_base: complexity_base,
         complexity_head: complexity_head,
         delta: delta,
         churn: head_value&.churn,
+        score_base: base_value&.score,
         score_head: head_value&.score,
         refactor_base: base_refactor_files.include?(file_path),
         refactor_head: head_refactor_files.include?(file_path),

data/lib/attractor/formatters/formats/json.rb

@@ -9,6 +9,7 @@ module Attractor
         def call(report)
           report.metadata.merge(
             :title => report.title,
+            :summary => report.sections.empty? ? nil : report.sections,
             report.rows_key => rows_for(report),
             :footer => report.footer
           ).compact.to_json

data/lib/attractor/formatters/formats/markdown.rb

@@ -6,7 +6,7 @@ module Attractor
       class Markdown
         def call(report)
           lines = []
-          lines << "# #{report.title}"
+          lines << "#{title_prefix(report)} #{report.title}"
           lines << ""
 
           report.metadata.each do |key, value|
@@ -14,11 +14,24 @@ module Attractor
           end
           lines << "" unless report.metadata.empty?
 
-          lines << "| #{report.columns.join(" | ")} |"
-          lines << "| #{report.columns.map { |column| "-" * column.to_s.length }.join(" | ")} |"
+          report.sections.each do |section|
+            lines << "### #{section[:title]}"
+            lines << ""
+            lines += render_table(section[:columns], section[:rows])
+            lines << ""
+          end
 
-          report.rows.each do |row|
-            lines << "| #{report.columns.map { |column| row[column] }.join(" | ")} |"
+          if report.collapsed_table
+            lines << "<details>"
+            lines << "<summary>All files</summary>"
+            lines << ""
+          end
+
+          lines += render_table(report.columns, report.rows)
+
+          if report.collapsed_table
+            lines << ""
+            lines << "</details>"
           end
 
           if report.footer
@@ -31,6 +44,35 @@ module Attractor
 
         private
 
+        def render_table(columns, rows)
+          return [] if columns.empty?
+
+          lines = []
+          lines << "| #{columns.join(" | ")} |"
+          lines << "| #{columns.map { |column| "-" * column.to_s.length }.join(" | ")} |"
+
+          rows.each do |row|
+            lines << "| #{columns.map { |column| format_cell(column, row) }.join(" | ")} |"
+          end
+
+          lines
+        end
+
+        def format_cell(column, row)
+          value = row[column]
+
+          if column == :delta
+            return "new" if row[:complexity_base].nil? && !row[:complexity_head].nil?
+            return "deleted" if row[:complexity_head].nil? && !row[:complexity_base].nil?
+          end
+
+          value
+        end
+
+        def title_prefix(report)
+          (report.sections.any? || report.collapsed_table) ? "##" : "#"
+        end
+
         def format_key(key)
           key.to_s.split("_").map(&:capitalize).join(" ")
         end

data/lib/attractor/formatters/report.rb

@@ -3,9 +3,9 @@
 module Attractor
   module Formatters
     class Report
-      attr_reader :title, :metadata, :columns, :rows, :footer, :group_by, :rows_key
+      attr_reader :title, :metadata, :columns, :rows, :footer, :group_by, :rows_key, :sections, :collapsed_table
 
-      def initialize(title:, columns:, rows:, metadata: {}, footer: nil, group_by: nil, rows_key: :rows)
+      def initialize(title:, columns:, rows:, metadata: {}, footer: nil, group_by: nil, rows_key: :rows, sections: [], collapsed_table: false)
         @title = title
         @metadata = metadata
         @columns = columns
@@ -13,6 +13,8 @@ module Attractor
         @footer = footer
         @group_by = group_by
         @rows_key = rows_key
+        @sections = sections
+        @collapsed_table = collapsed_table
       end
     end
   end

data/lib/attractor/formatters/targets/diff.rb

@@ -7,18 +7,73 @@ module Attractor
     module Targets
       class Diff
         def call(data)
+          files = data[:files]
+
           Report.new(
-            title: "Complexity diff between #{data[:base_ref]} and #{data[:head_ref]}",
-            metadata: {
-              total_score_base: data[:total_score_base],
-              total_score_head: data[:total_score_head],
-              trend: data[:trend]
-            },
+            title: "Attractor: #{data[:base_ref]}..#{data[:head_ref]}",
             columns: %i[file_path complexity_base complexity_head delta churn score_head refactor_base refactor_head],
-            rows: data[:files],
-            rows_key: :files
+            rows: files,
+            rows_key: :files,
+            sections: [
+              {title: "Stats", columns: %i[language score trend], rows: stats_rows(files)},
+              {title: "Trends", columns: ["", :most_improved, :largest_declines], rows: trends_rows(files)},
+              {title: "To-dos", columns: ["", :new_refactoring_candidates, :refactored], rows: todos_rows(files)}
+            ],
+            collapsed_table: true
           )
         end
+
+        private
+
+        def stats_rows(files)
+          rows_by_type(files).map do |type, rows|
+            total_base = rows.sum { |row| row[:score_base].to_f }
+            total_head = rows.sum { |row| row[:score_head].to_f }
+            trend = total_head - total_base
+            percent = total_base.zero? ? 0.0 : (trend / total_base * 100)
+
+            {
+              language: type,
+              score: "#{format("%.1f", total_head)} (from #{format("%.1f", total_base)})",
+              trend: trend.zero? ? "0.0%" : "#{trend_emoji(trend)} #{format("%+.1f", percent)}%"
+            }
+          end
+        end
+
+        def trends_rows(files)
+          rows_by_type(files).map do |type, rows|
+            improved = rows.select { |row| row[:delta].negative? }.first(5)
+            declined = rows.select { |row| row[:delta].positive? }.first(5)
+
+            {
+              "" => type,
+              :most_improved => improved.empty? ? "none" : improved.map { |row| "#{row[:file_path]} (#{format("%.1f", row[:delta])})" }.join(", "),
+              :largest_declines => declined.empty? ? "none" : declined.map { |row| "#{row[:file_path]} (#{format("%+.1f", row[:delta])})" }.join(", ")
+            }
+          end
+        end
+
+        def todos_rows(files)
+          rows_by_type(files).map do |type, rows|
+            flipped = rows.select { |row| row[:refactor_base] != row[:refactor_head] }
+            new_candidates = flipped.select { |row| row[:refactor_head] }
+            refactored = flipped.reject { |row| row[:refactor_head] }
+
+            {
+              "" => type,
+              :new_refactoring_candidates => new_candidates.empty? ? "none" : new_candidates.map { |row| row[:file_path] }.join(", "),
+              :refactored => refactored.empty? ? "none" : refactored.map { |row| row[:file_path] }.join(", ")
+            }
+          end
+        end
+
+        def rows_by_type(files)
+          files.reject { |row| row[:type].nil? }.group_by { |row| row[:type] }
+        end
+
+        def trend_emoji(trend)
+          trend.positive? ? "📈" : "📉"
+        end
       end
     end
   end

data/lib/attractor/reporters/console_reporter.rb

@@ -5,6 +5,7 @@ require "attractor/formatters/targets/console"
 require "attractor/formatters/formats/json"
 require "attractor/formatters/formats/table"
 require "attractor/formatters/formats/csv"
+require "attractor/formatters/formats/markdown"
 require "attractor/formatters/format_strategy"
 
 module Attractor

data/lib/attractor/version.rb

@@ -1,3 +1,3 @@
 module Attractor
-  VERSION = "2.7.0"
+  VERSION = "2.7.1"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: attractor
 version: !ruby/object:Gem::Version
-  version: 2.7.0
+  version: 2.7.1
 platform: ruby
 authors:
 - Julian Rubisch
@@ -211,14 +211,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.3.0
+        version: 0.4.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.3.0
+        version: 0.4.0
 - !ruby/object:Gem::Dependency
   name: attractor-ruby
   requirement: !ruby/object:Gem::Requirement