packwerk 1.1.0 → 1.3.0

data/lib/packwerk/node_processor_factory.rb

@@ -1,15 +1,11 @@
 # typed: strict
 # frozen_string_literal: true
 
-require "packwerk/constant_name_inspector"
-require "packwerk/checker"
-
 module Packwerk
   class NodeProcessorFactory < T::Struct
     extend T::Sig
 
     const :root_path, String
-    const :reference_lister, ReferenceLister
     const :context_provider, Packwerk::ConstantDiscovery
     const :constant_name_inspectors, T::Array[ConstantNameInspector]
     const :checkers, T::Array[Checker]
@@ -18,7 +14,6 @@ module Packwerk
     def for(filename:, node:)
       ::Packwerk::NodeProcessor.new(
         reference_extractor: reference_extractor(node: node),
-        reference_lister: reference_lister,
         filename: filename,
         checkers: checkers,
       )

data/lib/packwerk/node_visitor.rb

@@ -1,8 +1,6 @@
 # typed: false
 # frozen_string_literal: true
 
-require "packwerk/node"
-
 module Packwerk
   class NodeVisitor
     def initialize(node_processor:)
@@ -10,8 +8,7 @@ module Packwerk
     end
 
     def visit(node, ancestors:, result:)
-      offense = @node_processor.call(node, ancestors: ancestors)
-      result << offense if offense
+      result.concat(@node_processor.call(node, ancestors))
 
       child_ancestors = [node] + ancestors
       Node.each_child(node) do |child|

data/lib/packwerk/offense.rb

@@ -2,9 +2,6 @@
 # frozen_string_literal: true
 
 require "parser/source/map"
-require "sorbet-runtime"
-
-require "packwerk/output_styles"
 
 module Packwerk
   class Offense
@@ -23,11 +20,8 @@ module Packwerk
       @message = message
     end
 
-    sig do
-      params(style: T.any(T.class_of(OutputStyles::Plain), T.class_of(OutputStyles::Coloured)))
-        .returns(String)
-    end
-    def to_s(style = OutputStyles::Plain)
+    sig { params(style: OutputStyle).returns(String) }
+    def to_s(style = OutputStyles::Plain.new)
       if location
         <<~EOS
           #{style.filename}#{file}#{style.reset}:#{location.line}:#{location.column}

data/lib/packwerk/offense_collection.rb

@@ -0,0 +1,84 @@
+# typed: strict
+# frozen_string_literal: true
+
+module Packwerk
+  class OffenseCollection
+    extend T::Sig
+    extend T::Helpers
+
+    sig do
+      params(
+        root_path: String,
+        deprecated_references: T::Hash[Packwerk::Package, Packwerk::DeprecatedReferences]
+      ).void
+    end
+    def initialize(root_path, deprecated_references = {})
+      @root_path = root_path
+      @deprecated_references = T.let(deprecated_references, T::Hash[Packwerk::Package, Packwerk::DeprecatedReferences])
+      @new_violations = T.let([], T::Array[Packwerk::ReferenceOffense])
+      @errors = T.let([], T::Array[Packwerk::Offense])
+    end
+
+    sig { returns(T::Array[Packwerk::ReferenceOffense]) }
+    attr_reader :new_violations
+
+    sig { returns(T::Array[Packwerk::Offense]) }
+    attr_reader :errors
+
+    sig do
+      params(offense: Packwerk::Offense)
+        .returns(T::Boolean)
+    end
+    def listed?(offense)
+      return false unless offense.is_a?(ReferenceOffense)
+      reference = offense.reference
+      deprecated_references_for(reference.source_package).listed?(reference, violation_type: offense.violation_type)
+    end
+
+    sig do
+      params(offense: Packwerk::Offense).void
+    end
+    def add_offense(offense)
+      unless offense.is_a?(ReferenceOffense)
+        @errors << offense
+        return
+      end
+      deprecated_references = deprecated_references_for(offense.reference.source_package)
+      unless deprecated_references.add_entries(offense.reference, offense.violation_type)
+        new_violations << offense
+      end
+    end
+
+    sig { returns(T::Boolean) }
+    def stale_violations?
+      @deprecated_references.values.any?(&:stale_violations?)
+    end
+
+    sig { void }
+    def dump_deprecated_references_files
+      @deprecated_references.each do |_, deprecated_references_file|
+        deprecated_references_file.dump
+      end
+    end
+
+    sig { returns(T::Array[Packwerk::Offense]) }
+    def outstanding_offenses
+      errors + new_violations
+    end
+
+    private
+
+    sig { params(package: Packwerk::Package).returns(Packwerk::DeprecatedReferences) }
+    def deprecated_references_for(package)
+      @deprecated_references[package] ||= Packwerk::DeprecatedReferences.new(
+        package,
+        deprecated_references_file_for(package),
+      )
+    end
+
+    sig { params(package: Packwerk::Package).returns(String) }
+    def deprecated_references_file_for(package)
+      File.join(@root_path, package.name, "deprecated_references.yml")
+    end
+  end
+end

