org.ajoberstar.grgit.operation.ResetOp.groovy Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of grgit Show documentation
The Groovy way to use Git.
There is a newer version: 1.8.0-rc.1
/*
 * Copyright 2012-2014 the original author or authors.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *      http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package org.ajoberstar.grgit.operation

import java.util.concurrent.Callable

import org.ajoberstar.grgit.Repository
import org.ajoberstar.grgit.exception.GrgitException

import org.eclipse.jgit.api.ResetCommand
import org.eclipse.jgit.api.errors.GitAPIException

/**
 * Reset changes in the repository.
 *
 * Reset the HEAD to a different commit.
 *
 *  * grgit.reset(commit: 'HEAD~1', mode: ResetOp.Mode.SOFT)
 * 
 *
 * Reset the HEAD, index, and working tree to a different commit.
 *
 *  * grgit.reset(commit: 'other-branch', mode: ResetOp.Mode.HARD)
 * 
 *
 * Reset the HEAD and index to a different commit.
 *
 *  * grgit.reset(commit: 'HEAD~2')
 * grgit.reset(commit: 'HEAD~2', mode: ResetOp.Mode.MIXED)
 * 
 *
 * Reset the index for specific paths back to the HEAD
 *
 *  * grgit.reset(paths: ['some/file.txt'])
 * 
 *
 * See git-reset Manual Page.
 *
 * @since 0.1.0
 * @see git-reset Manual Page
 */
class ResetOp implements Callable {
	private final Repository repo

	/**
	 * The paths to reset.
	 */
	Set paths = []

	/**
	 * The commit to reset back to. Defaults to HEAD.
	 */
	String commit

	/**
	 * The mode to use when resetting.
	 */
	Mode mode = Mode.MIXED

	ResetOp(Repository repo) {
		this.repo = repo
	}

	Void call() {
		if (!paths.empty && mode != Mode.MIXED) {
			throw new IllegalStateException('Cannot set mode when resetting paths.')
		}

		ResetCommand cmd = repo.jgit.reset()
		paths.each { cmd.addPath(it) }
		if (commit) {
			cmd.ref = commit
		}
		if (paths.empty) {
			cmd.mode = mode.jgit
		}

		try {
			cmd.call()
			return null
		} catch (GitAPIException e) {
			throw new GrgitException('Problem running reset.', e)
		}
	}

	static enum Mode {
		/**
		 * Reset the index and working tree.
		 */
		HARD(ResetCommand.ResetType.HARD),
		/**
		 * Reset the index, but not the working tree.
		 */
		MIXED(ResetCommand.ResetType.MIXED),
		/**
		 * Only reset the HEAD. Leave the index and working tree as-is.
		 */
		SOFT(ResetCommand.ResetType.SOFT)

		private final ResetCommand.ResetType jgit

		private Mode(ResetCommand.ResetType jgit) {
			this.jgit = jgit
		}
	}
}