git_helper 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 155df8ff3253824dd7a7ba9b8e1c68862bd84c02985b56cc5aae3e4a8111bf02
+  data.tar.gz: ec4aacae883bf8655dbb8382c738180cf29d150a67f674c6d8b3ed02dea76335
+SHA512:
+  metadata.gz: 42382a1b731fbcc6a601a733158deb41c38af92141d438148330736c5be2d5934f5283524fec215e41c61375a1d0fef341a318dce2c925c42e857c5d4950b3fc
+  data.tar.gz: 7307415e608846cd7f55bae4540fff9a322e19bb6813c1cbd22291370cb7432ba44105b393cbd7f32614ccbf9f8821534aea9d6f99ec8048de7a917dd6767cc2

data/Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+
+gemspec

data/Gemfile.lock

@@ -0,0 +1,97 @@
+PATH
+  remote: .
+  specs:
+    git_helper (1.0.0)
+      gitlab (~> 4.16)
+      gli (~> 2.13)
+      highline (~> 2.0)
+      octokit (~> 4.18)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    addressable (2.7.0)
+      public_suffix (>= 2.0.2, < 5.0)
+    coderay (1.1.3)
+    diff-lcs (1.4.4)
+    faraday (1.0.1)
+      multipart-post (>= 1.2, < 3)
+    ffi (1.13.1)
+    formatador (0.2.5)
+    gitlab (4.16.1)
+      httparty (~> 0.14, >= 0.14.0)
+      terminal-table (~> 1.5, >= 1.5.1)
+    gli (2.19.2)
+    guard (2.16.2)
+      formatador (>= 0.2.4)
+      listen (>= 2.7, < 4.0)
+      lumberjack (>= 1.0.12, < 2.0)
+      nenv (~> 0.1)
+      notiffany (~> 0.0)
+      pry (>= 0.9.12)
+      shellany (~> 0.0)
+      thor (>= 0.18.1)
+    guard-compat (1.2.1)
+    guard-rspec (4.7.3)
+      guard (~> 2.1)
+      guard-compat (~> 1.1)
+      rspec (>= 2.99.0, < 4.0)
+    highline (2.0.3)
+    httparty (0.18.1)
+      mime-types (~> 3.0)
+      multi_xml (>= 0.5.2)
+    listen (3.2.1)
+      rb-fsevent (~> 0.10, >= 0.10.3)
+      rb-inotify (~> 0.9, >= 0.9.10)
+    lumberjack (1.2.8)
+    method_source (1.0.0)
+    mime-types (3.3.1)
+      mime-types-data (~> 3.2015)
+    mime-types-data (3.2020.0512)
+    multi_xml (0.6.0)
+    multipart-post (2.1.1)
+    nenv (0.3.0)
+    notiffany (0.1.3)
+      nenv (~> 0.1)
+      shellany (~> 0.0)
+    octokit (4.18.0)
+      faraday (>= 0.9)
+      sawyer (~> 0.8.0, >= 0.5.3)
+    pry (0.13.1)
+      coderay (~> 1.1)
+      method_source (~> 1.0)
+    public_suffix (4.0.6)
+    rake (10.5.0)
+    rb-fsevent (0.10.4)
+    rb-inotify (0.10.1)
+      ffi (~> 1.0)
+    rspec (2.99.0)
+      rspec-core (~> 2.99.0)
+      rspec-expectations (~> 2.99.0)
+      rspec-mocks (~> 2.99.0)
+    rspec-core (2.99.2)
+    rspec-expectations (2.99.2)
+      diff-lcs (>= 1.1.3, < 2.0)
+    rspec-mocks (2.99.4)
+    sawyer (0.8.2)
+      addressable (>= 2.3.5)
+      faraday (> 0.8, < 2.0)
+    shellany (0.0.1)
+    terminal-table (1.8.0)
+      unicode-display_width (~> 1.1, >= 1.1.1)
+    thor (1.0.1)
+    unicode-display_width (1.7.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 2.1)
+  git_helper!
+  guard (~> 2.6)
+  guard-rspec (~> 4.3)
+  rake (~> 10.1)
+  rspec (~> 2.99)
+
+BUNDLED WITH
+   2.1.4

