packwerk 1.1.0 → 1.3.0

data/TROUBLESHOOT.md

@@ -14,9 +14,9 @@ Packwerk can give feedback via continuous integration (CI) if you have it set up
 
 You can specify folders or packages in Packwerk commands for a shorter run time:
 
-     bundle exec packwerk check components/your_package
+     packwerk check components/your_package
 
-     bundle exec packwerk update-deprecations components/your_package
+     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

@@ -1,29 +1,32 @@
 # Packwerk usage
 
 ## Table of Contents
-* [What problem does Packwerk solve?](#What-problem-does-Packwerk-solve?)
-* [What is a package?](#What-is-a-package?)
-  * [Package principles](#Package-principles)
-* [Getting started](#Getting-started)
-* [Setting up the configuration file](#Setting-up-the-configuration-file)
-  * [Inflections](#Inflections)
-* [Validating the package system](#Validating-the-package-system)
-* [Defining packages](#Defining-packages)
-  * [Package metadata](#Package-metadata)
-* [Types of boundary checks](#Types-of-boundary-checks)
-  * [Enforcing privacy boundary](#Enforcing-privacy-boundary)
-    * [Using public folders](#Using-public-folders)
-  * [Enforcing dependency boundary](#Enforcing-dependency-boundary)
-* [Checking for violations](#Checking-for-violations)
-* [Recording existing violations](#Recording-existing-violations)
-  * [Understanding the list of deprecated references](#Understanding-the-list-of-deprecated-references)
+
+* [What problem does Packwerk solve?](#what-problem-does-packwerk-solve)
+* [What is a package?](#what-is-a-package)
+  * [Package principles](#package-principles)
+* [Getting started](#getting-started)
+* [Setting up the configuration file](#setting-up-the-configuration-file)
+  * [Inflections](#inflections)
+* [Validating the package system](#validating-the-package-system)
+* [Defining packages](#defining-packages)
+  * [Package metadata](#package-metadata)
+* [Types of boundary checks](#types-of-boundary-checks)
+  * [Enforcing privacy boundary](#enforcing-privacy-boundary)
+    * [Using public folders](#using-public-folders)
+  * [Enforcing dependency boundary](#enforcing-dependency-boundary)
+* [Checking for violations](#checking-for-violations)
+* [Recording existing violations](#recording-existing-violations)
+  * [Understanding the list of deprecated references](#understanding-the-list-of-deprecated-references)
 
 ## What problem does Packwerk solve?
+
 Large applications need clear boundaries to avoid turning into a [ball of mud](https://en.wikipedia.org/wiki/Big_ball_of_mud). However, Ruby does not provide a good solution to enforcing boundaries between code.
 
 Packwerk is a gem that can be used to enforce boundaries between groups of code we call packages.
 
 ## What is a package?
+
 A package is a folder containing autoloaded code. To decide whether code belongs together in a package, these are some design best practices:
 
 - We should package things together that have high functional [cohesion](https://en.wikipedia.org/wiki/Cohesion_(computer_science)).
@@ -41,7 +44,7 @@ The [package principles](https://en.wikipedia.org/wiki/Package_principles) page
 
 After including Packwerk in the Gemfile, you can generate the necessary files to get Packwerk running by executing:
 
-    bundle exec packwerk init
+    packwerk init
 
 Here is a list of files generated:
 
@@ -49,8 +52,6 @@ Here is a list of files generated:
 |-----------------------------|--------------|------------|
 | 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          | 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)
@@ -66,6 +67,7 @@ Packwerk reads from the `packwerk.yml` configuration file in the root directory.
 | 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 |
+| parallel             | true                                      | when true, fork code parsing out to subprocesses |
 
 ### Using a custom ERB parser
 
@@ -132,18 +134,14 @@ Any new inflectors should be added to `config/inflections.yml`.
 
 There are some criteria that an application must meet in order to have a valid package system. These criteria include having a valid autoload path cache, package definition files, and application folder structure. The dependency graph within the package system also has to be acyclic.
 
-The package system can be validated through a series of built in validation checks. Currently, the validation checks require the application to be booted either through `spring` or as part of its test suite.
-
 We recommend setting up the package system validation for your Rails application in a CI step (or through a test suite for Ruby projects) separate from `packwerk check`.
 
-If running `packwerk init` generates a `bin/packwerk` script, proceed to run:
+Use the following command to validate the application:
 
-    bin/packwerk validate
+    packwerk validate
 
 ![](static/packwerk_validate.gif)
 
-If running `packwerk init` on your Ruby project generates `test/packwerk_validator_test.rb`, you can use this test as validation.
-
 ## Defining packages
 
 You can create a `package.yml` in any folder to make it a package. The package name is the path to the folder from the project root.
@@ -151,6 +149,7 @@ You can create a `package.yml` in any folder to make it a package. The package n
 _Note: It is helpful to define a namespace that corresponds to the package name and contains at least all the public constants of the package. This makes it more obvious which package a constant is defined in._
 
 ### Package metadata
+
 Package metadata can be included in the `package.yml`. Metadata won't be validated, and can thus be anything. We recommend including information on ownership and stewardship of the package.
 
 Example:
@@ -168,6 +167,7 @@ Example:
 Packwerk can perform two types of boundary checks: privacy and dependency.
 
 #### Enforcing privacy boundary
+
 A package's privacy boundary is violated when there is a reference to the package's private constants from a source outside the package.
 
 There are two ways you can enforce privacy for your package:
@@ -227,13 +227,13 @@ It will be a dependency violation when `components/shop_identity` tries to refer
 
 After enforcing the boundary checks for a package, you may execute:
 
-    bundle exec packwerk check
+    packwerk check
 
-Packwerk will check the entire codebase for any violations.
+Packwerk will check the entire codebase for any new or stale violations.
 
 You can also specify folders or packages for a shorter run time:
 
-    bundle exec packwerk check components/your_package
+    packwerk check components/your_package
 
 ![](static/packwerk_check.gif)
 
@@ -247,11 +247,11 @@ 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-deprecations
+    packwerk update-deprecations
 
 Similar to `packwerk check`, you may also run `packwerk update-deprecations` on folders or packages:
 
-    bundle exec packwerk update-deprecations components/your_package
+    packwerk update-deprecations components/your_package
 
 ![](static/packwerk_update.gif)
 

data/bin/m

@@ -0,0 +1,29 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+#
+# This file was generated by Bundler.
+#
+# The application 'm' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+require "pathname"
+ENV["BUNDLE_GEMFILE"] ||= File.expand_path("../../Gemfile",
+  Pathname.new(__FILE__).realpath)
+
+bundle_binstub = File.expand_path("../bundle", __FILE__)
+
+if File.file?(bundle_binstub)
+  if File.read(bundle_binstub, 300) =~ /This file was generated by Bundler/
+    load(bundle_binstub)
+  else
+    abort("Your `bin/bundle` was not generated by Bundler, so this binstub cannot run.
+Replace `bin/bundle` by running `bundle binstubs bundler --force`, then run this command again.")
+  end
+end
+
+require "rubygems"
+require "bundler/setup"
+
+load Gem.bin_path("m", "m")

data/bin/rake

@@ -0,0 +1,29 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+#
+# This file was generated by Bundler.
+#
+# The application 'rake' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+require "pathname"
+ENV["BUNDLE_GEMFILE"] ||= File.expand_path("../../Gemfile",
+  Pathname.new(__FILE__).realpath)
+
+bundle_binstub = File.expand_path("../bundle", __FILE__)
+
+if File.file?(bundle_binstub)
+  if File.read(bundle_binstub, 300) =~ /This file was generated by Bundler/
+    load(bundle_binstub)
+  else
+    abort("Your `bin/bundle` was not generated by Bundler, so this binstub cannot run.
+Replace `bin/bundle` by running `bundle binstubs bundler --force`, then run this command again.")
+  end
+end
+
+require "rubygems"
+require "bundler/setup"
+
+load Gem.bin_path("rake", "rake")

data/bin/rubocop

@@ -0,0 +1,29 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+#
+# This file was generated by Bundler.
+#
+# The application 'rubocop' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+require "pathname"
+ENV["BUNDLE_GEMFILE"] ||= File.expand_path("../../Gemfile",
+  Pathname.new(__FILE__).realpath)
+
+bundle_binstub = File.expand_path("../bundle", __FILE__)
+
+if File.file?(bundle_binstub)
+  if File.read(bundle_binstub, 300) =~ /This file was generated by Bundler/
+    load(bundle_binstub)
+  else
+    abort("Your `bin/bundle` was not generated by Bundler, so this binstub cannot run.
+Replace `bin/bundle` by running `bundle binstubs bundler --force`, then run this command again.")
+  end
+end
+
+require "rubygems"
+require "bundler/setup"
+
+load Gem.bin_path("rubocop", "rubocop")

data/bin/srb

@@ -0,0 +1,29 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+#
+# This file was generated by Bundler.
+#
+# The application 'srb' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+require "pathname"
+ENV["BUNDLE_GEMFILE"] ||= File.expand_path("../../Gemfile",
+  Pathname.new(__FILE__).realpath)
+
+bundle_binstub = File.expand_path("../bundle", __FILE__)
+
+if File.file?(bundle_binstub)
+  if File.read(bundle_binstub, 300) =~ /This file was generated by Bundler/
+    load(bundle_binstub)
+  else
+    abort("Your `bin/bundle` was not generated by Bundler, so this binstub cannot run.
+Replace `bin/bundle` by running `bundle binstubs bundler --force`, then run this command again.")
+  end
+end
+
+require "rubygems"
+require "bundler/setup"
+
+load Gem.bin_path("sorbet", "srb")

data/bin/tapioca

@@ -0,0 +1,29 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+#
+# This file was generated by Bundler.
+#
+# The application 'tapioca' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+require "pathname"
+ENV["BUNDLE_GEMFILE"] ||= File.expand_path("../../Gemfile",
+  Pathname.new(__FILE__).realpath)
+
+bundle_binstub = File.expand_path("../bundle", __FILE__)
+
+if File.file?(bundle_binstub)
+  if File.read(bundle_binstub, 300) =~ /This file was generated by Bundler/
+    load(bundle_binstub)
+  else
+    abort("Your `bin/bundle` was not generated by Bundler, so this binstub cannot run.
+Replace `bin/bundle` by running `bundle binstubs bundler --force`, then run this command again.")
+  end
+end
+
+require "rubygems"
+require "bundler/setup"
+
+load Gem.bin_path("tapioca", "tapioca")

data/dev.yml

@@ -3,7 +3,7 @@ name: packwerk
 type: ruby
 
 up:
-  - ruby: 2.6.6
+  - ruby: 3.0.0
   - bundler
 
 commands:
@@ -12,21 +12,21 @@ commands:
       if [[ "$*" =~ ":"[0-9]+ ]];
       then
         # run test by its line number
-        bundle exec m "$@"
+        bin/m "$@"
       elif [[ "$#" -eq 1 && -f "$1" ]];
       then
         # run all tests in given file(s)
-        bundle exec rake test TEST="$@"
+        bin/rake test TEST="$@"
       else
         # run all tests
-        bundle exec rake test
+        bin/rake test
       fi
-  style: "bundle exec rubocop -D --auto-correct"
+  style: "bin/rubocop -D --auto-correct"
   typecheck:
     desc: "run Sorbet typechecking"
-    run: "bundle exec srb tc"
+    run: "bin/srb tc"
     aliases: ['tc']
     subcommands:
       update:
         desc: "update RBIs for gems"
-        run: "bundle exec tapioca sync -c 'dev typecheck update'"
+        run: "bin/tapioca sync -c 'dev typecheck update'"

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/gemfiles/Gemfile-rails-6-0

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+source("https://rubygems.org")
+
+gemspec path: ".."
+
+# Specify the same dependency sources as the application Gemfile
+
+gem("spring")
+gem("rails", '~> 6.0.0')
+gem("constant_resolver", require: false)
+gem("sorbet-runtime", require: false)
+gem("rubocop-performance", require: false)
+gem("rubocop-sorbet", require: false)
+gem("mocha", require: false)
+gem("rubocop-shopify", require: false)
+gem("tapioca", require: false)
+
+group :development do
+  gem("byebug", require: false)
+  gem("minitest-focus", require: false)
+end

data/lib/packwerk.rb

@@ -3,40 +3,78 @@
 
 require "sorbet-runtime"
 require "active_support"
-require "constant_resolver"
-
-require "packwerk/offense"
-
-require "packwerk/application_validator"
-require "packwerk/association_inspector"
-require "packwerk/checking_deprecated_references"
-require "packwerk/cli"
-require "packwerk/configuration"
-require "packwerk/const_node_inspector"
-require "packwerk/constant_discovery"
-require "packwerk/dependency_checker"
-require "packwerk/deprecated_references"
-require "packwerk/files_for_processing"
-require "packwerk/file_processor"
-require "packwerk/formatters/progress_formatter"
-require "packwerk/generators/application_validation"
-require "packwerk/generators/configuration_file"
-require "packwerk/generators/inflections_file"
-require "packwerk/generators/root_package"
-require "packwerk/graph"
-require "packwerk/inflector"
-require "packwerk/node_processor"
-require "packwerk/node_visitor"
-require "packwerk/output_styles"
-require "packwerk/package"
-require "packwerk/package_set"
-require "packwerk/parsers"
-require "packwerk/privacy_checker"
-require "packwerk/reference_extractor"
-require "packwerk/run_context"
-require "packwerk/updating_deprecated_references"
-require "packwerk/version"
-require "packwerk/violation_type"
+require "fileutils"
 
 module Packwerk
+  extend ActiveSupport::Autoload
+
+  autoload :ApplicationLoadPaths
+  autoload :ApplicationValidator
+  autoload :AssociationInspector
+  autoload :OffenseCollection
+  autoload :Checker
+  autoload :Cli
+  autoload :Configuration
+  autoload :ConstantDiscovery
+  autoload :ConstantNameInspector
+  autoload :ConstNodeInspector
+  autoload :DependencyChecker
+  autoload :DeprecatedReferences
+  autoload :FileProcessor
+  autoload :FilesForProcessing
+  autoload :Graph
+  autoload :Inflector
+  autoload :Node
+  autoload :NodeProcessor
+  autoload :NodeProcessorFactory
+  autoload :NodeVisitor
+  autoload :Offense
+  autoload :OffensesFormatter
+  autoload :OutputStyle
+  autoload :Package
+  autoload :PackageSet
+  autoload :ParsedConstantDefinitions
+  autoload :Parsers
+  autoload :ParseRun
+  autoload :PrivacyChecker
+  autoload :Reference
+  autoload :ReferenceExtractor
+  autoload :ReferenceOffense
+  autoload :Result
+  autoload :RunContext
+  autoload :Version
+  autoload :ViolationType
+
+  module Inflections
+    extend ActiveSupport::Autoload
+
+    autoload :Custom
+    autoload :Default
+  end
+
+  module OutputStyles
+    extend ActiveSupport::Autoload
+
+    autoload :Coloured
+    autoload :Plain
+  end
+
+  autoload_under "commands" do
+    autoload :OffenseProgressMarker
+  end
+
+  module Formatters
+    extend ActiveSupport::Autoload
+
+    autoload :OffensesFormatter
+    autoload :ProgressFormatter
+  end
+
+  module Generators
+    extend ActiveSupport::Autoload
+
+    autoload :ConfigurationFile
+    autoload :InflectionsFile
+    autoload :RootPackage
+  end
 end