packwerk 1.1.1 → 1.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: da27cf2b0d19f98831fc32b685ab58ab5a1abeacad532eff698787ef0dd8892d
-  data.tar.gz: 2b7d574417307d4b2d4aa0ae8e85665e5a701bc304307abd0302d02ebb4b6060
+  metadata.gz: cd008f86d84fd0224aac9d8f92bc104123f23869e9381c947b3e51864523c947
+  data.tar.gz: debf7f89ce8f8419a02f2af84c3f1900c7bc2f2ac79cce535284e3e697133d74
 SHA512:
-  metadata.gz: 730635a8851f68e9b43b25454f56bfe7296a42e76da335ab4b14b5fb2562a09c758107b9b25ab8d8455bd722e28079023568d84a6621d30b77b5d709c4dd5bd9
-  data.tar.gz: 97e9941ee9756c33dc952dca17ca6fe255ad8e2605584f3715616ff8e4a2a1caf380a079c0954435fff54ff83a7a92000176d9d6aa30858ef67f263958d2d105
+  metadata.gz: 2bf12776a5e5cd4f3f9d06f3bbabb3d9b0c6d873325dba9a7bc43dc49ffedbc119678b77a2087cface6428bf564e037b75386abb8fca2d06a313e617461db53a
+  data.tar.gz: d6ca7a42dea1c5338c40e89b6fe6b14baa43372cf44e22af3f19763ee1048c03629e34f4466b632e7f5b6d82932b8e05b2d02d5e26ebf91852334b9f2ca6d5b2

data/Gemfile.lock

@@ -85,7 +85,7 @@ GIT
 PATH
   remote: .
   specs:
-    packwerk (1.1.1)
+    packwerk (1.1.2)
       activesupport (>= 5.2)
       ast
       better_html

data/README.md

@@ -3,7 +3,7 @@
 Packwerk is a Ruby gem used to enforce boundaries and modularize Rails applications.
 
 Packwerk can be used to:
-* Combine group of files into packages
+* Combine groups of files into packages
 * Define package-level constant visibility (i.e. have publicly accessible constants)
 * Enforce privacy (inbound) and dependency (outbound) boundaries between packages
 * Help existing codebases to become more modular without obstructing development

data/exe/packwerk

@@ -3,4 +3,4 @@
 
 require "packwerk"
 
-Packwerk::Cli.new(style: Packwerk::OutputStyles::Coloured).run(ARGV.dup)
+Packwerk::Cli.new(style: Packwerk::OutputStyles::Coloured.new).run(ARGV.dup)

data/lib/packwerk.rb

@@ -27,7 +27,9 @@ require "packwerk/graph"
 require "packwerk/inflector"
 require "packwerk/node_processor"
 require "packwerk/node_visitor"
-require "packwerk/output_styles"
+require "packwerk/output_style"
+require "packwerk/output_styles/plain"
+require "packwerk/output_styles/coloured"
 require "packwerk/package"
 require "packwerk/package_set"
 require "packwerk/parsers"

data/lib/packwerk/application_load_paths.rb

@@ -28,8 +28,9 @@ module Packwerk
           .select { |railtie| railtie.is_a?(Rails::Engine) }
           .push(Rails.application)
           .flat_map do |engine|
-          (engine.config.autoload_paths + engine.config.eager_load_paths + engine.config.autoload_once_paths).uniq
-        end
+            paths = (engine.config.autoload_paths + engine.config.eager_load_paths + engine.config.autoload_once_paths)
+            paths.map(&:to_s).uniq
+          end
       end
 
       sig do

data/lib/packwerk/application_validator.rb

@@ -35,16 +35,7 @@ module Packwerk
         check_root_package_exists,
       ]
 
-      results.reject!(&:ok?)
-
-      if results.empty?
-        Result.new(true)
-      else
-        Result.new(
-          false,
-          results.map(&:error_value).join("\n===\n")
-        )
-      end
+      merge_results(results)
     end
 
     def check_autoload_path_cache
@@ -65,51 +56,37 @@ module Packwerk
     def check_package_manifests_for_privacy
       privacy_settings = package_manifests_settings_for("enforce_privacy")
 
