git_helper 3.3.0 → 3.6.6

data/lib/git_helper/pull_request.rb

@@ -1,75 +1,76 @@
+# frozen_string_literal: true
+
 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
+    # rubocop:disable Metrics/AbcSize
     def create(options)
       @base_branch = options[:base_branch]
       @new_pr_title = options[:new_title]
 
-      begin
-        new_pr_body
-
-        puts "Creating pull request: #{new_pr_title}"
-        pr = octokit_client.create_pull_request(local_repo, base_branch, local_branch, new_pr_title, new_pr_body)
-        puts "Pull request successfully created: #{pr.html_url}"
-      rescue Octokit::UnprocessableEntity => e
-        puts 'Could not create pull request:'
-        if e.message.include?('pull request already exists')
-          puts '  A pull request already exists for this branch'
-        elsif e.message.include?('No commits between')
-          puts '  No commits have been pushed to GitHub'
-        else
-          puts e.message
-        end
-      rescue Exception => e
-        puts 'Could not create pull request:'
-        puts e.message
+      options = {
+        head: local_branch,
+        base: base_branch,
+        body: new_pr_body,
+        title: new_pr_title
+      }
+
+      puts "Creating pull request: #{new_pr_title}"
+      pr = github_client.create_pull_request(local_repo, options)
+
+      raise StandardError, pr.errors.first['message'] if pr.html_url.nil?
+
+      puts "Pull request successfully created: #{pr.html_url}"
+    rescue StandardError => e
+      puts 'Could not create pull request:'
+
+      if e.message.include?('A pull request already exists')
+        puts '  A pull request already exists for this branch'
+      elsif e.message.include?('No commits between')
+        puts '  No commits have been pushed to GitHub'
+      else
+        puts "  #{e.message}"
       end
     end
+    # rubocop:enable Metrics/AbcSize
+    # rubocop:enable Metrics/MethodLength
 
+    # rubocop:disable Metrics/MethodLength
+    # rubocop:disable Metrics/AbcSize
     def merge
-      begin
-        pr_id
-        merge_method
-
-        puts "Merging pull request: #{pr_id}"
-        merge = octokit_client.merge_pull_request(local_repo, pr_id, existing_pr.title, { merge_method: merge_method })
-        puts "Pull request successfully merged: #{merge.sha}"
-      rescue Octokit::UnprocessableEntity => e
-        puts 'Could not merge pull request:'
-        puts e.message
-      rescue Octokit::NotFound => e
-        puts 'Could not merge pull request:'
-        puts "  Could not a locate a pull request to merge with ID #{pr_id}"
-      rescue Octokit::MethodNotAllowed => e
-        puts 'Could not merge pull request:'
-        if e.message.include?('405 - Required status check')
-          puts '  A required status check has not passed'
-        elsif e.message.include?('405 - Base branch was modified')
-          puts '  The base branch has been modified'
-        elsif e.message.include?('405 - Pull Request is not mergeable')
-          puts '  The pull request is not mergeable'
-        elsif e.message.include?('405 - Rebase merges are not allowed on this repository')
-          puts '  Rebase merges are not allowed on this repository'
-        elsif e.message.include?('405 - Merge commits are not allowed on this repository')
-          puts '  Merge commits are not allowed on this repository'
-        elsif e.message.include?('405 - Squash commits are not allowed on this repository')
-          puts '  Squash merges are not allowed on this repository'
-        else
-          puts e.message
-        end
-      rescue Exception => e
-        puts 'Could not merge pull request:'
-        puts e.message
+      pr_id
+
+      options = {
+        merge_method: merge_method,
+        commit_title: existing_pr.title
+      }
+
+      puts "Merging pull request: #{pr_id}"
+      merge = github_client.merge_pull_request(local_repo, pr_id, options)
+
+      raise StandardError, merge.message if merge.sha.nil?
+
+      puts "Pull request successfully merged: #{merge.sha}"
+    rescue StandardError => e
+      puts 'Could not merge pull request:'
+
+      if e.message.include?('Not found')
+        puts '  Could not a locate a pull request to merge with given ID'
+      else
+        puts "  #{e.message}"
       end
     end
+    # rubocop:enable Metrics/AbcSize
+    # rubocop:enable Metrics/MethodLength
 
     private def new_pr_body
       @new_pr_body ||= template_name_to_apply ? local_code.read_template(template_name_to_apply) : ''
