packwerk 2.1.0 → 2.1.1

data/lib/packwerk/files_for_processing.rb

@@ -1,20 +1,40 @@
-# typed: true
+# typed: strict
 # frozen_string_literal: true
 
 module Packwerk
   class FilesForProcessing
+    extend T::Sig
+
     class << self
-      def fetch(paths:, configuration:, ignore_nested_packages: false)
-        new(paths, configuration, ignore_nested_packages).files
+      extend T::Sig
+
+      sig do
+        params(
+          relative_file_paths: T::Array[String],
+          configuration: Configuration,
+          ignore_nested_packages: T::Boolean
+        ).returns(T::Array[String])
+      end
+      def fetch(relative_file_paths:, configuration:, ignore_nested_packages: false)
+        new(relative_file_paths, configuration, ignore_nested_packages).files
       end
     end
 
-    def initialize(paths, configuration, ignore_nested_packages)
-      @paths = paths
+    sig do
+      params(
+        relative_file_paths: T::Array[String],
+        configuration: Configuration,
+        ignore_nested_packages: T::Boolean
+      ).void
+    end
+    def initialize(relative_file_paths, configuration, ignore_nested_packages)
+      @relative_file_paths = relative_file_paths
       @configuration = configuration
       @ignore_nested_packages = ignore_nested_packages
+      @custom_files = T.let(nil, T.nilable(T::Array[String]))
     end
 
+    sig { returns(T::Array[String]) }
     def files
       include_files = if custom_files.empty?
         configured_included_files
@@ -27,50 +47,57 @@ module Packwerk
 
     private
 
+    sig { returns(T::Array[String]) }
     def custom_files
-      @custom_files ||= @paths.flat_map do |path|
-        path = File.expand_path(path, @configuration.root_path)
-        if File.file?(path)
-          path
+      @custom_files ||= @relative_file_paths.flat_map do |relative_file_path|
+        absolute_file_path = File.expand_path(relative_file_path, @configuration.root_path)
+        if File.file?(absolute_file_path)
+          absolute_file_path
         else
-          custom_included_files(path)
+          custom_included_files(absolute_file_path)
         end
       end
     end
 
-    def custom_included_files(path)
+    sig { params(absolute_file_path: String).returns(T::Array[String]) }
+    def custom_included_files(absolute_file_path)
       # Note, assuming include globs are always relative paths
       absolute_includes = @configuration.include.map do |glob|
         File.expand_path(glob, @configuration.root_path)
       end
 
-      files = Dir.glob([File.join(path, "**", "*")]).select do |file_path|
+      absolute_files = Dir.glob([File.join(absolute_file_path, "**", "*")]).select do |absolute_path|
         absolute_includes.any? do |pattern|
-          File.fnmatch?(pattern, file_path, File::FNM_EXTGLOB)
+          File.fnmatch?(pattern, absolute_path, File::FNM_EXTGLOB)
         end
       end
 
       if @ignore_nested_packages
-        nested_packages_paths = Dir.glob(File.join(path, "*", "**", "package.yml"))
-        nested_packages_globs = nested_packages_paths.map { |npp| npp.gsub("package.yml", "**/*") }
-        nested_packages_globs.each do |glob|
-          files -= Dir.glob(glob)
+        nested_packages_absolute_file_paths = Dir.glob(File.join(absolute_file_path, "*", "**", "package.yml"))
+        nested_packages_absolute_globs = nested_packages_absolute_file_paths.map do |npp|
+          npp.gsub("package.yml", "**/*")
+        end
+        nested_packages_absolute_globs.each do |absolute_glob|
+          absolute_files -= Dir.glob(absolute_glob)
         end
       end
 
-      files
+      absolute_files
     end
 
+    sig { returns(T::Array[String]) }
     def configured_included_files
-      files_for_globs(@configuration.include)
+      absolute_files_for_globs(@configuration.include)
     end
 
+    sig { returns(T::Array[String]) }
     def configured_excluded_files
-      files_for_globs(@configuration.exclude)
+      absolute_files_for_globs(@configuration.exclude)
     end
 
-    def files_for_globs(globs)
-      globs
+    sig { params(relative_globs: T::Array[String]).returns(T::Array[String]) }
+    def absolute_files_for_globs(relative_globs)
+      relative_globs
         .flat_map { |glob| Dir[File.expand_path(glob, @configuration.root_path)] }
         .uniq
     end

data/lib/packwerk/node_processor.rb

