git_helper 3.2.0 → 3.3.2

data/lib/git_helper/new_branch.rb

@@ -1,7 +1,9 @@
+# frozen_string_literal: true
+
 module GitHelper
   class NewBranch
     def execute(new_branch_name = nil)
-      branch_name = new_branch_name || GitHelper::HighlineCli.new.new_branch_name
+      branch_name = new_branch_name || GitHelper::HighlineCli.new.ask('New branch name?')
       puts "Attempting to create a new branch: #{branch_name}"
       GitHelper::LocalCode.new.new_branch(branch_name)
     end

data/lib/git_helper/octokit_client.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module GitHelper
   class OctokitClient
     def client

data/lib/git_helper/pull_request.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module GitHelper
   class GitHubPullRequest
     attr_accessor :local_repo, :local_branch, :local_code, :cli, :base_branch, :new_pr_title
@@ -9,67 +11,79 @@ module GitHelper
       @cli = options[:cli]
     end
 
+    # rubocop:disable Metrics/MethodLength
+    # rubocop:disable Metrics/AbcSize
     def create(options)
       @base_branch = options[:base_branch]
       @new_pr_title = options[:new_title]
 
-      begin
-        new_pr_body
+      new_pr_body
 
-        puts "Creating pull request: #{new_pr_title}"
-        pr = octokit_client.create_pull_request(local_repo, base_branch, local_branch, new_pr_title, new_pr_body)
-        puts "Pull request successfully created: #{pr.html_url}"
-      rescue Octokit::UnprocessableEntity => e
-        puts 'Could not create pull request:'
-        if e.message.include?('pull request already exists')
-          puts '  A pull request already exists for this branch'
-        elsif e.message.include?('No commits between')
-          puts '  No commits have been pushed to GitHub'
-        else
-          puts e.message
-        end
-      rescue Exception => e
-        puts 'Could not create pull request:'
+      puts "Creating pull request: #{new_pr_title}"
+      pr = octokit_client.create_pull_request(
+        local_repo,
+        base_branch,
+        local_branch,
+        new_pr_title,
+        new_pr_body
+      )
+      puts "Pull request successfully created: #{pr.html_url}"
+    rescue Octokit::UnprocessableEntity => e
+      puts 'Could not create pull request:'
+      if e.message.include?('pull request already exists')
+        puts '  A pull request already exists for this branch'
+      elsif e.message.include?('No commits between')
+        puts '  No commits have been pushed to GitHub'
+      else
         puts e.message
       end
+    rescue StandardError => e
+      puts 'Could not create pull request:'
+      puts e.message
     end
+    # rubocop:enable Metrics/AbcSize
+    # rubocop:enable Metrics/MethodLength
 
+    # rubocop:disable Metrics/MethodLength
+    # rubocop:disable Metrics/AbcSize
     def merge
-      begin
-        pr_id
-        merge_method
-
-        puts "Merging pull request: #{pr_id}"
-        merge = octokit_client.merge_pull_request(local_repo, pr_id, existing_pr.title, { merge_method: merge_method })
-        puts "Pull request successfully merged: #{merge.sha}"
-      rescue Octokit::UnprocessableEntity => e
-        puts 'Could not merge pull request:'
-        puts e.message
-      rescue Octokit::NotFound => e
-        puts 'Could not merge pull request:'
-        puts "  Could not a locate a pull request to merge with ID #{pr_id}"
-      rescue Octokit::MethodNotAllowed => e
-        puts 'Could not merge pull request:'
-        if e.message.include?('405 - Required status check')
-          puts '  A required status check has not passed'
-        elsif e.message.include?('405 - Base branch was modified')
-          puts '  The base branch has been modified'
-        elsif e.message.include?('405 - Pull Request is not mergeable')
-          puts '  The pull request is not mergeable'
-        elsif e.message.include?('405 - Rebase merges are not allowed on this repository')
-          puts '  Rebase merges are not allowed on this repository'
-        elsif e.message.include?('405 - Merge commits are not allowed on this repository')
-          puts '  Merge commits are not allowed on this repository'
-        elsif e.message.include?('405 - Squash commits are not allowed on this repository')
-          puts '  Squash merges are not allowed on this repository'
-        else
-          puts e.message
-        end
-      rescue Exception => e
-        puts 'Could not merge pull request:'
+      pr_id
+      merge_method
+
+      puts "Merging pull request: #{pr_id}"
+      merge = octokit_client.merge_pull_request(
+        local_repo,
+        pr_id,
+        existing_pr.title,
+        { merge_method: merge_method }
+      )
+      puts "Pull request successfully merged: #{merge.sha}"
+    rescue Octokit::NotFound
+      puts 'Could not merge pull request:'
+      puts "  Could not a locate a pull request to merge with ID #{pr_id}"
+    rescue Octokit::MethodNotAllowed => e
+      puts 'Could not merge pull request:'
+      if e.message.include?('405 - Required status check')
+        puts '  A required status check has not passed'
+      elsif e.message.include?('405 - Base branch was modified')
+        puts '  The base branch has been modified'
+      elsif e.message.include?('405 - Pull Request is not mergeable')
+        puts '  The pull request is not mergeable'
+      elsif e.message.include?('405 - Rebase merges are not allowed on this repository')
+        puts '  Rebase merges are not allowed on this repository'
+      elsif e.message.include?('405 - Merge commits are not allowed on this repository')
+        puts '  Merge commits are not allowed on this repository'
+      elsif e.message.include?('405 - Squash commits are not allowed on this repository')
+        puts '  Squash merges are not allowed on this repository'
+      else
         puts e.message
       end
