churn_vs_complexity 1.5.2 → 1.6.0

data/lib/churn_vs_complexity/normal/serializer/summary_hash.rb

@@ -7,45 +7,38 @@ module ChurnVsComplexity
         class << self
           def serialize(result)
             values_by_file = result[:values_by_file]
-            churn_values = values_by_file.map { |_, values| values[0].to_f }
-            complexity_values = values_by_file.map { |_, values| values[1].to_f }
-
-            mean_churn = churn_values.sum / churn_values.size
-            median_churn = churn_values.sort[churn_values.size / 2]
-            mean_complexity = complexity_values.sum / complexity_values.size
-            median_complexity = complexity_values.sort[complexity_values.size / 2]
+            end_date = result[:git_period].end_date
 
-            max_churn = churn_values.max
-            min_churn = churn_values.min
-            max_complexity = complexity_values.max
-            min_complexity = complexity_values.min
+            return empty_summary(end_date) if values_by_file.empty?
 
-            epsilon = 0.0001
-            gamma_score = values_by_file.map do |_, values|
-              # unnormalised harmonic mean of churn and complexity,
-              # since the summary needs to be comparable over time
-              churn = values[0].to_f + epsilon
-              complexity = values[1].to_f + epsilon
+            churn_values = values_by_file.map { |_, values| values[0].to_f }
+            complexity_values = values_by_file.map { |_, values| values[1].to_f }
+            gamma_scores = values_by_file.map { |_, values| GammaScore.calculate(values[0], values[1]) }
 
-              (2 * churn * complexity) / (churn + complexity)
-            end
+            stats(churn_values).transform_keys { |k| :"#{k}_churn" }
+              .merge(stats(complexity_values).transform_keys { |k| :"#{k}_complexity" })
+              .merge(stats(gamma_scores).slice(:mean, :median).transform_keys { |k| :"#{k}_gamma_score" })
+              .merge(end_date:)
+          end
 
-            mean_gamma_score = gamma_score.sum / gamma_score.size
-            median_gamma_score = gamma_score.sort[gamma_score.size / 2]
+          private
 
-            end_date = result[:git_period].end_date
+          def stats(values)
+            { mean: values.sum / values.size, median: values.sort[values.size / 2], max: values.max, min: values.min }
+          end
 
+          def empty_summary(end_date)
             {
-              mean_churn:,
-              median_churn:,
-              max_churn:,
-              min_churn:,
-              mean_complexity:,
-              median_complexity:,
-              max_complexity:,
-              min_complexity:,
-              mean_gamma_score:,
-              median_gamma_score:,
+              mean_churn: 0.0,
+              median_churn: 0.0,
+              max_churn: 0.0,
+              min_churn: 0.0,
+              mean_complexity: 0.0,
+              median_complexity: 0.0,
+              max_complexity: 0.0,
+              min_complexity: 0.0,
+              mean_gamma_score: 0.0,
+              median_gamma_score: 0.0,
               end_date:,
             }
           end

data/lib/churn_vs_complexity/normal/serializer.rb

@@ -5,6 +5,7 @@ require_relative 'serializer/summary'
 require_relative 'serializer/csv'
 require_relative 'serializer/graph'
 require_relative 'serializer/pass_through'
+require_relative 'serializer/json'
 
 module ChurnVsComplexity
   module Normal

data/lib/churn_vs_complexity/normal.rb

@@ -9,7 +9,7 @@ module ChurnVsComplexity
     module SerializerValidator
       def self.validate!(serializer:)
         raise ValidationError, "Unsupported serializer: #{serializer}" \
-          unless %i[none csv graph summary].include?(serializer)
+          unless %i[none csv graph summary json].include?(serializer)
       end
     end
 

data/lib/churn_vs_complexity/risk_annotator.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+module ChurnVsComplexity
+  module RiskAnnotator
+    def self.annotate(values_by_file, classifier: RiskClassifier.new)
+      values_by_file.map { |file, values| build_entry(file, values, classifier) }
+    end
+
+    def self.risk_summary(entries)
+      counts = entries.each_with_object(Hash.new(0)) { |e, acc| acc["#{e[:risk]}_risk"] += 1 }
+      { high_risk: counts['high_risk'], medium_risk: counts['medium_risk'], low_risk: counts['low_risk'] }
+    end
+
+    def self.build_entry(file, values, classifier)
+      gamma = GammaScore.calculate(values[0], values[1])
+      classification = classifier.classify(gamma_score: gamma)
+
+      {
+        file:, churn: values[0], complexity: values[1].to_f, gamma_score: gamma.round(2),
+        risk: classification[:risk], recommendation: classification[:recommendation],
+      }
+    end
+
+    private_class_method :build_entry
+  end
+end

