git_helper 3.3.0 → 3.3.5

data/lib/git_helper/setup.rb

@@ -1,87 +1,116 @@
+# 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) (This process will ' \
+        'attempt to use your GitHub personal access token to authenticate)',
+        { 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 ~/.bash_profile:\n" \
+            '  export PATH=/path/to/computer/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..."
       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
 
+    # rubocop:disable Metrics/MethodLength
+    # rubocop:disable Metrics/AbcSize
     private def create_or_update_plugin_files
-      plugins_dir = "#{Dir.pwd.scan(/\A\/[\w]*\/[\w]*\//).first}/.git_helper/plugins"
+      plugins_dir = "#{Dir.pwd.scan(%r{\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)
+      Dir.mkdir(plugins_dir) unless File.exist?(plugins_dir)
 
-      all_plugins = JSON.parse(`curl -s -H "#{header}" -L "#{plugins_url}"`)
+      all_plugins = JSON.parse(`curl -s -u #{user}:#{token} -H "#{header}" -L "#{plugins_url}"`)
 
       all_plugins.each do |plugin|
-        plugin_content = `curl -s -H "#{header}" -L "#{plugins_url}/#{plugin['name']}"`
+        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
+    # rubocop:enable Metrics/MethodLength
+    # rubocop:enable Metrics/AbcSize
+
+    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.3.5'
 end

data/spec/git_helper/change_remote_spec.rb

@@ -1,30 +1,31 @@
+# frozen_string_literal: true
+
 require 'spec_helper'
 require 'git_helper'
 
 describe GitHelper::ChangeRemote do
   let(:remote1) { "git@github.com:#{old_owner}/#{project}.git" }
   let(:project) { Faker::Lorem.word }
-  let(:cli) { double(:highline_cli, ask_yes_no: true) }
+  let(:highline_wrapper) { double(:highline_wrapper, ask_yes_no: true) }
   let(:old_owner) { Faker::Internet.username }
   let(:new_owner) { Faker::Internet.username }
-  let(:directory_entries) { [ '.', '..', project, Faker::Lorem.word, Faker::Lorem.word ] }
+  let(:directory_entries) { ['.', '..', project, Faker::Lorem.word, Faker::Lorem.word] }
 
   let(:local_code) do
     double(:local_code,
-      remotes: [remote1],
-      remote_name: Faker::Lorem.word,
-      ssh_remote?: true,
-      https_remote?: false,
-      remote_project: project,
-      remote_source: 'github.com',
-      change_remote: true
-    )
+           remotes: [remote1],
+           remote_name: Faker::Lorem.word,
+           ssh_remote?: true,
+           https_remote?: false,
+           remote_project: project,
+           remote_source: 'github.com',
+           change_remote: true)
   end
 
   subject { GitHelper::ChangeRemote.new(old_owner, new_owner) }
 
   before do
-    allow(GitHelper::HighlineCli).to receive(:new).and_return(cli)
+    allow(HighlineWrapper).to receive(:new).and_return(highline_wrapper)
     allow(GitHelper::LocalCode).to receive(:new).and_return(local_code)
     allow(subject).to receive(:puts)
   end
@@ -73,7 +74,7 @@ describe GitHelper::ChangeRemote do
     end
 
     context 'when the user says not to process the directory' do
-      let(:cli) { double(:highline_cli, ask_yes_no: false) }
+      let(:highline_wrapper) { double(:highline_wrapper, ask_yes_no: false) }
 
       it 'should not call to process the directory' do
         expect(subject).not_to receive(:process_git_repository)
@@ -138,14 +139,13 @@ describe GitHelper::ChangeRemote do
     context 'https remote' do
       let(:local_code) do
         double(:local_code,
-          remotes: [remote1],
-          remote_name: Faker::Lorem.word,
-          ssh_remote?: false,
-          https_remote?: false,
-          remote_project: project,
-          remote_source: 'github.com',
-          change_remote: true
-        )
+               remotes: [remote1],
+               remote_name: Faker::Lorem.word,
+               ssh_remote?: false,
+               https_remote?: false,
+               remote_project: project,
+               remote_source: 'github.com',
+               change_remote: true)
       end
 
       it 'should ask if the remote is SSH' do
@@ -167,10 +167,10 @@ describe GitHelper::ChangeRemote do
     end
   end
 
-  describe '#cli' do
-    it 'should create a new highline CLI instance' do
-      expect(GitHelper::HighlineCli).to receive(:new)
-      subject.send(:cli)
+  describe '#highline' do
+    it 'should create a new highline_wrapper instance' do
+      expect(HighlineWrapper).to receive(:new)
+      subject.send(:highline)
     end
   end
 end

data/spec/git_helper/checkout_default_spec.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'spec_helper'
 require 'git_helper'
 

data/spec/git_helper/clean_branches_spec.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'spec_helper'
 require 'git_helper'
 

data/spec/git_helper/code_request_spec.rb

@@ -1,8 +1,10 @@
+# frozen_string_literal: true
+
 require 'spec_helper'
 require 'git_helper'
 
 describe GitHelper::CodeRequest do
