git_helper 3.3.2 → 3.3.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: '02607381872b87e3390ddfe00db3a66da5b72698943abfc7af1fb556b69bc5fd'
-  data.tar.gz: 85ef4555a8f0be75248dc20895a62d3e7660276154c4cee638faceb7f0ff701a
+  metadata.gz: aa8dfc9e8dff01f688d1f18ac2db60d0f0d9c193ad9ad1a5d91ab54fa7e2cb47
+  data.tar.gz: ed55743cbc0291c9058e8639c8b426d7201e5152d8f7f54c146df614a5cc154b
 SHA512:
-  metadata.gz: 354f303f75c86aefa64b8af4378e0006aab40b322ad5fa5b3f18018e45625d5f0e2d57c5a2f6ff8eb5e38d60863f995ac55fdecfe995d922dfff0d5dc3db4a52
-  data.tar.gz: 2a946bf13c0b36ebe71ca352623aeb6c509a3a3ee2c565ed1e433380713afacd08fddfd69626ca22a88225a65f0f7f5d093f5bf25b58c3cbc2121ebf70d9529b
+  metadata.gz: d412a23d9fb0daf6798fd0a364c536451361e3d195925e411b0ff2022ae0d2390f422f1fbcc2f83ce8830e38aa3371a76c10bea381cc565d9418c6b0a8ebdfda
+  data.tar.gz: b7eab53f9e11d32d058f9d9b52a05ef7e87e08288ddd115c2011f937c4ccd6a6e1a5e83c2eab9cc85b6488a1f5d727d2945822c254212ac02284d0c8b1748bd6

data/Gemfile.lock

@@ -1,11 +1,12 @@
 PATH
   remote: .
   specs:
-    git_helper (3.3.1)
+    git_helper (3.3.7)
       gitlab (~> 4.16)
       gli (~> 2.13)
-      highline (~> 2.0)
+      highline_wrapper (~> 1.1)
       octokit (~> 4.18)
+      psych (< 4)
 
 GEM
   remote: https://rubygems.org/
@@ -16,19 +17,23 @@ GEM
     coderay (1.1.3)
     concurrent-ruby (1.1.8)
     diff-lcs (1.4.4)
-    faker (2.15.1)
+    faker (2.17.0)
       i18n (>= 1.6, < 2)
-    faraday (1.3.0)
+    faraday (1.4.1)
+      faraday-excon (~> 1.1)
       faraday-net_http (~> 1.0)
+      faraday-net_http_persistent (~> 1.1)
       multipart-post (>= 1.2, < 3)
-      ruby2_keywords
+      ruby2_keywords (>= 0.0.4)
+    faraday-excon (1.1.0)
     faraday-net_http (1.0.1)
-    ffi (1.14.2)
+    faraday-net_http_persistent (1.1.0)
+    ffi (1.15.0)
     formatador (0.2.5)
     gitlab (4.17.0)
       httparty (~> 0.18)
       terminal-table (~> 1.5, >= 1.5.1)
-    gli (2.19.2)
+    gli (2.20.0)
     guard (2.16.2)
       formatador (>= 0.2.4)
       listen (>= 2.7, < 4.0)
@@ -44,34 +49,37 @@ GEM
       guard-compat (~> 1.1)
       rspec (>= 2.99.0, < 4.0)
     highline (2.0.3)
+    highline_wrapper (1.1.0)
+      highline (~> 2.0)
     httparty (0.18.1)
       mime-types (~> 3.0)
       multi_xml (>= 0.5.2)
-    i18n (1.8.8)
+    i18n (1.8.10)
       concurrent-ruby (~> 1.0)
-    listen (3.4.1)
+    listen (3.5.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.1104)
+    mime-types-data (3.2021.0225)
     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.20.0)
+    octokit (4.21.0)
       faraday (>= 0.9)
       sawyer (~> 0.8.0, >= 0.5.3)
     parallel (1.20.1)
-    parser (3.0.0.0)
+    parser (3.0.1.1)
       ast (~> 2.4.1)
-    pry (0.14.0)
+    pry (0.14.1)
       coderay (~> 1.1)
       method_source (~> 1.0)
+    psych (3.3.2)
     public_suffix (4.0.6)
     rainbow (3.0.0)
     rake (13.0.3)
@@ -79,7 +87,7 @@ GEM
     rb-inotify (0.10.1)
       ffi (~> 1.0)
     regexp_parser (2.1.1)
