danger-dangermattic 1.0.0 → 1.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e85f01a1d938e27470bb45e542e181b976500f6ecd7753f02536e778af12b370
-  data.tar.gz: 79ec4d88e1bb27c40a72be9b19a70a2a3200aa2eb7a68a7433849550d31f11bf
+  metadata.gz: 615ffb488aacbecf44a30b87c7c782d97bbf4a5104ada852ea6565d20d092ed4
+  data.tar.gz: f7d16f0afcd180ea5271865f091d0c33866900f3102745cb31b886b59cb8348f
 SHA512:
-  metadata.gz: a681ba5b47937b6fe5ab6abd568954f8b5e26570e75385a9a3fa719ea6420c7bcd4dd216c90a9a431755270beec609183f161bd6a7ccf4f502af6d31793c1120
-  data.tar.gz: a3542e84de8347a75760d8501aeac783305e5ff3c665d1209a706100c889aeb0afa959f4b80e66d166fd9c4f881c373f24155333a0a6bf27817b84ecb6b1ceac
+  metadata.gz: fbbd4c83b4c026dec016433abc3fbb2c8275c28aceab5863e4c39160031484550b1bc41092c74ba6786738863b43431089d2b5e02e239e95eca2ee5045c01a6f
+  data.tar.gz: df4b5edf15a414ead103abc8b0c0bc182baac45425170be3aea0df1186f6a233f2f401b894da1cbd3c204668be97cc43c527bd6e969fabc7ce5e1f30fb8b26d6

data/.github/workflows/reusable-run-danger.yml

@@ -34,13 +34,13 @@ jobs:
       - name: "☢️ Danger PR Check"
         env:
           PR_URL: ${{ github.event.pull_request.html_url }}
-          RUNNING_ON_FORK: ${{ github.event.pull_request.head.repo.fork }}
+          READ_ONLY_MODE: ${{ github.event.pull_request.head.repo.fork || github.actor == 'dependabot[bot]' }}
           REMOVE_PREVIOUS_COMMENTS: ${{ inputs.remove-previous-comments }}
-          DANGER_GITHUB_API_TOKEN: ${{ secrets.github-token }}
+          DANGER_GITHUB_API_TOKEN: ${{ secrets.github-token || secrets.GITHUB_TOKEN }}
         run: |
           echo "--- 🏃 Running Danger: PR Check"
 
-          if [ "$RUNNING_ON_FORK" = true ]; then
+          if [ "$READ_ONLY_MODE" = true ]; then
             danger_output=$(bundle exec danger pr "$PR_URL" --verbose)
 
             echo "$danger_output"

data/CHANGELOG.md

@@ -2,6 +2,12 @@
 
 ---
 
+## 1.0.1
+
+### Bug Fixes
+
+- Fix `tracks_checker` plugin so that only additions / removals in a diff are considered in the check, therefore not including the context parts of the diff.
+
 ## 1.0.0
 
-After some time being developed and tested across a few repositories, this is our first stable release.
+- After some time being developed and tested across a few repositories, this is our first stable release.

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    danger-dangermattic (0.0.1)
+    danger-dangermattic (1.0.1)
       danger (~> 9.4)
       danger-junit (~> 1.0)
       danger-plugin-api (~> 1.0)

data/lib/dangermattic/gem_version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Dangermattic
-  VERSION = '1.0.0'
+  VERSION = '1.0.1'
 end

data/lib/dangermattic/plugins/common/git_utils.rb

@@ -81,9 +81,11 @@ module Danger
     #
     # @param files [Array<String>] List of file names to check
     # @param line_matcher [Proc] A callable that takes a line and returns true if it matches the desired pattern
-    # @param change_type [Symbol, nil] Change type to filter lines (e.g., :added, :removed) or nil for no filter
+    # @param change_type [Symbol, Array<Symbol>, nil] Change type(s) to filter lines (e.g., `:added`, `:removed`,
+    #                    `:context`, `[:added, :removed]`, …), or nil for no filter
     # @return [Array<MatchedData>] Array of MatchedData objects representing matched lines in files
     def matching_lines_in_diff_files(files:, line_matcher:, change_type: nil)
