Существует ли библиотека Diff для Java, которая поддерживает Annotate/Blame?

Я копаю результаты Google для бесплатных (с открытым исходным кодом) Java-библиотек различий, и, кажется, их довольно много (некоторые из них даже работают со стандартными объектами, а не только со строками).

Прежде чем копаться в тоннах результатов поиска и не найти то, что я ищу, я сначала спрошу здесь:

Поддерживает ли какая-либо из этих библиотек diff такую ​​функцию, как cvs annotate или svn blame. я бы хотел

  • передать ток String[] к функции
  • продолжить прохождение старых версий String[] для функции, пока я не израсходую их все, или библиотека не скажет мне, что ни одна оригинальная строка не осталась без аннотации (последняя вещь на самом деле не обязательна, но очень полезна, так как поиск более старых версий String[] стоит дорого, поэтому хотелось бы остановиться как можно раньше)
  • вызвать функцию, которая дает мне ìnt[] это говорит мне для каждой строки текущей версии, в какой версии она была в последний раз изменена или не была ли она вообще изменена (т.е. последняя изменена в самой первой версии).

Наличие поддержки для объектов, которые не являются StringЭто хорошо, но не надо. И если API не совсем так, я думаю, я мог бы жить с этим.

Если их нет, кто-нибудь может предложить расширяемую библиотеку diff, в которую можно легко добавить эту функцию, предпочтительно такую, которая хотела бы получить эту функцию в качестве вклада (и не требует заполнения тонны документов до того, как они примут вклады, как, например, Проект GNU)? Тогда я бы добровольно (по крайней мере, попытался) добавить его туда.

3 ответа

Решение

Я решил реализовать это самостоятельно для библиотеки java-diff-utils Дмитрия Науменко:

/*
   Copyright 2010 Michael Schierl (schierlm@gmx.de)

   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 difflib.annotate;

import java.util.*;

import difflib.*;

/**
 * Generates an annotated version of a revision based on a list of older
 * revisions, like <tt>cvs annotate</tt> or <tt>svn blame</tt>.
 * 
 * @author <a href="schierlm@gmx.de">Michael Schierl</a>
 * 
 * @param <R>
 *            Type of the revision metadata
 */
public class Annotate<R> {

    private final List<R> revisions;
    private final int[] lineNumbers;
    private R currentRevision;
    private final List<Object> currentLines;
    private final List<Integer> currentLineMap;

    /**
     * Creates a new annotation generator.
     * 
     * @param revision
     *            Revision metadata for the revision to be annotated
     * @param targetLines
     *            Lines of the revision to be annotated
     */
    public Annotate(R revision, List<?> targetLines) {
        revisions = new ArrayList<R>();
        lineNumbers = new int[targetLines.size()];
        currentRevision = revision;
        currentLines = new ArrayList<Object>(targetLines);
        currentLineMap = new ArrayList<Integer>();
        for (int i = 0; i < lineNumbers.length; i++) {
            lineNumbers[i] = -1;
            revisions.add(null);
            currentLineMap.add(i);
        }
    }

    /**
     * Check whether there are still lines that are unannotated. In that case,
     * more older revisions should be retrieved and passed to the function. Note
     * that as soon as you pass an empty revision, all lines will be annotated
     * (with a later revision), therefore if you do not have any more revisions,
     * pass an empty revision to annotate the rest of the lines.
     */
    public boolean areLinesUnannotated() {
        for (int i = 0; i < lineNumbers.length; i++) {
            if (lineNumbers[i] == -1 || revisions.get(i) == null)
                return true;
        }
        return false;
    }

    /**
     * Add the previous revision and update annotation info.
     * 
     * @param revision
     *            Revision metadata for this revision
     * @param lines
     *            Lines of this revision
     */
    public void addRevision(R revision, List<?> lines) {
        Patch patch = DiffUtils.diff(currentLines, lines);
        int lineOffset = 0; // remember number of already deleted/added lines
        for (Delta d : patch.getDeltas()) {
            Chunk original = d.getOriginal();
            Chunk revised = d.getRevised();
            int pos = original.getPosition() + lineOffset;
            // delete lines
            for (int i = 0; i < original.getSize(); i++) {
                int origLine = currentLineMap.remove(pos);
                currentLines.remove(pos);
                if (origLine != -1) {
                    lineNumbers[origLine] = original.getPosition() + i;
                    revisions.set(origLine, currentRevision);
                }
            }
            for (int i = 0; i < revised.getSize(); i++) {
                currentLines.add(pos + i, revised.getLines().get(i));
                currentLineMap.add(pos + i, -1);
            }
            lineOffset += revised.getSize() - original.getSize();
        }

        currentRevision = revision;
        if (!currentLines.equals(lines))
            throw new RuntimeException("Patch application failed");
    }

    /**
     * Return the result of the annotation. It will be a List of the same length
     * as the target revision, for which every entry states the revision where
     * the line appeared last.
     */
    public List<R> getAnnotatedRevisions() {
        return Collections.unmodifiableList(revisions);
    }

    /**
     * Return the result of the annotation. It will be a List of the same length
     * as the target revision, for which every entry states the line number in
     * the revision where the line appeared last.
     */
    public int[] getAnnotatedLineNumbers() {
        return (int[]) lineNumbers.clone();
    }
}

Я также отправил его Дмитрию Науменко (с несколькими контрольными случаями) на случай, если он захочет включить его.

Вы можете использовать xwiki-commons-blame-api. На самом деле он использует код из принятого ответа этой ветки ( спасибо Михаэлю Ширлу за то, что он поделился этим кодом в Stackru)

Вы можете увидеть, как использовать его в Java в его модульных тестах.

Или в Scala вроде:

import java.util
import org.xwiki.blame.AnnotatedContent
import org.xwiki.blame.internal.DefaultBlameManager

case class Revision(id: Int,
                    parentId: Option[Int] = None,
                    content: Option[String] = None)

def createAnnotation(revisions: Seq[Revision]): Option[AnnotatedContent[Revision, String]] = {
    val blameManager = new DefaultBlameManager()

    val annotatedContent = revisions.foldLeft(null.asInstanceOf[AnnotatedContent[Revision, String]]){
      (annotation, revision) =>
        blameManager.blame(annotation, revision, splitByWords(revision.content))
    }
    Option(annotatedContent)
}

def splitByWords(content: Option[String]): util.List[String] = {
    val array = content.fold(Array[String]())(_.split("[^\\pL_\\pN]+"))
    util.Arrays.asList(array:_*)
}

Возможно, я ошибаюсь, но я думаю, что annotate / blame нуждается в системе контроля версий, чтобы получить доступ к истории файла. Универсальная библиотека diff не может этого сделать. Так что, если это ваша цель, проверьте библиотеки, которые работают с этими VCS, например, svnkit. Если нет, такая библиотека может быть хорошей отправной точкой для того, как делается аннотирование / обвинение, очень часто это включает в себя определение цепочки всех версий файла.

Другие вопросы по тегам