org.ajoberstar.grgit.operation.CleanOp.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.CleanCommand
import org.eclipse.jgit.api.errors.GitAPIException

/**
 * Remove untracked files from the working tree. Returns the list of
 * file paths deleted.
 *
 * To clean all untracked files, but not ignored ones or untracked directories.
 *
 *  * def cleanedPaths = grgit.clean()
 * 
 *
 * To clean all untracked files and directories.
 *
 *  * def cleanedPaths = grgit.clean(directories: true)
 * 
 *
 * To clean all untracked files, including ignored ones.
 *
 *  * def cleanedPaths = grgit.clean(ignore: false)
 * 
 *
 * To only return files that would be cleaned.
 *
 *  * def cleanedPaths = grgit.clean(dryRun: true)
 * 
 *
 * To clean specific untracked files.
 *
 *  * def cleanedPaths = grgit.clean(paths: ['specific/file.txt'])
 * 
 *
 * See git-clean Manual Page.
 *
 * @since 0.2.0
 * @see git-clean Manual Page
 */
class CleanOp implements Callable> {
	private final Repository repo

	/**
	 * The paths to clean. {@code null} if all paths should be included.
	 */
	Set paths

	/**
	 * {@code true} if untracked directories should also be deleted,
	 * {@code false} (the default) otherwise
	 */
	boolean directories = false

	/**
	 * {@code true} if the files should be returned, but not deleted,
	 * {@code false} (the default) otherwise
	 */
	boolean dryRun = false

	/**
	 * {@code false} if files ignored by {@code .gitignore} should
	 * also be deleted, {@code true} (the default) otherwise
	 */
	boolean ignore = true

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

	Set call() {
		CleanCommand cmd = repo.jgit.clean()
		if (paths) { cmd.paths = paths }
		cmd.cleanDirectories = directories
		cmd.dryRun = dryRun
		cmd.ignore = ignore

		try {
			return cmd.call()
		} catch (GitAPIException e) {
			throw new GrgitException('Problem cleaning repository.', e)
		}
	}
}