+    rescue StandardError => e
+      puts 'Could not merge pull request:'
+      puts e.message
     end
+    # rubocop:enable Metrics/AbcSize
+    # rubocop:enable Metrics/MethodLength
 
     private def new_pr_body
       @new_pr_body ||= template_name_to_apply ? local_code.read_template(template_name_to_apply) : ''
@@ -77,39 +91,56 @@ module GitHelper
 
     private def template_name_to_apply
       return @template_name_to_apply if @template_name_to_apply
+
       @template_name_to_apply = nil
 
-      unless pr_template_options.empty?
-        if pr_template_options.count == 1
-          apply_single_template = cli.apply_template?(pr_template_options.first, 'pull')
-          @template_name_to_apply = pr_template_options.first if apply_single_template
-        else
-          response = cli.template_to_apply(pr_template_options, 'pull')
-          @template_name_to_apply = response unless response == 'None'
-        end
-      end
+      determine_template unless pr_template_options.empty?
 
       @template_name_to_apply
     end
 
+    # rubocop:disable Metrics/MethodLength
+    private def determine_template
+      if pr_template_options.count == 1
+        apply_single_template = cli.ask_yes_no(
+          "Apply the pull request template from #{pr_template_options.first}? (y/n)"
+        )
+        @template_name_to_apply = pr_template_options.first if apply_single_template
+      else
+        response = cli.ask_options(
+          'Which pull request template should be applied?', pr_template_options << 'None'
+        )
+        @template_name_to_apply = response unless response == 'None'
+      end
+    end
+    # rubocop:enable Metrics/MethodLength
+
     private def pr_template_options
-      @pr_template_options ||= local_code.template_options({
-                                 template_directory: '.github',
-                                 nested_directory_name: 'PULL_REQUEST_TEMPLATE',
-                                 non_nested_file_name: 'pull_request_template'
-                               })
+      @pr_template_options ||= local_code.template_options(
+        {
+          template_directory: '.github',
+          nested_directory_name: 'PULL_REQUEST_TEMPLATE',
+          non_nested_file_name: 'pull_request_template'
+        }
+      )
     end
 
     private def pr_id
-      @pr_id ||= cli.code_request_id('Pull')
+      @pr_id ||= cli.ask('Pull Request ID?')
     end
 
     private def merge_method
-      @merge_method ||= merge_options.length == 1 ? merge_options.first : cli.merge_method(merge_options)
+      @merge_method ||=
+        if merge_options.length == 1
+          merge_options.first
+        else
+          cli.ask_options('Merge method?', merge_options)
+        end
     end
 
     private def merge_options
       return @merge_options if @merge_options
+
       merge_options = []
       merge_options << 'merge' if existing_project.allow_merge_commit
       merge_options << 'squash' if existing_project.allow_squash_merge

data/lib/git_helper/setup.rb

