packwerk 1.0.0 → 1.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: cdc39eaf91ef0f8f247cc31b54a3bb1680fcc0ddee4e9552f60a8c9bbdcf3410
-  data.tar.gz: d449d1c6484b490d79a6dd3d98b0cdc84bf2ffdae1aa0564544ee3aa1e592f12
+  metadata.gz: cd008f86d84fd0224aac9d8f92bc104123f23869e9381c947b3e51864523c947
+  data.tar.gz: debf7f89ce8f8419a02f2af84c3f1900c7bc2f2ac79cce535284e3e697133d74
 SHA512:
-  metadata.gz: c1f2d61a18cb126e85e824e0bc6d2a5854e2dd7114717165fb71ae9a5765f719464c7b66177078c01a5601aca9e8500112f68d695594a650f03da62a0d3054a2
-  data.tar.gz: a674e776393ab5cc078ab21c9faefa554d54a85010bde8c40e47cb5bf6eed1b3e8e523cecce8f8673a0dfb606f455aac1ae3bb71b12acd7c5dfccffa2b645eda
+  metadata.gz: 2bf12776a5e5cd4f3f9d06f3bbabb3d9b0c6d873325dba9a7bc43dc49ffedbc119678b77a2087cface6428bf564e037b75386abb8fca2d06a313e617461db53a
+  data.tar.gz: d6ca7a42dea1c5338c40e89b6fe6b14baa43372cf44e22af3f19763ee1048c03629e34f4466b632e7f5b6d82932b8e05b2d02d5e26ebf91852334b9f2ca6d5b2

data/.github/pull_request_template.md

@@ -7,21 +7,22 @@
 ## What should reviewers focus on?
 
 
-
 ## Type of Change
 
