git_helper 3.3.1 → 3.3.2

data/lib/git_helper/merge_request.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module GitHelper
   class GitLabMergeRequest
     attr_accessor :local_project, :local_branch, :local_code, :cli, :base_branch, :new_mr_title
@@ -9,70 +11,74 @@ module GitHelper
       @cli = options[:cli]
     end
 
+    # rubocop:disable Metrics/MethodLength
+    # rubocop:disable Metrics/AbcSize
     def create(options)
       @base_branch = options[:base_branch]
       @new_mr_title = options[:new_title]
 
-      begin
-        options = {
-          source_branch: local_branch,
-          target_branch: base_branch,
-          squash: squash_merge_request,
-          remove_source_branch: remove_source_branch,
-          description: new_mr_body
-        }
-
-        puts "Creating merge request: #{new_mr_title}"
-        mr = gitlab_client.create_merge_request(local_project, new_mr_title, options)
-
-        if mr.diff_refs.base_sha == mr.diff_refs.head_sha
-          puts "Merge request was created, but no commits have been pushed to GitLab: #{mr.web_url}"
-        else
-          puts "Merge request successfully created: #{mr.web_url}"
-        end
-      rescue Gitlab::Error::Conflict => e
-        puts 'Could not create merge request:'
-        puts '  A merge request already exists for this branch'
-      rescue Exception => e
-        puts 'Could not create merge request:'
-        puts e.message
+      options = {
+        source_branch: local_branch,
+        target_branch: base_branch,
+        squash: squash_merge_request,
+        remove_source_branch: remove_source_branch,
+        description: new_mr_body
+      }
+
+      puts "Creating merge request: #{new_mr_title}"
+      mr = gitlab_client.create_merge_request(local_project, new_mr_title, options)
+
+      if mr.diff_refs.base_sha == mr.diff_refs.head_sha
+        puts "Merge request was created, but no commits have been pushed to GitLab: #{mr.web_url}"
+      else
+        puts "Merge request successfully created: #{mr.web_url}"
       end
+    rescue Gitlab::Error::Conflict
+      puts 'Could not create merge request:'
+      puts '  A merge request already exists for this branch'
+    rescue StandardError => e
+      puts 'Could not create merge request:'
+      puts e.message
     end
+    # rubocop:enable Metrics/AbcSize
+    # rubocop:enable Metrics/MethodLength
 
+    # rubocop:disable Metrics/MethodLength
+    # rubocop:disable Metrics/AbcSize
     def merge
-      begin
-        mr_id
-        options = {
-          should_remove_source_branch: existing_mr.should_remove_source_branch || existing_mr.force_remove_source_branch,
-          squash: existing_mr.squash,
-          squash_commit_message: existing_mr.title
-        }
-
-        puts "Merging merge request: #{mr_id}"
+      mr_id
+      options = {
+        should_remove_source_branch: existing_mr.should_remove_source_branch || existing_mr.force_remove_source_branch,
+        squash: existing_mr.squash,
+        squash_commit_message: existing_mr.title
+      }
+
+      puts "Merging merge request: #{mr_id}"
+      merge = gitlab_client.accept_merge_request(local_project, mr_id, options)
+
+      if merge.merge_commit_sha.nil?
+        options[:squash] = true
         merge = gitlab_client.accept_merge_request(local_project, mr_id, options)
+      end
 
-        if merge.merge_commit_sha.nil?
-          options[:squash] = true
-          merge = gitlab_client.accept_merge_request(local_project, mr_id, options)
-        end
-
-        if merge.merge_commit_sha.nil?
-          puts 'Could not merge merge request:'
-          puts "  #{merge.merge_error}"
-        else
-          puts "Merge request successfully merged: #{merge.merge_commit_sha}"
-        end
-      rescue Gitlab::Error::MethodNotAllowed => e
-        puts 'Could not merge merge request:'
-        puts '  The merge request is not mergeable'
-      rescue Gitlab::Error::NotFound => e
+      if merge.merge_commit_sha.nil?
         puts 'Could not merge merge request:'
-        puts "  Could not a locate a merge request to merge with ID #{mr_id}"
-      rescue Exception => e
-        puts 'Could not merge merge request:'
-        puts e.message
+        puts "  #{merge.merge_error}"
+      else
+        puts "Merge request successfully merged: #{merge.merge_commit_sha}"
       end
