git_helper 3.3.3 → 3.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e7e2fb7b1199964740a0d73091815fb81469b492a3de04adc16aea30ba794e79
-  data.tar.gz: 80abd21099775a4829c1e72accb74f7f91ae6e9f5e536cfd0468879065de06ff
+  metadata.gz: 0f54fe4752a8c63fd35e668a15b6d0ed4c17e6646f1058de2d66056550305050
+  data.tar.gz: 4dd91a7a425990aceb3012064bb64ad55d2501f2975d5e75668e9540722c8121
 SHA512:
-  metadata.gz: 5fdabeaa00c72c8f58e00bce3f054949ad1061dbbb132661d06caf788ca827b486d44c20d57213582c2eb7b9c8db28ac88636b5e4562366010c33cc6056c526c
-  data.tar.gz: '08eee4e6e95562f500c93df42f72a713b43ece4d39c96013d5313612f13bf33dc4b7dcd5ca6de243d3bba360af8d8bc183d6c5f2a8600d9692de2afa3bf7c675'
+  metadata.gz: 8d618c4758a4f4f9387e58a2d5a41b85d052ae61afd8253ca2c3c718bba85791a03f85332a5ecb104ab49dee35e7a406ea3e25984301b0db4f18d8c51140c233
+  data.tar.gz: 19ee42210fc4a308e927ef5bbf40512c73cfd5513be8d68a3b3754510b78a76701768eec2a8fd4ad9f2d48cfe168a1f817f9ab465040349068c7e7980322fba8

data/Gemfile.lock

@@ -1,11 +1,12 @@
 PATH
   remote: .
   specs:
-    git_helper (3.3.2)
+    git_helper (3.4.0)
       gitlab (~> 4.16)
       gli (~> 2.13)
-      highline_wrapper (~> 0.1.0)
+      highline_wrapper (~> 1.1)
       octokit (~> 4.18)
+      psych (< 4)
 
 GEM
   remote: https://rubygems.org/
@@ -16,14 +17,18 @@ 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)
@@ -44,14 +49,14 @@ GEM
       guard-compat (~> 1.1)
       rspec (>= 2.99.0, < 4.0)
     highline (2.0.3)
-    highline_wrapper (0.1.0)
+    highline_wrapper (1.2.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)
@@ -65,15 +70,16 @@ GEM
     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)
@@ -81,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)
@@ -95,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)
@@ -131,4 +137,4 @@ DEPENDENCIES
   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:
 
@@ -127,7 +127,7 @@ The command will provide an autogenerated code request title based on your branc
 
 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.
 
-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 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. If the project has allowed squashing, but doesn't default it, then the code will ask the user whether to squash the merge request. If the project has set merge requests to require squashing, prevent squashing, or sets the project to default to squashing, then the code will skip a squash question. If default squashing is set, then the code will set the merge request to squash, and the user can change that over the API or in the browser.
 
 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.
 
@@ -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/merge_request.rb

@@ -125,7 +125,16 @@ module GitHelper
     end
 
     private def squash_merge_request
-      @squash_merge_request ||= highline.ask_yes_no('Squash merge request? (y/n)')
+      return @squash_merge_request if @squash_merge_request
+
+      case existing_project.squash_option
+      when 'always', 'default_on'
+        @squash_merge_request = true
+      when 'never'
+        @squash_merge_request = false
+      else # 'default_off' or anything else
+        @squash_merge_request = highline.ask_yes_no('Squash merge request? (y/n)')
+      end
     end
 
     private def remove_source_branch

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 || HighlineWrapper.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/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.4.0'
 end

data/spec/git_helper/merge_request_spec.rb

@@ -183,12 +183,39 @@ describe GitHelper::GitLabMergeRequest do
   end
 
   describe '#squash_merge_request' do
-    it 'should ask the CLI for the code request ID' do
+    let(:existing_project) { double(squash_option: 'default_off') }
+
+    it 'should return true if the squash is set to always on the project' do
+      allow(subject).to receive(:existing_project).and_return(existing_project)
+      allow(existing_project).to receive(:squash_option).and_return('always')
+      expect(highline_wrapper).not_to receive(:ask_yes_no)
+      expect(subject.send(:squash_merge_request)).to eq(true)
+    end
+
+    it 'should return true if the squash is set to default_on on the project' do
+      allow(subject).to receive(:existing_project).and_return(existing_project)
+      allow(existing_project).to receive(:squash_option).and_return('default_on')
+      expect(highline_wrapper).not_to receive(:ask_yes_no)
+      expect(subject.send(:squash_merge_request)).to eq(true)
+    end
+
+    it 'should return false if the squash is set to never on the project' do
+      allow(subject).to receive(:existing_project).and_return(existing_project)
+      allow(existing_project).to receive(:squash_option).and_return('never')
+      expect(highline_wrapper).not_to receive(:ask_yes_no)
+      expect(subject.send(:squash_merge_request)).to eq(false)
+    end
+
+    it 'should ask the user for their response to the squash question' do
+      allow(subject).to receive(:existing_project).and_return(existing_project)
+      allow(existing_project).to receive(:squash_option).and_return(nil)
       expect(highline_wrapper).to receive(:ask_yes_no).and_return(true)
       subject.send(:squash_merge_request)
     end
 
     it 'should be a boolean' do
+      allow(subject).to receive(:existing_project).and_return(existing_project)
+      allow(existing_project).to receive(:squash_option).and_return(nil)
       expect(highline_wrapper).to receive(:ask_yes_no).and_return(false)
       expect([true, false]).to include(subject.send(:squash_merge_request))
     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.4.0
 platform: ruby
 authors:
 - Emma Sax
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-03-02 00:00:00.000000000 Z
+date: 2021-06-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: gitlab
@@ -44,14 +44,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.1.0
+        version: '1.1'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.1.0
+        version: '1.1'
 - !ruby/object:Gem::Dependency
   name: octokit
   requirement: !ruby/object:Gem::Requirement
@@ -66,6 +66,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '4.18'
+- !ruby/object:Gem::Dependency
+  name: psych
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '4'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '4'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -230,7 +244,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.3
+rubygems_version: 3.2.15
 signing_key:
 specification_version: 4
 summary: A set of GitHub and GitLab workflow scripts.