data/lib/churn_vs_complexity/risk_classifier.rb

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+module ChurnVsComplexity
+  class RiskClassifier
+    DEFAULT_LOW = 10
+    DEFAULT_HIGH = 25
+
+    RECOMMENDATIONS = {
+      'low' => 'Safe for quick changes.',
+      'medium' => 'Exercise judgement; consider tests for non-trivial changes.',
+      'high' => 'Write tests before modifying. Consider multi-agent review.',
+    }.freeze
+
+    def initialize(low: DEFAULT_LOW, high: DEFAULT_HIGH)
+      @low = low
+      @high = high
+    end
+
+    def classify(gamma_score:)
+      risk = if gamma_score < @low
+               'low'
+             elsif gamma_score > @high
+               'high'
+             else
+               'medium'
+             end
+
+      { risk:, recommendation: RECOMMENDATIONS[risk] }
+    end
+
+    def self.classify(gamma_score:)
+      new.classify(gamma_score:)
+    end
+  end
+end

data/lib/churn_vs_complexity/triage/checker.rb

@@ -0,0 +1,64 @@
+# frozen_string_literal: true
+
+module ChurnVsComplexity
+  module Triage
+    class Checker
+      def initialize(language:, serializer:, targets:, since:, excluded:)
+        @language = language
+        @serializer = serializer
+        @targets = targets
+        @since = since
+        @excluded = excluded
+      end
+
+      def check(folder: nil)
+        files, dirs = partition_targets
+        folder = folder || dirs.first || '.'
+        engine = build_engine(files, folder)
+        raw_result = engine.check(folder:)
+        @serializer.serialize(raw_result)
+      end
+
+      private
+
+      def partition_targets
+        @targets.partition { |t| File.file?(t) }
+      end
+
+      def build_engine(files, _folder)
+        Engine.concurrent(
+          complexity: complexity_for(@language),
+          churn: Churn::GitCalculator,
+          file_selector: select_files(files),
+          serializer: Normal::Serializer::None,
+          since: @since,
+        )
+      end
+
+      def select_files(files)
+        selector = file_selector_for(@language)
+        files.any? ? selector.predefined(included: files, excluded: @excluded) : selector.excluding(@excluded)
+      end
+
+      def file_selector_for(language)
+        case language
+        when :ruby then FileSelector::Ruby
+        when :java then FileSelector::Java
+        when :javascript then FileSelector::JavaScript
+        when :python then FileSelector::Python
+        when :go then FileSelector::Go
+        end
+      end
+
+      def complexity_for(language)
+        case language
+        when :ruby then Complexity::FlogCalculator
+        when :java then Complexity::PMD::FolderCalculator
+        when :javascript then Complexity::ESLintCalculator
+        when :python then Complexity::PythonCalculator
+        when :go then Complexity::GoCalculator
+        end
+      end
+    end
+  end
+end

data/lib/churn_vs_complexity/triage/config.rb

@@ -0,0 +1,52 @@
+# frozen_string_literal: true
+
+module ChurnVsComplexity
+  module Triage
+    class Config
+      def initialize(
+        language:,
+        serializer: :json,
+        targets: [],
+        since: nil,
+        excluded: [],
+        complexity_validator: ComplexityValidator,
+        since_validator: Normal::SinceValidator,
+        **options
+      )
+        @language = language
+        @serializer = serializer
+        @targets = targets
+        @since = since
+        @excluded = excluded
+        @complexity_validator = complexity_validator
+        @since_validator = since_validator
+        @options = options
+      end
+
+      def validate!
+        LanguageValidator.validate!(@language)
+        @since_validator.validate!(since: @since, relative_period: nil)
+        @complexity_validator.validate!(@language)
+      end
+
+      def checker
+        Checker.new(
+          language: @language,
+          serializer: triage_serializer,
+          targets: @targets,
+          since: @since,
+          excluded: @excluded,
+        )
+      end
+
+      private
+
+      def triage_serializer
+        case @serializer
+        when :json
+          Serializer::Json
+        end
+      end
+    end
+  end
+end

