packwerk 1.2.0 → 1.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ced63ca0995c039913777f3e8ba1aac428970d8fc515b1629c9212f71baab34b
-  data.tar.gz: 331b0a5f30e7104b4eb3e44920739ea592e7e3dc7df3dca339a74260fa13d62b
+  metadata.gz: c73a1063d42615133bdd6a3cc797838f0d4a0b71c716a5a6dd2730c125723ca8
+  data.tar.gz: ede1cf336fb3c64f0093c9b853bc4db9e06004d8bfd297fd9ff60a6253c16e1c
 SHA512:
-  metadata.gz: a487a501ca28d341a888eea2e0ec13c4831897680ce1d17bef2a4943408ff718d75cffe9a50030fd93d7a2388d161c7a3cd946a0764930f89016c2f2c81e5306
-  data.tar.gz: d4685f869617c8b1141125fcaacbde96839be3d239aa2422db6f76dbcb485f42fcde97e0c6aaa580ef4abcd847ebbfd9979fe4896f0bc5c7421d104673346981
+  metadata.gz: 3a2dd60787d4b8bb40e40491fb364321c0e2d086df7315b64ccb7a27b21f28d4e5e1855d40b52c1aadcbaf61d02ececa43d186fc10abdbe1de2c9609469586ef
+  data.tar.gz: 327267b82f798960ccf5a295125a980077bcfb9dfc00587583dcefbdcd1bfcea935f79f0f4c2efebad8d90d08807d6f08d800240bc4315ded513abdca9efcce0

data/.github/workflows/ci.yml

@@ -30,7 +30,7 @@ jobs:
         run: |
           gem install bundler
           bundle install --jobs 4 --retry 3
-          bundle exec rake
+          bin/rake
   lint:
     runs-on: ubuntu-latest
     steps:
@@ -43,7 +43,7 @@ jobs:
         run: |
           gem install bundler
           bundle install --jobs 4 --retry 3
-          bundle exec rubocop
+          bin/rubocop
   static-type-checking:
     runs-on: ubuntu-latest
     steps:
@@ -56,4 +56,4 @@ jobs:
         run: |
           gem install bundler
           bundle install --jobs 4 --retry 3
-          bundle exec srb tc
+          bin/srb tc

data/Gemfile.lock

@@ -87,7 +87,7 @@ GIT
 PATH
   remote: .
   specs:
-    packwerk (1.2.0)
+    packwerk (1.3.0)
       activesupport (>= 5.2)
       ast
       better_html

data/README.md

@@ -2,8 +2,8 @@
 
 ## 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.  
+> "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_
 
@@ -47,7 +47,7 @@ Or install it yourself as:
 
     $ gem install packwerk
 
-3. Run `bundle exec packwerk init` to generate the configuration files
+3. Run `packwerk init` to generate the configuration files
 
 ## Usage
 
@@ -59,7 +59,7 @@ Read [USAGE.md](USAGE.md) for usage once Packwerk is installed on your project.
 
 ## Development
 