-  let(:highline_cli) { double(:highline_cli) }
+  let(:highline_wrapper) { double(:highline_wrapper) }
   let(:local_code) { double(:local_code, project_name: Faker::Lorem.word, branch: Faker::Lorem.word) }
   let(:process_project) { double(:process_project, create: :created, merge: :merged) }
   let(:base_branch) { Faker::Lorem.word }
@@ -12,7 +14,7 @@ describe GitHelper::CodeRequest do
 
   before do
     allow(GitHelper::LocalCode).to receive(:new).and_return(local_code)
-    allow(GitHelper::HighlineCli).to receive(:new).and_return(highline_cli)
+    allow(HighlineWrapper).to receive(:new).and_return(highline_wrapper)
     allow(subject).to receive(:puts)
   end
 
@@ -101,19 +103,19 @@ describe GitHelper::CodeRequest do
 
   describe '#ask_for_clarification' do
     it 'should ask the CLI' do
-      expect(highline_cli).to receive(:ask).and_return('github')
+      expect(highline_wrapper).to receive(:ask).and_return('github')
       subject.send(:ask_for_clarification)
     end
 
     context 'when response is github' do
       it 'should return github_pull_request' do
-        allow(highline_cli).to receive(:ask).and_return('github')
+        allow(highline_wrapper).to receive(:ask).and_return('github')
         expect(subject).to receive(:github_pull_request)
         subject.send(:ask_for_clarification)
       end
 
       it 'should return github_pull_request' do
-        allow(highline_cli).to receive(:ask).and_return('Github')
+        allow(highline_wrapper).to receive(:ask).and_return('Github')
         expect(subject).to receive(:github_pull_request)
         subject.send(:ask_for_clarification)
       end
@@ -121,13 +123,13 @@ describe GitHelper::CodeRequest do
 
     context 'when response is gitlab' do
       it 'should return gitlab_merge_request' do
-        allow(highline_cli).to receive(:ask).and_return('gitlab')
+        allow(highline_wrapper).to receive(:ask).and_return('gitlab')
         expect(subject).to receive(:gitlab_merge_request)
         subject.send(:ask_for_clarification)
       end
 
       it 'should return gitlab_merge_request' do
-        allow(highline_cli).to receive(:ask).and_return('Gitlab')
+        allow(highline_wrapper).to receive(:ask).and_return('Gitlab')
         expect(subject).to receive(:gitlab_merge_request)
         subject.send(:ask_for_clarification)
       end
@@ -136,7 +138,7 @@ describe GitHelper::CodeRequest do
     # Unfortunately this test sometimes fails... just rerun the tests if it does
     context 'when response is neither' do
       it 'should raise an error' do
-        allow(highline_cli).to receive(:ask).and_return(Faker::Lorem.word)
+        allow(highline_wrapper).to receive(:ask).and_return(Faker::Lorem.word)
         expect(subject).to receive(:exit)
         subject.send(:ask_for_clarification)
       end
@@ -174,23 +176,23 @@ describe GitHelper::CodeRequest do
   describe '#base_branch' do
     it 'should call the default branch' do
       expect(subject).to receive(:default_branch)
-      allow(highline_cli).to receive(:ask_yes_no).at_least(:once)
-      allow(highline_cli).to receive(:ask).at_least(:once).and_return(base_branch)
+      allow(highline_wrapper).to receive(:ask_yes_no).at_least(:once)
+      allow(highline_wrapper).to receive(:ask).at_least(:once).and_return(base_branch)
       subject.send(:base_branch)
     end
 
     it 'should ask the CLI to ask the user' do
       allow(subject).to receive(:default_branch)
-      expect(highline_cli).to receive(:ask_yes_no).at_least(:once)
-      allow(highline_cli).to receive(:ask).at_least(:once).and_return(base_branch)
+      expect(highline_wrapper).to receive(:ask_yes_no).at_least(:once)
+      allow(highline_wrapper).to receive(:ask).at_least(:once).and_return(base_branch)
       subject.send(:base_branch)
     end
 
     context 'if the user says no' do
       it 'definitely asks for the users base branch' do
         allow(subject).to receive(:default_branch)
-        expect(highline_cli).to receive(:ask_yes_no).at_least(:once).and_return(false)
-        expect(highline_cli).to receive(:ask).at_least(:once).and_return(base_branch)
+        expect(highline_wrapper).to receive(:ask_yes_no).at_least(:once).and_return(false)
+        expect(highline_wrapper).to receive(:ask).at_least(:once).and_return(base_branch)
         subject.send(:base_branch)
       end
     end
@@ -198,8 +200,8 @@ describe GitHelper::CodeRequest do
     context 'if the user says yes' do
       it 'does not ask for the users base branch' do
         allow(subject).to receive(:default_branch)
-        expect(highline_cli).to receive(:ask_yes_no).at_least(:once).and_return(true)
-        expect(highline_cli).not_to receive(:base_branch)
+        expect(highline_wrapper).to receive(:ask_yes_no).at_least(:once).and_return(true)
+        expect(highline_wrapper).not_to receive(:base_branch)
         subject.send(:base_branch)
       end
     end