@@ -77,39 +78,56 @@ module GitHelper
 
     private def template_name_to_apply
       return @template_name_to_apply if @template_name_to_apply
+
       @template_name_to_apply = nil
 
-      unless pr_template_options.empty?
-        if pr_template_options.count == 1
-          apply_single_template = cli.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("Which pull request template should be applied?", pr_template_options << 'None')
-          @template_name_to_apply = response unless response == 'None'
-        end
-      end
+      determine_template unless pr_template_options.empty?
 
       @template_name_to_apply
     end
 
+    # rubocop:disable Metrics/MethodLength
+    private def determine_template
+      if pr_template_options.count == 1
+        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 = highline.ask_options(
+          'Which pull request template should be applied?', pr_template_options << 'None'
+        )
+        @template_name_to_apply = response unless response == 'None'
+      end
+    end
+    # rubocop:enable Metrics/MethodLength
+
     private def pr_template_options
-      @pr_template_options ||= local_code.template_options({
-                                 template_directory: '.github',
-                                 nested_directory_name: 'PULL_REQUEST_TEMPLATE',
-                                 non_nested_file_name: 'pull_request_template'
-                               })
+      @pr_template_options ||= local_code.template_options(
+        {
+          template_directory: '.github',
+          nested_directory_name: 'PULL_REQUEST_TEMPLATE',
+          non_nested_file_name: 'pull_request_template'
+        }
+      )
     end
 
     private def pr_id
-      @pr_id ||= cli.ask('Pull Request ID?')
+      @pr_id ||= highline.ask('Pull Request ID?', { required: true })
     end
 
     private def merge_method
-      @merge_method ||= merge_options.length == 1 ? merge_options.first : cli.ask_options('Merge method?', merge_options)
+      @merge_method ||=
+        if merge_options.length == 1
+          merge_options.first
+        else
+          highline.ask_options('Merge method?', merge_options)
+        end
     end
 
     private def merge_options
       return @merge_options if @merge_options
+
       merge_options = []
       merge_options << 'merge' if existing_project.allow_merge_commit
       merge_options << 'squash' if existing_project.allow_squash_merge
@@ -118,15 +136,15 @@ module GitHelper
     end
 
     private def existing_project
-      @existing_project ||= octokit_client.repository(local_repo)
+      @existing_project ||= github_client.repository(local_repo)
     end
 
     private def existing_pr
-      @existing_pr ||= octokit_client.pull_request(local_repo, pr_id)
+      @existing_pr ||= github_client.pull_request(local_repo, pr_id)
     end
 
-    private def octokit_client
-      @octokit_client ||= GitHelper::OctokitClient.new.client
+    private def github_client
+      @github_client ||= GitHelper::GitHubClient.new
     end
   end
 end

data/lib/git_helper/setup.rb

@@ -1,87 +1,110 @@
+# frozen_string_literal: true
+
 module GitHelper
   class Setup
     def execute
+      execute_config_file
+      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)")
-        puts
+        answer = highline.ask_yes_no(
+          "It looks like the #{config_file} file already exists. Do you wish to replace it? (y/n)",
+          { required: true }
+        )
       else
         answer = true
       end
 
       create_or_update_config_file if answer
+    end
+    # rubocop:enable Style/ConditionalAssignment
 
-      answer = highline.ask_yes_no("Do you wish to set up the Git Helper plugins? (y/n)")
+    private def execute_plugins
+      answer = highline.ask_yes_no(
+        'Do you wish to set up the Git Helper plugins? (y/n)',
+        { required: true }
+      )
 
-      if answer
-        create_or_update_plugin_files
-        puts "\nNow add this line to your ~/.bash_profile:\n  export PATH=/path/to/computer/home/.git_helper/plugins:$PATH"
-        puts "\nDone!"
-      end
+      return unless answer
+
+      create_or_update_plugin_files
+      puts "\nNow add this line to your ~/.zshrc:\n  " \
+           'export PATH="$HOME/.git_helper/plugins:$PATH"'
+      puts "\nDone!"
     end
 
     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..."
+      FileUtils.mkdir_p("#{Dir.home}/.git_helper")
       File.open(config_file, 'w') { |file| file.puts contents }
       puts "\nDone!\n\n"
     end
 
     private def config_file_exists?
-      File.exists?(config_file)
+      File.exist?(config_file)
     end
 
