packwerk 1.0.1 → 1.1.3

data/lib/packwerk/parsers/erb.rb

@@ -19,6 +19,10 @@ module Packwerk
       def call(io:, file_path: "<unknown>")
         buffer = Parser::Source::Buffer.new(file_path)
         buffer.source = io.read
+        parse_buffer(buffer, file_path: file_path)
+      end
+
+      def parse_buffer(buffer, file_path:)
         parser = @parser_class.new(buffer, template_language: :html)
         to_ruby_ast(parser.ast, file_path)
       rescue EncodingError => e

data/lib/packwerk/parsers/factory.rb

@@ -26,9 +26,18 @@ module Packwerk
         when RUBY_REGEX
           @ruby_parser ||= Ruby.new
         when ERB_REGEX
-          @erb_parser ||= Erb.new
+          @erb_parser ||= erb_parser_class.new
         end
       end
+
+      def erb_parser_class
+        @erb_parser_class ||= Erb
+      end
+
+      def erb_parser_class=(klass)
+        @erb_parser_class = klass
+        @erb_parser = nil
+      end
     end
   end
 end

data/lib/packwerk/privacy_checker.rb

@@ -1,4 +1,4 @@
-# typed: true
+# typed: strict
 # frozen_string_literal: true
 
 require "packwerk/violation_type"
@@ -6,26 +6,34 @@ require "packwerk/checker"
 
 module Packwerk
   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, reference_lister: Packwerk::ReferenceLister)
+        .returns(T::Boolean)
+    end
     def invalid_reference?(reference, reference_lister)
-      return if reference.constant.public?
+      return false if reference.constant.public?
 
       privacy_option = reference.constant.package.enforce_privacy
-      return if enforcement_disabled?(privacy_option)
+      return false if enforcement_disabled?(privacy_option)
 
-      return unless privacy_option == true ||
+      return false unless privacy_option == true ||
         explicitly_private_constant?(reference.constant, explicitly_private_constants: privacy_option)
 
-      return if reference_lister.listed?(reference, violation_type: violation_type)
+      return false if reference_lister.listed?(reference, violation_type: violation_type)
 
       true
     end
 
+    sig { override.params(reference: Packwerk::Reference).returns(String) }
     def message_for(reference)
       source_desc = reference.source_package ? "'#{reference.source_package}'" : "here"
       "Privacy violation: '#{reference.constant.name}' is private to '#{reference.constant.package}' but " \
@@ -35,12 +43,22 @@ module Packwerk
 
     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

data/lib/packwerk/run_context.rb

@@ -1,48 +1,49 @@
 # typed: true
 # frozen_string_literal: true
 
-require "active_support/inflector"
 require "constant_resolver"
 
 require "packwerk/association_inspector"
-require "packwerk/checking_deprecated_references"
 require "packwerk/constant_discovery"
 require "packwerk/const_node_inspector"
 require "packwerk/dependency_checker"
 require "packwerk/file_processor"
-require "packwerk/node_processor"
+require "packwerk/inflector"
 require "packwerk/package_set"
 require "packwerk/privacy_checker"
 require "packwerk/reference_extractor"
+require "packwerk/node_processor_factory"
 
 module Packwerk
   class RunContext
+    extend T::Sig
+
     attr_reader(
-      :checkers,
-      :constant_name_inspectors,
-      :context_provider,
       :root_path,
-      :file_processor,
-      :node_processor_class,
-      :reference_lister
+      :load_paths,
+      :package_paths,
+      :inflector,
+      :custom_associations,
+      :checker_classes,
     )
 
+    attr_accessor :reference_lister
+
     DEFAULT_CHECKERS = [
       ::Packwerk::DependencyChecker,
       ::Packwerk::PrivacyChecker,
     ]
 
     class << self
-      def from_configuration(configuration, reference_lister: nil)
-        default_reference_lister = reference_lister ||
-          ::Packwerk::CheckingDeprecatedReferences.new(configuration.root_path)
+      def from_configuration(configuration, reference_lister:)
+        inflector = ::Packwerk::Inflector.from_file(configuration.inflections_file)
         new(
           root_path: configuration.root_path,
           load_paths: configuration.load_paths,
           package_paths: configuration.package_paths,
-          inflector: ActiveSupport::Inflector,
+          inflector: inflector,
           custom_associations: configuration.custom_associations,
-          reference_lister: default_reference_lister,
+          reference_lister: reference_lister,
         )
       end
     end
