hashira 0.6.0 → 0.7.0

data/lib/hashira/report/metrics_table.rb

@@ -1,47 +1,46 @@
 # frozen_string_literal: true
 
 class Hashira::Report::MetricsTable
-  def initialize(graph, io: $stdout)
+  TOP = 25
+
+  def initialize(graph, top: TOP, io: $stdout)
     @graph = graph
+    @top = top
     @io = io
   end
 
-  LIMIT = 25
+  HEADERS = %w[package TC Ca Ce I Cyc].freeze
 
   def print
-    heading
-    kept.each { |package, metric| @io.puts(row(package, metric)) }
+    Hashira::Report::Columns.new(HEADERS, kept.map { |package, metric| row(package, metric) }, io: @io).print
     note unless spared.empty?
+    more unless over.zero?
     legend
   end
 
   private
 
-  def ranked = @graph.metrics.sort_by { |_package, metric| metric.instability }
+  def ranked = @graph.metrics.sort_by { |_package, metric| metric.order }
 
-  def split = @split ||= (ranked.size > LIMIT ? ranked.partition { |_package, metric| !leaf?(metric) } : [ranked, []])
+  def split = @split ||= (ranked.size > @top ? ranked.partition { |_package, metric| !leaf?(metric) } : [ranked, []])
 
-  def kept = split.first
+  def kept = split.first.first(@top)
 
   def spared = split.last
 
+  def over = split.first.size - kept.size
+
   def leaf?(metric) = metric.types <= 1 && metric.efferent.zero? && metric.afferent <= 1
 
-  def note
-    @io.puts("  + #{spared.size} single-type leaf packages (TC ≤ 1, Ca ≤ 1, Ce = 0) — hidden for brevity")
-  end
+  def note = @io.puts("  + #{leaves} (TC ≤ 1, Ca ≤ 1, Ce = 0) — hidden for brevity")
 
-  def heading
-    @io.puts(format("%-12s %3s %3s %3s %5s  %-3s", *%w[package TC Ca Ce I Cyc]))
-    @io.puts("-" * 40)
-  end
+  def leaves = Hashira::Report::Phrases.count(spared.size, "single-type leaf package")
 
-  def row(package, metric)
-    format(
-      "%-12s %3d %3d %3d %5.2f  %-3s", package, *metric.to_h.values,
-      (@graph.cycles.through?(package) ? "YES" : "-")
-    )
-  end
+  def more = @io.puts("  … and #{over} more — raise the cap with --top, or read them all with --json")
+
+  def row(package, metric) = [package, *metric.cells, cyc(package)]
+
+  def cyc(package) = @graph.cycles.through?(package) ? "YES" : "-"
 
   def legend
     @io.puts("\nLegend: TC total types, Ca afferent (incoming), Ce efferent (outgoing),")

data/lib/hashira/report/notices.rb

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+class Hashira::Report::Notices
+  ISSUES = "https://github.com/giacope/hashira/issues"
+
+  def initialize(io: $stderr)
+    @io = io
+  end
+
+  def scanning(files) = interactive { @io.puts("hashira: reading #{files} files…") }
+
+  def finished(files, seconds) = interactive { @io.puts("hashira: #{files} files in #{seconds}s") }
+
+  def rails
+    @io.puts("hashira: this looks like a Rails root — `hashira app` reads the application, not just lib/")
+  end
+
+  def churn(label)
+    @io.puts("hashira: no git history for #{label} — hotspots are ranked by cost alone")
+  end
+
+  def crashed(error)
+    @io.puts("hashira: internal error — #{error.class}: #{error.message}")
+    @io.puts("  at #{error.backtrace.first}")
+    @io.puts("  this is a bug in hashira — please report it at #{ISSUES}")
+  end
+
+  def unparsed(count, sample)
+    @io.puts("hashira: #{count} of the files did not parse — #{sample}")
+  end
+
+  private
+
+  def interactive
+    yield if @io.tty?
+  end
+end

data/lib/hashira/report/phrases.rb

@@ -81,6 +81,8 @@ module Hashira::Report::Phrases
 
   def score(value) = format("%.2f", value)
 
