1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
|
using System;
using System.Collections;
using System.Collections.Generic;
using System.Diagnostics;
using System.Globalization;
using System.Linq;
using LibGit2Sharp.Core;
using LibGit2Sharp.Core.Compat;
using LibGit2Sharp.Core.Handles;
namespace LibGit2Sharp
{
/// <summary>
/// A collection of <see cref = "Note"/> exposed in the <see cref = "Repository"/>.
/// </summary>
[DebuggerDisplay("{DebuggerDisplay,nq}")]
public class NoteCollection : IEnumerable<Note>
{
private readonly Repository repo;
private readonly Lazy<string> defaultNamespace;
/// <summary>
/// Needed for mocking purposes.
/// </summary>
protected NoteCollection()
{ }
internal NoteCollection(Repository repo)
{
this.repo = repo;
defaultNamespace = new Lazy<string>(RetrieveDefaultNamespace);
}
#region Implementation of IEnumerable
/// <summary>
/// Returns an enumerator that iterates through the collection.
/// </summary>
/// <returns>An <see cref = "IEnumerator{T}" /> object that can be used to iterate through the collection.</returns>
public virtual IEnumerator<Note> GetEnumerator()
{
return this[DefaultNamespace].GetEnumerator();
}
/// <summary>
/// Returns an enumerator that iterates through the collection.
/// </summary>
/// <returns>An <see cref = "IEnumerator" /> object that can be used to iterate through the collection.</returns>
IEnumerator IEnumerable.GetEnumerator()
{
return GetEnumerator();
}
#endregion
/// <summary>
/// The default namespace for notes.
/// </summary>
public virtual string DefaultNamespace
{
get { return defaultNamespace.Value; }
}
/// <summary>
/// The list of canonicalized namespaces related to notes.
/// </summary>
public virtual IEnumerable<string> Namespaces
{
get
{
return NamespaceRefs.Select(UnCanonicalizeName);
}
}
internal IEnumerable<string> NamespaceRefs
{
get
{
return new[] { NormalizeToCanonicalName(DefaultNamespace) }.Concat(
from reference in repo.Refs
select reference.CanonicalName into refCanonical
where refCanonical.StartsWith(Reference.NotePrefix, StringComparison.Ordinal) && refCanonical != NormalizeToCanonicalName(DefaultNamespace)
select refCanonical);
}
}
/// <summary>
/// Gets the collection of <see cref = "Note"/> associated with the specified <see cref = "ObjectId"/>.
/// </summary>
public virtual IEnumerable<Note> this[ObjectId id]
{
get
{
Ensure.ArgumentNotNull(id, "id");
return NamespaceRefs
.Select(ns => RetrieveNote(id, ns))
.Where(n => n != null);
}
}
/// <summary>
/// Gets the collection of <see cref = "Note"/> associated with the specified namespace.
/// <para>This is similar to the 'get notes list' command.</para>
/// </summary>
public virtual IEnumerable<Note> this[string @namespace]
{
get
{
Ensure.ArgumentNotNull(@namespace, "@namespace");
string canonicalNamespace = NormalizeToCanonicalName(@namespace);
return Proxy.git_note_foreach(repo.Handle, canonicalNamespace,
(blobId,annotatedObjId) => RetrieveNote(annotatedObjId, canonicalNamespace));
}
}
internal Note RetrieveNote(ObjectId targetObjectId, string canonicalNamespace)
{
using (NoteSafeHandle noteHandle = Proxy.git_note_read(repo.Handle, canonicalNamespace, targetObjectId))
{
return noteHandle == null ? null :
Note.BuildFromPtr(noteHandle, UnCanonicalizeName(canonicalNamespace), targetObjectId);
}
}
private string RetrieveDefaultNamespace()
{
string notesRef = Proxy.git_note_default_ref(repo.Handle);
return UnCanonicalizeName(notesRef);
}
internal static string NormalizeToCanonicalName(string name)
{
Ensure.ArgumentNotNullOrEmptyString(name, "name");
if (name.LooksLikeNote())
{
return name;
}
return string.Concat(Reference.NotePrefix, name);
}
internal string UnCanonicalizeName(string name)
{
Ensure.ArgumentNotNullOrEmptyString(name, "name");
if (!name.LooksLikeNote())
{
return name;
}
return name.Substring(Reference.NotePrefix.Length);
}
/// <summary>
/// Creates or updates a <see cref = "Note"/> on the specified object, and for the given namespace.
/// </summary>
/// <param name = "targetId">The target <see cref = "ObjectId"/>, for which the note will be created.</param>
/// <param name = "message">The note message.</param>
/// <param name = "author">The author.</param>
/// <param name = "committer">The committer.</param>
/// <param name = "namespace">The namespace on which the note will be created. It can be either a canonical namespace or an abbreviated namespace ('refs/notes/myNamespace' or just 'myNamespace').</param>
/// <returns>The note which was just saved.</returns>
public virtual Note Add(ObjectId targetId, string message, Signature author, Signature committer, string @namespace)
{
Ensure.ArgumentNotNull(targetId, "targetId");
Ensure.ArgumentNotNullOrEmptyString(message, "message");
Ensure.ArgumentNotNull(author, "author");
Ensure.ArgumentNotNull(committer, "committer");
Ensure.ArgumentNotNullOrEmptyString(@namespace, "@namespace");
string canonicalNamespace = NormalizeToCanonicalName(@namespace);
Remove(targetId, author, committer, @namespace);
Proxy.git_note_create(repo.Handle, author, committer, canonicalNamespace, targetId, message, true);
return RetrieveNote(targetId, canonicalNamespace);
}
/// <summary>
/// Deletes the note on the specified object, and for the given namespace.
/// </summary>
/// <param name = "targetId">The target <see cref = "ObjectId"/>, for which the note will be created.</param>
/// <param name = "author">The author.</param>
/// <param name = "committer">The committer.</param>
/// <param name = "namespace">The namespace on which the note will be removed. It can be either a canonical namespace or an abbreviated namespace ('refs/notes/myNamespace' or just 'myNamespace').</param>
public virtual void Remove(ObjectId targetId, Signature author, Signature committer, string @namespace)
{
Ensure.ArgumentNotNull(targetId, "targetId");
Ensure.ArgumentNotNull(author, "author");
Ensure.ArgumentNotNull(committer, "committer");
Ensure.ArgumentNotNullOrEmptyString(@namespace, "@namespace");
string canonicalNamespace = NormalizeToCanonicalName(@namespace);
Proxy.git_note_remove(repo.Handle, canonicalNamespace, author, committer, targetId);
}
private string DebuggerDisplay
{
get
{
return string.Format(CultureInfo.InvariantCulture,
"Count = {0}", this.Count());
}
}
}
}
|
