git_helper 3.1.3 → 3.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f85140fd3f9789ce420906994b5918e2fbb1318691829977c5234dbbb6be4867
-  data.tar.gz: 63cf9ee23e0d32e829c738feb4fcc5d195c034cd814e4ed1af109ff10984be6d
+  metadata.gz: be948f58bc902f2e3036bfc3379279afcc74012af9cb56ee1b1f8586ba9c0fa2
+  data.tar.gz: c4f8655fcaef1db1fba03ebb731932da6d185bb89c46ebc366781309b76ebd1d
 SHA512:
-  metadata.gz: e28dcdae4082f67e060fa3aa2f31e600103a6abc50daa8f0b349034aaed9cbdfed0231ed1b9a75374483e2a37753b2482905d82c3150210af8e567ea3e6b2ac4
-  data.tar.gz: 3bc7be22d5bd115e7cd1d565cc0814d181f4ded6826d4aee8e58d0ba05a4d2fb773fbfa2486fab144a05780b60f846bd524ad408758677c9fad4776196931481
+  metadata.gz: d19cf35a128b640a265aa89f229022fd7be3629e6e8ae5f6f08504494b1ccc5231af4ff1e39fbd3014ddb78e8757dd1a9413110872bdd7c8da8ae86525e7776a
+  data.tar.gz: d50eb1904c56c2269c139f7275321eef5516c70de6973fb2b11f8ea0f6681f5db5389f3f629c8b16718a7390442031e4999d8620a3814647b64dae340c01b8d1

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    git_helper (3.1.3)
+    git_helper (3.3.1)
       gitlab (~> 4.16)
       gli (~> 2.13)
       highline (~> 2.0)
@@ -13,14 +13,16 @@ GEM
     addressable (2.7.0)
       public_suffix (>= 2.0.2, < 5.0)
     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)
-    faraday (1.1.0)
+    faraday (1.3.0)
+      faraday-net_http (~> 1.0)
       multipart-post (>= 1.2, < 3)
       ruby2_keywords
-    ffi (1.13.1)
+    faraday-net_http (1.0.1)
+    ffi (1.14.2)
     formatador (0.2.5)
     gitlab (4.17.0)
       httparty (~> 0.18)
@@ -44,9 +46,9 @@ GEM
     httparty (0.18.1)
       mime-types (~> 3.0)
       multi_xml (>= 0.5.2)
-    i18n (1.8.5)
+    i18n (1.8.8)
       concurrent-ruby (~> 1.0)
-    listen (3.3.3)
+    listen (3.4.1)
       rb-fsevent (~> 0.10, >= 0.10.3)
       rb-inotify (~> 0.9, >= 0.9.10)
     lumberjack (1.2.8)
@@ -60,14 +62,14 @@ GEM
     notiffany (0.1.3)
       nenv (~> 0.1)
       shellany (~> 0.0)
-    octokit (4.19.0)
+    octokit (4.20.0)
       faraday (>= 0.9)
       sawyer (~> 0.8.0, >= 0.5.3)
-    pry (0.13.1)
+    pry (0.14.0)
       coderay (~> 1.1)
       method_source (~> 1.0)
     public_suffix (4.0.6)
-    rake (13.0.1)
+    rake (13.0.3)
     rb-fsevent (0.10.4)
     rb-inotify (0.10.1)
       ffi (~> 1.0)
@@ -75,36 +77,35 @@ GEM
       rspec-core (~> 3.10.0)
       rspec-expectations (~> 3.10.0)
       rspec-mocks (~> 3.10.0)
-    rspec-core (3.10.0)
+    rspec-core (3.10.1)
       rspec-support (~> 3.10.0)
-    rspec-expectations (3.10.0)
+    rspec-expectations (3.10.1)
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.10.0)
-    rspec-mocks (3.10.0)
+    rspec-mocks (3.10.2)
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.10.0)
-    rspec-support (3.10.0)
-    ruby2_keywords (0.0.2)
+    rspec-support (3.10.2)
+    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
-  ruby
   x86_64-darwin-19
 
 DEPENDENCIES
   bundler (~> 2.2)
-  faker
+  faker (~> 2.15)
   git_helper!
   guard-rspec (~> 4.3)
   rake (~> 13.0)
   rspec (~> 3.9)
 
 BUNDLED WITH
-   2.2.0
+   2.2.9

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 [![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)
 
 ## 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/bin/git-helper

@@ -14,9 +14,16 @@ wrap_help_text :verbatim
 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."

data/lib/git_helper/change_remote.rb

@@ -23,7 +23,7 @@ module GitHelper
       Dir.chdir(current_dir)
 
       if File.exist?('.git')
-        process_git_repository if cli.process_directory_remotes?(current_dir)
+        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)")
       end
 
       Dir.chdir(original_dir)

