git_helper 3.3.0 → 3.6.6

data/lib/git_helper/code_request.rb

@@ -1,10 +1,14 @@
+# frozen_string_literal: true
+
 module GitHelper
   class CodeRequest
     def create
-      process_project.create({
-        base_branch: base_branch,
-        new_title: new_code_request_title
-      })
+      process_project.create(
+        {
+          base_branch: base_branch,
+          new_title: new_code_request_title
+        }
+      )
     end
 
     def merge
@@ -23,8 +27,14 @@ module GitHelper
       end
     end
 
+    # rubocop:disable Metrics/MethodLength
     private def ask_for_clarification
-      resp = cli.ask('Found git remotes for both GitHub and GitLab. Would you like to proceed with GitLab or GitHub? (github/gitlab)').downcase
+      resp = highline.ask(
+        'Found git remotes for both GitHub and GitLab. Would you like to proceed ' \
+        'with GitLab or GitHub? (github/gitlab)',
+        { required: true }
+      ).downcase
+
       if resp.include?('hub')
         github_pull_request
       elsif resp.include?('lab')
@@ -34,6 +44,7 @@ module GitHelper
         exit
       end
     end
+    # rubocop:enable Metrics/MethodLength
 
     private def github_pull_request
       @github_pull_request ||= GitHelper::GitHubPullRequest.new(options)
@@ -48,7 +59,7 @@ module GitHelper
         local_project: local_project,
         local_branch: local_branch,
         local_code: local_code,
-        cli: cli
+        highline: highline
       }
     end
 
@@ -61,11 +72,12 @@ module GitHelper
     end
 
     private def base_branch
-      @base_branch ||= if cli.ask_yes_no("Is '#{default_branch}' the correct base branch for your new code request? (y/n)")
-                         default_branch
-                       else
-                         cli.ask('Base branch?')
-                       end
+      @base_branch ||=
+        if highline.ask_yes_no("Is '#{default_branch}' the correct base branch for your new code request? (Y/n)")
+          default_branch
+        else
+          highline.ask('Base branch?', { required: true })
+        end
     end
 
     private def local_branch
@@ -77,16 +89,18 @@ module GitHelper
     end
 
     private def new_code_request_title
-      @new_code_request_title ||= if autogenerated_title &&
-                                     cli.ask_yes_no("Accept the autogenerated code request title '#{autogenerated_title}'? (y/n)")
-                                    autogenerated_title
-                                  else
-                                    cli.ask('Title?')
-                                  end
+      @new_code_request_title ||=
+        if autogenerated_title && highline.ask_yes_no(
+          "Accept the autogenerated code request title '#{autogenerated_title}'? (Y/n)"
+        )
+          autogenerated_title
+        else
+          highline.ask('Title?', { required: true })
+        end
     end
 
-    private def cli
-      @cli ||= GitHelper::HighlineCli.new
+    private def highline
+      @highline ||= HighlineWrapper.new
     end
 
     private def local_code

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,23 +1,29 @@
+# frozen_string_literal: true
+
 module GitHelper
   class GitConfigReader
     def gitlab_token
       config_file[:gitlab_token]
     end
 
+    def gitlab_user
+      config_file[:gitlab_user]
+    end
+
     def github_token
       config_file[:github_token]
     end
 
+    def github_user
+      config_file[:github_user]
+    end
+
     def git_config_file_path
