Support updating task lists with non-breaking spaces

Author: mtodd

app/assets/javascripts/task_lists.coffee

@@ -99,8 +99,12 @@
 # To automatically enable TaskLists, add the `js-task-list-enable` class to the
 # `js-task-list-container`.
 
-incomplete = "[ ]"
-complete   = "[x]"
+incomplete     = "[ ]"
+incompleteNBSP = "[\xC2\xA0]"
+complete       = "[x]"
+
+escape = (str) ->
+  str.replace(/([\[\]])/g, "\\$1")
 
 # Pattern used to identify all task list items.
 # Useful when you need iterate over all items.
@@ -109,8 +113,9 @@ itemPattern = ///
   (?:\s*[-+*]|(?:\d+\.))? # optional list prefix
   \s*                     # optional whitespace prefix
   (                       # checkbox
-    #{complete.  replace(/([\[\]])/g, "\\$1")}|
-    #{incomplete.replace(/([\[\]])/g, "\\$1")}
+    #{escape(complete)}|
+    #{escape(incomplete)}|
+    #{escape(incompleteNBSP)}
   )
   (?=\s)                  # followed by whitespace
 ///
@@ -132,8 +137,9 @@ codeFencesPattern = ///
 itemsInParasPattern = ///
   ^
   (
-    #{complete.  replace(/[\[\]]/g, "\\$1")}|
-    #{incomplete.replace(/[\[\]]/g, "\\$1")}
+    #{escape(complete)}|
+    #{escape(incomplete)}|
+    #{escape(incompleteNBSP)}
   )
   .+
   $
@@ -153,7 +159,7 @@ updateTaskListItem = (source, itemIndex, checked) ->
       if index == itemIndex
         line =
           if checked
-            line.replace(incomplete, complete)
+            line.replace(incomplete, complete).replace(incompleteNBSP, complete)
           else
             line.replace(complete, incomplete)
     line

test/unit/test_updates.coffee

@@ -20,19 +20,34 @@ module "TaskList updates",
       disabled: true
       checked: false
 
+    @incompleteNBSPItem = $ '<li>', class: 'task-list-item'
+    @incompleteNBSPCheckbox = $ '<input>',
+      type: 'checkbox'
+      class: 'task-list-item-checkbox'
+      disabled: true
+      checked: false
+
     @field = $ '<textarea>', class: 'js-task-list-field', text: """
       - [x] complete
       - [ ] incomplete
+      - [\xC2\xA0] incompleteNBSP
     """
 
     @changes =
       toComplete: """
       - [ ] complete
       - [ ] incomplete
+      - [\xC2\xA0] incompleteNBSP
       """
       toIncomplete: """
       - [x] complete
       - [x] incomplete
+      - [\xC2\xA0] incompleteNBSP
+      """
+      toIncompleteNBSP: """
+      - [x] complete
+      - [ ] incomplete
+      - [x] incompleteNBSP
       """
 
     @completeItem.append @completeCheckbox
@@ -43,6 +58,10 @@ module "TaskList updates",
     @list.append @incompleteItem
     @incompleteItem.expectedIndex = 2
 
+    @incompleteNBSPItem.append @incompleteNBSPCheckbox
+    @list.append @incompleteNBSPItem
+    @incompleteNBSPItem.expectedIndex = 3
+
     @container.append @list
     @container.append @field
 
@@ -79,3 +98,17 @@ asyncTest "updates the source, marking the complete item as incomplete", ->
   , 20
 
   @completeCheckbox.click()
+
+asyncTest "updates the source for items with non-breaking spaces", ->
+  expect 3
+
+  @field.on 'tasklist:changed', (event, index, checked) =>
+    ok checked
+    equal index, @incompleteNBSPItem.expectedIndex
+    equal @field.val(), @changes.toIncompleteNBSP
+
+  setTimeout ->
+    start()
+  , 20
+
+  @incompleteNBSPCheckbox.click()