danger-packwerk 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: cf899d973a7ead8ff19dc6f73f30f63c23bdc7fffc3f043766d8819ffbc088aa
-  data.tar.gz: 318d88c5243e9e510abef74590fb907ba97dd10afd563cd9fcebb1eea9161f40
+  metadata.gz: 8789235e049c26367bdf6a909d22646d76b44adb350fb35e777d2be40ec0e14a
+  data.tar.gz: 1bd02af0c72f377ad0a7982681fe9bfdb8bc6e4550fdb6b756ee8e9840cba27b
 SHA512:
-  metadata.gz: 33fb31226007f52ddf1248e0d764816014f2371a5e48e1ba981ce6947c6f64eb6b3368e2ac628ea5912c5ec565481f3887e5fd53618ac5227816d27009034769
-  data.tar.gz: 8d391aea94c4045f26eb5232a177a35ebe597bf62239ab8e1050458b8db89739c2538a7f68cc5791d2b956f01986a1fb9ea23d4e5c72a53dc25e4aa965bbe013
+  metadata.gz: 3839e46d7a89a4dbb7dcee0957be8d891a9e151d29485f06e8a53ab21a92af7a7a1a2d4c09da48030e6c95040956c6e4f92d380a663a57c02b48085fa189ff62
+  data.tar.gz: ddcb0fec757eafe11d18b5c0146202fb3ea6a655087bf3c11534a3f556f85ccf76a945eca3a86683ba37197f9ca22a8fc1ad92049bdd0b7cfd4a80ff73125bdb

data/lib/danger-packwerk/basic_reference_offense.rb

@@ -38,38 +38,66 @@ module DangerPackwerk
     const :file, String
     const :to_package_name, String
     const :type, String
-    const :location, Location
+    const :file_location, Location
 
     sig { params(deprecated_references_yml: String).returns(T::Array[BasicReferenceOffense]) }
     def self.from(deprecated_references_yml)
       deprecated_references_yml_pathname = Pathname.new(deprecated_references_yml)
       violations = Private::DeprecatedReferences.from(deprecated_references_yml_pathname).violations
 
+      # See the larger comment below for more information on why we need this information.
+      # This is a small optimization that lets us find the location of referenced files within
+      # a `deprecated_references.yml` file. Getting this now allows us to avoid reading through the file
+      # once for every referenced file in the inner loop below.
+      file_reference_to_line_number_index = T.let({}, T::Hash[String, T::Array[Integer]])
+      all_referenced_files = violations.flat_map(&:files).uniq
+      deprecated_references_yml_pathname.readlines.each_with_index do |line, index|
+        # We can use `find` here to exit early since each line will include one path that is unique to that file.
+        # Paths should not be substrings of each other, since they are all paths relative to the root.
+        file_on_line = all_referenced_files.find { |file| line.include?(file) }
+        # Not all lines contain a reference to a file
+        if file_on_line
+          file_reference_to_line_number_index[file_on_line] ||= []
+          file_reference_to_line_number_index.fetch(file_on_line) << index
+        end
+      end
+
       violations.flat_map do |violation|
-        # We choose the location of the violation as the reference to the constant within the `deprecated_references.yml` file.
-        # We simply find the reference to that constant, because we know that each constant reference can occur only once per `deprecated_references.yml` file
+        #
+        # We identify two locations associated with this violation.
+        # First, we find the reference to the constant within the `deprecated_references.yml` file.
+        # We know that each constant reference can occur only once per `deprecated_references.yml` file
         # The reason for this is that we know that only one file in the codebase can define a constant, and packwerk's constant_resolver will actually
         # raise if this assumption is not true: https://github.com/Shopify/constant_resolver/blob/e78af0c8d5782b06292c068cfe4176e016c51b34/lib/constant_resolver.rb#L74
         #
+        # Second, we find the reference to the specific file that references the constant within the `deprecated_references.yml` file.
+        # This can occur multiple times per `deprecated_references.yml` file, but we know that the very first reference to the file after the class name key will be the one we care
+        # about, so we take the first instance that occurs after the class is listed.
+        #
         # Note though that since one constant reference in a `deprecated_referencs.yml` can be both a privacy and a dependency violation AND it can occur in many files,
         # we need to group them. That is -- if `MyPrivateConstant` is both a dependency and a privacy violation AND it occurs in 10 files, that would represent 20 violations.
         # Therefore we will group all of those 20 into one message to the user rather than providing 20 messages.
