hashira 0.1.0 → 0.2.0

data/lib/hashira/hotspots/file_cost.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+module Hashira
+  module Hotspots
+    CHURN_FLOOR = 1
+
+    FileCost = Data.define(:file, :cognitive, :duplication, :churn) do
+      def cost = cognitive + duplication
+
+      def rank = cost * effective_churn
+
+      def effective_churn = [churn, CHURN_FLOOR].max
+
+      def to_h = { file:, cognitive:, duplication:, churn:, cost:, rank: }
+
+      def cells = [file, cognitive, duplication, churn, rank]
+    end
+  end
+end

data/lib/hashira/hotspots/rollup.rb

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+module Hashira
+  module Hotspots
+    class Rollup
+      def initialize(complexity, duplication, churn)
+        @complexity = complexity
+        @duplication = duplication
+        @churn = churn
+      end
+
+      def files = costs.reject { it.cost.zero? }.sort_by { [-it.rank, it.file] }
+
+      private
+
+      def costs = (cognitive.keys | duplicated.keys).map { cost_for(it) }
+
+      def cost_for(file)
+        FileCost.new(file:, cognitive: cognitive[file], duplication: duplicated[file], churn: @churn.hits(file))
+      end
+
+      def scores = @complexity ? @complexity.methods : []
+
+      def clusters = @duplication ? @duplication.clusters : []
+
+      def cognitive = @cognitive ||= per_file(scores.map { [it.file, it.cognitive] })
+
+      def duplicated = @duplicated ||= per_file(clusters.flat_map(&:site_masses))
+
+      def per_file(charges) = charges.each_with_object(Hash.new(0)) { |(file, cost), total| total[file] += cost }
+    end
+  end
+end

data/lib/hashira/pipeline.rb

@@ -4,21 +4,43 @@ require "prism"
 
 module Hashira
   class Pipeline
-    def initialize(project)
+    ANALYZERS = %i[coupling complexity duplication].freeze
+
+    RULES = [Analysis::CycleFindings, Analysis::SdpViolationFindings].freeze
+
+    def initialize(project, enabled: ANALYZERS)
       @project = project
-      trees = project.files.to_h { [_1, parse(_1)] }
-      @census = Analysis::Census.new(project, trees)
-      @graph = Analysis::Graph.new(project, trees, @census)
+      @enabled = enabled
+      @trees = project.files.to_h { [it, parse(it)] }
+      @graph = Analysis::Graph.new(project, @trees, Analysis::Census.new(project, @trees))
     end
 
     attr_reader :project, :graph
 
-    RULES = [Analysis::CycleFindings, Analysis::SdpViolationFindings].freeze
+    def complexity
+      @complexity ||= Complexity::Analyzer.new(@project, @trees) if enabled?(:complexity)
+    end
 
-    def findings = RULES.flat_map { _1.new(@project, @graph).list }
+    def duplication
+      @duplication ||= Duplication::Analyzer.new(@project, @trees, churn) if enabled?(:duplication)
+    end
+
+    def hotspots
+      @hotspots ||= Hotspots::Rollup.new(complexity, duplication, churn) if complexity || duplication
+    end
+
+    def churn = @churn ||= Churn.from_git
+
+    def enabled?(analyzer) = @enabled.include?(analyzer)
+
+    def findings = coupling_findings + listed(complexity) + listed(duplication)
 
     private
 
+    def coupling_findings = enabled?(:coupling) ? RULES.flat_map { it.new(@project, @graph).list } : []
+
+    def listed(analyzer) = analyzer ? analyzer.findings : []
+
     def parse(path)
       Prism.parse_file(path).value
     rescue SystemCallError => error

data/lib/hashira/project.rb

@@ -5,24 +5,27 @@ module Hashira
     ROOT_PACKAGE = "(root)"
 
     def self.detect(directories)
-      return new(directories) unless directories.empty?
+      directories.empty? ? new(default_directories) : new(directories)
+    end
 
-      subdirectories = Dir["lib/*/"].map { File.basename(_1) }
+    def self.default_directories
+      subdirectories = Dir["lib/*/"].map { File.basename(it) }
       raise Error, "no lib/ directory here — pass the source directory explicitly" if subdirectories.empty?
 
-      new(subdirectories.size == 1 ? ["lib/#{subdirectories.first}"] : ["lib"])
+      subdirectories.size == 1 ? ["lib/#{subdirectories.first}"] : ["lib"]
     end
+    private_class_method :default_directories
 
     def initialize(directories)
