git_helper 3.2.2 → 3.3.4

data/spec/git_helper/gitlab_client_spec.rb

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

data/spec/git_helper/local_code_spec.rb

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

data/spec/git_helper/merge_request_spec.rb

@@ -1,19 +1,20 @@
+# frozen_string_literal: true
+
 require 'spec_helper'
 require 'git_helper'
 
 describe GitHelper::GitLabMergeRequest do
   let(:local_code) { double(:local_code, read_template: Faker::Lorem.word) }
-  let(:highline_cli) { double(:highline_cli) }
+  let(:highline_wrapper) { double(:highline_wrapper) }
   let(:gitlab_client_client) { double(:gitlab_client_client, project: :project, merge_request: :merge_request, create_merge_request: :created) }
   let(:gitlab_client) { double(:gitlab_client, client: gitlab_client_client) }
   let(:diff_refs) { double(:diff_refs, base_sha: :base, head_sha: :head) }
 
   let(:merge_request) do
     double(:merge_request,
-      diff_refs: diff_refs,
-      web_url: Faker::Internet.url,
-      merge_commit_sha: Faker::Internet.password
-    )
+           diff_refs: diff_refs,
+           web_url: Faker::Internet.url,
+           merge_commit_sha: Faker::Internet.password)
   end
 
   let(:options) do
@@ -21,7 +22,7 @@ describe GitHelper::GitLabMergeRequest do
       local_project: Faker::Lorem.word,
       local_branch: Faker::Lorem.word,
       local_code: local_code,
-      cli: highline_cli
+      highline: highline_wrapper
     }
   end
 
@@ -38,7 +39,7 @@ describe GitHelper::GitLabMergeRequest do
       allow(subject).to receive(:remove_source_branch).and_return(false)
       allow(subject).to receive(:new_mr_body).and_return('')
       expect(gitlab_client_client).to receive(:create_merge_request).and_return(merge_request)
-      subject.create({base_branch: Faker::Lorem.word, new_title: Faker::Lorem.word})
+      subject.create({ base_branch: Faker::Lorem.word, new_title: Faker::Lorem.word })
     end
 
     it 'should call various other methods' do
@@ -46,7 +47,7 @@ describe GitHelper::GitLabMergeRequest do
       expect(subject).to receive(:remove_source_branch).and_return(false)
       expect(subject).to receive(:new_mr_body).and_return('')
       allow(gitlab_client_client).to receive(:create_merge_request).and_return(merge_request)
-      subject.create({base_branch: Faker::Lorem.word, new_title: Faker::Lorem.word})
+      subject.create({ base_branch: Faker::Lorem.word, new_title: Faker::Lorem.word })
     end
 
     it 'should catch the raised error if the creation does not work' do
@@ -54,7 +55,7 @@ describe GitHelper::GitLabMergeRequest do
       allow(subject).to receive(:remove_source_branch).and_return(false)
       allow(subject).to receive(:new_mr_body).and_return('')
       allow(gitlab_client_client).to receive(:create_merge_request).and_raise(StandardError)
-      expect(subject.create({base_branch: Faker::Lorem.word, new_title: Faker::Lorem.word})).to eq(nil)
+      expect(subject.create({ base_branch: Faker::Lorem.word, new_title: Faker::Lorem.word })).to eq(nil)
     end
   end
 
@@ -120,19 +121,19 @@ describe GitHelper::GitLabMergeRequest do
 
       it 'should call the CLI to ask about a single template' do
         allow(subject).to receive(:mr_template_options).and_return([template])
-        expect(highline_cli).to receive(:ask_yes_no).and_return(true)
+        expect(highline_wrapper).to receive(:ask_yes_no).and_return(true)
         subject.send(:template_name_to_apply)
       end
 
       it 'should return the single template if the user says yes' do
         allow(subject).to receive(:mr_template_options).and_return([template])
-        allow(highline_cli).to receive(:ask_yes_no).and_return(true)
+        allow(highline_wrapper).to receive(:ask_yes_no).and_return(true)
         expect(subject.send(:template_name_to_apply)).to eq(template)
       end
 
       it 'should return nil if the user says no' do
         allow(subject).to receive(:mr_template_options).and_return([template])