-        _line, line_number = deprecated_references_yml_pathname.readlines.each_with_index.find { |line, _index| line.include?(violation.class_name) }
-        if line_number.nil?
+        #
+        _line, class_name_line_number = deprecated_references_yml_pathname.readlines.each_with_index.find { |line, _index| line.include?(violation.class_name) }
+        if class_name_line_number.nil?
           debug_info = { class_name: violation.class_name, to_package_name: violation.to_package_name, type: violation.type }
           raise "Unable to find reference to violation #{debug_info} in #{deprecated_references_yml}"
         end
 
-        # We add one to the line number since `each_with_index` is zero-based indexed but Github line numbers are one-based indexed
-        location = Location.new(file: deprecated_references_yml, line_number: line_number + 1)
-
         violation.files.map do |file|
+          file_line_numbers = file_reference_to_line_number_index.fetch(file, [])
+          file_line_number = file_line_numbers.select { |index| index > class_name_line_number }.min
+          raise "Unable to find reference to violation #{{ file: file, to_package_name: violation.to_package_name, type: violation.type }} in #{deprecated_references_yml}" if file_line_number.nil?
+
+          # We add one to the line number since `each_with_index` is zero-based indexed but Github line numbers are one-based indexed
+          file_location = Location.new(file: deprecated_references_yml, line_number: file_line_number + 1)
+
           BasicReferenceOffense.new(
             class_name: violation.class_name,
             file: file,
             to_package_name: violation.to_package_name,
             type: violation.type,
-            location: location
+            file_location: file_location
           )
         end
       end

data/lib/danger-packwerk/danger_deprecated_references_yml_changes.rb

@@ -44,9 +44,12 @@ module DangerPackwerk
       )
 
       current_comment_count = 0
-      violation_diff.added_violations.group_by(&:location).each do |location, violations|
+
+      violation_diff.added_violations.group_by(&:class_name).each do |_class_name, violations|
         break if current_comment_count >= max_comments
 
+        location = T.must(violations.first).file_location
+
         markdown(
           added_offenses_formatter.call(violations),
           line: location.line_number,
@@ -71,13 +74,13 @@ module DangerPackwerk
       git.deleted_files.grep(DEPRECATED_REFERENCES_PATTERN).each do |deleted_deprecated_references_yml_file|
         # Since the file is deleted, we know on the HEAD commit there are no violations related to this pack,
         # and that all violations from this file are deleted
-        removed_violations += get_violations_before_patch_for(deleted_deprecated_references_yml_file)
+        deleted_violations = get_violations_before_patch_for(deleted_deprecated_references_yml_file)
+        removed_violations += deleted_violations
       end
 
       git.modified_files.grep(DEPRECATED_REFERENCES_PATTERN).each do |modified_deprecated_references_yml_file|
         head_commit_violations = BasicReferenceOffense.from(modified_deprecated_references_yml_file)
         base_commit_violations = get_violations_before_patch_for(modified_deprecated_references_yml_file)
-
         added_violations += head_commit_violations - base_commit_violations
         removed_violations += base_commit_violations - head_commit_violations
       end

data/lib/danger-packwerk/private/default_offenses_formatter.rb

@@ -28,8 +28,7 @@ module DangerPackwerk
         else # violations.any?(&:privacy?)
           <<~MESSAGE
             Hi! It looks like the pack defining `#{constant_name}` considers this private API.
-            #{disclaimer}
-            #{request_to_add_context}
+            #{disclaimer}#{request_to_add_context}
           MESSAGE
         end
       end

data/lib/danger-packwerk/version.rb

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

data/sorbet/rbi/todo.rbi

@@ -1 +1,3 @@
-module ::RSpec; end
+module ::RSpec
+  module Matchers; end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: danger-packwerk
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Gusto Engineers
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-04-15 00:00:00.000000000 Z
+date: 2022-04-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: danger-plugin-api
@@ -81,35 +81,35 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: rspec
+  name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '0'
 - !ruby/object:Gem::Dependency
-  name: rubocop
+  name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '3.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '3.0'
 - !ruby/object:Gem::Dependency
-  name: rubocop-sorbet
+  name: rubocop
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -123,7 +123,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: sorbet
+  name: rubocop-sorbet
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -137,7 +137,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: tapioca
+  name: sorbet
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -151,7 +151,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: rake
+  name: tapioca
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="