-      autoload_paths = @configuration.load_paths
-
       resolver = ConstantResolver.new(
         root_path: @configuration.root_path,
-        load_paths: autoload_paths
+        load_paths: @configuration.load_paths
       )
 
-      errors = []
+      results = []
 
-      privacy_settings.each do |filepath, setting|
+      privacy_settings.each do |config_file_path, setting|
         next unless setting.is_a?(Array)
+        constants = setting
 
-        setting.each do |constant|
-          # make sure the constant can be loaded
-          constant.constantize # rubocop:disable Sorbet/ConstantsFromStrings
-          context = resolver.resolve(constant)
+        assert_constants_can_be_loaded(constants)
 
-          unless context
-            errors << "#{constant}, listed in #{filepath.inspect}, could not be resolved"
-            next
-          end
-
-          expected_filename = constant.underscore + ".rb"
+        constant_locations = constants.map { |c| [c, resolver.resolve(c)&.location] }
 
-          # We don't support all custom inflections yet, so we may accidentally resolve constants to the
-          # file that defines their parent namespace. This restriction makes sure that we don't.
-          next if context.location.end_with?(expected_filename)
-
-          errors << "Explicitly private constants need to have their own files.\n"\
-            "#{constant}, listed in #{filepath.inspect}, was resolved to #{context.location.inspect}.\n"\
-            "It should be in something like #{expected_filename.inspect}"
+        constant_locations.each do |name, location|
+          results << if location
+            check_private_constant_location(name, location, config_file_path)
+          else
+            private_constant_unresolvable(name, config_file_path)
+          end
         end
       end
 
-      if errors.empty?
-        Result.new(true)
-      else
-        Result.new(false, errors.join("\n---\n"))
-      end
+      merge_results(results, separator: "\n---\n")
     end
 
     def check_package_manifest_syntax
       errors = []
 
-      package_manifests(package_glob).each do |f|
+      package_manifests.each do |f|
         hash = YAML.load_file(f)
         next unless hash
 
@@ -193,24 +170,16 @@ module Packwerk
         end
       end
 
-      errors = results.reject(&:ok?)
-
-      if errors.empty?
-        Result.new(true)
-      else
-        Result.new(
-          false,
-          "Inflections specified in #{inflections_file} don't line up with application!\n" +
-            errors.map(&:error_value).join("\n")
-        )
-      end
+      merge_results(
+        results,
+        separator: "\n",
+        errors_headline: "Inflections specified in #{inflections_file} don't line up with application!\n"
+      )
     end
 
     def check_acyclic_graph
-      packages = Packwerk::PackageSet.load_all_from(@configuration.root_path)
-
-      edges = packages.flat_map do |package|
-        package.dependencies.map { |dependency| [package, packages.fetch(dependency)] }
+      edges = package_set.flat_map do |package|
+        package.dependencies.map { |dependency| [package, package_set.fetch(dependency)] }
       end
       dependency_graph = Packwerk::Graph.new(*edges)
 
@@ -316,8 +285,7 @@ module Packwerk
     private
 
     def package_manifests_settings_for(setting)
-      package_manifests(package_glob)
-        .map { |f| [f, (YAML.load_file(File.join(f)) || {})[setting]] }
+      package_manifests.map { |f| [f, (YAML.load_file(File.join(f)) || {})[setting]] }
     end
 
     def format_yaml_strings(list)
@@ -328,13 +296,17 @@ module Packwerk
       @configuration.package_paths || "**"
     end
 
-    def package_manifests(glob_pattern)
+    def package_manifests(glob_pattern = package_glob)
       PackageSet.package_paths(@configuration.root_path, glob_pattern)
         .map { |f| File.realpath(f) }
     end
 
     def relative_paths(paths)
-      paths.map { |path| Pathname.new(path).relative_path_from(@configuration.root_path) }
+      paths.map { |path| relative_path(path) }
+    end
+
+    def relative_path(path)
+      Pathname.new(path).relative_path_from(@configuration.root_path)
     end
 
     def invalid_package_path?(path)
@@ -344,5 +316,54 @@ module Packwerk
       package_path = File.join(@configuration.root_path, path, Packwerk::PackageSet::PACKAGE_CONFIG_FILENAME)
       !File.file?(package_path)
     end
