git_helper 1.3.1 → 3.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d7f6658d90f9abf6f52b670fcd9e09ac4fc5964abbf70d0e88d21c6d3838d598
-  data.tar.gz: 420511dc29ead38efe88f841b76bb42f1b086b5c76369202056d7856002886ef
+  metadata.gz: 34ec4f36cbe8b3cf3875894ee4670a5ca704ce4f67abeac7df2d5778f48a474f
+  data.tar.gz: 51721de128e9639c61c321ef0454c141cad5f91f4ec52ef5aa2161e6bb531c32
 SHA512:
-  metadata.gz: e8ee96f3180249acb8a25a549fa937852ff8a3a836a41d445dd7e5ea9f941f5b00408e174378e7c0b259a137cc96ce0ee3f52f3af7c3156f263e10f3253e1c3d
-  data.tar.gz: bd1b57e904dcb2a29a2f85688038af87908499240e0b86f0e75c5cebb0ebd6de4e538b25dab598df247ff8a2bc82da665d0a6c57e2c41ac470a47cb20c226a46
+  metadata.gz: 6f2a22415758219d80055e4ebdb0b954f49bdfb27d2023badea8d0f45e2be151e16d0683c351fd1dd890f7ef864ee5e4291d545af369936e1d65ee0ff14195b4
+  data.tar.gz: e2bdae4669a0331f84ecc50c7f60b1af00e987556ec2644abbe4c0e44cd45185c16820f4d508c451ad4883adf4e19c4a5dac89670bb6b500c2a700ffd0214ac4

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    git_helper (1.0.0)
+    git_helper (3.0.0)
       gitlab (~> 4.16)
       gli (~> 2.13)
       highline (~> 2.0)
@@ -61,18 +61,23 @@ GEM
       coderay (~> 1.1)
       method_source (~> 1.0)
     public_suffix (4.0.6)
-    rake (12.3.3)
+    rake (13.0.1)
     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)
+    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)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.9.0)
+    rspec-mocks (3.9.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.9.0)
+    rspec-support (3.9.3)
     sawyer (0.8.2)
       addressable (>= 2.3.5)
       faraday (> 0.8, < 2.0)
@@ -88,10 +93,9 @@ PLATFORMS
 DEPENDENCIES
   bundler (~> 2.1)
   git_helper!
-  guard (~> 2.6)
   guard-rspec (~> 4.3)
-  rake (~> 12.3.3)
-  rspec (~> 2.99)
+  rake (~> 13.0)
+  rspec (~> 3.9)
 
 BUNDLED WITH
    2.1.4

data/README.md

@@ -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`.
@@ -71,7 +80,7 @@ If you're going to make using git workflows easier, might as well provide lots o
 
 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:
+This command will go through every directory in a directory, and see if it is a git directory. It will then ask the user if they wish to process the git directory in question. The command does not yet know if there's any changes to be made. If the user says 'yes', then it 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
 git-helper change-remote OLD-OWNER NEW-OWNER
@@ -93,75 +102,61 @@ git symbolic-ref refs/remotes/origin/HEAD refs/remotes/origin/CORRECT-DEFAULT-BR
 
 ### `clean-branches`
 
-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:
+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 clean your local branches, run:
 
 ```bash
 git-helper clean-branches
 ```
 
-### `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
-git-helper empty-commit
-```
-
-### `merge-request`
+### `code-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).
+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 pull request, `-c`, or to merge a pull request, `-m`.
+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`.
 
 ```bash
-git-helper merge-request -c
+git-helper code-request -c
 # OR
-git-helper merge-request -m
+git-helper code-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. It will separate the branch name by `'_'` if underscores are in the branch, or `'-'` if dashes are present. Then it will join the list of words together by spaces. If there's a pattern in the form of `jira-123` or `jira_123` in the first part of the branch name, then it'll add `JIRA-123` to the first part of the pull request. You can respond 'yes' or 'no'. If you respond 'no', you can provide your own merge request title.
+If you're trying to create a code request, the command will provide an autogenerated code request title based on your branch name. It will separate the branch name by `'_'` if underscores are in the branch, or `'-'` if dashes are present. Then it will join the list of words together by spaces. If there's a pattern in the form of `jira-123` or `jira_123` in the first part of the branch name, then it'll add `JIRA-123` to the first part of the code request. You can respond 'yes' or 'no'. If you respond 'no', you can provide your own code 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.
+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 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 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.
 
 If you're getting stuck, you can run the command with a `--help` flag instead, to get some more information.
 
-### `new-branch`
+### `empty-commit`
 