-        allow(highline_cli).to receive(:ask_yes_no).and_return(false)
+        allow(highline_wrapper).to receive(:ask_yes_no).and_return(false)
         expect(subject.send(:template_name_to_apply)).to eq(nil)
       end
     end
@@ -143,19 +144,19 @@ describe GitHelper::GitLabMergeRequest do
 
       it 'should call the CLI to ask which of multiple templates to apply' do
         allow(subject).to receive(:mr_template_options).and_return([template1, template2])
-        expect(highline_cli).to receive(:ask_options).and_return(template1)
+        expect(highline_wrapper).to receive(:ask_options).and_return(template1)
         subject.send(:template_name_to_apply)
       end
 
       it 'should return the answer template if the user says yes' do
         allow(subject).to receive(:mr_template_options).and_return([template1, template2])
-        allow(highline_cli).to receive(:ask_options).and_return(template1)
+        allow(highline_wrapper).to receive(:ask_options).and_return(template1)
         expect(subject.send(:template_name_to_apply)).to eq(template1)
       end
 
       it 'should return nil if the user says no' do
         allow(subject).to receive(:mr_template_options).and_return([template1, template2])
-        allow(highline_cli).to receive(:ask_options).and_return('None')
+        allow(highline_wrapper).to receive(:ask_options).and_return('None')
         expect(subject.send(:template_name_to_apply)).to eq(nil)
       end
     end
@@ -170,25 +171,25 @@ describe GitHelper::GitLabMergeRequest do
 
   describe '#mr_id' do
     it 'should ask the CLI for the code request ID' do
-      expect(highline_cli).to receive(:ask).and_return(Faker::Number.number)
+      expect(highline_wrapper).to receive(:ask).and_return(Faker::Number.number)
       subject.send(:mr_id)
     end
 
     it 'should equal an integer' do
       pr_id = Faker::Number.number
-      expect(highline_cli).to receive(:ask).and_return(pr_id)
+      expect(highline_wrapper).to receive(:ask).and_return(pr_id)
       expect(subject.send(:mr_id)).to eq(pr_id)
     end
   end
 
   describe '#squash_merge_request' do
     it 'should ask the CLI for the code request ID' do
-      expect(highline_cli).to receive(:ask_yes_no).and_return(true)
+      expect(highline_wrapper).to receive(:ask_yes_no).and_return(true)
       subject.send(:squash_merge_request)
     end
 
     it 'should be a boolean' do
-      expect(highline_cli).to receive(:ask_yes_no).and_return(false)
+      expect(highline_wrapper).to receive(:ask_yes_no).and_return(false)
       expect([true, false]).to include(subject.send(:squash_merge_request))
     end
   end
@@ -200,12 +201,12 @@ describe GitHelper::GitLabMergeRequest do
 
     context 'when the existing project has no setting' do
       it 'should ask the CLI for the code request ID' do
-        expect(highline_cli).to receive(:ask_yes_no).and_return(true)
+        expect(highline_wrapper).to receive(:ask_yes_no).and_return(true)
         subject.send(:remove_source_branch)
       end
 
       it 'should be a boolean' do
-        allow(highline_cli).to receive(:ask_yes_no).and_return(false)
+        allow(highline_wrapper).to receive(:ask_yes_no).and_return(false)
         expect([true, false]).to include(subject.send(:remove_source_branch))
       end
     end
@@ -222,7 +223,7 @@ describe GitHelper::GitLabMergeRequest do
 
     it 'should return the existing projects setting if it exists' do
       allow(subject).to receive(:existing_project).and_return(double(remove_source_branch_after_merge: false))
-      allow(highline_cli).to receive(:ask_yes_no).and_return(true)
+      allow(highline_wrapper).to receive(:ask_yes_no).and_return(true)
       expect(subject.send(:remove_source_branch)).to eq(true)
     end
   end
@@ -236,7 +237,7 @@ describe GitHelper::GitLabMergeRequest do
 
   describe '#existing_mr' do
     it 'should call the gitlab client' do
