git_helper 1.1.0 → 2.0.0

data/lib/git_helper/pull_request.rb

@@ -1,13 +1,23 @@
 require_relative './octokit_client.rb'
 require_relative './highline_cli.rb'
+require_relative './local_code.rb'
 
 module GitHelper
   class GitHubPullRequest
-    def create
+    attr_accessor :local_repo, :local_branch, :local_code, :cli, :base_branch, :new_pr_title
+
+    def initialize(options)
+      @local_repo = options[:local_project]
+      @local_branch = options[:local_branch]
+      @local_code = options[:local_code]
+      @cli = options[:cli]
+    end
+
+    def create(options)
+      @base_branch = options[:base_branch]
+      @new_pr_title = options[:new_title]
+
       begin
-        # Ask these questions right away
-        base_branch
-        new_pr_title
         new_pr_body
 
         puts "Creating pull request: #{new_pr_title}"
@@ -30,12 +40,11 @@ module GitHelper
 
     def merge
       begin
-        # Ask these questions right away
         pr_id
         merge_method
 
         puts "Merging pull request: #{pr_id}"
-        merge = octokit_client.merge_pull_request(local_repo, pr_id, existing_pr_title, { merge_method: merge_method })
+        merge = octokit_client.merge_pull_request(local_repo, pr_id, existing_pr.title, { merge_method: merge_method })
         puts "Pull request successfully merged: #{merge.sha}"
       rescue Octokit::UnprocessableEntity => e
         puts 'Could not merge pull request:'
@@ -66,100 +75,61 @@ module GitHelper
       end
     end
 
-    private def local_repo
-      # Get the repository by looking in the remote URLs for the full repository name
-      remotes = `git remote -v`
-      return remotes.scan(/\S[\s]*[\S]+.com[\S]{1}([\S]*).git/).first.first
+    private def new_pr_body
+      @new_pr_body ||= template_name_to_apply ? local_code.read_template(template_name_to_apply) : ''
     end
 
-    private def local_branch
-      # Get the current branch by looking in the list of branches for the *
-      branches = `git branch`
-      return branches.scan(/\*\s([\S]*)/).first.first
-    end
+    private def template_name_to_apply
+      return @template_name_to_apply if @template_name_to_apply
+      @template_name_to_apply = nil
 
-    private def read_template
-      if pr_template_options.count == 1
-        apply_template?(pr_template_options.first) ? File.open(pr_template_options.first).read : ''
-      else
-        template_file_name_to_apply = template_to_apply
-        template_file_name_to_apply == "None" ? '' : File.open(template_file_name_to_apply).read
+      unless pr_template_options.empty?
+        if pr_template_options.count == 1
+          apply_single_template = cli.apply_template?(pr_template_options.first, 'pull')
+          @template_name_to_apply = pr_template_options.first if apply_single_template
+        else
+          response = cli.template_to_apply(pr_template_options, 'pull')
+          @template_name_to_apply = response unless response == 'None'
+        end
       end
-    end
-
-    private def merge_options
-      [ 'merge', 'squash', 'rebase' ]
-    end
-
-    private def pr_id
-      @pr_id ||= cli.ask('Pull Request ID?')
-    end
-
-    private def existing_pr_title
-      @existing_pr_title ||= octokit_client.pull_request(local_repo, pr_id).title
-    end
-
-    private def new_pr_title
-      @new_pr_title ||= accept_autogenerated_title? ? autogenerated_title : cli.ask('Title?')
-    end
-
-    private def new_pr_body
-      @new_pr_body ||= pr_template_options.empty? ? '' : read_template
-    end
 
-    private def base_branch
-      @base_branch ||= base_branch_default? ? default_branch : cli.ask('Base branch?')
+      @template_name_to_apply
     end
 
-    private def autogenerated_title
-      @autogenerated_title ||= local_branch.split('_')[0..-1].join(' ').capitalize
+    private def pr_template_options
+      @pr_template_options ||= local_code.template_options({
+                                 nested_directory_name: 'PULL_REQUEST_TEMPLATE',
+                                 non_nested_file_name: 'pull_request_template'
+                               })
     end
 
-    private def default_branch
-      @default_branch ||= octokit_client.repository(local_repo).default_branch
+    private def pr_id
+      @pr_id ||= cli.code_request_id('Pull')
     end
 
     private def merge_method
-      return @merge_method if @merge_method
-      index = cli.ask_options("Merge method?", merge_options)
-      @merge_method = merge_options[index]
+      @merge_method ||= merge_options.length == 1 ? merge_options.first : cli.merge_method(merge_options)
     end
 
