git_helper 3.2.0 → 3.3.2

data/spec/git_helper/new_branch_spec.rb

@@ -1,10 +1,12 @@
+# 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, new_branch_name: new_branch_name) }
+  let(:cli) { double(:highline_cli, ask: new_branch_name) }
 
   subject { GitHelper::NewBranch.new }
 
@@ -31,7 +33,7 @@ describe GitHelper::NewBranch do
     end
 
     it 'should ask the highline cli what the new branch name should be' do
-      expect(cli).to receive(:new_branch_name)
+      expect(cli).to receive(:ask)
       subject.execute
     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,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'spec_helper'
 require 'git_helper'
 
@@ -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(:apply_template?).and_return(true)
+        expect(highline_cli).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(:apply_template?).and_return(true)
+        allow(highline_cli).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(:apply_template?).and_return(false)
+        allow(highline_cli).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(:template_to_apply).and_return(template1)
+        expect(highline_cli).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(:template_to_apply).and_return(template1)
+        allow(highline_cli).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(:template_to_apply).and_return('None')
+        allow(highline_cli).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(:code_request_id).and_return(Faker::Number.number)
+      expect(highline_cli).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(:code_request_id).and_return(pr_id)
+      expect(highline_cli).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(:merge_method)
+      allow(highline_cli).to receive(:ask_options)
     end
 
     it 'should ask the CLI for the merge_method' do
-      expect(highline_cli).to receive(:merge_method).and_return('merge')
+      expect(highline_cli).to receive(:ask_options).and_return('merge')
       subject.send(:merge_method)
     end
 
     it 'should be a string' do
-      allow(highline_cli).to receive(:merge_method).and_return('merge')
+      allow(highline_cli).to receive(:ask_options).and_return('merge')
       expect(subject.send(:merge_method)).to be_a(String)
     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(:code_request_id).and_return(Faker::Number.number)
+      allow(highline_cli).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,180 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+require 'git_helper'
+
+describe GitHelper::Setup do
+  let(:response) { double(:response, readline: true, to_s: Faker::Lorem.sentence) }
+  let(:highline_cli) { double(:highline_cli, ask: response, ask_yes_no: true) }
+
+  before do
+    allow(GitHelper::HighlineCli).to receive(:new).and_return(highline_cli)
+    allow(subject).to receive(:puts)
+  end
+
+  after do
+    GitHelper::Setup.instance_variable_set('@highline', nil)
+  end
+
+  describe '#execute' do
+    it 'should ask a question if the config file exists' do
+      allow(File).to receive(:exists?).and_return(true)
+      expect(highline_cli).to receive(:ask_yes_no).and_return(true)
+      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_cli).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_cli).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_cli).to receive(:ask).and_return(Faker::Lorem.word)
+      subject.send(:ask_question, Faker::Lorem.sentence)
+    end
+
+    it 'should recurse if the highline client gets an empty string' do
+      allow(highline_cli).to receive(:ask).and_return('', Faker::Lorem.word)
+      expect(subject).to receive(:ask_question).at_least(:twice).and_call_original
+      subject.send(:ask_question, Faker::Lorem.sentence)
+    end
+
+    it 'should return the answer if it is given' do
+      answer = Faker::Lorem.sentence
+      allow(highline_cli).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_cli).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_cli).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_cli).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_cli).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

data/spec/spec_helper.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'faker'
 
 # This file was generated by the `rspec --init` command. Conventionally, all
@@ -33,7 +35,7 @@ RSpec.configure do |config|
     expectations.include_chain_clauses_in_custom_matcher_descriptions = true
   end
 
-  config.filter_run :focus => true
+  config.filter_run focus: true
   config.run_all_when_everything_filtered = true
 
   # rspec-mocks config goes here. You can use an alternate test double

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: git_helper
 version: !ruby/object:Gem::Version
-  version: 3.2.0
+  version: 3.3.2
 platform: ruby
 authors:
 - Emma Sax
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-01-06 00:00:00.000000000 Z
+date: 2021-03-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: gitlab
@@ -136,16 +136,30 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.9'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 description: A set of GitHub and GitLab workflow scripts to provide a smoother development
   process for your git projects.
 email:
-- emma.sax4@gmail.com
 executables:
 - git-helper
 extensions: []
 extra_rdoc_files: []
 files:
 - Gemfile
+- Gemfile.lock
 - Guardfile
 - LICENSE
 - README.md
@@ -166,6 +180,7 @@ files:
 - lib/git_helper/new_branch.rb
 - lib/git_helper/octokit_client.rb
 - lib/git_helper/pull_request.rb
+- lib/git_helper/setup.rb
 - lib/git_helper/version.rb
 - plugins.zip
 - spec/git_helper/change_remote_spec.rb
@@ -182,8 +197,9 @@ files:
 - spec/git_helper/new_branch_spec.rb
 - spec/git_helper/octokit_client_spec.rb
 - spec/git_helper/pull_request_spec.rb
+- spec/git_helper/setup_spec.rb
 - spec/spec_helper.rb
-homepage: https://github.com/emmasax4/git_helper
+homepage: https://github.com/emmahsax/git_helper
 licenses:
 - MIT
 metadata: {}
@@ -195,7 +211,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: '2.5'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
@@ -222,3 +238,4 @@ test_files:
 - spec/git_helper/new_branch_spec.rb
 - spec/git_helper/octokit_client_spec.rb
 - spec/git_helper/pull_request_spec.rb
+- spec/git_helper/setup_spec.rb