git_helper 3.3.1 → 3.3.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: be948f58bc902f2e3036bfc3379279afcc74012af9cb56ee1b1f8586ba9c0fa2
-  data.tar.gz: c4f8655fcaef1db1fba03ebb731932da6d185bb89c46ebc366781309b76ebd1d
+  metadata.gz: '02607381872b87e3390ddfe00db3a66da5b72698943abfc7af1fb556b69bc5fd'
+  data.tar.gz: 85ef4555a8f0be75248dc20895a62d3e7660276154c4cee638faceb7f0ff701a
 SHA512:
-  metadata.gz: d19cf35a128b640a265aa89f229022fd7be3629e6e8ae5f6f08504494b1ccc5231af4ff1e39fbd3014ddb78e8757dd1a9413110872bdd7c8da8ae86525e7776a
-  data.tar.gz: d50eb1904c56c2269c139f7275321eef5516c70de6973fb2b11f8ea0f6681f5db5389f3f629c8b16718a7390442031e4999d8620a3814647b64dae340c01b8d1
+  metadata.gz: 354f303f75c86aefa64b8af4378e0006aab40b322ad5fa5b3f18018e45625d5f0e2d57c5a2f6ff8eb5e38d60863f995ac55fdecfe995d922dfff0d5dc3db4a52
+  data.tar.gz: 2a946bf13c0b36ebe71ca352623aeb6c509a3a3ee2c565ed1e433380713afacd08fddfd69626ca22a88225a65f0f7f5d093f5bf25b58c3cbc2121ebf70d9529b

data/Gemfile

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

data/Gemfile.lock

@@ -12,6 +12,7 @@ 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.8)
     diff-lcs (1.4.4)
@@ -65,14 +66,20 @@ GEM
     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)
@@ -86,6 +93,18 @@ GEM
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.10.0)
     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)
@@ -106,6 +125,7 @@ DEPENDENCIES
   guard-rspec (~> 4.3)
   rake (~> 13.0)
   rspec (~> 3.9)
+  rubocop
 
 BUNDLED WITH
    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/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
 

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,15 +13,15 @@ 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 ||
+  c.action do
     GitHelper::Setup.new.execute
   end
 end
@@ -28,36 +30,37 @@ 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
@@ -65,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 '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') && cli.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,6 +62,8 @@ 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

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 = cli.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)
@@ -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 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
     end
 
     private def local_branch
@@ -77,12 +88,14 @@ 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 && cli.ask_yes_no(
+          "Accept the autogenerated code request title '#{autogenerated_title}'? (y/n)"
+        )
+          autogenerated_title
+        else
+          cli.ask('Title?')
+        end
     end
 
     private def cli

data/lib/git_helper/empty_commit.rb

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

data/lib/git_helper/forget_local_commits.rb

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

data/lib/git_helper/git_config_reader.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module GitHelper
   class GitConfigReader
     def gitlab_token
@@ -17,15 +19,11 @@ module GitHelper
     end
 
     def git_config_file_path
