packwerk 1.0.2 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3b54c31e7c1902a03feb01304c85c9f2363b769fdb5f3c3cea7f38c67ff77af3
-  data.tar.gz: efefa11bf554021227ce63a876c891d5466ee7bcd173e319deb086c8ec9732a5
+  metadata.gz: 91ec92f15d9d87fa8c54861afd424fe6149ef8f8e05f114b6ee04559fa6053fc
+  data.tar.gz: b83cc17ff9cd7d2d37db4456017d429b4a8f8e45766cdfa4551ace2e32c58183
 SHA512:
-  metadata.gz: 5765e07827c5c5fc6d297f916e80c6cd2a6e09984ba91a1f2186ce1209d7965c7d906b6ff06a6b50fd37c299cdb9f82188d57273faf6e0fe7c654983ff8c0e8d
-  data.tar.gz: b44c1ba5e1c5b61dd2d3e4755b5c215f245cb412a05f272513a6eba83e561097d6f6e624d65f5e8fa7021479616433f0e37ca9b818f00363efd11f24f8b6bca6
+  metadata.gz: 596f4f1a6b026e96ab6299e9ba7ceb63b7d709bd49c0629390f50e62e751174e4a92557243bef3a8f7f36aaf416e54fbf1fdb9f368fc2e478eb033e208358dc6
+  data.tar.gz: fdca4107315ea6140d7b92e5cd7b53216a73f65fac4c1c3147c798a1d407f75d3898b31517bec6bf2452e7ca0a3d1ad87599142250cf75684ccc9a48436bcd91

data/Gemfile.lock

@@ -85,7 +85,7 @@ GIT
 PATH
   remote: .
   specs:
-    packwerk (1.0.2)
+    packwerk (1.1.0)
       activesupport (>= 5.2)
       ast
       better_html

data/USAGE.md

@@ -63,10 +63,31 @@ 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 |
 
+### 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
 

data/lib/packwerk/application_validator.rb

@@ -32,7 +32,7 @@ module Packwerk
         check_acyclic_graph,
         check_package_manifest_paths,
         check_valid_package_dependencies,
-        check_root_package_exist,
+        check_root_package_exists,
       ]
 
       results.reject!(&:ok?)
@@ -207,7 +207,7 @@ module Packwerk
     end
 
     def check_acyclic_graph
-      packages = Packwerk::PackageSet.load_all_from(".")
+      packages = Packwerk::PackageSet.load_all_from(@configuration.root_path)
 
       edges = packages.flat_map do |package|
         package.dependencies.map { |dependency| [package, packages.fetch(dependency)] }
@@ -297,7 +297,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)
 

data/lib/packwerk/cache_deprecated_references.rb

@@ -0,0 +1,47 @@
+# typed: true
+# frozen_string_literal: true
+
+require "sorbet-runtime"
+
+require "packwerk/deprecated_references"
+require "packwerk/reference"
+require "packwerk/reference_lister"
+require "packwerk/violation_type"
+
+module Packwerk
+  class CacheDeprecatedReferences
+    extend T::Sig
+    extend T::Helpers
+    include ReferenceLister
+    abstract!
+
+    def initialize(root_path, deprecated_references = {})
+      @root_path = root_path
+      @deprecated_references = T.let(deprecated_references, T::Hash[String, Packwerk::DeprecatedReferences])
+    end
+
+    sig do
+      params(reference: Packwerk::Reference, violation_type: ViolationType)
+        .returns(T::Boolean)
+        .override
+    end
+    def listed?(reference, violation_type:)
+      deprecated_references = deprecated_references_for(reference.source_package)
+      deprecated_references.add_entries(reference, violation_type.serialize)
+      true
+    end
+
+    private
+
+    def deprecated_references_for(package)
+      @deprecated_references[package] ||= Packwerk::DeprecatedReferences.new(
+        package,
+        deprecated_references_file_for(package),
+      )
+    end
+
+    def deprecated_references_file_for(package)
+      File.join(@root_path, package.name, "deprecated_references.yml")
+    end
+  end
+end