data/lib/packwerk/offenses_formatter.rb

@@ -0,0 +1,19 @@
+# typed: strict
+# frozen_string_literal: true
+
+module Packwerk
+  module OffensesFormatter
+    extend T::Sig
+    extend T::Helpers
+
+    interface!
+
+    sig { abstract.params(offenses: T::Array[T.nilable(Offense)]).returns(String) }
+    def show_offenses(offenses)
+    end
+
+    sig { abstract.params(offense_collection: Packwerk::OffenseCollection).returns(String) }
+    def show_stale_violations(offense_collection)
+    end
+  end
+end

data/lib/packwerk/output_style.rb

@@ -0,0 +1,20 @@
+# typed: strict
+# frozen_string_literal: true
+
+module Packwerk
+  module OutputStyle
+    extend T::Sig
+    extend T::Helpers
+
+    interface!
+
+    sig { abstract.returns(String) }
+    def reset; end
+
+    sig { abstract.returns(String) }
+    def filename; end
+
+    sig { abstract.returns(String) }
+    def error; end
+  end
+end

data/lib/packwerk/output_styles/coloured.rb

@@ -0,0 +1,29 @@
+# typed: strict
+# frozen_string_literal: true
+
+module Packwerk
+  module OutputStyles
+    # See https://en.wikipedia.org/wiki/ANSI_escape_code#3/4_bit for ANSI escape colour codes
+    class Coloured
+      extend T::Sig
+      include OutputStyle
+
+      sig { override.returns(String) }
+      def reset
+        "\033[m"
+      end
+
+      sig { override.returns(String) }
+      def filename
+        # 36 is foreground cyan
+        "\033[36m"
+      end
+
+      sig { override.returns(String) }
+      def error
+        # 31 is foreground red
+        "\033[31m"
+      end
+    end
+  end
+end

data/lib/packwerk/output_styles/plain.rb

@@ -0,0 +1,26 @@
+# typed: strict
+# frozen_string_literal: true
+
+module Packwerk
+  module OutputStyles
+    class Plain
+      extend T::Sig
+      include OutputStyle
+
+      sig { override.returns(String) }
+      def reset
+        ""
+      end
+
+      sig { override.returns(String) }
+      def filename
+        ""
+      end
+
+      sig { override.returns(String) }
+      def error
+        ""
+      end
+    end
+  end
+end

data/lib/packwerk/package.rb

@@ -33,7 +33,15 @@ module Packwerk
     end
 
     def public_path
-      @public_path ||= File.join(@name, user_defined_public_path || "app/public/")
+      @public_path ||= begin
+        unprefixed_public_path = user_defined_public_path || "app/public/"
+
+        if root?
+          unprefixed_public_path
+        else
+          File.join(@name, unprefixed_public_path)
+        end
+      end
     end
 
     def public_path?(path)
@@ -52,6 +60,14 @@ module Packwerk
       name <=> other.name
     end
 
+    def eql?(other)
+      self == other
+    end
+
+    def hash
+      name.hash
+    end
+
     def to_s
       name
     end

data/lib/packwerk/package_set.rb

@@ -3,8 +3,6 @@
 
 require "pathname"
 
-require "packwerk/package"
-
 module Packwerk
   class PackageSet
     include Enumerable
@@ -60,7 +58,8 @@ module Packwerk
     end
 
     def package_from_path(file_path)
-      @packages.values.find { |package| package.package_path?(file_path) }
+      path_string = file_path.to_s
+      @packages.values.find { |package| package.package_path?(path_string) }
     end
   end
 end

data/lib/packwerk/parse_run.rb