+
+    def assert_constants_can_be_loaded(constants)
+      constants.each(&:constantize)
+      nil
+    end
+
+    def private_constant_unresolvable(name, config_file_path)
+      explicit_filepath = (name.start_with?("::") ? name[2..-1] : name).underscore + ".rb"
+
+      Result.new(
+        false,
+        "'#{name}', listed in #{config_file_path}, could not be resolved.\n"\
+        "This is probably because it is an autovivified namespace - a namespace module that doesn't have a\n"\
+        "file explicitly defining it. Packwerk currently doesn't support declaring autovivified namespaces as\n"\
+        "private. Add a #{explicit_filepath} file to explicitly define the constant."
+      )
+    end
+
+    def check_private_constant_location(name, location, config_file_path)
+      declared_package = package_set.package_from_path(relative_path(config_file_path))
+      constant_package = package_set.package_from_path(location)
+
+      if constant_package == declared_package
+        Result.new(true)
+      else
+        Result.new(
+          false,
+          "'#{name}' is declared as private in the '#{declared_package}' package but appears to be "\
+          "defined\nin the '#{constant_package}' package. Packwerk resolved it to #{location}."
+        )
+      end
+    end
+
+    def package_set
+      @package_set ||= Packwerk::PackageSet.load_all_from(@configuration.root_path, package_pathspec: package_glob)
+    end
+
+    def merge_results(results, separator: "\n===\n", errors_headline: "")
+      results.reject!(&:ok?)
+
+      if results.empty?
+        Result.new(true)
+      else
+        Result.new(
+          false,
+          errors_headline + results.map(&:error_value).join(separator)
+        )
+      end
+    end
   end
 end

data/lib/packwerk/association_inspector.rb

@@ -1,4 +1,4 @@
-# typed: true
+# typed: strict
 # frozen_string_literal: true
 
 require "packwerk/constant_name_inspector"
@@ -7,20 +7,32 @@ require "packwerk/node"
 module Packwerk
   # Extracts the implicit constant reference from an active record association
   class AssociationInspector
+    extend T::Sig
     include ConstantNameInspector
 
-    RAILS_ASSOCIATIONS = %i(
-      belongs_to
-      has_many
-      has_one
-      has_and_belongs_to_many
-    ).to_set
+    CustomAssociations = T.type_alias { T.any(T::Array[Symbol], T::Set[Symbol]) }
 
+    RAILS_ASSOCIATIONS = T.let(
+      %i(
+        belongs_to
+        has_many
+        has_one
+        has_and_belongs_to_many
+      ).to_set,
+      CustomAssociations
+    )
+
+    sig { params(inflector: Inflector, custom_associations: CustomAssociations).void }
     def initialize(inflector:, custom_associations: Set.new)
       @inflector = inflector
-      @associations = RAILS_ASSOCIATIONS + custom_associations
+      @associations = T.let(RAILS_ASSOCIATIONS + custom_associations, CustomAssociations)
     end
 
+    sig do
+      override
+        .params(node: AST::Node, ancestors: T::Array[AST::Node])
+        .returns(T.nilable(String))
+    end
     def constant_name_from_node(node, ancestors:)
       return unless Node.method_call?(node)
       return unless association?(node)
@@ -38,11 +50,13 @@ module Packwerk
 
     private
 
+    sig { params(node: AST::Node).returns(T::Boolean) }
     def association?(node)
       method_name = Node.method_name(node)
       @associations.include?(method_name)
     end
 
+    sig { params(arguments: T::Array[AST::Node]).returns(T.nilable(AST::Node)) }
     def custom_class_name(arguments)
       association_options = arguments.detect { |n| Node.hash?(n) }
       return unless association_options
@@ -50,6 +64,7 @@ module Packwerk
       Node.value_from_hash(association_options, :class_name)
     end
 
+    sig { params(arguments: T::Array[AST::Node]).returns(T.any(T.nilable(Symbol), T.nilable(String))) }
     def association_name(arguments)
       return unless Node.symbol?(arguments[0])
 

data/lib/packwerk/cache_deprecated_references.rb

@@ -1,4 +1,4 @@
-# typed: true
+# typed: strict
 # frozen_string_literal: true
 
 require "sorbet-runtime"
@@ -15,9 +15,15 @@ module Packwerk
     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[String, Packwerk::DeprecatedReferences])