@@ -1,4 +1,4 @@
-# typed: true
+# typed: strict
 # frozen_string_literal: true
 
 module Packwerk
@@ -9,12 +9,12 @@ module Packwerk
     sig do
       params(
         reference_extractor: ReferenceExtractor,
-        filename: String,
+        absolute_file: String,
       ).void
     end
-    def initialize(reference_extractor:, filename:)
+    def initialize(reference_extractor:, absolute_file:)
       @reference_extractor = reference_extractor
-      @filename = filename
+      @absolute_file = absolute_file
     end
 
     sig do
@@ -25,7 +25,7 @@ module Packwerk
     end
     def call(node, ancestors)
       return unless Node.method_call?(node) || Node.constant?(node)
-      @reference_extractor.reference_from_node(node, ancestors: ancestors, file_path: @filename)
+      @reference_extractor.reference_from_node(node, ancestors: ancestors, absolute_file: @absolute_file)
     end
   end
 end

data/lib/packwerk/node_processor_factory.rb

@@ -9,11 +9,11 @@ module Packwerk
     const :context_provider, Packwerk::ConstantDiscovery
     const :constant_name_inspectors, T::Array[ConstantNameInspector]
 
-    sig { params(filename: String, node: AST::Node).returns(NodeProcessor) }
-    def for(filename:, node:)
+    sig { params(absolute_file: String, node: AST::Node).returns(NodeProcessor) }
+    def for(absolute_file:, node:)
       ::Packwerk::NodeProcessor.new(
         reference_extractor: reference_extractor(node: node),
-        filename: filename,
+        absolute_file: absolute_file,
       )
     end
 

data/lib/packwerk/offense.rb

@@ -1,4 +1,4 @@
-# typed: true
+# typed: strict
 # frozen_string_literal: true
 
 require "parser/source/map"
@@ -8,7 +8,14 @@ module Packwerk
     extend T::Sig
     extend T::Helpers
 
-    attr_reader :location, :file, :message
+    sig { returns(T.nilable(Node::Location)) }
+    attr_reader :location
+
+    sig { returns(String) }
+    attr_reader :file
+
+    sig { returns(String) }
+    attr_reader :message
 
     sig do
       params(file: String, message: String, location: T.nilable(Node::Location))
@@ -22,6 +29,7 @@ module Packwerk
 
     sig { params(style: OutputStyle).returns(String) }
     def to_s(style = OutputStyles::Plain.new)
+      location = self.location
       if location
         <<~EOS
           #{style.filename}#{file}#{style.reset}:#{location.line}:#{location.column}

data/lib/packwerk/package_set.rb

@@ -92,10 +92,10 @@ module Packwerk
       packages[name]
     end
 
-    sig { params(file_path: T.any(Pathname, String)).returns(T.nilable(Package)) }
+    sig { params(file_path: T.any(Pathname, String)).returns(Package) }
     def package_from_path(file_path)
       path_string = file_path.to_s
-      @package_from_path[path_string] ||= packages.values.find { |package| package.package_path?(path_string) }
+      @package_from_path[path_string] ||= T.must(packages.values.find { |package| package.package_path?(path_string) })
     end
   end
 end

data/lib/packwerk/parse_run.rb

@@ -1,4 +1,4 @@
-# typed: true
+# typed: strict
 # frozen_string_literal: true
 
 require "benchmark"
@@ -8,8 +8,20 @@ module Packwerk
   class ParseRun
     extend T::Sig
 
