packwerk 1.1.3 → 1.2.0

data/sorbet/tapioca/require.rb

@@ -13,6 +13,7 @@ require "better_html/parser"
 require "constant_resolver"
 require "minitest/autorun"
 require "mocha/minitest"
+require "parallel"
 require "parser"
 require "parser/ast/node"
 require "parser/current"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: packwerk
 version: !ruby/object:Gem::Version
-  version: 1.1.3
+  version: 1.2.0
 platform: ruby
 authors:
 - Shopify Inc.
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2021-04-01 00:00:00.000000000 Z
+date: 2021-06-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -38,6 +38,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: parallel
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: sorbet-runtime
   requirement: !ruby/object:Gem::Requirement
@@ -187,21 +201,14 @@ files:
 - lib/packwerk/application_load_paths.rb
 - lib/packwerk/application_validator.rb
 - lib/packwerk/association_inspector.rb
-- lib/packwerk/cache_deprecated_references.rb
 - lib/packwerk/checker.rb
-- lib/packwerk/checking_deprecated_references.rb
 - lib/packwerk/cli.rb
-- lib/packwerk/commands/detect_stale_violations_command.rb
-- lib/packwerk/commands/offense_progress_marker.rb
-- lib/packwerk/commands/result.rb
-- lib/packwerk/commands/update_deprecations_command.rb
 - lib/packwerk/configuration.rb
 - lib/packwerk/const_node_inspector.rb
 - lib/packwerk/constant_discovery.rb
 - lib/packwerk/constant_name_inspector.rb
 - lib/packwerk/dependency_checker.rb
 - lib/packwerk/deprecated_references.rb
-- lib/packwerk/detect_stale_deprecated_references.rb
 - lib/packwerk/file_processor.rb
 - lib/packwerk/files_for_processing.rb
 - lib/packwerk/formatters/offenses_formatter.rb
@@ -224,11 +231,14 @@ files:
 - lib/packwerk/node_processor_factory.rb
 - lib/packwerk/node_visitor.rb
 - lib/packwerk/offense.rb
+- lib/packwerk/offense_collection.rb
+- lib/packwerk/offenses_formatter.rb
 - lib/packwerk/output_style.rb
 - lib/packwerk/output_styles/coloured.rb
 - lib/packwerk/output_styles/plain.rb
 - lib/packwerk/package.rb
 - lib/packwerk/package_set.rb
+- lib/packwerk/parse_run.rb
 - lib/packwerk/parsed_constant_definitions.rb
 - lib/packwerk/parsers.rb
 - lib/packwerk/parsers/erb.rb
@@ -237,11 +247,11 @@ files:
 - lib/packwerk/privacy_checker.rb
 - lib/packwerk/reference.rb
 - lib/packwerk/reference_extractor.rb
-- lib/packwerk/reference_lister.rb
+- lib/packwerk/reference_offense.rb
+- lib/packwerk/result.rb
 - lib/packwerk/run_context.rb
 - lib/packwerk/sanity_checker.rb
 - lib/packwerk/spring_command.rb
-- lib/packwerk/updating_deprecated_references.rb
 - lib/packwerk/version.rb
 - lib/packwerk/violation_type.rb
 - library.yml
@@ -343,7 +353,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
+rubygems_version: 3.2.17
 signing_key: 
 specification_version: 4
 summary: Packages for applications based on the zeitwerk autoloader

data/lib/packwerk/cache_deprecated_references.rb

@@ -1,55 +0,0 @@
-# typed: strict
-# frozen_string_literal: true
-
-require "sorbet-runtime"
-
-require "packwerk/deprecated_references"
-require "packwerk/reference"
-require "packwerk/reference_lister"
-require "packwerk/violation_type"
-
-module Packwerk
-  class CacheDeprecatedReferences
-    extend T::Sig
-    extend T::Helpers
-    include ReferenceLister
-    abstract!
-
-    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])
-    end
-
-    sig do
-      params(reference: Packwerk::Reference, violation_type: ViolationType)
-        .returns(T::Boolean)
-        .override
-    end
-    def listed?(reference, violation_type:)
-      deprecated_references = deprecated_references_for(reference.source_package)
-      deprecated_references.add_entries(reference, violation_type.serialize)
-      true
-    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/checking_deprecated_references.rb