-    private def template_to_apply
-      return @template_to_apply if @template_to_apply
-      complete_options = pr_template_options << 'None'
-      index = cli.ask_options("Which pull request template should be applied?", complete_options)
-      @template_to_apply = complete_options[index]
-    end
-
-    private def pr_template_options
-      return @pr_template_options if @pr_template_options
-      nested_templates = Dir.glob(File.join("**/PULL_REQUEST_TEMPLATE", "*.md"), File::FNM_DOTMATCH | File::FNM_CASEFOLD)
-      non_nested_templates = Dir.glob(File.join("**", "pull_request_template.md"), File::FNM_DOTMATCH | File::FNM_CASEFOLD)
-      @pr_template_options = nested_templates.concat(non_nested_templates)
-    end
-
-    private def base_branch_default?
-      answer = cli.ask("Is '#{default_branch}' the correct base branch for your new pull request? (y/n)")
-      !!(answer =~ /^y/i)
+    private def merge_options
+      return @merge_options if @merge_options
+      merge_options = []
+      merge_options << 'merge' if existing_project.allow_merge_commit
+      merge_options << 'squash' if existing_project.allow_squash_merge
+      merge_options << 'rebase' if existing_project.allow_rebase_merge
+      @merge_options = merge_options
     end
 
-    private def accept_autogenerated_title?
-      answer = cli.ask("Accept the autogenerated pull request title '#{autogenerated_title}'? (y/n)")
-      !!(answer =~ /^y/i)
+    private def existing_project
+      @existing_project ||= octokit_client.repository(local_repo)
     end
 
-    private def apply_template?(template_file_name)
-      answer = cli.ask("Apply the pull request template from #{template_file_name}? (y/n)")
-      !!(answer =~ /^y/i)
+    private def existing_pr
+      @existing_pr ||= octokit_client.pull_request(local_repo, pr_id)
     end
 
     private def octokit_client
       @octokit_client ||= GitHelper::OctokitClient.new.client
     end
-
-    private def cli
-      @cli ||= GitHelper::HighlineCli.new
-    end
   end
 end

data/lib/git_helper/version.rb

@@ -1,3 +1,3 @@
 module GitHelper
-  VERSION = '1.1.0'
+  VERSION = '2.0.0'
 end

data/spec/git_helper/change_remote_spec.rb

