Skip to content

#checkout without args should do same as git checkout without args #637

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Mar 2, 2023
Merged

#checkout without args should do same as git checkout without args #637

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions lib/git/base.rb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -350,8 +350,8 @@ def commit_all(message, opts = {})
end

# checks out a branch as the new git working directory
def checkout(branch = 'master', opts = {})
self.lib.checkout(branch, opts)
def checkout(*args, **options)
self.lib.checkout(*args, **options)
end

# checks out an old version of a file
Expand Down
9 changes: 7 additions & 2 deletions lib/git/lib.rb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -772,11 +772,16 @@ def branch_delete(branch)
#
# @param [String] branch
# @param [Hash] opts
def checkout(branch, opts = {})
def checkout(branch = nil, opts = {})
if branch.is_a?(Hash) && opts == {}
opts = branch
branch = nil
end

arr_opts = []
arr_opts << '-b' if opts[:new_branch] || opts[:b]
arr_opts << '--force' if opts[:force] || opts[:f]
arr_opts << branch
arr_opts << branch if branch
arr_opts << opts[:start_point] if opts[:start_point] && arr_opts.include?('-b')

command('checkout', *arr_opts)
Expand Down
82 changes: 82 additions & 0 deletions tests/units/test_checkout.rb
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,82 @@
require 'test_helper'

# Runs checkout command to checkout or create branch
#
# accepts options:
# :new_branch
# :force
# :start_point
#
# @param [String] branch
# @param [Hash] opts
# def checkout(branch, opts = {})

class TestCheckout < Test::Unit::TestCase
test 'checkout with no args' do
expected_command_line = ['checkout']
git_cmd = :checkout
git_cmd_args = []
assert_command_line(expected_command_line, git_cmd, git_cmd_args)
end

test 'checkout with no args and options' do
expected_command_line = ['checkout', '--force']
git_cmd = :checkout
git_cmd_args = [force: true]
assert_command_line(expected_command_line, git_cmd, git_cmd_args)
end

test 'checkout with branch' do
expected_command_line = ['checkout', 'feature1']
git_cmd = :checkout
git_cmd_args = ['feature1']
assert_command_line(expected_command_line, git_cmd, git_cmd_args)
end

test 'checkout with branch and options' do
expected_command_line = ['checkout', '--force', 'feature1']
git_cmd = :checkout
git_cmd_args = ['feature1', force: true]
assert_command_line(expected_command_line, git_cmd, git_cmd_args)
end

test 'checkout with branch name and new_branch: true' do
expected_command_line = ['checkout', '-b', 'feature1']
git_cmd = :checkout
git_cmd_args = ['feature1', new_branch: true]
assert_command_line(expected_command_line, git_cmd, git_cmd_args)
end

test 'checkout with force: true' do
expected_command_line = ['checkout', '--force', 'feature1']
git_cmd = :checkout
git_cmd_args = ['feature1', force: true]
assert_command_line(expected_command_line, git_cmd, git_cmd_args)
end

test 'checkout with branch name and new_branch: true and start_point: "sha"' do
expected_command_line = ['checkout', '-b', 'feature1', 'sha']
git_cmd = :checkout
git_cmd_args = ['feature1', new_branch: true, start_point: 'sha']
assert_command_line(expected_command_line, git_cmd, git_cmd_args)
end


test 'when checkout succeeds an error should not be raised' do
in_temp_dir do
git = Git.init('.', initial_branch: 'master')
File.write('file1.txt', 'file1')
git.add('file1.txt')
git.commit('commit1')
assert_nothing_raised { git.checkout('master') }
end
end

test 'when checkout fails a Git::FailedError should be raised' do
in_temp_dir do
git = Git.init('.', initial_branch: 'master')
# fails because there are no commits
assert_raises(Git::FailedError) { git.checkout('master') }
end
end
end