danger-packwerk 0.1.2 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6300323ecd2a3738dff019fa9d13477c01c4ef9f0c750780d25c22dea7087e56
-  data.tar.gz: b4d97e21514bc854ccea2117ca0b63a751a632a2ad4558fe2f5e7e64c382c11e
+  metadata.gz: 16735a1a43375efdebd16bc519ffbd0a1ddd5067f1f970ae7efd4d3f8f5f0de4
+  data.tar.gz: 294b6e674282672231041190fdfa1127ff1ce5011b9a7ae08dc650757862724d
 SHA512:
-  metadata.gz: dbfa1eaea903b7ae2fed28832bb8797c9a594886baf4bad4e951ebf95d6859d19776a8affccb20623189987230a33046eac23ff2eb3a659f454f37c1fc30cdff
-  data.tar.gz: 0f0e32051b0f970eeac82fa5ba0e677441ffdbc8b9a2e9c1f94d6dcdbea5937df4ccfce69eea946a52ea7af54b7ff646d3d8b1c7356d55c488c1eb35f8224404
+  metadata.gz: d6f6e5b5b414a8a411b414f161a4b0f1378ee0e872f3f666398bf345a4246f9910c92b0360f763378339f3603594a87fa0a5c605ddcaee5f93a764d99d954e44
+  data.tar.gz: 4b76ae659c1b03d7f6cb7ffba6804f45c14ba64dc62ba79147bd6eda6ceb7930293ad692986baf83fcf5f6235bf3b9eb988aebe9cada3af354e6b1fcddc5d329

data/lib/danger-packwerk/basic_reference_offense.rb

@@ -81,10 +81,11 @@ module DangerPackwerk
         _line, class_name_line_number = deprecated_references_yml_pathname.readlines.each_with_index.find do |line, _index|
           # If you have a class `::MyClass`, then you can get a false match if another constant in the file
           # is named `MyOtherClass::MyClassThing`. Therefore we include quotes in our match to ensure that we match
