GithubHelper: Change all methods to be instance methods

In the past all the methods use the self to be accessed as class methods, as is now mandatory to instanciate the GithubHelper, the methods are now converted in instance methods.

Author: raafaelima

lib/fastlane/plugin/wpmreleasetoolkit/helper/github_helper.rb

@@ -25,7 +25,7 @@ def initialize(github_token:)
         @client.auto_paginate = true
       end
 
-      def self.get_milestone(repository, release)
+      def get_milestone(repository, release)
         miles = client.list_milestones(repository)
         mile = nil
 
@@ -42,11 +42,11 @@ def self.get_milestone(repository, release)
       # @param [String] milestone The name of the milestone we want to fetch the list of PRs for (e.g.: `16.9`)
       # @return [<Sawyer::Resource>] A list of the PRs for the given milestone, sorted by number
       #
-      def self.get_prs_for_milestone(repository, milestone)
+      def get_prs_for_milestone(repository, milestone)
         client.search_issues(%(type:pr milestone:"#{milestone}" repo:#{repository}))[:items].sort_by(&:number)
       end
 
-      def self.get_last_milestone(repository)
+      def get_last_milestone(repository)
         options = {}
         options[:state] = 'open'
 
@@ -71,7 +71,7 @@ def self.get_last_milestone(repository)
         last_stone
       end
 
-      def self.create_milestone(repository, newmilestone_number, newmilestone_duedate, newmilestone_duration, number_of_days_from_code_freeze_to_release, need_submission)
+      def create_milestone(repository, newmilestone_number, newmilestone_duedate, newmilestone_duration, number_of_days_from_code_freeze_to_release, need_submission)
         # If there is a review process, we want to submit the binary 3 days before its release
         #
         # Using 3 days is mostly for historical reasons where we release the apps on Monday and submit them on Friday.
@@ -112,7 +112,7 @@ def self.create_milestone(repository, newmilestone_number, newmilestone_duedate,
       # @param [Array<String>] assets List of file paths to attach as assets to the release
       # @param [TrueClass|FalseClass] prerelease Indicates if this should be created as a pre-release (i.e. for alpha/beta)
       #
-      def self.create_release(repository:, version:, target: nil, description:, assets:, prerelease:)
+      def create_release(repository:, version:, target: nil, description:, assets:, prerelease:)
         release = client.create_release(
           repository,
           version, # tag name
@@ -135,7 +135,7 @@ def self.create_release(repository:, version:, target: nil, description:, assets
       # @param [String] download_folder The folder which the file should be downloaded into
       # @return [String] The path of the downloaded file, or nil if something went wrong
       #
-      def self.download_file_from_tag(repository:, tag:, file_path:, download_folder:)
+      def download_file_from_tag(repository:, tag:, file_path:, download_folder:)
         repository = repository.delete_prefix('/').chomp('/')
         file_path = file_path.delete_prefix('/').chomp('/')
         file_name = File.basename(file_path)
@@ -156,7 +156,7 @@ def self.download_file_from_tag(repository:, tag:, file_path:, download_folder:)
       end
 
       # Creates (or updates an existing) GitHub PR Comment
-      def self.comment_on_pr(project_slug:, pr_number:, body:, reuse_identifier: SecureRandom.uuid)
+      def comment_on_pr(project_slug:, pr_number:, body:, reuse_identifier: SecureRandom.uuid)
         comments = client.issue_comments(project_slug, pr_number)
 
         reuse_marker = "<!-- REUSE_ID: #{reuse_identifier} -->"
@@ -189,7 +189,7 @@ def self.comment_on_pr(project_slug:, pr_number:, body:, reuse_identifier: Secur
       # @return [Milestone] A single milestone object
       # @see http://developer.github.com/v3/issues/milestones/#update-a-milestone
       #
-      def self.update_milestone(repository:, number:, options:)
+      def update_milestone(repository:, number:, options:)
         client.update_milestone(repository, number, options)
       end
 
@@ -200,7 +200,7 @@ def self.update_milestone(repository:, number:, options:)
       # @param [Hash] options A customizable set of options.
       # @see https://docs.github.com/en/rest/branches/branch-protection#update-branch-protection
       #
-      def self.remove_branch_protection(repository:, branch:, options:)
+      def remove_branch_protection(repository:, branch:, options:)
         client.unprotect_branch(repository, branch_name, options)
       end
 
@@ -211,7 +211,7 @@ def self.remove_branch_protection(repository:, branch:, options:)
       # @param options [Hash] A customizable set of options.
       # @see https://docs.github.com/en/rest/branches/branch-protection#update-branch-protection
       #
-      def self.set_branch_protection(repository:, branch:, options:)
+      def set_branch_protection(repository:, branch:, options:)
         client.protect_branch(repository, branch_name, options)
       end
 

spec/github_helper_spec.rb

@@ -29,17 +29,19 @@
     let(:client) do
       instance_double(
         Octokit::Client,
-        contents: double(download_url: content_url) # rubocop:disable RSpec/VerifiedDoubles
+        contents: double(download_url: content_url), # rubocop:disable RSpec/VerifiedDoubles
+        user: instance_double('User', name: 'test'),
+        'auto_paginate=': nil
       )
     end
 
     before do
-      allow(described_class).to receive(:client).and_return(client)
+      allow(Octokit::Client).to receive(:new).and_return(client)
     end
 
     it 'fails if it does not find the right release on GitHub' do
       stub = stub_request(:get, content_url).to_return(status: [404, 'Not Found'])
-      downloaded_file = described_class.download_file_from_tag(repository: test_repo, tag: test_tag, file_path: test_file, download_folder: './')
+      downloaded_file = download_file_from_tag(download_folder: './')
       expect(downloaded_file).to be_nil
       expect(stub).to have_been_made.once
     end
@@ -48,12 +50,17 @@
       stub = stub_request(:get, content_url).to_return(status: 200, body: 'my-test-content')
       Dir.mktmpdir('a8c-download-repo-file-') do |tmpdir|
         dst_file = File.join(tmpdir, 'test-file.xml')
-        downloaded_file = described_class.download_file_from_tag(repository: test_repo, tag: test_tag, file_path: test_file, download_folder: tmpdir)
+        downloaded_file = download_file_from_tag(download_folder: tmpdir)
         expect(downloaded_file).to eq(dst_file)
         expect(stub).to have_been_made.once
         expect(File.read(dst_file)).to eq('my-test-content')
       end
     end
+
+    def download_file_from_tag(download_folder:)
+      helper = described_class.new(github_token: 'Fake-GitHubToken-123')
+      helper.download_file_from_tag(repository: test_repo, tag: test_tag, file_path: test_file, download_folder: download_folder)
+    end
   end
 
   describe 'get_last_milestone' do
@@ -62,23 +69,30 @@
     let(:client) do
       instance_double(
         Octokit::Client,
-        list_milestones: ['9.8 ❄️', '9.9'].map { |title| mock_milestone(title) }.append(last_stone)
+        list_milestones: ['9.8 ❄️', '9.9'].map { |title| mock_milestone(title) }.append(last_stone),
+        user: instance_double('User', name: 'test'),
+        'auto_paginate=': nil
       )
     end
 
     before do
-      allow(described_class).to receive(:client).and_return(client)
+      allow(Octokit::Client).to receive(:new).and_return(client)
     end
 
     it 'returns correct milestone' do
       expect(client).to receive(:list_milestones)
-      last_milestone = described_class.get_last_milestone(repository: test_repo)
+      last_milestone = get_last_milestone(repository: test_repo)
       expect(last_milestone).to eq(last_stone)
     end
 
     def mock_milestone(title)
       { title: title }
     end
+
+    def get_last_milestone(repository:)
+      helper = described_class.new(github_token: 'Fake-GitHubToken-123')
+      helper.get_last_milestone(repository: repository)
+    end
   end
 
   describe 'comment_on_pr' do
@@ -88,12 +102,13 @@ def mock_milestone(title)
         issue_comments: [],
         add_comment: nil,
         update_comment: nil,
-        user: instance_double('User', id: 1234)
+        user: instance_double('User', id: 1234, name: 'test'),
+        'auto_paginate=': nil
       )
     end
 
     before do
-      allow(described_class).to receive(:client).and_return(client)
+      allow(Octokit::Client).to receive(:new).and_return(client)
     end
 
     it 'will create a new comment if an existing one is not found' do
@@ -124,7 +139,8 @@ def mock_milestone(title)
     end
 
     def comment_on_pr
-      described_class.comment_on_pr(
+      helper = described_class.new(github_token: 'Fake-GitHubToken-123')
+      helper.comment_on_pr(
         project_slug: 'test/test',
         pr_number: 1234,
         body: 'Test',
@@ -143,41 +159,48 @@ def mock_comment(body: '<!-- REUSE_ID: test-id --> Test', user_id: 1234)
     let(:client) do
       instance_double(
         Octokit::Client,
-        list_milestones: []
+        list_milestones: [],
+        user: instance_double('User', name: 'test'),
+        'auto_paginate=': nil
       )
     end
 
     before do
-      allow(described_class).to receive(:client).and_return(client)
+      allow(Octokit::Client).to receive(:new).and_return(client)
     end
 
     it 'properly passes the repository all the way down to the Octokit::Client' do
       expect(client).to receive(:list_milestones).with(test_repo)
-      described_class.get_milestone(test_repo, 'test')
+      get_milestone(milestone_name: 'test')
     end
 
     it 'returns nil when no milestone is returned from the api' do
-      milestone = described_class.get_milestone(test_repo, '10')
+      milestone = get_milestone(milestone_name: '10')
       expect(milestone).to be_nil
     end
 
     it 'returns nil when no milestone title starts with the searched term' do
       allow(client).to receive(:list_milestones).and_return(test_milestones)
-      milestone = described_class.get_milestone(test_repo, '8.5')
+      milestone = get_milestone(milestone_name: '8.5')
       expect(milestone).to be_nil
     end
 
     it 'returns a milestone when the milestone title starts with search term' do
       allow(client).to receive(:list_milestones).and_return(test_milestones)
-      milestone = described_class.get_milestone(test_repo, '9')
+      milestone = get_milestone(milestone_name: '9')
       expect(milestone).to eq({ title: '9.8' })
     end
 
     it 'returns the milestone with the latest due date matching the search term when there are more than one' do
       allow(client).to receive(:list_milestones).and_return(test_milestones)
-      milestone = described_class.get_milestone(test_repo, '10.1')
+      milestone = get_milestone(milestone_name: '10.1')
       expect(milestone).to eq({ title: '10.1.3 ❄️' })
     end
+
+    def get_milestone(milestone_name:)
+      helper = described_class.new(github_token: 'Fake-GitHubToken-123')
+      helper.get_milestone(test_repo, milestone_name)
+    end
   end
 
   describe 'create_milestone' do
@@ -187,12 +210,14 @@ def mock_comment(body: '<!-- REUSE_ID: test-id --> Test', user_id: 1234)
     let(:client) do
       instance_double(
         Octokit::Client,
-        create_milestone: nil
+        create_milestone: nil,
+        user: instance_double('User', name: 'test'),
+        'auto_paginate=': nil
       )
     end
 
     before do
-      allow(described_class).to receive(:client).and_return(client)
+      allow(Octokit::Client).to receive(:new).and_return(client)
     end
 
     it 'has the correct dates to code freeze without submission' do
@@ -212,7 +237,8 @@ def mock_comment(body: '<!-- REUSE_ID: test-id --> Test', user_id: 1234)
     end
 
     def create_milestone(need_submission:, milestone_duration:, days_code_freeze:)
-      described_class.create_milestone(
+      helper = described_class.new(github_token: 'Fake-GitHubToken-123')
+      helper.create_milestone(
         test_repo,
         test_milestone_number,
         test_milestone_duedate.to_time.utc,
@@ -231,12 +257,14 @@ def create_milestone(need_submission:, milestone_duration:, days_code_freeze:)
     let(:client) do
       instance_double(
         Octokit::Client,
-        create_release: nil
+        create_release: nil,
+        user: instance_double('User', name: 'test'),
+        'auto_paginate=': nil
       )
     end
 
     before do
-      allow(described_class).to receive(:client).and_return(client)
+      allow(Octokit::Client).to receive(:new).and_return(client)
     end
 
     it 'has the correct options' do
@@ -255,7 +283,8 @@ def create_milestone(need_submission:, milestone_duration:, days_code_freeze:)
     end
 
     def create_release(assets: [])
-      described_class.create_release(
+      helper = described_class.new(github_token: 'Fake-GitHubToken-123')
+      helper.create_release(
         repository: test_repo,
         version: test_tag,
         target: test_target,