+      change_types = Array(change_type).map(&:to_sym)
       matched_data = []
 
       files.each do |file|
@@ -92,7 +94,7 @@ module Danger
         diff = danger.git.diff_for_file(file)
 
         diff.patch.each_line do |line|
-          matched_lines << line if line_matcher.call(line) && (change_type.nil? || change_type(diff_line: line) == change_type)
+          matched_lines << line if line_matcher.call(line) && (change_type.nil? || change_types.include?(change_type(diff_line: line)))
         end
 
         matched_data << MatchedData.new(file, matched_lines) unless matched_lines.empty?

data/lib/dangermattic/plugins/tracks_checker.rb

@@ -63,7 +63,7 @@ module Danger
       matched_lines = git_utils.matching_lines_in_diff_files(
         files: git_utils.all_changed_files,
         line_matcher: ->(line) { tracks_usage_matchers.any? { |tracks_usage_match| line.match(tracks_usage_match) } },
-        change_type: nil
+        change_type: %i[added removed]
       )
 
       !matched_lines.empty?

data/spec/tracks_checker_spec.rb

@@ -68,7 +68,7 @@ module Danger
           it 'does nothing when there are no changes in Tracks-related files' do
             modified_files = ['MyClass.swift']
             allow(@plugin.git_utils).to receive(:all_changed_files).and_return(modified_files)
-            allow(@plugin.git_utils).to receive(:matching_lines_in_diff_files).with(files: modified_files, line_matcher: kind_of(Proc), change_type: nil).and_return([])
+            allow(@plugin.git_utils).to receive(:matching_lines_in_diff_files).with(files: modified_files, line_matcher: kind_of(Proc), change_type: %i[added removed]).and_return([])
 
             @plugin.check_tracks_changes(tracks_files: track_files, tracks_usage_matchers: tracks_matchers, tracks_label: nil)
 
@@ -83,12 +83,7 @@ module Danger
             modified_files = ['MyClass.kt']
             allow(@plugin.git_utils).to receive(:all_changed_files).and_return(modified_files)
 
-            allow(@plugin.git_utils).to receive(:matching_lines_in_diff_files).with(files: modified_files, line_matcher: kind_of(Proc), change_type: nil) do |args|
-              analytics_call_in_diff = '-                AnalyticsTracker.track("myEvent1")'
-              expect(args[:line_matcher].call(analytics_call_in_diff)).to be true
-
-              [analytics_call_in_diff]
-            end
+            allow_diff_match(modified_files: modified_files, diff_line: '-      AnalyticsTracker.track("myEvent1")', expect_match: true)
 
             @plugin.check_tracks_changes(tracks_files: track_files, tracks_usage_matchers: tracks_matchers, tracks_label: tracks_label)
 
@@ -99,12 +94,7 @@ module Danger
             modified_files = ['MyClass.kt']
             allow(@plugin.git_utils).to receive(:all_changed_files).and_return(modified_files)
 
-            allow(@plugin.git_utils).to receive(:matching_lines_in_diff_files).with(files: modified_files, line_matcher: kind_of(Proc), change_type: nil) do |args|
-              analytics_call_in_diff = '-                AnalyticsTracker.track("evento")'
-              expect(args[:line_matcher].call(analytics_call_in_diff)).to be true
-
-              [analytics_call_in_diff]
-            end
+            allow_diff_match(modified_files: modified_files, diff_line: '+      AnalyticsTracker.track("evento")', expect_match: true)
 
             @plugin.check_tracks_changes(tracks_files: track_files, tracks_usage_matchers: tracks_matchers, tracks_label: nil)
 
@@ -116,12 +106,7 @@ module Danger
             modified_files = ['MyClass.kt']
             allow(@plugin.git_utils).to receive(:all_changed_files).and_return(modified_files)
 