-      allow(highline_cli).to receive(:ask).and_return(Faker::Number.number)
+      allow(highline_wrapper).to receive(:ask).and_return(Faker::Number.number)
       expect(gitlab_client_client).to receive(:merge_request).and_return(:merge_request)
       subject.send(:existing_mr)
     end

data/spec/git_helper/new_branch_spec.rb

@@ -1,16 +1,18 @@
+# frozen_string_literal: true
+
 require 'spec_helper'
 require 'git_helper'
 
 describe GitHelper::NewBranch do
   let(:new_branch_name) { 'new-branch-name' }
   let(:local_code) { double(:local_code, new_branch: :commit) }
-  let(:cli) { double(:highline_cli, ask: new_branch_name) }
+  let(:highline) { double(:highline_wrapper, ask: new_branch_name) }
 
   subject { GitHelper::NewBranch.new }
 
   before do
     allow(GitHelper::LocalCode).to receive(:new).and_return(local_code)
-    allow(GitHelper::HighlineCli).to receive(:new).and_return(cli)
+    allow(HighlineWrapper).to receive(:new).and_return(highline)
     allow(subject).to receive(:puts)
   end
 
@@ -25,20 +27,20 @@ describe GitHelper::NewBranch do
   end
 
   context 'when no branch name is passed in' do
-    it 'should call the highline cli' do
-      expect(GitHelper::HighlineCli).to receive(:new).and_return(cli)
+    it 'should call the highline client' do
+      expect(HighlineWrapper).to receive(:new).and_return(highline)
       subject.execute
     end
 
-    it 'should ask the highline cli what the new branch name should be' do
-      expect(cli).to receive(:ask)
+    it 'should ask the highline client what the new branch name should be' do
+      expect(highline).to receive(:ask)
       subject.execute
     end
   end
 
   context 'when there is a branch name passed in' do
-    it 'should not create a highline cli' do
-      expect(GitHelper::HighlineCli).not_to receive(:new)
+    it 'should not create a highline_wrapper client' do
+      expect(HighlineWrapper).not_to receive(:new)
       subject.execute(new_branch_name)
     end
   end

data/spec/git_helper/octokit_client_spec.rb

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

data/spec/git_helper/pull_request_spec.rb

@@ -1,9 +1,11 @@
+# frozen_string_literal: true
+
 require 'spec_helper'
 require 'git_helper'
 
 describe GitHelper::GitHubPullRequest do
   let(:local_code) { double(:local_code, read_template: Faker::Lorem.word) }
-  let(:highline_cli) { double(:highline_cli) }
+  let(:highline_wrapper) { double(:highline_wrapper) }
   let(:octokit_client_client) { double(:octokit_client_client, project: :project, merge_request: :merge_request, create_merge_request: :created) }
   let(:octokit_client) { double(:octokit_client, client: octokit_client_client) }
 
@@ -12,7 +14,7 @@ describe GitHelper::GitHubPullRequest do
       local_project: Faker::Lorem.word,
       local_branch: Faker::Lorem.word,
       local_code: local_code,
-      cli: highline_cli
+      highline: highline_wrapper
     }
   end
 
@@ -27,19 +29,19 @@ describe GitHelper::GitHubPullRequest do
     it 'should call the octokit client to create' do
       allow(subject).to receive(:new_pr_body).and_return('')
       expect(octokit_client_client).to receive(:create_pull_request).and_return(double(html_url: Faker::Internet.url))
-      subject.create({base_branch: Faker::Lorem.word, new_title: Faker::Lorem.word})
+      subject.create({ base_branch: Faker::Lorem.word, new_title: Faker::Lorem.word })
     end
 
     it 'should call various other methods' do
       expect(subject).to receive(:new_pr_body).and_return('').at_least(:once)
       allow(octokit_client_client).to receive(:create_pull_request).and_return(double(html_url: Faker::Internet.url))
-      subject.create({base_branch: Faker::Lorem.word, new_title: Faker::Lorem.word})
+      subject.create({ base_branch: Faker::Lorem.word, new_title: Faker::Lorem.word })
     end
 
     it 'should catch the raised error if the creation does not work' do
       allow(subject).to receive(:new_pr_body).and_return('')
       allow(octokit_client_client).to receive(:create_pull_request).and_raise(StandardError)
