Use different reviewer checklist for pre-2026 issues

The pre2026 checklist template file will be used if the review issue is labeled as 'pre-2026-submission'

Author: xuanxu

app/responders/openjournals/reviewer_checklists_responder.rb

@@ -0,0 +1,69 @@
+require_relative '../../lib/responder'
+
+module Openjournals
+  class ReviewerChecklistsResponder < Responder
+
+    keyname :openjournals_reviewer_checklists
+
+    def define_listening
+      @event_action = "issue_comment.created"
+      @event_regex = /\A@#{bot_name} #{command}\.?\s*$/i
+    end
+
+    def process_message(message)
+      if sender_in_reviewers_list?
+        checklist = render_external_template(template_filename, locals)
+        update_comment(context.comment_id, checklist)
+        update_checklists_links
+      else
+        respond("@#{context.sender} I can't do that because you are not a reviewer")
+      end
+    end
+
+    def template_filename
+      context.issue_labels.map{|il| il["name"]}.include?("pre-2026-submission") ? "reviewer_checklist_pre2026.md" : "reviewer_checklist.md"
+    end
+
+    def sender_in_reviewers_list?
+      reviewers.include?("@#{context.sender.downcase}")
+    end
+
+    def update_checklists_links
+      if issue_body_has?("checklist-comments")
+        mapping = checklists_mapping.merge({"#{context.sender}" => "📝 [Checklist for @#{context.sender}](#{comment_url})"})
+
+        checklists = mapping.keys.map do |k|
+          "<!--checklist-for-#{k}-->\n#{mapping[k]}\n<!--end-checklist-for-#{k}-->"
+        end
+
+        update_value("checklist-comments", "\n"+checklists.join("\n")+"\n")
+      end
+    end
+
+    def reviewers
+      @reviewers ||= read_value_from_body("reviewers-list").split(",").map(&:strip).map(&:downcase)
+    end
+
+    def checklists_mapping
+      mapping = {}
+      reviewers.each do |rev|
+        rev_login = rev.gsub("@", "")
+        checklink_link = read_value_from_body("checklist-for-#{rev_login}")
+        mapping[rev_login] = checklink_link unless checklink_link.empty?
+      end
+      mapping
+    end
+
+    def command
+      params[:command] || "generate my checklist"
+    end
+
+    def default_description
+      "Adds a checklist for the reviewer using this command"
+    end
+
+    def default_example_invocation
+      "@#{bot_name} #{command}"
+    end
+  end
+end

config/settings-production.yml

@@ -52,11 +52,10 @@ buffy:
       only: editors
       authorized_roles_in_issue:
         - reviewers-list
-    reviewer_checklist_comment:
+    openjournals_reviewer_checklists:
       if:
         title: "^\\[REVIEW\\]:"
         reject_msg: Checklists can only be created once the review has started in the review issue
-      template_file: reviewer_checklist.md
       data_from_issue:
         - target-repository
         - author-handle

spec/responders/openjournals/reviewer_checklists_responder_spec.rb