-          # the constant and only the constant. Right now `packwerk` `deprecated_references.yml` files always use
-          # double quotes, so we check for that only. If the public API ever changes, this may need to change.
-          class_name_with_quote_boundaries = "\"#{violation.class_name}\":"
-          line.include?(class_name_with_quote_boundaries)
+          # the constant and only the constant.
+          # Right now `packwerk` `deprecated_references.yml` files typically use double quotes, but sometimes folks linters change this to single quotes.
+          # To be defensive, we match against either.
+          class_name_with_quote_boundaries = /["|']#{violation.class_name}["|']:/
+          line.match?(class_name_with_quote_boundaries)
         end
 
         if class_name_line_number.nil?

data/lib/danger-packwerk/danger_packwerk.rb

@@ -3,6 +3,7 @@
 
 require 'danger'
 require 'packwerk'
+require 'parse_packwerk'
 require 'sorbet-runtime'
 require 'danger-packwerk/packwerk_wrapper'
 
@@ -23,13 +24,23 @@ module DangerPackwerk
     DEFAULT_FAIL = false
     DEFAULT_FAILURE_MESSAGE = 'Packwerk violations were detected! Please resolve them to unblock the build.'
 
+    class CommentGroupingStrategy < ::T::Enum
+      enums do
+        PerConstantPerLocation = new
+        PerConstantPerPack = new
+      end
+    end
+
+    PerConstantPerPackGrouping = CommentGroupingStrategy::PerConstantPerPack
+
     sig do
       params(
         max_comments: Integer,
         offenses_formatter: OffensesFormatter,
         fail_build: T::Boolean,
         failure_message: String,
-        on_failure: OnFailure
+        on_failure: OnFailure,
+        grouping_strategy: CommentGroupingStrategy
       ).void
     end
     def check(
@@ -37,7 +48,8 @@ module DangerPackwerk
       offenses_formatter: DEFAULT_OFFENSES_FORMATTER,
       fail_build: DEFAULT_FAIL,
       failure_message: DEFAULT_FAILURE_MESSAGE,
-      on_failure: DEFAULT_ON_FAILURE
+      on_failure: DEFAULT_ON_FAILURE,
+      grouping_strategy: CommentGroupingStrategy::PerConstantPerLocation
     )
       # This is important because by default, Danger will leave a concantenated list of all its messages if it can't find a commentable place in the
       # diff to leave its message. This is an especially bad UX because it will be a huge wall of text not connected to the source of the issue.
@@ -75,11 +87,21 @@ module DangerPackwerk
       # We group by the constant name, line number, and reference path. Any offenses with these same values should only differ on what type of violation
       # they are (privacy or dependency). We put privacy and dependency violation messages in the same comment since they would occur on the same line.
       packwerk_reference_offenses.group_by do |packwerk_reference_offense|
-        [
-          packwerk_reference_offense.reference.constant.name,
-          packwerk_reference_offense.location.line,
-          packwerk_reference_offense.reference.relative_path
-        ]
+        case grouping_strategy
+        when CommentGroupingStrategy::PerConstantPerLocation
+          [
+            packwerk_reference_offense.reference.constant.name,
+            packwerk_reference_offense.location.line,
+            packwerk_reference_offense.reference.relative_path
+          ]
+        when CommentGroupingStrategy::PerConstantPerPack
+          [
+            packwerk_reference_offense.reference.constant.name,
+            ParsePackwerk.package_from_path(packwerk_reference_offense.reference.relative_path)
+          ]
+        else
+          T.absurd(grouping_strategy)
+        end
       end.each do |_group, unique_packwerk_reference_offenses|
         break if current_comment_count >= max_comments
 

data/lib/danger-packwerk/version.rb

@@ -2,5 +2,5 @@
 # frozen_string_literal: true
 
 module DangerPackwerk
-  VERSION = '0.1.2'
+  VERSION = '0.3.0'
 end

data/sorbet/rbi/gems/parse_packwerk@0.12.0.rbi

@@ -0,0 +1,146 @@
+# typed: true
+
+# DO NOT EDIT MANUALLY
+# This is an autogenerated file for types exported from the `parse_packwerk` gem.
+# Please instead update this file by running `bin/tapioca gem parse_packwerk`.
+
+module ParsePackwerk
+  class << self
+    sig { returns(T::Array[::ParsePackwerk::Package]) }
+    def all; end
+
+    sig { void }
+    def bust_cache!; end
+
+    sig { params(name: ::String).returns(T.nilable(::ParsePackwerk::Package)) }
+    def find(name); end
+
+    sig { params(file_path: T.any(::Pathname, ::String)).returns(T.nilable(::ParsePackwerk::Package)) }
+    def package_from_path(file_path); end
+
+    sig { params(package: ::ParsePackwerk::Package).void }
+    def write_package_yml!(package); end
+
+    sig { returns(::ParsePackwerk::Configuration) }
+    def yml; end
+
+    private
+
+    sig { returns(T::Hash[::String, ::ParsePackwerk::Package]) }
+    def packages_by_name; end
+  end
+end
+
+class ParsePackwerk::Configuration < ::T::Struct
+  const :exclude, T::Array[::String]
+  const :package_paths, T::Array[::String]
+
+  class << self
+    sig { params(config_hash: T::Hash[T.untyped, T.untyped]).returns(T::Array[::String]) }
+    def excludes(config_hash); end
+
+    sig { returns(::ParsePackwerk::Configuration) }
+    def fetch; end
+
+    def inherited(s); end
+
+    sig { params(config_hash: T::Hash[T.untyped, T.untyped]).returns(T::Array[::String]) }
+    def package_paths(config_hash); end
+  end
+end
+
+ParsePackwerk::DEFAULT_EXCLUDE_GLOBS = T.let(T.unsafe(nil), Array)
+ParsePackwerk::DEFAULT_PACKAGE_PATHS = T.let(T.unsafe(nil), Array)
+ParsePackwerk::DEPENDENCIES = T.let(T.unsafe(nil), String)
+ParsePackwerk::DEPRECATED_REFERENCES_YML_NAME = T.let(T.unsafe(nil), String)
+
+class ParsePackwerk::DeprecatedReferences < ::T::Struct
+  const :pathname, ::Pathname
+  const :violations, T::Array[::ParsePackwerk::Violation]
+
+  class << self
+    sig { params(package: ::ParsePackwerk::Package).returns(::ParsePackwerk::DeprecatedReferences) }
+    def for(package); end
+
+    sig { params(pathname: ::Pathname).returns(::ParsePackwerk::DeprecatedReferences) }
+    def from(pathname); end
+
+    def inherited(s); end
+  end
+end
+
+ParsePackwerk::ENFORCE_DEPENDENCIES = T.let(T.unsafe(nil), String)
+ParsePackwerk::ENFORCE_PRIVACY = T.let(T.unsafe(nil), String)
+ParsePackwerk::METADATA = T.let(T.unsafe(nil), String)
+ParsePackwerk::MetadataYmlType = T.type_alias { T::Hash[T.untyped, T.untyped] }
+
+class ParsePackwerk::MissingConfiguration < ::StandardError
+  sig { params(packwerk_file_name: ::Pathname).void }
+  def initialize(packwerk_file_name); end
+end
+
+ParsePackwerk::PACKAGE_YML_NAME = T.let(T.unsafe(nil), String)
+ParsePackwerk::PACKWERK_YML_NAME = T.let(T.unsafe(nil), String)
+
+class ParsePackwerk::Package < ::T::Struct
+  const :dependencies, T::Array[::String]
+  const :enforce_dependencies, T::Boolean
+  const :enforce_privacy, T::Boolean
+  const :metadata, T::Hash[T.untyped, T.untyped]
+  const :name, ::String
+
+  sig { returns(::Pathname) }
+  def directory; end
+
+  sig { returns(T::Boolean) }
+  def enforces_dependencies?; end
+
+  sig { returns(T::Boolean) }
+  def enforces_privacy?; end
+
+  sig { returns(::Pathname) }
+  def yml; end
+
+  class << self
+    sig { params(pathname: ::Pathname).returns(::ParsePackwerk::Package) }
+    def from(pathname); end
+
+    def inherited(s); end
+  end
+end
+
+class ParsePackwerk::PackageSet
+  class << self
+    sig do
+      params(
+        package_pathspec: T::Array[::String],
+        exclude_pathspec: T::Array[::String]
+      ).returns(T::Array[::ParsePackwerk::Package])
+    end
+    def from(package_pathspec:, exclude_pathspec:); end
+
+    private
+
+    sig { params(globs: T::Array[::String], path: ::Pathname).returns(T::Boolean) }
+    def exclude_path?(globs, path); end
+  end
+end
+
+ParsePackwerk::ROOT_PACKAGE_NAME = T.let(T.unsafe(nil), String)
+
+class ParsePackwerk::Violation < ::T::Struct
+  const :class_name, ::String
+  const :files, T::Array[::String]
+  const :to_package_name, ::String
+  const :type, ::String
+
+  sig { returns(T::Boolean) }
+  def dependency?; end
+
+  sig { returns(T::Boolean) }
+  def privacy?; end
+
+  class << self
+    def inherited(s); end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: danger-packwerk
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.3.0
 platform: ruby
 authors:
 - Gusto Engineers
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-04-20 00:00:00.000000000 Z
+date: 2022-08-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: danger-plugin-api
@@ -38,6 +38,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: parse_packwerk
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: sorbet-runtime
   requirement: !ruby/object:Gem::Requirement
@@ -186,15 +200,16 @@ files:
 - sorbet/config
 - sorbet/rbi/gems/danger@8.5.0.rbi
 - sorbet/rbi/gems/packwerk@1.3.2.rbi
+- sorbet/rbi/gems/parse_packwerk@0.12.0.rbi
 - sorbet/rbi/todo.rbi
 - sorbet/tapioca/require.rb
-homepage: https://github.com/bigrails/danger-packwerk
+homepage: https://github.com/rubyatscale/danger-packwerk
 licenses:
 - MIT
 metadata:
-  homepage_uri: https://github.com/bigrails/danger-packwerk
-  source_code_uri: https://github.com/bigrails/danger-packwerk
-  changelog_uri: https://github.com/bigrails/danger-packwerk/releases
+  homepage_uri: https://github.com/rubyatscale/danger-packwerk
+  source_code_uri: https://github.com/rubyatscale/danger-packwerk
+  changelog_uri: https://github.com/rubyatscale/danger-packwerk/releases
   allowed_push_host: https://rubygems.org
 post_install_message: 
 rdoc_options: []