data/lib/churn_vs_complexity/triage/serializer.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+require 'json'
+
+module ChurnVsComplexity
+  module Triage
+    module Serializer
+      module Json
+        def self.serialize(result)
+          entries = RiskAnnotator.annotate(result[:values_by_file])
+          JSON.generate({ files: entries, summary: RiskAnnotator.risk_summary(entries) })
+        end
+      end
+    end
+  end
+end

data/lib/churn_vs_complexity/triage.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+require_relative 'triage/serializer'
+require_relative 'triage/config'
+require_relative 'triage/checker'
+
+module ChurnVsComplexity
+  module Triage
+  end
+end

data/lib/churn_vs_complexity/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module ChurnVsComplexity
-  VERSION = '1.5.2'
+  VERSION = '1.6.0'
 end

data/lib/churn_vs_complexity.rb

@@ -32,6 +32,14 @@ require_relative 'churn_vs_complexity/git_date'
 require_relative 'churn_vs_complexity/complexity_validator'
 require_relative 'churn_vs_complexity/language_validator'
 require_relative 'churn_vs_complexity/git_strategy'
+require_relative 'churn_vs_complexity/gamma_score'
+require_relative 'churn_vs_complexity/risk_classifier'
+require_relative 'churn_vs_complexity/risk_annotator'
 require_relative 'churn_vs_complexity/normal'
 require_relative 'churn_vs_complexity/timetravel'
 require_relative 'churn_vs_complexity/delta'
+require_relative 'churn_vs_complexity/triage'
+require_relative 'churn_vs_complexity/hotspots'
+require_relative 'churn_vs_complexity/gate'
+require_relative 'churn_vs_complexity/focus'
+require_relative 'churn_vs_complexity/diff'

data/tmp/test-support/delta/ruby-summary.txt

@@ -8,14 +8,16 @@ Type of change:       modified
 Complexity:           58.34326171010786
 
 File, relative path:  lib/churn_vs_complexity/serializer/timetravel/stats_calculator.rb
-Type of change:       deleted
+Type of change:       new
+Complexity:           80.35549194682164
 
 File, relative path:  test/churn_vs_complexity/serializer/timetravel/quality_calculator_test.rb
 Type of change:       modified
 Complexity:           13.054183368177016
 
 File, relative path:  test/churn_vs_complexity/serializer/timetravel/stats_calculator_test.rb
-Type of change:       deleted
+Type of change:       new
+Complexity:           12.2198021565134
 
 
 
@@ -29,7 +31,8 @@ Type of change:       modified
 Complexity:           70.26655854867414
 
 File, relative path:  lib/churn_vs_complexity/serializer/pass_through.rb
-Type of change:       deleted
+Type of change:       new
+Complexity:           19.309088021254183
 
 File, relative path:  lib/churn_vs_complexity/serializer/summary_hash.rb
 Type of change:       modified
@@ -40,11 +43,13 @@ Type of change:       modified
 Complexity:           131.0989019732436
 
 File, relative path:  lib/churn_vs_complexity/serializer/timetravel/quality_calculator.rb
-Type of change:       deleted
+Type of change:       new
+Complexity:           23.324498016752965
 
 File, relative path:  test/churn_vs_complexity/serializer/summary_hash_test.rb
 Type of change:       modified
 Complexity:           14.396336540125482
 
 File, relative path:  test/churn_vs_complexity/serializer/timetravel/quality_calculator_test.rb
-Type of change:       deleted
+Type of change:       new
+Complexity:           13.054183368177016

data/tmp/test-support/delta/ruby.csv

@@ -1,12 +1,12 @@
 Commit, Relative Path, Type of Change, Complexity
 b20a9bddd04afb9c7a736cf4530fd3188b5f785e, lib/churn_vs_complexity/serializer/timetravel.rb, modified, 58.34326171010786
-b20a9bddd04afb9c7a736cf4530fd3188b5f785e, lib/churn_vs_complexity/serializer/timetravel/stats_calculator.rb, deleted, 
+b20a9bddd04afb9c7a736cf4530fd3188b5f785e, lib/churn_vs_complexity/serializer/timetravel/stats_calculator.rb, new, 80.35549194682164
 b20a9bddd04afb9c7a736cf4530fd3188b5f785e, test/churn_vs_complexity/serializer/timetravel/quality_calculator_test.rb, modified, 13.054183368177016