@@ -0,0 +1,106 @@
+# typed: true
+# frozen_string_literal: true
+
+require "benchmark"
+require "parallel"
+
+module Packwerk
+  class ParseRun
+    extend T::Sig
+
+    def initialize(
+      files:,
+      configuration:,
+      progress_formatter: Formatters::ProgressFormatter.new(StringIO.new),
+      offenses_formatter: Formatters::OffensesFormatter.new
+    )
+      @configuration = configuration
+      @progress_formatter = progress_formatter
+      @offenses_formatter = offenses_formatter
+      @files = files
+    end
+
+    def detect_stale_violations
+      offense_collection = find_offenses
+
+      result_status = !offense_collection.stale_violations?
+      message = @offenses_formatter.show_stale_violations(offense_collection)
+
+      Result.new(message: message, status: result_status)
+    end
+
+    def update_deprecations
+      offense_collection = find_offenses
+      offense_collection.dump_deprecated_references_files
+
+      message = <<~EOS
+        #{@offenses_formatter.show_offenses(offense_collection.errors)}
+        ✅ `deprecated_references.yml` has been updated.
+      EOS
+
+      Result.new(message: message, status: offense_collection.errors.empty?)
+    end
+
+    def check
+      offense_collection = find_offenses(show_errors: true)
+
+      messages = [
+        @offenses_formatter.show_offenses(offense_collection.outstanding_offenses),
+        @offenses_formatter.show_stale_violations(offense_collection),
+      ]
+      result_status = offense_collection.outstanding_offenses.empty? && !offense_collection.stale_violations?
+
+      Result.new(message: messages.join("\n") + "\n", status: result_status)
+    end
+
+    private
+
+    def find_offenses(show_errors: false)
+      offense_collection = OffenseCollection.new(@configuration.root_path)
+      @progress_formatter.started(@files)
+
+      run_context = Packwerk::RunContext.from_configuration(@configuration)
+      all_offenses = T.let([], T.untyped)
+
+      process_file = -> (path) do
+        run_context.process_file(file: path).tap do |offenses|
+          failed = show_errors && offenses.any? { |offense| !offense_collection.listed?(offense) }
+          update_progress(failed: failed)
+        end
+      end
+
+      execution_time = Benchmark.realtime do
+        all_offenses = if @configuration.parallel?
+          Parallel.flat_map(@files, &process_file)
+        else
+          serial_find_offenses(&process_file)
+        end
+      end
+
+      @progress_formatter.finished(execution_time)
+
+      all_offenses.each { |offense| offense_collection.add_offense(offense) }
+      offense_collection
+    end
+
+    def serial_find_offenses
+      all_offenses = T.let([], T.untyped)
+      @files.each do |path|
+        offenses = yield path
+        all_offenses.concat(offenses)
+      end
+      all_offenses
+    rescue Interrupt
+      @progress_formatter.interrupted
+      all_offenses
+    end
+
+    def update_progress(failed: false)
+      if failed
+        @progress_formatter.mark_as_failed
+      else
+        @progress_formatter.mark_as_inspected
+      end
+    end
+  end
+end

data/lib/packwerk/parsed_constant_definitions.rb

@@ -3,8 +3,6 @@
 
 require "ast/node"
 
-require "packwerk/node"
-
 module Packwerk
   class ParsedConstantDefinitions
     def initialize(root_node:)
@@ -28,8 +26,8 @@ module Packwerk
 
       fully_qualified_constant_name = "::#{constant_name}"
 
-      possible_namespaces = namespace_path.reduce([""]) do |acc, current|
-        acc << acc.last + "::" + current
+      possible_namespaces = namespace_path.each_with_object([""]) do |current, acc|
+        acc << "#{acc.last}::#{current}" if acc.last && current
       end
 
       possible_namespaces.map { |namespace| namespace + fully_qualified_constant_name }

data/lib/packwerk/parsers.rb

@@ -1,8 +1,6 @@
 # typed: true
 # frozen_string_literal: true
 
-require "packwerk/offense"
-
 module Packwerk
   module Parsers
     autoload :Erb, "packwerk/parsers/erb"

data/lib/packwerk/parsers/erb.rb

@@ -6,8 +6,6 @@ require "better_html"
 require "better_html/parser"
 require "parser/source/buffer"
 
-require "packwerk/parsers"
-
 module Packwerk
   module Parsers
     class Erb