-      Dir.pwd.scan(/\A\/[\w]*\/[\w]*\//).first << git_config_file
+      "#{Dir.pwd.scan(%r{\A/\w*/\w*/}).first}.git_helper/config.yml"
     end
 
     private def config_file
       YAML.load_file(git_config_file_path)
     end
-
-    private def git_config_file
-      '.git_helper/config.yml'
-    end
   end
 end

data/lib/git_helper/gitlab_client.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module GitHelper
   class GitLabClient
     def client

data/lib/git_helper/highline_cli.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module GitHelper
   class HighlineCli
     def ask(prompt)
@@ -15,7 +17,7 @@ module GitHelper
     end
 
     def ask_options(prompt, choices)
-      choices_as_string_options = ''
+      choices_as_string_options = ''.dup
       choices.each { |choice| choices_as_string_options << "#{choices.index(choice) + 1}. #{choice}\n" }
       compiled_prompt = "#{prompt}\n#{choices_as_string_options.strip}"
 

data/lib/git_helper/local_code.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module GitHelper
   class LocalCode
     def checkout_default
@@ -44,20 +46,20 @@ module GitHelper
     end
 
     def https_remote?(remote)
-      remote.scan(/(https:\/\/)/).any?
+      remote.scan(%r{(https://)}).any?
     end
 
     def remote_project(remote)
       if https_remote?(remote)
-        remote.scan(/https:\/\/[\S]+\/([\S]*).git/).first.first
+        remote.scan(%r{https://\S+/(\S*).git}).first.first
       elsif ssh_remote?(remote)
-        remote.scan(/\/([\S]*).git/).first.first
+        remote.scan(%r{/(\S*).git}).first.first
       end
     end
 
     def remote_source(remote)
       if https_remote?(remote)
-        remote.scan(/https:\/\/([a-zA-z.]+)\//).first.first
+        remote.scan(%r{https://([a-zA-z.]+)/}).first.first
       elsif ssh_remote?(remote)
         remote.scan(/git@([a-zA-z.]+):/).first.first
       end
@@ -73,18 +75,20 @@ module GitHelper
 
     def project_name
       # Get the repo/project name by looking in the remote URLs for the full name
-      `git remote -v`.scan(/\S[\s]*[\S]+.com[\S]{1}([\S]*).git/).first.first
+      `git remote -v`.scan(/\S\s*\S+.com\S{1}(\S*).git/).first.first
     end
 
     def branch
       # Get the current branch by looking in the list of branches for the *
-      `git branch`.scan(/\*\s([\S]*)/).first.first
+      `git branch`.scan(/\*\s(\S*)/).first.first
     end
 
     def default_branch
       `git symbolic-ref refs/remotes/origin/HEAD | sed "s@^refs/remotes/origin/@@" | tr -d "\n"`
     end
 
+    # rubocop:disable Metrics/AbcSize
+    # rubocop:disable Metrics/MethodLength
     def template_options(identifiers)
       nested_templates = Dir.glob(
         File.join("#{identifiers[:template_directory]}/#{identifiers[:nested_directory_name]}", '*.md'),
@@ -100,11 +104,15 @@ module GitHelper
       )
       nested_templates.concat(non_nested_templates).concat(root_templates).uniq
     end
+    # rubocop:enable Metrics/MethodLength
+    # rubocop:enable Metrics/AbcSize
 
     def read_template(file_name)
       File.open(file_name).read
     end
 
+    # rubocop:disable Metrics/AbcSize
+    # rubocop:disable Metrics/MethodLength
     def generate_title(local_branch)
       branch_arr = local_branch.split(local_branch.include?('_') ? '_' : '-')
 
@@ -112,11 +120,11 @@ module GitHelper
 
       if branch_arr.length == 1
         branch_arr.first.capitalize
-      elsif branch_arr[0].scan(/([\w]+)/).any? && branch_arr[1].scan(/([\d]+)/).any? # branch includes jira_123 at beginning
+      elsif branch_arr[0].scan(/(\w+)/).any? && branch_arr[1].scan(/(\d+)/).any? # branch includes jira_123 at beginning
         issue = "#{branch_arr[0].upcase}-#{branch_arr[1]}"
         description = branch_arr[2..-1].join(' ')
         "#{issue} #{description.capitalize}"
-      elsif branch_arr[0].scan(/([\w]+-[\d]+)/).any? # branch includes string jira-123 at beginning
+      elsif branch_arr[0].scan(/(\w+-\d+)/).any? # branch includes string jira-123 at beginning
         issue = branch_arr[0].upcase
         description = branch_arr[1..-1].join(' ')
         "#{issue} #{description.capitalize}"
@@ -124,5 +132,7 @@ module GitHelper
         branch_arr[0..-1].join(' ').capitalize
       end
     end
+    # rubocop:enable Metrics/MethodLength
+    # rubocop:enable Metrics/AbcSize
   end
 end