+  def count(number, noun) = "#{number} #{number == 1 ? noun : "#{noun}s"}"
+
   def clause(part) = "#{part[:users].join(", ")} #{verb(part)} #{part[:constants].join(", ")}"
 
   def verb(part)

data/lib/hashira/report/text.rb

@@ -1,6 +1,8 @@
 # frozen_string_literal: true
 
 class Hashira::Report::Text
+  FINDINGS = 25
+
   def initialize(view, io: $stdout)
     @view = view
     @io = io
@@ -19,31 +21,37 @@ class Hashira::Report::Text
   def coupling
     graph = @view.graph
     header(graph)
-    Hashira::Report::MetricsTable.new(graph, io: @io).print
+    table(Hashira::Report::MetricsTable, graph)
     Hashira::Report::DependencyMap.new(graph, io: @io).print
     folded(graph.folds)
   end
 
   def folded(folds)
     return if folds.empty?
-    @io.puts("\nFolded (single-type classes joined to their base or domain):")
+    @io.puts("Folded (single-type classes joined to their base or domain):")
     folds.each { @io.puts("  #{it[:from]} -> #{it[:to]} (#{it[:via]})") }
+    @io.puts
   end
 
-  def complexity = Hashira::Report::ComplexityTable.new(@view.complexity, io: @io).print
+  def table(kind, subject) = kind.new(subject, top: @view.top || kind::TOP, io: @io).print
+
+  def complexity = table(Hashira::Report::ComplexityTable, @view.complexity)
 
-  def hotspots = Hashira::Report::HotspotTable.new(@view.hotspots, io: @io).print
+  def hotspots = table(Hashira::Report::HotspotTable, @view.hotspots)
 
   def header(graph)
     packages = graph.packages.size
-    @io.puts(banner(packages))
+    @io.puts(banner(graph.packaging, packages))
     caveat if packages == 1
   end
 
-  def banner(packages)
-    "Package (layer) metrics for #{@view.project.label}  (#{packages} packages, #{total} files)\n\n"
+  def banner(grouping, packages)
+    "Package (#{grouping}) metrics for #{@view.project.label}  " \
+      "(#{count(packages, "package")}, #{count(total, "file")})\n\n"
   end
 
+  def count(number, noun) = Hashira::Report::Phrases.count(number, noun)
+
   def total = @view.project.files.size
 
   def caveat
@@ -55,7 +63,7 @@ class Hashira::Report::Text
 
   def findings
     all = @view.findings.all
-    @io.puts("\nFindings (#{all.size}):")
+    @io.puts("Findings (#{all.size}):")
     list(all)
     accepted
     @io.puts("\n  Full evidence + machine format: hashira --json") unless all.empty?
@@ -63,7 +71,14 @@ class Hashira::Report::Text
 
   def list(all)
     return @io.puts("  none ✓ — structure is healthy") if all.empty?
-    all.each { Hashira::Report::FindingLines.new(it, indent: "  ", io: @io).emit }
+    shown = all.first(@view.top || FINDINGS)
+    shown.each { Hashira::Report::FindingLines.new(it, indent: "  ", io: @io).emit }
+    elided(all.size - shown.size)
+  end
+
+  def elided(rest)
+    return if rest.zero?
+    @io.puts("  … and #{rest} more — raise the cap with --top, or read them all with --json")
   end
 
   def accepted

data/lib/hashira/report/view.rb

@@ -2,6 +2,9 @@
 
 module Hashira
   module Report
-    View = Data.define(:project, :graph, :complexity, :duplication, :hotspots, :findings)
+    View =
+      Data.define(:project, :graph, :complexity, :duplication, :hotspots, :findings, :top, :compact) do
+        def initialize(top: nil, compact: nil, **) = super
+      end
   end
 end

data/lib/hashira/trees.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+require "prism"
+
+class Hashira::Trees
+  def initialize(project)
+    @unparsed = []
+    @all = project.files.to_h { [it, parse(it)] }
+  end
+
+  attr_reader :all, :unparsed
+
+  private
+
+  def parse(path)
+    result = Prism.parse_file(path)
+    @unparsed << path if result.failure?
+    result.value
+  rescue SystemCallError => error
+    raise(Hashira::Error, "cannot read #{path} (#{error.message})")
+  end
+end

data/lib/hashira/version.rb

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