+      @deprecated_references = T.let(deprecated_references, T::Hash[Packwerk::Package, Packwerk::DeprecatedReferences])
     end
 
     sig do
@@ -33,6 +39,7 @@ module Packwerk
 
     private
 
+    sig { params(package: Packwerk::Package).returns(Packwerk::DeprecatedReferences) }
     def deprecated_references_for(package)
       @deprecated_references[package] ||= Packwerk::DeprecatedReferences.new(
         package,
@@ -40,6 +47,7 @@ module Packwerk
       )
     end
 
+    sig { params(package: Packwerk::Package).returns(String) }
     def deprecated_references_file_for(package)
       File.join(@root_path, package.name, "deprecated_references.yml")
     end

data/lib/packwerk/checker.rb

@@ -11,6 +11,9 @@ module Packwerk
 
     interface!
 
+    sig { returns(ViolationType).abstract }
+    def violation_type; end
+
     sig { params(reference: Reference, reference_lister: ReferenceLister).returns(T::Boolean).abstract }
     def invalid_reference?(reference, reference_lister); end
 

data/lib/packwerk/checking_deprecated_references.rb

@@ -1,4 +1,4 @@
-# typed: true
+# typed: strict
 # frozen_string_literal: true
 
 require "sorbet-runtime"
@@ -10,9 +10,10 @@ module Packwerk
     extend T::Sig
     include ReferenceLister
 
+    sig { params(root_path: String).void }
     def initialize(root_path)
       @root_path = root_path
-      @deprecated_references = {}
+      @deprecated_references = T.let({}, T::Hash[Packwerk::Package, Packwerk::DeprecatedReferences])
     end
 
     sig do
@@ -26,6 +27,7 @@ module Packwerk
 
     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,
@@ -33,6 +35,7 @@ module Packwerk
       )
     end
 
+    sig { params(package: Packwerk::Package).returns(String) }
     def deprecated_references_file_for(package)
       File.join(@root_path, package.name, "deprecated_references.yml")
     end

data/lib/packwerk/cli.rb

@@ -10,7 +10,8 @@ require "packwerk/files_for_processing"
 require "packwerk/formatters/offenses_formatter"
 require "packwerk/formatters/progress_formatter"
 require "packwerk/inflector"
-require "packwerk/output_styles"
+require "packwerk/output_style"
+require "packwerk/output_styles/plain"
 require "packwerk/run_context"
 require "packwerk/updating_deprecated_references"
 require "packwerk/checking_deprecated_references"
@@ -23,7 +24,16 @@ module Packwerk
     extend T::Sig
     include OffenseProgressMarker
 
-    def initialize(run_context: nil, configuration: nil, out: $stdout, err_out: $stderr, style: OutputStyles::Plain)
+    sig do
+      params(
+        run_context: T.nilable(Packwerk::RunContext),
+        configuration: T.nilable(Configuration),
+        out: T.any(StringIO, IO),
+        err_out: T.any(StringIO, IO),
+        style: Packwerk::OutputStyle
+      ).void
+    end
+    def initialize(run_context: nil, configuration: nil, out: $stdout, err_out: $stderr, style: OutputStyles::Plain.new)
       @out = out
       @err_out = err_out
       @style = style

data/lib/packwerk/commands/detect_stale_violations_command.rb

@@ -49,7 +49,7 @@ module Packwerk
       sig { returns(Result) }
       def calculate_result
         result_status = !reference_lister.stale_violations?
-        message = "There were stale violations found, please run `packwerk update`"
+        message = "There were stale violations found, please run `packwerk update-deprecations`"
         if result_status
           message = "No stale violations detected"
         end

data/lib/packwerk/const_node_inspector.rb

@@ -1,4 +1,4 @@
-# typed: true
+# typed: strict
 # frozen_string_literal: true
 
 require "packwerk/constant_name_inspector"
@@ -6,15 +6,21 @@ require "packwerk/constant_name_inspector"
 module Packwerk
   # Extracts a constant name from an AST node of type :const
   class ConstNodeInspector
+    extend T::Sig
     include ConstantNameInspector
 