@@ -216,23 +218,23 @@ describe GitHelper::CodeRequest do
   describe '#new_code_request_title' do
     it 'should call autogenerated title method' do
       expect(subject).to receive(:autogenerated_title)
-      allow(highline_cli).to receive(:ask_yes_no).at_least(:once)
-      allow(highline_cli).to receive(:ask).at_least(:once).and_return(title)
+      allow(highline_wrapper).to receive(:ask_yes_no).at_least(:once)
+      allow(highline_wrapper).to receive(:ask).at_least(:once).and_return(title)
       subject.send(:new_code_request_title)
     end
 
     it 'should ask the CLI to ask the user' do
       allow(subject).to receive(:autogenerated_title).and_return(Faker::Lorem.sentence)
-      expect(highline_cli).to receive(:ask_yes_no).at_least(:once)
-      allow(highline_cli).to receive(:ask).at_least(:once).and_return(title)
+      expect(highline_wrapper).to receive(:ask_yes_no).at_least(:once)
+      allow(highline_wrapper).to receive(:ask).at_least(:once).and_return(title)
       subject.send(:new_code_request_title)
     end
 
     context 'if the user says no' do
       it 'definitely asks for the users title' do
         allow(subject).to receive(:autogenerated_title).and_return(Faker::Lorem.sentence)
-        expect(highline_cli).to receive(:ask_yes_no).at_least(:once).and_return(false)
-        expect(highline_cli).to receive(:ask).at_least(:once).and_return(title)
+        expect(highline_wrapper).to receive(:ask_yes_no).at_least(:once).and_return(false)
+        expect(highline_wrapper).to receive(:ask).at_least(:once).and_return(title)
         subject.send(:new_code_request_title)
       end
     end
@@ -240,8 +242,8 @@ describe GitHelper::CodeRequest do
     context 'if the user says yes to original title' do
       it 'does not ask for the users chosen title' do
         allow(subject).to receive(:autogenerated_title).and_return(Faker::Lorem.sentence)
-        expect(highline_cli).to receive(:ask_yes_no).at_least(:once).and_return(true)
-        expect(highline_cli).not_to receive(:ask)
+        expect(highline_wrapper).to receive(:ask_yes_no).at_least(:once).and_return(true)
+        expect(highline_wrapper).not_to receive(:ask)
         subject.send(:new_code_request_title)
       end
     end
@@ -254,10 +256,10 @@ describe GitHelper::CodeRequest do
     end
   end
 
-  describe '#cli' do
-    it 'should call the octokit client' do
-      expect(GitHelper::HighlineCli).to receive(:new).and_return(highline_cli)
-      subject.send(:cli)
+  describe '#highline' do
+    it 'should create a highline_wrapper client' do
+      expect(HighlineWrapper).to receive(:new).and_return(highline_wrapper)
+      subject.send(:highline)
     end
   end
 end

data/spec/git_helper/empty_commit_spec.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'spec_helper'
 require 'git_helper'
 

data/spec/git_helper/forget_local_commits_spec.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'spec_helper'
 require 'git_helper'
 

data/spec/git_helper/git_config_reader_spec.rb

@@ -1,18 +1,22 @@
+# frozen_string_literal: true
+
 require 'spec_helper'
 require 'git_helper'
 
 describe GitHelper::GitConfigReader do
+  let(:github_user) { Faker::Internet.username }
   let(:github_token) { Faker::Internet.password(max_length: 10) }
+  let(:gitlab_user) { Faker::Internet.username }
   let(:gitlab_token) { Faker::Internet.password(max_length: 10) }
 
-  let(:config_file) {
+  let(:config_file) do
     {
-      github_user: Faker::Internet.username,
+      github_user: github_user,
       github_token: github_token,
-      gitlab_user: Faker::Internet.username,
+      gitlab_user: gitlab_user,
       gitlab_token: gitlab_token
     }
-  }
+  end
 
   subject { GitHelper::GitConfigReader.new }
 
@@ -40,6 +44,30 @@ describe GitHelper::GitConfigReader do
     end
   end
 
+  describe '#github_user' do
+    it 'should locate the github_user' do
+      expect(subject).to receive(:config_file).and_return(config_file)
+      expect(subject.github_user).to eq(github_user)
+    end
+
+    it 'should call the config file' do
+      expect(subject).to receive(:config_file).and_return(config_file)
+      subject.github_user
+    end
+  end
+
+  describe '#gitlab_user' do
+    it 'should locate the gitlab_user' do
+      expect(subject).to receive(:config_file).and_return(config_file)
+      expect(subject.gitlab_user).to eq(gitlab_user)
+    end
+
+    it 'should call the config file' do
+      expect(subject).to receive(:config_file).and_return(config_file)
+      subject.gitlab_user
+    end
+  end
+
   describe '#config_file' do
     it 'should yaml load the file path' do
       expect(YAML).to receive(:load_file)