-      Dir.pwd.scan(/\A\/[\w]*\/[\w]*\//).first << git_config_file
+      "#{Dir.home}/.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/github_client.rb

@@ -0,0 +1,70 @@
+# frozen_string_literal: true
+
+module GitHelper
+  class GitHubClient
+    def repository(repo_name)
+      run(repo_name.split('/').first, nil, "/repos/#{repo_name}")
+    end
+
+    def pull_request(repo_name, pull_request_id)
+      run(repo_name.split('/').first, nil, "/repos/#{repo_name}/pulls/#{pull_request_id}")
+    end
+
+    def create_pull_request(repo_name, options)
+      opts_as_string = format_options(options)
+      run(
+        repo_name.split('/').first,
+        'POST',
+        "/repos/#{repo_name}/pulls",
+        opts_as_string
+      )
+    end
+
+    def merge_pull_request(repo_name, pull_request_id, options)
+      opts_as_string = format_options(options)
+      run(
+        repo_name.split('/').first,
+        'PUT',
+        "/repos/#{repo_name}/pulls/#{pull_request_id}/merge",
+        opts_as_string
+      )
+    end
+
+    private def format_options(options)
+      opts_as_string = ''.dup
+      options.each do |key, value|
+        next if value == ''
+
+        opts_as_string << "#{key.to_json}:#{value.to_json.gsub("'", "'\\\\''")},"
+      end
+      opts_as_string = opts_as_string.reverse.sub(',', '').reverse
+      opts_as_string.empty? ? '' : "{#{opts_as_string}}"
+    end
+
+    # rubocop:disable Layout/LineLength
+    private def run(username, request_type, curl_url, options = '')
+      OpenStruct.new(
+        JSON.parse(
+          if request_type
+            `curl -s -u #{username}:#{github_token} -H "Accept: application/vnd.github.v3+json" -X #{request_type} -d '#{options}' "#{github_endpoint}#{curl_url}"`
+          else
+            `curl -s -u #{username}:#{github_token} -H "Accept: application/vnd.github.v3+json" "#{github_endpoint}#{curl_url}"`
+          end
+        )
+      )
+    end
+    # rubocop:enable Layout/LineLength
+
+    private def github_token
+      git_config_reader.github_token
+    end
+
+    private def git_config_reader
+      @git_config_reader ||= GitHelper::GitConfigReader.new
+    end
+
+    private def github_endpoint
+      'https://api.github.com'
+    end
+  end
+end

data/lib/git_helper/gitlab_client.rb

@@ -1,7 +1,53 @@
+# frozen_string_literal: true
+
 module GitHelper
   class GitLabClient
-    def client
-      Gitlab.client(endpoint: gitlab_endpoint, private_token: git_config_reader.gitlab_token)
+    def project(project_name)
+      run('GET', "/projects/#{url_encode(project_name)}")
+    end
+
+    def merge_request(project_name, merge_request_id)
+      run('GET', "/projects/#{url_encode(project_name)}/merge_requests/#{merge_request_id}")
+    end
+
+    def create_merge_request(project_name, options)
+      opts_as_string = format_options(options)
+      run('POST', "/projects/#{url_encode(project_name)}/merge_requests#{opts_as_string}")
+    end
+
+    def accept_merge_request(project_name, merge_request_id, options)
+      opts_as_string = format_options(options)
+      run(
+        'PUT',
+        "/projects/#{url_encode(project_name)}/merge_requests/#{merge_request_id}/merge#{opts_as_string}"
+      )
+    end
+
+    private def format_options(options)
+      opts_as_string = ''.dup
+      options.each do |key, value|
+        next if value == ''
+
+        opts_as_string << "#{key}=#{url_encode(value.to_s)}&"
+      end
+      opts_as_string = opts_as_string.reverse.sub('&', '').reverse
+      opts_as_string.empty? ? '' : "?#{opts_as_string}"
+    end
+
+    private def run(request_type, curl_url)
+      OpenStruct.new(
+        JSON.parse(
+          `curl -s -X #{request_type} -H "PRIVATE-TOKEN: #{gitlab_token}" "#{gitlab_endpoint}#{curl_url}"`
+        )
+      )
+    end
+
+    private def url_encode(string)
+      string.b.gsub(/[^a-zA-Z0-9_\-.~]/n) { |m| format('%%%<val>02X', val: m.unpack1('C')) }
+    end
+
+    private def gitlab_token
+      git_config_reader.gitlab_token
     end
 
     private def git_config_reader

data/lib/git_helper/local_code.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module GitHelper
   class LocalCode
     def checkout_default
@@ -44,47 +46,49 @@ 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
     end
 
     def github_repo?
-      remotes.select { |remote| remote.include?('github') }.any?
+      remotes.any? { |remote| remote.include?('github') }
     end
 
     def gitlab_project?
-      remotes.select { |remote| remote.include?('gitlab') }.any?
+      remotes.any? { |remote| remote.include?('gitlab') }
     end
 
     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
+      File.read(file_name)
     end
 
+    # rubocop:disable Metrics/AbcSize
+    # rubocop:disable Metrics/MethodLength
     def generate_title(local_branch)
       branch_arr = local_branch.split(local_branch.include?('_') ? '_' : '-')
 
@@ -112,17 +120,19 @@ 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(' ')
+        description = branch_arr[2..].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(' ')
+        description = branch_arr[1..].join(' ')
         "#{issue} #{description.capitalize}"
       else # plain words
-        branch_arr[0..-1].join(' ').capitalize
+        branch_arr[0..].join(' ').capitalize
       end
     end
+    # rubocop:enable Metrics/MethodLength
+    # rubocop:enable Metrics/AbcSize
   end
 end

data/lib/git_helper/merge_request.rb

@@ -1,78 +1,82 @@
+# 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,
+        title: new_mr_title
+      }
+
+      puts "Creating merge request: #{new_mr_title}"
+      mr = gitlab_client.create_merge_request(local_project, options)
+
+      if mr.web_url && mr.diff_refs && (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}"
+      elsif mr.web_url
+        puts "Merge request successfully created: #{mr.web_url}"
+      else
+        raise StandardError, (mr.message.instance_of?(Array) ? mr.message.first : mr.message)
       end
+    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
+      raise StandardError, merge.message if merge.merge_commit_sha.nil?
 
-        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 "Merge request successfully merged: #{merge.merge_commit_sha}"
+    rescue StandardError => e
+      puts 'Could not merge merge request:'
+
+      if e.message.include?('404 Not found')
+        puts '  Could not a locate a merge request to merge with given ID'
+      elsif e.message.include?('405 Method Not Allowed')
         puts '  The merge request is not mergeable'
-      rescue Gitlab::Error::NotFound => e
-        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
+      else
+        puts "  #{e.message}"
       end
     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 +84,63 @@ 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?', { required: true })
     end
 
     private def squash_merge_request
-      @squash_merge_request ||= cli.ask_yes_no('Squash merge request? (y/n)')
+      return @squash_merge_request if @squash_merge_request
+
+      @squash_merge_request =
+        case existing_project.squash_option
+        when 'always', 'default_on'
+          true
+        when 'never'
+          false
+        else # 'default_off' or anything else
+          highline.ask_yes_no('Squash merge request? (Y/n)')
+        end
     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
@@ -124,7 +152,7 @@ module GitHelper
     end
 
     private def gitlab_client
-      @gitlab_client ||= GitHelper::GitLabClient.new.client
+      @gitlab_client ||= GitHelper::GitLabClient.new
     end
   end
 end

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