danger-dangermattic 1.3.0 → 1.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 455052da651ef9af5d20ffc6be33a06ab961393e4c0adc8d3d87e27beba62efd
-  data.tar.gz: f04b1494ea66bc1fb3677e69658c08fa40b7373f548215f424ffd6f5fd0a4148
+  metadata.gz: 1ea5b40de9b9c82ffa11d1f10449caacbdd87051a9f2d1d7765a73869fe923a6
+  data.tar.gz: 82a8e207c33c9cddde899d05094bd6e1a128d6d8ce95e4847f59248a3f0af1c0
 SHA512:
-  metadata.gz: 58e0ffcb0c9ee7ce6f6a9080dc95e5aa8d9fe21eac85b576782625c4a528d0ebdc7069498fc6e965345f23d159eba6a186c7a9074f33ba38988e8bd3e24cc70c
-  data.tar.gz: 5401b6ce0765675148c5a6951c4f1279be562a3bc55a0e9dc824d6e0fd92a123738cdef5b8258fb734e8427939c206af845dac89d89d3192ee0f32f6ac2c0c3e
+  metadata.gz: 7c059b2ecabb7c0e126811bb3f5f8b0b3555feec5ed14a1df606dfcc61201a7540cf1242622802c0f76b6b4f59836a8038f275fb0491476b397d0967a673f2ea
+  data.tar.gz: 9cf786de34875f9cdd091aa479d285f13a8a78950c86bb480467c3f8aab6499dbbf7b3b7142d8cd6c8237b38c6247f38251f77e0e264ab4fb3c65cc81d557302

data/.github/CODEOWNERS

@@ -0,0 +1,13 @@
+# Ruby dependency surface
+Gemfile*              @Automattic/apps-infra-tooling
+*.gemspec             @Automattic/apps-infra-tooling
+.bundle/              @Automattic/apps-infra-tooling
+.rubocop*.yml         @Automattic/apps-infra-tooling
+
+# CI and automation
+.buildkite/           @Automattic/apps-infra-tooling
+.github/workflows/    @Automattic/apps-infra-tooling
+.github/dependabot.yml @Automattic/apps-infra-tooling
+
+# Toolchain and environment pins
+.ruby-version         @Automattic/apps-infra-tooling

data/.github/dependabot.yml

@@ -21,3 +21,12 @@ updates:
     cooldown:
       default-days: 7
       semver-major-days: 14
+
+  - package-ecosystem: bundler
+    directory: /
+    schedule:
+      interval: daily
+    groups:
+      ruby-minor-and-patch:
+        update-types: [minor, patch]
+    open-pull-requests-limit: 5

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

@@ -26,11 +26,11 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - name: 📥 Checkout Repo
-        uses: actions/checkout@v4
+        uses: actions/checkout@v7
         with:
           fetch-depth: 100
       - name: 💎 Ruby Setup
-        uses: ruby/setup-ruby@afeafc3d1ab54a631816aba4c914a0081c12ff2f # v1.310.0
+        uses: ruby/setup-ruby@d45b1a4e94b71acab930e56e79c6aa188764e7f9 # v1.316.0
         with:
           bundler-cache: true
       - name: ☢️ Danger PR Check

data/CHANGELOG.md

@@ -20,6 +20,12 @@ _None_
 
 _None_
 
