git_helper 3.3.3 → 3.3.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e7e2fb7b1199964740a0d73091815fb81469b492a3de04adc16aea30ba794e79
-  data.tar.gz: 80abd21099775a4829c1e72accb74f7f91ae6e9f5e536cfd0468879065de06ff
+  metadata.gz: 8dc9aca4ddec9f8038f5083b2790b10ac48b8293de15c37fb8a153b76ca0ce23
+  data.tar.gz: e2be8c7950de2fe93e7b44b0b3c50118dd8bd34494237f435c69cdbc775ef7e9
 SHA512:
-  metadata.gz: 5fdabeaa00c72c8f58e00bce3f054949ad1061dbbb132661d06caf788ca827b486d44c20d57213582c2eb7b9c8db28ac88636b5e4562366010c33cc6056c526c
-  data.tar.gz: '08eee4e6e95562f500c93df42f72a713b43ece4d39c96013d5313612f13bf33dc4b7dcd5ca6de243d3bba360af8d8bc183d6c5f2a8600d9692de2afa3bf7c675'
+  metadata.gz: '029e8998214a94ff639bed8faa0a90bf94eca320a7989effab17b845918df911718512f40dd74e563faf347162723fb9e39b9a02ba0b20477183f4eb4b1d1d71'
+  data.tar.gz: ef184720792c6dc8f361674eabdf7e9972e905f2c835b06ecbbe4b952bdd9eab94c42e644663b6be38222688982c8ff2b0fc958a6899b9eb0a2c3ce2afb77547

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    git_helper (3.3.2)
+    git_helper (3.3.4)
       gitlab (~> 4.16)
       gli (~> 2.13)
       highline_wrapper (~> 0.1.0)
@@ -16,7 +16,7 @@ GEM
     coderay (1.1.3)
     concurrent-ruby (1.1.8)
     diff-lcs (1.4.4)
-    faker (2.15.1)
+    faker (2.16.0)
       i18n (>= 1.6, < 2)
     faraday (1.3.0)
       faraday-net_http (~> 1.0)
@@ -49,7 +49,7 @@ GEM
     httparty (0.18.1)
       mime-types (~> 3.0)
       multi_xml (>= 0.5.2)
-    i18n (1.8.8)
+    i18n (1.8.9)
       concurrent-ruby (~> 1.0)
     listen (3.4.1)
       rb-fsevent (~> 0.10, >= 0.10.3)
@@ -95,7 +95,7 @@ GEM
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.10.0)
     rspec-support (3.10.2)
-    rubocop (1.10.0)
+    rubocop (1.11.0)
       parallel (~> 1.10)
       parser (>= 3.0.0.0)
       rainbow (>= 2.2.2, < 4.0)
@@ -118,7 +118,7 @@ GEM
     unicode-display_width (1.7.0)
 
 PLATFORMS
-  x86_64-darwin-19
+  x86_64-darwin-20
 
 DEPENDENCIES
   bundler (~> 2.2)
@@ -131,4 +131,4 @@ DEPENDENCIES
   rubocop (~> 1.10)
 
 BUNDLED WITH
-   2.2.9
+   2.2.4

data/README.md

@@ -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/change_remote.rb

@@ -25,7 +25,8 @@ module GitHelper
       Dir.chdir(current_dir)
 
       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)"
+        "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

data/lib/git_helper/code_request.rb

@@ -31,7 +31,8 @@ module GitHelper
     private def ask_for_clarification
       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')
@@ -75,7 +76,7 @@ module GitHelper
         if highline.ask_yes_no("Is '#{default_branch}' the correct base branch for your new code request? (y/n)")
           default_branch
         else
-          highline.ask('Base branch?')
+          highline.ask('Base branch?', { required: true })
         end
     end
 
@@ -94,7 +95,7 @@ module GitHelper
         )
           autogenerated_title
         else
-          highline.ask('Title?')
+          highline.ask('Title?', { required: true })
         end
     end
 

data/lib/git_helper/new_branch.rb

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

data/lib/git_helper/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module GitHelper
-  VERSION = '3.3.3'
+  VERSION = '3.3.4'
 end

data/spec/git_helper/setup_spec.rb

@@ -84,12 +84,6 @@ describe GitHelper::Setup do
       subject.send(:ask_question, Faker::Lorem.sentence)
     end
 
-    it 'should recurse if the highline client gets an empty string' do
-      allow(highline_wrapper).to receive(:ask).and_return('', Faker::Lorem.word)
-      expect(subject).to receive(:ask_question).at_least(:twice).and_call_original
-      subject.send(:ask_question, Faker::Lorem.sentence)
-    end
-
     it 'should return the answer if it is given' do
       answer = Faker::Lorem.sentence
       allow(highline_wrapper).to receive(:ask).and_return(answer)

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: git_helper
 version: !ruby/object:Gem::Version
-  version: 3.3.3
+  version: 3.3.4
 platform: ruby
 authors:
 - Emma Sax
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-03-02 00:00:00.000000000 Z
+date: 2021-03-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: gitlab