-After checking out the repo, run `bin/setup` to install dependencies. Then, run `bundle exec rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
 
 ## Limitations
 

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,6 +1,7 @@
 # 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)
@@ -19,11 +20,13 @@
   * [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)
@@ -133,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.
@@ -152,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:
@@ -169,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:
@@ -228,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)
 
@@ -248,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

@@ -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/lib/packwerk.rb

@@ -73,7 +73,6 @@ module Packwerk
   module Generators
     extend ActiveSupport::Autoload
 
-    autoload :ApplicationValidation
     autoload :ConfigurationFile
     autoload :InflectionsFile
     autoload :RootPackage

data/lib/packwerk/application_load_paths.rb

@@ -8,20 +8,15 @@ module Packwerk
     class << self
       extend T::Sig
 
-      sig { returns(T::Array[String]) }
-      def extract_relevant_paths
-        assert_application_booted
+      sig { params(root: String, environment: String).returns(T::Array[String]) }
+      def extract_relevant_paths(root, environment)
+        require_application(root, environment)
         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
@@ -54,6 +49,21 @@ module Packwerk
           .uniq
       end
 
+      private
+
+      sig { params(root: String, environment: String).void }
+      def require_application(root, environment)
+        environment_file = "#{root}/config/environment"
+
+        if File.file?("#{environment_file}.rb")
+          ENV["RAILS_ENV"] ||= environment
+
+          require environment_file
+        else
+          raise "A Rails application could not be found in #{root}"
+        end
+      end
+
       sig { params(paths: T::Array[T.untyped]).void }
       def assert_load_paths_present(paths)
         if paths.empty?

data/lib/packwerk/application_validator.rb

@@ -1,4 +1,4 @@
-# typed: false
+# typed: true
 # frozen_string_literal: true
 
 require "active_support/inflector/inflections"
@@ -8,11 +8,12 @@ require "yaml"
 
 module Packwerk
   class ApplicationValidator
-    def initialize(config_file_path:, configuration:)
+    def initialize(config_file_path:, configuration:, environment:)
       @config_file_path = config_file_path
       @configuration = configuration
+      @environment = environment
 
-      @application_load_paths = ApplicationLoadPaths.extract_relevant_paths
+      @application_load_paths = ApplicationLoadPaths.extract_relevant_paths(configuration.root_path, environment)
     end
 
     Result = Struct.new(:ok?, :error_value)
@@ -176,21 +177,9 @@ module Packwerk
       edges = package_set.flat_map do |package|
         package.dependencies.map { |dependency| [package, package_set.fetch(dependency)] }
       end
-      dependency_graph = Packwerk::Graph.new(*edges)
-
-      # Convert the cycle
-      #
-      #   [a, b, c]
-      #
-      # to the string
-      #
-      #   a -> b -> c -> a
-      #
-      cycle_strings = dependency_graph.cycles.map do |cycle|
-        cycle_strings = cycle.map(&:to_s)
-        cycle_strings << cycle.first.to_s
-        "\t- #{cycle_strings.join(" → ")}"
-      end
+      dependency_graph = Packwerk::Graph.new(*T.unsafe(edges))
+
+      cycle_strings = build_cycle_strings(dependency_graph.cycles)
 
       if dependency_graph.acyclic?
         Result.new(true)
@@ -279,6 +268,21 @@ module Packwerk
 
     private
 
+    # Convert the cycles:
+    #
+    #   [[a, b, c], [b, c]]
+    #
+    # to the string:
+    #
+    #   ["a -> b -> c -> a", "b -> c -> b"]
+    def build_cycle_strings(cycles)
+      cycles.map do |cycle|
+        cycle_strings = cycle.map(&:to_s)
+        cycle_strings << cycle.first.to_s
+        "\t- #{cycle_strings.join(" → ")}"
+      end
+    end
+
     def package_manifests_settings_for(setting)
       package_manifests.map { |f| [f, (YAML.load_file(File.join(f)) || {})[setting]] }
     end

data/lib/packwerk/cli.rb

@@ -10,6 +10,7 @@ module Packwerk
         configuration: T.nilable(Configuration),
         out: T.any(StringIO, IO),
         err_out: T.any(StringIO, IO),
+        environment: String,
         style: Packwerk::OutputStyle,
         offenses_formatter: T.nilable(Packwerk::OffensesFormatter)
       ).void
@@ -18,11 +19,13 @@ module Packwerk
       configuration: nil,
       out: $stdout,
       err_out: $stderr,
+      environment: "test",
       style: OutputStyles::Plain.new,
       offenses_formatter: nil
     )
       @out = out
       @err_out = err_out
+      @environment = environment
       @style = style
       @configuration = configuration || Configuration.from_path
       @progress_formatter = Formatters::ProgressFormatter.new(@out, style: style)
@@ -77,28 +80,12 @@ module Packwerk
     def init
       @out.puts("📦 Initializing Packwerk...")
 
-      application_validation = Packwerk::Generators::ApplicationValidation.generate(
-        for_rails_app: rails_app?,
-        root: @configuration.root_path,
-        out: @out
-      )
-
-      if application_validation
-        if rails_app?
-          # To run in the same space as the Rails process,
-          # in order to fetch load paths for the configuration generator
-          exec("bin/packwerk", "generate_configs")
-        else
-          generate_configurations = generate_configs
-        end
-      end
-
-      application_validation && generate_configurations
+      generate_configs
     end
 
     def generate_configs
       configuration_file = Packwerk::Generators::ConfigurationFile.generate(
-        load_paths: Packwerk::ApplicationLoadPaths.extract_relevant_paths,
+        load_paths: Packwerk::ApplicationLoadPaths.extract_relevant_paths(@configuration.root_path, @environment),
         root: @configuration.root_path,
         out: @out
       )
@@ -144,14 +131,11 @@ module Packwerk
     end
 
     def validate(_paths)
-      warn("`packwerk validate` should be run within the application. "\
-        "Generate the bin script using `packwerk init` and"\
-        " use `bin/packwerk validate` instead.") unless defined?(::Rails)
-
       @progress_formatter.started_validation do
         checker = Packwerk::ApplicationValidator.new(
           config_file_path: @configuration.config_path,
-          configuration: @configuration
+          configuration: @configuration,
+          environment: @environment,
         )
         result = checker.check_all
 
@@ -171,15 +155,6 @@ module Packwerk
       end
     end
 
-    sig { returns(T::Boolean) }
-    def rails_app?
-      if File.exist?("config/application.rb") && File.exist?("bin/rails")
-        File.foreach("Gemfile").any? { |line| line.match?(/['"]rails['"]/) }
-      else
-        false
-      end
-    end
-
     def parse_run(paths)
       ParseRun.new(
         files: fetch_files_to_process(paths),

data/lib/packwerk/deprecated_references.rb

@@ -73,7 +73,7 @@ module Packwerk
           #
           # You can regenerate this file using the following command:
           #
-          # bundle exec packwerk update-deprecations #{@package.name}
+          # packwerk update-deprecations #{@package.name}
         MESSAGE
         File.open(@filepath, "w") do |f|
           f.write(message)

data/lib/packwerk/formatters/offenses_formatter.rb

@@ -15,7 +15,7 @@ module Packwerk
 
       sig { override.params(offenses: T::Array[T.nilable(Offense)]).returns(String) }
       def show_offenses(offenses)
-        return "No offenses detected 🎉" if offenses.empty?
+        return "No offenses detected" if offenses.empty?
 
         <<~EOS
           #{offenses_list(offenses)}
@@ -23,6 +23,15 @@ module Packwerk
         EOS
       end
 
+      sig { override.params(offense_collection: Packwerk::OffenseCollection).returns(String) }
+      def show_stale_violations(offense_collection)
+        if offense_collection.stale_violations?
+          "There were stale violations found, please run `packwerk update-deprecations`"
+        else
+          "No stale violations detected"
+        end
+      end
+
       private
 
       sig { params(offenses: T::Array[T.nilable(Offense)]).returns(String) }

data/lib/packwerk/offenses_formatter.rb

@@ -11,5 +11,9 @@ module Packwerk
     sig { abstract.params(offenses: T::Array[T.nilable(Offense)]).returns(String) }
     def show_offenses(offenses)
     end
+
+    sig { abstract.params(offense_collection: Packwerk::OffenseCollection).returns(String) }
+    def show_stale_violations(offense_collection)
+    end
   end
 end

data/lib/packwerk/package.rb

@@ -33,7 +33,15 @@ module Packwerk
     end
 
     def public_path
-      @public_path ||= File.join(@name, user_defined_public_path || "app/public/")
+      @public_path ||= begin
+        unprefixed_public_path = user_defined_public_path || "app/public/"
+
+        if root?
+          unprefixed_public_path
+        else
+          File.join(@name, unprefixed_public_path)
+        end
+      end
     end
 
     def public_path?(path)

data/lib/packwerk/parse_run.rb

@@ -24,11 +24,7 @@ module Packwerk
       offense_collection = find_offenses
 
       result_status = !offense_collection.stale_violations?
-      message = if result_status
-        "No stale violations detected"
-      else
-        "There were stale violations found, please run `packwerk update-deprecations`"
-      end
+      message = @offenses_formatter.show_stale_violations(offense_collection)
 
       Result.new(message: message, status: result_status)
     end
@@ -47,8 +43,14 @@ module Packwerk
 
     def check
       offense_collection = find_offenses(show_errors: true)
-      message = @offenses_formatter.show_offenses(offense_collection.outstanding_offenses)
-      Result.new(message: message, status: offense_collection.outstanding_offenses.empty?)
+
+      messages = [
+        @offenses_formatter.show_offenses(offense_collection.outstanding_offenses),
+        @offenses_formatter.show_stale_violations(offense_collection),
+      ]
+      result_status = offense_collection.outstanding_offenses.empty? && !offense_collection.stale_violations?
+
+      Result.new(message: messages.join("\n") + "\n", status: result_status)
     end
 
     private

data/lib/packwerk/version.rb

@@ -2,5 +2,5 @@
 # frozen_string_literal: true
 
 module Packwerk
-  VERSION = "1.2.0"
+  VERSION = "1.3.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: packwerk
 version: !ruby/object:Gem::Version
-  version: 1.2.0
+  version: 1.3.0
 platform: ruby
 authors:
 - Shopify Inc.
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2021-06-10 00:00:00.000000000 Z
+date: 2021-07-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -192,7 +192,12 @@ files:
 - TROUBLESHOOT.md
 - USAGE.md
 - bin/console
+- bin/m
+- bin/rake
+- bin/rubocop
 - bin/setup
+- bin/srb
+- bin/tapioca
 - dev.yml
 - docs/cohesion.png
 - exe/packwerk
@@ -213,15 +218,12 @@ files:
 - lib/packwerk/files_for_processing.rb
 - lib/packwerk/formatters/offenses_formatter.rb
 - lib/packwerk/formatters/progress_formatter.rb
-- lib/packwerk/generators/application_validation.rb
 - lib/packwerk/generators/configuration_file.rb
 - lib/packwerk/generators/inflections_file.rb
 - lib/packwerk/generators/root_package.rb
 - lib/packwerk/generators/templates/inflections.yml
 - lib/packwerk/generators/templates/package.yml
-- lib/packwerk/generators/templates/packwerk
 - lib/packwerk/generators/templates/packwerk.yml.erb
-- lib/packwerk/generators/templates/packwerk_validator_test.rb
 - lib/packwerk/graph.rb
 - lib/packwerk/inflections/custom.rb
 - lib/packwerk/inflections/default.rb
@@ -251,7 +253,6 @@ files:
 - lib/packwerk/result.rb
 - lib/packwerk/run_context.rb
 - lib/packwerk/sanity_checker.rb
-- lib/packwerk/spring_command.rb
 - lib/packwerk/version.rb
 - lib/packwerk/violation_type.rb
 - library.yml
@@ -353,7 +354,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.17
+rubygems_version: 3.2.20
 signing_key: 
 specification_version: 4
 summary: Packages for applications based on the zeitwerk autoloader

data/lib/packwerk/generators/application_validation.rb

@@ -1,62 +0,0 @@
-# typed: true
-# frozen_string_literal: true
-
-module Packwerk
-  module Generators
-    class ApplicationValidation
-      class << self
-        def generate(for_rails_app: false, root: ".", out: $stdout)
-          new(root, out: out).generate(for_rails_app: for_rails_app)
-        end
-      end
-
-      def initialize(root, out: $stdout)
-        @root = root
-        @out = out
-      end
-
-      def generate(for_rails_app:)
-        @out.puts("📦 Generating application validator...")
-        if for_rails_app
-          generate_packwerk_validate_script
-        else
-          generate_validation_test
-        end
-      end
-
-      private
-
-      def generate_packwerk_validate_script
-        destination_file_path = File.join(@root, "bin")
-        FileUtils.mkdir_p(destination_file_path)
-
-        if File.exist?(File.join(destination_file_path, "packwerk"))
-          @out.puts("⚠️  Packwerk application validation bin script already exists.")
-          return true
-        end
-
-        source_file_path = File.expand_path("templates/packwerk", __dir__)
-        FileUtils.cp(source_file_path, destination_file_path)
-
-        @out.puts("✅ Packwerk application validation bin script generated in #{destination_file_path}")
-        true
-      end
-
-      def generate_validation_test
-        destination_file_path = File.join(@root, "test")
-        FileUtils.mkdir_p(destination_file_path)
-
-        if File.exist?(File.join(destination_file_path, "packwerk_validator_test.rb"))
-          @out.puts("⚠️  Packwerk application validation test already exists.")
-          return true
-        end
-
-        source_file_path = File.expand_path("templates/packwerk_validator_test.rb", __dir__)
-        FileUtils.cp(source_file_path, destination_file_path)
-
-        @out.puts("✅ Packwerk application validation test generated in #{destination_file_path}")
-        true
-      end
-    end
-  end
-end

data/lib/packwerk/generators/templates/packwerk

@@ -1,23 +0,0 @@
-#!/usr/bin/env ruby
-# frozen_string_literal: true
-
-# This file was auto-generated by Packwerk through `packwerk init`
-
-# Needs to be run in test environment in order to have test helper paths available in the autoload paths
-ENV["RAILS_ENV"] = "test"
-
-# Command line arguments needs to be duplicated because spring modifies it
-packwerk_argv = ARGV.dup
-
-begin
-  load(File.expand_path("spring", __dir__))
-rescue LoadError => e
-  raise unless e.message.include?("spring")
-end
-
-require File.expand_path("../config/environment", __dir__)
-
-require "packwerk"
-
-cli = Packwerk::Cli.new
-cli.run(packwerk_argv)

data/lib/packwerk/generators/templates/packwerk_validator_test.rb

@@ -1,11 +0,0 @@
-# frozen_string_literal: true
-
-require "test_helper"
-require "packwerk"
-
-# This test is necessary to make sure that the package system is working correctly
-class PackwerkValidatorTest < Minitest::Test
-  def test_the_application_is_correctly_set_up_for_the_package_system
-    assert(Packwerk::Cli.new.execute_command(["validate"]))
-  end
-end

data/lib/packwerk/spring_command.rb

@@ -1,28 +0,0 @@
-# frozen_string_literal: true
-# typed: false
-
-require "spring/commands"
-
-module Packwerk
-  class SpringCommand
-    def env(*)
-      # Packwerk needs to run in a test environment, which has a set of autoload paths that are
-      # often a superset of the dev/prod paths (for example, test/support/helpers)
-      "test"
-    end
-
-    def exec_name
-      "packwerk"
-    end
-
-    def gem_name
-      "packwerk"
-    end
-
-    def call
-      load(Gem.bin_path(gem_name, exec_name))
-    end
-  end
-
-  Spring.register_command("packwerk", SpringCommand.new)
-end