-            allow(@plugin.git_utils).to receive(:matching_lines_in_diff_files).with(files: modified_files, line_matcher: kind_of(Proc), change_type: nil) do |args|
-              analytics_call_in_diff = '-                AnalyticsTracker.track("myEvent1")'
-              expect(args[:line_matcher].call(analytics_call_in_diff)).to be true
-
-              [analytics_call_in_diff]
-            end
+            allow_diff_match(modified_files: modified_files, diff_line: '-      AnalyticsTracker.track("evento")', expect_match: true)
 
             tracks_label = 'TRACKS PR'
             @plugin.check_tracks_changes(tracks_files: track_files, tracks_usage_matchers: tracks_matchers, tracks_label: tracks_label)
@@ -133,12 +118,34 @@ module Danger
             modified_files = ['MyClass.kt']
             allow(@plugin.git_utils).to receive(:all_changed_files).and_return(modified_files)
 
-            allow(@plugin.git_utils).to receive(:matching_lines_in_diff_files).with(files: modified_files, line_matcher: kind_of(Proc), change_type: nil) do |args|
-              analytics_call_in_diff = '+                AnalyticsHelper.log("event_1")'
-              expect(args[:line_matcher].call(analytics_call_in_diff)).to be false
+            allow_diff_match(modified_files: modified_files, diff_line: '-      AnalyticsHelper.log("event_1")', expect_match: false)
+
+            @plugin.check_tracks_changes(tracks_files: track_files, tracks_usage_matchers: tracks_matchers, tracks_label: nil)
+
+            expect(@dangerfile).to not_report
+          end
+
+          it 'does nothing when there are matching changes but in the context parts of the diff' do
+            modified_file = 'MyClass.kt'
+            allow(@plugin.git_utils).to receive(:all_changed_files).and_return([modified_file])
+
+            tracks_diff = <<~STRINGS
+              diff --git a/MyClass.kt b/MyClass.kt
+              index 5794d472..772e2b99 100644
+              - a/MyClass
+              + b/MyClass
+              @@ -1,3 +1,6 @@
+                AnalyticsTracker.track("myMagicEvent1")
+                // call magic
+              +  AnalyticsHelper.log("event_1")
+              +  AnalyticsHelper.log("event_2")
+              +  AnotherUtil.callMagic()
+                AnalyticsTracker.track("myMagicEvent2")
+            STRINGS
 
-              []
-            end
+            diff = GitDiffStruct.new('modified', modified_file, tracks_diff)
+
+            allow(@plugin.git).to receive(:diff_for_file).with(modified_file).and_return(diff)
 
             @plugin.check_tracks_changes(tracks_files: track_files, tracks_usage_matchers: tracks_matchers, tracks_label: nil)
 
@@ -147,6 +154,17 @@ module Danger
         end
       end
 
+      def allow_diff_match(modified_files:, diff_line:, expect_match:)
+        allow(@plugin.git_utils).to receive(:matching_lines_in_diff_files).with(files: modified_files, line_matcher: kind_of(Proc), change_type: %i[added removed]) do |args|
+          expect(args[:line_matcher].call(diff_line)).to be expect_match
+
+          result = []
+          result.append(diff_line) if expect_match
+
+          result
+        end
+      end
+
       def expect_label_checks(tracks_label)
         expect(@dangerfile.status_report[:messages]).to eq [TracksChecker::TRACKS_PR_INSTRUCTIONS + format(TracksChecker::TRACKS_NO_LABEL_INSTRUCTION_FORMAT, tracks_label)]
         expect(@dangerfile.status_report[:errors]).to eq [format(TracksChecker::TRACKS_NO_LABEL_MESSAGE_FORMAT, tracks_label)]

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: danger-dangermattic
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.0.1
 platform: ruby
 authors:
 - Automattic
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-02-08 00:00:00.000000000 Z
+date: 2024-02-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: danger