hashira 0.4.0 → 0.5.0

data/lib/hashira.rb

@@ -7,6 +7,9 @@ module Hashira
   module CI
   end
 
+  module Coupling
+  end
+
   module Complexity
   end
 
@@ -21,35 +24,13 @@ module Hashira
 
   module Report
   end
+
+  module Smells
+  end
 end
 
-require_relative "hashira/analysis/catalog"
-require_relative "hashira/analysis/census"
-require_relative "hashira/analysis/constant_registry"
-require_relative "hashira/analysis/cycle_findings"
-require_relative "hashira/analysis/cycle_search"
-require_relative "hashira/analysis/cycles"
-require_relative "hashira/analysis/definition"
-require_relative "hashira/analysis/definitions"
-require_relative "hashira/analysis/edge"
-require_relative "hashira/analysis/edge_map"
 require_relative "hashira/analysis/finding"
-require_relative "hashira/analysis/folder_placement"
-require_relative "hashira/analysis/folding"
-require_relative "hashira/analysis/graph"
-require_relative "hashira/analysis/metric"
-require_relative "hashira/analysis/namespace_placement"
-require_relative "hashira/analysis/namespace_prefix"
-require_relative "hashira/analysis/naming"
-require_relative "hashira/analysis/no_folding"
 require_relative "hashira/analysis/node_walk"
-require_relative "hashira/analysis/placement"
-require_relative "hashira/analysis/references"
-require_relative "hashira/analysis/resolver"
-require_relative "hashira/analysis/roster"
-require_relative "hashira/analysis/rule"
-require_relative "hashira/analysis/sdp_check"
-require_relative "hashira/analysis/sdp_violation_findings"
 require_relative "hashira/analysis/syntax"
 require_relative "hashira/analysis/type_walk"
 require_relative "hashira/churn"
@@ -71,7 +52,6 @@ require_relative "hashira/cli/package_by"
 require_relative "hashira/cli/run"
 require_relative "hashira/cli/skip"
 require_relative "hashira/cli/usage"
-require_relative "hashira/complexity/analyzer"
 require_relative "hashira/complexity/boolean_run"
 require_relative "hashira/complexity/cognitive_score"
 require_relative "hashira/complexity/if_chain"
@@ -79,17 +59,50 @@ require_relative "hashira/complexity/method_finding"
 require_relative "hashira/complexity/method_score"
 require_relative "hashira/complexity/rescue_scan"
 require_relative "hashira/complexity/rollup"
+require_relative "hashira/complexity/scores"
+require_relative "hashira/coupling/audiences"
+require_relative "hashira/coupling/catalog"
+require_relative "hashira/coupling/census"
+require_relative "hashira/coupling/constant_registry"
+require_relative "hashira/coupling/cycle_findings"
+require_relative "hashira/coupling/cycle_search"
+require_relative "hashira/coupling/cycles"
+require_relative "hashira/coupling/definition"
+require_relative "hashira/coupling/definitions"
+require_relative "hashira/coupling/edge"
+require_relative "hashira/coupling/edge_map"
+require_relative "hashira/coupling/folder_placement"
+require_relative "hashira/coupling/folding"
+require_relative "hashira/coupling/graph"
+require_relative "hashira/coupling/metric"
+require_relative "hashira/coupling/mixed_audience_findings"
+require_relative "hashira/coupling/namespace_placement"
+require_relative "hashira/coupling/namespace_prefix"
+require_relative "hashira/coupling/naming"
+require_relative "hashira/coupling/no_folding"
+require_relative "hashira/coupling/placement"
+require_relative "hashira/coupling/references"
+require_relative "hashira/coupling/report"
+require_relative "hashira/coupling/roll_call"
+require_relative "hashira/coupling/roll_call_findings"
+require_relative "hashira/coupling/roster"
+require_relative "hashira/coupling/rule"
+require_relative "hashira/coupling/scope"
+require_relative "hashira/coupling/sdp_check"
+require_relative "hashira/coupling/sdp_violation_findings"
+require_relative "hashira/coupling/wide_edge_findings"
+require_relative "hashira/coupling/words"
 require_relative "hashira/diagram/dot"
 require_relative "hashira/diagram/mermaid"