-    rexml (3.2.4)
+    rexml (3.2.5)
     rspec (3.10.0)
       rspec-core (~> 3.10.0)
       rspec-expectations (~> 3.10.0)
@@ -93,17 +101,17 @@ GEM
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.10.0)
     rspec-support (3.10.2)
-    rubocop (1.10.0)
+    rubocop (1.14.0)
       parallel (~> 1.10)
       parser (>= 3.0.0.0)
       rainbow (>= 2.2.2, < 4.0)
       regexp_parser (>= 1.8, < 3.0)
       rexml
-      rubocop-ast (>= 1.2.0, < 2.0)
+      rubocop-ast (>= 1.5.0, < 2.0)
       ruby-progressbar (~> 1.7)
       unicode-display_width (>= 1.4.0, < 3.0)
-    rubocop-ast (1.4.1)
-      parser (>= 2.7.1.5)
+    rubocop-ast (1.5.0)
+      parser (>= 3.0.1.1)
     ruby-progressbar (1.11.0)
     ruby2_keywords (0.0.4)
     sawyer (0.8.2)
@@ -123,9 +131,10 @@ DEPENDENCIES
   faker (~> 2.15)
   git_helper!
   guard-rspec (~> 4.3)
+  pry (~> 0.13)
   rake (~> 13.0)
   rspec (~> 3.9)
-  rubocop
+  rubocop (~> 1.10)
 
 BUNDLED WITH
-   2.2.9
+   2.2.17

data/README.md

@@ -1,4 +1,4 @@
-# git_helper [![Main](https://github.com/emmahsax/git_helper/actions/workflows/main.yml/badge.svg)](https://github.com/emmahsax/git_helper/actions/workflows/main.yml)
+# Git Helper [![Main](https://github.com/emmahsax/git_helper/actions/workflows/main.yml/badge.svg)](https://github.com/emmahsax/git_helper/actions/workflows/main.yml)
 
 ## Gem Usage
 
@@ -115,7 +115,7 @@ git-helper clean-branches
 
 ### `code-request`
 
-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).
+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 command like this:
 
@@ -149,7 +149,7 @@ 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).
+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:
 
@@ -166,7 +166,7 @@ For GitLab, the command will use whatever squash/source branch deletion/etc sett
 
 ### `new-branch`
 