@@ -1,43 +0,0 @@
-# typed: strict
-# frozen_string_literal: true
-
-require "sorbet-runtime"
-
-require "packwerk/reference_lister"
-
-module Packwerk
-  class CheckingDeprecatedReferences
-    extend T::Sig
-    include ReferenceLister
-
-    sig { params(root_path: String).void }
-    def initialize(root_path)
-      @root_path = root_path
-      @deprecated_references = T.let({}, T::Hash[Packwerk::Package, Packwerk::DeprecatedReferences])
-    end
-
-    sig do
-      params(reference: Packwerk::Reference, violation_type: ViolationType)
-        .returns(T::Boolean)
-        .override
-    end
-    def listed?(reference, violation_type:)
-      deprecated_references_for(reference.source_package).listed?(reference, violation_type: violation_type)
-    end
-
-    private
-
-    sig { params(source_package: Packwerk::Package).returns(Packwerk::DeprecatedReferences) }
-    def deprecated_references_for(source_package)
-      @deprecated_references[source_package] ||= Packwerk::DeprecatedReferences.new(
-        source_package,
-        deprecated_references_file_for(source_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/commands/detect_stale_violations_command.rb

@@ -1,60 +0,0 @@
-# typed: true
-# frozen_string_literal: true
-require "sorbet-runtime"
-require "benchmark"
-require "packwerk/run_context"
-require "packwerk/detect_stale_deprecated_references"
-require "packwerk/commands/offense_progress_marker"
-require "packwerk/commands/result"
-
-module Packwerk
-  module Commands
-    class DetectStaleViolationsCommand
-      extend T::Sig
-      include OffenseProgressMarker
-      def initialize(files:, configuration:, run_context: nil, progress_formatter: nil, reference_lister: nil)
-        @configuration = configuration
-        @run_context = run_context
-        @reference_lister = reference_lister
-        @progress_formatter = progress_formatter
-        @files = files
-      end
-
-      sig { returns(Result) }
-      def run
-        @progress_formatter.started(@files)
-
-        execution_time = Benchmark.realtime do
-          @files.flat_map do |path|
-            run_context.process_file(file: path).tap do |offenses|
-              mark_progress(offenses: offenses, progress_formatter: @progress_formatter)
-            end
-          end
-        end
-
-        @progress_formatter.finished(execution_time)
-        calculate_result
-      end
-
-      private
-
-      def run_context
-        @run_context ||= Packwerk::RunContext.from_configuration(@configuration, reference_lister: reference_lister)
-      end
-
-      def reference_lister
-        @reference_lister ||= ::Packwerk::DetectStaleDeprecatedReferences.new(@configuration.root_path)
-      end
-
-      sig { returns(Result) }
-      def calculate_result
-        result_status = !reference_lister.stale_violations?
-        message = "There were stale violations found, please run `packwerk update-deprecations`"
-        if result_status
-          message = "No stale violations detected"
-        end
-        Result.new(message: message, status: result_status)
-      end
-    end
-  end
-end

data/lib/packwerk/commands/offense_progress_marker.rb

@@ -1,24 +0,0 @@
-# frozen_string_literal: true
-# typed: strict
-require "sorbet-runtime"
-require "packwerk/formatters/progress_formatter"
-
-module Packwerk
-  module OffenseProgressMarker
-    extend T::Sig
-
-    sig do
-      params(
-        offenses: T::Array[T.nilable(::Packwerk::Offense)],
-        progress_formatter: ::Packwerk::Formatters::ProgressFormatter
-      ).void
-    end
-    def mark_progress(offenses:, progress_formatter:)
-      if offenses.empty?
-        progress_formatter.mark_as_inspected
-      else
-        progress_formatter.mark_as_failed
-      end
-    end
-  end
-end

data/lib/packwerk/commands/result.rb

@@ -1,13 +0,0 @@
-# typed: strict
-# frozen_string_literal: true
-
-require "sorbet-runtime"
-
-module Packwerk
-  module Commands
-    class Result < T::Struct
-      prop :message, String
-      prop :status, T::Boolean
-    end
-  end
-end

data/lib/packwerk/commands/update_deprecations_command.rb

@@ -1,81 +0,0 @@
-# typed: strict
-# frozen_string_literal: true
-
-require "sorbet-runtime"
-require "benchmark"
-
-require "packwerk/commands/offense_progress_marker"
-require "packwerk/commands/result"
-require "packwerk/run_context"
-require "packwerk/updating_deprecated_references"
-
-module Packwerk
-  module Commands
-    class UpdateDeprecationsCommand
-      extend T::Sig
-      include OffenseProgressMarker
-
-      sig do
-        params(
-          files: T::Enumerable[String],
-          configuration: Configuration,
-          offenses_formatter: Formatters::OffensesFormatter,
-          progress_formatter: Formatters::ProgressFormatter
-        ).void
-      end
-      def initialize(files:, configuration:, offenses_formatter:, progress_formatter:)
-        @files = files
-        @configuration = configuration
-        @progress_formatter = progress_formatter
-        @offenses_formatter = offenses_formatter
-        @updating_deprecated_references = T.let(nil, T.nilable(UpdatingDeprecatedReferences))
-        @run_context = T.let(nil, T.nilable(RunContext))
-      end
-
-      sig { returns(Result) }
-      def run
-        @progress_formatter.started(@files)
-
-        all_offenses = T.let([], T.untyped)
-        execution_time = Benchmark.realtime do
-          all_offenses = @files.flat_map do |path|
-            run_context.process_file(file: path).tap do |offenses|
-              mark_progress(offenses: offenses, progress_formatter: @progress_formatter)
-            end
-          end
-
-          updating_deprecated_references.dump_deprecated_references_files
-        end
-
-        @progress_formatter.finished(execution_time)
-        calculate_result(all_offenses)
-      end
-
-      private
-
-      sig { returns(RunContext) }
-      def run_context
-        @run_context ||= RunContext.from_configuration(
-          @configuration,
-          reference_lister: updating_deprecated_references
-        )
-      end
-
-      sig { returns(UpdatingDeprecatedReferences) }
-      def updating_deprecated_references
-        @updating_deprecated_references ||= UpdatingDeprecatedReferences.new(@configuration.root_path)
-      end
-
-      sig { params(all_offenses: T::Array[T.nilable(::Packwerk::Offense)]).returns(Result) }
-      def calculate_result(all_offenses)
-        result_status = all_offenses.empty?
-        message = <<~EOS
-          #{@offenses_formatter.show_offenses(all_offenses)}
-          ✅ `deprecated_references.yml` has been updated.
-        EOS
-
-        Result.new(message: message, status: result_status)
-      end
-    end
-  end
-end

data/lib/packwerk/detect_stale_deprecated_references.rb

@@ -1,14 +0,0 @@
-# typed: strict
-# frozen_string_literal: true
-
-require "packwerk/cache_deprecated_references"
-
-module Packwerk
-  class DetectStaleDeprecatedReferences < CacheDeprecatedReferences
-    extend T::Sig
-    sig { returns(T::Boolean) }
-    def stale_violations?
-      @deprecated_references.values.any?(&:stale_violations?)
-    end
-  end
-end

data/lib/packwerk/reference_lister.rb

@@ -1,23 +0,0 @@
-# typed: strict
-# frozen_string_literal: true
-
-require "sorbet-runtime"
-
-require "packwerk/reference"
-require "packwerk/violation_type"
-
-module Packwerk
-  module ReferenceLister
-    extend T::Sig
-    extend T::Helpers
-
-    interface!
-
-    sig do
-      params(reference: Packwerk::Reference, violation_type: ViolationType)
-        .returns(T::Boolean)
-        .abstract
-    end
-    def listed?(reference, violation_type:); end
-  end
-end

data/lib/packwerk/updating_deprecated_references.rb

@@ -1,14 +0,0 @@
-# typed: true
-# frozen_string_literal: true
-
-require "packwerk/cache_deprecated_references"
-
-module Packwerk
-  class UpdatingDeprecatedReferences < CacheDeprecatedReferences
-    def dump_deprecated_references_files
-      @deprecated_references.each do |_, deprecated_references_file|
-        deprecated_references_file.dump
-      end
-    end
-  end
-end