attractor 2.6.0 → 2.7.0

data/lib/attractor/formatters/formatter.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module Attractor
+  module Formatters
+    class Formatter
+      def initialize(target:, format:)
+        @target = target
+        @format = format
+      end
+
+      def call(data)
+        @format.call(@target.call(data))
+      end
+    end
+  end
+end

data/lib/attractor/formatters/report.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+module Attractor
+  module Formatters
+    class Report
+      attr_reader :title, :metadata, :columns, :rows, :footer, :group_by, :rows_key
+
+      def initialize(title:, columns:, rows:, metadata: {}, footer: nil, group_by: nil, rows_key: :rows)
+        @title = title
+        @metadata = metadata
+        @columns = columns
+        @rows = rows
+        @footer = footer
+        @group_by = group_by
+        @rows_key = rows_key
+      end
+    end
+  end
+end

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

@@ -0,0 +1,47 @@
+# frozen_string_literal: true
+
+require "attractor/formatters/report"
+
+module Attractor
+  module Formatters
+    module Targets
+      class Console
+        def call(calculators)
+          rows = []
+          footer_lines = []
+
+          calculators.each do |type, calc|
+            values = calc.calculate
+            suggester = Suggester.new(values)
+            refactor_files = suggester.suggest.map(&:file_path)
+
+            values.each do |value|
+              rows << {
+                type: type,
+                file_path: value.file_path,
+                score: value.score,
+                complexity: value.complexity,
+                churn: value.churn,
+                refactor: refactor_files.include?(value.file_path),
+                details: value.details,
+                history: value.history
+              }
+            end
+
+            footer_lines << "Suggestions for refactorings:"
+            footer_lines += refactor_files unless refactor_files.empty?
+          end
+
+          Report.new(
+            title: "Calculated churn and complexity",
+            metadata: {schema: 2},
+            columns: %i[file_path score complexity churn type refactor],
+            rows: rows,
+            footer: footer_lines.empty? ? nil : footer_lines.join("\n"),
+            group_by: :type
+          )
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+require "attractor/formatters/report"
+
+module Attractor
+  module Formatters
+    module Targets
+      class Diff
+        def call(data)
+          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]
+            },
+            columns: %i[file_path complexity_base complexity_head delta churn score_head refactor_base refactor_head],
+            rows: data[:files],
+            rows_key: :files
+          )
+        end
+      end
+    end
+  end
+end

data/lib/attractor/git.rb

@@ -0,0 +1,51 @@
+# frozen_string_literal: true
+
+require "fileutils"
+require "tmpdir"
+require "rugged"
+
+module Attractor
+  module Git
+    def self.repo
+      @repo ||= Rugged::Repository.discover(".")
+    end
+
+    def self.validate_ref!(ref)
+      repo.rev_parse(ref)
+    rescue Rugged::ReferenceError
+      raise ArgumentError, "Invalid git ref: #{ref}"
+    end
+
+    def self.diff_files(base_ref, head_ref)
+      base_commit = repo.merge_base(base_ref, head_ref)
+      head_commit = repo.rev_parse(head_ref)
+
+      repo.diff(base_commit, head_commit).deltas.map { |delta| delta.new_file[:path] }.uniq
+    end
+
+    class Worktree
+      attr_reader :path
+
+      def initialize(ref)
+        @ref = ref
+        @path = Dir.mktmpdir("attractor-diff-#{ref}-")
+      end
+
+      def checkout
+        success = system("git", "worktree", "add", "-f", @path, @ref, out: File::NULL, err: File::NULL)
+        raise "Failed to create git worktree for #{@ref} at #{@path}" unless success
+
+        self
+      end
+
+      def cleanup
+        system("git", "worktree", "remove", "-f", @path, out: File::NULL, err: File::NULL)
+        FileUtils.rm_rf(@path)
+      end
+
+      def chdir(&block)
+        Dir.chdir(@path, &block)
+      end
+    end
+  end
+end

data/lib/attractor/reporters/base_reporter.rb

@@ -10,6 +10,7 @@ module Attractor
   # base reporter
   class BaseReporter
     extend Forwardable
+
     attr_accessor :file_prefix
     attr_reader :types
     attr_writer :values

data/lib/attractor/reporters/console_reporter.rb

@@ -1,96 +1,28 @@
 # frozen_string_literal: true
 
+require "attractor/formatters/formatter"
+require "attractor/formatters/targets/console"
+require "attractor/formatters/formats/json"
+require "attractor/formatters/formats/table"
+require "attractor/formatters/formats/csv"
+require "attractor/formatters/format_strategy"
+
 module Attractor
   # console reporter
   class ConsoleReporter < BaseReporter
