git_helper 2.0.0 → 3.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 929b169f934f99ecd468e7fb78080b0ea0059192f912ee8492ee35c0dfae7bfa
-  data.tar.gz: 9a5302fc0a26595b048cbc03e2d2e6e2d4ad4b207219e2c06b1cc732fb7be5b0
+  metadata.gz: 59ea066ec1e5cc797d676571c908c55fcc6de186590f5f1d1f14bb5f3ebfe1c5
+  data.tar.gz: 31c8412273b1e46d5f181e7a01bac5b10858f848293fe287c357f768e41ab90e
 SHA512:
-  metadata.gz: f6dd7318464df844707836bef67b9cb9addc580785edb8a57cf694f9e5a3af69f7efe18888aa0936cfdd3bfbc4a3848c90e142603501a2d3251d9618c26ed19c
-  data.tar.gz: ca79af7651e083f543a1a5bb89f54cec6506958dd653556afa235a3b0bad82a673fa70a3df7f9460033c1f76c5bcd76eb4081127c68f7e237a714e383d028a53
+  metadata.gz: 16b7f3b1a77e5a2cae432fcddc556425a18ce88ae6a7147814810af49e42ebe61ca1a82daf691165ef62f7315b10442fcf8c3b458440075b8b767090b5fe560b
+  data.tar.gz: dd940ec200f5275c5f07b1b91c5e504bc545b177580ab6c059e64d988438001b186ced83af14a2022e14f9526a0d69fe01989eabd7290bf5378de3560ede5968

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    git_helper (2.0.0)
+    git_helper (3.0.1)
       gitlab (~> 4.16)
       gli (~> 2.13)
       highline (~> 2.0)
@@ -13,9 +13,13 @@ GEM
     addressable (2.7.0)
       public_suffix (>= 2.0.2, < 5.0)
     coderay (1.1.3)
+    concurrent-ruby (1.1.7)
     diff-lcs (1.4.4)
-    faraday (1.0.1)
+    faker (2.14.0)
+      i18n (>= 1.6, < 2)
+    faraday (1.1.0)
       multipart-post (>= 1.2, < 3)
+      ruby2_keywords
     ffi (1.13.1)
     formatador (0.2.5)
     gitlab (4.16.1)
@@ -40,6 +44,8 @@ GEM
     httparty (0.18.1)
       mime-types (~> 3.0)
       multi_xml (>= 0.5.2)
+    i18n (1.8.5)
+      concurrent-ruby (~> 1.0)
     listen (3.2.1)
       rb-fsevent (~> 0.10, >= 0.10.3)
       rb-inotify (~> 0.9, >= 0.9.10)
@@ -47,14 +53,14 @@ GEM
     method_source (1.0.0)
     mime-types (3.3.1)
       mime-types-data (~> 3.2015)
-    mime-types-data (3.2020.0512)
+    mime-types-data (3.2020.1104)
     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)
+    octokit (4.19.0)
       faraday (>= 0.9)
       sawyer (~> 0.8.0, >= 0.5.3)
     pry (0.13.1)
@@ -65,19 +71,20 @@ GEM
     rb-fsevent (0.10.4)
     rb-inotify (0.10.1)
       ffi (~> 1.0)
-    rspec (3.9.0)
-      rspec-core (~> 3.9.0)
-      rspec-expectations (~> 3.9.0)
-      rspec-mocks (~> 3.9.0)
-    rspec-core (3.9.3)
-      rspec-support (~> 3.9.3)
-    rspec-expectations (3.9.2)
+    rspec (3.10.0)
+      rspec-core (~> 3.10.0)
+      rspec-expectations (~> 3.10.0)
+      rspec-mocks (~> 3.10.0)
+    rspec-core (3.10.0)
+      rspec-support (~> 3.10.0)
+    rspec-expectations (3.10.0)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.9.0)
-    rspec-mocks (3.9.1)
+      rspec-support (~> 3.10.0)
+    rspec-mocks (3.10.0)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.9.0)
-    rspec-support (3.9.3)
+      rspec-support (~> 3.10.0)
+    rspec-support (3.10.0)
+    ruby2_keywords (0.0.2)
     sawyer (0.8.2)
       addressable (>= 2.3.5)
       faraday (> 0.8, < 2.0)
