packwerk 2.3.0 → 3.0.1

data/sorbet/rbi/shims/minitest/test.rb

@@ -0,0 +1,8 @@
+# typed: true
+# frozen_string_literal: true
+
+module Minitest
+  class Test
+    include StubConst
+  end
+end

data/sorbet/rbi/shims/packwerk/reference.rbi

@@ -0,0 +1,33 @@
+# typed: true
+
+module Packwerk
+  class Reference
+    sig do
+      params(
+        package: Package,
+        relative_path: String,
+        constant: ConstantContext,
+        source_location: T.nilable(Node::Location),
+      ).void
+    end
+    def initialize(
+      package:,
+      relative_path:,
+      constant:,
+      source_location:
+    )
+    end
+
+    sig { returns(Package) }
+    attr_reader(:package)
+
+    sig { returns(T.nilable(String)) }
+    attr_reader(:relative_path)
+
+    sig { returns(ConstantContext) }
+    attr_reader(:constant)
+
+    sig { returns(T.nilable(Node::Location)) }
+    attr_reader(:source_location)
+  end
+end

data/sorbet/rbi/shims/packwerk/unresolved_reference.rbi

@@ -0,0 +1,33 @@
+# typed: true
+
+module Packwerk
+  class UnresolvedReference
+    sig do
+      params(
+        constant_name: String,
+        namespace_path: T.nilable(T::Array[String]),
+        relative_path: String,
+        source_location: T.nilable(Node::Location),
+      ).void
+    end
+    def initialize(
+      constant_name:,
+      namespace_path:,
+      relative_path:,
+      source_location:
+    )
+    end
+
+    sig { returns(String) }
+    attr_reader(:constant_name)
+
+    sig { returns(T.nilable(T::Array[String])) }
+    attr_reader(:namespace_path)
+
+    sig { returns(String) }
+    attr_reader(:relative_path)
+
+    sig { returns(T.nilable(Node::Location)) }
+    attr_reader(:source_location)
+  end
+end

data/sorbet/rbi/shims/parser.rbi

@@ -0,0 +1,13 @@
+# typed: strict
+
+class Parser::Base < ::Racc::Parser
+  # Parses a source buffer and returns the AST, or `nil` in case of a non fatal error.
+  #
+  # @api public
+  # @param source_buffer [Parser::Source::Buffer] The source buffer to parse.
+  # @return [Parser::AST::Node, nil]
+  #
+  # source://parser-3.1.2.1/lib/parser/base.rb:186
+  sig { params(source_buffer: Parser::Source::Buffer).returns(T.nilable(Parser::AST::Node)) }
+  def parse(source_buffer); end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: packwerk
 version: !ruby/object:Gem::Version
-  version: 2.3.0
+  version: 3.0.1
 platform: ruby
 authors:
 - Shopify Inc.
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2023-02-21 00:00:00.000000000 Z
+date: 2023-03-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '5.2'
+        version: '6.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '5.2'
+        version: '6.0'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -136,6 +136,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: railties
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 description: |
   Sets package level boundaries between a specified set of ruby
   constants to minimize cross-boundary referencing and dependency.
@@ -179,18 +193,22 @@ files:
 - gemfiles/Gemfile-rails-6-0
 - gemfiles/Gemfile-rails-6-1
 - lib/packwerk.rb
-- lib/packwerk/application_load_paths.rb
 - lib/packwerk/application_validator.rb
 - lib/packwerk/association_inspector.rb
 - lib/packwerk/cache.rb
+- lib/packwerk/checker.rb
 - lib/packwerk/cli.rb
+- lib/packwerk/cli/result.rb
 - lib/packwerk/configuration.rb
 - lib/packwerk/const_node_inspector.rb
+- lib/packwerk/constant_context.rb
 - lib/packwerk/constant_discovery.rb
 - lib/packwerk/constant_name_inspector.rb
+- lib/packwerk/disable_sorbet.rb
+- lib/packwerk/extension_loader.rb
 - lib/packwerk/file_processor.rb
 - lib/packwerk/files_for_processing.rb
-- lib/packwerk/formatters/offenses_formatter.rb
+- lib/packwerk/formatters/default_offenses_formatter.rb
 - lib/packwerk/formatters/progress_formatter.rb
 - lib/packwerk/generators/configuration_file.rb
 - lib/packwerk/generators/root_package.rb
@@ -218,20 +236,19 @@ files:
 - lib/packwerk/parsers/factory.rb
 - lib/packwerk/parsers/parser_interface.rb
 - lib/packwerk/parsers/ruby.rb
+- lib/packwerk/rails_load_paths.rb
 - lib/packwerk/reference.rb
-- lib/packwerk/reference_checking/checkers/checker.rb
 - lib/packwerk/reference_checking/checkers/dependency_checker.rb
-- lib/packwerk/reference_checking/checkers/privacy_checker.rb
 - lib/packwerk/reference_checking/reference_checker.rb
 - lib/packwerk/reference_extractor.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/unresolved_reference.rb