-- [ ] Bug fix (non-breaking change which fixes an issue)
-- [ ] New feature (non-breaking change which adds functionality)
-- [ ] Code refactor (non-breaking change that doesn't add functionality)
-- [ ] Breaking change (fix or feature that would cause existing functionality to not work as expected)
-- [ ] This change requires a documentation update
+- [ ] Bugfix
+- [ ] New feature
+- [ ] Non-breaking change (a change that doesn't alter functionality - i.e., code refactor, configs, etc.)
 
 ### Additional Release Notes
 
+- [ ] Breaking change (fix or feature that would cause existing functionality to change)
+
 Include any notes here to include in the release description. For example, if you selected "breaking change" above, leave notes on how users can transition to this version.
 
 If no additional notes are necessary, delete this section or leave it unchanged.
 
 ## Checklist
 
-- [ ] It is safe to simply rollback this change.
+- [ ] I have updated the documentation accordingly.
+- [ ] I have added tests to cover my changes.
+- [ ] It is safe to rollback this change.

data/.github/workflows/ci.yml

@@ -1,6 +1,6 @@
 name: CI
 
-on: [push]
+on: [push, pull_request]
 
 jobs:
   build:

data/.gitignore

@@ -9,4 +9,5 @@
 /.bundle/
 /tmp/
 .rubocop-*
+.byebug_history
 sorbet/rbi/hidden-definitions/errors.txt

data/Gemfile

@@ -19,4 +19,5 @@ gem("tapioca", require: false)
 
 group :development do
   gem("byebug", require: false)
+  gem("minitest-focus", require: false)
 end

data/Gemfile.lock

@@ -85,7 +85,7 @@ GIT
 PATH
   remote: .
   specs:
-    packwerk (1.0.0)
+    packwerk (1.1.2)
       activesupport (>= 5.2)
       ast
       better_html
@@ -137,6 +137,8 @@ GEM
     mini_mime (1.0.2)
     mini_portile2 (2.4.0)
     minitest (5.14.0)
+    minitest-focus (1.2.1)
+      minitest (>= 4, < 6)
     mocha (1.11.2)
     nio4r (2.5.2)
     nokogiri (1.10.9)
@@ -180,7 +182,7 @@ GEM
     smart_properties (1.15.0)
     sorbet (0.5.5898)
       sorbet-static (= 0.5.5898)
-    sorbet-runtime (0.5.5898)
+    sorbet-runtime (0.5.6049)
     sorbet-static (0.5.5898-universal-darwin-19)
     spoom (1.0.4)
       colorize
@@ -220,6 +222,7 @@ DEPENDENCIES
   byebug
   constant_resolver
   m
+  minitest-focus
   mocha
   packwerk!
   rails!

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
@@ -16,9 +16,9 @@ Packwerk supports MRI versions 2.6 and above.
 
 ## Demo
 
-Watch a [1-minute video demo](https://drive.google.com/file/d/1D-t1nYduwgpHAP4DHY-EwVwVNFHlwRWj/view?usp=sharing) on how Packwerk works.
+Watch a [1-minute video demo](https://www.youtube.com/watch?v=NwqlyBAxVpQ&feature=youtu.be) on how Packwerk works.
 
-[![](./static/packwerk-check-demo.png)](https://drive.google.com/file/d/1D-t1nYduwgpHAP4DHY-EwVwVNFHlwRWj/view?usp=sharing)
+[![](./static/packwerk-check-demo.png)](https://www.youtube.com/watch?v=NwqlyBAxVpQ&feature=youtu.be)
 
 ## Installation
 
@@ -28,6 +28,8 @@ Watch a [1-minute video demo](https://drive.google.com/file/d/1D-t1nYduwgpHAP4DH
 gem 'packwerk'
 ```
 
+_Note: Packwerk has to be grouped in production environment within the Gemfile if your Rails app has custom inflections._
+
 2. Install the gem
 
 Execute:

data/TROUBLESHOOT.md

@@ -16,7 +16,7 @@ You can specify folders or packages in Packwerk commands for a shorter run time:
 
      bundle exec packwerk check components/your_package
 
-     bundle exec packwerk update components/your_package
+     bundle exec packwerk update-deprecations components/your_package
 
 _Note: You cannot specify folders or packages for `packwerk validate` because the command runs for the entire application._
 

data/USAGE.md

@@ -47,11 +47,11 @@ Here is a list of files generated:
 
 | File                        | Location     | Description |
 |-----------------------------|--------------|------------|
-| Packwerk configuration      | packwerk.yml | See [Setting up configuration file](#Setting-up-configuration-file) |
+| Packwerk configuration      | packwerk.yml | See [Setting up the configuration file](#Setting-up-the-configuration-file) |
 | Root package                | package.yml  | A package for the root folder |
 | Bin script                  | bin/packwerk | For Rails applications to run Packwerk validation on CI, see [Validating the package system](#Validating-the-package-system) |
 | Validation test             | test/packwerk_validator_test.rb | For Ruby projects to run Packwerk validation using tests, see [Validating the package system](#Validating-the-package-system) |
-| Custom inflections          | configs/inflections.yml | A custom inflections file is only required if you have custom inflections in `inflections.rb`, see [Inflections](#Inflections) |
+| Custom inflections          | config/inflections.yml | A custom inflections file is only required if you have custom inflections in `inflections.rb`, see [Inflections](#Inflections) |
 
 After that, you may begin creating packages for your application. See [Defining packages](#Defining-packages)
 
@@ -59,33 +59,58 @@ After that, you may begin creating packages for your application. See [Defining
 
 Packwerk reads from the `packwerk.yml` configuration file in the root directory. Packwerk will run with the default configuration if any of these settings are not specified.
 
-| Key                  | Default value                      | Description  |
-|----------------------|------------------------------------|--------------|
-| include              | **/*.{rb,rake,erb}                 | list of patterns for folder paths to include |
-| exclude              | {bin,node_modules,script,tmp}/**/* | list of patterns for folder paths to exclude |
-| package_paths        | **/                                | patterns to find package configuration files, see: Defining packages |
-| load_paths           | All application autoload paths     | list of load paths |
-| custom_associations  | N/A                                | list of custom associations, if any |
+| Key                  | Default value                             | Description  |
+|----------------------|-------------------------------------------|--------------|
+| include              | **/*.{rb,rake,erb}                        | list of patterns for folder paths to include |
+| exclude              | {bin,node_modules,script,tmp,vendor}/**/* | list of patterns for folder paths to exclude |
+| package_paths        | **/                                       | a single pattern or a list of patterns to find package configuration files, see: [Defining packages](#Defining-packages) |
+| load_paths           | All application autoload paths            | list of load paths |
+| custom_associations  | N/A                                       | list of custom associations, if any |
 
+### Using a custom ERB parser
+
+You can specify a custom ERB parser if needed. For example, if you're using `<%graphql>` tags from https://github.com/github/graphql-client in your ERBs, you can use a custom parser subclass to comment them out so that Packwerk can parse the rest of the file:
+
+```ruby
+class CustomParser < Packwerk::Parsers::Erb
+  def parse_buffer(buffer, file_path:)
+    preprocessed_source = buffer.source
+
+    # Comment out <%graphql ... %> tags. They won't contain any object
+    # references anyways.
+    preprocessed_source = preprocessed_source.gsub(/<%graphql/, "<%#")
+
+    preprocessed_buffer = Parser::Source::Buffer.new(file_path)
+    preprocessed_buffer.source = preprocessed_source
+    super(preprocessed_buffer, file_path: file_path)
+  end
+end
+
+Packwerk::Parsers::Factory.instance.erb_parser_class = CustomParser
+```
 
 ### Inflections
 
-Packwerk requires custom inflections to be defined in `inflections.yml` instead of the traditional `inflections.rb`. This is because Packwerk accounts for custom inflections, such as acronyms, when resolving constants. Additionally, Packwerk interprets Active Record associations as references to constants. For example, `has_many :birds` is reference to the `Birds` constant.
+Packwerk requires custom inflections to be defined in `inflections.yml` instead of the traditional `inflections.rb`. This is because Packwerk accounts for custom inflections, such as acronyms, when resolving constants. Additionally, Packwerk interprets Active Record associations as references to constants. For example, `has_many :birds` is a reference to the `Bird` constant.
 
-In order to make your custom inflections compatible with Active Support and Packwerk, you must create an `inflections.yml` file and point `ActiveSupport::Inflector` to that file.
+In order to make your custom inflections compatible with Active Support and Packwerk, you must create a `config/inflections.yml` file and point `ActiveSupport::Inflector` to that file.
 
 In `inflections.rb`, add:
 
 ```rb
+require "packwerk/inflections/custom"
+
 ActiveSupport::Inflector.inflections do |inflect|
   # please add all custom inflections in the file below.
   Packwerk::Inflections::Custom.new(
-    Rails.root.join("inflections.yml")
+    Rails.root.join("config", "inflections.yml")
   ).apply_to(inflect)
 end
 ```
 
-Next, move your existing custom inflections into `inflections.yml`:
+_Note: Packwerk has to be grouped in production environment within the Gemfile if you have custom inflections._
+
+Next, move your existing custom inflections into `config/inflections.yml`:
 
 ```yaml
 acronym:
@@ -97,9 +122,11 @@ irregular:
   - ['reserve', 'reserves']
 uncountable:
   - 'payment_details'
+singular:
+  - [!ruby/regexp /status$/, 'status']
 ```
 
-Any new inflectors should be added to `inflections.yml`.
+Any new inflectors should be added to `config/inflections.yml`.
 
 ## Validating the package system
 
@@ -168,7 +195,17 @@ enforce_privacy:
 It will be a privacy violation when a file outside of the `components/merchandising` package tries to reference `Merchandising::Product`.
 
 ##### Using public folders
-You may enforce privacy either way mentioned above and still expose a public API for your package by placing constants in the `app/public` folder. The constants in the public folder will be made available for use by the rest of the application.
+You may enforce privacy either way mentioned above and still expose a public API for your package by placing constants in the public folder, which by default is `app/public`. The constants in the public folder will be made available for use by the rest of the application.
+
+##### Defining your own public folder
+
+You may prefer to override the default public folder, you can do so on a per-package basis by defining a `public_path`.
+
+Example:
+
+```yaml
+public_path: my/custom/path/
+```
 
 #### Enforcing dependency boundary
 A package's dependency boundary is violated whenever it references a constant in some package that has not been declared as a dependency.
@@ -210,17 +247,17 @@ For existing codebases, packages are likely to have existing boundary violations
 
 If so, you will want to stop the bleeding and prevent more violations from occuring. The existing violations in the codebase can be recorded in a [deprecated references list](#Understanding_the_list_of_deprecated_references) by executing:
 
-    bundle exec packwerk update
+    bundle exec packwerk update-deprecations
 
-Similar to `packwerk check`, you may also run `packwerk update` on folders or packages:
+Similar to `packwerk check`, you may also run `packwerk update-deprecations` on folders or packages:
 
-    bundle exec packwerk update components/your_package
+    bundle exec packwerk update-deprecations components/your_package
 
 ![](static/packwerk_update.gif)
 
 _Note: Changing dependencies or enabling dependencies will not require a full update of the codebase, only the package that changed. On the other hand, changing or enabling privacy will require a full update of the codebase._
 
-`packwerk update` should only be run to record existing violations and to remove deprecated references that have been worked off. Running `packwerk update` to resolve a violation should be the very last resort.
+`packwerk update-deprecations` should only be run to record existing violations and to remove deprecated references that have been worked off. Running `packwerk update-deprecations` to resolve a violation should be the very last resort.
 
 See: [TROUBLESHOOT.md - Troubleshooting violations](TROUBLESHOOT.md#Troubleshooting_violations)
 

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

@@ -14,7 +14,6 @@ require "packwerk/cli"
 require "packwerk/configuration"
 require "packwerk/const_node_inspector"
 require "packwerk/constant_discovery"
-require "packwerk/constant_name_inspector"
 require "packwerk/dependency_checker"
 require "packwerk/deprecated_references"
 require "packwerk/files_for_processing"
@@ -28,13 +27,14 @@ 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"
 require "packwerk/privacy_checker"
 require "packwerk/reference_extractor"
-require "packwerk/reference_lister"
 require "packwerk/run_context"
 require "packwerk/updating_deprecated_references"
 require "packwerk/version"

data/lib/packwerk/application_load_paths.rb

@@ -0,0 +1,68 @@
+# typed: strict
+# frozen_string_literal: true
+
+require "bundler"
+
+module Packwerk
+  module ApplicationLoadPaths
+    class << self
+      extend T::Sig
+
+      sig { returns(T::Array[String]) }
+      def extract_relevant_paths
+        assert_application_booted
+        all_paths = extract_application_autoload_paths
+        relevant_paths = filter_relevant_paths(all_paths)
+        assert_load_paths_present(relevant_paths)
+        relative_path_strings(relevant_paths)
+      end
+
+      sig { void }
+      def assert_application_booted
+        raise "The application needs to be booted to extract load paths" unless defined?(::Rails)
+      end
+
+      sig { returns(T::Array[String]) }
+      def extract_application_autoload_paths
+        Rails.application.railties
+          .select { |railtie| railtie.is_a?(Rails::Engine) }
+          .push(Rails.application)
+          .flat_map do |engine|
+            paths = (engine.config.autoload_paths + engine.config.eager_load_paths + engine.config.autoload_once_paths)
+            paths.map(&:to_s).uniq
+          end
+      end
+
+      sig do
+        params(all_paths: T::Array[String], bundle_path: Pathname, rails_root: Pathname)
+          .returns(T::Array[Pathname])
+      end
+      def filter_relevant_paths(all_paths, bundle_path: Bundler.bundle_path, rails_root: Rails.root)
+        bundle_path_match = bundle_path.join("**")
+        rails_root_match = rails_root.join("**")
+
+        all_paths
+          .map { |path| Pathname.new(path).expand_path }
+          .select { |path| path.fnmatch(rails_root_match.to_s) } # path needs to be in application directory
+          .reject { |path| path.fnmatch(bundle_path_match.to_s) } # reject paths from vendored gems
+      end
+
+      sig { params(paths: T::Array[Pathname], rails_root: Pathname).returns(T::Array[String]) }
+      def relative_path_strings(paths, rails_root: Rails.root)
+        paths
+          .map { |path| path.relative_path_from(rails_root).to_s }
+          .uniq
+      end
+
+      sig { params(paths: T::Array[T.untyped]).void }
+      def assert_load_paths_present(paths)
+        if paths.empty?
+          raise <<~EOS
+            We could not extract autoload paths from your Rails app. This is likely a configuration error.
+            Packwerk will not work correctly without any autoload paths.
+          EOS
+        end
+      end
+    end
+  end
+end

data/lib/packwerk/application_validator.rb

@@ -9,15 +9,15 @@ require "yaml"
 require "packwerk/package_set"
 require "packwerk/graph"
 require "packwerk/inflector"
+require "packwerk/application_load_paths"
 
 module Packwerk
   class ApplicationValidator
-    def initialize(config_file_path:, application_load_paths:, configuration:)
+    def initialize(config_file_path:, configuration:)
       @config_file_path = config_file_path
       @configuration = configuration
 
-      # Load paths should be from the application
-      @application_load_paths = application_load_paths.sort.uniq
+      @application_load_paths = ApplicationLoadPaths.extract_relevant_paths
     end
 
     Result = Struct.new(:ok?, :error_value)
@@ -32,19 +32,10 @@ module Packwerk
         check_acyclic_graph,
         check_package_manifest_paths,
         check_valid_package_dependencies,
-        check_root_package_exist,
+        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,55 +56,41 @@ 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)
-
-          unless context
-            errors << "#{constant}, listed in #{filepath.inspect}, could not be resolved"
-            next
-          end
-
-          expected_filename = constant.underscore + ".rb"
+        assert_constants_can_be_loaded(constants)
 
-          # 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)
+        constant_locations = constants.map { |c| [c, resolver.resolve(c)&.location] }
 
-          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
 
-        known_keys = %w(enforce_privacy enforce_dependencies dependencies metadata)
+        known_keys = %w(enforce_privacy enforce_dependencies public_path dependencies metadata)
         unknown_keys = hash.keys - known_keys
 
         unless unknown_keys.empty?
@@ -134,6 +111,12 @@ module Packwerk
           end
         end
 
+        if hash.key?("public_path")
+          unless hash["public_path"].is_a?(String)
+            errors << "'public_path' option must be a string in #{f.inspect}: #{hash['public_path'].inspect}"
+          end
+        end
+
         next unless hash.key?("dependencies")
         next if hash["dependencies"].is_a?(Array)
 
@@ -164,14 +147,12 @@ module Packwerk
     def check_inflection_file
       inflections_file = @configuration.inflections_file
 
-      test_inflections = ActiveSupport::Inflector::Inflections.new
-
-      Packwerk::Inflections::Default.apply_to(test_inflections)
-      Packwerk::Inflections::Custom.new(inflections_file).apply_to(test_inflections)
+      application_inflections = ActiveSupport::Inflector.inflections
+      packwerk_inflections = Packwerk::Inflector.from_file(inflections_file).inflections
 
       results = %i(plurals singulars uncountables humans acronyms).map do |type|
-        expected = ActiveSupport::Inflector.inflections.public_send(type).to_a
-        actual = test_inflections.public_send(type).to_a
+        expected = application_inflections.public_send(type).to_set
+        actual = packwerk_inflections.public_send(type).to_set
 
         if expected == actual
           Result.new(true)
@@ -189,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(".")
-
-      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)
 
@@ -293,7 +266,7 @@ module Packwerk
       end
     end
 
-    def check_root_package_exist
+    def check_root_package_exists
       root_package_path = File.join(@configuration.root_path, "package.yml")
       all_packages_manifests = package_manifests(package_glob)
 
@@ -312,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)
@@ -324,12 +296,17 @@ module Packwerk
       @configuration.package_paths || "**"
     end
 
-    def package_manifests(glob_pattern)
-      Dir.glob(File.join(glob_pattern, Packwerk::PackageSet::PACKAGE_CONFIG_FILENAME)).map { |f| File.realpath(f) }
+    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)
@@ -339,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