+    ProcessFileProc = T.type_alias do
+      T.proc.params(path: String).returns(T::Array[Offense])
+    end
+
+    sig do
+      params(
+        absolute_files: T::Array[String],
+        configuration: Configuration,
+        progress_formatter: Formatters::ProgressFormatter,
+        offenses_formatter: OffensesFormatter,
+      ).void
+    end
     def initialize(
-      files:,
+      absolute_files:,
       configuration:,
       progress_formatter: Formatters::ProgressFormatter.new(StringIO.new),
       offenses_formatter: Formatters::OffensesFormatter.new
@@ -17,9 +29,10 @@ module Packwerk
       @configuration = configuration
       @progress_formatter = progress_formatter
       @offenses_formatter = offenses_formatter
-      @files = files
+      @absolute_files = absolute_files
     end
 
+    sig { returns(Result) }
     def detect_stale_violations
       offense_collection = find_offenses
 
@@ -29,6 +42,7 @@ module Packwerk
       Result.new(message: message, status: result_status)
     end
 
+    sig { returns(Result) }
     def update_deprecations
       offense_collection = find_offenses
       offense_collection.dump_deprecated_references_files
@@ -41,6 +55,7 @@ module Packwerk
       Result.new(message: message, status: offense_collection.errors.empty?)
     end
 
+    sig { returns(Result) }
     def check
       offense_collection = find_offenses(show_errors: true)
 
@@ -55,23 +70,24 @@ module Packwerk
 
     private
 
+    sig { params(show_errors: T::Boolean).returns(OffenseCollection) }
     def find_offenses(show_errors: false)
       offense_collection = OffenseCollection.new(@configuration.root_path)
-      @progress_formatter.started(@files)
+      @progress_formatter.started(@absolute_files)
 
       run_context = Packwerk::RunContext.from_configuration(@configuration)
-      all_offenses = T.let([], T.untyped)
+      all_offenses = T.let([], T::Array[Offense])
 
-      process_file = -> (path) do
-        run_context.process_file(file: path).tap do |offenses|
+      process_file = T.let(-> (absolute_file) do
+        run_context.process_file(absolute_file: absolute_file).tap do |offenses|
           failed = show_errors && offenses.any? { |offense| !offense_collection.listed?(offense) }
           update_progress(failed: failed)
         end
-      end
+      end, ProcessFileProc)
 
       execution_time = Benchmark.realtime do
         all_offenses = if @configuration.parallel?
-          Parallel.flat_map(@files, &process_file)
+          Parallel.flat_map(@absolute_files, &process_file)
         else
           serial_find_offenses(&process_file)
         end
@@ -83,18 +99,22 @@ module Packwerk
       offense_collection
     end
 
-    def serial_find_offenses
-      all_offenses = T.let([], T.untyped)
-      @files.each do |path|
-        offenses = yield path
-        all_offenses.concat(offenses)
+    sig { params(block: ProcessFileProc).returns(T::Array[Offense]) }
+    def serial_find_offenses(&block)
+      all_offenses = T.let([], T::Array[Offense])
+      begin
+        @absolute_files.each do |absolute_file|
+          offenses = block.call(absolute_file)
+          all_offenses.concat(offenses)
+        end
+      rescue Interrupt
+        @progress_formatter.interrupted
+        all_offenses
       end
       all_offenses
-    rescue Interrupt
-      @progress_formatter.interrupted
-      all_offenses
     end
 
+    sig { params(failed: T::Boolean).void }
     def update_progress(failed: false)
       if failed
         @progress_formatter.mark_as_failed

data/lib/packwerk/parsers/erb.rb

@@ -9,6 +9,8 @@ require "parser/source/buffer"
 module Packwerk
   module Parsers
     class Erb
+      include ParserInterface
+
       def initialize(parser_class: BetterHtml::Parser, ruby_parser: Ruby.new)
         @parser_class = parser_class
         @ruby_parser = ruby_parser

data/lib/packwerk/parsers/factory.rb

@@ -6,6 +6,7 @@ require "singleton"
 module Packwerk
   module Parsers
     class Factory
+      extend T::Sig
       include Singleton
 
       RUBY_REGEX = %r{
@@ -19,6 +20,7 @@ module Packwerk
       ERB_REGEX = /\.erb\Z/
       private_constant :ERB_REGEX
 
+      sig { params(path: String).returns(T.nilable(ParserInterface)) }
       def for_path(path)
         case path
         when RUBY_REGEX

data/lib/packwerk/parsers/parser_interface.rb

@@ -0,0 +1,17 @@
+# typed: strict
+# frozen_string_literal: true
+
+module Packwerk
+  module Parsers
+    module ParserInterface
+      extend T::Helpers
+      extend T::Sig
+
+      interface!
+
+      sig { abstract.params(io: File, file_path: String).returns(T.untyped) }
+      def call(io:, file_path:)
+      end
+    end
+  end
+end

data/lib/packwerk/parsers/ruby.rb

@@ -7,6 +7,8 @@ require "parser/current"
 module Packwerk
   module Parsers
     class Ruby
+      include ParserInterface
+
       class RaiseExceptionsParser < Parser::CurrentRuby
         def initialize(builder)
           super(builder)

data/lib/packwerk/parsers.rb

@@ -5,6 +5,7 @@ module Packwerk
   module Parsers
     autoload :Erb, "packwerk/parsers/erb"
     autoload :Factory, "packwerk/parsers/factory"
+    autoload :ParserInterface, "packwerk/parsers/parser_interface"
     autoload :Ruby, "packwerk/parsers/ruby"
 
     class ParseResult < Offense; end

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

@@ -1,4 +1,4 @@
-# typed: true
+# typed: strict
 # frozen_string_literal: true
 
 module Packwerk

data/lib/packwerk/reference_checking/reference_checker.rb

@@ -1,4 +1,4 @@
-# typed: true
+# typed: strict
 # frozen_string_literal: true
 
 module Packwerk
@@ -6,6 +6,7 @@ module Packwerk
     class ReferenceChecker
       extend T::Sig
 
+      sig { params(checkers: T::Array[Checkers::Checker]).void }
       def initialize(checkers)
         @checkers = checkers
       end

data/lib/packwerk/reference_extractor.rb

@@ -27,10 +27,10 @@ module Packwerk
       params(
         node: Parser::AST::Node,
         ancestors: T::Array[Parser::AST::Node],
-        file_path: String
+        absolute_file: String
       ).returns(T.nilable(UnresolvedReference))
     end
-    def reference_from_node(node, ancestors:, file_path:)
+    def reference_from_node(node, ancestors:, absolute_file:)
       constant_name = T.let(nil, T.nilable(String))
 
       @constant_name_inspectors.each do |inspector|
@@ -39,7 +39,14 @@ module Packwerk
         break if constant_name
       end
 
-      reference_from_constant(constant_name, node: node, ancestors: ancestors, file_path: file_path) if constant_name
+      if constant_name
+        reference_from_constant(
+          constant_name,
+          node: node,
+          ancestors: ancestors,
+          absolute_file: absolute_file
+        )
+      end
     end
 
     sig do
@@ -66,11 +73,15 @@ module Packwerk
             current_namespace_path: unresolved_reference.namespace_path
           )
 
-        next if constant&.package.nil?
+        next if constant.nil?
+
+        package_for_constant = constant.package
+
+        next if package_for_constant.nil?
 
         source_package = context_provider.package_from_path(unresolved_reference.relative_path)
 
-        next if source_package == constant.package
+        next if source_package == package_for_constant
 
         fully_qualified_references_and_offenses << Reference.new(
           source_package,
@@ -90,21 +101,21 @@ module Packwerk
         constant_name: String,
         node: Parser::AST::Node,
         ancestors: T::Array[Parser::AST::Node],
-        file_path: String
+        absolute_file: String
       ).returns(T.nilable(UnresolvedReference))
     end
-    def reference_from_constant(constant_name, node:, ancestors:, file_path:)
+    def reference_from_constant(constant_name, node:, ancestors:, absolute_file:)
       namespace_path = Node.enclosing_namespace_path(node, ancestors: ancestors)
 
       return if local_reference?(constant_name, Node.name_location(node), namespace_path)
 
-      relative_path = Pathname.new(file_path).relative_path_from(@root_path).to_s
+      relative_file = Pathname.new(absolute_file).relative_path_from(@root_path).to_s
       location = Node.location(node)
 
       UnresolvedReference.new(
         constant_name,
         namespace_path,
-        relative_path,
+        relative_file,
         location
       )
     end

data/lib/packwerk/reference_offense.rb

@@ -1,4 +1,4 @@
-# typed: true
+# typed: strict
 # frozen_string_literal: true
 
 module Packwerk
@@ -7,7 +7,11 @@ module Packwerk
     extend T::Sig
     extend T::Helpers
 
-    attr_reader :reference, :violation_type
+    sig { returns(Reference) }
+    attr_reader :reference
+
+    sig { returns(ViolationType) }
+    attr_reader :violation_type
 
     sig do
       params(
@@ -25,10 +29,11 @@ module Packwerk
 
     private
 
+    sig { params(reference: Reference, violation_type: ViolationType).returns(String) }
     def build_message(reference, violation_type)
       violation_message = case violation_type
       when ViolationType::Privacy
-        source_desc = reference.source_package ? "'#{reference.source_package}'" : "here"
+        source_desc = "'#{reference.source_package}'"
         "Privacy violation: '#{reference.constant.name}' is private to '#{reference.constant.package}' but " \
         "referenced from #{source_desc}.\n" \
         "Is there a public entrypoint in '#{reference.constant.package.public_path}' that you can use instead?"

data/lib/packwerk/result.rb

@@ -3,7 +3,7 @@
 
 module Packwerk
   class Result < T::Struct
-    prop :message, String
-    prop :status, T::Boolean
+    const :message, String
+    const :status, T::Boolean
   end
 end