+- lib/packwerk/validator.rb
+- lib/packwerk/validator/result.rb
+- lib/packwerk/validators/dependency_validator.rb
 - lib/packwerk/version.rb
-- lib/packwerk/violation_type.rb
 - packwerk.gemspec
 - shipit.rubygems.yml
 - sorbet/config
@@ -258,7 +275,6 @@ files:
 - sorbet/rbi/gems/digest@3.1.0.rbi
 - sorbet/rbi/gems/erubi@1.11.0.rbi
 - sorbet/rbi/gems/globalid@1.0.0.rbi
-- sorbet/rbi/gems/html_tokenizer@0.0.7.rbi
 - sorbet/rbi/gems/i18n@1.12.0.rbi
 - sorbet/rbi/gems/json@2.6.2.rbi
 - sorbet/rbi/gems/language_server-protocol@3.16.0.3.rbi
@@ -268,7 +284,6 @@ files:
 - sorbet/rbi/gems/marcel@1.0.2.rbi
 - sorbet/rbi/gems/method_source@1.0.0.rbi
 - sorbet/rbi/gems/mini_mime@1.1.2.rbi
-- sorbet/rbi/gems/mini_portile2@2.8.0.rbi
 - sorbet/rbi/gems/minitest-focus@1.3.1.rbi
 - sorbet/rbi/gems/minitest@5.16.2.rbi
 - sorbet/rbi/gems/mocha@1.14.0.rbi
@@ -318,7 +333,11 @@ files:
 - sorbet/rbi/gems/websocket-extensions@0.1.5.rbi
 - sorbet/rbi/gems/yard-sorbet@0.6.1.rbi
 - sorbet/rbi/gems/yard@0.9.28.rbi
-- sorbet/rbi/gems/zeitwerk@2.6.0.rbi
+- sorbet/rbi/gems/zeitwerk@2.6.4.rbi
+- sorbet/rbi/shims/minitest/test.rb
+- sorbet/rbi/shims/packwerk/reference.rbi
+- sorbet/rbi/shims/packwerk/unresolved_reference.rbi
+- sorbet/rbi/shims/parser.rbi
 - sorbet/rbi/shims/psych.rbi
 - sorbet/tapioca/require.rb
 homepage: https://github.com/Shopify/packwerk
@@ -337,7 +356,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '2.6'
+      version: '2.7'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="

data/lib/packwerk/formatters/offenses_formatter.rb

@@ -1,52 +0,0 @@
-# typed: strict
-# frozen_string_literal: true
-
-module Packwerk
-  module Formatters
-    class OffensesFormatter
-      include Packwerk::OffensesFormatter
-
-      extend T::Sig
-
-      sig { params(style: OutputStyle).void }
-      def initialize(style: OutputStyles::Plain.new)
-        @style = style
-      end
-
-      sig { override.params(offenses: T::Array[T.nilable(Offense)]).returns(String) }
-      def show_offenses(offenses)
-        return "No offenses detected" if offenses.empty?
-
-        <<~EOS
-          #{offenses_list(offenses)}
-          #{offenses_summary(offenses)}
-        EOS
-      end
-
-      sig { override.params(offense_collection: Packwerk::OffenseCollection, fileset: T::Set[String]).returns(String) }
-      def show_stale_violations(offense_collection, fileset)
-        if offense_collection.stale_violations?(fileset)
-          "There were stale violations found, please run `packwerk update-todo`"
-        else
-          "No stale violations detected"
-        end
-      end
-
-      private
-
-      sig { params(offenses: T::Array[T.nilable(Offense)]).returns(String) }
-      def offenses_list(offenses)
-        offenses
-          .compact
-          .map { |offense| offense.to_s(@style) }
-          .join("\n")
-      end
-
-      sig { params(offenses: T::Array[T.nilable(Offense)]).returns(String) }
-      def offenses_summary(offenses)
-        offenses_string = "offense".pluralize(offenses.length)
-        "#{offenses.length} #{offenses_string} detected"
-      end
-    end
-  end
-end

data/lib/packwerk/reference_checking/checkers/checker.rb

@@ -1,34 +0,0 @@
-# typed: strict
-# frozen_string_literal: true
-
-module Packwerk
-  module ReferenceChecking
-    module Checkers
-      module Checker
-        extend T::Sig
-        extend T::Helpers
-
-        abstract!
-
-        sig { abstract.returns(ViolationType) }
-        def violation_type; end
-
-        sig { abstract.params(reference: Reference).returns(T::Boolean) }
-        def invalid_reference?(reference); end
-
-        sig { abstract.params(reference: Reference).returns(String) }
-        def message(reference); end
-
-        sig { params(reference: Reference).returns(String) }
-        def standard_help_message(reference)
-          standard_message = <<~EOS
-            Inference details: this is a reference to #{reference.constant.name} which seems to be defined in #{reference.constant.location}.
-            To receive help interpreting or resolving this error message, see: https://github.com/Shopify/packwerk/blob/main/TROUBLESHOOT.md#Troubleshooting-violations
-          EOS
-
-          standard_message.chomp
-        end
-      end
-    end
-  end
-end