data/lib/packwerk/cli.rb

@@ -12,10 +12,13 @@ require "packwerk/output_styles"
 require "packwerk/run_context"
 require "packwerk/updating_deprecated_references"
 require "packwerk/checking_deprecated_references"
+require "packwerk/commands/detect_stale_violations_command"
+require "packwerk/commands/offense_progress_marker"
 
 module Packwerk
   class Cli
     extend T::Sig
+    include OffenseProgressMarker
 
     def initialize(run_context: nil, configuration: nil, out: $stdout, err_out: $stderr, style: OutputStyles::Plain)
       @out = out
@@ -45,6 +48,8 @@ module Packwerk
         generate_configs
       when "check"
         check(args)
+      when "detect-stale-violations"
+        detect_stale_violations(args)
       when "update"
         update(args)
       when "update-deprecations"
@@ -142,7 +147,9 @@ module Packwerk
       all_offenses = T.let([], T.untyped)
       execution_time = Benchmark.realtime do
         all_offenses = files.flat_map do |path|
-          @run_context.process_file(file: path).tap { |offenses| mark_progress(offenses) }
+          @run_context.process_file(file: path).tap do |offenses|
+            mark_progress(offenses: offenses, progress_formatter: @progress_formatter)
+          end
         end
 
         updating_deprecated_references.dump_deprecated_references_files
@@ -165,7 +172,7 @@ module Packwerk
       execution_time = Benchmark.realtime do
         files.each do |path|
           @run_context.process_file(file: path).tap do |offenses|
-            mark_progress(offenses)
+            mark_progress(offenses: offenses, progress_formatter: @progress_formatter)
             all_offenses.concat(offenses)
           end
         end
@@ -181,6 +188,18 @@ module Packwerk
       all_offenses.empty?
     end
 