@@ -0,0 +1,116 @@
+# frozen_string_literal: true
+
+module GitHelper
+  class Setup
+    def execute
+      execute_config_file
+      execute_plugins
+    end
+
+    private def execute_config_file
+      if config_file_exists?
+        answer = highline.ask_yes_no(
+          "It looks like the #{config_file} file already exists. Do you wish to replace it? (y/n)"
+        )
+        puts
+      else
+        answer = true
+      end
+
+      create_or_update_config_file if answer
+    end
+
+    private def execute_plugins
+      answer = highline.ask_yes_no(
+        'Do you wish to set up the Git Helper plugins? (y/n) (This process will ' \
+        'attempt to use your GitHub personal access token to authenticate)'
+      )
+
+      return unless answer
+
+      create_or_update_plugin_files
+      puts "\nNow add this line to your ~/.bash_profile:\n" \
+            '  export PATH=/path/to/computer/home/.git_helper/plugins:$PATH'
+      puts "\nDone!"
+    end
+
+    private def create_or_update_config_file
+      contents = generate_file_contents
+      puts "\nCreating or updating your #{config_file} file..."
+      File.open(config_file, 'w') { |file| file.puts contents }
+      puts "\nDone!\n\n"
+    end
+
+    private def config_file_exists?
+      File.exist?(config_file)
+    end
+
+    # rubocop:disable Metrics/MethodLength
+    private def generate_file_contents
+      file_contents = ''.dup
+
+      if highline.ask_yes_no('Do you wish to set up GitHub credentials? (y/n)')
+        file_contents << ":github_user:  #{ask_question('GitHub username?')}\n"
+        file_contents << ':github_token: ' \
+          "#{ask_question('GitHub personal access token? (Navigate to https://github.com/settings/tokens ' \
+          'to create a new personal access token)')}\n"
+      end
+
+      if highline.ask_yes_no("\nDo you wish to set up GitLab credentials? (y/n)")
+        file_contents << ":gitlab_user:  #{ask_question('GitLab username?')}\n"
+        file_contents << ':gitlab_token: ' \
+          "#{ask_question(
+            'GitLab personal access token? (Navigate to https://gitlab.com/-/profile/personal_access_tokens' \
+            ' to create a new personal access token)'
+          )}\n"
+      end
+
+      file_contents.strip
+    end
+    # rubocop:enable Metrics/MethodLength
+
+    private def ask_question(prompt)
+      answer = highline.ask("\n#{prompt}")
+
+      if answer.empty?
+        puts "\nThis question is required."
+        ask_question(prompt)
+      else
+        answer
+      end
+    end
+
+    # rubocop:disable Metrics/MethodLength
+    # rubocop:disable Metrics/AbcSize
+    private def create_or_update_plugin_files
+      plugins_dir = "#{Dir.pwd.scan(%r{\A/\w*/\w*/}).first}.git_helper/plugins"
+      plugins_url = 'https://api.github.com/repos/emmahsax/git_helper/contents/plugins'
+      header = 'Accept: application/vnd.github.v3.raw'
+      token = git_config_reader.github_token
+      user = git_config_reader.github_user
+
+      Dir.mkdir(plugins_dir) unless File.exist?(plugins_dir)
+
+      all_plugins = JSON.parse(`curl -s -u #{user}:#{token} -H "#{header}" -L "#{plugins_url}"`)
+
+      all_plugins.each do |plugin|
+        plugin_content = `curl -s -u #{user}:#{token} -H "#{header}" -L "#{plugins_url}/#{plugin['name']}"`
+        File.open("#{plugins_dir}/#{plugin['name']}", 'w') { |file| file.puts plugin_content }
+      end
+    end
+    # rubocop:enable Metrics/MethodLength
+    # rubocop:enable Metrics/AbcSize
+
+    private def config_file
+      git_config_reader.git_config_file_path
+    end
+
+    private def git_config_reader
+      @git_config_reader ||= GitHelper::GitConfigReader.new
+    end
+
+    private def highline
+      @highline ||= GitHelper::HighlineCli.new
+    end
+  end
+end

data/lib/git_helper/version.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module GitHelper
-  VERSION = '3.2.0'
+  VERSION = '3.3.2'
 end

data/spec/git_helper/change_remote_spec.rb

@@ -1,24 +1,25 @@
+# frozen_string_literal: true
+
 require 'spec_helper'
 require 'git_helper'
 
 describe GitHelper::ChangeRemote do
   let(:remote1) { "git@github.com:#{old_owner}/#{project}.git" }
   let(:project) { Faker::Lorem.word }
-  let(:cli) { double(:highline_cli, process_directory_remotes?: true) }
+  let(:cli) { double(:highline_cli, ask_yes_no: true) }
   let(:old_owner) { Faker::Internet.username }
   let(:new_owner) { Faker::Internet.username }