-require_relative "hashira/diagram/renderer"
-require_relative "hashira/duplication/analyzer"
+require_relative "hashira/diagram/source"
+require_relative "hashira/duplication/clones"
 require_relative "hashira/duplication/cluster"
-require_relative "hashira/duplication/clusterer"
+require_relative "hashira/duplication/clusters"
 require_relative "hashira/duplication/delta"
 require_relative "hashira/duplication/duplication_finding"
-require_relative "hashira/duplication/extractor"
 require_relative "hashira/duplication/fragment"
 require_relative "hashira/duplication/grouping"
+require_relative "hashira/duplication/harvest"
 require_relative "hashira/duplication/index"
 require_relative "hashira/duplication/maximal"
 require_relative "hashira/duplication/near_miss"
@@ -109,6 +122,28 @@ 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/phrases"
+require_relative "hashira/report/smell_phrases"
 require_relative "hashira/report/text"
 require_relative "hashira/report/view"
+require_relative "hashira/smells/census"
+require_relative "hashira/smells/check"
+require_relative "hashira/smells/conditions"
+require_relative "hashira/smells/contexts"
+require_relative "hashira/smells/control_parameter"
+require_relative "hashira/smells/data_clump"
+require_relative "hashira/smells/duplicate_method_call"
+require_relative "hashira/smells/feature_envy"
+require_relative "hashira/smells/instance_variable_assumption"
+require_relative "hashira/smells/manual_dispatch"
+require_relative "hashira/smells/module_initialize"
+require_relative "hashira/smells/nil_check"
+require_relative "hashira/smells/param_check"
+require_relative "hashira/smells/refs"
+require_relative "hashira/smells/repeated_conditional"
+require_relative "hashira/smells/report"
+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/version"

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: hashira
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 0.5.0
 platform: ruby
 authors:
 - Giacomo GK
@@ -26,33 +26,8 @@ files:
 - README.md
 - exe/hashira
 - lib/hashira.rb
-- lib/hashira/analysis/catalog.rb
-- lib/hashira/analysis/census.rb
-- lib/hashira/analysis/constant_registry.rb
-- lib/hashira/analysis/cycle_findings.rb
-- lib/hashira/analysis/cycle_search.rb
-- lib/hashira/analysis/cycles.rb
-- lib/hashira/analysis/definition.rb
-- lib/hashira/analysis/definitions.rb
-- lib/hashira/analysis/edge.rb
-- lib/hashira/analysis/edge_map.rb
 - lib/hashira/analysis/finding.rb
-- lib/hashira/analysis/folder_placement.rb
-- lib/hashira/analysis/folding.rb
-- lib/hashira/analysis/graph.rb
-- lib/hashira/analysis/metric.rb
-- lib/hashira/analysis/namespace_placement.rb
-- lib/hashira/analysis/namespace_prefix.rb
-- lib/hashira/analysis/naming.rb
-- lib/hashira/analysis/no_folding.rb
 - lib/hashira/analysis/node_walk.rb
-- lib/hashira/analysis/placement.rb
-- lib/hashira/analysis/references.rb
-- lib/hashira/analysis/resolver.rb
-- lib/hashira/analysis/roster.rb
-- lib/hashira/analysis/rule.rb
-- lib/hashira/analysis/sdp_check.rb
-- lib/hashira/analysis/sdp_violation_findings.rb
 - lib/hashira/analysis/syntax.rb
 - lib/hashira/analysis/type_walk.rb
 - lib/hashira/churn.rb
@@ -74,7 +49,6 @@ files:
 - 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