-      expect(subject.create({base_branch: Faker::Lorem.word, new_title: Faker::Lorem.word})).to eq(nil)
+      expect(subject.create({ base_branch: Faker::Lorem.word, new_title: Faker::Lorem.word })).to eq(nil)
     end
   end
 
@@ -101,19 +103,19 @@ describe GitHelper::GitHubPullRequest do
 
       it 'should call the CLI to ask about a single template' do
         allow(subject).to receive(:pr_template_options).and_return([template])
-        expect(highline_cli).to receive(:ask_yes_no).and_return(true)
+        expect(highline_wrapper).to receive(:ask_yes_no).and_return(true)
         subject.send(:template_name_to_apply)
       end
 
       it 'should return the single template if the user says yes' do
         allow(subject).to receive(:pr_template_options).and_return([template])
-        allow(highline_cli).to receive(:ask_yes_no).and_return(true)
+        allow(highline_wrapper).to receive(:ask_yes_no).and_return(true)
         expect(subject.send(:template_name_to_apply)).to eq(template)
       end
 
       it 'should return nil if the user says no' do
         allow(subject).to receive(:pr_template_options).and_return([template])
-        allow(highline_cli).to receive(:ask_yes_no).and_return(false)
+        allow(highline_wrapper).to receive(:ask_yes_no).and_return(false)
         expect(subject.send(:template_name_to_apply)).to eq(nil)
       end
     end
@@ -124,19 +126,19 @@ describe GitHelper::GitHubPullRequest do
 
       it 'should call the CLI to ask which of multiple templates to apply' do
         allow(subject).to receive(:pr_template_options).and_return([template1, template2])
-        expect(highline_cli).to receive(:ask_options).and_return(template1)
+        expect(highline_wrapper).to receive(:ask_options).and_return(template1)
         subject.send(:template_name_to_apply)
       end
 
       it 'should return the answer template if the user says yes' do
         allow(subject).to receive(:pr_template_options).and_return([template1, template2])
-        allow(highline_cli).to receive(:ask_options).and_return(template1)
+        allow(highline_wrapper).to receive(:ask_options).and_return(template1)
         expect(subject.send(:template_name_to_apply)).to eq(template1)
       end
 
       it 'should return nil if the user says no' do
         allow(subject).to receive(:pr_template_options).and_return([template1, template2])
-        allow(highline_cli).to receive(:ask_options).and_return('None')
+        allow(highline_wrapper).to receive(:ask_options).and_return('None')
         expect(subject.send(:template_name_to_apply)).to eq(nil)
       end
     end
@@ -151,13 +153,13 @@ describe GitHelper::GitHubPullRequest do
 
   describe '#pr_id' do
     it 'should ask the CLI for the code request ID' do
-      expect(highline_cli).to receive(:ask).and_return(Faker::Number.number)
+      expect(highline_wrapper).to receive(:ask).and_return(Faker::Number.number)
       subject.send(:pr_id)
     end
 
     it 'should equal an integer' do
       pr_id = Faker::Number.number
-      expect(highline_cli).to receive(:ask).and_return(pr_id)
+      expect(highline_wrapper).to receive(:ask).and_return(pr_id)
       expect(subject.send(:pr_id)).to eq(pr_id)
     end
   end
@@ -167,16 +169,16 @@ describe GitHelper::GitHubPullRequest do
 
     before do
       allow(subject).to receive(:existing_project).and_return(project)
-      allow(highline_cli).to receive(:ask_options)
+      allow(highline_wrapper).to receive(:ask_options)
     end
 
     it 'should ask the CLI for the merge_method' do
-      expect(highline_cli).to receive(:ask_options).and_return('merge')
+      expect(highline_wrapper).to receive(:ask_options).and_return('merge')
       subject.send(:merge_method)
     end
 
     it 'should be a string' do
-      allow(highline_cli).to receive(:ask_options).and_return('merge')
+      allow(highline_wrapper).to receive(:ask_options).and_return('merge')
       expect(subject.send(:merge_method)).to be_a(String)
     end
 
