git_helper 3.0.1 → 3.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 34ec4f36cbe8b3cf3875894ee4670a5ca704ce4f67abeac7df2d5778f48a474f
-  data.tar.gz: 51721de128e9639c61c321ef0454c141cad5f91f4ec52ef5aa2161e6bb531c32
+  metadata.gz: b3f63c9e4283a7e005a3f6ca7f29e7721e474ec06ebebecd1dcda8f63f841450
+  data.tar.gz: 2ec89ecd8513c12f9434aa9c03f7568522b84d3c282e62e09670aa15a63fef95
 SHA512:
-  metadata.gz: 6f2a22415758219d80055e4ebdb0b954f49bdfb27d2023badea8d0f45e2be151e16d0683c351fd1dd890f7ef864ee5e4291d545af369936e1d65ee0ff14195b4
-  data.tar.gz: e2bdae4669a0331f84ecc50c7f60b1af00e987556ec2644abbe4c0e44cd45185c16820f4d508c451ad4883adf4e19c4a5dac89670bb6b500c2a700ffd0214ac4
+  metadata.gz: bce1b9c25dc1ad30c8434a0e252bdc95f8864fcd29e2c02e712dffb4fe63aaa063fa6a72d9cc27a91c06784758fd6499f9aaa21f62ea57d7b7b81522558112a4
+  data.tar.gz: 572c484112dbdcfbb2da9ad8c25add8fd56baa3c652931715a46d9355780e3535e226afc3a83d2f57a6815f78df6fba7c8f47e97990801608bb9653ef3c961c2

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    git_helper (3.0.0)
+    git_helper (3.2.0)
       gitlab (~> 4.16)
       gli (~> 2.13)
       highline (~> 2.0)
@@ -13,13 +13,19 @@ 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.15.1)
+      i18n (>= 1.6, < 2)
+    faraday (1.3.0)
+      faraday-net_http (~> 1.0)
       multipart-post (>= 1.2, < 3)
-    ffi (1.13.1)
+      ruby2_keywords
+    faraday-net_http (1.0.0)
+    ffi (1.14.2)
     formatador (0.2.5)
-    gitlab (4.16.1)
-      httparty (~> 0.14, >= 0.14.0)
+    gitlab (4.17.0)
+      httparty (~> 0.18)
       terminal-table (~> 1.5, >= 1.5.1)
     gli (2.19.2)
     guard (2.16.2)
@@ -40,44 +46,47 @@ GEM
     httparty (0.18.1)
       mime-types (~> 3.0)
       multi_xml (>= 0.5.2)
-    listen (3.2.1)
+    i18n (1.8.7)
+      concurrent-ruby (~> 1.0)
+    listen (3.4.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)
+    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.20.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 (13.0.1)
+    rake (13.0.3)
     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.1)
+      rspec-support (~> 3.10.0)
+    rspec-expectations (3.10.1)
       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.1)
       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.1)
+    ruby2_keywords (0.0.2)
     sawyer (0.8.2)
       addressable (>= 2.3.5)
       faraday (> 0.8, < 2.0)
@@ -88,14 +97,15 @@ GEM
     unicode-display_width (1.7.0)
 
 PLATFORMS
-  ruby
+  x86_64-darwin-19
 
 DEPENDENCIES
-  bundler (~> 2.1)
+  bundler (~> 2.2)
+  faker (~> 2.15)
   git_helper!
   guard-rspec (~> 4.3)
   rake (~> 13.0)
   rspec (~> 3.9)
 
 BUNDLED WITH
-   2.1.4
+   2.2.4

data/Guardfile

@@ -1,5 +1,5 @@
-guard :rspec, cmd: 'bundle exec rspec', all_on_start: true, all_after_pass: true  do
+guard :rspec, cmd: 'bundle exec rspec', all_on_start: 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
 
@@ -34,7 +34,7 @@ As an additional option, you can set each of the following commands to be a git
 ```bash
 # As a Gem                            # As a Plugin
 git-helper clean-branches             git clean-branches
-git-helper code-request --create      git code-request --create
+git-helper code-request               git code-request
 ```
 
 To do this, download the `plugins.zip` file in the root of this directory. Unzip and place the contents in the appropriate location:
@@ -110,25 +110,21 @@ 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_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).
+This command can be used to handily make new GitHub/GitLab pull/merge 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`.
+After setup is complete, you can call the command like this:
 
 ```bash