@@ -92,6 +99,7 @@ PLATFORMS
 
 DEPENDENCIES
   bundler (~> 2.1)
+  faker
   git_helper!
   guard-rspec (~> 4.3)
   rake (~> 13.0)

data/Guardfile

@@ -1,5 +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" }
+  watch('spec/spec_helper.rb')  { 'spec' }
 end

data/README.md

@@ -1,4 +1,4 @@
-# git_helper [![Maintainability](https://api.codeclimate.com/v1/badges/d53da11f17c38cc81b5b/maintainability)](https://codeclimate.com/github/emmasax4/git_helper/maintainability) ![Develop](https://github.com/emmasax4/git_helper/workflows/Develop/badge.svg)
+# git_helper [![Maintainability](https://api.codeclimate.com/v1/badges/d53da11f17c38cc81b5b/maintainability)](https://codeclimate.com/github/emmasax4/git_helper/maintainability) ![Default](https://github.com/emmasax4/git_helper/workflows/Default/badge.svg)
 
 ## Gem Usage
 
@@ -6,16 +6,18 @@
 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:
+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_helper/config.yml` file. The contents should look like this:
 
 ```
-:github_user: GITHUB-USERNAME
+:github_user:  GITHUB-USERNAME
 :github_token: GITHUB-TOKEN
-:gitlab_user: GITLAB-USERNAME
+:gitlab_user:  GITLAB-USERNAME
 :gitlab_token: GITLAB-TOKEN
 ```
 
-To view the help screen, run:
+To create or see what access tokens you have, look [here for GitHub personal access tokens](https://github.com/settings/tokens) and [here for GitLab access tokens](https://gitlab.com/profile/personal_access_tokens). You could either have one set of tokens for each computer you use, or just have one set of tokens for all computers that you rotate periodically.
+
+Once the gem is installed, run this to view the help screen:
 ```bash
 git-helper --help
 ```
@@ -30,15 +32,22 @@ git-helper --version
 As an additional option, you can set each of the following commands to be a git plugin, meaning you can call them in a way that feels even more git-native:
 
 ```bash
