fix: added tests for replaceQuote and made its implementation more robust

Author: eileenoo

spec/smartQuotes.spec.js

@@ -1,5 +1,5 @@
 import {expect} from 'chai'
-import {isDoubleQuote, isSingleQuote, isWhitespace, isSeparatorOrWhitespace, isApostrophe} from '../src/smartQuotes'
+import {isDoubleQuote, isSingleQuote, isWhitespace, isSeparatorOrWhitespace, isApostrophe, replaceQuote} from '../src/smartQuotes'
 
 const allSingleQuotes = ['‘', '’', '‹', '›', '‚', '‘', '›', '‹', `'`, `‘`]
 const allDoubleQuotes = ['«', '»', '»', '«', '"', '"', '“', '”', '”', '”', '“', '“', '„', '“']
@@ -8,7 +8,7 @@ const nonStringValues = [undefined, null, true, 123, NaN]
 const whitespaceChars = [' ', '\t', '\n', '\r', '\v', '\f']
 const separatorValues = ['>', '-', '–—']
 
-describe('Smart Quotes Helper Functions', () => {
+describe('Smart Quotes Helper Functions:', () => {
   describe('isDoubleQuote', () => {
     it('Should return false for non double quote values', () => {
       [...charValues, ...separatorValues, ...nonStringValues, ...allSingleQuotes].forEach(value => {
@@ -52,7 +52,7 @@ describe('Smart Quotes Helper Functions', () => {
   })
 
   describe('isSeparatorOrWhitespace', () => {
-    it('should return false for non whitespace / separator characters', () => {
+    it('should return false for non whitespace/ separator characters', () => {
       [...charValues, ...nonStringValues ].forEach(value => {
         expect(isSeparatorOrWhitespace(value)).to.equal(false, `Failed for: ${value}`)
       })
@@ -80,3 +80,37 @@ describe('Smart Quotes Helper Functions', () => {
   })
 })
 
+const createRangeWithText = (text) => {
+  const textNode = document.createTextNode(text)
+  const range = document.createRange()
+  range.selectNodeContents(textNode)
+  return range
+}
+
+describe('replaceQuote(): ', () => {
+  const testString = '123 "you'
+  const index = testString.indexOf('"')
+
+  it('should replace quote at given index', () => {
+    const range = createRangeWithText(testString)
+    const replacedTextNode = replaceQuote(range, index, '`')
+    expect(replacedTextNode.textContent).to.equal('123 `you')
+  })
+
+  it('should return null if range is invalid', () => {
+    const invalidNodeValue = replaceQuote(undefined, index, '`')
+    expect(invalidNodeValue).to.equal(null)
+  })
+
+  it('should return null if range is empty', () => {
+    const range = createRangeWithText('')
+    const replacedTextNode = replaceQuote(range, 0, '`')
+    expect(replacedTextNode).to.equal(null)
+  })
+
+  it('should insert quote at the end, if index is out of bounce', () => {
+    const range = createRangeWithText(testString)
+    const replacedTextNode = replaceQuote(range, 40, '`')
+    expect(replacedTextNode.textContent).to.equal(`${testString}${'`'}`)
+  })
+})

src/smartQuotes.js

@@ -4,7 +4,7 @@ export const shouldApplySmartQuotes = (config, target) => {
   const {smartQuotes, quotes, singleQuotes} = config
   return !!smartQuotes && isValidQuotePairConfig(quotes) && isValidQuotePairConfig(singleQuotes) && target.isContentEditable
 }
-// TODO: isDoubleQuote, isSingleQuote, isApostrophe, isWhitespace accept more than one char
+
 export const isDoubleQuote = (char) => /^[«»"“”„]$/.test(char)
 export const isSingleQuote = (char) => /^[‘’‹›‚']$/.test(char)
 export const isApostrophe = (char) => /^[’']$/.test(char)
@@ -15,14 +15,16 @@ const shouldBeOpeningQuote = (text, indexCharBefore) => indexCharBefore < 0 || i
 const shouldBeClosingQuote = (text, indexCharBefore) => !!text[indexCharBefore] && !isSeparatorOrWhitespace(text[indexCharBefore])
 const hasCharAfter = (textArr, indexCharAfter) => !!textArr[indexCharAfter] && !isWhitespace(textArr[indexCharAfter])
 
-const replaceQuote = (range, index, quoteType) => {
-  const startContainer = range.startContainer
-  if (!startContainer.nodeValue) {
-    return
+export const replaceQuote = (range, index, quoteType) => {
+  const startContainer = range?.startContainer
+  const nodeValue = startContainer?.nodeValue
+  if (!nodeValue) {
+    return null
   }
-  const textNode = document.createTextNode(`${startContainer.nodeValue.substring(0, index)}${quoteType}${startContainer.nodeValue.substring(index + 1)}`)
-  startContainer.replaceWith(textNode)
-  return textNode
+  const newText = `${nodeValue.substring(0, index)}${quoteType}${nodeValue.substring(index + 1)}`
+  const newTextNode = document.createTextNode(newText)
+  startContainer.replaceWith(newTextNode)
+  return newTextNode
 }
 
 const hasSingleOpeningQuote = (textArr, offset, singleOpeningQuote) => {