+## 1.4.0
+
+### New Features
+
+- `pr_size_checker`: add optional `line_selector` to `check_diff_size` (and `insertions_size` / `deletions_size` / `diff_size`) to exclude specific changed lines (e.g. comments and blank lines) from the diff-size metric. [#133]
+
 ## 1.3.0
 
 ### New Features

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    danger-dangermattic (1.3.0)
+    danger-dangermattic (1.4.0)
       danger (~> 9.5, >= 9.5.3)
       danger-plugin-api (~> 1.0)
       danger-rubocop (~> 0.13)
@@ -35,7 +35,7 @@ GEM
       open4 (~> 1.3)
     coderay (1.1.3)
     colored2 (3.1.2)
-    concurrent-ruby (1.3.6)
+    concurrent-ruby (1.3.7)
     connection_pool (3.0.2)
     cork (0.3.0)
       colored2 (~> 3.1)
@@ -60,13 +60,13 @@ GEM
       rubocop (~> 1.0)
     diff-lcs (1.6.2)
     drb (2.2.3)
-    faraday (2.14.1)
+    faraday (2.14.3)
       faraday-net_http (>= 2.0, < 3.5)
       json
       logger
     faraday-http-cache (2.6.1)
       faraday (>= 0.8)
-    faraday-net_http (3.4.2)
+    faraday-net_http (3.4.4)
       net-http (~> 0.5)
     ffi (1.17.2)
     ffi (1.17.2-arm64-darwin)
@@ -94,7 +94,7 @@ GEM
       rspec (>= 2.99.0, < 4.0)
     i18n (1.14.8)
       concurrent-ruby (~> 1.0)
-    json (2.19.3)
+    json (2.20.0)
     kramdown (2.5.2)
       rexml (>= 3.4.4)
     kramdown-parser-gfm (1.1.0)
@@ -190,7 +190,7 @@ GEM
       unicode-emoji (~> 4.1)
     unicode-emoji (4.2.0)
     uri (1.1.1)
-    yard (0.9.43)
+    yard (0.9.44)
 
 PLATFORMS
   arm64-darwin-22

data/lib/dangermattic/gem_version.rb

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

data/lib/dangermattic/plugins/pr_size_checker.rb

@@ -18,6 +18,14 @@ module Danger
   #          # Check the size of insertions in the files selected by the file_selector
   #          pr_size_checker.check_diff_size(file_selector: ->(file) { file.include?('/java/test/') }, type: :insertions)
   #
+  # @example Running a PR diff size check that excludes comment and blank lines from the count
+  #
+  #          # Only count changed lines that are neither blank nor comments (e.g. Kotlin/Java/Swift)
+  #          pr_size_checker.check_diff_size(
+  #            max_size: 300,
+  #            line_selector: ->(line) { stripped = line.strip; !(stripped.empty? || stripped.start_with?('//', '/*', '*', '*/')) }
+  #          )
+  #
   # @example Running a PR description length check
   #
   #          # Check the PR Body using the default parameters, reporting a warning if the PR is smaller than 10 characters
@@ -39,20 +47,28 @@ module Danger
     #
     # @param max_size [Integer] The maximum allowed size for the diff.
     # @param file_selector [Proc] Optional closure to filter the files in the diff to be used for size calculation.
+    # @param line_selector [Proc] Optional closure to filter the individual changed lines counted towards the size.
+    #   It receives the content of an added/removed line (without the leading `+`/`-` diff marker or trailing newline)
+    #   and should return `true` for lines that should be counted. When provided, the size is computed by iterating the
+    #   diff patches instead of the cached numstats, which is slower but allows excluding lines such as comments or blanks.
     # @param type [:insertions, :deletions, :all] The type of diff size to check. (default: :all)
     # @param message [String] The message to display if the diff size exceeds the maximum. (default: DEFAULT_DIFF_SIZE_MESSAGE)
     # @param report_type [Symbol] (optional) The type of report for the message. Types: :error, :warning (default), :message.
     #
     # @return [void]
-    def check_diff_size(max_size:, file_selector: nil, type: :all, message: format(DEFAULT_DIFF_SIZE_MESSAGE_FORMAT, max_size), report_type: :warning)
-      case type
-      when :insertions
-        reporter.report(message: message, type: report_type) if insertions_size(file_selector: file_selector) > max_size
-      when :deletions
-        reporter.report(message: message, type: report_type) if deletions_size(file_selector: file_selector) > max_size
-      when :all
-        reporter.report(message: message, type: report_type) if diff_size(file_selector: file_selector) > max_size
-      end
+    def check_diff_size(max_size:, file_selector: nil, line_selector: nil, type: :all, message: format(DEFAULT_DIFF_SIZE_MESSAGE_FORMAT, max_size), report_type: :warning)
+      size = case type
+             when :insertions
+               insertions_size(file_selector: file_selector, line_selector: line_selector)
+             when :deletions
+               deletions_size(file_selector: file_selector, line_selector: line_selector)
+             when :all
+               diff_size(file_selector: file_selector, line_selector: line_selector)
+             else
+               raise ArgumentError, "Unknown diff size type: #{type.inspect}. Use :insertions, :deletions, or :all."
+             end
+
+      reporter.report(message: message, type: report_type) if size > max_size
     end
 
     # Check the size of the Pull Request description (PR body) against a specified minimum size.
@@ -71,9 +87,12 @@ module Danger
     # Calculate the total size of insertions in modified files that match the file selector.
     #
     # @param file_selector [Proc] Select the files to be used for the insertions calculation.
+    # @param line_selector [Proc] Optional closure to select which added lines are counted (see #check_diff_size).
     #
     # @return [Integer] The total size of insertions in the selected modified files.
-    def insertions_size(file_selector: nil)
+    def insertions_size(file_selector: nil, line_selector: nil)
+      return filtered_diff_size(file_selector: file_selector, line_selector: line_selector, change_types: [:added]) if line_selector
+
       return danger.git.insertions unless file_selector
 
       # Only check added and modified files - deleted files have 0 insertions
@@ -88,9 +107,12 @@ module Danger
     # Calculate the total size of deletions in modified files that match the file selector.
     #
     # @param file_selector [Proc] Select the files to be used for the deletions calculation.
+    # @param line_selector [Proc] Optional closure to select which removed lines are counted (see #check_diff_size).
     #
     # @return [Integer] The total size of deletions in the selected modified files.
-    def deletions_size(file_selector: nil)
+    def deletions_size(file_selector: nil, line_selector: nil)
+      return filtered_diff_size(file_selector: file_selector, line_selector: line_selector, change_types: [:removed]) if line_selector
+
       return danger.git.deletions unless file_selector
 
       filtered_files = git_utils.all_changed_files.select(&file_selector)
@@ -104,9 +126,12 @@ module Danger
     # Calculate the total size of changes (insertions and deletions) in modified files that match the file selector.
     #
     # @param file_selector [Proc] Select the files to be used for the total insertions and deletions calculation.
+    # @param line_selector [Proc] Optional closure to select which added/removed lines are counted (see #check_diff_size).
     #
     # @return [Integer] The total size of changes in the selected modified files.
-    def diff_size(file_selector: nil)
+    def diff_size(file_selector: nil, line_selector: nil)
+      return filtered_diff_size(file_selector: file_selector, line_selector: line_selector, change_types: %i[added removed]) if line_selector
+
       return danger.git.lines_of_code unless file_selector
 
       filtered_files = git_utils.all_changed_files.select(&file_selector)
@@ -119,5 +144,47 @@ module Danger
         stats[:deletions].to_i + stats[:insertions].to_i
       end
     end
+
+    private
+
+    # Count the changed lines across the selected files by iterating the diff patches, keeping only the lines
+    # whose change type is included in `change_types` and for which `line_selector` returns true.
+    #
+    # This is slower than the cached-numstats path used when no `line_selector` is given, since it needs the
+    # actual patch content to evaluate each line, but it is the only way to exclude specific lines (e.g. comments).
+    #
+    # @param file_selector [Proc, nil] Optional closure to select the files to inspect.
+    # @param line_selector [Proc] Closure receiving a changed line's content (without the `+`/`-` marker),
+    #   returning true when the line should be counted.
+    # @param change_types [Array<Symbol>] The diff change types to count (any of :added, :removed).
+    #
+    # @return [Integer] The total number of counted changed lines.
+    def filtered_diff_size(file_selector:, line_selector:, change_types:)
+      files = git_utils.all_changed_files
+      files = files.select(&file_selector) if file_selector
+
+      files.sum do |file|
+        # `patch` can be nil (e.g. binary files), in which case there are no textual lines to count.
+        patch = danger.git.diff_for_file(file)&.patch
+        next 0 unless patch
+
+        patch.each_line.count do |diff_line|
+          next false unless change_types.include?(git_utils.change_type(diff_line: diff_line))
+
+          line_selector.call(strip_diff_marker(diff_line))
+        end
+      end
+    end
+
+    # Strip the leading `+`/`-` diff marker and the trailing newline from a diff patch line,
+    # so that `line_selector` only sees the actual line content.
+    #
+    # @param diff_line [String] A line from a diff patch, e.g. `"+    // a comment\n"`.
+    #
+    # @return [String] The line content, e.g. `"    // a comment"`.
+    def strip_diff_marker(diff_line)
+      without_marker = diff_line[1..].to_s
+      without_marker.chomp
+    end
   end
 end

data/spec/pr_size_checker_spec.rb

@@ -177,6 +177,120 @@ module Danger
           it_behaves_like 'using the default diff size counter, without a file selector', :deletions
           it_behaves_like 'using a file selector to filter and count the changes in a diff', :deletions, [221, 380, 1157]
         end
+
+        context 'when using a line_selector to exclude comment and blank lines' do
+          # Counts a changed line only if, once trimmed, it is neither empty nor the start of a comment.
+          let(:code_line_selector) do
+            lambda do |line|
+              stripped = line.strip
+              !(stripped.empty? || stripped.start_with?('//', '/*', '*', '*/'))
+            end
+          end
+
+          # 4 added code lines (fun/val/return/}) + 1 removed code line, plus comment and blank lines that must be ignored.
+          let(:kotlin_patch) do
+            <<~PATCH
+              diff --git a/Foo.kt b/Foo.kt
+              index 1234567..89abcde 100644
+              --- a/Foo.kt
+              +++ b/Foo.kt
+              @@ -1,2 +1,10 @@
+               package com.example
+              +
+              +// a single line comment
+              +/* a block comment */
+              +/** kdoc opening */
+              + * kdoc continuation line
+              +fun foo(): Int {
+              +    val x = 1
+              +    return x
+              +}
+              -val removedCode = 0
+              -// removed comment
+            PATCH
+          end
+
+          before do
+            stub_const('GitDiffStruct', Struct.new(:type, :path, :patch))
+            allow(@plugin.git).to receive_messages(added_files: ['Foo.kt'], modified_files: [], deleted_files: [])
+            allow(@plugin.git).to receive(:diff_for_file).with('Foo.kt').and_return(GitDiffStruct.new('added', 'Foo.kt', kotlin_patch))
+          end
+
+          it 'reports a warning when the non-comment, non-blank changes exceed the max (type :all counts 5)' do
+            @plugin.check_diff_size(max_size: 4, type: :all, line_selector: code_line_selector)
+
+            expect(@dangerfile).to report_warnings([format(described_class::DEFAULT_DIFF_SIZE_MESSAGE_FORMAT, 4)])
+          end
+
+          it 'does nothing when the non-comment, non-blank changes are within the max (type :all counts 5)' do
+            @plugin.check_diff_size(max_size: 5, type: :all, line_selector: code_line_selector)
+
+            expect(@dangerfile).to not_report
+          end
+
+          it 'counts only added code lines for :insertions (counts 4)' do
+            @plugin.check_diff_size(max_size: 3, type: :insertions, line_selector: code_line_selector)
+
+            expect(@dangerfile).to report_warnings([format(described_class::DEFAULT_DIFF_SIZE_MESSAGE_FORMAT, 3)])
+          end
+
+          it 'does nothing for :insertions when the added code lines are within the max (counts 4)' do
+            @plugin.check_diff_size(max_size: 4, type: :insertions, line_selector: code_line_selector)
+
+            expect(@dangerfile).to not_report
+          end
+
+          it 'counts only removed code lines for :deletions (counts 1)' do
+            @plugin.check_diff_size(max_size: 0, type: :deletions, line_selector: code_line_selector)
+
+            expect(@dangerfile).to report_warnings([format(described_class::DEFAULT_DIFF_SIZE_MESSAGE_FORMAT, 0)])
+          end
+
+          it 'does nothing for :deletions when the removed code lines are within the max (counts 1)' do
+            @plugin.check_diff_size(max_size: 1, type: :deletions, line_selector: code_line_selector)
+
+            expect(@dangerfile).to not_report
+          end
+
+          it 'exposes the filtered counts through the size helpers' do
+            expect(@plugin.diff_size(line_selector: code_line_selector)).to eq(5)
+            expect(@plugin.insertions_size(line_selector: code_line_selector)).to eq(4)
+          end
+
+          context 'when combined with a file_selector' do
+            before do
+              excluded_test_file = 'src/test/java/FooTest.kt'
+              allow(@plugin.git).to receive_messages(added_files: ['Foo.kt', excluded_test_file], modified_files: [], deleted_files: [])
+              allow(@plugin.git).to receive(:diff_for_file).with(excluded_test_file).and_return(GitDiffStruct.new('added', excluded_test_file, kotlin_patch))
+            end
+
+            it 'only counts lines in files accepted by the file_selector' do
+              # Both files carry the same patch (5 code lines each); excluding the test file must keep the count at 5, not 10.
+              file_selector = ->(path) { !path.include?('src/test') }
+
+              expect(
+                @plugin.diff_size(file_selector: file_selector, line_selector: code_line_selector)
+              ).to eq(5)
+            end
+          end
+
+          context 'without a line_selector (default numstats path)' do
+            before do
+              allow(@plugin.git).to receive(:diff).and_return(instance_double(Git::Diff))
+              allow(@plugin.git.diff).to receive(:stats).and_return({ files: { 'Foo.kt' => { insertions: 9, deletions: 2 } } })
+            end
+
+            it 'counts every changed line including comments and blanks (counts 11)' do
+              @plugin.check_diff_size(max_size: 10, type: :all, file_selector: ->(_path) { true })
+
+              expect(@dangerfile).to report_warnings([format(described_class::DEFAULT_DIFF_SIZE_MESSAGE_FORMAT, 10)])
+            end
+          end
+        end
+
+        it 'raises an ArgumentError when given an unknown diff size type' do
+          expect { @plugin.check_diff_size(max_size: 100, type: :unknown) }.to raise_error(ArgumentError)
+        end
       end
 
       context 'when checking a PR body size' do

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: danger-dangermattic
 version: !ruby/object:Gem::Version
-  version: 1.3.0
+  version: 1.4.0
 platform: ruby
 authors:
 - Automattic
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2026-06-16 00:00:00.000000000 Z
+date: 2026-07-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: danger
@@ -207,6 +207,7 @@ files:
 - ".buildkite/gem-push.sh"
 - ".buildkite/pipeline.yml"
 - ".bundle/config"
+- ".github/CODEOWNERS"
 - ".github/dependabot.yml"
 - ".github/workflows/README.md"
 - ".github/workflows/reusable-check-labels-on-issues.yml"