-      missing = directories.reject { Dir.exist?(_1) }
+      missing = directories.reject { Dir.exist?(it) }
       raise Error, "no such directory: #{missing.join(", ")}" unless missing.empty?
 
-      @directories = directories.map { _1.delete_suffix("/") }
+      @directories = directories.map { it.delete_suffix("/") }
     end
 
     attr_reader :directories
 
-    def files = @directories.flat_map { Dir["#{_1}/**/*.rb"] }.sort
+    def files = @directories.flat_map { Dir["#{it}/**/*.rb"] }.sort
 
     def package_for(path)
       first, rest = relative(path).delete_suffix(".rb").split("/", 2)
@@ -40,7 +43,7 @@ module Hashira
     def folder?(path, name) = Dir.exist?("#{directory_of(path)}/#{name}")
 
     def directory_of(path)
-      @directories.find { path.start_with?("#{_1}/") } ||
+      @directories.find { path.start_with?("#{it}/") } ||
         raise(Error, "#{path} is outside the analyzed directories")
     end
   end

data/lib/hashira/report/complexity_table.rb

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+
+module Hashira
+  module Report
+    class ComplexityTable
+      TOP = 10
+      METHOD_ROW = "%-44s %4s %6s  %s"
+      CLASS_ROW = "%-32s %5s %8s %6s"
+
+      def initialize(complexity, io: $stdout)
+        @complexity = complexity
+        @io = io
+      end
+
+      def print
+        section(@complexity.methods, METHOD_ROW, %w[method Cog Calls Loc],
+                "Cognitive complexity — worst methods (Cog = how hard to read, Calls = message sends)")
+        section(@complexity.classes, CLASS_ROW, %w[class Cog Methods Peak],
+                "Per-class rollup (Cog total survives extract-method; Peak is the worst method it hides)")
+      end
+
+      private
+
+      def section(scores, row_format, columns, title)
+        heading(row_format, columns, title)
+        ranked(scores).each { @io.puts format(row_format, *it.cells) }
+        @io.puts
+      end
+
+      def heading(row_format, columns, title)
+        header = format(row_format, *columns)
+        @io.puts "#{title}:\n\n"
+        @io.puts header
+        @io.puts "-" * header.length
+      end
+
+      def ranked(scores) = scores.select { it.cognitive.positive? }.first(TOP)
+    end
+  end
+end

data/lib/hashira/report/dependency_map.rb

@@ -10,18 +10,21 @@ module Hashira
 
       def print
         @io.puts "Dependencies (DependsUpon(refs) -> | <- UsedBy):"
-        @graph.packages.sort.each { @io.puts row(_1) }
+        @graph.packages.sort.each { @io.puts row(it) }
       end
 
       private
 
       def row(package)
-        depends_upon = @graph.dependencies_of(package).map { "#{_1}(#{@graph.weight(package, _1)})" }.join(", ")
-        used_by = @graph.dependents_of(package).join(", ")
         format("  %-12s -> %-32s <- %s", package,
-               depends_upon.empty? ? "(none)" : depends_upon,
-               used_by.empty? ? "(none)" : used_by)
+               list(depends_upon(package)), list(@graph.dependents_of(package)))
       end
+
+      def depends_upon(package)
+        @graph.dependencies_of(package).map { "#{it}(#{@graph.weight(package, it)})" }
+      end
+
+      def list(items) = items.empty? ? "(none)" : items.join(", ")
     end
   end
 end

data/lib/hashira/report/finding_lines.rb

@@ -13,7 +13,7 @@ module Hashira
 
       def print
         @io.puts "#{@indent}#{@finding.kind}: #{@finding.message}"
-        @finding.evidence.first(SAMPLE).each { @io.puts "#{@indent}    · #{_1}" }
+        @finding.evidence.first(SAMPLE).each { @io.puts "#{@indent}    · #{it}" }
       end
 
       def print_with_overflow

data/lib/hashira/report/graph_payload.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+module Hashira
+  module Report
+    class GraphPayload
+      def initialize(graph)
+        @graph = graph
+      end
+
+      def to_h = { packages:, edges: }
+
+      private
+
+      def packages
+        @graph.metrics.sort_by { |_package, metric| metric.instability }
+                      .to_h do |package, metric|
+          [package,
+           metric.to_h.merge(cyclic: @graph.cyclic?(package))]
+        end
+      end
+
+      def edges
+        @graph.weighted_edges.map do |from, to, weight|
+          { from:, to:, weight:, refs: @graph.evidence_for(from, to).to_a.sort }
+        end
+      end
+    end
+  end
+end