+    # rubocop:disable Metrics/MethodLength
     private def generate_file_contents
-      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"
+        file_contents << ':github_token: ' \
+          "#{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)')}\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)',
+            secret: true
+          )}\n"
       end
 
       file_contents.strip
     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
-    end
-
-    private def highline
-      @highline ||= GitHelper::HighlineCli.new
-    end
-
-    private def config_file
-      GitHelper::GitConfigReader.new.git_config_file_path
+    private def ask_question(prompt, secret: false)
+      highline.ask(prompt, { required: true, secret: secret })
     end
 
     private def create_or_update_plugin_files
-      plugins_dir = "#{Dir.pwd.scan(/\A\/[\w]*\/[\w]*\//).first}/.git_helper/plugins"
+      plugins_dir = "#{Dir.home}/.git_helper/plugins"
       plugins_url = 'https://api.github.com/repos/emmahsax/git_helper/contents/plugins'
       header = 'Accept: application/vnd.github.v3.raw'
 
-      Dir.mkdir(plugins_dir) unless File.exists?(plugins_dir)
+      FileUtils.mkdir_p(plugins_dir)
 
       all_plugins = JSON.parse(`curl -s -H "#{header}" -L "#{plugins_url}"`)
 
       all_plugins.each do |plugin|
         plugin_content = `curl -s -H "#{header}" -L "#{plugins_url}/#{plugin['name']}"`
-        File.open("#{plugins_dir}/#{plugin['name']}", 'w') { |file| file.puts plugin_content }
+        File.open("#{plugins_dir}/#{plugin['name']}", 'w', 0o755) { |file| file.puts plugin_content }
       end
     end
+
+    private def config_file
+      git_config_reader.git_config_file_path
+    end
+
+    private def git_config_reader
+      @git_config_reader ||= GitHelper::GitConfigReader.new
+    end
+
+    private def highline
+      @highline ||= HighlineWrapper.new
+    end
   end
 end

data/lib/git_helper/version.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module GitHelper
-  VERSION = '3.3.0'
+  VERSION = '3.6.6'
 end

data/lib/git_helper.rb

@@ -1,9 +1,12 @@
+# frozen_string_literal: true
+
 require 'yaml'
-require 'gitlab'
-require 'highline'
-require 'octokit'
+require 'json'
+require 'highline_wrapper'
+
+files = "#{File.expand_path(File.join(File.dirname(File.absolute_path(__FILE__)), 'git_helper'))}/**/*.rb"
 
-Dir[File.expand_path(File.join(File.dirname(File.absolute_path(__FILE__)), 'git_helper')) + '/**/*.rb'].each do |file|
+Dir[files].sort.each do |file|
   require_relative file
 end
 

data/renovate.json

@@ -0,0 +1,6 @@
+{
+  "$schema": "https://docs.renovatebot.com/renovate-schema.json",
+  "extends": [
+    "config:base"
+  ]
+}

metadata

@@ -1,29 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: git_helper
 version: !ruby/object:Gem::Version
-  version: 3.3.0
+  version: 3.6.6
 platform: ruby
 authors:
 - Emma Sax
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-02-25 00:00:00.000000000 Z
+date: 2023-08-28 00:00:00.000000000 Z
 dependencies:
-- !ruby/object:Gem::Dependency
-  name: gitlab
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '4.16'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '4.16'
 - !ruby/object:Gem::Dependency
   name: gli
   requirement: !ruby/object:Gem::Requirement
@@ -39,33 +25,19 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '2.13'
 - !ruby/object:Gem::Dependency
-  name: highline
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '2.0'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '2.0'
-- !ruby/object:Gem::Dependency
-  name: octokit
+  name: highline_wrapper
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '4.18'
+        version: '1.1'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '4.18'
+        version: '1.1'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -86,14 +58,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.15'
+        version: '3.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.15'
+        version: '3.0'
 - !ruby/object:Gem::Dependency
   name: guard-rspec
   requirement: !ruby/object:Gem::Requirement
@@ -109,19 +81,19 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '4.3'
 - !ruby/object:Gem::Dependency
-  name: rake
+  name: pry
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '13.0'
+        version: '0.13'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '13.0'
+        version: '0.13'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -136,6 +108,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.9'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
 description: A set of GitHub and GitLab workflow scripts to provide a smoother development
   process for your git projects.
 email:
@@ -147,7 +133,7 @@ files:
 - Gemfile
 - Gemfile.lock
 - Guardfile
-- LICENSE
+- LICENSE.md
 - README.md
 - Rakefile
 - bin/git-helper
@@ -159,36 +145,20 @@ files:
 - lib/git_helper/empty_commit.rb
 - lib/git_helper/forget_local_commits.rb
 - lib/git_helper/git_config_reader.rb
+- lib/git_helper/github_client.rb
 - lib/git_helper/gitlab_client.rb
-- lib/git_helper/highline_cli.rb
 - lib/git_helper/local_code.rb
 - lib/git_helper/merge_request.rb
 - lib/git_helper/new_branch.rb
-- lib/git_helper/octokit_client.rb
 - lib/git_helper/pull_request.rb
 - lib/git_helper/setup.rb
 - lib/git_helper/version.rb
-- plugins.zip
-- spec/git_helper/change_remote_spec.rb
-- spec/git_helper/checkout_default_spec.rb
-- spec/git_helper/clean_branches_spec.rb
-- spec/git_helper/code_request_spec.rb
-- spec/git_helper/empty_commit_spec.rb
-- spec/git_helper/forget_local_commits_spec.rb
-- spec/git_helper/git_config_reader_spec.rb
-- spec/git_helper/gitlab_client_spec.rb
-- spec/git_helper/highline_cli_spec.rb
-- spec/git_helper/local_code_spec.rb
-- spec/git_helper/merge_request_spec.rb
-- spec/git_helper/new_branch_spec.rb
-- spec/git_helper/octokit_client_spec.rb
-- spec/git_helper/pull_request_spec.rb
-- spec/git_helper/setup_spec.rb
-- spec/spec_helper.rb
+- renovate.json
 homepage: https://github.com/emmahsax/git_helper
 licenses:
-- MIT
-metadata: {}
+- BSD-3-Clause
+metadata:
+  rubygems_mfa_required: 'true'
 post_install_message:
 rdoc_options: []
 require_paths:
@@ -197,31 +167,15 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: '2.5'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.3
+rubygems_version: 3.4.12
 signing_key:
 specification_version: 4
-summary: A set of GitHub and GitLab workflow scripts.
-test_files:
-- spec/spec_helper.rb
-- spec/git_helper/change_remote_spec.rb
-- spec/git_helper/checkout_default_spec.rb
-- spec/git_helper/clean_branches_spec.rb
-- spec/git_helper/code_request_spec.rb
-- spec/git_helper/empty_commit_spec.rb
-- spec/git_helper/forget_local_commits_spec.rb
-- spec/git_helper/git_config_reader_spec.rb
-- spec/git_helper/gitlab_client_spec.rb
-- spec/git_helper/highline_cli_spec.rb
-- spec/git_helper/local_code_spec.rb
-- spec/git_helper/merge_request_spec.rb
-- spec/git_helper/new_branch_spec.rb
-- spec/git_helper/octokit_client_spec.rb
-- spec/git_helper/pull_request_spec.rb
-- spec/git_helper/setup_spec.rb
+summary: A set of GitHub and GitLab workflow scripts
+test_files: []

data/LICENSE

@@ -1,22 +0,0 @@
-The MIT License (MIT)
-
-Copyright 2020 Emma Sax
-
-Permission is hereby granted, free of charge, to any person obtaining
-a copy of this software and associated documentation files (the
-"Software"), to deal in the Software without restriction, including
-without limitation the rights to use, copy, modify, merge, publish,
-distribute, sublicense, and/or sell copies of the Software, and to
-permit persons to whom the Software is furnished to do so, subject to
-the following conditions:
-
-The above copyright notice and this permission notice shall be
-included in all copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
-EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
-MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
-NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
-LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
-OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
-WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/lib/git_helper/highline_cli.rb

@@ -1,33 +0,0 @@
-module GitHelper
-  class HighlineCli
-    def ask(prompt)
-      highline_client.ask(prompt) do |conf|
-        conf.readline = true
-      end.to_s
-    end
-
-    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
-
-    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}"
-
-      index = highline_client.ask(compiled_prompt) do |conf|
-        conf.readline = true
-      end.to_i - 1
-
-      choices[index]
-    end
-
-    private def highline_client
-      @highline_client ||= HighLine.new
-    end
-  end
-end