data/Guardfile

@@ -0,0 +1,5 @@
+guard :rspec, cmd: 'bundle exec rspec', all_on_start: true, all_after_pass: true  do
+  watch(%r{^spec/.+_spec\.rb$})
+  watch(%r{^lib/(.+)\.rb$})     { |m| "spec/lib/#{m[1]}_spec.rb" }
+  watch('spec/spec_helper.rb')  { "spec" }
+end

data/LICENSE

@@ -0,0 +1,22 @@
+The MIT License (MIT)
+
+Copyright 2020 Emma Sax
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,124 @@
+# git_helper [![Maintainability](https://api.codeclimate.com/v1/badges/ce1bdd719cc21b7c22a6/maintainability)](https://codeclimate.com/github/emmasax4/git_helper/maintainability)
+
+## Usage
+
+```bash
+gem install git_helper
+```
+
+Some of the commands in this gem can be used without any additional configuration. However, others utilize special GitHub or GitLab configuration. To provide access tokens for this, create a `~/.git_config.yml` file. The contents should look like this:
+
+```
+:github_user: GITHUB-USERNAME
+:github_token: GITHUB-TOKEN
+:gitlab_user: GITLAB-USERNAME
+:gitlab_token: GITLAB-TOKEN
+```
+
+To view the help screen, run:
+```bash
+ghelper --help
+```
+
+To see what version of git_helper you're running, run:
+```bash
+ghelper --version
+```
+
+## Commands
+
+### `change-remote`
+
+This can be used when switching the owners of a GitHub repo. When you switch a username, GitHub only makes some changes for you. With this command, you no longer have to manually walk through local repo and switch the remotes from each one into a remote with the new username.
+
+This command will go through every directory in a directory, see if it is a git directory, and then will check to see if the old username is included in the remote URL of that git directory. If it is, then the command will change the remote URL to instead point to the new username's remote URL. To run the command, run:
+
+```bash
+ghelper change-remote OLD-OWNER NEW-OWNER
+```
+
+### `checkout-default`
+
+This command will check out the default branch of whatever repository you're currently in. It looks at what branch the `origin/HEAD` remote is pointed to on your local machine, versus querying GitHub/GitLab for that, so if your local machine's remotes aren't up to date, then this command won't work as expected. To run this command, run:
+
+```bash
+ghelper checkout-default
+```
+
+If your local branches aren't right (run `git branch --remote` to see), then run:
+
+```bash
+git symbolic-ref refs/remotes/origin/HEAD refs/remotes/origin/CORRECT-DEFAULT-BRANCH-GOES-HERE
+```
+
+### `clean-git`
+
+This command will bring you to the repository's default branch, `git pull`, `git fetch -p`, and will clean up your local branches on your machine by seeing which ones are existing on the remote, and updating yours accordingly. To run:
+
+```bash
+ghelper clean-git
+```
+
+### `empty-commit`
+
+For some reason, I'm always forgetting the commands to create an empty commit. So with this command, it becomes easy. The commit message of this commit will be `'Empty commit'`. To run the command, run:
+
+```bash
+ghelper empty-commit
+```
+
+### `new-branch`
+
+This command is useful for making new branches in a repository on the command line. To run the command, run:
+
+```bash
+ghelper new-branch
+# OR
+ghelper new-branch NEW_BRANCH_NAME
+```
+
+The command either accepts a branch name right away or it will ask you for the name of your new branch. Make sure your input does not contain any spaces or special characters.
+
+### `pull-request`
+
+This command can be used to handily make new GitHub pull requests and to merge pull requests from the command line. The command uses the [`Octokit::Client`](https://octokit.github.io/octokit.rb/Octokit/Client.html) to do this, so make sure you have a `.git_config.yml` file set up in the home directory of your computer. For instructions on how to do that, see [Usage](#usage).
+
+After setup is complete, you can call the file, and send in a flag indicating whether to create a pull request, `-c`, or to merge a pull request, `-m`.
+
+```bash
+ghelper pull-request -c
+# OR
+ghelper pull-request -m
+```
+
+If you're trying to create a pull request, the command will provide an autogenerated pull request title based on your branch name (separated by `_`). You can respond 'yes' or 'no'. If you respond 'no', you can provide your own pull request title. The command will also ask you if the default branch of the repository is the proper base branch to use. You can say 'yes' or 'no'. If you respond 'no', then you can give the command your chosen base base. Lastly, it'll ask the user to apply any pull request templates found at any `*/pull_request_template.md` file or any file in `.github/PULL_REQUEST_TEMPLATE/*.md`. Applying any template is optional, and a user can make an empty pull request if they desire.
+
+If you're requesting to merge a pull request, the command will ask you the number ID of the pull request you wish to merge. The command will also ask you what type of merge to do: regular merging, squashing, or rebasing. The commit message to use during the merge/squash/rebase will be the title of the pull request.
+
+If you're getting stuck, you can run the command with a `--help` flag instead, to get some more information.
+
+### `merge-request`
+
+This command can be used to handily make new GitLab merge requests and to accept merge requests from the command line. The command uses the Ruby wrapper [`Gitlab`](https://github.com/NARKOZ/gitlab) to do this, so make sure you have a `.git_config.yml` file set up in the home directory of your computer. For instructions on how to do that, see [Usage](#usage).
+
+After setup is complete, you can call the file, and send in a flag indicating whether to create a pull request, `-c`, or to merge a pull request, `-m`.
+
+```bash
+ghelper merge-request -c
+# OR
+ghelper merge-request -m
+```
+
+If you're trying to create a merge request, the command will provide an autogenerated merge request title based on your branch name (separated by `_`). You can respond 'yes' or 'no'. If you respond 'no', you can provide your own merge request title. The command will also ask you if the default branch of the repository is the proper base branch to use. You can say 'yes' or 'no'. If you respond 'no', then you can give the command your chosen base base. Lastly, it'll ask the user to apply any merge request templates found at any `*/merge_request_template.md` file or any file in `.gitlab/merge_request_templates/*.md`. Applying any template is optional, and from the command's standpoint, a user can make an empty merge request if they desire. If a GitLab project automatically adds a template, then it may create a merge request with a default template anyway.
+
+If you're requesting to merge a merge request, the command will ask you the number ID of the merge request you wish to accept. The command will also ask you what type of merge to do: regular merging or squashing. The commit message to use during the merge/squash will be the title of the pull request.
+
+If you're getting stuck, you can run the command with a `--help` flag instead, to get some more information.
+
+## Contributing
+
+To submit a feature request, bug ticket, etc, please submit an official [GitHub Issue](https://github.com/emmasax4/git_helper/issues/new).
+
+To report any security vulnerabilities, please view this project's [Security Policy](https://github.com/emmasax4/git_helper/security/policy).
+
+This repository does have a standard [Code of Conduct](https://github.com/emmasax4/git_helper/blob/main/.github/code_of_conduct.md).

data/Rakefile

@@ -0,0 +1,37 @@
+#!/usr/bin/env rake
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+begin
+  require 'rdoc/task'
+rescue LoadError
+  require 'rdoc/rdoc'
+  require 'rake/rdoctask'
+  RDoc::Task = Rake::RDocTask
+end
+
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'Hubstats'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.rdoc')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+APP_RAKEFILE = File.expand_path("../test/dummy/Rakefile", __FILE__)
+load 'rails/tasks/engine.rake'
+
+Bundler::GemHelper.install_tasks
+
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib'
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = false
+end
+
+task :default => :test

data/bin/ghelper

@@ -0,0 +1,102 @@
+#!/usr/bin/env ruby
+require 'rubygems'
+require 'gli'
+require_relative '../lib/git_helper'
+
+include GLI::App
+
+program_desc 'GitHub and GitLab workflow scripts.'
+version GitHelper::VERSION
+
+autocomplete_commands false
+wrap_help_text :verbatim
+
+program_long_desc """
+DOCUMENTATION
+    For documentation and help in setting up your Git configuration files,
+    see Git Helper's GitHub repo: https://github.com/emmasax4/git_helper
+"""
+
+arg :old_owner
+arg :new_owner
+desc "Update a repository's remote URLs from an old GitHub owner to a new owner."
+command 'change-remote' do |c|
+  c.action do |global_options, options, args|
+    require_relative '../lib/git_helper/change_remote.rb'
+    raise ArgumentError, 'You must specify an old owner and a new owner' unless args.count == 2
+    GitHelper::ChangeRemote.new.execute(args[0], args[1])
+  end
+end
+
+desc "Checks out the default branch of the repository based on the repository's local remote branches."
+command 'checkout-default' do |c|
+  c.action do |global_options, options, args|
+    require_relative '../lib/git_helper/checkout_default.rb'
+    GitHelper::CheckoutDefault.new.execute
+  end
+end
+
+desc "Clean a repository's git branches."
+command 'clean-git' do |c|
+  c.action do |global_options, options, args|
+    require_relative '../lib/git_helper/clean_git.rb'
+    GitHelper::CleanGit.new.execute
+  end
+end
+
+desc "Creates an empty commit with a basic commit message."
+command 'empty-commit' do |c|
+  c.action do |global_options, options, args|
+    require_relative '../lib/git_helper/empty_commit.rb'
+    GitHelper::EmptyCommit.new.execute
+  end
+end
+
+desc 'Create a GitLab merge request from the current branch.'
+command 'merge-request' do |c|
+  c.switch [:c, :create], desc: 'Create a new pull request'
+  c.switch [:m, :merge], desc: 'Merge an existing pull request'
+
+  c.action do |global_options, options, args|
+    require_relative '../lib/git_helper/merge_request.rb'
+    raise ArgumentError, 'You must specify an action (either --merge or --create)' unless options[:create] || options[:merge]
+
+    options = global_options.merge(options)
+
+    if options[:create]
+      GitHelper::GitLabMergeRequest.new.create
+    elsif options[:merge]
+      GitHelper::GitLabMergeRequest.new.merge
+    end
+  end
+end
+
+arg :new_branch_name, optional: true
+desc 'Create a new branch for features, bug fixes, or experimentation.'
+command 'new-branch' do |c|
+  c.action do |global_options, options, args|
+    require_relative '../lib/git_helper/new_branch.rb'
+    GitHelper::NewBranch.new.execute(args[0])
+  end
+end
+
+desc 'Create a GitHub pull request from the current branch.'
+command 'pull-request' do |c|
+  c.switch [:c, :create], desc: 'Create a new pull request'
+  c.switch [:m, :merge], desc: 'Merge an existing pull request'
+
+  c.action do |global_options, options, args|
+    require_relative '../lib/git_helper/pull_request.rb'
+    raise ArgumentError, 'You must specify an action (either --merge or --create)' unless options[:create] || options[:merge]
+
+    options = global_options.merge(options)
+
+    if options[:create]
+      GitHelper::GitHubPullRequest.new.create
+    elsif options[:merge]
+      GitHelper::GitHubPullRequest.new.merge
+    end
+  end
+end
+
+exit run(ARGV)

data/lib/git_helper.rb

@@ -0,0 +1,7 @@
+require 'highline'
+require 'yaml'
+require 'gitlab'
+require 'octokit'
+require_relative 'git_helper/version'
+
+module GitHelper; end

data/lib/git_helper/change_remote.rb

@@ -0,0 +1,55 @@
+module GitHelper
+  class ChangeRemote
+    def execute(old_owner, new_owner)
+      current_dir = Dir.pwd
+      nested_dirs = Dir.entries(current_dir).select do |entry|
+        entry_dir = File.join(current_dir, entry)
+        File.directory?(entry_dir) && !(entry == '.' || entry == '..')
+      end
+
+      nested_dirs.each do |dir|
+        Dir.chdir dir
+        if File.exist?('.git')
+          puts "Found git directory: #{dir}."
+          remotes = `git remote -v`.split("\n")
+          remotes.each do |remote|
+            if resp.include?(old_owner)
+              puts "  Git directory's remote is pointing to: '#{old_owner}'."
+              swap_ssh(old_owner, new_owner, remote) if remote.scan(/(git@)/).any?
+              swap_https(old_owner, new_owner, remote) if remote.scan(/(https:\/\/)/).any?
+            else
+              puts "  No need to update remote."
+            end
+          end
+        end
+        Dir.chdir current_dir
+      end
+    end
+
+    private def swap_https(old_owner, new_owner, remote)
+      repo = remote.scan(/https:\/\/[\S]+\/([\S]*).git/).first.first
+      remote_name = remote.scan(/([a-zA-z]+)/).first.first
+      source_name = scan(/https:\/\/([a-zA-z.]+)\//).first.first
+      puts "  Changing the remote URL #{remote_name} to be 'https://#{source_name}/#{new_owner}/#{repo}.git'."
+      begin
+        `git remote set-url #{remote_name} https://#{source_name}:#{new_owner}/#{repo}.git`
+        puts "  Done."
+      rescue Exception => e
+        puts "  Could not complete: #{e.message}"
+      end
+    end
+
+    private def swap_ssh(old_owner, new_owner, remote)
+      repo = remote.scan(/\/([\S]*).git/).first.first
+      remote_name = remote.scan(/([a-zA-z]+)/).first.first
+      source_name = remote.scan(/git@([a-zA-z.]+):/).first.first
+      puts "  Changing the remote URL #{remote_name} to be 'git@#{source_name}:#{new_owner}/#{repo}.git'."
+      begin
+        `git remote set-url #{remote_name} git@#{source_name}:#{new_owner}/#{repo}.git`
+        puts "  Done."
+      rescue Exception => e
+        puts "  Could not complete: #{e.message}"
+      end
+    end
+  end
+end

data/lib/git_helper/checkout_default.rb

@@ -0,0 +1,7 @@
+module GitHelper
+  class CheckoutDefault
+    def execute
+      system("git checkout $(git symbolic-ref refs/remotes/origin/HEAD | sed \"s@^refs/remotes/origin/@@\")")
+    end
+  end
+end

data/lib/git_helper/clean_git.rb

@@ -0,0 +1,10 @@
+module GitHelper
+  class CleanGit
+    def execute
+      system("git checkout $(git symbolic-ref refs/remotes/origin/HEAD | sed \"s@^refs/remotes/origin/@@\")")
+      system("git pull")
+      system("git fetch -p")
+      system("git branch -vv | grep \"origin/.*: gone]\" | awk \"{print \$1}\" | grep -v \"*\" | xargs git branch -D")
+    end
+  end
+end

data/lib/git_helper/empty_commit.rb

@@ -0,0 +1,7 @@
+module GitHelper
+  class EmptyCommit
+    def execute
+      system("git commit --allow-empty -m \"Empty commit\"")
+    end
+  end
+end

data/lib/git_helper/git_config_reader.rb

@@ -0,0 +1,25 @@
+require 'yaml'
+
+module GitHelper
+  class GitConfigReader
+    def gitlab_token
+      config_file[:gitlab_token]
+    end
+
+    def github_token
+      config_file[:github_token]
+    end
+
+    private def config_file
+      YAML.load_file(git_config_file_path)
+    end
+
+    private def git_config_file_path
+      Dir.pwd.scan(/\A\/[\w]*\/[\w]*\//).first << git_config_file
+    end
+
+    private def git_config_file
+      '.git_config.yml'
+    end
+  end
+end

data/lib/git_helper/gitlab_client.rb

@@ -0,0 +1,18 @@
+require 'gitlab'
+require_relative './git_config_reader.rb'
+
+module GitHelper
+  class GitLabClient
+    def client
+      Gitlab.client(endpoint: gitlab_endpoint, private_token: git_config_reader.gitlab_token)
+    end
+
+    private def git_config_reader
+      @git_config_reader ||= GitConfigReader.new
+    end
+
+    private def gitlab_endpoint
+      'https://gitlab.com/api/v4'
+    end
+  end
+end

data/lib/git_helper/highline_cli.rb

@@ -0,0 +1,25 @@
+require 'highline'
+
+module GitHelper
+  class HighlineCli
+    def ask(prompt)
+      cli.ask(prompt) do |conf|
+        conf.readline = true
+      end.to_s
+    end
+
+    def ask_options(prompt, choices)
+      choices_as_string_options = ''
+      choices.each { |choice| choices_as_string_options << "#{choices.index(choice) + 1}. #{choice}\n" }
+      compiled_prompt = "#{prompt}\n#{choices_as_string_options.strip}"
+
+      cli.ask(compiled_prompt) do |conf|
+        conf.readline = true
+      end.to_i - 1
+    end
+
+    private def cli
+      @cli ||= HighLine.new
+    end
+  end
+end

data/lib/git_helper/merge_request.rb

@@ -0,0 +1,154 @@
+require_relative './gitlab_client.rb'
+require_relative './highline_cli.rb'
+
+module GitHelper
+  class GitLabMergeRequest
+    def create
+      begin
+        # Ask these questions right away
+        base_branch
+        new_mr_title
+        options = {
+          source_branch: local_branch,
+          target_branch: base_branch,
+          description: new_mr_body
+        }
+
+        puts "Creating merge request: #{new_mr_title}"
+        mr = gitlab_client.create_merge_request(local_repo, 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
+      end
+    end
+
+    def merge
+      begin
+        # Ask these questions right away
+        mr_id
+        options = {}
+        options[:should_remove_source_branch] = remove_source_branch?
+        options[:squash] = squash_merge_request?
+        options[:squash_commit_message] = existing_mr_title
+
+        puts "Merging merge request: #{mr_id}"
+        merge = gitlab_client.accept_merge_request(local_repo, mr_id, options)
+        puts "Merge request successfully merged: #{merge.merge_commit_sha}"
+      rescue Gitlab::Error::MethodNotAllowed => e
+        puts 'Could not merge merge request:'
+        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
+      end
+    end
+
+    private def local_repo
+      # Get the repository by looking in the remote URLs for the full repository name
+      remotes = `git remote -v`
+      return remotes.scan(/\S[\s]*[\S]+.com[\S]{1}([\S]*).git/).first.first
+    end
+
+    private def local_branch
+      # Get the current branch by looking in the list of branches for the *
+      branches = `git branch`
+      return branches.scan(/\*\s([\S]*)/).first.first
+    end
+
+    private def read_template
+      if mr_template_options.count == 1
+        apply_template?(mr_template_options.first) ? File.open(mr_template_options.first).read : ''
+      else
+        template_file_name_to_apply = template_to_apply
+        template_file_name_to_apply == "None" ? '' : File.open(template_file_name_to_apply).read
+      end
+    end
+
+    private def mr_id
+      @mr_id ||= cli.ask('Merge Request ID?')
+    end
+
+    private def existing_mr_title
+      @existing_mr_title ||= gitlab_client.merge_request(local_repo, mr_id).title
+    end
+
+    private def new_mr_title
+      @new_mr_title ||= accept_autogenerated_title? ? autogenerated_title : cli.ask('Title?')
+    end
+
+    private def new_mr_body
+      @new_mr_body ||= mr_template_options.empty? ? '' : read_template
+    end
+
+    private def base_branch
+      @base_branch ||= base_branch_default? ? default_branch : cli.ask('Base branch?')
+    end
+
+    private def autogenerated_title
+      @autogenerated_title ||= local_branch.split('_')[0..-1].join(' ').capitalize
+    end
+
+    private def default_branch
+      @default_branch ||= gitlab_client.branches(local_repo).select { |branch| branch.default }.first.name
+    end
+
+    private def template_to_apply
+      return @template_to_apply if @template_to_apply
+      complete_options = mr_template_options << 'None'
+      index = cli.ask_options("Which merge request template should be applied?", complete_options)
+      @template_to_apply = complete_options[index]
+    end
+
+    private def mr_template_options
+      return @mr_template_options if @mr_template_options
+      nested_templates = Dir.glob(File.join("**/merge_request_templates", "*.md"), File::FNM_DOTMATCH | File::FNM_CASEFOLD)
+      non_nested_templates = Dir.glob(File.join("**", "merge_request_template.md"), File::FNM_DOTMATCH | File::FNM_CASEFOLD)
+      @mr_template_options = nested_templates.concat(non_nested_templates)
+    end
+
+    private def base_branch_default?
+      answer = cli.ask("Is '#{default_branch}' the correct base branch for your new merge request? (y/n)")
+      !!(answer =~ /^y/i)
+    end
+
+    private def accept_autogenerated_title?
+      answer = cli.ask("Accept the autogenerated merge request title '#{autogenerated_title}'? (y/n)")
+      !!(answer =~ /^y/i)
+    end
+
+    private def squash_merge_request?
+      answer = cli.ask('Squash merge request? (y/n)')
+      !!(answer =~ /^y/i)
+    end
+
+    private def remove_source_branch?
+      answer = cli.ask('Remove source branch after merging? (y/n)')
+      !!(answer =~ /^y/i)
+    end
+
+    private def apply_template?(template_file_name)
+      answer = cli.ask("Apply the merge request template from #{template_file_name}? (y/n)")
+      !!(answer =~ /^y/i)
+    end
+
+    private def gitlab_client
+      @gitlab_client ||= GitHelper::GitLabClient.new.client
+    end
+
+    private def cli
+      @cli ||= GitHelper::HighlineCli.new
+    end
+  end
+end

data/lib/git_helper/new_branch.rb

@@ -0,0 +1,18 @@
+require_relative './highline_cli.rb'
+
+module GitHelper
+  class NewBranch
+    def execute(new_branch_name = nil)
+      branch_name = new_branch_name || cli.ask('New branch name?')
+      puts "Attempting to create a new branch: #{branch_name}"
+      system("git pull")
+      system("git branch --no-track #{branch_name}")
+      system("git checkout #{branch_name}")
+      system("git push --set-upstream origin #{branch_name}")
+    end
+
+    private def cli
+      @cli ||= GitHelper::HighlineCli.new
+    end
+  end
+end

data/lib/git_helper/octokit_client.rb

@@ -0,0 +1,14 @@
+require 'octokit'
+require_relative './git_config_reader.rb'
+
+module GitHelper
+  class OctokitClient
+    def client
+      Octokit::Client.new(access_token: git_config_reader.github_token)
+    end
+
+    private def git_config_reader
+      @git_config_reader ||= GitHelper::GitConfigReader.new
+    end
+  end
+end

data/lib/git_helper/pull_request.rb

@@ -0,0 +1,165 @@
+require_relative './octokit_client.rb'
+require_relative './highline_cli.rb'
+
+module GitHelper
+  class GitHubPullRequest
+    def create
+      begin
+        # Ask these questions right away
+        base_branch
+        new_pr_title
+        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 e.message
+      end
+    end
+
+    def merge
+      begin
+        # Ask these questions right away
+        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:'
+        puts e.message
+      end
+    end
+
+    private def local_repo
+      # Get the repository by looking in the remote URLs for the full repository name
+      remotes = `git remote -v`
+      return remotes.scan(/\S[\s]*[\S]+.com[\S]{1}([\S]*).git/).first.first
+    end
+
+    private def local_branch
+      # Get the current branch by looking in the list of branches for the *
+      branches = `git branch`
+      return branches.scan(/\*\s([\S]*)/).first.first
+    end
+
+    private def read_template
+      if pr_template_options.count == 1
+        apply_template?(pr_template_options.first) ? File.open(pr_template_options.first).read : ''
+      else
+        template_file_name_to_apply = template_to_apply
+        template_file_name_to_apply == "None" ? '' : File.open(template_file_name_to_apply).read
+      end
+    end
+
+    private def merge_options
+      [ 'merge', 'squash', 'rebase' ]
+    end
+
+    private def pr_id
+      @pr_id ||= cli.ask('Pull Request ID?')
+    end
+
+    private def existing_pr_title
+      @existing_pr_title ||= octokit_client.pull_request(local_repo, pr_id).title
+    end
+
+    private def new_pr_title
+      @new_pr_title ||= accept_autogenerated_title? ? autogenerated_title : cli.ask('Title?')
+    end
+
+    private def new_pr_body
+      @new_pr_body ||= pr_template_options.empty? ? '' : read_template
+    end
+
+    private def base_branch
+      @base_branch ||= base_branch_default? ? default_branch : cli.ask('Base branch?')
+    end
+
+    private def autogenerated_title
+      @autogenerated_title ||= local_branch.split('_')[0..-1].join(' ').capitalize
+    end
+
+    private def default_branch
+      @default_branch ||= octokit_client.repository(local_repo).default_branch
+    end
+
+    private def merge_method
+      return @merge_method if @merge_method
+      index = cli.ask_options("Merge method?", merge_options)
+      @merge_method = merge_options[index]
+    end
+
+    private def template_to_apply
+      return @template_to_apply if @template_to_apply
+      complete_options = pr_template_options << 'None'
+      index = cli.ask_options("Which pull request template should be applied?", complete_options)
+      @template_to_apply = complete_options[index]
+    end
+
+    private def pr_template_options
+      return @pr_template_options if @pr_template_options
+      nested_templates = Dir.glob(File.join("**/PULL_REQUEST_TEMPLATE", "*.md"), File::FNM_DOTMATCH | File::FNM_CASEFOLD)
+      non_nested_templates = Dir.glob(File.join("**", "pull_request_template.md"), File::FNM_DOTMATCH | File::FNM_CASEFOLD)
+      @pr_template_options = nested_templates.concat(non_nested_templates)
+    end
+
+    private def base_branch_default?
+      answer = cli.ask("Is '#{default_branch}' the correct base branch for your new pull request? (y/n)")
+      !!(answer =~ /^y/i)
+    end
+
+    private def accept_autogenerated_title?
+      answer = cli.ask("Accept the autogenerated pull request title '#{autogenerated_title}'? (y/n)")
+      !!(answer =~ /^y/i)
+    end
+
+    private def apply_template?(template_file_name)
+      answer = cli.ask("Apply the pull request template from #{template_file_name}? (y/n)")
+      !!(answer =~ /^y/i)
+    end
+
+    private def octokit_client
+      @octokit_client ||= GitHelper::OctokitClient.new.client
+    end
+
+    private def cli
+      @cli ||= GitHelper::HighlineCli.new
+    end
+  end
+end

data/lib/git_helper/version.rb

@@ -0,0 +1,3 @@
+module GitHelper
+  VERSION = '1.0.0'
+end

metadata

@@ -0,0 +1,191 @@
+--- !ruby/object:Gem::Specification
+name: git_helper
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Emma Sax
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2020-09-09 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: gitlab
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.16'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.16'
+- !ruby/object:Gem::Dependency
+  name: gli
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.13'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.13'
+- !ruby/object:Gem::Dependency
+  name: highline
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: octokit
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.18'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.18'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.1'
+- !ruby/object:Gem::Dependency
+  name: guard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.6'
+- !ruby/object:Gem::Dependency
+  name: guard-rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.1'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.99'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.99'
+description: A set of GitHub and GitLab workflow scripts.
+email:
+- emma.sax4@gmail.com
+executables:
+- ghelper
+extensions: []
+extra_rdoc_files: []
+files:
+- Gemfile
+- Gemfile.lock
+- Guardfile
+- LICENSE
+- README.md
+- Rakefile
+- bin/ghelper
+- lib/git_helper.rb
+- lib/git_helper/change_remote.rb
+- lib/git_helper/checkout_default.rb
+- lib/git_helper/clean_git.rb
+- lib/git_helper/empty_commit.rb
+- lib/git_helper/git_config_reader.rb
+- lib/git_helper/gitlab_client.rb
+- lib/git_helper/highline_cli.rb
+- lib/git_helper/merge_request.rb
+- lib/git_helper/new_branch.rb
+- lib/git_helper/octokit_client.rb
+- lib/git_helper/pull_request.rb
+- lib/git_helper/version.rb
+homepage: https://github.com/emmasax4/git_helper
+licenses:
+- MIT
+metadata: {}
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.1.2
+signing_key:
+specification_version: 4
+summary: A set of GitHub and GitLab workflow scripts to provide a smoother development
+  process for your git projects.
+test_files: []