@@ -54,51 +55,73 @@ module Packwerk
       inflector: nil,
       custom_associations: [],
       checker_classes: DEFAULT_CHECKERS,
-      node_processor_class: NodeProcessor,
-      reference_lister: nil
+      reference_lister:
     )
-      @root_path = File.expand_path(root_path)
+      @root_path = root_path
+      @load_paths = load_paths
+      @package_paths = package_paths
+      @inflector = inflector
+      @custom_associations = custom_associations
+      @checker_classes = checker_classes
+      @reference_lister = reference_lister
+    end
 
-      resolver = ConstantResolver.new(
-        root_path: @root_path,
-        load_paths: load_paths,
-        inflector: inflector,
-      )
+    sig { params(file: String).returns(T::Array[T.nilable(::Packwerk::Offense)]) }
+    def process_file(file:)
+      file_processor.call(file)
+    end
+
+    private
+
+    sig { returns(FileProcessor) }
+    def file_processor
+      @file_processor ||= FileProcessor.new(node_processor_factory: node_processor_factory)
+    end
 
-      package_set = ::Packwerk::PackageSet.load_all_from(@root_path, package_pathspec: package_paths)
+    sig { returns(NodeProcessorFactory) }
+    def node_processor_factory
+      NodeProcessorFactory.new(
+        context_provider: context_provider,
+        checkers: checkers,
+        root_path: root_path,
+        constant_name_inspectors: constant_name_inspectors,
+        reference_lister: reference_lister
+      )
+    end
 
