Renamed getBranch and getMaster to more a more accurate name

John Haley · John Haley · commit dd5acb9a2cde · 2014-11-20T11:51:01.000-07:00
diff --git a/README.md b/README.md
@@ -134,12 +134,12 @@ var open = require("nodegit").Repository.open;
 open("tmp")
   // Open the master branch.
   .then(function(repo) {
-    return repo.getMaster();
+    return repo.getMasterCommit();
   })
   // Display information about commits on master.
-  .then(function(branch) {
+  .then(function(firstCommitOnMaster) {
     // Create a new history event emitter.
-    var history = branch.history();
+    var history = firstCommitOnMaster.history();
 
     // Create a counter to only show up to 9 entries.
     var count = 0;
diff --git a/example/apps/git_profanity_check.js b/example/apps/git_profanity_check.js
@@ -35,32 +35,25 @@ else {
 }
 
 // Open repository.
-git.Repo.open(path, function(err, repo) {
-  if (err) {
-    throw new Error(err);
-  }
-
+git.Repo.open(path)
+.then(function(repo) {
   // Open branch, default to master.
-  repo.getBranch(branch, function(err, branch) { 
-    if (err) {
-      throw new Error(err);
+  return repo.getBranchCommit(branch);
+}).then(function(firstCommit) {
+  // Iterate history
+  var history = firstCommit.history();
+
+  // Iterate over every commit message and test for words.
+  history.on('commit', function(commit) {
+    var message = commit.message();
+
+    if (reCurse.test(message)) {
+      console.log('Curse detected in commit', commit.sha());
+      console.log('=> ', message);
+      return;
     }
-
-    // Iterate history
-    var history = branch.history();
-
-    // Iterate over every commit message and test for words.
-    history.on('commit', function(commit) {
-      var message = commit.message();
-
-      if (reCurse.test(message)) {
-        console.log('Curse detected in commit', commit.sha()); 
-        console.log('=> ', message);
-        return;
-      }
-    });
-
-    // Start history iteration.
-    history.start();
   });
+
+  // Start history iteration.
+  history.start();
 });
diff --git a/example/walk-history.js b/example/walk-history.js
@@ -6,10 +6,10 @@ var nodegit = require('../'),
 // that look very similar to calling `git log` from the command line
 
 nodegit.Repository.open(path.resolve(__dirname, '../.git')).then(function(repo) {
-  return repo.getMaster();
-}).then(function(branch){
+  return repo.getMasterCommit();
+}).then(function(firstCommitOnMaster){
   // History returns an event.
-  var history = branch.history(sort.Time);
+  var history = firstCommitOnMaster.history(sort.Time);
 
   // History emits 'commit' event for each commit in the branch's history
   history.on('commit', function(commit) {
diff --git a/example/walk-tree.js b/example/walk-tree.js
@@ -6,9 +6,9 @@ var nodegit = require('../'),
 // tree (directory), or a file.
 
 nodegit.Repository.open(path.resolve(__dirname, '../.git')).then(function(repo) {
-  return repo.getMaster();
-}).then(function(branch) {
-    return branch.getTree();
+  return repo.getMasterCommit();
+}).then(function(firstCommitOnMaster) {
+    return firstCommitOnMaster.getTree();
 }).then(function(tree) {
   // `walk()` returns an event.
   var walker = tree.walk();
diff --git a/generate/descriptor.json b/generate/descriptor.json
@@ -87,6 +87,19 @@
       "functions": {
         "git_branch_next": {
           "ignore": true
+        },
+        "git_branch_create": {
+          "args": {
+            "force": {
+              "isOptional": true
+            },
+            "signature": {
+              "isOptional": true
+            },
+            "log_message": {
+              "isOptional": true
+            }
+          }
         }
       }
     },
diff --git a/lib/repository.js b/lib/repository.js
@@ -24,7 +24,7 @@ Object.defineProperty(Repository.prototype, "openIndex", {
  * @param {Function} callback
  * @return {Branch}
  */
-Repository.prototype.getBranch = function(name, callback) {
+Repository.prototype.getBranchCommit = function(name, callback) {
   var repository = this;
 
   return this.getReference("refs/heads/" + name).then(function(reference) {
@@ -262,13 +262,13 @@ Repository.prototype.createRevWalk = function() {
 };
 
 /**
- * Retrieve the master branch.
+ * Retrieve the master branch commit.
  *
  * @param {Function} callback
  * @return {Branch}
  */
-Repository.prototype.getMaster = function(callback) {
-  return this.getBranch("master", callback);
+Repository.prototype.getMasterCommit = function(callback) {
+  return this.getBranchCommit("master", callback);
 };
 
 /**
diff --git a/test/tests/commit.js b/test/tests/commit.js
@@ -177,8 +177,8 @@ describe("Commit", function() {
   it("can fetch the master branch HEAD", function() {
     var repository = this.repository;
 
-    return repository.getBranch("master").then(function(branch) {
-      return repository.getCommit(branch.sha());
+    return repository.getBranchCommit("master").then(function(commit) {
+      return repository.getCommit(commit.sha());
     });
   });
 
diff --git a/test/tests/revwalk.js b/test/tests/revwalk.js
@@ -12,24 +12,24 @@ describe("Revwalk", function() {
     var test = this;
     return Repository.open(reposPath).then(function(repository) {
       test.repository = repository;
-      return test.repository.getBranch("rev-walk").then(function(branch) {
-        test.branch = branch;
+      return test.repository.getBranchCommit("rev-walk").then(function(commit) {
+        test.commit = commit;
         done();
       });
     });
   });
 
   beforeEach(function() {
     this.walker = this.repository.createRevWalk();
-    this.walker.push(this.branch.id());
+    this.walker.push(this.commit.id());
   });
 
   it("can create a walker", function() {
     assert.ok(this.walker instanceof Revwalk);
   });
 
   it("can push an object", function() {
-    var sha = this.branch.sha();
+    var sha = this.commit.sha();
 
     return this.walker.next().then(function(commit) {
       assert.equal(sha, commit);
@@ -49,7 +49,7 @@ describe("Revwalk", function() {
       assert.equal(commit.toString(),
         "b8a94aefb22d0534cc0e5acf533989c13d8725dc");
       test.walker = test.repository.createRevWalk();
-      test.walker.push(test.branch.id());
+      test.walker.push(test.commit.id());
       test.walker.hide(
         Oid.fromString("b8a94aefb22d0534cc0e5acf533989c13d8725dc"));
 
@@ -89,9 +89,9 @@ describe("Revwalk", function() {
     this.timeout(10000);
     return Repository.open(reposPath).then(function(repository) {
       var walker = repository.createRevWalk();
-      return repository.getMaster().then(function(master) {
+      return repository.getMasterCommit().then(function(firstCommitOnMaster) {
         var did = false;
-        walker.walk(master, function(error, commit) {
+        walker.walk(firstCommitOnMaster, function(error, commit) {
           for (var i = 0; i < 1000; i++) {
             if (true) {
               commit.author().name();