+    sig do
+      override
+        .params(node: AST::Node, ancestors: T::Array[AST::Node])
+        .returns(T.nilable(String))
+    end
     def constant_name_from_node(node, ancestors:)
       return nil unless Node.constant?(node)
       parent = ancestors.first
       return nil unless root_constant?(parent)
 
       if parent && constant_in_module_or_class_definition?(node, parent: parent)
-        fully_qualify_constant(node, ancestors: ancestors)
+        fully_qualify_constant(ancestors)
       else
         begin
           Node.constant_name(node)
@@ -28,27 +34,22 @@ module Packwerk
 
     # Only process the root `const` node for namespaced constant references. For example, in the
     # reference `Spam::Eggs::Thing`, we only process the const node associated with `Spam`.
+    sig { params(parent: T.nilable(AST::Node)).returns(T::Boolean) }
     def root_constant?(parent)
       !(parent && Node.constant?(parent))
     end
 
+    sig { params(node: AST::Node, parent: AST::Node).returns(T.nilable(T::Boolean)) }
     def constant_in_module_or_class_definition?(node, parent:)
       parent_name = Node.module_name_from_definition(parent)
       parent_name && parent_name == Node.constant_name(node)
     end
 
-    def fully_qualify_constant(node, ancestors:)
+    sig { params(ancestors: T::Array[AST::Node]).returns(String) }
+    def fully_qualify_constant(ancestors)
       # We're defining a class with this name, in which case the constant is implicitly fully qualified by its
       # enclosing namespace
-      name = Node.parent_module_name(ancestors: ancestors)
-      name ||= generate_qualified_constant(node, ancestors)
-      "::" + name
-    end
-
-    def generate_qualified_constant(node, ancestors:)
-      namespace_path = Node.enclosing_namespace_path(node, ancestors: ancestors)
-      constant_name = Node.constant_name(node)
-      namespace_path.push(constant_name).join("::")
+      "::" + Node.parent_module_name(ancestors: ancestors)
     end
   end
 end

data/lib/packwerk/dependency_checker.rb

@@ -1,4 +1,4 @@
-# typed: true
+# typed: strict
 # frozen_string_literal: true
 
 require "packwerk/violation_type"
@@ -6,20 +6,28 @@ require "packwerk/checker"
 
 module Packwerk
   class DependencyChecker
+    extend T::Sig
     include Checker
 
+    sig { override.returns(ViolationType) }
     def violation_type
       ViolationType::Dependency
     end
 
+    sig do
+      override
+        .params(reference: Packwerk::Reference, reference_lister: Packwerk::ReferenceLister)
+        .returns(T::Boolean)
+    end
     def invalid_reference?(reference, reference_lister)
-      return unless reference.source_package
-      return unless reference.source_package.enforce_dependencies?
-      return if reference.source_package.dependency?(reference.constant.package)
-      return if reference_lister.listed?(reference, violation_type: violation_type)
+      return false unless reference.source_package
+      return false unless reference.source_package.enforce_dependencies?
+      return false if reference.source_package.dependency?(reference.constant.package)
+      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)
       "Dependency violation: #{reference.constant.name} belongs to '#{reference.constant.package}', but " \
         "'#{reference.source_package}' does not specify a dependency on " \

data/lib/packwerk/deprecated_references.rb

@@ -3,7 +3,6 @@
 
 require "sorbet-runtime"
 require "yaml"
-require "sorbet-runtime"
 
 require "packwerk/reference"
 require "packwerk/reference_lister"
@@ -14,6 +13,7 @@ module Packwerk
     extend T::Sig
     include ReferenceLister
 
+    sig { params(package: Packwerk::Package, filepath: String).void }
     def initialize(package, filepath)
       @package = package
       @filepath = filepath
@@ -35,6 +35,7 @@ module Packwerk
       violated_constants_found.fetch("violations", []).include?(violation_type.serialize)
     end
 
+    sig { params(reference: Packwerk::Reference, violation_type: String).void }
     def add_entries(reference, violation_type)
       package_violations = @new_entries.fetch(reference.constant.package.name, {})
       entries_for_file = package_violations[reference.constant.name] ||= {}
@@ -66,6 +67,7 @@ module Packwerk
       end
     end
 
+    sig { void }
     def dump
       if @new_entries.empty?
         File.delete(@filepath) if File.exist?(@filepath)