-      @context_provider = ::Packwerk::ConstantDiscovery.new(
+    sig { returns(ConstantDiscovery) }
+    def context_provider
+      ::Packwerk::ConstantDiscovery.new(
         constant_resolver: resolver,
         packages: package_set
       )
+    end
 
-      @reference_lister = reference_lister || ::Packwerk::CheckingDeprecatedReferences.new(@root_path)
+    sig { returns(ConstantResolver) }
+    def resolver
+      ConstantResolver.new(
+        root_path: root_path,
+        load_paths: load_paths,
+        inflector: inflector,
+      )
+    end
 
-      @checkers = checker_classes.map(&:new)
+    sig { returns(PackageSet) }
+    def package_set
+      ::Packwerk::PackageSet.load_all_from(root_path, package_pathspec: package_paths)
+    end
 
-      @constant_name_inspectors = [
+    sig { returns(T::Array[Checker]) }
+    def checkers
+      checker_classes.map(&:new)
+    end
+
+    sig { returns(T::Array[ConstantNameInspector]) }
+    def constant_name_inspectors
+      [
         ::Packwerk::ConstNodeInspector.new,
         ::Packwerk::AssociationInspector.new(inflector: inflector, custom_associations: custom_associations),
       ]
-
-      @node_processor_class = node_processor_class
-      @file_processor = FileProcessor.new(run_context: self)
-    end
-
-    def node_processor_for(filename:, ast_node:)
-      reference_extractor = ::Packwerk::ReferenceExtractor.new(
-        context_provider: context_provider,
-        constant_name_inspectors: constant_name_inspectors,
-        root_node: ast_node,
-        root_path: root_path,
-      )
-
-      node_processor_class.new(
-        reference_extractor: reference_extractor,
-        reference_lister: @reference_lister,
-        filename: filename,
-        checkers: checkers,
-      )
     end
   end
 end

data/lib/packwerk/sanity_checker.rb

@@ -1,4 +1,4 @@
-# typed: ignore
+# typed: false
 # frozen_string_literal: true
 
 require "packwerk/application_validator"

data/lib/packwerk/spring_command.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
-# typed: ignore
+# typed: false
 
 require "spring/commands"
 

data/lib/packwerk/updating_deprecated_references.rb

@@ -1,51 +1,14 @@
 # typed: true
 # frozen_string_literal: true
 
-require "sorbet-runtime"
-
-require "packwerk/deprecated_references"
-require "packwerk/reference"
-require "packwerk/reference_lister"
-require "packwerk/violation_type"
+require "packwerk/cache_deprecated_references"
 
 module Packwerk
-  class UpdatingDeprecatedReferences
-    extend T::Sig
-    include ReferenceLister
-
-    def initialize(root_path, deprecated_references = {})
-      @root_path = root_path
-      @deprecated_references = deprecated_references
-    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
-
+  class UpdatingDeprecatedReferences < CacheDeprecatedReferences
     def dump_deprecated_references_files
       @deprecated_references.each do |_, deprecated_references_file|
         deprecated_references_file.dump
       end
     end
-
-    private
-
-    def deprecated_references_for(package)
-      @deprecated_references[package] ||= Packwerk::DeprecatedReferences.new(
-        package,
-        deprecated_references_file_for(package),
-      )
-    end
-
-    def deprecated_references_file_for(package)
-      File.join(@root_path, package.name, "deprecated_references.yml")
-    end
   end
 end

data/lib/packwerk/version.rb

@@ -2,5 +2,5 @@
 # frozen_string_literal: true
 
 module Packwerk
-  VERSION = "1.0.1"
+  VERSION = "1.1.3"
 end

data/library.yml

@@ -3,4 +3,4 @@ name: Packwerk
 stewards:
 - "@Shopify/kernel-architecture-patterns"
 slack_channels:
-- architecture-patterns
+- code-foundations

data/packwerk.gemspec

@@ -34,7 +34,7 @@ Gem::Specification.new do |spec|
   spec.executables << "packwerk"
 
   spec.files = Dir.chdir(__dir__) do
-    %x(git ls-files -z).split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+    %x(git ls-files -z).split("\x0").reject { |f| f.match(%r{^(test|spec|features|static)/}) }
   end
   spec.require_paths = %w(lib)
 

data/service.yml

@@ -1,6 +1,6 @@
 # https://services.shopify.io/services/packwerk/production
 org_line: Kernel
-owners: Shopify/kernel-architecture-patterns
+owners: Shopify/core-stewardship
 classification: library
 slack_channels:
-  - architecture-patterns
+  - core-stewardship

data/shipit.rubygems.yml

@@ -1 +1,5 @@
-# default configs
+dependencies:
+  override: []
+deploy:
+  override:
+  - release-gem packwerk.gemspec rake release

data/sorbet/rbi/gems/{actioncable@6.1.0.alpha-d80c18a391e33552ae2d943e68af56946f883f65.rbi → actioncable@7.0.0.alpha-d612542336d9a61381311c95a27d801bb4094779.rbi}

@@ -1,6 +1,6 @@
 # DO NOT EDIT MANUALLY
 # This is an autogenerated file for types exported from the `actioncable` gem.
-# Please instead update this file by running `dev typecheck update`.
+# Please instead update this file by running `bin/tapioca sync`.
 
 # typed: true
 
@@ -49,12 +49,12 @@ class ActionCable::Channel::Base
   def _unsubscribe_callbacks; end
   def connection; end
   def identifier; end
-  def logger(*args, &block); end
+  def logger(*_arg0, &_arg1); end
   def params; end
   def perform_action(data); end
-  def periodic_timers=(_); end
+  def periodic_timers=(_arg0); end
   def rescue_handlers; end
-  def rescue_handlers=(_); end
+  def rescue_handlers=(_arg0); end
   def rescue_handlers?; end
   def subscribe_to_channel; end
   def unsubscribe_from_channel; end
@@ -107,8 +107,8 @@ module ActionCable::Channel::Broadcasting
 
   mixes_in_class_methods(::ActionCable::Channel::Broadcasting::ClassMethods)
 
-  def broadcast_to(*args, &block); end
-  def broadcasting_for(*args, &block); end
+  def broadcast_to(*_arg0, &_arg1); end
+  def broadcasting_for(*_arg0, &_arg1); end
 end
 
 module ActionCable::Channel::Broadcasting::ClassMethods
@@ -139,7 +139,7 @@ module ActionCable::Channel::Naming
 
   mixes_in_class_methods(::ActionCable::Channel::Naming::ClassMethods)
 
-  def channel_name(*args, &block); end
+  def channel_name(*_arg0, &_arg1); end
 end
 
 module ActionCable::Channel::Naming::ClassMethods
@@ -167,13 +167,13 @@ end
 module ActionCable::Channel::Streams
   extend(::ActiveSupport::Concern)
 
-  def pubsub(*args, &block); end
+  def pubsub(*_arg0, &_arg1); end
   def stop_all_streams; end
   def stop_stream_for(model); end
   def stop_stream_from(broadcasting); end
   def stream_for(model, callback = T.unsafe(nil), coder: T.unsafe(nil), &block); end
   def stream_from(broadcasting, callback = T.unsafe(nil), coder: T.unsafe(nil), &block); end
-  def stream_or_reject_for(record); end
+  def stream_or_reject_for(model); end
 
   private
 
@@ -194,7 +194,7 @@ class ActionCable::Channel::TestCase < ::ActiveSupport::TestCase
   extend(::ActionCable::Channel::TestCase::Behavior::ClassMethods)
 
   def _channel_class; end
-  def _channel_class=(_); end
+  def _channel_class=(_arg0); end
   def _channel_class?; end
   def connection; end
   def subscription; end
@@ -264,9 +264,9 @@ class ActionCable::Connection::Base
   def close(reason: T.unsafe(nil), reconnect: T.unsafe(nil)); end
   def dispatch_websocket_message(websocket_message); end
   def env; end
-  def event_loop(*args, &block); end
+  def event_loop(*_arg0, &_arg1); end
   def identifiers; end
-  def identifiers=(_); end
+  def identifiers=(_arg0); end
   def identifiers?; end
   def logger; end
   def on_close(reason, code); end
@@ -275,10 +275,10 @@ class ActionCable::Connection::Base
   def on_open; end
   def process; end
   def protocol; end
-  def pubsub(*args, &block); end
+  def pubsub(*_arg0, &_arg1); end
   def receive(websocket_message); end
   def rescue_handlers; end
-  def rescue_handlers=(_); end
+  def rescue_handlers=(_arg0); end
   def rescue_handlers?; end
   def send_async(method, *arguments); end
   def server; end
@@ -438,7 +438,7 @@ class ActionCable::Connection::Subscriptions
   def add(data); end
   def execute_command(data); end
   def identifiers; end
-  def logger(*args, &block); end
+  def logger(*_arg0, &_arg1); end
   def perform_action(data); end
   def remove(data); end
   def remove_subscription(subscription); end
@@ -477,7 +477,7 @@ class ActionCable::Connection::TestCase < ::ActiveSupport::TestCase
   extend(::ActionCable::Connection::TestCase::Behavior::ClassMethods)
 
   def _connection_class; end
-  def _connection_class=(_); end
+  def _connection_class=(_arg0); end
   def _connection_class?; end
   def connection; end
 
@@ -556,7 +556,7 @@ class ActionCable::RemoteConnections::RemoteConnection
 
   def disconnect; end
   def identifiers; end
-  def identifiers=(_); end
+  def identifiers=(_arg0); end
   def identifiers?; end
 
   protected
@@ -593,7 +593,7 @@ class ActionCable::Server::Base
   def connection_identifiers; end
   def disconnect(identifiers); end
   def event_loop; end
-  def logger(*args, &block); end
+  def logger(*_arg0, &_arg1); end
   def mutex; end
   def pubsub; end
   def remote_connections; end
@@ -625,26 +625,26 @@ class ActionCable::Server::Configuration
   def initialize; end
 
   def allow_same_origin_as_host; end
-  def allow_same_origin_as_host=(_); end
+  def allow_same_origin_as_host=(_arg0); end
   def allowed_request_origins; end
-  def allowed_request_origins=(_); end
+  def allowed_request_origins=(_arg0); end
   def cable; end
-  def cable=(_); end
+  def cable=(_arg0); end
   def connection_class; end
-  def connection_class=(_); end
+  def connection_class=(_arg0); end
   def disable_request_forgery_protection; end
-  def disable_request_forgery_protection=(_); end
+  def disable_request_forgery_protection=(_arg0); end
   def log_tags; end
-  def log_tags=(_); end
+  def log_tags=(_arg0); end
   def logger; end
-  def logger=(_); end
+  def logger=(_arg0); end
   def mount_path; end
-  def mount_path=(_); end
+  def mount_path=(_arg0); end
   def pubsub_adapter; end
   def url; end
-  def url=(_); end
+  def url=(_arg0); end
   def worker_pool_size; end
-  def worker_pool_size=(_); end
+  def worker_pool_size=(_arg0); end
 end
 
 module ActionCable::Server::Connections
@@ -659,15 +659,29 @@ ActionCable::Server::Connections::BEAT_INTERVAL = T.let(T.unsafe(nil), Integer)
 
 class ActionCable::Server::Worker
   include(::ActiveSupport::Callbacks)
+  include(::ActionCable::Server::Worker::ActiveRecordConnectionManagement)
   extend(::ActiveSupport::Callbacks::ClassMethods)
   extend(::ActiveSupport::DescendantsTracker)
 
+  def initialize(max_size: T.unsafe(nil)); end
+
   def __callbacks; end
   def __callbacks?; end
   def _run_work_callbacks(&block); end
   def _work_callbacks; end
+  def async_exec(receiver, *args, connection:, &block); end
+  def async_invoke(receiver, method, *args, connection: T.unsafe(nil), &block); end
   def connection; end
   def connection=(obj); end
+  def executor; end
+  def halt; end
+  def invoke(receiver, method, *args, connection:, &block); end
+  def stopping?; end
+  def work(connection); end
+
+  private
+
+  def logger; end
 
   class << self
     def __callbacks; end
@@ -680,6 +694,12 @@ class ActionCable::Server::Worker
   end
 end
 
+module ActionCable::Server::Worker::ActiveRecordConnectionManagement
+  extend(::ActiveSupport::Concern)
+
+  def with_database_connections; end
+end
+
 module ActionCable::SubscriptionAdapter
   extend(::ActiveSupport::Autoload)
 end
@@ -738,8 +758,8 @@ module ActionCable::TestHelper
   def assert_broadcasts(stream, number, &block); end
   def assert_no_broadcasts(stream, &block); end
   def before_setup; end
-  def broadcasts(*args, &block); end
-  def clear_messages(*args, &block); end
+  def broadcasts(*_arg0, &_arg1); end
+  def clear_messages(*_arg0, &_arg1); end
   def pubsub_adapter; end
 
   private
@@ -766,7 +786,7 @@ module ActionCable::Channel::ChannelStub
   def start_periodic_timers; end
   def stop_all_streams; end
   def stop_periodic_timers; end
-  def stream_from(broadcasting, *_); end
+  def stream_from(broadcasting, *_arg1); end
   def streams; end
 end
 
@@ -806,9 +826,9 @@ end
 
 class ActionCable::Connection::TestRequest < ::ActionDispatch::TestRequest
   def cookie_jar; end
-  def cookie_jar=(_); end
+  def cookie_jar=(_arg0); end
   def session; end
-  def session=(_); end
+  def session=(_arg0); end
 end
 
 class ActionCable::SubscriptionAdapter::Async < ::ActionCable::SubscriptionAdapter::Inline
@@ -821,12 +841,12 @@ end
 class ActionCable::SubscriptionAdapter::Async::AsyncSubscriberMap < ::ActionCable::SubscriptionAdapter::SubscriberMap
   def initialize(event_loop); end
 
-  def add_subscriber(*_); end
-  def invoke_callback(*_); end
+  def add_subscriber(*_arg0); end
+  def invoke_callback(*_arg0); end
 end
 
 class ActionCable::SubscriptionAdapter::Inline < ::ActionCable::SubscriptionAdapter::Base
-  def initialize(*_); end
+  def initialize(*_arg0); end
 
   def broadcast(channel, payload); end
   def shutdown; end