data/lib/hashira.rb

@@ -43,6 +43,8 @@ require_relative "hashira/ci/gate"
 require_relative "hashira/ci/improvement"
 require_relative "hashira/ci/ratchet"
 require_relative "hashira/ci/ratchet_report"
+require_relative "hashira/ci/scope"
+require_relative "hashira/ci/status"
 require_relative "hashira/cli"
 require_relative "hashira/cli/arguments"
 require_relative "hashira/cli/command_line"
@@ -50,6 +52,7 @@ require_relative "hashira/cli/fail_on"
 require_relative "hashira/cli/flag"
 require_relative "hashira/cli/flags"
 require_relative "hashira/cli/format"
+require_relative "hashira/cli/needs"
 require_relative "hashira/cli/options"
 require_relative "hashira/cli/package_by"
 require_relative "hashira/cli/run"
@@ -118,6 +121,7 @@ require_relative "hashira/hotspots/file_cost"
 require_relative "hashira/hotspots/rollup"
 require_relative "hashira/pipeline"
 require_relative "hashira/project"
+require_relative "hashira/report/columns"
 require_relative "hashira/report/complexity_table"
 require_relative "hashira/report/dependency_map"
 require_relative "hashira/report/finding_lines"
@@ -125,6 +129,7 @@ require_relative "hashira/report/graph_payload"
 require_relative "hashira/report/hotspot_table"
 require_relative "hashira/report/json"
 require_relative "hashira/report/metrics_table"
+require_relative "hashira/report/notices"
 require_relative "hashira/report/phrases"
 require_relative "hashira/report/smell_phrases"
 require_relative "hashira/report/text"
@@ -149,4 +154,5 @@ require_relative "hashira/smells/scope"
 require_relative "hashira/smells/too_many_instance_variables"
 require_relative "hashira/smells/utility_function"
 require_relative "hashira/smells/visibility"
+require_relative "hashira/trees"
 require_relative "hashira/version"

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: hashira
 version: !ruby/object:Gem::Version
-  version: 0.6.0
+  version: 0.7.0
 platform: ruby
 authors:
 - Giacomo GK
@@ -40,6 +40,8 @@ files:
 - lib/hashira/ci/improvement.rb
 - lib/hashira/ci/ratchet.rb
 - lib/hashira/ci/ratchet_report.rb
+- lib/hashira/ci/scope.rb
+- lib/hashira/ci/status.rb
 - lib/hashira/cli.rb
 - lib/hashira/cli/arguments.rb
 - lib/hashira/cli/command_line.rb
@@ -47,10 +49,12 @@ files:
 - lib/hashira/cli/flag.rb
 - lib/hashira/cli/flags.rb
 - lib/hashira/cli/format.rb
+- lib/hashira/cli/needs.rb
 - lib/hashira/cli/options.rb
 - lib/hashira/cli/package_by.rb
 - lib/hashira/cli/run.rb
 - lib/hashira/cli/skip.rb
+- lib/hashira/cli/top.rb
 - lib/hashira/cli/usage.rb
 - lib/hashira/complexity/boolean_run.rb
 - lib/hashira/complexity/cognitive_score.rb
@@ -115,6 +119,7 @@ files:
 - lib/hashira/hotspots/rollup.rb
 - lib/hashira/pipeline.rb
 - lib/hashira/project.rb
+- lib/hashira/report/columns.rb
 - lib/hashira/report/complexity_table.rb
 - lib/hashira/report/dependency_map.rb
 - lib/hashira/report/finding_lines.rb
@@ -122,6 +127,7 @@ files:
 - lib/hashira/report/hotspot_table.rb
 - lib/hashira/report/json.rb
 - lib/hashira/report/metrics_table.rb
+- lib/hashira/report/notices.rb
 - lib/hashira/report/phrases.rb
 - lib/hashira/report/smell_phrases.rb
 - lib/hashira/report/text.rb
@@ -149,6 +155,7 @@ files:
 - lib/hashira/smells/too_many_instance_variables.rb
 - lib/hashira/smells/utility_function.rb
 - lib/hashira/smells/visibility.rb
+- lib/hashira/trees.rb
 - lib/hashira/version.rb
 homepage: https://github.com/giacope/hashira
 licenses: