packwerk 1.0.2 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3b54c31e7c1902a03feb01304c85c9f2363b769fdb5f3c3cea7f38c67ff77af3
-  data.tar.gz: efefa11bf554021227ce63a876c891d5466ee7bcd173e319deb086c8ec9732a5
+  metadata.gz: ced63ca0995c039913777f3e8ba1aac428970d8fc515b1629c9212f71baab34b
+  data.tar.gz: 331b0a5f30e7104b4eb3e44920739ea592e7e3dc7df3dca339a74260fa13d62b
 SHA512:
-  metadata.gz: 5765e07827c5c5fc6d297f916e80c6cd2a6e09984ba91a1f2186ce1209d7965c7d906b6ff06a6b50fd37c299cdb9f82188d57273faf6e0fe7c654983ff8c0e8d
-  data.tar.gz: b44c1ba5e1c5b61dd2d3e4755b5c215f245cb412a05f272513a6eba83e561097d6f6e624d65f5e8fa7021479616433f0e37ca9b818f00363efd11f24f8b6bca6
+  metadata.gz: a487a501ca28d341a888eea2e0ec13c4831897680ce1d17bef2a4943408ff718d75cffe9a50030fd93d7a2388d161c7a3cd946a0764930f89016c2f2c81e5306
+  data.tar.gz: d4685f869617c8b1141125fcaacbde96839be3d239aa2422db6f76dbcb485f42fcde97e0c6aaa580ef4abcd847ebbfd9979fe4896f0bc5c7421d104673346981

data/.github/workflows/ci.yml

@@ -7,10 +7,19 @@ jobs:
     runs-on: ubuntu-latest
     strategy:
       matrix:
+        gemfile:
+          - Gemfile
+          - gemfiles/Gemfile-rails-6-0
         ruby:
           - 2.6
           - 2.7
-    name: Tests Ruby ${{ matrix.ruby }}
+          - 3.0
+        exclude:
+          - ruby: 2.6
+            gemfile: Gemfile
+    env:
+      BUNDLE_GEMFILE: ${{ matrix.gemfile }}
+    name: "Tests: Ruby ${{ matrix.ruby }} ${{ matrix.gemfile }}"
     steps:
       - uses: actions/checkout@v1
       - name: Set up Ruby ${{ matrix.ruby }}
@@ -26,10 +35,10 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - uses: actions/checkout@v1
-      - name: Set up Ruby 2.6
+      - name: Set up Ruby
         uses: actions/setup-ruby@v1
         with:
-          ruby-version: 2.6.x
+          ruby-version: 3.0.x
       - name: Run style checks
         run: |
           gem install bundler
@@ -39,10 +48,10 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - uses: actions/checkout@v1
-      - name: Set up Ruby 2.6
+      - name: Set up Ruby
         uses: actions/setup-ruby@v1
         with:
-          ruby-version: 2.6.x
+          ruby-version: 3.0.x
       - name: Run static type checks
         run: |
           gem install bundler

data/.ruby-version

@@ -1 +1 @@
-2.6.6
+3.0.0

data/Gemfile

@@ -8,7 +8,7 @@ gemspec
 # Specify the same dependency sources as the application Gemfile
 
 gem("spring")
-gem("rails", github: "rails/rails")
+gem("rails", github: "rails/rails", branch: "main")
 gem("constant_resolver", require: false)
 gem("sorbet-runtime", require: false)
 gem("rubocop-performance", require: false)

data/Gemfile.lock

@@ -1,103 +1,106 @@
 GIT
   remote: https://github.com/rails/rails.git
-  revision: d80c18a391e33552ae2d943e68af56946f883f65
+  revision: d612542336d9a61381311c95a27d801bb4094779
+  branch: main
   specs:
-    actioncable (6.1.0.alpha)
-      actionpack (= 6.1.0.alpha)
-      activesupport (= 6.1.0.alpha)
+    actioncable (7.0.0.alpha)
+      actionpack (= 7.0.0.alpha)
+      activesupport (= 7.0.0.alpha)
       nio4r (~> 2.0)
       websocket-driver (>= 0.6.1)
-    actionmailbox (6.1.0.alpha)
-      actionpack (= 6.1.0.alpha)
-      activejob (= 6.1.0.alpha)
-      activerecord (= 6.1.0.alpha)
-      activestorage (= 6.1.0.alpha)
-      activesupport (= 6.1.0.alpha)
+    actionmailbox (7.0.0.alpha)
+      actionpack (= 7.0.0.alpha)
+      activejob (= 7.0.0.alpha)
+      activerecord (= 7.0.0.alpha)
+      activestorage (= 7.0.0.alpha)
+      activesupport (= 7.0.0.alpha)
       mail (>= 2.7.1)
-    actionmailer (6.1.0.alpha)
-      actionpack (= 6.1.0.alpha)
-      actionview (= 6.1.0.alpha)
-      activejob (= 6.1.0.alpha)
-      activesupport (= 6.1.0.alpha)
+    actionmailer (7.0.0.alpha)
+      actionpack (= 7.0.0.alpha)
+      actionview (= 7.0.0.alpha)
+      activejob (= 7.0.0.alpha)
+      activesupport (= 7.0.0.alpha)
       mail (~> 2.5, >= 2.5.4)
       rails-dom-testing (~> 2.0)
-    actionpack (6.1.0.alpha)
-      actionview (= 6.1.0.alpha)
-      activesupport (= 6.1.0.alpha)
+    actionpack (7.0.0.alpha)
+      actionview (= 7.0.0.alpha)
+      activesupport (= 7.0.0.alpha)
       rack (~> 2.0, >= 2.0.9)
       rack-test (>= 0.6.3)
       rails-dom-testing (~> 2.0)
       rails-html-sanitizer (~> 1.0, >= 1.2.0)
-    actiontext (6.1.0.alpha)
-      actionpack (= 6.1.0.alpha)
-      activerecord (= 6.1.0.alpha)
-      activestorage (= 6.1.0.alpha)
-      activesupport (= 6.1.0.alpha)
+    actiontext (7.0.0.alpha)
+      actionpack (= 7.0.0.alpha)
+      activerecord (= 7.0.0.alpha)
+      activestorage (= 7.0.0.alpha)
+      activesupport (= 7.0.0.alpha)
       nokogiri (>= 1.8.5)
-    actionview (6.1.0.alpha)
-      activesupport (= 6.1.0.alpha)
+    actionview (7.0.0.alpha)
+      activesupport (= 7.0.0.alpha)
       builder (~> 3.1)
       erubi (~> 1.4)
       rails-dom-testing (~> 2.0)
       rails-html-sanitizer (~> 1.1, >= 1.2.0)
-    activejob (6.1.0.alpha)
-      activesupport (= 6.1.0.alpha)
+    activejob (7.0.0.alpha)
+      activesupport (= 7.0.0.alpha)
       globalid (>= 0.3.6)
-    activemodel (6.1.0.alpha)
-      activesupport (= 6.1.0.alpha)
-    activerecord (6.1.0.alpha)
-      activemodel (= 6.1.0.alpha)
-      activesupport (= 6.1.0.alpha)
-    activestorage (6.1.0.alpha)
-      actionpack (= 6.1.0.alpha)
-      activejob (= 6.1.0.alpha)
-      activerecord (= 6.1.0.alpha)
-      activesupport (= 6.1.0.alpha)
-      marcel (~> 0.3.1)
-    activesupport (6.1.0.alpha)
+    activemodel (7.0.0.alpha)
+      activesupport (= 7.0.0.alpha)
+    activerecord (7.0.0.alpha)
+      activemodel (= 7.0.0.alpha)
+      activesupport (= 7.0.0.alpha)
+    activestorage (7.0.0.alpha)
+      actionpack (= 7.0.0.alpha)
+      activejob (= 7.0.0.alpha)
+      activerecord (= 7.0.0.alpha)
+      activesupport (= 7.0.0.alpha)
+      marcel (~> 1.0.0)
+      mini_mime (~> 1.0.2)
+    activesupport (7.0.0.alpha)
       concurrent-ruby (~> 1.0, >= 1.0.2)
       i18n (>= 1.6, < 2)
-      minitest (~> 5.1)
+      minitest (>= 5.1)
       tzinfo (~> 2.0)
       zeitwerk (~> 2.3)
-    rails (6.1.0.alpha)
-      actioncable (= 6.1.0.alpha)
-      actionmailbox (= 6.1.0.alpha)
-      actionmailer (= 6.1.0.alpha)
-      actionpack (= 6.1.0.alpha)
-      actiontext (= 6.1.0.alpha)
-      actionview (= 6.1.0.alpha)
-      activejob (= 6.1.0.alpha)
-      activemodel (= 6.1.0.alpha)
-      activerecord (= 6.1.0.alpha)
-      activestorage (= 6.1.0.alpha)
-      activesupport (= 6.1.0.alpha)
-      bundler (>= 1.3.0)
-      railties (= 6.1.0.alpha)
+    rails (7.0.0.alpha)
+      actioncable (= 7.0.0.alpha)
+      actionmailbox (= 7.0.0.alpha)
+      actionmailer (= 7.0.0.alpha)
+      actionpack (= 7.0.0.alpha)
+      actiontext (= 7.0.0.alpha)
+      actionview (= 7.0.0.alpha)
+      activejob (= 7.0.0.alpha)
+      activemodel (= 7.0.0.alpha)
+      activerecord (= 7.0.0.alpha)
+      activestorage (= 7.0.0.alpha)
+      activesupport (= 7.0.0.alpha)
+      bundler (>= 1.15.0)
+      railties (= 7.0.0.alpha)
       sprockets-rails (>= 2.0.0)
-    railties (6.1.0.alpha)
-      actionpack (= 6.1.0.alpha)
-      activesupport (= 6.1.0.alpha)
+    railties (7.0.0.alpha)
+      actionpack (= 7.0.0.alpha)
+      activesupport (= 7.0.0.alpha)
       method_source
-      rake (>= 0.8.7)
+      rake (>= 0.13)
       thor (~> 1.0)
 
 PATH
   remote: .
   specs:
-    packwerk (1.0.2)
+    packwerk (1.2.0)
       activesupport (>= 5.2)
       ast
       better_html
       constant_resolver
+      parallel
       parser
       sorbet-runtime
 
 GEM
   remote: https://rubygems.org/
   specs:
-    ast (2.4.1)
-    better_html (1.0.15)
+    ast (2.4.2)
+    better_html (1.0.16)
       actionview (>= 4.0)
       activesupport (>= 4.0)
       ast (~> 2.0)
@@ -111,18 +114,17 @@ GEM
     colorize (0.8.1)
     commander (4.5.2)
       highline (~> 2.0.0)
-    concurrent-ruby (1.1.6)
+    concurrent-ruby (1.1.8)
     constant_resolver (0.1.5)
     crass (1.0.6)
-    erubi (1.9.0)
+    erubi (1.10.0)
     globalid (0.4.2)
       activesupport (>= 4.2.0)
     highline (2.0.3)
     html_tokenizer (0.0.7)
-    i18n (1.8.2)
+    i18n (1.8.10)
       concurrent-ruby (~> 1.0)
-    jaro_winkler (1.5.4)
-    loofah (2.5.0)
+    loofah (2.9.0)
       crass (~> 1.0.2)
       nokogiri (>= 1.5.9)
     m (1.5.1)
@@ -130,31 +132,33 @@ GEM
       rake (>= 0.9.2.2)
     mail (2.7.1)
       mini_mime (>= 0.1.1)
-    marcel (0.3.3)
-      mimemagic (~> 0.3.2)
+    marcel (1.0.0)
     method_source (1.0.0)
-    mimemagic (0.3.5)
-    mini_mime (1.0.2)
-    mini_portile2 (2.4.0)
-    minitest (5.14.0)
+    mini_mime (1.0.3)
+    mini_portile2 (2.5.1)
+    minitest (5.14.4)
     minitest-focus (1.2.1)
       minitest (>= 4, < 6)
-    mocha (1.11.2)
-    nio4r (2.5.2)
-    nokogiri (1.10.9)
-      mini_portile2 (~> 2.4.0)
-    parallel (1.19.1)
-    parlour (4.0.1)
+    mocha (1.12.0)
+    nio4r (2.5.7)
+    nokogiri (1.11.5)
+      mini_portile2 (~> 2.5.0)
+      racc (~> 1.4)
+    nokogiri (1.11.5-x86_64-darwin)
+      racc (~> 1.4)
+    parallel (1.20.1)
+    parlour (6.0.0)
       commander (~> 4.5)
       parser
       rainbow (~> 3.0)
       sorbet-runtime (>= 0.5)
-    parser (2.7.1.4)
+    parser (3.0.0.0)
       ast (~> 2.4.1)
-    pry (0.13.1)
+    pry (0.14.0)
       coderay (~> 1.1)
       method_source (~> 1.0)
-    rack (2.2.2)
+    racc (1.5.2)
+    rack (2.2.3)
     rack-test (1.1.0)
       rack (>= 1.0, < 3)
     rails-dom-testing (2.0.3)
@@ -163,59 +167,73 @@ GEM
     rails-html-sanitizer (1.3.0)
       loofah (~> 2.3)
     rainbow (3.0.0)
-    rake (13.0.1)
-    rexml (3.2.4)
-    rubocop (0.82.0)
-      jaro_winkler (~> 1.5.1)
+    rake (13.0.3)
+    regexp_parser (2.1.1)
+    rexml (3.2.5)
+    rubocop (1.12.0)
       parallel (~> 1.10)
-      parser (>= 2.7.0.1)
+      parser (>= 3.0.0.0)
       rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.8, < 3.0)
       rexml
