Mark API as private and reference it in permitted way

Author: Alex Evanczuk

lib/packwerk.rb

@@ -13,44 +13,74 @@
 module Packwerk
   extend ActiveSupport::Autoload
 
+  # Public APIs
+  autoload :Checker
+  autoload :Cli
+  autoload :Offense
+  autoload :OffensesFormatter
+  autoload :OutputStyle
+  autoload :Package
+  autoload :PackageSet
+  autoload :PackageTodo
+  autoload :Parsers
+  autoload :Reference
+  autoload :ReferenceOffense
+  autoload :Result
+
+  # Private APIs
+  # Please submit an issue if you have a use-case for these
   autoload :ApplicationLoadPaths
+  private_constant :ApplicationLoadPaths
   autoload :ApplicationValidator
+  private_constant :ApplicationValidator
   autoload :AssociationInspector
+  private_constant :AssociationInspector
   autoload :Cache
-  autoload :Checker
-  autoload :Cli
+  private_constant :Cache
   autoload :Configuration
+  private_constant :Configuration
   autoload :ConstantDiscovery
+  private_constant :ConstantDiscovery
   autoload :ConstantNameInspector
+  private_constant :ConstantNameInspector
   autoload :ConstNodeInspector
+  private_constant :ConstNodeInspector
   autoload :ExtensionLoader
+  private_constant :ExtensionLoader
   autoload :FileProcessor
+  private_constant :FileProcessor
   autoload :FilesForProcessing
+  private_constant :FilesForProcessing
   autoload :Graph
+  private_constant :Graph
   autoload :Loader
+  private_constant :Loader
   autoload :Node
+  private_constant :Node
   autoload :NodeHelpers
+  private_constant :NodeHelpers
   autoload :NodeProcessor
+  private_constant :NodeProcessor
   autoload :NodeProcessorFactory
+  private_constant :NodeProcessorFactory
   autoload :NodeVisitor
-  autoload :Offense
+  private_constant :NodeVisitor
   autoload :OffenseCollection
-  autoload :OffensesFormatter
-  autoload :OutputStyle
-  autoload :Package
-  autoload :PackageSet
-  autoload :PackageTodo
+  private_constant :OffenseCollection
   autoload :ParsedConstantDefinitions
-  autoload :Parsers
+  private_constant :ParsedConstantDefinitions
   autoload :ParseRun
-  autoload :Reference
+  private_constant :ParseRun
   autoload :ReferenceExtractor
-  autoload :ReferenceOffense
-  autoload :Result
+  private_constant :ReferenceExtractor
   autoload :RunContext
+  private_constant :RunContext
   autoload :UnresolvedReference
+  private_constant :UnresolvedReference
   autoload :Validator
+  private_constant :Validator
   autoload :Version
+  private_constant :Version
 
   module OutputStyles
     extend ActiveSupport::Autoload
@@ -103,9 +133,9 @@ class ApplicationValidator
   end
 end
 
-# Required to register the default OffensesFormatter
+# Required to register the DefaultOffensesFormatter
 # We put this at the *end* of the file to specify all autoloads first
-require "packwerk/formatters/offenses_formatter"
+require "packwerk/formatters/default_offenses_formatter"
 
 # Required to register the default DependencyChecker
 require "packwerk/reference_checking/checkers/dependency_checker"

lib/packwerk/cli.rb

@@ -14,8 +14,8 @@ class Cli
         out: T.any(StringIO, IO),
         err_out: T.any(StringIO, IO),
         environment: String,