-    class TableFormatter
-      def call(calculators)
-        puts "Calculated churn and complexity"
-        puts
-        puts "file_path#{" " * 53}complexity   churn"
-        puts "-" * 80
-
-        calculators.each do |calc|
-          # e.g. ['js', JsCalculator']
-          puts calc.last.type
-
-          values = calc.last.calculate
-          suggester = Suggester.new(values)
-
-          puts values&.map(&:to_s)
-          puts
-          puts "Suggestions for refactorings:"
-          suggester.suggest&.each { |sug| puts sug.file_path }
-          puts
-        end
-      end
-    end
-
-    class CSVFormatter
-      def call(calculators)
-        require "csv"
-
-        result = CSV.generate do |csv|
-          csv << %w[file_path score complexity churn type refactor]
-
-          calculators.each do |calc|
-            type = calc.last.type
-            values = calc.last.calculate
-            suggester = Suggester.new(values)
-            to_be_refactored = suggester.suggest.map(&:file_path)
-
-            values.each do |value|
-              csv << [value.file_path, value.score, value.complexity, value.churn, type, to_be_refactored.include?(value.file_path)]
-            end
-          end
-        end
-
-        puts result
-      end
-    end
-
-    class JSONFormatter
-      def call(calculators)
-        result = calculators.map do |calc|
-          type = calc.last.type
-          values = calc.last.calculate
-          suggester = Suggester.new(values)
-          to_be_refactored = suggester.suggest.map(&:file_path)
-
-          [
-            type, values.map do |value|
-              {
-                file_path: value.file_path,
-                score: value.score,
-                complexity: value.complexity,
-                churn: value.churn,
-                refactor: to_be_refactored.include?(value.file_path),
-                details: value.details,
-                history: value.history
-              }
-            end
-          ]
-        end
-
-        puts result.to_h.to_json
-      end
-    end
+    include Attractor::Formatters::FormatStrategy
 
     def initialize(format:, **other)
       super(**other)
-      @formatter = case format.to_sym
-      when :csv
-        CSVFormatter.new
-      when :json
-        JSONFormatter.new
-      else
-        TableFormatter.new
-      end
+      @formatter = Attractor::Formatters::Formatter.new(
+        target: Attractor::Formatters::Targets::Console.new,
+        format: format_strategy(format)
+      )
     end
 
     def report
       super
-      @formatter.call(@calculators)
+      puts @formatter.call(@calculators)
     end
   end
 end

data/lib/attractor/reporters/diff_reporter.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+require "attractor/formatters/formatter"
+require "attractor/formatters/targets/diff"
+require "attractor/formatters/formats/json"
+require "attractor/formatters/formats/table"
+require "attractor/formatters/formats/markdown"
+require "attractor/formatters/format_strategy"
+
+module Attractor
+  # Reporter for complexity deltas between two git refs
+  class DiffReporter
+    include Attractor::Formatters::FormatStrategy
+
+    def initialize(format:)
+      @formatter = Attractor::Formatters::Formatter.new(
+        target: Attractor::Formatters::Targets::Diff.new,
+        format: format_strategy(format)
+      )
+    end
+
+    def report(data)
+      puts @formatter.call(data)
+    end
+  end
+end

data/lib/attractor/suggester.rb

@@ -10,11 +10,14 @@ module Attractor
     end
 
     def suggest(threshold = 95)
-      products = @values.map(&:score)
+      scored_values = @values.reject { |value| value.score.nil? }
+      return [] if scored_values.empty?
+
+      products = scored_values.map(&:score)
       products.extend(DescriptiveStatistics)
       quantile = products.percentile(threshold.to_i)
 
-      @values.select { |val| val.score > quantile }
+      scored_values.select { |val| val.score > quantile }
         .sort_by { |val| val.score }.reverse
     end
   end

data/lib/attractor/value.rb

@@ -20,11 +20,14 @@ module Attractor
     end
 
     def score
+      return nil if @complexity.nil?
+
       @complexity * @churn
     end
 
     def to_s
-      format("%-64s%8.1f%8i", @file_path, @complexity, @churn)
+      complexity_str = @complexity.nil? ? "n/a" : format("%8.1f", @complexity)
+      format("%-64s%8s%8i", @file_path, complexity_str, @churn)
     end
 
     def to_h

data/lib/attractor/version.rb

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

data/lib/attractor/watcher.rb

