Add option to support closed-but-not-merged PRs (#72)

Signed-off-by: Phil Dibowitz <phil@ipom.com>

Author: jaymzh

examples/repo_stats_config.rb

@@ -13,6 +13,11 @@
 log_level :info
 ci_timeout 600
 include_list false
+# by default we don't count unmerged-but-closed PRs as in "closed PRs"
+# but some workflows push commits that reference the PR as a way of
+# "merging" the PR, and if your workflow does so, you can set this so
+# that we count such PRs as "merged."
+count_unmerged_prs false
 
 # the most interesting part about this config file
 # is the organizations block. It allows you to specify

lib/oss_stats/config/repo_stats.rb

@@ -36,6 +36,7 @@ module RepoStats
       buildkite_token nil
       limit_gh_ops_per_minute nil
       include_list false
+      count_unmerged_prs false
       mode ['all']
       organizations({})
 

lib/oss_stats/repo_stats.rb

@@ -106,8 +106,14 @@ def get_pr_and_issue_stats(gh_client, options)
           # window
           next unless closed_date && closed_date >= cutoff_date
 
-          # if it's a PR make sure it was closed by merging
-          next unless !is_pr || item.pull_request.merged_at
+          # Only count this PR/Issue as closed depending on settings.
+          if is_pr
+            unless OssStats::Config::RepoStats.count_unmerged_prs
+              # Default: only count PRs that were merged
+              next unless item.pull_request && item.pull_request.merged_at
+            end
+            # when count_unmerged_prs is true we allow closed-but-unmerged PRs
+          end
 
           # anything closed this week counts as closed regardless of when it
           # was opened
@@ -793,6 +799,12 @@ def parse_options
           'Disable Markdown links in the output (default: false)',
         ) { options[:no_links] = true }
 
+        opts.on(
+          '--count-unmerged-prs',
+          'Count PRs that were closed without merging as closed' +
+            ' (default: false)',
+        ) { options[:count_unmerged_prs] = true }
+
         opts.on(
           '--mode MODE',
           Array,

spec/repo_stats_spec.rb

@@ -92,6 +92,66 @@
       expect(stats[:issue][:closed]).to eq(0)
     end
 
+    it 'does not count closed-but-unmerged PRs by default' do
+      # closed PR but not merged
+      allow(client).to receive(:issues).with(
+        'test_org/test_repo',
+        hash_including(page: 1),
+      ).and_return(
+        [
+          double(
+            created_at: Date.today - 7,
+            closed_at: Date.today - 2,
+            pull_request: double(merged_at: nil),
+            updated_at: Date.today - 1,
+            labels: [],
+          ),
+        ],
+      )
+      allow(client).to receive(:issues).with(
+        'test_org/test_repo',
+        hash_including(page: 2),
+      ).and_return([])
+
+      # ensure default is false
+      OssStats::Config::RepoStats.count_unmerged_prs = false
+
+      stats = get_pr_and_issue_stats(client, options)
+      expect(stats[:pr][:closed]).to eq(0)
+
+      # reset
+      OssStats::Config::RepoStats.count_unmerged_prs = false
+    end
+
+    it 'counts closed-but-unmerged PRs when configured' do
+      allow(client).to receive(:issues).with(
+        'test_org/test_repo',
+        hash_including(page: 1),
+      ).and_return(
+        [
+          double(
+            created_at: Date.today - 7,
+            closed_at: Date.today - 2,
+            pull_request: double(merged_at: nil),
+            updated_at: Date.today - 1,
+            labels: [],
+          ),
+        ],
+      )
+      allow(client).to receive(:issues).with(
+        'test_org/test_repo',
+        hash_including(page: 2),
+      ).and_return([])
+
+      OssStats::Config::RepoStats.count_unmerged_prs = true
+
+      stats = get_pr_and_issue_stats(client, options)
+      expect(stats[:pr][:closed]).to eq(1)
+
+      # reset
+      OssStats::Config::RepoStats.count_unmerged_prs = false
+    end
+
     it 'handles empty responses gracefully' do
       allow(client).to receive(:issues).and_return([])