+    def detect_stale_violations(paths)
+      detect_stale_violations = DetectStaleViolationsCommand.new(
+        files: fetch_files_to_process(paths),
+        configuration: @configuration,
+        progress_formatter: @progress_formatter
+      )
+      result = detect_stale_violations.run
+      @out.puts
+      @out.puts(result.message)
+      result.status
+    end
+
     def fetch_files_to_process(paths)
       files = FilesForProcessing.fetch(paths: paths, configuration: @configuration)
       abort("No files found or given. "\
@@ -188,14 +207,6 @@ module Packwerk
       files
     end
 
-    def mark_progress(offenses)
-      if offenses.empty?
-        @progress_formatter.mark_as_inspected
-      else
-        @progress_formatter.mark_as_failed
-      end
-    end
-
     def validate(_paths)
       warn("`packwerk validate` should be run within the application. "\
         "Generate the bin script using `packwerk init` and"\

data/lib/packwerk/commands/detect_stale_violations_command.rb

@@ -0,0 +1,63 @@
+# typed: true
+# frozen_string_literal: true
+require "packwerk/cli"
+require "sorbet-runtime"
+require "benchmark"
+require "packwerk/configuration"
+require "packwerk/formatters/progress_formatter"
+require "packwerk/run_context"
+require "packwerk/detect_stale_deprecated_references"
+require "packwerk/commands/offense_progress_marker"
+
+module Packwerk
+  class DetectStaleViolationsCommand
+    extend T::Sig
+    include OffenseProgressMarker
+    Result = Struct.new(:message, :status)
+
+    def initialize(files:, configuration:, run_context: nil, progress_formatter: nil, reference_lister: nil)
+      @configuration = configuration
+      @run_context = run_context
+      @reference_lister = reference_lister
+      @progress_formatter = progress_formatter
+      @files = files
+    end
+
+    sig { returns(Result) }
+    def run
+      @progress_formatter.started(@files)
+
+      all_offenses = T.let([], T.untyped)
+      execution_time = Benchmark.realtime do
+        all_offenses = @files.flat_map do |path|
+          run_context.process_file(file: path).tap do |offenses|
+            mark_progress(offenses: offenses, progress_formatter: @progress_formatter)
+          end
+        end
+      end
+
+      @progress_formatter.finished(execution_time)
+      calculate_result
+    end
+
+    private
+
+    def run_context
+      @run_context ||= Packwerk::RunContext.from_configuration(@configuration, reference_lister: reference_lister)
+    end
+
+    def reference_lister
+      @reference_lister ||= ::Packwerk::DetectStaleDeprecatedReferences.new(@configuration.root_path)
+    end
+
+    sig { returns Result }
+    def calculate_result
+      result_status = !reference_lister.stale_violations?
+      message = "There were stale violations found, please run `packwerk update`"
+      if result_status
+        message = "No stale violations detected"
+      end
+      Result.new(message, result_status)
+    end
+  end
+end

data/lib/packwerk/commands/offense_progress_marker.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+# typed: strict
+require "sorbet-runtime"
+require "packwerk/formatters/progress_formatter"
+
+module Packwerk
+  module OffenseProgressMarker
+    extend T::Sig
+
+    sig do
+      params(
+        offenses: T::Array[T.nilable(::Packwerk::Offense)],
+        progress_formatter: ::Packwerk::Formatters::ProgressFormatter
+      ).void
+    end
+    def mark_progress(offenses:, progress_formatter:)
+      if offenses.empty?
+        progress_formatter.mark_as_inspected
+      else
+        progress_formatter.mark_as_failed
+      end
+    end
+  end
+end

data/lib/packwerk/deprecated_references.rb

@@ -3,6 +3,7 @@
 
 require "sorbet-runtime"
 require "yaml"
+require "sorbet-runtime"
 
 require "packwerk/reference"
 require "packwerk/reference_lister"
@@ -47,6 +48,24 @@ module Packwerk
       @new_entries[reference.constant.package.name] = package_violations
     end
 
+    sig { returns(T::Boolean) }
+    def stale_violations?
+      prepare_entries_for_dump
+      deprecated_references.any? do |package, package_violations|
+        package_violations.any? do |constant_name, entries_for_file|
+          new_entries_violation_types = @new_entries.dig(package, constant_name, "violations")
+          return true if new_entries_violation_types.nil?
+          if entries_for_file["violations"].all? { |type| new_entries_violation_types.include?(type) }
+            stale_violations =
+              entries_for_file["files"] - Array(@new_entries.dig(package, constant_name, "files"))
+            stale_violations.present?
+          else
+            return true
+          end
+        end
+      end
+    end
+
     def dump
       if @new_entries.empty?
         File.delete(@filepath) if File.exist?(@filepath)

data/lib/packwerk/detect_stale_deprecated_references.rb

@@ -0,0 +1,14 @@
+# typed: strict
+# frozen_string_literal: true
+
+require "packwerk/cache_deprecated_references"
+
+module Packwerk
+  class DetectStaleDeprecatedReferences < CacheDeprecatedReferences
+    extend T::Sig
+    sig { returns(T::Boolean) }
+    def stale_violations?
+      @deprecated_references.values.any?(&:stale_violations?)
+    end
+  end
+end

data/lib/packwerk/package_set.rb

@@ -28,8 +28,12 @@ module Packwerk
       def package_paths(root_path, package_pathspec)
         bundle_path_match = Bundler.bundle_path.join("**").to_s
 
-        Dir.glob(File.join(root_path, package_pathspec, PACKAGE_CONFIG_FILENAME))
-          .map { |path| Pathname.new(path) }
+        glob_patterns = Array(package_pathspec).map do |pathspec|
+          File.join(root_path, pathspec, PACKAGE_CONFIG_FILENAME)
+        end
+
+        Dir.glob(glob_patterns)
+          .map { |path| Pathname.new(path).cleanpath }
           .reject { |path| path.realpath.fnmatch(bundle_path_match) }
       end
 

data/lib/packwerk/parsers/erb.rb

@@ -19,6 +19,10 @@ module Packwerk
       def call(io:, file_path: "<unknown>")
         buffer = Parser::Source::Buffer.new(file_path)
         buffer.source = io.read
+        parse_buffer(buffer, file_path: file_path)
+      end
+
+      def parse_buffer(buffer, file_path:)
         parser = @parser_class.new(buffer, template_language: :html)
         to_ruby_ast(parser.ast, file_path)
       rescue EncodingError => e

data/lib/packwerk/parsers/factory.rb

@@ -26,9 +26,18 @@ module Packwerk
         when RUBY_REGEX
           @ruby_parser ||= Ruby.new
         when ERB_REGEX
-          @erb_parser ||= Erb.new
+          @erb_parser ||= erb_parser_class.new
         end
       end
+
+      def erb_parser_class
+        @erb_parser_class || Erb
+      end
+
+      def erb_parser_class=(klass)
+        @erb_parser_class = klass
+        @erb_parser = nil
+      end
     end
   end
 end

data/lib/packwerk/run_context.rb

@@ -25,9 +25,10 @@ module Packwerk
       :inflector,
       :custom_associations,
       :checker_classes,
-      :reference_lister,
     )
 
+    attr_accessor :reference_lister
+
     DEFAULT_CHECKERS = [
       ::Packwerk::DependencyChecker,
       ::Packwerk::PrivacyChecker,

data/lib/packwerk/updating_deprecated_references.rb

@@ -1,51 +1,14 @@
 # typed: true
 # frozen_string_literal: true
 
-require "sorbet-runtime"
-
-require "packwerk/deprecated_references"
-require "packwerk/reference"
-require "packwerk/reference_lister"
-require "packwerk/violation_type"
+require "packwerk/cache_deprecated_references"
 
 module Packwerk
-  class UpdatingDeprecatedReferences
-    extend T::Sig
-    include ReferenceLister
-
-    def initialize(root_path, deprecated_references = {})
-      @root_path = root_path
-      @deprecated_references = deprecated_references
-    end
-
-    sig do
-      params(reference: Packwerk::Reference, violation_type: ViolationType)
-        .returns(T::Boolean)
-        .override
-    end
-    def listed?(reference, violation_type:)
-      deprecated_references = deprecated_references_for(reference.source_package)
-      deprecated_references.add_entries(reference, violation_type.serialize)
-      true
-    end
-
+  class UpdatingDeprecatedReferences < CacheDeprecatedReferences
     def dump_deprecated_references_files
       @deprecated_references.each do |_, deprecated_references_file|
         deprecated_references_file.dump
       end
     end
-
-    private
-
-    def deprecated_references_for(package)
-      @deprecated_references[package] ||= Packwerk::DeprecatedReferences.new(
-        package,
-        deprecated_references_file_for(package),
-      )
-    end
-
-    def deprecated_references_file_for(package)
-      File.join(@root_path, package.name, "deprecated_references.yml")
-    end
   end
 end

data/lib/packwerk/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: packwerk
 version: !ruby/object:Gem::Version
-  version: 1.0.2
+  version: 1.1.0
 platform: ruby
 authors:
 - Shopify Inc.
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-11-16 00:00:00.000000000 Z
+date: 2020-11-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -186,15 +186,19 @@ files:
 - lib/packwerk/application_load_paths.rb
 - lib/packwerk/application_validator.rb
 - lib/packwerk/association_inspector.rb
+- lib/packwerk/cache_deprecated_references.rb
 - lib/packwerk/checker.rb
 - lib/packwerk/checking_deprecated_references.rb
 - lib/packwerk/cli.rb
+- lib/packwerk/commands/detect_stale_violations_command.rb
+- lib/packwerk/commands/offense_progress_marker.rb
 - lib/packwerk/configuration.rb
 - lib/packwerk/const_node_inspector.rb
 - lib/packwerk/constant_discovery.rb
 - lib/packwerk/constant_name_inspector.rb
 - lib/packwerk/dependency_checker.rb
 - lib/packwerk/deprecated_references.rb
+- lib/packwerk/detect_stale_deprecated_references.rb
 - lib/packwerk/file_processor.rb
 - lib/packwerk/files_for_processing.rb
 - lib/packwerk/formatters/progress_formatter.rb