data/lib/hashira/report/hotspot_table.rb

@@ -0,0 +1,41 @@
+# frozen_string_literal: true
+
+module Hashira
+  module Report
+    class HotspotTable
+      TOP = 10
+      ROW = "%-46s %5s %5s %6s %7s"
+
+      def initialize(hotspots, io: $stdout)
+        @hotspots = hotspots
+        @io = io
+      end
+
+      def print
+        return if ranked.empty?
+
+        heading
+        rows
+        legend
+      end
+
+      private
+
+      def ranked = @ranked ||= @hotspots.files.first(TOP)
+
+      def rows = ranked.each { @io.puts format(ROW, *it.cells) }
+
+      def heading
+        @io.puts "Hotspots — cost × churn (where refactoring pays the most):\n\n"
+        header = format(ROW, *%w[file Cog Dup Churn Rank])
+        @io.puts header
+        @io.puts "-" * header.length
+      end
+
+      def legend
+        @io.puts "\nLegend: Cog cognitive complexity, Dup mass of the clones the file carries,"
+        @io.puts "        Churn commits touching it, Rank (Cog+Dup) × Churn\n\n"
+      end
+    end
+  end
+end

data/lib/hashira/report/json.rb

@@ -5,37 +5,44 @@ require "json"
 module Hashira
   module Report
     class Json
-      def initialize(graph, findings, io: $stdout)
-        @graph = graph
-        @findings = findings
+      def initialize(view, io: $stdout)
+        @view = view
         @io = io
       end
 
       def print
-        @io.puts JSON.pretty_generate(packages:, edges:, findings: @findings.all.map(&:to_h),
-                                      accepted: accepted_entries)
+        @io.puts JSON.pretty_generate(payload)
         0
       end
 
       private
 
-      def accepted_entries
-        @findings.accepted.map { |finding, reason| finding.to_h.merge(reason:) }
+      def payload = base.merge(graph_payload).merge(sections.compact)
+
+      def base = { findings: @view.findings.all.map(&:to_h), accepted: accepted_entries }
+
+      def graph_payload
+        graph = @view.graph
+        graph ? GraphPayload.new(graph).to_h : {}
       end
 
-      def packages
-        @graph.metrics.sort_by { |_package, metric| metric.instability }
-                      .to_h do |package, metric|
-          [package,
-           metric.to_h.merge(cyclic: @graph.cyclic?(package))]
-        end
+      def sections
+        { complexity: (complexity_payload if @view.complexity),
+          duplication: (duplication_payload if @view.duplication),
+          hotspots: @view.hotspots&.files&.map(&:to_h) }
       end
 
-      def edges
-        @graph.weighted_edges.map do |from, to, weight|
-          { from:, to:, weight:, refs: @graph.evidence_for(from, to).to_a.sort }
-        end
+      def accepted_entries
+        @view.findings.accepted.map { |finding, reason| finding.to_h.merge(reason:) }
       end
+
+      def complexity_payload = { methods: method_scores, classes: class_scores }
+
+      def method_scores = @view.complexity.methods.map(&:to_h)
+
+      def class_scores = @view.complexity.classes.map(&:to_h)
+
+      def duplication_payload = @view.duplication.clusters.map { Duplication::Delta.new(it).to_h }
     end
   end
 end

data/lib/hashira/report/metrics_table.rb

@@ -25,8 +25,7 @@ module Hashira
 
       def row(package, metric)
         cyclic = @graph.cyclic?(package) ? "YES" : "-"
-        format("%-12s %3d %3d %3d %5.2f  %-3s", package,
-               metric.type_count, metric.afferent, metric.efferent, metric.instability, cyclic)
+        format("%-12s %3d %3d %3d %5.2f  %-3s", package, *metric.to_h.values, cyclic)
       end
 
       def legend

data/lib/hashira/report/text.rb

@@ -3,27 +3,37 @@
 module Hashira
   module Report
     class Text
-      def initialize(project, graph, findings, io: $stdout)
-        @project = project
-        @graph = graph
-        @findings = findings
+      def initialize(view, io: $stdout)
+        @view = view
         @io = io
       end
 
       def print
-        header
-        MetricsTable.new(@graph, io: @io).print
-        DependencyMap.new(@graph, io: @io).print
+        coupling_sections if @view.graph
+        complexity_section if @view.complexity
+        hotspot_section if @view.hotspots
         findings_section
         0
       end
 
       private
 