@@ -184,7 +186,7 @@ describe GitHelper::GitHubPullRequest do
       let(:project) { double(:project, allow_merge_commit: true, allow_squash_merge: false, allow_rebase_merge: false) }
 
       it 'should not ask the CLI anything' do
-        expect(highline_cli).not_to receive(:merge_method)
+        expect(highline_wrapper).not_to receive(:merge_method)
         subject.send(:merge_method)
       end
     end
@@ -239,7 +241,7 @@ describe GitHelper::GitHubPullRequest do
 
   describe '#existing_pr' do
     it 'should call the octokit client' do
-      allow(highline_cli).to receive(:ask).and_return(Faker::Number.number)
+      allow(highline_wrapper).to receive(:ask).and_return(Faker::Number.number)
       expect(octokit_client_client).to receive(:pull_request).and_return(:pull_request)
       subject.send(:existing_pr)
     end

data/spec/git_helper/setup_spec.rb

@@ -0,0 +1,183 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+require 'git_helper'
+
+describe GitHelper::Setup do
+  let(:highline_wrapper) { double(:highline_wrapper, ask: Faker::Lorem.word, ask_yes_no: true) }
+
+  before do
+    allow(HighlineWrapper).to receive(:new).and_return(highline_wrapper)
+    allow(subject).to receive(:puts)
+  end
+
+  after do
+    GitHelper::Setup.instance_variable_set('@highline', nil)
+  end
+
+  describe '#execute' do
+    it 'only asks the user one question if the config file does not exist' do
+      allow(subject).to receive(:config_file_exists?).and_return(false)
+      allow(File).to receive(:exists?).and_return(true)
+      expect(highline_wrapper).to receive(:ask_yes_no).and_return(true).exactly(:once)
+      allow(subject).to receive(:create_or_update_config_file).and_return(true)
+      allow(subject).to receive(:create_or_update_plugin_files)
+      subject.execute
+    end
+
+    it 'should ask two questions if the config file exists' do
+      allow(subject).to receive(:config_file_exists?).and_return(true)
+      allow(File).to receive(:exists?).and_return(true)
+      expect(highline_wrapper).to receive(:ask_yes_no).and_return(true).at_least(:twice)
+      allow(subject).to receive(:create_or_update_config_file).and_return(true)
+      allow(subject).to receive(:create_or_update_plugin_files)
+      subject.execute
+    end
+
+    it 'should call to create or update the config file' do
+      allow(File).to receive(:exists?).and_return(true)
+      allow(highline_wrapper).to receive(:ask_yes_no).and_return(true)
+      expect(subject).to receive(:create_or_update_config_file).and_return(true)
+      allow(subject).to receive(:create_or_update_plugin_files)
+      subject.execute
+    end
+
+    it 'should skip if the user opts not to continue' do
+      allow(File).to receive(:exists?).and_return(true)
+      allow(subject).to receive(:config_file_exists?).and_return(true)
+      allow(highline_wrapper).to receive(:ask_yes_no).and_return(false)
+      expect(subject).not_to receive(:create_or_update_config_file)
+      expect(subject).not_to receive(:create_or_update_plugin_files)
+      subject.execute
+    end
+  end
+
+  describe '#create_or_update_config_file' do
+    it 'should generate the file based on the answers to the questions' do
+      expect(subject).to receive(:generate_file_contents)
+      allow(File).to receive(:open).and_return(nil)
+      subject.send(:create_or_update_config_file)
+    end
+
+    it 'should open the file for writing' do
+      allow(subject).to receive(:generate_file_contents)
+      expect(File).to receive(:open).and_return(nil)
+      subject.send(:create_or_update_config_file)
+    end
+  end
+
+  describe '#config_file_exists?' do
+    it 'should return true if the file exists' do
+      allow(File).to receive(:exist?).and_return(true)
+      expect(subject.send(:config_file_exists?)).to eq(true)
+    end
+
+    it 'should return false if the file does not exist' do
+      allow(File).to receive(:exist?).and_return(false)
+      expect(subject.send(:config_file_exists?)).to eq(false)
+    end
+  end
+
+  describe '#ask_question' do
+    it 'should use highline to ask a question' do
+      expect(highline_wrapper).to receive(:ask).and_return(Faker::Lorem.word)
+      subject.send(:ask_question, Faker::Lorem.sentence)
+    end
+
+    it 'should return the answer if it is given' do
+      answer = Faker::Lorem.sentence
+      allow(highline_wrapper).to receive(:ask).and_return(answer)
+      expect(subject.send(:ask_question, Faker::Lorem.sentence)).to be(answer)
+    end
+  end
+
+  describe '#generate_file_contents' do
+    it 'should ask two yes/no questions' do
+      expect(highline_wrapper).to receive(:ask_yes_no).exactly(2).times.and_return(false)
+      subject.send(:generate_file_contents)
+    end
+
+    it 'should ask two additional questions for each time the user says yes' do
+      allow(highline_wrapper).to receive(:ask_yes_no).exactly(2).times.and_return(true, false)
+      expect(subject).to receive(:ask_question).exactly(2).times.and_return(Faker::Lorem.word)
+      subject.send(:generate_file_contents)
+    end
+
+    it 'should ask four additional questions for each time the user says yes' do
+      allow(highline_wrapper).to receive(:ask_yes_no).exactly(2).times.and_return(true)
+      expect(subject).to receive(:ask_question).exactly(4).times.and_return(Faker::Lorem.word)
+      subject.send(:generate_file_contents)
+    end
+
+    it 'should return a string no matter what' do
+      allow(highline_wrapper).to receive(:ask_yes_no).exactly(2).times.and_return(true)
+      allow(subject).to receive(:ask_question).exactly(4).times.and_return(Faker::Lorem.word)
+      expect(subject.send(:generate_file_contents)).to be_a(String)
+    end
+  end
+
+  describe '#create_or_update_plugin_files' do
+    let(:plugins) do
+      [
+        {
+          name: 'plugin-file-one'
+        },
+        {
+          name: 'plugin-file-two'
+        }
+      ]
+    end
+
+    let(:plugins_json) do
+      "[
+        {
+          \"name\": \"plugin-file-one\"
+        },
+        {
+          \"name\": \"plugin-file-two\"
+        }
+      ]"
+    end
+
+    before do
+      allow_any_instance_of(GitHelper::GitConfigReader).to receive(:github_token).and_return(Faker::Internet.password)
+      allow_any_instance_of(GitHelper::GitConfigReader).to receive(:github_user).and_return(Faker::Internet.username)
+    end
+
+    it 'should create the directory if it does not exist' do
+      allow(File).to receive(:exist?).and_return(false)
+      allow(File).to receive(:open).and_return(nil)
+      expect(Dir).to receive(:mkdir)
+      allow(subject).to receive(:`).and_return(plugins_json)
+      allow(JSON).to receive(:parse).and_return(plugins)
+      subject.send(:create_or_update_plugin_files)
+    end
+
+    it 'should not create the directory if it already exists' do
+      allow(File).to receive(:exist?).and_return(true)
+      allow(File).to receive(:open).and_return(nil)
+      expect(Dir).not_to receive(:mkdir)
+      allow(subject).to receive(:`).and_return(plugins_json)
+      allow(JSON).to receive(:parse).and_return(plugins)
+      subject.send(:create_or_update_plugin_files)
+    end
+
+    it 'should curl the GitHub API' do
+      allow(Dir).to receive(:mkdir).and_return(true)
+      allow(File).to receive(:exists?).and_return(true)
+      allow(File).to receive(:open).and_return(nil)
+      allow(subject).to receive(:`).and_return(plugins_json)
+      expect(JSON).to receive(:parse).with(plugins_json).and_return(plugins)
+      subject.send(:create_or_update_plugin_files)
+    end
+
+    it 'should go through the loop for each plugin' do
+      allow(Dir).to receive(:mkdir).and_return(true)
+      allow(File).to receive(:exists?).and_return(true)
+      allow(File).to receive(:open).and_return(nil)
+      expect(subject).to receive(:`).exactly(3).times
+      allow(JSON).to receive(:parse).and_return(plugins)
+      subject.send(:create_or_update_plugin_files)
+    end
+  end
+end