git_helper 3.2.1 → 3.3.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b3f63c9e4283a7e005a3f6ca7f29e7721e474ec06ebebecd1dcda8f63f841450
-  data.tar.gz: 2ec89ecd8513c12f9434aa9c03f7568522b84d3c282e62e09670aa15a63fef95
+  metadata.gz: e7e2fb7b1199964740a0d73091815fb81469b492a3de04adc16aea30ba794e79
+  data.tar.gz: 80abd21099775a4829c1e72accb74f7f91ae6e9f5e536cfd0468879065de06ff
 SHA512:
-  metadata.gz: bce1b9c25dc1ad30c8434a0e252bdc95f8864fcd29e2c02e712dffb4fe63aaa063fa6a72d9cc27a91c06784758fd6499f9aaa21f62ea57d7b7b81522558112a4
-  data.tar.gz: 572c484112dbdcfbb2da9ad8c25add8fd56baa3c652931715a46d9355780e3535e226afc3a83d2f57a6815f78df6fba7c8f47e97990801608bb9653ef3c961c2
+  metadata.gz: 5fdabeaa00c72c8f58e00bce3f054949ad1061dbbb132661d06caf788ca827b486d44c20d57213582c2eb7b9c8db28ac88636b5e4562366010c33cc6056c526c
+  data.tar.gz: '08eee4e6e95562f500c93df42f72a713b43ece4d39c96013d5313612f13bf33dc4b7dcd5ca6de243d3bba360af8d8bc183d6c5f2a8600d9692de2afa3bf7c675'

data/Gemfile

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

data/Gemfile.lock

@@ -1,10 +1,10 @@
 PATH
   remote: .
   specs:
-    git_helper (3.2.0)
+    git_helper (3.3.2)
       gitlab (~> 4.16)
       gli (~> 2.13)
-      highline (~> 2.0)
+      highline_wrapper (~> 0.1.0)
       octokit (~> 4.18)
 
 GEM
@@ -12,8 +12,9 @@ GEM
   specs:
     addressable (2.7.0)
       public_suffix (>= 2.0.2, < 5.0)
+    ast (2.4.2)
     coderay (1.1.3)
-    concurrent-ruby (1.1.7)
+    concurrent-ruby (1.1.8)
     diff-lcs (1.4.4)
     faker (2.15.1)
       i18n (>= 1.6, < 2)
@@ -21,13 +22,13 @@ GEM
       faraday-net_http (~> 1.0)
       multipart-post (>= 1.2, < 3)
       ruby2_keywords
-    faraday-net_http (1.0.0)
+    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.19.2)
+    gli (2.20.0)
     guard (2.16.2)
       formatador (>= 0.2.4)
       listen (>= 2.7, < 4.0)
@@ -43,10 +44,12 @@ GEM
       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.7)
+    i18n (1.8.8)
       concurrent-ruby (~> 1.0)
     listen (3.4.1)
       rb-fsevent (~> 0.10, >= 0.10.3)
@@ -55,7 +58,7 @@ GEM
     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)
@@ -65,14 +68,20 @@ GEM
     octokit (4.20.0)
       faraday (>= 0.9)
       sawyer (~> 0.8.0, >= 0.5.3)
-    pry (0.13.1)
+    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)
@@ -82,18 +91,30 @@ GEM
     rspec-expectations (3.10.1)
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.10.0)
-    rspec-mocks (3.10.1)
+    rspec-mocks (3.10.2)
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.10.0)
-    rspec-support (3.10.1)
-    ruby2_keywords (0.0.2)
+    rspec-support (3.10.2)
+    rubocop (1.10.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.0.1)
+    thor (1.1.0)
     unicode-display_width (1.7.0)
 
 PLATFORMS
@@ -104,8 +125,10 @@ DEPENDENCIES
   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
+   2.2.9

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/d53da11f17c38cc81b5b/maintainability)](https://codeclimate.com/github/emmasax4/git_helper/maintainability) ![Default](https://github.com/emmasax4/git_helper/workflows/Default/badge.svg)
+# 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
 ```
 
@@ -70,7 +75,7 @@ alias gnb="git new-branch"
 
 And then, running `gnb` maps to `git new-branch`, which again routes to `git-helper new-branch`.
 
-For a full list of the git aliases I prefer to use, check out my [Git Aliases gist](https://gist.github.com/emmasax4/e8744fe253fba1f00a621c01a2bf68f5).
+For a full list of the git aliases I prefer to use, check out my [Git Aliases gist](https://gist.github.com/emmahsax/e8744fe253fba1f00a621c01a2bf68f5).
 
 If you're going to make using git workflows easier, might as well provide lots of options 😃.
 
@@ -173,9 +178,9 @@ The command either accepts a branch name right away or it will ask you for the n
 
 ## Contributing
 
-To submit a feature request, bug ticket, etc, please submit an official [GitHub Issue](https://github.com/emmasax4/git_helper/issues/new).
+To submit a feature request, bug ticket, etc, please submit an official [GitHub Issue](https://github.com/emmahsax/git_helper/issues/new).
 
-To report any security vulnerabilities, please view this project's [Security Policy](https://github.com/emmasax4/git_helper/security/policy).
+To report any security vulnerabilities, please view this project's [Security Policy](https://github.com/emmahsax/git_helper/security/policy).
 
 When interacting with this repository, please follow [Contributor Covenant's Code of Conduct](https://contributor-covenant.org).
 
@@ -185,7 +190,7 @@ To make a new release of this gem:
 
 1. Merge the pull request via the big green button
 2. Run `git tag vX.X.X` and `git push --tag`
-3. Make a new release [here](https://github.com/emmasax4/git_helper/releases/new)
+3. Make a new release [here](https://github.com/emmahsax/git_helper/releases/new)
 4. Run `gem build *.gemspec`
 5. Run `gem push *.gem` to push the new gem to RubyGems
 6. Run `rm *.gem` to clean up your local repository

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/emmasax4/git_helper
-"""
+    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,10 @@ 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)"
+      )
+        process_git_repository
       end
 
       Dir.chdir(original_dir)
@@ -40,6 +44,8 @@ module GitHelper
       puts "\n"
     end
 
+    # rubocop:disable Metrics/AbcSize
+    # rubocop:disable Metrics/MethodLength
     private def process_remote(remote)
       remote_name = local_code.remote_name(remote)
 
@@ -56,13 +62,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,13 @@ 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)'
+      ).downcase
+
       if resp.include?('hub')
         github_pull_request
       elsif resp.include?('lab')
@@ -34,6 +43,7 @@ module GitHelper
         exit
       end
     end
+    # rubocop:enable Metrics/MethodLength
 
     private def github_pull_request
       @github_pull_request ||= GitHelper::GitHubPullRequest.new(options)
@@ -48,7 +58,7 @@ module GitHelper
         local_project: local_project,
         local_branch: local_branch,
         local_code: local_code,
-        cli: cli
+        highline: highline
       }
     end
 
@@ -61,11 +71,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?')
+        end
     end
 
     private def local_branch
@@ -77,16 +88,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?')
+        end
     end
 
-    private def cli
-      @cli ||= GitHelper::HighlineCli.new
+    private def highline
+      @highline ||= HighlineWrapper.new
     end
 
     private def local_code