1 /*
2 * Copyright (C) 2012, IBM Corporation and others.
3 * and other copyright owners as documented in the project's IP log.
4 *
5 * This program and the accompanying materials are made available
6 * under the terms of the Eclipse Distribution License v1.0 which
7 * accompanies this distribution, is reproduced below, and is
8 * available at http://www.eclipse.org/org/documents/edl-v10.php
9 *
10 * All rights reserved.
11 *
12 * Redistribution and use in source and binary forms, with or
13 * without modification, are permitted provided that the following
14 * conditions are met:
15 *
16 * - Redistributions of source code must retain the above copyright
17 * notice, this list of conditions and the following disclaimer.
18 *
19 * - Redistributions in binary form must reproduce the above
20 * copyright notice, this list of conditions and the following
21 * disclaimer in the documentation and/or other materials provided
22 * with the distribution.
23 *
24 * - Neither the name of the Eclipse Foundation, Inc. nor the
25 * names of its contributors may be used to endorse or promote
26 * products derived from this software without specific prior
27 * written permission.
28 *
29 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND
30 * CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES,
31 * INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
32 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
33 * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR
34 * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
35 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
36 * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
37 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
38 * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
39 * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
40 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
41 * ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
42 */
43 package org.eclipse.jgit.merge;
44
45 import java.util.List;
46
47 import org.eclipse.jgit.lib.PersonIdent;
48 import org.eclipse.jgit.lib.Ref;
49 import org.eclipse.jgit.revwalk.RevCommit;
50 import org.eclipse.jgit.util.GitDateFormatter;
51 import org.eclipse.jgit.util.GitDateFormatter.Format;
52
53 /**
54 * Formatter for constructing the commit message for a squashed commit.
55 * <p>
56 * The format should be the same as C Git does it, for compatibility.
57 */
58 public class SquashMessageFormatter {
59
60 private GitDateFormatter dateFormatter;
61
62 /**
63 * Create a new squash message formatter.
64 */
65 public SquashMessageFormatter() {
66 dateFormatter = new GitDateFormatter(Format.DEFAULT);
67 }
68 /**
69 * Construct the squashed commit message.
70 *
71 * @param squashedCommits
72 * the squashed commits
73 * @param target
74 * the target branch
75 * @return squashed commit message
76 */
77 public String format(List<RevCommit> squashedCommits, Ref target) {
78 StringBuilder sb = new StringBuilder();
79 sb.append("Squashed commit of the following:\n"); //$NON-NLS-1$
80 for (RevCommit c : squashedCommits) {
81 sb.append("\ncommit "); //$NON-NLS-1$
82 sb.append(c.getName());
83 sb.append("\n"); //$NON-NLS-1$
84 sb.append(toString(c.getAuthorIdent()));
85 sb.append("\n\t"); //$NON-NLS-1$
86 sb.append(c.getShortMessage());
87 sb.append("\n"); //$NON-NLS-1$
88 }
89 return sb.toString();
90 }
91
92 private String toString(PersonIdent author) {
93 final StringBuilder a = new StringBuilder();
94
95 a.append("Author: "); //$NON-NLS-1$
96 a.append(author.getName());
97 a.append(" <"); //$NON-NLS-1$
98 a.append(author.getEmailAddress());
99 a.append(">\n"); //$NON-NLS-1$
100 a.append("Date: "); //$NON-NLS-1$
101 a.append(dateFormatter.formatDate(author));
102 a.append("\n"); //$NON-NLS-1$
103
104 return a.toString();
105 }
106 }