-      def header
-        packages = @graph.packages.size
-        @io.puts "Package (layer) metrics for #{@project.label}  " \
-                 "(#{packages} packages, #{@project.files.size} files)\n\n"
+      def coupling_sections
+        graph = @view.graph
+        header(graph)
+        MetricsTable.new(graph, io: @io).print
+        DependencyMap.new(graph, io: @io).print
+      end
+
+      def complexity_section = ComplexityTable.new(@view.complexity, io: @io).print
+
+      def hotspot_section = HotspotTable.new(@view.hotspots, io: @io).print
+
+      def header(graph)
+        project = @view.project
+        packages = graph.packages.size
+        @io.puts "Package (layer) metrics for #{project.label}  " \
+                 "(#{packages} packages, #{project.files.size} files)\n\n"
         single_package_note if packages == 1
       end
 
@@ -33,7 +43,7 @@ module Hashira
       end
 
       def findings_section
-        all = @findings.all
+        all = @view.findings.all
         @io.puts "\nFindings (#{all.size}):"
         print_findings(all)
         accepted_section
@@ -43,11 +53,11 @@ module Hashira
       def print_findings(all)
         return @io.puts "  none ✓ — structure is healthy" if all.empty?
 
-        all.each { FindingLines.new(_1, indent: "  ", io: @io).print_with_overflow }
+        all.each { FindingLines.new(it, indent: "  ", io: @io).print_with_overflow }
       end
 
       def accepted_section
-        accepted = @findings.accepted
+        accepted = @view.findings.accepted
         return if accepted.empty?
 
         @io.puts "\nAccepted (#{accepted.size}):"

data/lib/hashira/report/view.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module Hashira
+  module Report
+    View = Data.define(:project, :graph, :complexity, :duplication, :hotspots, :findings)
+  end
+end

data/lib/hashira/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Hashira
-  VERSION = "0.1.0"
+  VERSION = "0.2.0"
 end

data/lib/hashira.rb

@@ -3,6 +3,7 @@
 require_relative "hashira/version"
 require_relative "hashira/error"
 require_relative "hashira/project"
+require_relative "hashira/churn"
 require_relative "hashira/analysis/syntax"
 require_relative "hashira/analysis/node_walk"
 require_relative "hashira/analysis/type_walk"
@@ -20,21 +21,56 @@ require_relative "hashira/analysis/finding"
 require_relative "hashira/analysis/rule"
 require_relative "hashira/analysis/cycle_findings"
 require_relative "hashira/analysis/sdp_violation_findings"
+require_relative "hashira/complexity/method_score"
+require_relative "hashira/complexity/rollup"
+require_relative "hashira/complexity/if_chain"
+require_relative "hashira/complexity/boolean_run"
+require_relative "hashira/complexity/rescue_scan"
+require_relative "hashira/complexity/cognitive_score"
+require_relative "hashira/complexity/method_finding"
+require_relative "hashira/complexity/analyzer"
+require_relative "hashira/duplication/fragment"
+require_relative "hashira/duplication/sequence"
+require_relative "hashira/duplication/extractor"
+require_relative "hashira/duplication/similarity"
+require_relative "hashira/duplication/union_find"
+require_relative "hashira/duplication/cluster"
+require_relative "hashira/duplication/grouping"
+require_relative "hashira/duplication/index"
+require_relative "hashira/duplication/near_miss"
+require_relative "hashira/duplication/maximal"
+require_relative "hashira/duplication/clusterer"
+require_relative "hashira/duplication/variance"
+require_relative "hashira/duplication/delta"
+require_relative "hashira/duplication/duplication_finding"
+require_relative "hashira/duplication/analyzer"
 require_relative "hashira/diagram/dot"
 require_relative "hashira/diagram/mermaid"
 require_relative "hashira/diagram/renderer"
 require_relative "hashira/ci/accepted"
+require_relative "hashira/ci/baseline"
+require_relative "hashira/ci/diff"
+require_relative "hashira/ci/improvement"
 require_relative "hashira/ci/edge_diff_report"
+require_relative "hashira/ci/finding_diff_report"
+require_relative "hashira/ci/ratchet_report"
 require_relative "hashira/ci/gate"
 require_relative "hashira/ci/ratchet"
+require_relative "hashira/hotspots/file_cost"
+require_relative "hashira/hotspots/rollup"
+require_relative "hashira/report/view"
+require_relative "hashira/report/graph_payload"
 require_relative "hashira/report/finding_lines"
 require_relative "hashira/report/dependency_map"
 require_relative "hashira/report/metrics_table"