-This command is useful for making new branches in a repository on the command line. To run the command, run:
+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
-git-helper new-branch
-# OR
-git-helper new-branch NEW_BRANCH_NAME
+git-helper empty-commit
 ```
 
-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`
+### `forget-local-commits`
 
-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`.
+This command is handy if you locally have a bunch of commits you wish to completely get rid of. This command basically does a hard reset to `origin/HEAD`. Once you forget them, they're completely gone, so run carefully. To test it out, run:
 
 ```bash
-git-helper pull-request -c
-# OR
-git-helper pull-request -m
+git-helper forget-local-commits
 ```
 
-If you're trying to create a pull request, the command will provide an autogenerated pull request title based on your branch name. It will separate the branch name by `'_'` if underscores are in the branch, or `'-'` if dashes are present. Then it will join the list of words together by spaces. If there's a pattern in the form of `jira-123` or `jira_123` in the first part of the branch name, then it'll add `JIRA-123` to the first part of the pull request. 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.
+### `new-branch`
 
-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.
+This command is useful for making new branches in a repository on the command line. To run the command, run:
 
-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.
+```bash
+git-helper new-branch
+# OR
+git-helper new-branch NEW_BRANCH_NAME
+```
 
-If you're getting stuck, you can run the command with a `--help` flag instead, to get some more information.
+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.
 
 ## Contributing
 

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.execute(args[0], args[1])
+    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."
 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,7 +37,6 @@ 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
@@ -47,27 +44,14 @@ 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'
-
+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/merge_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)
-
-    if options[:create]
-      GitHelper::GitLabMergeRequest.new.create
-    elsif options[:merge]
-      GitHelper::GitLabMergeRequest.new.merge
-    end
+    GitHelper::ForgetLocalCommits.new.execute
   end
 end
 
@@ -75,26 +59,24 @@ 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'
+desc 'Create or merge a GitHub or GitLab pull/merge request from the current branch. The command will figure out whether your code project belongs to GitHub or GitLab'
+command 'code-request' do |c|
+  c.switch [:c, :create], desc: 'Create a new pull/merge request'
+  c.switch [:m, :merge], desc: 'Merge an existing pull/merge request'
 
   c.action do |global_options, options, args|
-    require_relative '../lib/git_helper/pull_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)
 
     if options[:create]
-      GitHelper::GitHubPullRequest.new.create
+      GitHelper::CodeRequest.new.create
     elsif options[:merge]
-      GitHelper::GitHubPullRequest.new.merge
+      GitHelper::CodeRequest.new.merge
     end
   end
 end

data/lib/git_helper.rb

@@ -1,7 +1,5 @@
-require 'highline'
-require 'yaml'
-require 'gitlab'
-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,55 +1,68 @@
 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)
+    attr_accessor :old_owner, :new_owner
+
+    def initialize(old_owner, new_owner)
+      @old_owner = old_owner
+      @new_owner = new_owner
+    end
+
+    def execute
+      original_dir = Dir.pwd
+      nested_dirs = Dir.entries(original_dir).select do |entry|
+        entry_dir = File.join(original_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
+      nested_dirs.each do |nested_dir|
+        process_dir(nested_dir, original_dir)
+      end
+    end
+
+    private def process_dir(current_dir, original_dir)
+      Dir.chdir(current_dir)
+
+      if File.exist?('.git')
+        process_git_repository if cli.process_directory_remotes?(current_dir)
       end
+
+      Dir.chdir(original_dir)
     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}"
+    private def process_git_repository
+      local_code.remotes.each do |remote|
+        if remote.include?(old_owner)
+          process_remote(remote)
+        else
+          puts "  Found remote is not pointing to #{old_owner}."
+        end
       end
+      puts "\n"
     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}"
+    private def process_remote(remote)
+      remote_name = local_code.remote_name(remote)
+
+      if local_code.ssh_remote?(remote)
+        repo = local_code.remote_project(remote)
+        source_name = local_code.remote_source(remote)
+        remote_url = "git@#{source_name}:#{new_owner}/#{repo}.git"
+      elsif local_code.https_remote?(remote)
+        repo = local_code.remote_project(remote)
+        source_name = local_code.remote_source(remote)
+        remote_url = "https://#{source_name}/#{new_owner}/#{repo}.git"
       end
+
+      puts "  Changing the remote URL #{remote_name} to be '#{remote_url}'."
+      local_code.change_remote(remote_name, remote_url)
+    end
+
+    private def local_code
+      @local_code ||= GitHelper::LocalCode.new
+    end
+
+    private def cli
+      @cli ||= GitHelper::HighlineCli.new
     end
   end
 end