-b20a9bddd04afb9c7a736cf4530fd3188b5f785e, test/churn_vs_complexity/serializer/timetravel/stats_calculator_test.rb, deleted, 
+b20a9bddd04afb9c7a736cf4530fd3188b5f785e, test/churn_vs_complexity/serializer/timetravel/stats_calculator_test.rb, new, 12.2198021565134
 4f3151f83e982eb8f2b8a4e7a7572a0af156c3c0, lib/churn_vs_complexity/config.rb, modified, 70.26655854867414
-4f3151f83e982eb8f2b8a4e7a7572a0af156c3c0, lib/churn_vs_complexity/serializer/pass_through.rb, deleted, 
+4f3151f83e982eb8f2b8a4e7a7572a0af156c3c0, lib/churn_vs_complexity/serializer/pass_through.rb, new, 19.309088021254183
 4f3151f83e982eb8f2b8a4e7a7572a0af156c3c0, lib/churn_vs_complexity/serializer/summary_hash.rb, modified, 89.25682464940157
 4f3151f83e982eb8f2b8a4e7a7572a0af156c3c0, lib/churn_vs_complexity/serializer/timetravel.rb, modified, 131.0989019732436
-4f3151f83e982eb8f2b8a4e7a7572a0af156c3c0, lib/churn_vs_complexity/serializer/timetravel/quality_calculator.rb, deleted, 
+4f3151f83e982eb8f2b8a4e7a7572a0af156c3c0, lib/churn_vs_complexity/serializer/timetravel/quality_calculator.rb, new, 23.324498016752965
 4f3151f83e982eb8f2b8a4e7a7572a0af156c3c0, test/churn_vs_complexity/serializer/summary_hash_test.rb, modified, 14.396336540125482
-4f3151f83e982eb8f2b8a4e7a7572a0af156c3c0, test/churn_vs_complexity/serializer/timetravel/quality_calculator_test.rb, deleted, 
+4f3151f83e982eb8f2b8a4e7a7572a0af156c3c0, test/churn_vs_complexity/serializer/timetravel/quality_calculator_test.rb, new, 13.054183368177016

data/tmp/test-support/go/main.go

@@ -0,0 +1,11 @@
+package main
+
+import "fmt"
+
+func main() {
+	fmt.Println("Hello, world!")
+}
+
+func add(a, b int) int {
+	return a + b
+}

data/tmp/test-support/go/utils.go

@@ -0,0 +1,13 @@
+package main
+
+func calculateSum(numbers []int) int {
+	total := 0
+	for _, n := range numbers {
+		total += n
+	}
+	return total
+}
+
+func isEven(n int) bool {
+	return n%2 == 0
+}

data/tmp/test-support/python/example.py

@@ -0,0 +1,6 @@
+def hello():
+    print("Hello, world!")
+
+
+def add(a, b):
+    return a + b

data/tmp/test-support/python/utils.py

@@ -0,0 +1,9 @@
+def calculate_sum(numbers):
+    total = 0
+    for n in numbers:
+        total += n
+    return total
+
+
+def is_even(n):
+    return n % 2 == 0

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: churn_vs_complexity
 version: !ruby/object:Gem::Version
-  version: 1.5.2
+  version: 1.6.0
 platform: ruby
 authors:
 - Erik T. Madsen
 bindir: bin
 cert_chain: []
-date: 2024-10-21 00:00:00.000000000 Z
+date: 1980-01-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: flog
@@ -52,6 +52,7 @@ files:
 - ".devcontainer/devcontainer.json"
 - ".rubocop.yml"
 - CHANGELOG.md
+- CLAUDE.md
 - Dockerfile
 - Dockerfile.dev
 - LICENSE.txt
@@ -67,9 +68,11 @@ files:
 - lib/churn_vs_complexity/complexity.rb
 - lib/churn_vs_complexity/complexity/eslint_calculator.rb
 - lib/churn_vs_complexity/complexity/flog_calculator.rb
+- lib/churn_vs_complexity/complexity/go_calculator.rb
 - lib/churn_vs_complexity/complexity/pmd.rb
 - lib/churn_vs_complexity/complexity/pmd/files_calculator.rb
 - lib/churn_vs_complexity/complexity/pmd/folder_calculator.rb