-git-helper code-request -c
-# OR
-git-helper code-request -m
+git-helper code-request
 ```
 
-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 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, 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.
+If your project uses GitLab, the command will potentially ask you if you'd like to delete the source branch upon merge. If the project defaults to deleting the source branch, then the script will use that selection, and the value can be changed for a specific MR either over the API or in the browser. If the project just provides source branch deletion as on option, then it'll ask the user. It also will probably ask you if you'd like to squash the MR upon merge. If the project requires or prevents squashing, then whatever answer you give will be _*ignored*_. This is unfortunate, but is here due to limited API functionality.
 
-If you're getting stuck, you can run the command with a `--help` flag instead, to get some more information.
+Lastly, it'll ask about code request templates. 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.
 
 ### `empty-commit`
 
@@ -146,6 +142,23 @@ This command is handy if you locally have a bunch of commits you wish to complet
 git-helper forget-local-commits
 ```
 
+### `merge-code-request`
+
+This command can be used to merge pull/merge 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 proper command like this:
+
+```bash
+git-helper merge-code-request
+```
+
+The command will ask you the number ID of the code request you wish to merge.
+
+If using GitHub _and_ the repository allows multiple types of merges (merge/squash/rebase), then the command will ask the user what type of merge to do. It'll only let users select a type of merge the repository allows. If a repository only allows one type of merging, then the command will automatically use that. The commit message to use during the merge/squash/rebase will be the title of the pull request.
+
+For GitLab, the command will use whatever squash/source branch deletion/etc settings are already set on the merge request, so make sure you click the proper checkboxes in the MR manually or over the API before running this command. The commit message to use during the merge/squash will be the title of the merge request.
+
+
 ### `new-branch`
 
 This command is useful for making new branches in a repository on the command line. To run the command, run:
@@ -164,7 +177,7 @@ To submit a feature request, bug ticket, etc, please submit an official [GitHub
 
 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).