data/lib/packwerk/reference_checking/checkers/privacy_checker.rb

@@ -1,76 +0,0 @@
-# typed: strict
-# frozen_string_literal: true
-
-module Packwerk
-  module ReferenceChecking
-    module Checkers
-      # Checks whether a given reference references a private constant of another package.
-      class PrivacyChecker
-        extend T::Sig
-        include Checker
-
-        sig { override.returns(Packwerk::ViolationType) }
-        def violation_type
-          ViolationType::Privacy
-        end
-
-        sig do
-          override
-            .params(reference: Packwerk::Reference)
-            .returns(T::Boolean)
-        end
-        def invalid_reference?(reference)
-          return false if reference.constant.public?
-
-          privacy_option = reference.constant.package.enforce_privacy
-          return false if enforcement_disabled?(privacy_option)
-
-          return false unless privacy_option == true ||
-            explicitly_private_constant?(reference.constant, explicitly_private_constants: privacy_option)
-
-          true
-        end
-
-        sig do
-          override
-            .params(reference: Packwerk::Reference)
-            .returns(String)
-        end
-        def message(reference)
-          source_desc = "'#{reference.source_package}'"
-
-          message = <<~EOS
-            Privacy violation: '#{reference.constant.name}' is private to '#{reference.constant.package}' but referenced from #{source_desc}.
-            Is there a public entrypoint in '#{reference.constant.package.public_path}' that you can use instead?
-
-            #{standard_help_message(reference)}
-          EOS
-
-          message.chomp
-        end
-
-        private
-
-        sig do
-          params(
-            constant: ConstantDiscovery::ConstantContext,
-            explicitly_private_constants: T::Array[String]
-          ).returns(T::Boolean)
-        end
-        def explicitly_private_constant?(constant, explicitly_private_constants:)
-          explicitly_private_constants.include?(constant.name) ||
-            # nested constants
-            explicitly_private_constants.any? { |epc| constant.name.start_with?(epc + "::") }
-        end
-
-        sig do
-          params(privacy_option: T.nilable(T.any(T::Boolean, T::Array[String])))
-            .returns(T::Boolean)
-        end
-        def enforcement_disabled?(privacy_option)
-          [false, nil].include?(privacy_option)
-        end
-      end
-    end
-  end
-end

data/lib/packwerk/result.rb

@@ -1,9 +0,0 @@
-# typed: strict
-# frozen_string_literal: true
-
-module Packwerk
-  class Result < T::Struct
-    const :message, String
-    const :status, T::Boolean
-  end
-end

data/lib/packwerk/sanity_checker.rb

@@ -1,8 +0,0 @@
-# typed: strict
-# frozen_string_literal: true
-
-module Packwerk
-  # To do: This alias and file should be removed as it is deprecated
-  warn("DEPRECATION WARNING: Packwerk::SanityChecker is deprecated, use Packwerk::ApplicationValidator instead.")
-  SanityChecker = ApplicationValidator
-end

data/lib/packwerk/violation_type.rb

@@ -1,11 +0,0 @@
-# typed: strict
-# frozen_string_literal: true
-
-module Packwerk
-  class ViolationType < T::Enum
-    enums do
-      Privacy = new
-      Dependency = new
-    end
-  end
-end

data/sorbet/rbi/gems/html_tokenizer@0.0.7.rbi

@@ -1,46 +0,0 @@
-# DO NOT EDIT MANUALLY
-# This is an autogenerated file for types exported from the `html_tokenizer` gem.
-# Please instead update this file by running `dev typecheck update`.
-
-# typed: true
-
-module HtmlTokenizer
-end
-
-class HtmlTokenizer::Parser
-  def initialize; end
-
-  def append_placeholder(_); end
-  def attribute_name; end
-  def attribute_quoted?; end
-  def attribute_value; end
-  def cdata_text; end
-  def closing_tag?; end
-  def column_number; end
-  def comment_text; end
-  def context; end
-  def document; end
-  def document_length; end
-  def errors; end
-  def errors_count; end
-  def line_number; end
-  def parse(_); end
-  def quote_character; end
-  def rawtext_text; end
-  def self_closing_tag?; end
-  def tag_name; end
-end
-
-class HtmlTokenizer::ParserError < ::RuntimeError
-  def initialize(message, position, line, column); end
-
-  def column; end
-  def line; end
-  def position; end
-end
-
-class HtmlTokenizer::Tokenizer
-  def initialize; end
-
-  def tokenize(_); end
-end

data/sorbet/rbi/gems/mini_portile2@2.8.0.rbi

@@ -1,8 +0,0 @@
-# typed: true
-
-# DO NOT EDIT MANUALLY
-# This is an autogenerated file for types exported from the `mini_portile2` gem.
-# Please instead update this file by running `bin/tapioca gem mini_portile2`.
-
-# THIS IS AN EMPTY RBI FILE.
-# see https://github.com/Shopify/tapioca/wiki/Manual-Gem-Requires