git_helper 3.2.2 → 3.3.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: '0278ec1bcdeffdfc4ff94dcb4853f0d0d9a37c99799d90ab04cb0b59af49d7aa'
-  data.tar.gz: ac395aad1492142aba911277e492eb49dd97345e40f81910eed0692618f973a7
+  metadata.gz: 8dc9aca4ddec9f8038f5083b2790b10ac48b8293de15c37fb8a153b76ca0ce23
+  data.tar.gz: e2be8c7950de2fe93e7b44b0b3c50118dd8bd34494237f435c69cdbc775ef7e9
 SHA512:
-  metadata.gz: 73cedc8f831a0fea6543fe78fa877eeeba394a43c2f5bd038b65d30a71f6830964c40c23dc3aeb0c4056130d1ffe9ceb14c021eb181f2bd3007eaa9c2533e891
-  data.tar.gz: 14d32de16eaf5cd1579464afbaf6c1068514f1cbbaf7c94eeddc3d1fd44b224a94cb93f29f60ec4918d292a7fdde1c326068c0e093848a51dc36f4305599c458
+  metadata.gz: '029e8998214a94ff639bed8faa0a90bf94eca320a7989effab17b845918df911718512f40dd74e563faf347162723fb9e39b9a02ba0b20477183f4eb4b1d1d71'
+  data.tar.gz: ef184720792c6dc8f361674eabdf7e9972e905f2c835b06ecbbe4b952bdd9eab94c42e644663b6be38222688982c8ff2b0fc958a6899b9eb0a2c3ce2afb77547

data/Gemfile

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 source 'https://rubygems.org'
 
 gemspec

data/Gemfile.lock

@@ -0,0 +1,134 @@
+PATH
+  remote: .
+  specs:
+    git_helper (3.3.4)
+      gitlab (~> 4.16)
+      gli (~> 2.13)
+      highline_wrapper (~> 0.1.0)
+      octokit (~> 4.18)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    addressable (2.7.0)
+      public_suffix (>= 2.0.2, < 5.0)
+    ast (2.4.2)
+    coderay (1.1.3)
+    concurrent-ruby (1.1.8)
+    diff-lcs (1.4.4)
+    faker (2.16.0)
+      i18n (>= 1.6, < 2)
+    faraday (1.3.0)
+      faraday-net_http (~> 1.0)
+      multipart-post (>= 1.2, < 3)
+      ruby2_keywords
+    faraday-net_http (1.0.1)
+    ffi (1.14.2)
+    formatador (0.2.5)
+    gitlab (4.17.0)
+      httparty (~> 0.18)
+      terminal-table (~> 1.5, >= 1.5.1)
+    gli (2.20.0)
+    guard (2.16.2)
+      formatador (>= 0.2.4)
+      listen (>= 2.7, < 4.0)
+      lumberjack (>= 1.0.12, < 2.0)
+      nenv (~> 0.1)
+      notiffany (~> 0.0)
+      pry (>= 0.9.12)
+      shellany (~> 0.0)
+      thor (>= 0.18.1)
+    guard-compat (1.2.1)
+    guard-rspec (4.7.3)
+      guard (~> 2.1)
+      guard-compat (~> 1.1)
+      rspec (>= 2.99.0, < 4.0)
+    highline (2.0.3)
+    highline_wrapper (0.1.0)
+      highline (~> 2.0)
+    httparty (0.18.1)
+      mime-types (~> 3.0)
+      multi_xml (>= 0.5.2)
+    i18n (1.8.9)
+      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.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)
+      faraday (>= 0.9)
+      sawyer (~> 0.8.0, >= 0.5.3)
+    parallel (1.20.1)
+    parser (3.0.0.0)
+      ast (~> 2.4.1)
+    pry (0.14.0)
+      coderay (~> 1.1)
+      method_source (~> 1.0)
+    public_suffix (4.0.6)
+    rainbow (3.0.0)
+    rake (13.0.3)
+    rb-fsevent (0.10.4)
+    rb-inotify (0.10.1)
+      ffi (~> 1.0)
+    regexp_parser (2.1.1)
+    rexml (3.2.4)
+    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.10.0)
+    rspec-mocks (3.10.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.10.0)
+    rspec-support (3.10.2)
+    rubocop (1.11.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)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 1.4.0, < 3.0)
+    rubocop-ast (1.4.1)
+      parser (>= 2.7.1.5)
+    ruby-progressbar (1.11.0)
+    ruby2_keywords (0.0.4)
+    sawyer (0.8.2)
+      addressable (>= 2.3.5)
+      faraday (> 0.8, < 2.0)
+    shellany (0.0.1)
+    terminal-table (1.8.0)
+      unicode-display_width (~> 1.1, >= 1.1.1)
+    thor (1.1.0)
+    unicode-display_width (1.7.0)
+
+PLATFORMS
+  x86_64-darwin-20
+
+DEPENDENCIES
+  bundler (~> 2.2)
+  faker (~> 2.15)
+  git_helper!
+  guard-rspec (~> 4.3)
+  pry (~> 0.13)
+  rake (~> 13.0)
+  rspec (~> 3.9)
+  rubocop (~> 1.10)
+
+BUNDLED WITH
+   2.2.4