-This command is useful for making new branches in a repository on the command line. To run the command, run:
+This command is useful for making new branches in a repository on the command-line. To run the command, run:
 
 ```bash
 git-helper new-branch

data/lib/git_helper.rb

@@ -2,7 +2,7 @@
 
 require 'yaml'
 require 'gitlab'
-require 'highline'
+require 'highline_wrapper'
 require 'octokit'
 
 files = "#{File.expand_path(File.join(File.dirname(File.absolute_path(__FILE__)), 'git_helper'))}/**/*.rb"

data/lib/git_helper/change_remote.rb

@@ -24,8 +24,9 @@ module GitHelper
     private def process_dir(current_dir, original_dir)
       Dir.chdir(current_dir)
 
-      if File.exist?('.git') && cli.ask_yes_no(
-        "Found git directory: #{current_dir}. Do you wish to proceed in updating #{current_dir}'s remote URLs? (y/n)"
+      if File.exist?('.git') && highline.ask_yes_no(
+        "Found git directory: #{current_dir}. Do you wish to proceed in updating #{current_dir}'s remote URLs? (y/n)",
+        { required: true }
       )
         process_git_repository
       end
@@ -41,7 +42,7 @@ module GitHelper
           puts "  Found remote is not pointing to #{old_owner}."
         end
       end
-      puts "\n"
+      puts
     end
 
     # rubocop:disable Metrics/AbcSize
@@ -69,8 +70,8 @@ module GitHelper
       @local_code ||= GitHelper::LocalCode.new
     end
 
-    private def cli
-      @cli ||= GitHelper::HighlineCli.new
+    private def highline
+      @highline ||= HighlineWrapper.new
     end
   end
 end

data/lib/git_helper/code_request.rb

@@ -29,9 +29,10 @@ module GitHelper
 
     # rubocop:disable Metrics/MethodLength
     private def ask_for_clarification
-      resp = cli.ask(
+      resp = highline.ask(
         'Found git remotes for both GitHub and GitLab. Would you like to proceed ' \
-        'with GitLab or GitHub? (github/gitlab)'
+        'with GitLab or GitHub? (github/gitlab)',
+        { required: true }
       ).downcase
 
       if resp.include?('hub')
@@ -58,7 +59,7 @@ module GitHelper
         local_project: local_project,
         local_branch: local_branch,
         local_code: local_code,
-        cli: cli
+        highline: highline
       }
     end
 
@@ -72,10 +73,10 @@ module GitHelper
 
     private def base_branch
       @base_branch ||=
-        if cli.ask_yes_no("Is '#{default_branch}' the correct base branch for your new code request? (y/n)")
+        if highline.ask_yes_no("Is '#{default_branch}' the correct base branch for your new code request? (y/n)")
           default_branch
         else
-          cli.ask('Base branch?')
+          highline.ask('Base branch?', { required: true })
         end
     end
 
@@ -89,17 +90,17 @@ module GitHelper
 
     private def new_code_request_title
       @new_code_request_title ||=
-        if autogenerated_title && cli.ask_yes_no(
+        if autogenerated_title && highline.ask_yes_no(
           "Accept the autogenerated code request title '#{autogenerated_title}'? (y/n)"
         )
           autogenerated_title
         else
-          cli.ask('Title?')
+          highline.ask('Title?', { required: true })
         end
     end
 
-    private def cli
-      @cli ||= GitHelper::HighlineCli.new
+    private def highline
+      @highline ||= HighlineWrapper.new
     end
 
     private def local_code

data/lib/git_helper/merge_request.rb

@@ -2,13 +2,13 @@
 
 module GitHelper
   class GitLabMergeRequest
-    attr_accessor :local_project, :local_branch, :local_code, :cli, :base_branch, :new_mr_title
+    attr_accessor :local_project, :local_branch, :local_code, :highline, :base_branch, :new_mr_title
 
     def initialize(options)
       @local_project = options[:local_project]
       @local_branch = options[:local_branch]
       @local_code = options[:local_code]
-      @cli = options[:cli]
+      @highline = options[:highline]
     end
 
     # rubocop:disable Metrics/MethodLength
@@ -97,12 +97,12 @@ module GitHelper
     # rubocop:disable Metrics/MethodLength
     private def determine_template
       if mr_template_options.count == 1
-        apply_single_template = cli.ask_yes_no(
+        apply_single_template = highline.ask_yes_no(
           "Apply the merge request template from #{mr_template_options.first}? (y/n)"
         )
         @template_name_to_apply = mr_template_options.first if apply_single_template
       else
-        response = cli.ask_options(
+        response = highline.ask_options(
           'Which merge request template should be applied?', mr_template_options << 'None'
         )
         @template_name_to_apply = response unless response == 'None'
@@ -121,16 +121,16 @@ module GitHelper
     end
 
     private def mr_id
-      @mr_id ||= cli.ask('Merge Request ID?')
+      @mr_id ||= highline.ask('Merge Request ID?')
     end
 
     private def squash_merge_request
-      @squash_merge_request ||= cli.ask_yes_no('Squash merge request? (y/n)')
+      @squash_merge_request ||= highline.ask_yes_no('Squash merge request? (y/n)')
     end
 
     private def remove_source_branch
       @remove_source_branch ||=
-        existing_project.remove_source_branch_after_merge || cli.ask_yes_no(
+        existing_project.remove_source_branch_after_merge || highline.ask_yes_no(
           'Remove source branch after merging? (y/n)'
         )
     end

data/lib/git_helper/new_branch.rb

@@ -3,7 +3,7 @@
 module GitHelper
   class NewBranch
     def execute(new_branch_name = nil)
-      branch_name = new_branch_name || GitHelper::HighlineCli.new.ask('New branch name?')
+      branch_name = new_branch_name || HighlineWrapper.new.ask('New branch name?', { required: true })
       puts "Attempting to create a new branch: #{branch_name}"
       GitHelper::LocalCode.new.new_branch(branch_name)
     end

data/lib/git_helper/pull_request.rb

@@ -2,13 +2,13 @@
 
 module GitHelper
   class GitHubPullRequest
-    attr_accessor :local_repo, :local_branch, :local_code, :cli, :base_branch, :new_pr_title
+    attr_accessor :local_repo, :local_branch, :local_code, :highline, :base_branch, :new_pr_title
 
     def initialize(options)
       @local_repo = options[:local_project]
       @local_branch = options[:local_branch]
       @local_code = options[:local_code]
-      @cli = options[:cli]
+      @highline = options[:highline]
     end
 
     # rubocop:disable Metrics/MethodLength
@@ -102,12 +102,12 @@ module GitHelper
     # rubocop:disable Metrics/MethodLength
     private def determine_template
       if pr_template_options.count == 1
-        apply_single_template = cli.ask_yes_no(
+        apply_single_template = highline.ask_yes_no(
           "Apply the pull request template from #{pr_template_options.first}? (y/n)"
         )
         @template_name_to_apply = pr_template_options.first if apply_single_template
       else
-        response = cli.ask_options(
+        response = highline.ask_options(
           'Which pull request template should be applied?', pr_template_options << 'None'
         )
         @template_name_to_apply = response unless response == 'None'
@@ -126,7 +126,7 @@ module GitHelper
     end
 
     private def pr_id
-      @pr_id ||= cli.ask('Pull Request ID?')
+      @pr_id ||= highline.ask('Pull Request ID?')
     end
 
     private def merge_method
@@ -134,7 +134,7 @@ module GitHelper
         if merge_options.length == 1
           merge_options.first
         else
-          cli.ask_options('Merge method?', merge_options)
+          highline.ask_options('Merge method?', merge_options)
         end
     end
 

data/lib/git_helper/setup.rb

@@ -7,23 +7,26 @@ module GitHelper
       execute_plugins
     end
 
+    # rubocop:disable Style/ConditionalAssignment
     private def execute_config_file
       if config_file_exists?
         answer = highline.ask_yes_no(
-          "It looks like the #{config_file} file already exists. Do you wish to replace it? (y/n)"
+          "It looks like the #{config_file} file already exists. Do you wish to replace it? (y/n)",
+          { required: true }
         )
-        puts
       else
         answer = true
       end
 
       create_or_update_config_file if answer
     end
+    # rubocop:enable Style/ConditionalAssignment
 
     private def execute_plugins
       answer = highline.ask_yes_no(
         'Do you wish to set up the Git Helper plugins? (y/n) (This process will ' \
-        'attempt to use your GitHub personal access token to authenticate)'
+        'attempt to use your GitHub personal access token to authenticate)',
+        { required: true }
       )
 
       return unless answer
@@ -36,7 +39,7 @@ module GitHelper
 
     private def create_or_update_config_file
       contents = generate_file_contents
-      puts "\nCreating or updating your #{config_file} file..."
+      puts "Creating or updating your #{config_file} file..."
       File.open(config_file, 'w') { |file| file.puts contents }
       puts "\nDone!\n\n"
     end
@@ -49,19 +52,23 @@ module GitHelper
     private def generate_file_contents
       file_contents = ''.dup
 
-      if highline.ask_yes_no('Do you wish to set up GitHub credentials? (y/n)')
+      if highline.ask_yes_no('Do you wish to set up GitHub credentials? (y/n)', { required: true })
         file_contents << ":github_user:  #{ask_question('GitHub username?')}\n"
         file_contents << ':github_token: ' \
-          "#{ask_question('GitHub personal access token? (Navigate to https://github.com/settings/tokens ' \
-          'to create a new personal access token)')}\n"
+          "#{ask_question(
+            'GitHub personal access token? (Navigate to https://github.com/settings/tokens ' \
+            'to create a new personal access token)',
+            secret: true
+          )}\n"
       end
 
-      if highline.ask_yes_no("\nDo you wish to set up GitLab credentials? (y/n)")
+      if highline.ask_yes_no('Do you wish to set up GitLab credentials? (y/n)', { required: true })
         file_contents << ":gitlab_user:  #{ask_question('GitLab username?')}\n"
         file_contents << ':gitlab_token: ' \
           "#{ask_question(
             'GitLab personal access token? (Navigate to https://gitlab.com/-/profile/personal_access_tokens' \
-            ' to create a new personal access token)'
+            ' to create a new personal access token)',
+            secret: true
           )}\n"
       end
 
@@ -69,15 +76,8 @@ module GitHelper
     end
     # rubocop:enable Metrics/MethodLength
 
-    private def ask_question(prompt)
-      answer = highline.ask("\n#{prompt}")
-
-      if answer.empty?
-        puts "\nThis question is required."
-        ask_question(prompt)
-      else
-        answer
-      end
+    private def ask_question(prompt, secret: false)
+      highline.ask(prompt, { required: true, secret: secret })
     end
 
     # rubocop:disable Metrics/MethodLength
@@ -110,7 +110,7 @@ module GitHelper
     end
 
     private def highline
-      @highline ||= GitHelper::HighlineCli.new
+      @highline ||= HighlineWrapper.new
     end
   end
 end