+require_relative "hashira/report/complexity_table"
+require_relative "hashira/report/hotspot_table"
 require_relative "hashira/report/json"
 require_relative "hashira/report/text"
 require_relative "hashira/pipeline"
 require_relative "hashira/cli"
 require_relative "hashira/cli/fail_on"
+require_relative "hashira/cli/skip"
 require_relative "hashira/cli/options"
 require_relative "hashira/cli/command_line"
 require_relative "hashira/cli/usage"

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: hashira
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Giacomo GK
@@ -9,9 +9,11 @@ bindir: exe
 cert_chain: []
 date: 1980-01-02 00:00:00.000000000 Z
 dependencies: []
-description: Measures package coupling in a Ruby codebase (Ca/Ce/instability, SDP
-  violations, cycles) from the AST, with findings backed by file-level evidence and
-  an edge-set ratchet for CI.
+description: Measures package coupling (Ca/Ce/instability, SDP violations, cycles),
+  per-method cognitive complexity, and near-miss code duplication in a Ruby codebase
+  from the AST, then ranks files by cost against git churn. Findings are backed by
+  file-level evidence, and a baseline ratchets edges and findings for CI — direction,
+  not a score.
 email:
 - giaco@hey.com
 executables:
@@ -41,27 +43,63 @@ files:
 - lib/hashira/analysis/sdp_violation_findings.rb
 - lib/hashira/analysis/syntax.rb
 - lib/hashira/analysis/type_walk.rb
+- lib/hashira/churn.rb
 - lib/hashira/ci/accepted.rb
+- lib/hashira/ci/baseline.rb
+- lib/hashira/ci/diff.rb
 - lib/hashira/ci/edge_diff_report.rb
+- lib/hashira/ci/finding_diff_report.rb
 - lib/hashira/ci/gate.rb
+- lib/hashira/ci/improvement.rb
 - lib/hashira/ci/ratchet.rb
+- lib/hashira/ci/ratchet_report.rb
 - lib/hashira/cli.rb
 - lib/hashira/cli/command_line.rb
 - lib/hashira/cli/fail_on.rb
 - lib/hashira/cli/options.rb
 - lib/hashira/cli/run.rb
+- lib/hashira/cli/skip.rb
 - lib/hashira/cli/usage.rb
+- lib/hashira/complexity/analyzer.rb
+- lib/hashira/complexity/boolean_run.rb
+- lib/hashira/complexity/cognitive_score.rb
+- lib/hashira/complexity/if_chain.rb
+- lib/hashira/complexity/method_finding.rb
+- lib/hashira/complexity/method_score.rb
+- lib/hashira/complexity/rescue_scan.rb
+- lib/hashira/complexity/rollup.rb
 - lib/hashira/diagram/dot.rb
 - lib/hashira/diagram/mermaid.rb
 - lib/hashira/diagram/renderer.rb
+- lib/hashira/duplication/analyzer.rb
+- lib/hashira/duplication/cluster.rb
+- lib/hashira/duplication/clusterer.rb
+- lib/hashira/duplication/delta.rb
+- lib/hashira/duplication/duplication_finding.rb
+- lib/hashira/duplication/extractor.rb
+- lib/hashira/duplication/fragment.rb
+- lib/hashira/duplication/grouping.rb
+- lib/hashira/duplication/index.rb
+- lib/hashira/duplication/maximal.rb
+- lib/hashira/duplication/near_miss.rb
+- lib/hashira/duplication/sequence.rb
+- lib/hashira/duplication/similarity.rb
+- lib/hashira/duplication/union_find.rb
+- lib/hashira/duplication/variance.rb
 - lib/hashira/error.rb
+- lib/hashira/hotspots/file_cost.rb
+- lib/hashira/hotspots/rollup.rb
 - lib/hashira/pipeline.rb
 - lib/hashira/project.rb
+- lib/hashira/report/complexity_table.rb
 - lib/hashira/report/dependency_map.rb
 - lib/hashira/report/finding_lines.rb
+- lib/hashira/report/graph_payload.rb
+- lib/hashira/report/hotspot_table.rb
 - lib/hashira/report/json.rb
 - lib/hashira/report/metrics_table.rb
 - lib/hashira/report/text.rb
+- lib/hashira/report/view.rb
 - lib/hashira/version.rb
 homepage: https://github.com/giacope/hashira
 licenses:
@@ -85,7 +123,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 4.0.10
+rubygems_version: 4.0.17
 specification_version: 4
-summary: Package coupling metrics for Ruby, via Prism
+summary: Coupling, cognitive-complexity, and duplication metrics for Ruby, via Prism
 test_files: []