data/Guardfile

@@ -1,4 +1,6 @@
-guard :rspec, cmd: 'bundle exec rspec', all_on_start: true  do
+# frozen_string_literal: true
+
+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' }

data/README.md

@@ -1,4 +1,4 @@
-# git_helper [![Maintainability](https://api.codeclimate.com/v1/badges/bf27d608257c202930c4/maintainability)](https://codeclimate.com/github/emmahsax/git_helper/maintainability) [![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
 
@@ -27,6 +27,11 @@ To see what version of git_helper you're running, run:
 git-helper --version
 ```
 
+To help you create the `~/.git_helper/config.yml` file and set up the plugins (see below), run this command and allow the command to walk you through the prompts:
+```bash
+git-helper setup
+```
+
 ## Plugin Usage
 
 As an additional option, you can set each of the following commands to be a git plugin, meaning you can call them in a way that feels even more git-native:
@@ -46,7 +51,7 @@ unzip path/to/downloaded/plugins.zip -d ~/.git_helper
 
 Now, the plugins will live in `~/.git_helper/plugins/*`. Add the following line to your `~/.bash_profile`:
 
-```
+```bash
 export PATH=/path/to/computer/home/.git_helper/plugins:$PATH
 ```
 
@@ -110,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:
 
@@ -144,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:
 
@@ -161,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/Rakefile

@@ -1 +1,3 @@
+# frozen_string_literal: true
+
 require 'bundler/gem_tasks'

data/bin/git-helper

@@ -1,4 +1,6 @@
 #!/usr/bin/env ruby
+# frozen_string_literal: true
+
 require 'rubygems'
 require 'gli'
 require_relative '../lib/git_helper'
@@ -11,46 +13,54 @@ version GitHelper::VERSION
 autocomplete_commands false
 wrap_help_text :verbatim
 
-program_long_desc """
+program_long_desc "
 DOCUMENTATION
     For documentation and help in setting up your Git configuration files,
     see Git Helper's GitHub repo: https://github.com/emmahsax/git_helper
-"""
+"
+
+desc 'Sets up Git Helper configs at ~/.git_helper/*'
+command 'setup' do |c|
+  c.action do
+    GitHelper::Setup.new.execute
+  end
+end
 
 arg :old_owner
 arg :new_owner
 desc "Update a repository's remote URLs from an old GitHub owner to a new owner."
 command 'change-remote' do |c|
-  c.action do |global_options, options, args|
+  c.action do |_global_options, _options, args|
     raise ArgumentError, 'You must specify an old owner and a new owner' unless args.count == 2
+
     GitHelper::ChangeRemote.new(args[0], args[1]).execute
   end
 end
 
 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|
+  c.action do |_global_options, _options, _args|
     GitHelper::CheckoutDefault.new.execute
   end
 end
 
 desc "Clean a repository's git branches."
 command 'clean-branches' do |c|
-  c.action do |global_options, options, args|
+  c.action do |_global_options, _options, _args|
     GitHelper::CleanBranches.new.execute
   end
 end
 
 desc 'Creates an empty commit with a basic commit message.'
 command 'empty-commit' do |c|
-  c.action do |global_options, options, args|
+  c.action do |_global_options, _options, _args|
     GitHelper::EmptyCommit.new.execute
   end
 end
 
 desc 'Reset your local git commits to origin/HEAD.'
 command 'forget-local-commits' do |c|
-  c.action do |global_options, options, args|
+  c.action do |_global_options, _options, _args|
     GitHelper::ForgetLocalCommits.new.execute
   end
 end
@@ -58,21 +68,23 @@ end
 arg :new_branch_name, optional: true
 desc 'Create a new branch for features, bug fixes, or experimentation.'
 command 'new-branch' do |c|
-  c.action do |global_options, options, args|
+  c.action do |_global_options, _options, args|
     GitHelper::NewBranch.new.execute(args[0])
   end
 end
 
-desc 'Merge a GitHub/GitLab pull/merge request. The command will figure out whether your code project belongs to GitHub or GitLab.'
+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|
+  c.action do |_global_options, _options, _args|
     GitHelper::CodeRequest.new.merge
   end
 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.'
+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|
+  c.action do |_global_options, _options, _args|
     GitHelper::CodeRequest.new.create
   end
 end

data/lib/git_helper.rb

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

data/lib/git_helper/change_remote.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module GitHelper
   class ChangeRemote
     attr_accessor :old_owner, :new_owner
@@ -11,7 +13,7 @@ module GitHelper
       original_dir = Dir.pwd
       nested_dirs = Dir.entries(original_dir).select do |entry|
         entry_dir = File.join(original_dir, entry)
-        File.directory?(entry_dir) && !(entry == '.' || entry == '..')
+        File.directory?(entry_dir) && !['.', '..'].include?(entry)
       end
 
       nested_dirs.each do |nested_dir|
@@ -22,8 +24,11 @@ module GitHelper
     private def process_dir(current_dir, original_dir)
       Dir.chdir(current_dir)
 
-      if File.exist?('.git')
-        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)")
+      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
 
       Dir.chdir(original_dir)
@@ -37,9 +42,11 @@ module GitHelper
           puts "  Found remote is not pointing to #{old_owner}."
         end
       end
-      puts "\n"
+      puts
     end
 
+    # rubocop:disable Metrics/AbcSize
+    # rubocop:disable Metrics/MethodLength
     private def process_remote(remote)
       remote_name = local_code.remote_name(remote)
 
@@ -56,13 +63,15 @@ module GitHelper
       puts "  Changing the remote URL #{remote_name} to be '#{remote_url}'."
       local_code.change_remote(remote_name, remote_url)
     end
+    # rubocop:enable Metrics/MethodLength
+    # rubocop:enable Metrics/AbcSize
 
     private def local_code
       @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/checkout_default.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module GitHelper
   class CheckoutDefault
     def execute

data/lib/git_helper/clean_branches.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module GitHelper
   class CleanBranches
     def execute

data/lib/git_helper/code_request.rb

@@ -1,10 +1,14 @@
+# frozen_string_literal: true
+
 module GitHelper
   class CodeRequest
     def create
-      process_project.create({
-        base_branch: base_branch,
-        new_title: new_code_request_title
-      })
+      process_project.create(
+        {
+          base_branch: base_branch,
+          new_title: new_code_request_title
+        }
+      )
     end
 
     def merge
@@ -23,8 +27,14 @@ module GitHelper
       end
     end
 
+    # rubocop:disable Metrics/MethodLength
     private def ask_for_clarification
-      resp = cli.ask('Found git remotes for both GitHub and GitLab. Would you like to proceed with GitLab or GitHub? (github/gitlab)').downcase
+      resp = highline.ask(
+        'Found git remotes for both GitHub and GitLab. Would you like to proceed ' \
+        'with GitLab or GitHub? (github/gitlab)',
+        { required: true }
+      ).downcase
+
       if resp.include?('hub')
         github_pull_request
       elsif resp.include?('lab')
@@ -34,6 +44,7 @@ module GitHelper
         exit
       end
     end
+    # rubocop:enable Metrics/MethodLength
 
     private def github_pull_request
       @github_pull_request ||= GitHelper::GitHubPullRequest.new(options)
@@ -48,7 +59,7 @@ module GitHelper
         local_project: local_project,
         local_branch: local_branch,
         local_code: local_code,
-        cli: cli
+        highline: highline
       }
     end
 
@@ -61,11 +72,12 @@ module GitHelper
     end
 
     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)")
-                         default_branch
-                       else
-                         cli.ask('Base branch?')
-                       end
+      @base_branch ||=
+        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?', { required: true })
+        end
     end
 
     private def local_branch
@@ -77,16 +89,18 @@ module GitHelper
     end
 
     private def new_code_request_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.ask('Title?')
-                                  end
+      @new_code_request_title ||=
+        if autogenerated_title && highline.ask_yes_no(
+          "Accept the autogenerated code request title '#{autogenerated_title}'? (y/n)"
+        )
+          autogenerated_title
+        else
+          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