data/lib/git_helper/code_request.rb

@@ -24,7 +24,7 @@ module GitHelper
     end
 
     private def ask_for_clarification
-      resp = cli.conflicting_remote_clarification
+      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')
@@ -61,10 +61,10 @@ module GitHelper
     end
 
     private def base_branch
-      @base_branch ||= if cli.base_branch_default?(default_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.base_branch
+                         cli.ask('Base branch?')
                        end
     end
 
@@ -77,10 +77,11 @@ module GitHelper
     end
 
     private def new_code_request_title
-      @new_code_request_title ||= if cli.accept_autogenerated_title?(autogenerated_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.title
+                                    cli.ask('Title?')
                                   end
     end
 

data/lib/git_helper/git_config_reader.rb

@@ -4,18 +4,26 @@ module GitHelper
       config_file[:gitlab_token]
     end
 
+    def gitlab_user
+      config_file[:gitlab_user]
+    end
+
     def github_token
       config_file[:github_token]
     end
 
-    private def config_file
-      YAML.load_file(git_config_file_path)
+    def github_user
+      config_file[:github_user]
     end
 
-    private def git_config_file_path
+    def git_config_file_path
       Dir.pwd.scan(/\A\/[\w]*\/[\w]*\//).first << git_config_file
     end
 
+    private def config_file
+      YAML.load_file(git_config_file_path)
+    end
+
     private def git_config_file
       '.git_helper/config.yml'
     end

data/lib/git_helper/highline_cli.rb

@@ -1,85 +1,29 @@
 module GitHelper
   class HighlineCli
-    def new_branch_name
-      ask('New branch name?')
-    end
-
-    def process_directory_remotes?(directory)
-      answer = ask("Found git directory: #{directory}. Do you wish to proceed in updating #{directory}'s remote URLs? (y/n)")
-      answer.empty? ? true : !!(answer =~ /^y/i)
-    end
-
-    def conflicting_remote_clarification
-      ask('Found git remotes for both GitHub and GitLab. Would you like to proceed with GitLab or GitHub? (github/gitlab)').downcase
-    end
-
-    def title
-      ask('Title?')
-    end
-
-    def base_branch
-      ask('Base branch?')
-    end
-
-    def code_request_id(request_type)
-      ask("#{request_type} Request ID?")
-    end
-
-    def accept_autogenerated_title?(autogenerated_title)
-      return false unless autogenerated_title
-      answer = ask("Accept the autogenerated code request title '#{autogenerated_title}'? (y/n)")
-      answer.empty? ? true : !!(answer =~ /^y/i)
-    end
-
-    def base_branch_default?(default_branch)
-      answer = ask("Is '#{default_branch}' the correct base branch for your new code request? (y/n)")
-      answer.empty? ? true : !!(answer =~ /^y/i)
-    end
-
-    def squash_merge_request?
-      answer = ask('Squash merge request? (y/n)')
-      answer.empty? ? true : !!(answer =~ /^y/i)
-    end
-
-    def remove_source_branch?
-      answer = ask('Remove source branch after merging? (y/n)')
-      answer.empty? ? true : !!(answer =~ /^y/i)
-    end
-
-    def merge_method(merge_options)
-      index = ask_options("Merge method?", merge_options)
-      merge_options[index]
-    end
-
-    def apply_template?(template_file_name, request_type)
-      answer = ask("Apply the #{request_type} request template from #{template_file_name}? (y/n)")
-      answer.empty? ? true : !!(answer =~ /^y/i)
-    end
-
-    def template_to_apply(template_options, request_type)
-      complete_options = template_options << 'None'
-      index = ask_options("Which #{request_type} request template should be applied?", complete_options)
-      complete_options[index]
+    def ask(prompt)
+      highline_client.ask(prompt) do |conf|
+        conf.readline = true
+      end.to_s
     end
 
-    #######################
-    ### GENERAL METHODS ###
-    #######################
-
-    private def ask(prompt)
-      highline_client.ask(prompt) do |conf|
+    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
 
-    private def ask_options(prompt, choices)
+    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}"
 
-      highline_client.ask(compiled_prompt) do |conf|
+      index = highline_client.ask(compiled_prompt) do |conf|
         conf.readline = true
       end.to_i - 1
+
+      choices[index]
     end
 
     private def highline_client

data/lib/git_helper/merge_request.rb

@@ -84,10 +84,10 @@ module GitHelper
 
       unless mr_template_options.empty?
         if mr_template_options.count == 1
-          apply_single_template = cli.apply_template?(mr_template_options.first, 'merge')
+          apply_single_template = cli.ask_yes_no("Apply the merge request template from #{mr_template_options.first}? (y/n)")
           @template_name_to_apply = mr_template_options.first if apply_single_template
         else
-          response = cli.template_to_apply(mr_template_options, 'merge')
+          response = cli.ask_options("Which merge request template should be applied?", mr_template_options << 'None')
           @template_name_to_apply = response unless response == 'None'
         end
       end
@@ -104,15 +104,15 @@ module GitHelper
     end
 
     private def mr_id
-      @mr_id ||= cli.code_request_id('Merge')
+      @mr_id ||= cli.ask('Merge Request ID?')
     end
 
     private def squash_merge_request
-      @squash_merge_request ||= cli.squash_merge_request?
+      @squash_merge_request ||= cli.ask_yes_no('Squash merge request? (y/n)')
     end
 
     private def remove_source_branch
-      @remove_source_branch ||= existing_project.remove_source_branch_after_merge || cli.remove_source_branch?
+      @remove_source_branch ||= existing_project.remove_source_branch_after_merge || cli.ask_yes_no('Remove source branch after merging? (y/n)')
     end
 
     private def existing_project

data/lib/git_helper/new_branch.rb

@@ -1,7 +1,7 @@
 module GitHelper
   class NewBranch
     def execute(new_branch_name = nil)
-      branch_name = new_branch_name || GitHelper::HighlineCli.new.new_branch_name
+      branch_name = new_branch_name || GitHelper::HighlineCli.new.ask('New branch name?')
       puts "Attempting to create a new branch: #{branch_name}"
       GitHelper::LocalCode.new.new_branch(branch_name)
     end

data/lib/git_helper/pull_request.rb

@@ -81,10 +81,10 @@ module GitHelper
 
       unless pr_template_options.empty?
         if pr_template_options.count == 1
-          apply_single_template = cli.apply_template?(pr_template_options.first, 'pull')
+          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.template_to_apply(pr_template_options, 'pull')
+          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
@@ -101,11 +101,11 @@ module GitHelper
     end
 
     private def pr_id
-      @pr_id ||= cli.code_request_id('Pull')
+      @pr_id ||= cli.ask('Pull Request ID?')
     end
 
     private def merge_method
-      @merge_method ||= merge_options.length == 1 ? merge_options.first : cli.merge_method(merge_options)
+      @merge_method ||= merge_options.length == 1 ? merge_options.first : cli.ask_options('Merge method?', merge_options)
     end
 
     private def merge_options

data/lib/git_helper/setup.rb

@@ -0,0 +1,96 @@
+module GitHelper
+  class Setup
+    def execute
+      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
+      else
+        answer = true
+      end
+
+      create_or_update_config_file if answer
+
+      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)"
+      )
+
+      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
+    end
+
+    private def create_or_update_config_file
+      contents = generate_file_contents
+      puts "\nCreating or updating your #{config_file} file..."
+      File.open(config_file, 'w') { |file| file.puts contents }
+      puts "\nDone!\n\n"
+    end
+
+    private def config_file_exists?
+      File.exists?(config_file)
+    end
+
+    private def generate_file_contents
+      file_contents = ''
+
+      if highline.ask_yes_no("Do you wish to set up GitHub credentials? (y/n)")
+        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"
+      end
+
+      if highline.ask_yes_no("\nDo you wish to set up GitLab credentials? (y/n)")
+        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"
+      end
+
+      file_contents.strip
+    end
+
+    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 create_or_update_plugin_files
+      plugins_dir = "#{Dir.pwd.scan(/\A\/[\w]*\/[\w]*\//).first}/.git_helper/plugins"
+      plugins_url = 'https://api.github.com/repos/emmahsax/git_helper/contents/plugins'
+      header = 'Accept: application/vnd.github.v3.raw'
+      token = git_config_reader.github_token
+      user = git_config_reader.github_user
+
+      Dir.mkdir(plugins_dir) unless File.exists?(plugins_dir)
+
+      all_plugins = JSON.parse(`curl -s -u #{user}:#{token} -H "#{header}" -L "#{plugins_url}"`)
+
+      all_plugins.each do |plugin|
+        plugin_content = `curl -s -u #{user}:#{token} -H "#{header}" -L "#{plugins_url}/#{plugin['name']}"`
+        File.open("#{plugins_dir}/#{plugin['name']}", 'w') { |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 ||= GitHelper::HighlineCli.new
+    end
+  end
+end