+      rubocop-ast (>= 1.2.0, < 2.0)
       ruby-progressbar (~> 1.7)
-      unicode-display_width (>= 1.4.0, < 2.0)
-    rubocop-performance (1.5.2)
-      rubocop (>= 0.71.0)
-    rubocop-shopify (1.0.2)
-      rubocop (~> 0.82.0)
-    rubocop-sorbet (0.3.7)
-    ruby-progressbar (1.10.1)
+      unicode-display_width (>= 1.4.0, < 3.0)
+    rubocop-ast (1.4.1)
+      parser (>= 2.7.1.5)
+    rubocop-performance (1.10.2)
+      rubocop (>= 0.90.0, < 2.0)
+      rubocop-ast (>= 0.4.0)
+    rubocop-shopify (2.0.1)
+      rubocop (~> 1.11)
+    rubocop-sorbet (0.6.1)
+      rubocop
+    ruby-progressbar (1.11.0)
     smart_properties (1.15.0)
-    sorbet (0.5.5898)
-      sorbet-static (= 0.5.5898)
-    sorbet-runtime (0.5.6049)
-    sorbet-static (0.5.5898-universal-darwin-19)
-    spoom (1.0.4)
+    sorbet (0.5.6360)
+      sorbet-static (= 0.5.6360)
+    sorbet-runtime (0.5.6360)
+    sorbet-static (0.5.6360-universal-darwin-14)
+    sorbet-static (0.5.6360-universal-darwin-15)
+    sorbet-static (0.5.6360-universal-darwin-16)
+    sorbet-static (0.5.6360-universal-darwin-17)
+    sorbet-static (0.5.6360-universal-darwin-18)
+    sorbet-static (0.5.6360-universal-darwin-19)
+    sorbet-static (0.5.6360-universal-darwin-20)
+    sorbet-static (0.5.6360-x86_64-linux)
+    spoom (1.1.0)
       colorize
-      sorbet (~> 0.5.5)
+      sorbet (>= 0.5.6347)
       sorbet-runtime
       thor (>= 0.19.2)
-    spring (2.1.0)
-    sprockets (4.0.0)
+    spring (2.1.1)
+    sprockets (4.0.2)
       concurrent-ruby (~> 1.0)
       rack (> 1, < 3)
-    sprockets-rails (3.2.1)
+    sprockets-rails (3.2.2)
       actionpack (>= 4.0)
       activesupport (>= 4.0)
       sprockets (>= 3.0.0)
-    tapioca (0.4.5)
+    tapioca (0.4.19)
+      bundler (>= 1.17.3)
       parlour (>= 2.1.0)
       pry (>= 0.12.2)
       sorbet-runtime
       sorbet-static (>= 0.4.4471)
       spoom
       thor (>= 0.19.2)
-    thor (1.0.1)
-    tzinfo (2.0.2)
+    thor (1.1.0)
+    tzinfo (2.0.4)
       concurrent-ruby (~> 1.0)
-    unicode-display_width (1.7.0)
-    websocket-driver (0.7.1)
+    unicode-display_width (2.0.0)
+    websocket-driver (0.7.3)
       websocket-extensions (>= 0.1.0)
-    websocket-extensions (0.1.4)
-    zeitwerk (2.3.0)
+    websocket-extensions (0.1.5)
+    zeitwerk (2.4.2)
 
 PLATFORMS
   ruby
-  x86_64-darwin-19
+  x86_64-darwin-20
 
 DEPENDENCIES
   bundler
@@ -236,4 +254,4 @@ DEPENDENCIES
   tapioca
 
 BUNDLED WITH
-   2.1.4
+   2.2.14

data/README.md

@@ -1,9 +1,16 @@
 # Packwerk [![Build Status](https://github.com/Shopify/packwerk/workflows/CI/badge.svg)](https://github.com/Shopify/packwerk/actions?query=workflow%3ACI)
 
+## NOTE: Packwerk is considered to be feature-complete for Shopify's uses. We are currently accepting bug fixes only, and it is not being actively developed. Please fork this project if you are interested in adding new features.
+
+> "I know who you are and because of that I know what you do."  
+> This knowledge is a dependency that raises the cost of change.  
+
+-- _Sandi Metz, Practical Object-Oriented Design in Ruby_
+
 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/USAGE.md

@@ -1,22 +1,22 @@
 # 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.
@@ -63,10 +63,32 @@ Packwerk reads from the `packwerk.yml` configuration file in the root directory.
 |----------------------|-------------------------------------------|--------------|
 | 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        | **/                                       | patterns to find package configuration files, see: Defining packages |
+| 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
+
+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