@@ -0,0 +1,172 @@
+require_relative '../../lib/git_helper/change_remote.rb'
+
+describe GitHelper::ChangeRemote do
+  let(:remote1) { 'git@github.com:github-username-old/project-1.git' }
+  let(:local_code) do
+    double(:local_code,
+      remotes: [remote1],
+      remote_name: 'origin',
+      ssh_remote?: true,
+      https_remote?: false,
+      remote_project: 'project-1',
+      remote_source: 'github.com',
+      change_remote: true
+    )
+  end
+  let(:cli) { double(:highline_cli, process_directory_remotes?: true) }
+  let(:old_owner) { 'github-username-old' }
+  let(:new_owner) { 'github-username-new' }
+  let(:directory_entries) { [ '.', '..', 'project-1', 'project-2', 'project-3' ] }
+
+  subject { GitHelper::ChangeRemote.new(old_owner, new_owner) }
+
+  before do
+    allow(GitHelper::HighlineCli).to receive(:new).and_return(cli)
+    allow(GitHelper::LocalCode).to receive(:new).and_return(local_code)
+  end
+
+  describe '#execute' do
+    before do
+      allow(Dir).to receive(:pwd).and_return('/Users/firstname/lastname/path/to/project')
+      allow(Dir).to receive(:entries).and_return(directory_entries)
+      allow(File).to receive(:join).and_return('/Users/firstname/lastname/path/to/project/project-1')
+      allow(File).to receive(:directory?).and_return(true)
+      allow(subject).to receive(:process_dir)
+    end
+
+    it 'should call to process at least one directory' do
+      expect(subject).to receive(:process_dir).at_least(:once)
+      subject.execute
+    end
+
+    it 'should definitely look in the file structure' do
+      expect(Dir).to receive(:pwd)
+      expect(Dir).to receive(:entries)
+      expect(File).to receive(:join)
+      expect(File).to receive(:directory?)
+      subject.execute
+    end
+  end
+
+  describe '#process_dir' do
+    before do
+      allow(Dir).to receive(:chdir).and_return(nil)
+      allow(File).to receive(:exist?).and_return(true)
+      allow(subject).to receive(:process_git_repository)
+    end
+
+    it 'should definitely look in the file structure' do
+      expect(Dir).to receive(:chdir)
+      expect(File).to receive(:exist?)
+      subject.send(:process_dir, '/Users/firstname/lastname/path/to/project', '/Users/firstname/lastname/path/to/project/project-1')
+    end
+
+    context 'when the user says to process the directory' do
+      it 'should call to process the git repository at least once' do
+        expect(subject).to receive(:process_git_repository).at_least(:once)
+        subject.send(:process_dir, '/Users/firstname/lastname/path/to/project', '/Users/firstname/lastname/path/to/project/project-1')
+      end
+    end
+
+    context 'when the user says not to process the directory' do
+      let(:cli) { double(:highline_cli, process_directory_remotes?: false) }
+
+      it 'should not call to process the directory' do
+        expect(subject).not_to receive(:process_git_repository)
+        subject.send(:process_dir, '/Users/firstname/lastname/path/to/project', '/Users/firstname/lastname/path/to/project/project-1')
+      end
+    end
+  end
+
+  describe '#process_git_repository' do
+    before do
+      allow(subject).to receive(:process_remote).and_return(nil)
+    end
+
+    it 'should call local_code' do
+      expect(GitHelper::LocalCode).to receive(:new)
+      subject.send(:process_git_repository)
+    end
+
+    context 'when the remote includes the old owner' do
+      it 'should call to process the remote' do
+        expect(subject).to receive(:process_remote)
+        subject.send(:process_git_repository)
+      end
+    end
+
+    context 'when the remote does not include the old owner' do
+      let(:remote1) { 'git@github.com:github-username-new/project-1.git' }
+
+      it 'should not call to process the remote' do
+        expect(subject).not_to receive(:process_remote)
+        subject.send(:process_git_repository)
+      end
+    end
+  end
+
+  describe '#process_remote' do
+    it 'should always get the remote name' do
+      expect(local_code).to receive(:remote_name)
+      subject.send(:process_remote, remote1)
+    end
+
+    it 'should always attempt to change the remote' do
+      expect(local_code).to receive(:change_remote)
+      subject.send(:process_remote, remote1)
+    end
+
+    it 'should attempt to get the remote repo exactly once' do
+      expect(local_code).to receive(:remote_project).exactly(:once)
+      subject.send(:process_remote, remote1)
+    end
+
+    it 'should attempt to get the remote source exactly once' do
+      expect(local_code).to receive(:remote_source).exactly(:once)
+      subject.send(:process_remote, remote1)
+    end
+
+    it 'should ask if the remote is SSH' do
+      expect(local_code).to receive(:ssh_remote?)
+      subject.send(:process_remote, remote1)
+    end
+
+    context 'https remote' do
+      let(:local_code) do
+        double(:local_code,
+          remotes: [remote1],
+          remote_name: 'origin',
+          ssh_remote?: false,
+          https_remote?: false,
+          remote_project: 'project-1',
+          remote_source: 'github.com',
+          change_remote: true
+        )
+      end
+
+      it 'should ask if the remote is SSH' do
+        expect(local_code).to receive(:ssh_remote?)
+        subject.send(:process_remote, remote1)
+      end
+
+      it 'should ask if the remote is https' do
+        expect(local_code).to receive(:https_remote?)
+        subject.send(:process_remote, remote1)
+      end
+    end
+  end
+
+  describe '#local_code' do
+    it 'should create a new local code instance' do
+      expect(GitHelper::LocalCode).to receive(:new)
+      subject.send(:local_code)
+    end
+  end
+
+  describe '#cli' do
+    it 'should create a new highline CLI instance' do
+      expect(GitHelper::HighlineCli).to receive(:new)
+      subject.send(:cli)
+    end
+  end
+end

data/spec/git_helper/checkout_default_spec.rb

@@ -0,0 +1,18 @@
+require_relative '../../lib/git_helper/checkout_default.rb'
+
+describe GitHelper::CheckoutDefault do
+  let(:local_code) { double(:local_code, checkout_default: :done) }
+
+  subject { GitHelper::CheckoutDefault.new }
+
+  it 'should call GitHelper::LocalCode' do
+    expect(GitHelper::LocalCode).to receive(:new).and_return(local_code)
+    subject.execute
+  end
+
+  it 'should call the checkout_default method from the local code class' do
+    allow(GitHelper::LocalCode).to receive(:new).and_return(local_code)
+    expect(local_code).to receive(:checkout_default)
+    subject.execute
+  end
+end

