packwerk-extensions 0.3.0 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ec06b679c031e028a1dca4bb93e0cac394f13a3af2e86a19892efcf5e26ce6fe
-  data.tar.gz: 98835c87573ac3b47f13a50c9de8e9af6370c7f88debf12a24578e0040d87324
+  metadata.gz: 10da1ea58224fce898e99dd53a7775dd59cb3714a13a0940cc3a3d42a17fe6ab
+  data.tar.gz: 6cfb154342f96cc03bab150f6fbc16839014d368e25553a7d46a4915ce36a334
 SHA512:
-  metadata.gz: 6e37b7e13b22e77dc428a3d3bd210a6dea8c5eddbac5baf9c0ce31ae207b6b5e9bcfdf0cb9c3a1c041524c20a4a3f0a0affb9d08e90f105d78b28746b67ae7d5
-  data.tar.gz: ff5c5b5d73118ac391a086c13edb8733f0b682e4c87e404e4aaa3a5fc7e7736b655a1ed15e18e059758e854fa895cedb67d81eb93889d7767ad16a778b300d82
+  metadata.gz: 2abe25b9dedf146e0483a99365a454a98844b464f3af2d61cdc1b6b9a688bc889c9823f3b0170ef03552f4d6ef13019144964506915a614babf1e4b474112f3c
+  data.tar.gz: 27fd29f382047cda7bcf8c8c457053ec83015aca2b286189cab26464cab1bce186fcdd8bbf50b491d3c8e19d79dd187a4ab8e2dab3ea95197bd1aeca7ab66bd5

data/README.md

@@ -5,8 +5,8 @@
 Currently, it ships the following checkers to help improve the boundaries between packages. These checkers are:
 - A `privacy` checker that ensures other packages are using your package's public API
 - A `visibility` checker that allows packages to be private except to an explicit group of other packages.
-- A `folder_privacy` checker that allows packages to their sibling packs and parent pack (to be used in an application that uses folder packs)
-- A `layer` (formerly `architecture`) checker that allows packages to specify their "layer" and requires that each layer only communicate with layers below it.
+- A `folder_privacy` checker that allows packages to be private to their sibling packs and parent pack (to be used in an application that uses folder packs)
+- A `layer` (formerly `architecture`) checker that allows packages to specify their "layer" and ensures they cannot use packages from higher layers
 
 ## Installation
 
@@ -63,7 +63,7 @@ public_path: my/custom/path/
 ### Defining public constants through sigil
 
 > [!WARNING]