+    rescue Gitlab::Error::MethodNotAllowed
+      puts 'Could not merge merge request:'
+      puts '  The merge request is not mergeable'
+    rescue Gitlab::Error::NotFound
+      puts 'Could not merge merge request:'
+      puts "  Could not a locate a merge request to merge with ID #{mr_id}"
+    rescue StandardError => e
+      puts 'Could not merge merge request:'
+      puts e.message
     end
+    # rubocop:enable Metrics/AbcSize
+    # rubocop:enable Metrics/MethodLength
 
     private def new_mr_body
       @new_mr_body ||= template_name_to_apply ? local_code.read_template(template_name_to_apply) : ''
@@ -80,27 +86,38 @@ module GitHelper
 
     private def template_name_to_apply
       return @template_name_to_apply if @template_name_to_apply
+
       @template_name_to_apply = nil
 
-      unless mr_template_options.empty?
-        if mr_template_options.count == 1
-          apply_single_template = cli.ask_yes_no("Apply the merge request template from #{mr_template_options.first}? (y/n)")
-          @template_name_to_apply = mr_template_options.first if apply_single_template
-        else
-          response = cli.ask_options("Which merge request template should be applied?", mr_template_options << 'None')
-          @template_name_to_apply = response unless response == 'None'
-        end
-      end
+      determine_template unless mr_template_options.empty?
 
       @template_name_to_apply
     end
 
+    # rubocop:disable Metrics/MethodLength
+    private def determine_template
+      if mr_template_options.count == 1
+        apply_single_template = cli.ask_yes_no(
+          "Apply the merge request template from #{mr_template_options.first}? (y/n)"
+        )
+        @template_name_to_apply = mr_template_options.first if apply_single_template
+      else
+        response = cli.ask_options(
+          'Which merge request template should be applied?', mr_template_options << 'None'
+        )
+        @template_name_to_apply = response unless response == 'None'
+      end
+    end
+    # rubocop:enable Metrics/MethodLength
+
     private def mr_template_options
-      @mr_template_options ||= local_code.template_options({
-                                 template_directory: '.gitlab',
-                                 nested_directory_name: 'merge_request_templates',
-                                 non_nested_file_name: 'merge_request_template'
-                               })
+      @mr_template_options ||= local_code.template_options(
+        {
+          template_directory: '.gitlab',
+          nested_directory_name: 'merge_request_templates',
+          non_nested_file_name: 'merge_request_template'
+        }
+      )
     end
 
     private def mr_id
@@ -112,7 +129,10 @@ module GitHelper
     end
 
     private def remove_source_branch
-      @remove_source_branch ||= existing_project.remove_source_branch_after_merge || cli.ask_yes_no('Remove source branch after merging? (y/n)')
+      @remove_source_branch ||=
+        existing_project.remove_source_branch_after_merge || cli.ask_yes_no(
+          'Remove source branch after merging? (y/n)'
+        )
     end
 
     private def existing_project

data/lib/git_helper/new_branch.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module GitHelper
   class NewBranch
     def execute(new_branch_name = nil)

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,27 +91,38 @@ 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.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
+      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
@@ -105,11 +130,17 @@ module GitHelper
     end
 
     private def merge_method
-      @merge_method ||= merge_options.length == 1 ? merge_options.first : cli.ask_options('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

@@ -1,25 +1,37 @@
+# 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)")
+        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)"
+        '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)'
       )
 
-      if 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
+      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
@@ -30,28 +42,32 @@ module GitHelper
     end
 
     private def config_file_exists?
-      File.exists?(config_file)
+      File.exist?(config_file)
     end
 
+    # rubocop:disable Metrics/MethodLength
     private def generate_file_contents
-      file_contents = ''
+      file_contents = ''.dup
 
-      if highline.ask_yes_no("Do you wish to set up GitHub credentials? (y/n)")
+      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: " \
+        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"
+        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}")
@@ -64,14 +80,16 @@ module GitHelper
       end
     end
 
+    # rubocop:disable Metrics/MethodLength
+    # rubocop:disable Metrics/AbcSize
     private def create_or_update_plugin_files
-      plugins_dir = "#{Dir.pwd.scan(/\A\/[\w]*\/[\w]*\//).first}/.git_helper/plugins"
+      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.exists?(plugins_dir)
+      Dir.mkdir(plugins_dir) unless File.exist?(plugins_dir)
 
       all_plugins = JSON.parse(`curl -s -u #{user}:#{token} -H "#{header}" -L "#{plugins_url}"`)
 
@@ -80,6 +98,8 @@ module GitHelper
         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