danger-packwerk 0.14.4 → 0.15.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f9961bce735a4a3e2ffd6e2f67719059652d08bcadcd06c8ab349b27452137e5
-  data.tar.gz: 3eca02e4593c388f7170036cc78fde2b4efa4b2fe616b3d1591acb68ecffe610
+  metadata.gz: f38fbe114e0e85afe924da1be42e39c8479a6ef13523fc126edf5bfd203a98fc
+  data.tar.gz: 5bdc17faafe562b47dd446e2fe7b499ac00ae3d4409079b642ce2e5b379b100d
 SHA512:
-  metadata.gz: 7167772693389751363dfd0c8e9956b30d7e2a237265d625f54de748453a3585a40b5e165e18bc6672d241344da08f216fd3614c031e9eea12b0e6eecca08c07
-  data.tar.gz: 0a8df0931b48669d9cb3d779824c6391622666c7614ca4fffa1cf03e83d1ba63ac891a7b621f736b1ddeeec0044694fc93c2ea15dbee4d633acd9cec52e1621c
+  metadata.gz: eaecf4c410532cd52c535137a6f8d22d2aa259b5c8642924168da0b0c05846f4f8932e8e7ee80ea5908162e2eafbae5a3a6fb592417ccb4fd2ce9d29b0566fdf
+  data.tar.gz: 6ef4da09535909112982266995d556af9a6b6f78ce946df87045e4937841cc8d73c528b79a2ee5e0b7f6206bb8185a9d907733ad7c4b072ac2f7e80c75cd8d47

data/README.md

@@ -43,8 +43,15 @@ class MyFormatter
   extend T::Sig
   include DangerPackwerk::Check::OffensesFormatter
   # Packwerk::ReferenceOffense: https://github.com/Shopify/packwerk/blob/main/lib/packwerk/reference_offense.rb
-  sig { override.params(offenses: T::Array[Packwerk::ReferenceOffense], repo_link: String, org_name: String).returns(String) }
-  def format_offenses(offenses, repo_link, org_name)
+  sig do
+    override.params(
+      offenses: T::Array[Packwerk::ReferenceOffense],
+      repo_link: String,
+      org_name: String
+      repo_url_builder: T.nilable(T.proc.params(constant_path: String).returns(String))
+    ).returns(String)
+  end
+  def format_offenses(offenses, repo_link, org_name, repo_builder_url: nil)
     # your logic here
   end
 end
@@ -98,8 +105,15 @@ class MyFormatter
   extend T::Sig
   include DangerPackwerk::Update::OffensesFormatter
   # DangerPackwerk::BasicReferenceOffense
-  sig { override.params(offenses: T::Array[DangerPackwerk::BasicReferenceOffense], repo_link: String, org_name: String).returns(String) }
-  def format_offenses(offenses, repo_link, org_name)
+  sig do
+    override.params(
+      offenses: T::Array[Packwerk::ReferenceOffense],
+      repo_link: String,
+      org_name: String
+      repo_url_builder: T.nilable(T.proc.params(constant_path: String).returns(String))
+    ).returns(String)
+  end
+  def format_offenses(offenses, repo_link, org_name, repo_builder_url: nil)
     # your logic here
   end
 end

data/lib/danger-packwerk/check/default_formatter.rb

@@ -21,10 +21,11 @@ module DangerPackwerk
         override.params(
           offenses: T::Array[Packwerk::ReferenceOffense],
           repo_link: String,
-          org_name: String
+          org_name: String,
+          repo_url_builder: T.nilable(T.proc.params(constant_path: String).returns(String))
         ).returns(String)
       end
-      def format_offenses(offenses, repo_link, org_name)
+      def format_offenses(offenses, repo_link, org_name, repo_url_builder: nil)
         reference_offense = T.must(offenses.first)
         violation_types = offenses.map(&:violation_type)
         referencing_file = reference_offense.reference.relative_path
@@ -45,11 +46,18 @@ module DangerPackwerk
         team_to_work_with = constant_source_package_ownership_info.owning_team ? constant_source_package_ownership_info.markdown_link_to_github_members_no_tag : 'the pack owner'
         privacy_violation_message = "- Does API in #{constant_source_package.name}/public support this use case?\n  - If not, can we work with #{team_to_work_with} to create and use a public API?\n  - If `#{constant_name}` should already be public, try `bin/packs make_public #{constant_location}`."
 
+        constant_location_url =
+          if repo_url_builder
+            repo_url_builder.call(constant_location)
+          else
+            "#{repo_link}/blob/main/#{constant_location}"
+          end
+
         if violation_types.include?(::DangerPackwerk::DEPENDENCY_VIOLATION_TYPE) && violation_types.include?(::DangerPackwerk::PRIVACY_VIOLATION_TYPE)
           <<~MESSAGE
             **Packwerk Violation**
             - Type: Privacy :lock: + Dependency :knot:
-            - Constant: [<ins>`#{constant_name}`</ins>](#{repo_link}/blob/main/#{constant_location})
+            - Constant: [<ins>`#{constant_name}`</ins>](#{constant_location_url})
             - Owning pack: #{constant_source_package_name}
               #{constant_source_package_ownership_info.ownership_copy}
 
@@ -69,7 +77,7 @@ module DangerPackwerk
           <<~MESSAGE
             **Packwerk Violation**
             - Type: Dependency :knot:
-            - Constant: [<ins>`#{constant_name}`</ins>](#{repo_link}/blob/main/#{constant_location})
+            - Constant: [<ins>`#{constant_name}`</ins>](#{constant_location_url})
             - Owning pack: #{constant_source_package_name}
               #{constant_source_package_ownership_info.ownership_copy}
 
@@ -88,7 +96,7 @@ module DangerPackwerk
           <<~MESSAGE
             **Packwerk Violation**
             - Type: Privacy :lock:
-            - Constant: [<ins>`#{constant_name}`</ins>](#{repo_link}/blob/main/#{constant_location})
+            - Constant: [<ins>`#{constant_name}`</ins>](#{constant_location_url})
             - Owning pack: #{constant_source_package_name}
               #{constant_source_package_ownership_info.ownership_copy}
 

data/lib/danger-packwerk/check/offenses_formatter.rb

@@ -14,10 +14,11 @@ module DangerPackwerk
         abstract.params(
           offenses: T::Array[Packwerk::ReferenceOffense],
           repo_link: String,
-          org_name: String
+          org_name: String,
+          repo_url_builder: T.nilable(T.proc.params(constant_path: String).returns(String))
         ).returns(String)
       end
-      def format_offenses(offenses, repo_link, org_name); end
+      def format_offenses(offenses, repo_link, org_name, repo_url_builder: nil); end
     end
   end
 end

data/lib/danger-packwerk/danger_package_todo_yml_changes.rb

@@ -42,6 +42,7 @@ module DangerPackwerk
     )
       offenses_formatter ||= Update::DefaultFormatter.new
       repo_link = github.pr_json[:base][:repo][:html_url]
+      repo_url_builder = ->(constant_path) { "#{repo_link}/blob/#{github.pr_json[:head][:ref]}/#{constant_path}" }
       org_name = github.pr_json[:base][:repo][:owner][:login]
 
       git_filesystem = Private::GitFilesystem.new(git: git, root: root_path || '')
@@ -56,13 +57,13 @@ module DangerPackwerk
 
       current_comment_count = 0
 
-      violation_diff.added_violations.group_by(&:class_name).each do |_class_name, violations|
+      violation_diff.added_violations.group_by(&:class_name).each_value do |violations|
         break if current_comment_count >= max_comments
 
         location = T.must(violations.first).file_location
 
         markdown(
-          offenses_formatter.format_offenses(violations, repo_link, org_name),
+          offenses_formatter.format_offenses(violations, repo_link, org_name, repo_url_builder: repo_url_builder),
           line: location.line_number,
           file: git_filesystem.convert_to_filesystem(location.file)
         )

data/lib/danger-packwerk/danger_packwerk.rb

@@ -36,6 +36,10 @@ module DangerPackwerk
 
     PerConstantPerPackGrouping = CommentGroupingStrategy::PerConstantPerPack
 
+    # We probably want to check the `include` key of `packwerk.yml`. By default, this value is "**/*.{rb,rake,erb}",
+    # so we hardcode this in for now. If this blocks a user, we can take that opportunity to read from `packwerk.yml`.
+    TARGETED_FILES_EXTENSIONS = T.let(%w[.erb .rake .rb].freeze, T::Array[String])
+
     sig do
       params(
         offenses_formatter: T.nilable(Check::OffensesFormatter),
@@ -60,6 +64,7 @@ module DangerPackwerk
     )
       offenses_formatter ||= Check::DefaultFormatter.new
       repo_link = github.pr_json[:base][:repo][:html_url]
+      repo_url_builder = ->(constant_path) { "#{repo_link}/blob/#{github.pr_json[:head][:ref]}/#{constant_path}" }
       org_name = github.pr_json[:base][:repo][:owner][:login]
 
       # 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
@@ -80,7 +85,7 @@ module DangerPackwerk
 
         # We probably want to check the `include` key of `packwerk.yml`. By default, this value is "**/*.{rb,rake,erb}",
         # so we hardcode this in for now. If this blocks a user, we can take that opportunity to read from `packwerk.yml`.
-        extension_is_targeted = ['.erb', '.rake', '.rb'].include?(path.extname)
+        extension_is_targeted = TARGETED_FILES_EXTENSIONS.include?(path.extname)
 
         # If a file has been modified via a rename, then `git.modified_files` will return an array that includes that file's *original* name.
         # Packwerk will ignore input files that do not exist, and when the PR only contains renamed Ruby files, that means packwerk check works
@@ -127,7 +132,7 @@ module DangerPackwerk
         else
           T.absurd(grouping_strategy)
         end
-      end.each do |_group, unique_packwerk_reference_offenses|
+      end.each_value do |unique_packwerk_reference_offenses|
         break if current_comment_count >= max_comments
 
         current_comment_count += 1
@@ -136,7 +141,7 @@ module DangerPackwerk
         line_number = reference_offense.location&.line
         referencing_file = reference_offense.reference.relative_path
 
-        message = offenses_formatter.format_offenses(unique_packwerk_reference_offenses, repo_link, org_name)
+        message = offenses_formatter.format_offenses(unique_packwerk_reference_offenses, repo_link, org_name, repo_url_builder: repo_url_builder)
         markdown(message, file: git_filesystem.convert_to_filesystem(referencing_file), line: line_number)
       end
 

data/lib/danger-packwerk/private.rb

@@ -13,14 +13,16 @@ module DangerPackwerk
 
     sig { returns(ConstantResolver) }
     def self.constant_resolver
-      @constant_resolver = T.let(@constant_resolver, T.nilable(ConstantResolver))
-      @constant_resolver ||= begin
-        load_paths = Packwerk::RailsLoadPaths.for(Dir.pwd, environment: 'test')
-        ConstantResolver.new(
-          root_path: Dir.pwd,
-          load_paths: T.unsafe(load_paths).keys
-        )
-      end
+      @constant_resolver ||= T.let(
+        begin
+          load_paths = Packwerk::RailsLoadPaths.for(Dir.pwd, environment: 'test')
+          ConstantResolver.new(
+            root_path: Dir.pwd,
+            load_paths: T.unsafe(load_paths).keys
+          )
+        end,
+        T.nilable(ConstantResolver)
+      )
     end
   end
 

data/lib/danger-packwerk/update/default_formatter.rb

@@ -15,8 +15,15 @@ module DangerPackwerk
         @custom_help_message = custom_help_message
       end
 
-      sig { override.params(offenses: T::Array[BasicReferenceOffense], repo_link: String, org_name: String).returns(String) }
-      def format_offenses(offenses, repo_link, org_name)
+      sig do
+        override.params(
+          offenses: T::Array[BasicReferenceOffense],
+          repo_link: String,
+          org_name: String,
+          repo_url_builder: T.nilable(T.proc.params(constant_path: String).returns(String))
+        ).returns(String)
+      end
+      def format_offenses(offenses, repo_link, org_name, repo_url_builder: nil)
         violation = T.must(offenses.first)
         referencing_file_pack = ParsePackwerk.package_from_path(violation.file)
         # We remove leading double colons as they feel like an implementation detail of packwerk.

data/lib/danger-packwerk/update/offenses_formatter.rb

@@ -14,10 +14,11 @@ module DangerPackwerk
         abstract.params(
           offenses: T::Array[BasicReferenceOffense],
           repo_link: String,
-          org_name: String
+          org_name: String,
+          repo_url_builder: T.nilable(T.proc.params(constant_path: String).returns(String))
         ).returns(String)
       end
-      def format_offenses(offenses, repo_link, org_name); end
+      def format_offenses(offenses, repo_link, org_name, repo_url_builder: nil); end
     end
   end
 end

data/lib/danger-packwerk/version.rb

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

data/lib/danger-packwerk.rb

@@ -5,7 +5,7 @@
 require 'sorbet-runtime'
 
 module DangerPackwerk
-  PACKAGE_TODO_PATTERN = T.let(/.*?package_todo\.yml\z/.freeze, Regexp)
+  PACKAGE_TODO_PATTERN = T.let(/.*?package_todo\.yml\z/, Regexp)
   DEPENDENCY_VIOLATION_TYPE = 'dependency'
   PRIVACY_VIOLATION_TYPE = 'privacy'
 

metadata

@@ -1,14 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: danger-packwerk
 version: !ruby/object:Gem::Version
-  version: 0.14.4
+  version: 0.15.0
 platform: ruby
 authors:
 - Gusto Engineers
-autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-05-08 00:00:00.000000000 Z
+date: 2025-03-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: code_ownership
@@ -94,118 +93,6 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-- !ruby/object:Gem::Dependency
-  name: bundler
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '2.0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '2.0'
-- !ruby/object:Gem::Dependency
-  name: pry
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: rake
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: rspec
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '3.0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '3.0'
-- !ruby/object:Gem::Dependency
-  name: rubocop
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 1.26.0
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 1.26.0
-- !ruby/object:Gem::Dependency
-  name: rubocop-sorbet
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 0.6.0
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 0.6.0
-- !ruby/object:Gem::Dependency
-  name: sorbet
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: tapioca
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
 description: Danger plugin for packwerk.
 email:
 - dev@gusto.com
@@ -238,7 +125,6 @@ metadata:
   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: []
 require_paths:
 - lib
@@ -246,15 +132,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '2.6'
+      version: '3.1'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.9
-signing_key:
+rubygems_version: 3.6.2
 specification_version: 4
 summary: Danger plugin for packwerk.
 test_files: []