@@ -88,6 +90,7 @@ module Packwerk
 
     private
 
+    sig { returns(Hash) }
     def prepare_entries_for_dump
       @new_entries.each do |package_name, package_violations|
         package_violations.each do |_, entries_for_file|
@@ -100,6 +103,7 @@ module Packwerk
       @new_entries = @new_entries.sort.to_h
     end
 
+    sig { returns(Hash) }
     def deprecated_references
       @deprecated_references ||= if File.exist?(@filepath)
         YAML.load_file(@filepath) || {}

data/lib/packwerk/formatters/offenses_formatter.rb

@@ -5,17 +5,16 @@ require "benchmark"
 require "sorbet-runtime"
 
 require "packwerk/inflector"
-require "packwerk/output_styles"
+require "packwerk/output_style"
+require "packwerk/output_styles/plain"
 
 module Packwerk
   module Formatters
     class OffensesFormatter
       extend T::Sig
 
-      sig do
-        params(style: T.any(T.class_of(OutputStyles::Plain), T.class_of(OutputStyles::Coloured))).void
-      end
-      def initialize(style: OutputStyles::Plain)
+      sig { params(style: OutputStyle).void }
+      def initialize(style: OutputStyles::Plain.new)
         @style = style
       end
 

data/lib/packwerk/formatters/progress_formatter.rb

@@ -4,12 +4,16 @@
 require "benchmark"
 
 require "packwerk/inflector"
-require "packwerk/output_styles"
+require "packwerk/output_style"
+require "packwerk/output_styles/plain"
 
 module Packwerk
   module Formatters
     class ProgressFormatter
-      def initialize(out, style: OutputStyles::Plain)
+      extend T::Sig
+
+      sig { params(out: T.any(StringIO, IO), style: OutputStyle).void }
+      def initialize(out, style: OutputStyles::Plain.new)
         @out = out
         @style = style
       end

data/lib/packwerk/node.rb

@@ -9,6 +9,8 @@ module Packwerk
     Location = Struct.new(:line, :column)
 
     class << self
+      extend T::Sig
+
       def class_or_module_name(class_or_module_node)
         case type_of(class_or_module_node)
         when CLASS, MODULE
@@ -178,6 +180,7 @@ module Packwerk
         class_node.children[1]
       end
 
+      sig { params(ancestors: T::Array[AST::Node]).returns(String) }
       def parent_module_name(ancestors:)
         definitions = ancestors
           .select { |n| [CLASS, MODULE, CONSTANT_ASSIGNMENT, BLOCK].include?(type_of(n)) }

data/lib/packwerk/offense.rb

@@ -4,7 +4,8 @@
 require "parser/source/map"
 require "sorbet-runtime"
 
-require "packwerk/output_styles"
+require "packwerk/output_style"
+require "packwerk/output_styles/plain"
 
 module Packwerk
   class Offense
@@ -23,11 +24,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/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_set.rb

@@ -60,7 +60,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/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/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: packwerk
 version: !ruby/object:Gem::Version
-  version: 1.1.1
+  version: 1.1.2
 platform: ruby
 authors:
 - Shopify Inc.
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-12-09 00:00:00.000000000 Z
+date: 2021-01-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -223,7 +223,9 @@ files:
 - lib/packwerk/node_processor_factory.rb
 - lib/packwerk/node_visitor.rb
 - lib/packwerk/offense.rb
-- lib/packwerk/output_styles.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/parsed_constant_definitions.rb

data/lib/packwerk/output_styles.rb

@@ -1,41 +0,0 @@
-# typed: true
-# frozen_string_literal: true
-
-module Packwerk
-  module OutputStyles
-    class Plain
-      class << self
-        def reset
-          ""
-        end
-
-        def filename
-          ""
-        end
-
-        def error
-          ""
-        end
-      end
-    end
-
-    # See https://en.wikipedia.org/wiki/ANSI_escape_code#3/4_bit for ANSI escape colour codes
-    class Coloured
-      class << self
-        def reset
-          "\033[m"
-        end
-
-        def filename
-          # 36 is foreground cyan
-          "\033[36m"
-        end
-
-        def error
-          # 31 is foreground red
-          "\033[31m"
-        end
-      end
-    end
-  end
-end