-# As a Gem                              # As a Plugin
-git-helper clean-branches               git clean-branches
-git-helper pull-request --create        git pull-request --create
+# As a Gem                            # As a Plugin
+git-helper clean-branches             git clean-branches
+git-helper code-request --create      git code-request --create
+```
+
+To do this, download the `plugins.zip` file in the root of this directory. Unzip and place the contents in the appropriate location:
+
+```bash
+mkdir ~/.git_helper
+unzip path/to/downloaded/plugins.zip -d ~/.git_helper
 ```
 
-To do this, clone this repository from GitHub, and add the following line to your `~/.bash_profile`:
+Now, the plugins will live in `~/.git_helper/plugins/*`. Add the following line to your `~/.bash_profile`:
 
 ```
-export PATH=/your/path/to/this/repository/git_helper/plugins:$PATH
+export PATH=/path/to/computer/home/.git_helper/plugins:$PATH
 ```
 
 And then run `source ~/.bash_profile`.
@@ -101,7 +110,7 @@ git-helper clean-branches
 
 ### `code-request`
 
-This command can be used to handily make new GitHub/GitLab pull/merge requests and to merge those requests from the command line. The command uses either the [`Octokit::Client`](https://octokit.github.io/octokit.rb/Octokit/Client.html) or [`Gitlab` client](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).
+This command can be used to handily make new GitHub/GitLab pull/merge requests and to merge those requests from the command line. The command uses either the [`Octokit::Client`](https://octokit.github.io/octokit.rb/Octokit/Client.html) or [`Gitlab` client](https://github.com/NARKOZ/gitlab) to do this, so make sure you have a `~/.git_helper/config.yml` file set up in the home directory of your computer. For instructions on how to do that, see [Gem Usage](#gem-usage).
 
 After setup is complete, you can call the file, and send in a flag indicating whether to create a code request, `-c`, or to merge a code request, `-m`.
 
@@ -115,7 +124,7 @@ If you're trying to create a code request, the command will provide an autogener
 
 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, for GitHub, it'll ask the user to apply any code 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. For GitLab, 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.
+Lastly, for GitHub, it'll ask the user to apply any pull request templates found at `.github/pull_request_template.md`, `./pull_request_template.md`, or `.github/PULL_REQUEST_TEMPLATE/*.md`. Applying any template is optional, and a user can make an empty pull request if they desire. For GitLab, it'll ask the user to apply any merge request templates found at any `.gitlab/merge_request_template.md`, `./merge_request_template.md`, or `.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 (although GitLab may still add a merge request template if the project itself requires one). When searching for templates, the code ignores cases, so the file could be named with all capital letters or all lowercase letters.
 
 If you're requesting to merge a code request, the command will ask you the number ID of the code request you wish to merge. For GitHub, 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. For GitLab, 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 merge request.
 

data/Rakefile

@@ -1,37 +1 @@
-#!/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
+require 'bundler/gem_tasks'

data/bin/git-helper

@@ -22,16 +22,14 @@ 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(args[0], args[1]).execute
   end
 end
 
-desc "Checks out the default branch of a repo based on the local remote branches."
+desc 'Checks out the default branch of a repo based on the 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
@@ -39,23 +37,20 @@ end
 desc "Clean a repository's git branches."
 command 'clean-branches' do |c|
   c.action do |global_options, options, args|
-    require_relative '../lib/git_helper/clean_branches.rb'
     GitHelper::CleanBranches.new.execute
   end
 end
 
-desc "Creates an empty commit with a basic commit message."
+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 "Reset your local git commits to origin/HEAD."
+desc 'Reset your local git commits to origin/HEAD.'
 command 'forget-local-commits' do |c|
   c.action do |global_options, options, args|
-    require_relative '../lib/git_helper/forget_local_commits.rb'
     GitHelper::ForgetLocalCommits.new.execute
   end
 end
@@ -64,7 +59,6 @@ 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
@@ -75,7 +69,6 @@ command 'code-request' do |c|
   c.switch [:m, :merge], desc: 'Merge an existing pull/merge request'
 
   c.action do |global_options, options, args|
-    require_relative '../lib/git_helper/code_request.rb'
     raise ArgumentError, "You must specify an action (either '-m'/'--merge' or '-c'/'--create')" unless options[:create] || options[:merge]
 
     options = global_options.merge(options)

data/lib/git_helper.rb

@@ -1,7 +1,10 @@
-require 'highline'
 require 'yaml'
 require 'gitlab'
+require 'highline'
 require 'octokit'
-require_relative 'git_helper/version'
+
+Dir[File.expand_path(File.join(File.dirname(File.absolute_path(__FILE__)), 'git_helper')) + '/**/*.rb'].each do |file|
+  require_relative file
+end
 
 module GitHelper; end

data/lib/git_helper/change_remote.rb

@@ -1,6 +1,3 @@
-require_relative './highline_cli.rb'
-require_relative './local_code.rb'
-
 module GitHelper
   class ChangeRemote
     attr_accessor :old_owner, :new_owner

data/lib/git_helper/checkout_default.rb

@@ -1,5 +1,3 @@
-require_relative './local_code.rb'
-
 module GitHelper
   class CheckoutDefault
     def execute

data/lib/git_helper/clean_branches.rb

@@ -1,5 +1,3 @@
-require_relative './local_code.rb'
-
 module GitHelper
   class CleanBranches
     def execute

data/lib/git_helper/code_request.rb

@@ -1,8 +1,3 @@
-require_relative './merge_request.rb'
-require_relative './pull_request.rb'
-require_relative './local_code.rb'
-require_relative './highline_cli.rb'
-
 module GitHelper
   class CodeRequest
     def create