-> This way of of defining the public API of a package should be considered WIP. It is not supported by all tooling in the RubyAtScale ecosystem, as @alexevanczuk pointed out in a [comment on the PR](https://github.com/rubyatscale/packwerk-extensions/pull/35#discussion_r1334331797):
+> This way of defining the public API of a package should be considered WIP. It is not supported by all tooling in the RubyAtScale ecosystem, as @alexevanczuk pointed out in a [comment on the PR](https://github.com/rubyatscale/packwerk-extensions/pull/35#discussion_r1334331797):
 >
 > There are a couple of other places that will require changes related to this sigil. Namely, everything that is coupled to the public folder implementation of privacy.
 >
@@ -195,12 +195,15 @@ packs/c                   VIOLATION
 ```
 
 ## Layer Checker
-The layer checker can be used to enforce constraints on what can depend on what.
+The layer checker can be used to define layers and then enforce constraints on the dependencies that packages can have.
+Dependencies are only allowed to packages in or below the same layer.
 
 To enforce layers for your package, first define the `layers` in `packwerk.yml`, for example:
+
 ```
 layers:
-  - package
+  - feature
+  - core
   - utility
 ```
 
@@ -208,10 +211,10 @@ Then, turn on the checker in your package:
 ```yaml
 # components/merchandising/package.yml
 enforce_layers: true
-layer: utility
+layer: core
 ```
 
-Now this pack can only depend on other utility packages.
+Now this pack can only depend on other packages from the `core` or `utility` layers. It cannot depend on packages from the higher `feature` layer.
 
 ### Deprecated Architecture Checker
 The "Layer Checker" was formerly named "Architecture Checker". The associated keys were:

data/lib/packwerk/folder_privacy/checker.rb

@@ -7,21 +7,18 @@ require 'packwerk/folder_privacy/validator'
 module Packwerk
   module FolderPrivacy
     class Checker
-      extend T::Sig
       include Packwerk::Checker
 
-      VIOLATION_TYPE = T.let('folder_privacy', String)
+      VIOLATION_TYPE = 'folder_privacy'
 
-      sig { override.returns(String) }
+      # @override
+      #: -> String
       def violation_type
         VIOLATION_TYPE
       end
 
-      sig do
-        override
-          .params(reference: Packwerk::Reference)
-          .returns(T::Boolean)
-      end
+      # @override
+      #: (Packwerk::Reference reference) -> bool
       def invalid_reference?(reference)
         referencing_package = reference.package
         referenced_package = reference.constant.package
@@ -41,21 +38,15 @@ module Packwerk
         true
       end
 
-      sig do
-        override
-          .params(listed_offense: Packwerk::ReferenceOffense)
-          .returns(T::Boolean)
-      end
+      # @override
+      #: (Packwerk::ReferenceOffense listed_offense) -> bool
       def strict_mode_violation?(listed_offense)
         publishing_package = listed_offense.reference.constant.package
         publishing_package.config['enforce_folder_privacy'] == 'strict'
       end
 
-      sig do
-        override
-          .params(reference: Packwerk::Reference)
-          .returns(String)
-      end
+      # @override
+      #: (Packwerk::Reference reference) -> String
       def message(reference)
         source_desc = "'#{reference.package}'"
 
@@ -71,15 +62,12 @@ module Packwerk
 
       private
 
-      sig do
-        params(visibility_option: T.nilable(T.any(T::Boolean, String)))
-          .returns(T::Boolean)
-      end
+      #: ((bool | String)? visibility_option) -> bool
       def enforcement_disabled?(visibility_option)
         [false, nil].include?(visibility_option)
       end
 
-      sig { params(reference: Reference).returns(String) }
+      #: (Reference reference) -> String
       def standard_help_message(reference)
         standard_message = <<~MESSAGE.chomp
           Inference details: this is a reference to #{reference.constant.name} which seems to be defined in #{reference.constant.location}.

data/lib/packwerk/folder_privacy/package.rb

@@ -3,15 +3,17 @@
 
 module Packwerk
   module FolderPrivacy
-    class Package < T::Struct
-      extend T::Sig
+    class Package
+      #: (bool | String)?
+      attr_reader :enforce_folder_privacy
 
-      const :enforce_folder_privacy, T.nilable(T.any(T::Boolean, String))
+      #: (enforce_folder_privacy: (bool | String)?) -> void
+      def initialize(enforce_folder_privacy:)
+        @enforce_folder_privacy = enforce_folder_privacy
+      end
 
       class << self
-        extend T::Sig
-
-        sig { params(package: ::Packwerk::Package).returns(Package) }
+        #: (::Packwerk::Package package) -> Package
         def from(package)
           Package.new(
             enforce_folder_privacy: package.config['enforce_folder_privacy']

data/lib/packwerk/folder_privacy/validator.rb

@@ -4,14 +4,14 @@
 module Packwerk
   module FolderPrivacy
     class Validator
-      extend T::Sig
       include Packwerk::Validator
 
       Result = Packwerk::Validator::Result
 
-      sig { override.params(package_set: PackageSet, configuration: Configuration).returns(Result) }
+      # @override
+      #: (PackageSet package_set, Configuration configuration) -> Result
       def call(package_set, configuration)
-        results = T.let([], T::Array[Result])
+        results = [] #: Array[Result]
 
         package_manifests_settings_for(configuration, 'enforce_folder_privacy').each do |config, setting|
           next if setting.nil?
@@ -27,9 +27,10 @@ module Packwerk
         merge_results(results, separator: "\n---\n")
       end
 
-      sig { override.returns(T::Array[String]) }
+      # @override
+      #: -> Array[String]
       def permitted_keys
-        %w[enforce_folder_privacy]
+        %w(enforce_folder_privacy)
       end
     end
   end

data/lib/packwerk/layer/checker.rb

@@ -28,45 +28,31 @@ module Packwerk
     # C) A potential sequencing for modularizing a system (starting with lower layers first).
     #
     class Checker
-      extend T::Sig
       include Packwerk::Checker
 
-      sig { void }
-      def initialize
-        @violation_type = T.let(@violation_type, T.nilable(String))
-      end
-
-      sig { override.returns(String) }
+      # @override
+      #: -> String
       def violation_type
-        @violation_type ||= layer_config.violation_key
+        @violation_type ||= layer_config.violation_key #: String?
       end
 
-      sig do
-        override
-          .params(reference: Packwerk::Reference)
-          .returns(T::Boolean)
-      end
+      # @override
+      #: (Packwerk::Reference reference) -> bool
       def invalid_reference?(reference)
         constant_package = Package.from(reference.constant.package, layers)
         referencing_package = Package.from(reference.package, layers)
-        !referencing_package.can_depend_on?(constant_package, layers: layers)
+        !referencing_package.can_depend_on?(constant_package, layers:)
       end
 
-      sig do
-        override
-          .params(listed_offense: Packwerk::ReferenceOffense)
-          .returns(T::Boolean)
-      end
+      # @override
+      #: (Packwerk::ReferenceOffense listed_offense) -> bool
       def strict_mode_violation?(listed_offense)
         constant_package = listed_offense.reference.package
         constant_package.config[layer_config.enforce_key] == 'strict'
       end
 
-      sig do
-        override
-          .params(reference: Packwerk::Reference)
-          .returns(String)
-      end
+      # @override
+      #: (Packwerk::Reference reference) -> String
       def message(reference)
         constant_package = Package.from(reference.constant.package, layers)
         referencing_package = Package.from(reference.package, layers)
@@ -84,7 +70,7 @@ module Packwerk
       end
 
       # TODO: Extract this out into a common helper, can call it StandardViolationHelpMessage.new(...) and implements .to_s
-      sig { params(reference: Reference).returns(String) }
+      #: (Reference reference) -> String
       def standard_help_message(reference)
         standard_message = <<~MESSAGE.chomp
           Inference details: this is a reference to #{reference.constant.name} which seems to be defined in #{reference.constant.location}.
@@ -94,14 +80,14 @@ module Packwerk
         standard_message.chomp
       end
 
-      sig { returns(Layers) }
+      #: -> Layers
       def layers
-        @layers ||= T.let(Layers.new, T.nilable(Packwerk::Layer::Layers))
+        @layers ||= Layers.new #: Packwerk::Layer::Layers?
       end
 
-      sig { returns(Config) }
+      #: -> Config
       def layer_config
-        @layer_config ||= T.let(Config.new, T.nilable(Config))
+        @layer_config ||= Config.new #: Config?
       end
     end
   end

data/lib/packwerk/layer/config.rb

@@ -4,40 +4,32 @@
 module Packwerk
   module Layer
     class Config
-      extend T::Sig
+      ARCHITECTURE_VIOLATION_TYPE = 'architecture'
+      ARCHITECTURE_ENFORCE = 'enforce_architecture'
+      LAYER_VIOLATION_TYPE = 'layer'
+      LAYER_ENFORCE = 'enforce_layers'
 
-      ARCHITECTURE_VIOLATION_TYPE = T.let('architecture', String)
-      ARCHITECTURE_ENFORCE = T.let('enforce_architecture', String)
-      LAYER_VIOLATION_TYPE = T.let('layer', String)
-      LAYER_ENFORCE = T.let('enforce_layers', String)
-
-      sig { void }
-      def initialize
-        @layers_key_configured = T.let(@layers_key_configured, T.nilable(T::Boolean))
-        @layers_list = T.let(@layers_list, T.nilable(T::Array[String]))
-      end
-
-      sig { returns(T::Array[String]) }
+      #: -> Array[String]
       def layers_list
-        @layers_list ||= YAML.load_file('packwerk.yml')[layers_key] || []
+        @layers_list ||= YAML.load_file('packwerk.yml')[layers_key] || [] #: Array[String]?
       end
 
-      sig { returns(T::Boolean) }
+      #: -> bool
       def layers_key_configured?
-        @layers_key_configured ||= YAML.load_file('packwerk.yml')['architecture_layers'].nil?
+        @layers_key_configured ||= YAML.load_file('packwerk.yml')['architecture_layers'].nil? #: bool?
       end
 
-      sig { returns(String) }
+      #: -> String
       def layers_key
         layers_key_configured? ? 'layers' : 'architecture_layers'
       end
 
-      sig { returns(String) }
+      #: -> String
       def violation_key
         layers_key_configured? ? LAYER_VIOLATION_TYPE : ARCHITECTURE_VIOLATION_TYPE
       end
 
-      sig { returns(String) }
+      #: -> String
       def enforce_key
         layers_key_configured? ? LAYER_ENFORCE : ARCHITECTURE_ENFORCE
       end

data/lib/packwerk/layer/layers.rb

@@ -4,15 +4,7 @@
 module Packwerk
   module Layer
     class Layers
-      extend T::Sig
-
-      sig { void }
-      def initialize
-        @names = T.let(@names, T.nilable(T::Set[String]))
-        @names_list = T.let(@names_list, T.nilable(T::Array[String]))
-      end
-
-      sig { params(layer: String).returns(Integer) }
+      #: (String layer) -> Integer
       def index_of(layer)
         index = names_list.reverse.find_index(layer)
         if index.nil?
@@ -22,14 +14,14 @@ module Packwerk
         index
       end
 
-      sig { returns(T::Set[String]) }
+      #: -> Set[String]
       def names
-        @names ||= Set.new(names_list)
+        @names ||= Set.new(names_list) #: Set[String]?
       end
 
-      sig { returns(T::Array[String]) }
+      #: -> Array[String]
       def names_list
-        @names_list ||= Config.new.layers_list
+        @names_list ||= Config.new.layers_list #: Array[String]?
       end
     end
   end

data/lib/packwerk/layer/package.rb

@@ -3,19 +3,29 @@
 
 module Packwerk
   module Layer
-    class Package < T::Struct
-      extend T::Sig
+    class Package
+      #: String?
+      attr_reader :layer
 
-      const :layer, T.nilable(String)
-      const :enforcement_setting, T.nilable(T.any(T::Boolean, String, T::Array[String]))
-      const :config, T::Hash[T.untyped, T.untyped]
+      #: (bool | String | Array[String])?
+      attr_reader :enforcement_setting
 
-      sig { returns(T::Boolean) }
+      #: Hash[untyped, untyped]
+      attr_reader :config
+
+      #: (layer: String?, enforcement_setting: (bool | String | Array[String])?, config: Hash[untyped, untyped]) -> void
+      def initialize(layer:, enforcement_setting:, config:)
+        @layer = layer
+        @enforcement_setting = enforcement_setting
+        @config = config
+      end
+
+      #: -> bool
       def enforces?
         enforcement_setting == true || enforcement_setting == 'strict'
       end
 
-      sig { params(other_package: Package, layers: Layers).returns(T::Boolean) }
+      #: (Package other_package, layers: Layers) -> bool
       def can_depend_on?(other_package, layers:)
         return true if !enforces?
 
@@ -28,9 +38,7 @@ module Packwerk
       end
 
       class << self
-        extend T::Sig
-
-        sig { params(package: ::Packwerk::Package, layers: Layers).returns(Package) }
+        #: (::Packwerk::Package package, Layers layers) -> Package
         def from(package, layers)
           config = package.config
 
@@ -45,9 +53,9 @@ module Packwerk
           end
 
           Package.new(
-            layer: layer,
+            layer:,
             enforcement_setting: config[Config.new.enforce_key],
-            config: config
+            config:
           )
         end
       end

data/lib/packwerk/layer/validator.rb

@@ -4,14 +4,14 @@
 module Packwerk
   module Layer
     class Validator
-      extend T::Sig
       include Packwerk::Validator
 
       Result = Packwerk::Validator::Result
 
-      sig { override.params(package_set: PackageSet, configuration: Configuration).returns(Result) }
+      # @override
+      #: (PackageSet package_set, Configuration configuration) -> Result
       def call(package_set, configuration)
-        results = T.let([], T::Array[Result])
+        results = [] #: Array[Result]
 
         package_set.each do |package|
           config = package.config
@@ -36,24 +36,23 @@ module Packwerk
         merge_results(results, separator: "\n---\n")
       end
 
-      sig { returns(Layers) }
+      #: -> Layers
       def layers
-        @layers ||= T.let(Layers.new, T.nilable(Packwerk::Layer::Layers))
+        @layers ||= Layers.new #: Packwerk::Layer::Layers?
       end
 
-      sig { returns(Config) }
+      #: -> Config
       def layer_config
-        @layer_config ||= T.let(Config.new, T.nilable(Config))
+        @layer_config ||= Config.new #: Config?
       end
 
-      sig { override.returns(T::Array[String]) }
+      # @override
+      #: -> Array[String]
       def permitted_keys
         [layer_config.enforce_key, 'layer']
       end
 
-      sig do
-        params(package: Package, config_file_path: String, config: T::Hash[T.untyped, T.untyped]).returns(Result)
-      end
+      #: (Package package, String config_file_path, Hash[untyped, untyped] config) -> Result
       def check_enforce_key(package, config_file_path, config)
         enforce_layer_present = !config[Config::LAYER_ENFORCE].nil?
         enforce_architecture_present = !config[Config::ARCHITECTURE_ENFORCE].nil?
@@ -73,9 +72,7 @@ module Packwerk
         end
       end
 
-      sig do
-        params(package: Package, config_file_path: String).returns(Result)
-      end
+      #: (Package package, String config_file_path) -> Result
       def check_layer_setting(package, config_file_path)
         layer = package.layer
         valid_layer = layer.nil? || layers.names.include?(layer)
@@ -95,9 +92,7 @@ module Packwerk
         end
       end
 
-      sig do
-        params(config_file_path: String, setting: T.untyped).returns(Result)
-      end
+      #: (String config_file_path, untyped setting) -> Result
       def check_enforce_layers_setting(config_file_path, setting)
         activated_value = [true, 'strict'].include?(setting)
         valid_value = [true, nil, false, 'strict'].include?(setting)

data/lib/packwerk/privacy/checker.rb

@@ -8,52 +8,52 @@ module Packwerk
   module Privacy
     # Checks whether a given reference references a private constant of another package.
     class Checker
-      extend T::Sig
       include Packwerk::Checker
 
-      VIOLATION_TYPE = T.let('privacy', String)
-      PUBLICIZED_SIGIL = T.let('pack_public: true', String)
-      PUBLICIZED_SIGIL_REGEX = T.let(/#.*pack_public:\s*true/, Regexp)
-      @publicized_locations = T.let({}, T::Hash[String, T::Boolean])
+      VIOLATION_TYPE = 'privacy'
+      PUBLICIZED_SIGIL = 'pack_public: true'
+      PUBLICIZED_SIGIL_REGEX = /pack_public:\s*true/
+      @publicized_locations = {} #: Hash[String, bool]
 
       class << self
-        extend T::Sig
+        #: Hash[String, bool]
+        attr_reader :publicized_locations
 
-        sig { returns(T::Hash[String, T::Boolean]) }
-        def publicized_locations
-          @publicized_locations
-        end
-
-        sig { params(location: String).returns(T::Boolean) }
+        #: (String location) -> bool
         def publicized_location?(location)
           unless publicized_locations.key?(location)
             publicized_locations[location] = check_for_publicized_sigil(location)
           end
 
-          T.must(publicized_locations[location])
+          publicized_locations.fetch(location)
         end
 
-        sig { params(location: String).returns(T::Boolean) }
+        #: (String location) -> bool
         def check_for_publicized_sigil(location)
           content_contains_sigil?(File.readlines(location))
         end
 
-        sig { params(lines: T::Array[String]).returns(T::Boolean) }
+        #: (Array[String] lines) -> bool
         def content_contains_sigil?(lines)
-          T.must(lines[0..4]).any? { |l| l =~ PUBLICIZED_SIGIL_REGEX }
+          lines.first(5).any? do |l|
+            # Only the sigil's existence matters, so it is enough to look for it after the
+            # line's first `#`. Searching from there keeps the scan linear in the length of
+            # the line, where matching `/#.*pack_public:\s*true/` would retry the `.*` scan
+            # once per `#` in the line.
+            comment_start = l.index('#')
+            !comment_start.nil? && PUBLICIZED_SIGIL_REGEX.match?(l, comment_start + 1)
+          end
         end
       end
 
-      sig { override.returns(String) }
+      # @override
+      #: -> String
       def violation_type
         VIOLATION_TYPE
       end
 
-      sig do
-        override
-          .params(reference: Packwerk::Reference)
-          .returns(T::Boolean)
-      end
+      # @override
+      #: (Packwerk::Reference reference) -> bool
       def invalid_reference?(reference)
         constant_package = reference.constant.package
         privacy_package = Package.from(constant_package)
@@ -69,11 +69,8 @@ module Packwerk
         explicitly_private_constant?(reference.constant, explicitly_private_constants: privacy_package.private_constants)
       end
 
-      sig do
-        override
-          .params(listed_offense: Packwerk::ReferenceOffense)
-          .returns(T::Boolean)
-      end
+      # @override
+      #: (Packwerk::ReferenceOffense listed_offense) -> bool
       def strict_mode_violation?(listed_offense)
         publishing_package = listed_offense.reference.constant.package
 
@@ -86,11 +83,8 @@ module Packwerk
         true
       end
 
-      sig do
-        override
-          .params(reference: Packwerk::Reference)
-          .returns(String)
-      end
+      # @override
+      #: (Packwerk::Reference reference) -> String
       def message(reference)
         source_desc = "'#{reference.package}'"
 
@@ -106,12 +100,7 @@ module Packwerk
 
       private
 
-      sig do
-        params(
-          constant: ConstantContext,
-          explicitly_private_constants: T::Array[String]
-        ).returns(T::Boolean)
-      end
+      #: (ConstantContext constant, explicitly_private_constants: Array[String]) -> bool
       def explicitly_private_constant?(constant, explicitly_private_constants:)
         return true if explicitly_private_constants.empty?
 
@@ -120,15 +109,12 @@ module Packwerk
           explicitly_private_constants.any? { |epc| constant.name.start_with?("#{epc}::") }
       end
 
-      sig do
-        params(privacy_option: T.nilable(T.any(T::Boolean, String, T::Array[String])))
-          .returns(T::Boolean)
-      end
+      #: ((bool | String | Array[String])? privacy_option) -> bool
       def enforcement_disabled?(privacy_option)
         [false, nil].include?(privacy_option)
       end
 
-      sig { params(reference: Reference).returns(String) }
+      #: (Reference reference) -> String
       def standard_help_message(reference)
         standard_message = <<~MESSAGE.chomp
           Inference details: this is a reference to #{reference.constant.name} which seems to be defined in #{reference.constant.location}.
@@ -138,7 +124,7 @@ module Packwerk
         standard_message.chomp
       end
 
-      sig { params(globs: T::Array[String], path: Pathname).returns(T::Boolean) }
+      #: (Array[String] globs, Pathname path) -> bool
       def exclude_from_strict?(globs, path)
         globs.any? do |glob|
           path.fnmatch(glob, File::FNM_EXTGLOB)

data/lib/packwerk/privacy/package.rb

@@ -3,25 +3,56 @@
 
 module Packwerk
   module Privacy
-    class Package < T::Struct
-      extend T::Sig
+    class Package
+      #: String
+      attr_reader :public_path
 
-      const :public_path, String
-      const :user_defined_public_path, T.nilable(String)
-      const :enforce_privacy, T.nilable(T.any(T::Boolean, String))
-      const :private_constants, T::Array[String]
-      const :ignored_private_constants, T::Array[String]
-      const :strict_privacy_ignored_patterns, T::Array[String]
+      #: String?
+      attr_reader :user_defined_public_path
 
-      sig { params(path: String).returns(T::Boolean) }
+      #: (bool | String)?
+      attr_reader :enforce_privacy
+
+      #: Array[String]
+      attr_reader :private_constants
+
+      #: Array[String]
+      attr_reader :ignored_private_constants
+
+      #: Array[String]
+      attr_reader :strict_privacy_ignored_patterns
+
+      #: (
+      #|   public_path: String,
+      #|   user_defined_public_path: String?,
+      #|   enforce_privacy: (bool | String)?,
+      #|   private_constants: Array[String],
+      #|   ignored_private_constants: Array[String],
+      #|   strict_privacy_ignored_patterns: Array[String]
+      #| ) -> void
+      def initialize(
+        public_path:,
+        user_defined_public_path:,
+        enforce_privacy:,
+        private_constants:,
+        ignored_private_constants:,
+        strict_privacy_ignored_patterns:
+      )
+        @public_path = public_path
+        @user_defined_public_path = user_defined_public_path
+        @enforce_privacy = enforce_privacy
+        @private_constants = private_constants
+        @ignored_private_constants = ignored_private_constants
+        @strict_privacy_ignored_patterns = strict_privacy_ignored_patterns
+      end
+
+      #: (String path) -> bool
       def public_path?(path)
         path.start_with?(public_path)
       end
 
       class << self
-        extend T::Sig
-
-        sig { params(package: ::Packwerk::Package).returns(Package) }
+        #: (::Packwerk::Package package) -> Package
         def from(package)
           Package.new(
             public_path: public_path_for(package),
@@ -33,7 +64,7 @@ module Packwerk
           )
         end
 
-        sig { params(package: ::Packwerk::Package).returns(T.nilable(String)) }
+        #: (::Packwerk::Package package) -> String?
         def user_defined_public_path(package)
           return unless package.config['public_path']
           return package.config['public_path'] if package.config['public_path'].end_with?('/')
@@ -41,7 +72,7 @@ module Packwerk
           "#{package.config['public_path']}/"
         end
 
-        sig { params(package: ::Packwerk::Package).returns(String) }
+        #: (::Packwerk::Package package) -> String
         def public_path_for(package)
           unprefixed_public_path = user_defined_public_path(package) || 'app/public/'
 

data/lib/packwerk/privacy/validator.rb

@@ -4,20 +4,18 @@
 module Packwerk
   module Privacy
     class Validator
-      extend T::Sig
       include Packwerk::Validator
 
       Result = Packwerk::Validator::Result
 
-      sig { override.params(package_set: PackageSet, configuration: Configuration).returns(Result) }
+      # @override
+      #: (PackageSet package_set, Configuration configuration) -> Result
       def call(package_set, configuration)
         privacy_settings = package_manifests_settings_for(configuration, 'enforce_privacy')
 
-        results = T.let([], T::Array[Result])
-
-        privacy_settings.each do |config_file_path, setting|
-          results << check_enforce_privacy_setting(config_file_path, setting)
-        end
+        results = privacy_settings.map do |config_file_path, setting|
+          check_enforce_privacy_setting(config_file_path, setting)
+        end #: Array[Result]
 
         results += verify_private_constants_setting(package_set, configuration)
 
@@ -29,17 +27,18 @@ module Packwerk
         merge_results(results, separator: "\n---\n")
       end
 
-      sig { override.returns(T::Array[String]) }
+      # @override
+      #: -> Array[String]
       def permitted_keys
-        %w[public_path enforce_privacy private_constants ignored_private_constants strict_privacy_ignored_patterns]
+        %w(public_path enforce_privacy private_constants ignored_private_constants strict_privacy_ignored_patterns)
       end
 
       private
 
-      sig { params(package_set: PackageSet, configuration: Configuration).returns(T::Array[Result]) }
+      #: (PackageSet package_set, Configuration configuration) -> Array[Result]
       def verify_private_constants_setting(package_set, configuration)
         private_constants_setting = package_manifests_settings_for(configuration, 'private_constants')
-        results = T.let([], T::Array[Result])
+        results = [] #: Array[Result]
         resolver = ConstantResolver.new(
           root_path: configuration.root_path,
           load_paths: configuration.load_paths,
@@ -65,19 +64,17 @@ module Packwerk
 
           constant_locations.each do |name, location|
             results << if location
-                         check_private_constant_location(configuration, package_set, name, location, config_file_path)
-                       else
-                         private_constant_unresolvable(name, config_file_path)
-                       end
+              check_private_constant_location(configuration, package_set, name, location, config_file_path)
+            else
+              private_constant_unresolvable(name, config_file_path)
+            end
           end
         end
 
         results
       end
 
-      sig do
-        params(config_file_path: String, setting: T.untyped).returns(Result)
-      end
+      #: (String config_file_path, untyped setting) -> Result
       def check_public_path(config_file_path, setting)
         if setting.is_a?(String) || setting.nil?
           Result.new(ok: true)
@@ -89,9 +86,7 @@ module Packwerk
         end
       end
 
-      sig do
-        params(config_file_path: String, setting: T.untyped).returns(Result)
-      end
+      #: (String config_file_path, untyped setting) -> Result
       def check_enforce_privacy_setting(config_file_path, setting)
         if [TrueClass, FalseClass, NilClass].include?(setting.class) || setting == 'strict'
           Result.new(ok: true)
@@ -103,10 +98,13 @@ module Packwerk
         end
       end
 
-      sig do
-        params(configuration: Configuration, package_set: PackageSet, name: T.untyped, location: T.untyped,
-               config_file_path: T.untyped).returns(Result)
-      end
+      #: (
+      #|   Configuration configuration,
+      #|   PackageSet package_set,
+      #|   untyped name,
+      #|   untyped location,
+      #|   untyped config_file_path
+      #| ) -> Result
       def check_private_constant_location(configuration, package_set, name, location, config_file_path)
         declared_package = package_set.package_from_path(relative_path(configuration, config_file_path))
         constant_package = package_set.package_from_path(location)
@@ -121,7 +119,7 @@ module Packwerk
         end
       end
 
-      sig { params(location: String, constant_package: Packwerk::Package, name: T.untyped).returns(Result) }
+      #: (String location, Packwerk::Package constant_package, untyped name) -> Result
       def check_for_publicized_constant(location, constant_package, name)
         if Packwerk::Privacy::Checker.publicized_location?(location)
           sigil = Packwerk::Privacy::Checker::PUBLICIZED_SIGIL
@@ -138,7 +136,7 @@ module Packwerk
         end
       end
 
-      sig { params(constants: T.untyped, config_file_path: String).returns(T::Array[Result]) }
+      #: (untyped constants, String config_file_path) -> Array[Result]
       def assert_constants_can_be_loaded(constants, config_file_path)
         constants.map do |constant|
           if constant.start_with?('::')
@@ -149,13 +147,13 @@ module Packwerk
                           'prefixed with the top-level namespace operator `::`.'
             Result.new(
               ok: false,
-              error_value: error_value
+              error_value:
             )
           end
         end
       end
 
-      sig { params(name: T.untyped, config_file_path: T.untyped).returns(Result) }
+      #: (untyped name, untyped config_file_path) -> Result
       def private_constant_unresolvable(name, config_file_path)
         explicit_filepath = "#{(name.start_with?('::') ? name[2..] : name).underscore}.rb"
 

data/lib/packwerk/visibility/checker.rb

@@ -8,21 +8,18 @@ module Packwerk
   module Visibility
     # Checks whether a given reference references a constant from a package that does not permit visibility
     class Checker
-      extend T::Sig
       include Packwerk::Checker
 
-      VIOLATION_TYPE = T.let('visibility', String)
+      VIOLATION_TYPE = 'visibility'
 
-      sig { override.returns(String) }
+      # @override
+      #: -> String
       def violation_type
         VIOLATION_TYPE
       end
 
-      sig do
-        override
-          .params(reference: Packwerk::Reference)
-          .returns(T::Boolean)
-      end
+      # @override
+      #: (Packwerk::Reference reference) -> bool
       def invalid_reference?(reference)
         constant_package = reference.constant.package
         visibility_package = Package.from(constant_package)
@@ -32,21 +29,15 @@ module Packwerk
         !visibility_package.visible_to.include?(reference.package.name)
       end
 
-      sig do
-        override
-          .params(listed_offense: Packwerk::ReferenceOffense)
-          .returns(T::Boolean)
-      end
+      # @override
+      #: (Packwerk::ReferenceOffense listed_offense) -> bool
       def strict_mode_violation?(listed_offense)
         publishing_package = listed_offense.reference.constant.package
         publishing_package.config['enforce_visibility'] == 'strict'
       end
 
-      sig do
-        override
-          .params(reference: Packwerk::Reference)
-          .returns(String)
-      end
+      # @override
+      #: (Packwerk::Reference reference) -> String
       def message(reference)
         source_desc = "'#{reference.package}'"
 
@@ -62,15 +53,12 @@ module Packwerk
 
       private
 
-      sig do
-        params(visibility_option: T.nilable(T.any(T::Boolean, String)))
-          .returns(T::Boolean)
-      end
+      #: ((bool | String)? visibility_option) -> bool
       def enforcement_disabled?(visibility_option)
         [false, nil].include?(visibility_option)
       end
 
-      sig { params(reference: Reference).returns(String) }
+      #: (Reference reference) -> String
       def standard_help_message(reference)
         standard_message = <<~MESSAGE.chomp
           Inference details: this is a reference to #{reference.constant.name} which seems to be defined in #{reference.constant.location}.

data/lib/packwerk/visibility/package.rb

@@ -3,16 +3,21 @@
 
 module Packwerk
   module Visibility
-    class Package < T::Struct
-      extend T::Sig
+    class Package
+      #: Array[String]
+      attr_reader :visible_to
 
-      const :visible_to, T::Array[String]
-      const :enforce_visibility, T.nilable(T.any(T::Boolean, String))
+      #: (bool | String)?
+      attr_reader :enforce_visibility
 
-      class << self
-        extend T::Sig
+      #: (visible_to: Array[String], enforce_visibility: (bool | String)?) -> void
+      def initialize(visible_to:, enforce_visibility:)
+        @visible_to = visible_to
+        @enforce_visibility = enforce_visibility
+      end
 
-        sig { params(package: ::Packwerk::Package).returns(Package) }
+      class << self
+        #: (::Packwerk::Package package) -> Package
         def from(package)
           Package.new(
             visible_to: package.config['visible_to'] || [],

data/lib/packwerk/visibility/validator.rb

@@ -4,15 +4,15 @@
 module Packwerk
   module Visibility
     class Validator
-      extend T::Sig
       include Packwerk::Validator
 
       Result = Packwerk::Validator::Result
 
-      sig { override.params(package_set: PackageSet, configuration: Configuration).returns(Result) }
+      # @override
+      #: (PackageSet package_set, Configuration configuration) -> Result
       def call(package_set, configuration)
         visible_settings = package_manifests_settings_for(configuration, 'visible_to')
-        results = T.let([], T::Array[Result])
+        results = [] #: Array[Result]
 
         all_package_names = package_set.to_set(&:name)
 
@@ -50,9 +50,10 @@ module Packwerk
         merge_results(results, separator: "\n---\n")
       end
 
-      sig { override.returns(T::Array[String]) }
+      # @override
+      #: -> Array[String]
       def permitted_keys
-        %w[visible_to enforce_visibility]
+        %w(visible_to enforce_visibility)
       end
     end
   end

data/lib/packwerk-extensions.rb

@@ -1,7 +1,6 @@
 # typed: strict
 # frozen_string_literal: true
 
-require 'sorbet-runtime'
 require 'packwerk'
 
 require 'packwerk/privacy/checker'

metadata

@@ -1,14 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: packwerk-extensions
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.4.0
 platform: ruby
 authors:
 - Gusto Engineers
-autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-06-28 00:00:00.000000000 Z
+date: 1980-01-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: packwerk
@@ -16,14 +15,14 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 2.2.1
+        version: '3'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 2.2.1
+        version: '3'
 - !ruby/object:Gem::Dependency
   name: railties
   requirement: !ruby/object:Gem::Requirement
@@ -38,20 +37,6 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: 6.0.0
-- !ruby/object:Gem::Dependency
-  name: sorbet-runtime
-  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: zeitwerk
   requirement: !ruby/object:Gem::Requirement
@@ -137,7 +122,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: sorbet
+  name: rubocop-gusto
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -151,7 +136,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: sorbet-static
+  name: sorbet
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -209,7 +194,6 @@ metadata:
   source_code_uri: https://github.com/rubyatscale/packwerk-extensions
   changelog_uri: https://github.com/rubyatscale/packwerk-extensions/releases
   allowed_push_host: https://rubygems.org
-post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -217,15 +201,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '2.7'
+      version: '3.3'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.11
-signing_key:
+rubygems_version: 3.6.9
 specification_version: 4
 summary: A collection of extensions for packwerk packages.
 test_files: []