+- lib/churn_vs_complexity/complexity/python_calculator.rb
 - lib/churn_vs_complexity/complexity_validator.rb
 - lib/churn_vs_complexity/concurrent_calculator.rb
 - lib/churn_vs_complexity/delta.rb
@@ -80,19 +83,39 @@ files:
 - lib/churn_vs_complexity/delta/factory.rb
 - lib/churn_vs_complexity/delta/multi_checker.rb
 - lib/churn_vs_complexity/delta/serializer.rb
+- lib/churn_vs_complexity/diff.rb
+- lib/churn_vs_complexity/diff/checker.rb
+- lib/churn_vs_complexity/diff/config.rb
+- lib/churn_vs_complexity/diff/serializer.rb
 - lib/churn_vs_complexity/engine.rb
 - lib/churn_vs_complexity/file_selector.rb
+- lib/churn_vs_complexity/focus.rb
+- lib/churn_vs_complexity/focus/checker.rb
+- lib/churn_vs_complexity/focus/config.rb
+- lib/churn_vs_complexity/focus/serializer.rb
+- lib/churn_vs_complexity/gamma_score.rb
+- lib/churn_vs_complexity/gate.rb
+- lib/churn_vs_complexity/gate/checker.rb
+- lib/churn_vs_complexity/gate/config.rb
+- lib/churn_vs_complexity/gate/serializer.rb
 - lib/churn_vs_complexity/git_date.rb
 - lib/churn_vs_complexity/git_strategy.rb
+- lib/churn_vs_complexity/hotspots.rb
+- lib/churn_vs_complexity/hotspots/checker.rb
+- lib/churn_vs_complexity/hotspots/config.rb
+- lib/churn_vs_complexity/hotspots/serializer.rb
 - lib/churn_vs_complexity/language_validator.rb
 - lib/churn_vs_complexity/normal.rb
 - lib/churn_vs_complexity/normal/config.rb
 - lib/churn_vs_complexity/normal/serializer.rb
 - lib/churn_vs_complexity/normal/serializer/csv.rb
 - lib/churn_vs_complexity/normal/serializer/graph.rb
+- lib/churn_vs_complexity/normal/serializer/json.rb
 - lib/churn_vs_complexity/normal/serializer/pass_through.rb
 - lib/churn_vs_complexity/normal/serializer/summary.rb
 - lib/churn_vs_complexity/normal/serializer/summary_hash.rb
+- lib/churn_vs_complexity/risk_annotator.rb
+- lib/churn_vs_complexity/risk_classifier.rb
 - lib/churn_vs_complexity/timetravel.rb
 - lib/churn_vs_complexity/timetravel/config.rb
 - lib/churn_vs_complexity/timetravel/factory.rb
@@ -101,6 +124,10 @@ files:
 - lib/churn_vs_complexity/timetravel/serializer/stats_calculator.rb
 - lib/churn_vs_complexity/timetravel/traveller.rb
 - lib/churn_vs_complexity/timetravel/worktree.rb
+- lib/churn_vs_complexity/triage.rb
+- lib/churn_vs_complexity/triage/checker.rb
+- lib/churn_vs_complexity/triage/config.rb
+- lib/churn_vs_complexity/triage/serializer.rb
 - lib/churn_vs_complexity/version.rb
 - package-lock.json
 - tmp/eslint-support/complexity-calculator.js
@@ -110,12 +137,16 @@ files:
 - tmp/template/timetravel_graph.html
 - tmp/test-support/delta/ruby-summary.txt
 - tmp/test-support/delta/ruby.csv
+- tmp/test-support/go/main.go
+- tmp/test-support/go/utils.go
 - tmp/test-support/java/small-example/src/main/java/org/example/Main.java
 - tmp/test-support/java/small-example/src/main/java/org/example/spice/Checker.java
 - tmp/test-support/javascript/complex.js
 - tmp/test-support/javascript/moderate.js
 - tmp/test-support/javascript/simple.js
 - tmp/test-support/javascript/typescript-example.ts
+- tmp/test-support/python/example.py
+- tmp/test-support/python/utils.py
 - tmp/test-support/txt/abc.txt
 - tmp/test-support/txt/d.txt
 - tmp/test-support/txt/ef.txt
@@ -148,7 +179,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.6.0.dev
+rubygems_version: 3.6.7
 specification_version: 4
 summary: A tool to visualise code complexity in projects and help direct refactoring
   efforts.