-  let(:directory_entries) { [ '.', '..', project, Faker::Lorem.word, Faker::Lorem.word ] }
+  let(:directory_entries) { ['.', '..', project, Faker::Lorem.word, Faker::Lorem.word] }
 
   let(:local_code) do
     double(:local_code,
-      remotes: [remote1],
-      remote_name: Faker::Lorem.word,
-      ssh_remote?: true,
-      https_remote?: false,
-      remote_project: project,
-      remote_source: 'github.com',
-      change_remote: true
-    )
+           remotes: [remote1],
+           remote_name: Faker::Lorem.word,
+           ssh_remote?: true,
+           https_remote?: false,
+           remote_project: project,
+           remote_source: 'github.com',
+           change_remote: true)
   end
 
   subject { GitHelper::ChangeRemote.new(old_owner, new_owner) }
@@ -73,7 +74,7 @@ describe GitHelper::ChangeRemote do
     end
 
     context 'when the user says not to process the directory' do
-      let(:cli) { double(:highline_cli, process_directory_remotes?: false) }
+      let(:cli) { double(:highline_cli, ask_yes_no: false) }
 
       it 'should not call to process the directory' do
         expect(subject).not_to receive(:process_git_repository)
@@ -138,14 +139,13 @@ describe GitHelper::ChangeRemote do
     context 'https remote' do
       let(:local_code) do
         double(:local_code,
-          remotes: [remote1],
-          remote_name: Faker::Lorem.word,
-          ssh_remote?: false,
-          https_remote?: false,
-          remote_project: project,
-          remote_source: 'github.com',
-          change_remote: true
-        )
+               remotes: [remote1],
+               remote_name: Faker::Lorem.word,
+               ssh_remote?: false,
+               https_remote?: false,
+               remote_project: project,
+               remote_source: 'github.com',
+               change_remote: true)
       end
 
       it 'should ask if the remote is SSH' do

data/spec/git_helper/checkout_default_spec.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'spec_helper'
 require 'git_helper'
 

data/spec/git_helper/clean_branches_spec.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'spec_helper'
 require 'git_helper'
 

data/spec/git_helper/code_request_spec.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'spec_helper'
 require 'git_helper'
 
@@ -101,19 +103,19 @@ describe GitHelper::CodeRequest do
 
   describe '#ask_for_clarification' do
     it 'should ask the CLI' do
-      expect(highline_cli).to receive(:conflicting_remote_clarification).and_return('github')
+      expect(highline_cli).to receive(:ask).and_return('github')
       subject.send(:ask_for_clarification)
     end
 
     context 'when response is github' do
       it 'should return github_pull_request' do
-        allow(highline_cli).to receive(:conflicting_remote_clarification).and_return('github')
+        allow(highline_cli).to receive(:ask).and_return('github')
         expect(subject).to receive(:github_pull_request)
         subject.send(:ask_for_clarification)
       end
 
       it 'should return github_pull_request' do
-        allow(highline_cli).to receive(:conflicting_remote_clarification).and_return('Github')
+        allow(highline_cli).to receive(:ask).and_return('Github')
         expect(subject).to receive(:github_pull_request)
         subject.send(:ask_for_clarification)
       end
@@ -121,21 +123,22 @@ describe GitHelper::CodeRequest do
 
     context 'when response is gitlab' do
       it 'should return gitlab_merge_request' do
-        allow(highline_cli).to receive(:conflicting_remote_clarification).and_return('gitlab')
+        allow(highline_cli).to receive(:ask).and_return('gitlab')
         expect(subject).to receive(:gitlab_merge_request)
         subject.send(:ask_for_clarification)
       end
 
       it 'should return gitlab_merge_request' do
-        allow(highline_cli).to receive(:conflicting_remote_clarification).and_return('Gitlab')
+        allow(highline_cli).to receive(:ask).and_return('Gitlab')
         expect(subject).to receive(:gitlab_merge_request)
         subject.send(:ask_for_clarification)
       end
     end
 
+    # Unfortunately this test sometimes fails... just rerun the tests if it does
     context 'when response is neither' do
       it 'should raise an error' do
-        allow(highline_cli).to receive(:conflicting_remote_clarification).and_return(Faker::Lorem.word)
+        allow(highline_cli).to receive(:ask).and_return(Faker::Lorem.word)
         expect(subject).to receive(:exit)
         subject.send(:ask_for_clarification)
       end
@@ -173,23 +176,23 @@ describe GitHelper::CodeRequest do
   describe '#base_branch' do
     it 'should call the default branch' do
       expect(subject).to receive(:default_branch)