@@ -17,7 +17,7 @@ module Attractor
 
       listener = Listen.to(File.absolute_path(@file_prefix), ignore: ignore) do |modified, _added, _removed|
         if modified
-          puts "#{modified.map(&:to_s).join(", ")} modified, recalculating..."
+          puts "#{modified.join(", ")} modified, recalculating..."
           @callback.call
         end
       end

data/lib/attractor.rb

@@ -3,6 +3,7 @@
 require "attractor/version"
 require "attractor/gem_names"
 require "attractor/duration_parser"
+require "attractor/config"
 require "attractor/calculators/base_calculator"
 require "attractor/detectors/base_detector"
 require "attractor/reporters/base_reporter"
@@ -10,12 +11,6 @@ require "attractor/suggester"
 require "attractor/watcher"
 require "attractor/cache"
 
-Dir[File.join(__dir__, "attractor", "reporters", "*.rb")].sort.each do |file|
-  next if file.start_with?("base")
-
-  require file
-end
-
 module Attractor
   class Error < StandardError; end
 
@@ -35,11 +30,20 @@ module Attractor
   end
 
   def calculators_for_type(type, **options)
+    files = options.delete(:files)
     registry_entry_for_type = @registry_entries[type]
 
-    return {type => registry_entry_for_type.calculator_class.new(**options)} if type
+    if type
+      calculator = registry_entry_for_type.calculator_class.new(**options)
+      calculator.files = files if calculator.respond_to?(:files=)
+      return {type => calculator}
+    end
 
-    all_registered_calculators(**options)
+    all_registered_calculators(**options).tap do |calculators|
+      calculators.each_value do |calculator|
+        calculator.files = files if calculator.respond_to?(:files=)
+      end
+    end
   end
 
   def all_registered_calculators(options = {})

metadata

@@ -1,14 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: attractor
 version: !ruby/object:Gem::Version
-  version: 2.6.0
+  version: 2.7.0
 platform: ruby
 authors:
 - Julian Rubisch
-autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-12-03 00:00:00.000000000 Z
+date: 1980-01-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: churn
@@ -24,6 +23,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: 1.0.4
+- !ruby/object:Gem::Dependency
+  name: csv
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: descriptive_statistics
   requirement: !ruby/object:Gem::Requirement
@@ -38,6 +51,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: logger
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: flog
   requirement: !ruby/object:Gem::Requirement
@@ -80,6 +107,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: ostruct
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rack-livereload
   requirement: !ruby/object:Gem::Requirement
@@ -94,6 +135,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: rugged
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
 - !ruby/object:Gem::Dependency
   name: sinatra
   requirement: !ruby/object:Gem::Requirement
@@ -170,14 +225,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: autoprefixer-rails
   requirement: !ruby/object:Gem::Requirement
@@ -376,14 +431,27 @@ files:
 - lib/attractor/calculators/base_calculator.rb~
 - lib/attractor/cli.rb
 - lib/attractor/cli.rb~
+- lib/attractor/config.rb
 - lib/attractor/detectors/base_detector.rb
+- lib/attractor/diff_calculator.rb
 - lib/attractor/duration_parser.rb
+- lib/attractor/formatters/format_strategy.rb
+- lib/attractor/formatters/formats/csv.rb
+- lib/attractor/formatters/formats/json.rb
+- lib/attractor/formatters/formats/markdown.rb
+- lib/attractor/formatters/formats/table.rb
+- lib/attractor/formatters/formatter.rb
+- lib/attractor/formatters/report.rb
+- lib/attractor/formatters/targets/console.rb
+- lib/attractor/formatters/targets/diff.rb
 - lib/attractor/gem_names.rb
+- lib/attractor/git.rb
 - lib/attractor/registry_entry.rb
 - lib/attractor/reporters/base_reporter.rb
 - lib/attractor/reporters/base_reporter.rb~
 - lib/attractor/reporters/console_reporter.rb
 - lib/attractor/reporters/console_reporter.rb~
+- lib/attractor/reporters/diff_reporter.rb
 - lib/attractor/reporters/html_reporter.rb
 - lib/attractor/reporters/sinatra_reporter.rb
 - lib/attractor/suggester.rb
@@ -400,7 +468,6 @@ metadata:
   source_code_uri: https://github.com/julianrubisch/attractor
   bug_tracker_uri: https://github.com/julianrubisch/attractor/issues
   changelog_uri: https://github.com/julianrubisch/attractor/CHANGELOG.md
-post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -415,8 +482,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.19
-signing_key:
+rubygems_version: 4.0.10
 specification_version: 4
 summary: Churn vs Complexity Chart Generator
 test_files: []