data/lib/git_helper/empty_commit.rb

@@ -1,5 +1,3 @@
-require_relative './local_code.rb'
-
 module GitHelper
   class EmptyCommit
     def execute

data/lib/git_helper/forget_local_commits.rb

@@ -1,5 +1,3 @@
-require_relative './local_code.rb'
-
 module GitHelper
   class ForgetLocalCommits
     def execute

data/lib/git_helper/git_config_reader.rb

@@ -1,5 +1,3 @@
-require 'yaml'
-
 module GitHelper
   class GitConfigReader
     def gitlab_token
@@ -19,7 +17,7 @@ module GitHelper
     end
 
     private def git_config_file
-      '.git_config.yml'
+      '.git_helper/config.yml'
     end
   end
 end

data/lib/git_helper/gitlab_client.rb

@@ -1,6 +1,3 @@
-require 'gitlab'
-require_relative './git_config_reader.rb'
-
 module GitHelper
   class GitLabClient
     def client

data/lib/git_helper/highline_cli.rb

@@ -1,5 +1,3 @@
-require 'highline'
-
 module GitHelper
   class HighlineCli
     def new_branch_name

data/lib/git_helper/local_code.rb

@@ -1,27 +1,27 @@
 module GitHelper
   class LocalCode
     def checkout_default
-      system("git checkout $(git symbolic-ref refs/remotes/origin/HEAD | sed \"s@^refs/remotes/origin/@@\")")
+      system('git checkout $(git symbolic-ref refs/remotes/origin/HEAD | sed "s@^refs/remotes/origin/@@")')
     end
 
     def forget_local_commits
-      system("git pull")
-      system("git reset --hard origin/HEAD")
+      system('git pull')
+      system('git reset --hard origin/HEAD')
     end
 
     def empty_commit
-      system("git commit --allow-empty -m \"Empty commit\"")
+      system('git commit --allow-empty -m \"Empty commit\"')
     end
 
     def clean_branches
-      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")
+      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
 
     def new_branch(branch_name)
-      system("git pull")
+      system('git pull')
       system("git branch --no-track #{branch_name}")
       system("git checkout #{branch_name}")
       system("git push --set-upstream origin #{branch_name}")
@@ -85,16 +85,20 @@ module GitHelper
       `git symbolic-ref refs/remotes/origin/HEAD | sed "s@^refs/remotes/origin/@@" | tr -d "\n"`
     end
 
-    def template_options(template_identifiers)
+    def template_options(identifiers)
       nested_templates = Dir.glob(
-        File.join("**/#{template_identifiers[:nested_directory_name]}", "*.md"),
+        File.join("#{identifiers[:template_directory]}/#{identifiers[:nested_directory_name]}", '*.md'),
         File::FNM_DOTMATCH | File::FNM_CASEFOLD
       )
       non_nested_templates = Dir.glob(
-        File.join("**", "#{template_identifiers[:non_nested_file_name]}.md"),
+        File.join(identifiers[:template_directory], "#{identifiers[:non_nested_file_name]}.md"),
         File::FNM_DOTMATCH | File::FNM_CASEFOLD
       )
-      nested_templates.concat(non_nested_templates).uniq
+      root_templates = Dir.glob(
+        File.join('.', "#{identifiers[:non_nested_file_name]}.md"),
+        File::FNM_DOTMATCH | File::FNM_CASEFOLD
+      )
+      nested_templates.concat(non_nested_templates).concat(root_templates).uniq
     end
 
     def read_template(file_name)

data/lib/git_helper/merge_request.rb

@@ -1,7 +1,3 @@
-require_relative './gitlab_client.rb'
-require_relative './highline_cli.rb'
-require_relative './local_code.rb'
-
 module GitHelper
   class GitLabMergeRequest
     attr_accessor :local_project, :local_branch, :local_code, :cli, :base_branch, :new_mr_title
@@ -101,6 +97,7 @@ module GitHelper
 
     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'
                                })