@@ -0,0 +1,142 @@
+require_relative "../../spec_helper.rb"
+
+describe Openjournals::ReviewerChecklistsResponder do
+
+  subject do
+    described_class
+  end
+
+  before do
+    settings = { env: {bot_github_user: "editorialbot"} }
+    @responder = subject.new(settings, {})
+  end
+
+  describe "listening" do
+    it "should listen to new comments" do
+      expect(@responder.event_action).to eq("issue_comment.created")
+    end
+
+    it "should define regex" do
+      expect(@responder.event_regex).to match("@editorialbot generate my checklist")
+      expect(@responder.event_regex).to match("@editorialbot generate my checklist.")
+      expect(@responder.event_regex).to match("@editorialbot generate my checklist   \r\n")
+      expect(@responder.event_regex).to match("@editorialbot generate my checklist   \r\nmore")
+      expect(@responder.event_regex).to_not match("@editorialbot generate my checklist for @arfon.")
+      expect(@responder.event_regex).to_not match("@editorialbot generate my checkl")
+    end
+  end
+
+    describe "#process_message" do
+    before do
+      @responder.context = OpenStruct.new(issue_id: 5,
+                                          issue_author: "opener",
+                                          issue_title: "New paper",
+                                          issue_labels: [{"name" => "test"}],
+                                          repo: "openjournals/buffy",
+                                          comment_id: 111222,
+                                          issue_body: "Test Submission\n\n ... description ... \n\n" +
+                                                      "<!--author-handle-->@submitter<!--end-author-handle-->\n" +
+                                                      "<!--reviewers-list-->@reviewer1, @reviewer2<!--end-reviewers-list-->")
+      @msg = "@editorialbot generate my checklist"
+      disable_github_calls_for(@responder)
+    end
+
+    context "generate checklist command" do
+      it "should add user checklist for reviewer" do
+        @responder.context[:sender] = "reviewer1"
+
+        expected_locals = { issue_id: 5, issue_author: "opener", bot_name: "editorialbot", issue_title: "New paper", repo: "openjournals/buffy", sender: "reviewer1" }
+        expected_checklist = "Checklist for @reviewer1 \n[] A"
+
+        expect(@responder).to receive(:render_external_template).with("reviewer_checklist.md", expected_locals).and_return(expected_checklist)
+        expect(@responder).to receive(:update_comment).with(111222, expected_checklist)
+        expect(@responder).to_not receive(:respond)
+        @responder.process_message(@msg)
+      end
+
+      it "should use pre-2026 checklist if issue is labeled" do
+        @responder.context[:sender] = "reviewer1"
+        @responder.context.issue_labels << {"name" => "pre-2026-submission"}
+
+        expected_locals = { issue_id: 5, issue_author: "opener", bot_name: "editorialbot", issue_title: "New paper", repo: "openjournals/buffy", sender: "reviewer1" }
+        expected_checklist = "Checklist for @reviewer1 \n[] A"
+
+        expect(@responder).to receive(:render_external_template).with("reviewer_checklist_pre2026.md", expected_locals).and_return(expected_checklist)
+        expect(@responder).to receive(:update_comment).with(111222, expected_checklist)
+        expect(@responder).to_not receive(:respond)
+        @responder.process_message(@msg)
+      end
+
+
+      it "should be case insensitive for the reviewer's username" do
+        @responder.context[:sender] = "ReVIEwer1"
+
+        expected_locals = { issue_id: 5, issue_author: "opener", issue_title: "New paper", bot_name: "editorialbot", repo: "openjournals/buffy", sender: "ReVIEwer1" }
+        expected_checklist = "Checklist for @ReVIEwer1 \n[] A"
+
+        expect(@responder).to receive(:render_external_template).with("reviewer_checklist.md", expected_locals).and_return(expected_checklist)
+        expect(@responder).to receive(:update_comment).with(111222, expected_checklist)
+        expect(@responder).to_not receive(:respond)
+        @responder.process_message(@msg)
+      end
+
+      it "should not add user checklist if sender is not a reviewer" do
+        @responder.context[:sender] = "nonreviewer"
+
+        expect(@responder).to receive(:respond).with("@nonreviewer I can't do that because you are not a reviewer")
+        @responder.process_message(@msg)
+      end
+    end
+
+    context "checklist links" do
+      before do
+        @responder.context[:sender] = "reviewer1"
+
+        expected_locals = { issue_id: 5, issue_author: "opener", issue_title: "New paper", bot_name: "editorialbot", repo: "openjournals/buffy", sender: "reviewer1" }
+        expected_checklist = "Checklist for @reviewer1 \n[] A"
+
+        expect(@responder).to receive(:render_external_template).with("reviewer_checklist.md", expected_locals).and_return(expected_checklist)
+        expect(@responder).to receive(:update_comment).with(111222, expected_checklist)
+
+
+        @link1 = "<!--checklist-for-reviewer1-->\n📝 [Checklist for @reviewer1](https://github.com/openjournals/buffy/issues/5#issuecomment-111222)\n<!--end-checklist-for-reviewer1-->"
+        @link2 = "<!--checklist-for-reviewer2-->\n📝 [Checklist for @reviewer2](https://github.com/openjournals/buffy/issues/5#issuecomment-222222)\n<!--end-checklist-for-reviewer2-->"
+      end
+
+      it "should not add link to checklist if no checklist-comments mark" do
+        expect(@responder).to_not receive(:update_value)
+        @responder.process_message(@msg)
+      end
+
+      it "should add link to the issue's text" do
+        @responder.context[:issue_body] += "<!--checklist-comments--><!--end-checklist-comments-->"
+
+        expect(@responder).to receive(:update_value).with("checklist-comments", "\n#{@link1}\n")
+        @responder.process_message(@msg)
+      end
+
+      it "should add link to existing checklist" do
+        @responder.context[:issue_body] += "<!--checklist-comments-->#{@link2}<!--end-checklist-comments-->"
+
+        expect(@responder).to receive(:update_value).with("checklist-comments", "\n#{@link2}\n#{@link1}\n")
+        @responder.process_message(@msg)
+      end
+
+      it "should update links to checklist in the issue's text" do
+        previous_link = "<!--checklist-for-reviewer1-->Whatever<!--end-checklist-for-reviewer1-->"
+        @responder.context[:issue_body] += "<!--checklist-comments--><!--end-checklist-comments-->"
+
+        expect(@responder).to receive(:update_value).with("checklist-comments", "\n#{@link1}\n")
+        @responder.process_message(@msg)
+      end
+    end
+  end
+
+  it "command is customizable" do
+    responder = subject.new({env: {bot_github_user: "editorialbot"}}, {command: "create check-list"})
+
+    expect(responder.event_regex).to match("@editorialbot create check-list")
+    expect(responder.event_regex).to_not match("@editorialbot generate my checklist")
+  end
+
+end