@@ -82,17 +56,50 @@ files:
 - lib/hashira/complexity/method_score.rb
 - lib/hashira/complexity/rescue_scan.rb
 - lib/hashira/complexity/rollup.rb
+- lib/hashira/complexity/scores.rb
+- lib/hashira/coupling/audiences.rb
+- lib/hashira/coupling/catalog.rb
+- lib/hashira/coupling/census.rb
+- lib/hashira/coupling/constant_registry.rb
+- lib/hashira/coupling/cycle_findings.rb
+- lib/hashira/coupling/cycle_search.rb
+- lib/hashira/coupling/cycles.rb
+- lib/hashira/coupling/definition.rb
+- lib/hashira/coupling/definitions.rb
+- lib/hashira/coupling/edge.rb
+- lib/hashira/coupling/edge_map.rb
+- lib/hashira/coupling/folder_placement.rb
+- lib/hashira/coupling/folding.rb
+- lib/hashira/coupling/graph.rb
+- lib/hashira/coupling/metric.rb
+- lib/hashira/coupling/mixed_audience_findings.rb
+- lib/hashira/coupling/namespace_placement.rb
+- lib/hashira/coupling/namespace_prefix.rb
+- lib/hashira/coupling/naming.rb
+- lib/hashira/coupling/no_folding.rb
+- lib/hashira/coupling/placement.rb
+- lib/hashira/coupling/references.rb
+- lib/hashira/coupling/report.rb
+- lib/hashira/coupling/roll_call.rb
+- lib/hashira/coupling/roll_call_findings.rb
+- lib/hashira/coupling/roster.rb
+- lib/hashira/coupling/rule.rb
+- lib/hashira/coupling/scope.rb
+- lib/hashira/coupling/sdp_check.rb
+- lib/hashira/coupling/sdp_violation_findings.rb
+- lib/hashira/coupling/wide_edge_findings.rb
+- lib/hashira/coupling/words.rb
 - lib/hashira/diagram/dot.rb
 - lib/hashira/diagram/mermaid.rb
-- lib/hashira/diagram/renderer.rb
-- lib/hashira/duplication/analyzer.rb
+- lib/hashira/diagram/source.rb
+- lib/hashira/duplication/clones.rb
 - lib/hashira/duplication/cluster.rb
-- lib/hashira/duplication/clusterer.rb
+- lib/hashira/duplication/clusters.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/harvest.rb
 - lib/hashira/duplication/index.rb
 - lib/hashira/duplication/maximal.rb
 - lib/hashira/duplication/near_miss.rb
@@ -112,8 +119,30 @@ files:
 - lib/hashira/report/hotspot_table.rb
 - lib/hashira/report/json.rb
 - lib/hashira/report/metrics_table.rb
+- lib/hashira/report/phrases.rb
+- lib/hashira/report/smell_phrases.rb
 - lib/hashira/report/text.rb
 - lib/hashira/report/view.rb
+- lib/hashira/smells/census.rb
+- lib/hashira/smells/check.rb
+- lib/hashira/smells/conditions.rb
+- lib/hashira/smells/contexts.rb
+- lib/hashira/smells/control_parameter.rb
+- lib/hashira/smells/data_clump.rb
+- lib/hashira/smells/duplicate_method_call.rb
+- lib/hashira/smells/feature_envy.rb
+- lib/hashira/smells/instance_variable_assumption.rb
+- lib/hashira/smells/manual_dispatch.rb
+- lib/hashira/smells/module_initialize.rb
+- lib/hashira/smells/nil_check.rb
+- lib/hashira/smells/param_check.rb
+- lib/hashira/smells/refs.rb
+- lib/hashira/smells/repeated_conditional.rb
+- lib/hashira/smells/report.rb
+- lib/hashira/smells/scope.rb
+- lib/hashira/smells/too_many_instance_variables.rb
+- lib/hashira/smells/utility_function.rb
+- lib/hashira/smells/visibility.rb
 - lib/hashira/version.rb
 homepage: https://github.com/giacope/hashira
 licenses:

data/lib/hashira/analysis/cycle_findings.rb

@@ -1,38 +0,0 @@
-# frozen_string_literal: true
-
-require_relative "rule"
-
-class Hashira::Analysis::CycleFindings < Hashira::Analysis::Rule
-  KIND = "cycle"
-
-  def list
-    loops.map { entry(it) }
-  end
-
-  private
-
-  def loops
-    cycles = graph.cycles
-    graph.packages.select { cycles.through?(it) }.sort.map { cycles.path(it) }.uniq { it[..-2].sort }
-  end
-
-  def entry(path)
-    package = path.first
-    finding(
-      package:, cycle: path, evidence: evidence(path),
-      message: message(package, path, graph.cycles.weakest(path))
-    )
-  end
-
-  def message(package, path, weak_edge)
-    from, to = weak_edge
-    weight = graph.weight(from, to)
-    "#{package} can reach itself: #{path.join(" -> ")} — any change may ripple back " \
-      "around. The lightest edge on this cycle is #{from} -> #{to} " \
-      "(#{weight} ref#{"s" unless weight == 1})."
-  end
-
-  def evidence(path)
-    path.each_cons(2).flat_map { |from, to| graph.evidence(from, to).to_a.first(2) }
-  end
-end

data/lib/hashira/analysis/references.rb

@@ -1,40 +0,0 @@
-# frozen_string_literal: true
-
-require "prism"
-
-module Hashira
-  module Analysis
-    module References
-      module_function
-
-      def list(tree)
-        sightings(tree).map(&:first)
-      end
-
-      def sightings(tree, roots = nil)
-        [].tap { collect(tree, [], it, roots) }
-      end
-
-      def collect(node, nesting, accumulator, roots, home = nesting)
-        return unless node
-        return accumulator << sighting(node, nesting, home) if constant?(node)
-        return enter(node, nesting, accumulator, roots) if definition?(node)
-        node.compact_child_nodes.each { collect(it, nesting, accumulator, roots, home) }
-      end
-
-      def sighting(node, nesting, home)
-        [Syntax.segments(node), node.location.start_line, Syntax.cbase?(node) ? nil : nesting, home]
-      end
-
-      def constant?(node) = node.is_a?(Prism::ConstantPathNode) || node.is_a?(Prism::ConstantReadNode)
-
-      def definition?(node) = node.is_a?(Prism::ClassNode) || node.is_a?(Prism::ModuleNode)
-
-      def enter(node, nesting, accumulator, roots)
-        opened = nesting + [Syntax.anchor(nesting, Syntax.segments(node.constant_path), roots)]
-        collect(node.superclass, nesting, accumulator, roots, opened) if node.is_a?(Prism::ClassNode)
-        collect(node.body, opened, accumulator, roots)
-      end
-    end
-  end
-end

data/lib/hashira/analysis/sdp_violation_findings.rb

@@ -1,29 +0,0 @@
-# frozen_string_literal: true
-
-require_relative "rule"
-
-class Hashira::Analysis::SdpViolationFindings < Hashira::Analysis::Rule
-  KIND = "sdp_violation"
-
-  def list
-    ranked.map { |from, to| violation(from, to) }
-  end
-
-  private
-
-  def ranked = graph.violations.sort_by { |from, to| instability(from) - instability(to) }
-
-  def violation(from, to)
-    finding(package: from, evidence: graph.evidence(from, to).to_a.first(5), message: message(from, to))
-  end
-
-  def message(from, to)
-    "#{from} (I=#{label(from)}) depends on the LESS stable #{to} " \
-      "(I=#{label(to)}) — churn in #{to} will force churn in #{from}. " \
-      "Invert the edge or extract the stable part of #{to} that #{from} needs."
-  end
-
-  def instability(package) = metrics[package].instability
-
-  def label(package) = format("%.2f", instability(package))
-end