org.ajoberstar.grgit.operation.LogOp.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-2015 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.Commit
import org.ajoberstar.grgit.Repository
import org.ajoberstar.grgit.exception.GrgitException
import org.ajoberstar.grgit.service.ResolveService
import org.ajoberstar.grgit.util.JGitUtil

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

/**
 * Gets a log of commits in the repository. Returns a list of {@link Commit}s.
 * Since a Git history is not necessarilly a line, these commits may not be in
 * a strict order.
 *
 * Get a full log of commits from the current HEAD and back.
 *
 *  * def history = grgit.log()
 * 
 *
 * Get log of commits between two points.
 *
 *  * def history = grgit.log {
 *  range 'v1.0', 'v2.0'
 * }
 * 
 *
 * Get a list of the most recent 5 commits.
 *
 *  * def history = grgit.log(maxCommits: 5)
 * 
 *
 * Get a log of commits skipping the most recent 3.
 *
 *  * def history = grgit.log(skipCommits: 3)
 * 
 *
 * See git-log Manual Page.
 *
 * @since 0.1.0
 * @see git-log Manual Page
 */
class LogOp implements Callable> {
	private final Repository repo

	/**
	 * @see {@link ResolveService#toRevisionString(Object)}
	 */
	List includes = []
	/**
	 * @see {@link ResolveService#toRevisionString(Object)}
	 */
	List excludes = []
	List paths = []
	int skipCommits = -1
	int maxCommits = -1

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

	void range(Object since, Object until) {
		excludes << since
		includes << until
	}

	List call() {
		LogCommand cmd = repo.jgit.log()
		ResolveService resolve = new ResolveService(repo)
		def toObjectId = { rev ->
			String revstr = resolve.toRevisionString(rev)
			JGitUtil.resolveObject(repo, revstr)
		}

		includes.collect(toObjectId).each { object ->
			cmd.add(object)
		}
		excludes.collect(toObjectId).each { object ->
			cmd.not(object)
		}
		paths.each { path ->
			cmd.addPath(path)
		}
		cmd.skip = skipCommits
		cmd.maxCount = maxCommits
		try {
			return cmd.call().collect { JGitUtil.convertCommit(it) }.asImmutable()
		} catch (GitAPIException e) {
			throw new GrgitException('Problem retrieving log.', e)
		}
	}
}