-
Notifications
You must be signed in to change notification settings - Fork 700
Expand file tree
/
Copy pathcommit.js
More file actions
357 lines (336 loc) · 9.98 KB
/
Copy pathcommit.js
File metadata and controls
357 lines (336 loc) · 9.98 KB
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
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
var git = require( '../' ),
success = require('./utilities').success,
events = require('events');
/**
* Convenience commit constructor.
*
* @constructor
* @param {git.raw.Repo} rawRepo Raw repository object.
* @param {git.raw.Commit} [rawCommit = new git.raw.Commit(rawRepo)] Raw commit object.
*/
var Commit = function(rawRepo, rawCommit) {
if (!(rawRepo instanceof git.raw.Repo)) {
throw new git.error('First parameter for Commit must be a raw repo');
}
this.rawRepo = rawRepo;
if (rawCommit instanceof git.raw.Commit) {
this.rawCommit = rawCommit;
} else {
this.rawCommit = new git.raw.Commit();
}
};
/**
* Look up the commit referenced by oid, replace this.commit with the result.
*
* @param {Oid|git.raw.Oid|String} oid A representation of an OID used to lookup the commit.
* @param {Commit~lookupCallback} callback
*/
Commit.prototype.lookup = function(oid, callback) {
/**
* @callback Commit~lookupCallback Callback executed on lookup completion.
* @param {GitError|null} error An Error or null if successful.
* @param {Commit|null} commit Retrieved commit object or null.
*/
if (typeof oid !== 'undefined' &&
typeof oid !== 'string' &&
!(oid instanceof git.raw.Oid)) {
oid = oid.getRawOid();
}
var self = this;
self.rawCommit.lookup(self.rawRepo, oid, function commitLookup(error, rawCommit) {
if (success(error, callback)) {
self.rawCommit = rawCommit;
callback(null, self);
}
});
};
/**
* Retrieve the commit's OID.
*
* @param {Commit~oidCallback} callback
*/
Commit.prototype.oid = function(callback) {
/**
* @callback Commit~oidCallback Callback executed on OID retrieval.
* @param {GitError|null} error An Error or null if successful.
* @param {Oid|null} commit Retrieved OID object or null.
*/
callback(null, new git.oid(this.rawCommit.oid()));
};
/**
* Retrieve the SHA.
*
* @param {Commit~shaCallback} callback
*/
Commit.prototype.sha = function(callback) {
/**
* @callback Commit~shaCallback Callback executed on SHA retrieval.
* @param {GitError|null} error An Error or null if successful.
* @param {String|null} sha Retrieved SHA.
*/
this.oid(function(error, oid) {
if (!success(error, callback)) {
return;
}
oid.sha(function(error, sha) {
if (!success(error, callback)) {
return;
}
callback(null, sha);
});
});
};
/**
* Retrieve the message
*
* @param {Commit~messageCallback} callback
*/
Commit.prototype.message = function(callback) {
/**
* @callback Commit~messageCallback Callback executed on message retrieval.
* @param {GitError|null} error An Error or null if successful.
* @param {String|null} message Retrieved message.
*/
this.rawCommit.message(function(error, message) {
if (success(error, callback)) {
callback(null, message);
}
});
};
/**
* Retrieve the commit time as a unix timestamp.
*
* @param {Commit~timeCallback} callback
*/
Commit.prototype.time = function(callback) {
/**
* @callback Commit~timeCallback Callback executed on time retrieval.
* @param {GitError|null} error An Error or null if successful.
* @param {Integer|null} time Retrieved time in seconds.
*/
this.rawCommit.time(function(error, time) {
if (success(error, callback)) {
// git_commit_time returns timestamp in s, converting to ms here
callback(null, time * 1000);
}
});
};
/**
* Retrieve the commit time as a Date object.
*
* @param {Commit~dateCallback} callback
*/
Commit.prototype.date = function(callback) {
/**
* @callback Commit~dateCallback Callback executed on date retrieval.
* @param {GitError|null} error An Error or null if successful.
* @param {Date|null} time Retrieved time as a Date object.
*/
this.time(function(error, time) {
if (success(error, callback)) {
callback(null, new Date(time));
}
});
};
/**
* Retrieve the commit's positive or negative timezone offset, in minutes from UTC.
*
* @param {Commit~offsetCallback} callback
*/
Commit.prototype.offset = function(callback) {
/**
* @callback Commit~offsetCallback Callback executed on offset retrieval.
* @param {GitError|null} error An Error or null if successful.
* @param {Integer|null} offset Retrieved offset in in minutes from UTC.
*/
this.rawCommit.offset(function(error, offset) {
if (success(error, callback)) {
callback(null, offset);
}
});
};
/**
* Retrieve the commit's author signature.
*
* @param {Commit~authorCallback} callback
*/
Commit.prototype.author = function(callback) {
/**
* @callback Commit~authorCallback Callback executed on author retrieval.
* @param {GitError|null} error An Error or null if successful.
* @param {Signature|null} author Retrieved author signature.
*/
this.rawCommit.author(function(error, rawSignature) {
if (success(error, callback)) {
callback(null, new git.signature(rawSignature));
}
});
};
/**
* Retrieve the commit's committer.
*
* @param {Commit~committerCallback} callback
*/
Commit.prototype.committer = function(callback) {
/**
* @callback Commit~committerCallback Callback executed on committer retrieval.
* @param {GitError|null} error An Error or null if successful.
* @param {Signature|null} committer Retrieved committer signature.
*/
this.rawCommit.committer(function(error, rawSignature) {
if (success(error, callback)) {
callback(null, new git.signature(rawSignature));
}
});
};
/**
* Retrieve the tree for this commit.
*
* @param {Commit~treeCallback} callback
*/
Commit.prototype.tree = function(callback) {
/**
* @callback Commit~treeCallback Callback executed on tree retrieval.
* @param {GitError|null} error An Error or null if successful.
* @param {Tree|null} tree Retrieved tree.
*/
var self = this;
self.rawCommit.tree(function commitTree(error, rawTree) {
if (success(error, callback)) {
callback(null, new git.tree(self.rawRepo, rawTree));
}
});
};
/**
* Retrieve the file represented by path for this commit.
* Path must be relative to repository root.
*
* @param {String} path
* @param {Commit~fileCallback} callback
*/
Commit.prototype.file = function(path, callback) {
/**
* @callback Commit~fileCallback Callback executed on file retrieval.
* @param {GitError|null} error An Error or null if successful.
* @param {Entry|null} file Retrieved file entry.
*/
this.tree(function commitFileCallback(error, tree) {
if (!success(error, callback)) {
return;
}
tree.entry(path, function(error, entry) {
if (success(error, callback)) {
callback(null, entry);
}
});
});
};
/**
* Walk the history from this commit backwards.
* An EventEmitter is returned that will emit a 'commit' event for each
* commit in the history, and one 'end' event when the walk is completed.
*
* @fires Commit#commit
* @fires Commit#end
*
* @return {EventEmitter} historyWalkEmitter
*/
Commit.prototype.history = function() {
var event = new events.EventEmitter(),
self = this;
self.oid(function commitOid(error, oid) {
(new git.revwalk(self.rawRepo)).allocate(function createRevwalk(error, revwalk) {
var commits = [];
revwalk.walk(oid, function commitRevWalk(error, index, commit, noMoreCommits) {
if(error) {
event.emit('end', error, commits);
return false;
}
if (noMoreCommits) {
/**
* End event.
*
* @event Commit#end
*
* @param {GitError|null} error An error object if there was an issue, null otherwise.
* @param {Commit[]} commits The commits.
*/
event.emit('end', null, commits);
return;
}
/**
* Commit event.
*
* @event Commit#commit
*
* @param {GitError|null} error An error object if there was an issue, null otherwise.
* @param {Commit} commit The commit.
*/
event.emit('commit', null, commit);
commits.push(commit);
});
});
});
return event;
};
/**
* Retrieve the commit's parents.
*
* @param {Commit~parentsCallback} callback
*/
Commit.prototype.parents = function(callback) {
/**
* @callback Commit~parentsCallback Callback executed on parents retrieval.
* @param {GitError|null} error An Error or null if successful.
* @param {Commit[]|null} parents Commit's parent(s).
*/
var self = this;
self.rawCommit.parents(function processParent(error, rawParents) {
if (success(error, callback)) {
var parents = [];
rawParents.forEach(function eachParent(rawParent) {
parents.push(new Commit(self.rawRepo, rawParent));
});
callback(null, parents);
}
});
};
/**
* Generate an array of diff trees showing changes between this commit
* and its parent(s).
*
* @param {Commit~parentsDiffTreesCallback} callback
*/
Commit.prototype.parentsDiffTrees = function(callback) {
/**
* @callback Commit~parentsDiffTreesCallback Callback executed on diff trees retrieval.
* @param {GitError|null} error An Error or null if successful.
* @param {DiffList[]|null} diffLists Array of DiffTrees showing changes between this commit and its parent(s)
*/
var self = this;
self.sha(function(error, commitSha) {
if (!success(error, callback)) {
return;
}
self.parents(function commitParents(error, parents) {
if (!success(error, callback)) {
return;
}
var parentDiffLists = [];
parents.forEach(function commitEachParent(parent) {
parent.sha(function commitParentSha(error, parentSha) {
(new git.diffList(self.rawRepo)).treeToTree(parentSha, commitSha, function walkDiffList(error, diffList) {
if (!success(error, callback)) {
return;
}
parentDiffLists.push(diffList);
if (parentDiffLists.length === parents.length) {
callback(null, parentDiffLists);
}
});
});
});
});
});
};
exports.commit = Commit;