git_helper 3.3.1 → 3.3.6

data/lib/git_helper/empty_commit.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module GitHelper
   class EmptyCommit
     def execute

data/lib/git_helper/forget_local_commits.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module GitHelper
   class ForgetLocalCommits
     def execute

data/lib/git_helper/git_config_reader.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module GitHelper
   class GitConfigReader
     def gitlab_token
@@ -17,15 +19,11 @@ module GitHelper
     end
 
     def git_config_file_path
-      Dir.pwd.scan(/\A\/[\w]*\/[\w]*\//).first << git_config_file
+      "#{Dir.pwd.scan(%r{\A/\w*/\w*/}).first}.git_helper/config.yml"
     end
 
     private def config_file
       YAML.load_file(git_config_file_path)
     end
-
-    private def git_config_file
-      '.git_helper/config.yml'
-    end
   end
 end

data/lib/git_helper/gitlab_client.rb

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

data/lib/git_helper/local_code.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module GitHelper
   class LocalCode
     def checkout_default
@@ -44,20 +46,20 @@ module GitHelper
     end
 
     def https_remote?(remote)
-      remote.scan(/(https:\/\/)/).any?
+      remote.scan(%r{(https://)}).any?
     end
 
     def remote_project(remote)
       if https_remote?(remote)
-        remote.scan(/https:\/\/[\S]+\/([\S]*).git/).first.first
+        remote.scan(%r{https://\S+/(\S*).git}).first.first
       elsif ssh_remote?(remote)
-        remote.scan(/\/([\S]*).git/).first.first
+        remote.scan(%r{/(\S*).git}).first.first
       end
     end
 
     def remote_source(remote)
       if https_remote?(remote)
-        remote.scan(/https:\/\/([a-zA-z.]+)\//).first.first
+        remote.scan(%r{https://([a-zA-z.]+)/}).first.first
       elsif ssh_remote?(remote)
         remote.scan(/git@([a-zA-z.]+):/).first.first
       end
@@ -73,18 +75,20 @@ module GitHelper
 
     def project_name
       # Get the repo/project name by looking in the remote URLs for the full name
-      `git remote -v`.scan(/\S[\s]*[\S]+.com[\S]{1}([\S]*).git/).first.first
+      `git remote -v`.scan(/\S\s*\S+.com\S{1}(\S*).git/).first.first
     end
 
     def branch
       # Get the current branch by looking in the list of branches for the *
-      `git branch`.scan(/\*\s([\S]*)/).first.first
+      `git branch`.scan(/\*\s(\S*)/).first.first
     end
 
     def default_branch
       `git symbolic-ref refs/remotes/origin/HEAD | sed "s@^refs/remotes/origin/@@" | tr -d "\n"`
     end
 
+    # rubocop:disable Metrics/AbcSize
+    # rubocop:disable Metrics/MethodLength
     def template_options(identifiers)
       nested_templates = Dir.glob(
         File.join("#{identifiers[:template_directory]}/#{identifiers[:nested_directory_name]}", '*.md'),
@@ -100,11 +104,15 @@ module GitHelper
       )
       nested_templates.concat(non_nested_templates).concat(root_templates).uniq
     end
+    # rubocop:enable Metrics/MethodLength
+    # rubocop:enable Metrics/AbcSize
 
     def read_template(file_name)
       File.open(file_name).read
     end
 
+    # rubocop:disable Metrics/AbcSize
+    # rubocop:disable Metrics/MethodLength
     def generate_title(local_branch)
       branch_arr = local_branch.split(local_branch.include?('_') ? '_' : '-')
 
@@ -112,11 +120,11 @@ module GitHelper
 
       if branch_arr.length == 1
         branch_arr.first.capitalize
-      elsif branch_arr[0].scan(/([\w]+)/).any? && branch_arr[1].scan(/([\d]+)/).any? # branch includes jira_123 at beginning
+      elsif branch_arr[0].scan(/(\w+)/).any? && branch_arr[1].scan(/(\d+)/).any? # branch includes jira_123 at beginning
         issue = "#{branch_arr[0].upcase}-#{branch_arr[1]}"
         description = branch_arr[2..-1].join(' ')
         "#{issue} #{description.capitalize}"
-      elsif branch_arr[0].scan(/([\w]+-[\d]+)/).any? # branch includes string jira-123 at beginning
+      elsif branch_arr[0].scan(/(\w+-\d+)/).any? # branch includes string jira-123 at beginning
         issue = branch_arr[0].upcase
         description = branch_arr[1..-1].join(' ')
         "#{issue} #{description.capitalize}"
@@ -124,5 +132,7 @@ module GitHelper
         branch_arr[0..-1].join(' ').capitalize
       end
     end
+    # rubocop:enable Metrics/MethodLength
+    # rubocop:enable Metrics/AbcSize
   end
 end

data/lib/git_helper/merge_request.rb

@@ -1,78 +1,84 @@
+# frozen_string_literal: true
+
 module GitHelper
   class GitLabMergeRequest
-    attr_accessor :local_project, :local_branch, :local_code, :cli, :base_branch, :new_mr_title
+    attr_accessor :local_project, :local_branch, :local_code, :highline, :base_branch, :new_mr_title
 
     def initialize(options)
       @local_project = options[:local_project]
       @local_branch = options[:local_branch]
       @local_code = options[:local_code]
-      @cli = options[:cli]
+      @highline = options[:highline]
     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,39 +86,53 @@ 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 = highline.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 = highline.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
-      @mr_id ||= cli.ask('Merge Request ID?')
+      @mr_id ||= highline.ask('Merge Request ID?')
     end
 
     private def squash_merge_request
-      @squash_merge_request ||= cli.ask_yes_no('Squash merge request? (y/n)')
+      @squash_merge_request ||= highline.ask_yes_no('Squash merge request? (y/n)')
     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 || highline.ask_yes_no(
+          'Remove source branch after merging? (y/n)'
+        )
     end
 
     private def existing_project

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.ask('New branch name?')
+      branch_name = new_branch_name || HighlineWrapper.new.ask('New branch name?', { required: true })
       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,75 +1,89 @@
+# frozen_string_literal: true
+
 module GitHelper
   class GitHubPullRequest
-    attr_accessor :local_repo, :local_branch, :local_code, :cli, :base_branch, :new_pr_title
+    attr_accessor :local_repo, :local_branch, :local_code, :highline, :base_branch, :new_pr_title
 
     def initialize(options)
       @local_repo = options[:local_project]
       @local_branch = options[:local_branch]
       @local_code = options[:local_code]
-      @cli = options[:cli]
+      @highline = options[:highline]
     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.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 = highline.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 = highline.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.ask('Pull Request ID?')
+      @pr_id ||= highline.ask('Pull Request ID?')
     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
+          highline.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