Replace spaces with dashes when naming branches (jorio#88)

Author: zachrammell

gitfourchette/forms/newbranchdialog.py

@@ -59,6 +59,7 @@ def __init__(
 
         self.ui.nameEdit.setFocus()
         self.ui.nameEdit.selectAll()
+        self.ui.nameEdit.setValidator(ReplaceSpacesWithDashes())
         self.preSelectLeaf(self.ui.nameEdit)
 
     @property

gitfourchette/tasks/branchtasks.py

@@ -92,6 +92,7 @@ def flow(self, oldBranchName: str):
             subtitle=_("Current name: {0}", oldBranchName))
         dlg.setText(oldBranchName)
         dlg.setValidator(lambda name: nameValidationMessage(name, forbiddenBranchNames, nameTaken))
+        dlg.lineEdit.setValidator(ReplaceSpacesWithDashes())
         dlg.okButton.setText(_("Rename"))
 
         # Pre-select leaf name (e.g. in "folder/leaf" select only "leaf")
@@ -159,6 +160,7 @@ def validate(newFolderName: str) -> str:
         dlg.setValidator(validate)
         dlg.okButton.setText(_("Rename"))
         dlg.lineEdit.setPlaceholderText(_("Leave blank to move the branches to the root folder."))
+        dlg.lineEdit.setValidator(ReplaceSpacesWithDashes())
 
         yield from self.flowDialog(dlg)
         dlg.deleteLater()

gitfourchette/toolbox/__init__.py

@@ -98,3 +98,4 @@
 )
 from .urltooltip import UrlToolTip
 from .validatormultiplexer import ValidatorMultiplexer
+from .validators import ReplaceSpacesWithDashes

gitfourchette/toolbox/validators.py

@@ -0,0 +1,13 @@
+# -----------------------------------------------------------------------------
+# Copyright (C) 2025 Iliyas Jorio.
+# This file is part of GitFourchette, distributed under the GNU GPL v3.
+# For full terms, see the included LICENSE file.
+# -----------------------------------------------------------------------------
+
+from gitfourchette.qt import QValidator
+
+
+class ReplaceSpacesWithDashes(QValidator):
+    def validate(self, text: str, pos: int) -> tuple[QValidator.State, str, int]:
+        text = text.replace(" ", "-")
+        return QValidator.State.Acceptable, text, pos

test/test_tasks_branch.py

@@ -59,6 +59,29 @@ def testNewBranch(tempDir, mainWindow, method, switch):
         assert repo.head_branch_shorthand == 'master'
 
 
+def testNewBranchNaming(tempDir, mainWindow):
+    """Test that spaces in branch names are automatically replaced with dashes"""
+    wd = unpackRepo(tempDir)
+    rw = mainWindow.openRepo(wd)
+    sb = rw.sidebar
+    repo = rw.repo
+
+    node = sb.findNodeByKind(SidebarItem.LocalBranchesHeader)
+    menu = sb.makeNodeMenu(node)
+    triggerMenuAction(menu, "new branch")
+
+    dlg: NewBranchDialog = findQDialog(rw, "new branch")
+    nameEdit = dlg.ui.nameEdit
+
+    nameEdit.setText("hello branch")
+
+    assert nameEdit.text() == "hello-branch"
+
+    dlg.accept()
+
+    assert 'hello-branch' in repo.branches.local
+
+
 def testNewBranchThenSwitchBlockedByConflicts(tempDir, mainWindow):
     wd = unpackRepo(tempDir)
     reposcenario.statelessConflictingChange(wd)
@@ -182,13 +205,22 @@ def testRenameBranch(tempDir, mainWindow, method):
         "nope.lock", "nope/", "nope.",
         "nope/.nope", "nope//nope", "nope@{nope", "no..pe",
         ".nope", "/nope",
-        "no pe", "no~pe", "no^pe", "no:pe", "no[pe", "no?pe", "no*pe", "no\\pe",
+        "no~pe", "no^pe", "no:pe", "no[pe", "no?pe", "no*pe", "no\\pe",
         "nul", "nope/nul", "nul/nope", "lpt3", "com2",
     ]
+    fixableNames = [
+        # Illegal patterns that can be automatically fixed by the input field
+        "no pe",
+    ]
     for bad in badNames:
         nameEdit.setText(bad)
         assert not okButton.isEnabled(), f"name shouldn't pass validation: {bad}"
         QTest.qWait(1)  # go through ValidatorMultiplexer's tooltip code path for coverage
+    for fixable in fixableNames:
+        nameEdit.setText(fixable)
+        nameEdit.textEdited.emit(fixable)
+        assert okButton.isEnabled(), f"name should pass validation: {fixable}"
+        QTest.qWait(1)  # go through ValidatorMultiplexer's tooltip code path for coverage
 
     nameEdit.setText("mainbranch")
     assert okButton.isEnabled()
@@ -305,13 +337,20 @@ def testRenameBranchFolder(tempDir, mainWindow, method, newName):
         "nope.lock", "nope/", "nope.",
         "nope/.nope", "nope//nope", "nope@{nope", "no..pe",
         ".nope", "/nope",
-        "no pe", "no~pe", "no^pe", "no:pe", "no[pe", "no?pe", "no*pe", "no\\pe",
+        "no~pe", "no^pe", "no:pe", "no[pe", "no?pe", "no*pe", "no\\pe",
         "nul", "nope/nul", "nul/nope", "lpt3", "com2",
     ]
+    fixableNames = [
+        # Illegal patterns that can be automatically fixed by the input field
+        "no pe",
+    ]
     for bad in badNames:
         nameEdit.setText(bad)
         assert not okButton.isEnabled(), f"name shouldn't pass validation: {bad}"
         print(bad, "-->", nameEdit.actions()[0].toolTip())
+    for fixable in fixableNames:
+        nameEdit.setText(fixable)
+        assert okButton.isEnabled(), f"name should pass validation: {fixable}"
 
     nameEdit.setText(newName)
     assert okButton.isEnabled()