data/spec/git_helper/clean_branches_spec.rb

@@ -0,0 +1,18 @@
+require_relative '../../lib/git_helper/clean_branches.rb'
+
+describe GitHelper::CleanBranches do
+  let(:local_code) { double(:local_code, clean_branches: :commit) }
+
+  subject { GitHelper::CleanBranches.new }
+
+  it 'should call GitHelper::LocalCode' do
+    expect(GitHelper::LocalCode).to receive(:new).and_return(local_code)
+    subject.execute
+  end
+
+  it 'should call the clean_branches method from the local code class' do
+    allow(GitHelper::LocalCode).to receive(:new).and_return(local_code)
+    expect(local_code).to receive(:clean_branches)
+    subject.execute
+  end
+end

data/spec/git_helper/code_request_spec.rb

@@ -0,0 +1,258 @@
+require_relative '../../lib/git_helper/code_request.rb'
+
+describe GitHelper::CodeRequest do
+  let(:highline_cli) { double(:highline_cli) }
+  let(:local_code) { double(:local_code, project_name: 'name', branch: 'branch') }
+  let(:process_project) { double(:process_project, create: :created, merge: :merged) }
+
+  subject { GitHelper::CodeRequest.new }
+
+  before do
+    allow(GitHelper::LocalCode).to receive(:new).and_return(local_code)
+    allow(GitHelper::HighlineCli).to receive(:new).and_return(highline_cli)
+  end
+
+  describe '#create' do
+    before do
+      allow(subject).to receive(:base_branch).and_return('base')
+      allow(subject).to receive(:new_code_request_title).and_return('Title')
+    end
+
+    it 'should call to process the project' do
+      expect(subject).to receive(:process_project).and_return(process_project)
+      subject.create
+    end
+
+    it 'should call create' do
+      allow(subject).to receive(:process_project).and_return(process_project)
+      expect(process_project).to receive(:create)
+      subject.create
+    end
+
+    it 'should call base_branch and new_code_request_title' do
+      expect(subject).to receive(:base_branch).and_return('base')
+      expect(subject).to receive(:new_code_request_title).and_return('Title')
+      allow(subject).to receive(:process_project).and_return(process_project)
+      allow(process_project).to receive(:create)
+      subject.create
+    end
+  end
+
+  describe '#merge' do
+    it 'should call to process the project' do
+      expect(subject).to receive(:process_project).and_return(process_project)
+      subject.merge
+    end
+
+    it 'should call merge' do
+      allow(subject).to receive(:process_project).and_return(process_project)
+      expect(process_project).to receive(:merge)
+      subject.merge
+    end
+  end
+
+  describe '#process_project' do
+    it 'should call the local code to see if it is a github or gitlab project' do
+      expect(local_code).to receive(:gitlab_project?).and_return(false)
+      expect(local_code).to receive(:github_repo?).and_return(true)
+      subject.send(:process_project)
+    end
+
+    context 'when github and gitlab remotes are found' do
+      it 'should ask for clarification' do
+        allow(local_code).to receive(:gitlab_project?).and_return(true)
+        allow(local_code).to receive(:github_repo?).and_return(true)
+        expect(subject).to receive(:ask_for_clarification)
+        subject.send(:process_project)
+      end
+    end
+
+    context 'when github' do
+      it 'should call the github_pull_request' do
+        allow(local_code).to receive(:gitlab_project?).and_return(false)
+        allow(local_code).to receive(:github_repo?).and_return(true)
+        expect(subject).to receive(:github_pull_request)
+        subject.send(:process_project)
+      end
+    end
+
+    context 'when gitlab' do
+      it 'should call the gitlab_merge_request' do
+        allow(local_code).to receive(:gitlab_project?).and_return(true)
+        allow(local_code).to receive(:github_repo?).and_return(false)
+        expect(subject).to receive(:gitlab_merge_request)
+        subject.send(:process_project)
+      end
+    end
+
+    context 'when no github or gitlab remotes are found' do
+      it 'should raise error' do
+        allow(local_code).to receive(:gitlab_project?).and_return(false)
+        allow(local_code).to receive(:github_repo?).and_return(false)
+        expect(subject).to receive(:exit)
+        subject.send(:process_project)
+      end
+    end
+  end
+
+  describe '#ask_for_clarification' do
+    it 'should ask the CLI' do
+      expect(highline_cli).to receive(:conflicting_remote_clarification).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(:conflicting_remote_clarification).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(:conflicting_remote_clarification).and_return('Github')
+        expect(subject).to receive(:github_pull_request)
+        subject.send(:ask_for_clarification)
+      end
+    end
+
+    context 'when response is gitlab' do
+      it 'should return gitlab_merge_request' do
+        allow(highline_cli).to receive(:conflicting_remote_clarification).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(:conflicting_remote_clarification).and_return('Gitlab')
+        expect(subject).to receive(:gitlab_merge_request)
+        subject.send(:ask_for_clarification)
+      end
+    end
+
+    context 'when response is neither' do
+      it 'should raise an error' do
+        allow(highline_cli).to receive(:conflicting_remote_clarification).and_return('huh?')
+        expect(subject).to receive(:exit)
+        subject.send(:ask_for_clarification)
+      end
+    end
+  end
+
+  describe '#github_pull_request' do
+    it 'should call the GitHelper::GitHubPullRequest' do
+      expect(GitHelper::GitHubPullRequest).to receive(:new)
+      subject.send(:github_pull_request)
+    end
+  end
+
+  describe '#gitlab_merge_request' do
+    it 'should call the GitHelper::GitLabMergeRequest' do
+      expect(GitHelper::GitLabMergeRequest).to receive(:new)
+      subject.send(:gitlab_merge_request)
+    end
+  end
+
+  describe '#local_project' do
+    it 'should call the name of the local_code' do
+      expect(local_code).to receive(:project_name)
+      subject.send(:local_project)
+    end
+  end
+
+  describe '#default_branch' do
+    it 'should call the name of the local_code' do
+      expect(local_code).to receive(:default_branch)
+      subject.send(:default_branch)
+    end
+  end
+
+  describe '#base_branch' do
+    it 'should call the default branch' do
+      expect(subject).to receive(:default_branch)
+      allow(highline_cli).to receive(:base_branch_default?).at_least(:once)
+      allow(highline_cli).to receive(:base_branch).at_least(:once).and_return('base')
+      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(:base_branch_default?).at_least(:once)
+      allow(highline_cli).to receive(:base_branch).at_least(:once).and_return('base')
+      subject.send(:base_branch)
+    end
+
+    context 'if the user says no' do
+      it "definitely asks for the user's base branch" do
+        allow(subject).to receive(:default_branch)
+        expect(highline_cli).to receive(:base_branch_default?).at_least(:once).and_return(false)
+        expect(highline_cli).to receive(:base_branch).at_least(:once).and_return('base')
+        subject.send(:base_branch)
+      end
+    end
+
+    context 'if the user says yes' do
+      it "does not ask for the user's base branch" do
+        allow(subject).to receive(:default_branch)
+        expect(highline_cli).to receive(:base_branch_default?).at_least(:once).and_return(true)
+        expect(highline_cli).not_to receive(:base_branch)
+        subject.send(:base_branch)
+      end
+    end
+  end
+
+  describe '#autogenerated_title' do
+    it 'should generate a title based on the branch' do
+      expect(subject).to receive(:local_branch).and_return('branch')
+      expect(local_code).to receive(:generate_title)
+      subject.send(:autogenerated_title)
+    end
+  end
+
+  describe '#new_code_request_title' do
+    it 'should call autogenerated title method' do
+      expect(subject).to receive(:autogenerated_title)
+      allow(highline_cli).to receive(:accept_autogenerated_title?).at_least(:once)
+      allow(highline_cli).to receive(:title).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)
+      expect(highline_cli).to receive(:accept_autogenerated_title?).at_least(:once)
+      allow(highline_cli).to receive(:title).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 user's title" do
+        allow(subject).to receive(:autogenerated_title)
+        expect(highline_cli).to receive(:accept_autogenerated_title?).at_least(:once).and_return(false)
+        expect(highline_cli).to receive(:title).at_least(:once).and_return('Title')
+        subject.send(:new_code_request_title)
+      end
+    end
+
+    context 'if the user says yes to original title' do
+      it "does not ask for the user's chosen title" do
+        allow(subject).to receive(:autogenerated_title)
+        expect(highline_cli).to receive(:accept_autogenerated_title?).at_least(:once).and_return(true)
+        expect(highline_cli).not_to receive(:title)
+        subject.send(:new_code_request_title)
+      end
+    end
+  end
+
+  describe '#local_code' do
+    it 'should call the octokit client' do
+      expect(GitHelper::LocalCode).to receive(:new).and_return(local_code)
+      subject.send(:local_code)
+    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)
+    end
+  end
+end