+When interacting with this repository, please follow [Contributor Covenant's Code of Conduct](https://contributor-covenant.org).
 
 ## Releasing
 

data/Rakefile

@@ -1 +1 @@
-require "bundler/gem_tasks"
+require 'bundler/gem_tasks'

data/bin/git-helper

@@ -27,7 +27,7 @@ command 'change-remote' do |c|
   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|
     GitHelper::CheckoutDefault.new.execute
@@ -41,14 +41,14 @@ command 'clean-branches' do |c|
   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|
     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|
     GitHelper::ForgetLocalCommits.new.execute
@@ -63,21 +63,17 @@ command 'new-branch' do |c|
   end
 end
 
-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'
-
+desc 'Merge a GitHub/GitLab pull/merge request. The command will figure out whether your code project belongs to GitHub or GitLab.'
+command 'merge-code-request' do |c|
   c.action do |global_options, options, args|
-    raise ArgumentError, "You must specify an action (either '-m'/'--merge' or '-c'/'--create')" unless options[:create] || options[:merge]
-
-    options = global_options.merge(options)
+    GitHelper::CodeRequest.new.merge
+  end
+end
 
-    if options[:create]
-      GitHelper::CodeRequest.new.create
-    elsif options[:merge]
-      GitHelper::CodeRequest.new.merge
-    end
+desc 'Create a GitHub/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.action do |global_options, options, args|
+    GitHelper::CodeRequest.new.create
   end
 end
 

data/lib/git_helper.rb

@@ -1,4 +1,9 @@
-Dir[File.expand_path(File.join(File.dirname(File.absolute_path(__FILE__)), 'git_helper')) + "/**/*.rb"].each do |file|
+require 'yaml'
+require 'gitlab'
+require 'highline'
+require 'octokit'
+
+Dir[File.expand_path(File.join(File.dirname(File.absolute_path(__FILE__)), 'git_helper')) + '/**/*.rb'].each do |file|
   require_relative file
 end
 

data/lib/git_helper/change_remote.rb

@@ -23,7 +23,7 @@ module GitHelper
       Dir.chdir(current_dir)
 
       if File.exist?('.git')
-        process_git_repository if cli.process_directory_remotes?(current_dir)
+        process_git_repository if cli.ask_yes_no("Found git directory: #{current_dir}. Do you wish to proceed in updating #{current_dir}'s remote URLs? (y/n)")
       end
 
       Dir.chdir(original_dir)

data/lib/git_helper/code_request.rb

@@ -24,7 +24,7 @@ module GitHelper
     end
 
     private def ask_for_clarification
-      resp = cli.conflicting_remote_clarification
+      resp = cli.ask('Found git remotes for both GitHub and GitLab. Would you like to proceed with GitLab or GitHub? (github/gitlab)').downcase
       if resp.include?('hub')
         github_pull_request
       elsif resp.include?('lab')
@@ -61,10 +61,10 @@ module GitHelper
     end
 
     private def base_branch
-      @base_branch ||= if cli.base_branch_default?(default_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.base_branch
+                         cli.ask('Base branch?')
                        end
     end
 
@@ -77,10 +77,11 @@ module GitHelper
     end
 
     private def new_code_request_title
-      @new_code_request_title ||= if cli.accept_autogenerated_title?(autogenerated_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.title
+                                    cli.ask('Title?')
                                   end
     end
 

data/lib/git_helper/git_config_reader.rb

@@ -1,5 +1,3 @@
-require 'yaml'
-
 module GitHelper
   class GitConfigReader
     def gitlab_token

data/lib/git_helper/gitlab_client.rb

@@ -1,5 +1,3 @@
-require 'gitlab'
-
 module GitHelper
   class GitLabClient
     def client

data/lib/git_helper/highline_cli.rb

@@ -1,87 +1,29 @@
-require 'highline'
-
 module GitHelper
   class HighlineCli
-    def new_branch_name
-      ask('New branch name?')
-    end
-
-    def process_directory_remotes?(directory)
-      answer = ask("Found git directory: #{directory}. Do you wish to proceed in updating #{directory}'s remote URLs? (y/n)")
-      answer.empty? ? true : !!(answer =~ /^y/i)
-    end
-
-    def conflicting_remote_clarification
-      ask('Found git remotes for both GitHub and GitLab. Would you like to proceed with GitLab or GitHub? (github/gitlab)').downcase
-    end
-
-    def title
-      ask('Title?')
-    end
-
-    def base_branch
-      ask('Base branch?')
-    end
-
-    def code_request_id(request_type)
-      ask("#{request_type} Request ID?")
-    end
-
-    def accept_autogenerated_title?(autogenerated_title)
-      return false unless autogenerated_title
-      answer = ask("Accept the autogenerated code request title '#{autogenerated_title}'? (y/n)")
-      answer.empty? ? true : !!(answer =~ /^y/i)
-    end
-
-    def base_branch_default?(default_branch)
-      answer = ask("Is '#{default_branch}' the correct base branch for your new code request? (y/n)")
-      answer.empty? ? true : !!(answer =~ /^y/i)
-    end
-
-    def squash_merge_request?
-      answer = ask('Squash merge request? (y/n)')
-      answer.empty? ? true : !!(answer =~ /^y/i)
-    end
-
-    def remove_source_branch?
-      answer = ask('Remove source branch after merging? (y/n)')
-      answer.empty? ? true : !!(answer =~ /^y/i)
-    end
-
-    def merge_method(merge_options)
-      index = ask_options("Merge method?", merge_options)
-      merge_options[index]
-    end
-
-    def apply_template?(template_file_name, request_type)
-      answer = ask("Apply the #{request_type} request template from #{template_file_name}? (y/n)")
-      answer.empty? ? true : !!(answer =~ /^y/i)
-    end
-
-    def template_to_apply(template_options, request_type)
-      complete_options = template_options << 'None'
-      index = ask_options("Which #{request_type} request template should be applied?", complete_options)
-      complete_options[index]
+    def ask(prompt)
+      highline_client.ask(prompt) do |conf|
+        conf.readline = true
+      end.to_s
     end
 
-    #######################
-    ### GENERAL METHODS ###
-    #######################
-
-    private def ask(prompt)
-      highline_client.ask(prompt) do |conf|
+    def ask_yes_no(prompt)
+      answer = highline_client.ask(prompt) do |conf|
         conf.readline = true
       end.to_s
+
+      answer.empty? ? true : !!(answer =~ /^y/i)
     end
 
-    private def ask_options(prompt, choices)
+    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}"
 
-      highline_client.ask(compiled_prompt) do |conf|
+      index = highline_client.ask(compiled_prompt) do |conf|
         conf.readline = true
       end.to_i - 1
+
+      choices[index]
     end
 
     private def highline_client

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}")