-      allow(highline_cli).to receive(:base_branch_default?).at_least(:once)
-      allow(highline_cli).to receive(:base_branch).at_least(:once).and_return(base_branch)
+      allow(highline_cli).to receive(:ask_yes_no).at_least(:once)
+      allow(highline_cli).to receive(:ask).at_least(:once).and_return(base_branch)
       subject.send(:base_branch)
     end
 
     it 'should ask the CLI to ask the user' do
       allow(subject).to receive(:default_branch)
-      expect(highline_cli).to receive(:base_branch_default?).at_least(:once)
-      allow(highline_cli).to receive(:base_branch).at_least(:once).and_return(base_branch)
+      expect(highline_cli).to receive(:ask_yes_no).at_least(:once)
+      allow(highline_cli).to receive(:ask).at_least(:once).and_return(base_branch)
       subject.send(:base_branch)
     end
 
     context 'if the user says no' do
       it 'definitely asks for the users base branch' do
         allow(subject).to receive(:default_branch)
-        expect(highline_cli).to receive(:base_branch_default?).at_least(:once).and_return(false)
-        expect(highline_cli).to receive(:base_branch).at_least(:once).and_return(base_branch)
+        expect(highline_cli).to receive(:ask_yes_no).at_least(:once).and_return(false)
+        expect(highline_cli).to receive(:ask).at_least(:once).and_return(base_branch)
         subject.send(:base_branch)
       end
     end
@@ -197,7 +200,7 @@ describe GitHelper::CodeRequest do
     context 'if the user says yes' do
       it 'does not ask for the users base branch' do
         allow(subject).to receive(:default_branch)
-        expect(highline_cli).to receive(:base_branch_default?).at_least(:once).and_return(true)
+        expect(highline_cli).to receive(:ask_yes_no).at_least(:once).and_return(true)
         expect(highline_cli).not_to receive(:base_branch)
         subject.send(:base_branch)
       end
@@ -215,32 +218,32 @@ describe GitHelper::CodeRequest do
   describe '#new_code_request_title' do
     it 'should call autogenerated title method' do
       expect(subject).to receive(:autogenerated_title)
-      allow(highline_cli).to receive(:accept_autogenerated_title?).at_least(:once)
-      allow(highline_cli).to receive(:title).at_least(:once).and_return(title)
+      allow(highline_cli).to receive(:ask_yes_no).at_least(:once)
+      allow(highline_cli).to receive(:ask).at_least(:once).and_return(title)
       subject.send(:new_code_request_title)
     end
 
     it 'should ask the CLI to ask the user' do
-      allow(subject).to receive(:autogenerated_title)
-      expect(highline_cli).to receive(:accept_autogenerated_title?).at_least(:once)
-      allow(highline_cli).to receive(:title).at_least(:once).and_return(title)
+      allow(subject).to receive(:autogenerated_title).and_return(Faker::Lorem.sentence)
+      expect(highline_cli).to receive(:ask_yes_no).at_least(:once)
+      allow(highline_cli).to receive(:ask).at_least(:once).and_return(title)
       subject.send(:new_code_request_title)
     end
 
     context 'if the user says no' do
       it 'definitely asks for the users title' do
-        allow(subject).to receive(:autogenerated_title)
-        expect(highline_cli).to receive(:accept_autogenerated_title?).at_least(:once).and_return(false)
-        expect(highline_cli).to receive(:title).at_least(:once).and_return(title)
+        allow(subject).to receive(:autogenerated_title).and_return(Faker::Lorem.sentence)
+        expect(highline_cli).to receive(:ask_yes_no).at_least(:once).and_return(false)
+        expect(highline_cli).to receive(:ask).at_least(:once).and_return(title)
         subject.send(:new_code_request_title)
       end
     end
 
     context 'if the user says yes to original title' do
       it 'does not ask for the users chosen title' do
-        allow(subject).to receive(:autogenerated_title)
-        expect(highline_cli).to receive(:accept_autogenerated_title?).at_least(:once).and_return(true)
-        expect(highline_cli).not_to receive(:title)
+        allow(subject).to receive(:autogenerated_title).and_return(Faker::Lorem.sentence)
+        expect(highline_cli).to receive(:ask_yes_no).at_least(:once).and_return(true)
+        expect(highline_cli).not_to receive(:ask)
         subject.send(:new_code_request_title)
       end
     end