Add bindings for git_reference_is_valid_name

docs/references.rst

@@ -23,6 +23,24 @@ Example::
     >>> repo.references.delete('refs/tags/version1')
 
 
+Functions
+===================================
+
+.. autofunction:: pygit2.reference_is_valid_name
+
+Check if the passed string is a valid reference name.
+
+   Example::
+
+     >>> from pygit2 import reference_is_valid_name
+     >>> reference_is_valid_name("refs/heads/master")
+     True
+     >>> reference_is_valid_name("HEAD")
+     True
+     >>> reference_is_valid_name("refs/heads/..")
+     False
+
+
 The Reference type
 ====================
 

src/pygit2.c

@@ -183,13 +183,35 @@ init_file_backend(PyObject *self, PyObject *args)
 }
 
 
+PyDoc_STRVAR(reference_is_valid_name__doc__,
+    "reference_is_valid_name(refname) -> bool\n"
+    "\n"
+    "Check if the passed string is a valid reference name.");
+PyObject *
+reference_is_valid_name(PyObject *self, PyObject *py_refname)
+{
+    char* refname;
+    int result;
+
+    refname = py_str_to_c_str(py_refname, NULL);
+    if (refname == NULL) {
+        return NULL;
+    }
+
+    result = git_reference_is_valid_name(refname);
+    free(refname);
+    return PyBool_FromLong(result);
+}
+
+
 PyMethodDef module_methods[] = {
     {"init_file_backend", init_file_backend, METH_VARARGS,
     init_file_backend__doc__},
     {"discover_repository", discover_repository, METH_VARARGS,
      discover_repository__doc__},
     {"hashfile", hashfile, METH_VARARGS, hashfile__doc__},
     {"hash", hash, METH_VARARGS, hash__doc__},
+    {"reference_is_valid_name", reference_is_valid_name, METH_O, reference_is_valid_name__doc__},
     {"option", option, METH_VARARGS, option__doc__},
     {NULL}
 };

test/test_refs.py

@@ -33,7 +33,7 @@
 import pytest
 
 from pygit2 import GitError, GIT_REF_OID, GIT_REF_SYMBOLIC, Signature
-from pygit2 import Commit, Tree
+from pygit2 import Commit, Tree, reference_is_valid_name
 from . import utils
 
 LAST_COMMIT = '2be5719152d4f82c7302b1c0932d8e5f0a4a0e98'
@@ -416,3 +416,41 @@ def test_peel(self):
         ref = self.repo.lookup_reference('refs/heads/master')
         commit = ref.peel(Commit)
         assert commit.tree.id == ref.peel(Tree).id
+
+
+class ReferenceIsValidNameTest(utils.NoRepoTestCase):
+
+    def test_valid_reference_names_ascii(self):
+        assert reference_is_valid_name('HEAD')
+        assert reference_is_valid_name('refs/heads/master')
+        assert reference_is_valid_name('refs/heads/perfectly/valid')
+        assert reference_is_valid_name('refs/tags/v1')
+        assert reference_is_valid_name('refs/special/ref')
+
+    def test_valid_reference_names_unicode(self):
+        assert reference_is_valid_name('refs/heads/ünicöde')
+        assert reference_is_valid_name('refs/tags/😀')
+
+    def test_invalid_reference_names(self):
+        assert not reference_is_valid_name('')
+        assert not reference_is_valid_name(' refs/heads/master')
+        assert not reference_is_valid_name('refs/heads/in..valid')
+        assert not reference_is_valid_name('refs/heads/invalid~')
+        assert not reference_is_valid_name('refs/heads/invalid^')
+        assert not reference_is_valid_name('refs/heads/invalid:')
+        assert not reference_is_valid_name('refs/heads/invalid\\')
+        assert not reference_is_valid_name('refs/heads/invalid?')
+        assert not reference_is_valid_name('refs/heads/invalid[')
+        assert not reference_is_valid_name('refs/heads/invalid*')
+        assert not reference_is_valid_name('refs/heads/@{no}')
+        assert not reference_is_valid_name('refs/heads/foo//bar')
+
+    def test_invalid_arguments(self):
+        with pytest.raises(TypeError):
+            reference_is_valid_name()
+        with pytest.raises(TypeError):
+            reference_is_valid_name(None)
+        with pytest.raises(TypeError):
+            reference_is_valid_name(1)
+        with pytest.raises(TypeError):
+            reference_is_valid_name('too', 'many')