-        style: Packwerk::OutputStyle,
-        offenses_formatter: T.nilable(Packwerk::OffensesFormatter)
+        style: OutputStyle,
+        offenses_formatter: T.nilable(OffensesFormatter)
       ).void
     end
     def initialize(
@@ -159,7 +159,7 @@ def validate(_paths)
 
     sig { returns(ApplicationValidator) }
     def validator
-      Packwerk::ApplicationValidator.new
+      ApplicationValidator.new
     end
 
     sig { returns(PackageSet) }

lib/packwerk/configuration.rb

@@ -51,7 +51,7 @@ def initialize(configs = {}, config_path: nil)
       @cache_directory = Pathname.new(configs["cache_directory"] || "tmp/cache/packwerk")
       @config_path = config_path
 
-      @offenses_formatter_identifier = configs["offenses_formatter"] || Formatters::OffensesFormatter::IDENTIFIER
+      @offenses_formatter_identifier = configs["offenses_formatter"] || Formatters::DefaultOffensesFormatter::IDENTIFIER
 
       if configs.key?("require")
         configs["require"].each do |require_directive|

lib/packwerk/constant_discovery.rb

@@ -50,7 +50,7 @@ def package_from_path(path)
     # @param const_name [String] The unresolved constant's name.
     # @param current_namespace_path [Array<String>] (optional) The namespace of the context in which the constant is
     #   used, e.g. ["Apps", "Models"] for `Apps::Models`. Defaults to [] which means top level.
-    # @return [Packwerk::ConstantDiscovery::ConstantContext]
+    # @return [ConstantDiscovery::ConstantContext]
     sig do
       params(
         const_name: String,

lib/packwerk/file_processor.rb

@@ -64,7 +64,7 @@ def references_from_ast(node, relative_file)
       references = []
 
       node_processor = @node_processor_factory.for(relative_file: relative_file, node: node)
-      node_visitor = Packwerk::NodeVisitor.new(node_processor: node_processor)
+      node_visitor = NodeVisitor.new(node_processor: node_processor)
       node_visitor.visit(node, ancestors: [], result: references)
 
       references

…ackwerk/formatters/offenses_formatter.rb …formatters/default_offenses_formatter.rblib/packwerk/formatters/offenses_formatter.rb renamed to lib/packwerk/formatters/default_offenses_formatter.rb lib/packwerk/formatters/offenses_formatter.rb renamed to lib/packwerk/formatters/default_offenses_formatter.rb

@@ -3,8 +3,8 @@
 
 module Packwerk
   module Formatters
-    class OffensesFormatter
-      include Packwerk::OffensesFormatter
+    class DefaultOffensesFormatter
+      include OffensesFormatter
 
       IDENTIFIER = T.let("default", String)
 
@@ -20,7 +20,7 @@ def show_offenses(offenses)
         EOS
       end
 
-      sig { override.params(offense_collection: Packwerk::OffenseCollection, fileset: T::Set[String]).returns(String) }
+      sig { override.params(offense_collection: OffenseCollection, fileset: T::Set[String]).returns(String) }
       def show_stale_violations(offense_collection, fileset)
         if offense_collection.stale_violations?(fileset)
           "There were stale violations found, please run `packwerk update-todo`"

lib/packwerk/generators/configuration_file.rb

@@ -25,7 +25,7 @@ def initialize(root:, out: $stdout)
       sig { returns(T::Boolean) }
       def generate
         @out.puts("📦 Generating Packwerk configuration file...")
-        default_config_path = File.join(@root, ::Packwerk::Configuration::DEFAULT_CONFIG_PATH)
+        default_config_path = File.join(@root, Configuration::DEFAULT_CONFIG_PATH)
 
         if File.exist?(default_config_path)
           @out.puts("⚠️  Packwerk configuration file already exists.")

lib/packwerk/node_processor_factory.rb

@@ -6,22 +6,22 @@ class NodeProcessorFactory < T::Struct
     extend T::Sig
 
     const :root_path, String
-    const :context_provider, Packwerk::ConstantDiscovery
+    const :context_provider, ConstantDiscovery
     const :constant_name_inspectors, T::Array[ConstantNameInspector]
 
     sig { params(relative_file: String, node: AST::Node).returns(NodeProcessor) }
     def for(relative_file:, node:)
-      ::Packwerk::NodeProcessor.new(
+      NodeProcessor.new(
         reference_extractor: reference_extractor(node: node),
         relative_file: relative_file,
       )
     end
 
     private
 
-    sig { params(node: AST::Node).returns(::Packwerk::ReferenceExtractor) }
+    sig { params(node: AST::Node).returns(ReferenceExtractor) }
     def reference_extractor(node:)
-      ::Packwerk::ReferenceExtractor.new(
+      ReferenceExtractor.new(
         constant_name_inspectors: constant_name_inspectors,
         root_node: node,
         root_path: root_path,

lib/packwerk/offenses_formatter.rb

@@ -61,7 +61,7 @@ def formatter_by_identifier(name)
     def show_offenses(offenses)
     end
 
-    sig { abstract.params(offense_collection: Packwerk::OffenseCollection, for_files: T::Set[String]).returns(String) }
+    sig { abstract.params(offense_collection: OffenseCollection, for_files: T::Set[String]).returns(String) }
     def show_stale_violations(offense_collection, for_files)
     end
 

lib/packwerk/parse_run.rb

@@ -45,7 +45,7 @@ def update_todo
         return Result.new(message: message, status: false)
       end
 
-      run_context = Packwerk::RunContext.from_configuration(@configuration)
+      run_context = RunContext.from_configuration(@configuration)
       offense_collection = find_offenses(run_context)
       offense_collection.persist_package_todo_files(run_context.package_set)
 
@@ -59,7 +59,7 @@ def update_todo
 
     sig { returns(Result) }
     def check
-      run_context = Packwerk::RunContext.from_configuration(@configuration)
+      run_context = RunContext.from_configuration(@configuration)
       offense_collection = find_offenses(run_context, show_errors: true)
 
       messages = [
@@ -76,7 +76,7 @@ def check
 
     private
 
-    sig { params(run_context: Packwerk::RunContext, show_errors: T::Boolean).returns(OffenseCollection) }
+    sig { params(run_context: RunContext, show_errors: T::Boolean).returns(OffenseCollection) }
     def find_offenses(run_context, show_errors: false)
       offense_collection = OffenseCollection.new(@configuration.root_path)
       all_offenses = T.let([], T::Array[Offense])