feat: replace quotes in text

Author: meinradandermatt

spec/clipboard.spec.js

@@ -189,5 +189,68 @@ describe('Clipboard', function () {
 
       expect(parseContent(div)[0]).toEqual('bar')
     })
+
+    // Replace quotation marks
+    // ------------------
+
+    it('replace quotation marks', function () {
+      const block = extractSingleBlock('text outside "text inside"')
+      expect(block).toEqual('text outside “text inside”')
+    })
+
+    it('replace nested quotation marks', function () {
+      const block = extractSingleBlock('text outside "text «inside» text"')
+      expect(block).toEqual('text outside “text “inside” text”')
+    })
+
+    it('replace multiple nested quotation marks', function () {
+      const block = extractSingleBlock('text outside "text «inside „double nested“» text"')
+      expect(block).toEqual('text outside “text “inside “double nested”” text”')
+    })
+
+    it('replace quotation marks and ignore not closing marks', function () {
+      const block = extractSingleBlock('text outside "text «inside „double nested» text"')
+      expect(block).toEqual('text outside “text “inside „double nested” text”')
+    })
+
+    it('replace nested quotes with multiple quotes inside nested', function () {
+      const block = extractSingleBlock('text outside "text «inside» „second inside text“"')
+      expect(block).toEqual('text outside “text “inside” “second inside text””')
+    })
+
+    it('replace nested quotes with multiple quotes inside nested and not closing marks', function () {
+      const block = extractSingleBlock('text outside "text «inside» „second «inside» text"')
+      expect(block).toEqual('text outside “text “inside” „second “inside” text”')
+    })
+
+    it('replace single quotation marks', function () {
+      const blocks = extract('text outside \'text inside\'')
+      expect(blocks).toEqual('text outside ‘text inside’')
+    })
+
+    it('replace nested quotes with single quotes inside nested', function () {
+      const block = extractSingleBlock('text outside "text \'inside\' „second inside text“"')
+      expect(block).toEqual('text outside “text ‘inside’ “second inside text””')
+    })
+
+    it('replace quotation marks around elements', function () {
+      const block = extractSingleBlock('text outside "<b>text inside</b>"')
+      expect(block).toEqual('text outside “<strong>text inside</strong>”')
+    })
+
+    it('replace quotation marks inside elements', function () {
+      const block = extractSingleBlock('text outside <b>"text inside"</b>')
+      expect(block).toEqual('text outside <strong>“text inside”</strong>')
+    })
+
+    it('do not replace quotation marks inside tag attributes', function () {
+      const block = extractSingleBlock('text outside "<a href="https://livingdocs.io">text inside</a>"')
+      expect(block).toEqual('text outside “<a href="https://livingdocs.io">text inside</a>”')
+    })
+
+    it('replace quotation marks around elements with attributes', function () {
+      const block = extractSingleBlock('text outside "<a href="https://livingdocs.io">text inside</a>"')
+      expect(block).toEqual('text outside “<a href="https://livingdocs.io">text inside</a>”')
+    })
   })
 })

src/clipboard.js

@@ -4,11 +4,21 @@ import config from './config'
 import * as string from './util/string'
 import * as nodeType from './node-type'
 
-let allowedElements, requiredAttributes, transformElements, blockLevelElements
+let allowedElements, requiredAttributes, transformElements, blockLevelElements, replaceQuotes
 let splitIntoBlocks, blacklistedElements
 const whitespaceOnly = /^\s*$/
 const blockPlaceholder = '<!-- BLOCK -->'
 let keepInternalRelativeLinks
+const doubleQuotePairs = [
+  ['«', '»'], // ch german, french
+  ['»', '«'], // danish
+  ['"', '"'], // danish, not specified
+  ['“', '”'], // english US
+  ['”', '”'], // swedish
+  ['“', '“'], // chinese simplified
+  ['„', '“'] // german
+]
+const quotesRegex = /(["'«»„“])(?![^<]*?>)/g
 
 updateConfig(config)
 export function updateConfig (conf) {
@@ -18,6 +28,7 @@ export function updateConfig (conf) {
   transformElements = rules.transformElements || {}
   blacklistedElements = rules.blacklistedElements || []
   keepInternalRelativeLinks = rules.keepInternalRelativeLinks || false
+  replaceQuotes = rules.replaceQuotes || {}
 
   blockLevelElements = {}
   rules.blockLevelElements.forEach((name) => { blockLevelElements[name] = true })
@@ -80,7 +91,7 @@ export function parseContent (element) {
   return filterHtmlElements(element)
   // Handle Blocks
     .split(blockPlaceholder)
-    .map((entry) => string.trim(cleanWhitespace(entry)))
+    .map((entry) => string.trim(cleanWhitespace(replaceAllQuotes(entry))))
     .filter((entry) => !whitespaceOnly.test(entry))
 }
 
@@ -168,3 +179,69 @@ export function cleanWhitespace (str) {
       : ' '
     ))
 }
+
+export function replaceAllQuotes (str) {
+  const quotes = getAllQuotes(str)
+  if (quotes && quotes.length > 0) {
+    const replacementQuotes = getReplacementArray(quotes, 0)
+    return replaceExistingQuotes(str, replacementQuotes)
+  }
+  return str
+}
+
+function getReplacementArray (quotes, position) {
+  const quotesArray = []
+  if (quotes.length === 1) {
+    return quotes
+  }
+
+  while (position < quotes.length) {
+    const closingTagPosition = findClosingQuote(quotes, position)
+    let nestedArray = []
+
+    if (closingTagPosition !== position + 1 && closingTagPosition !== -1 && closingTagPosition !== undefined) {
+      const nestedquotes = quotes.slice(position + 1, closingTagPosition)
+      if (nestedquotes) {
+        nestedArray = getReplacementArray(nestedquotes, 0)
+      }
+    }
+    if (closingTagPosition) {
+      position = closingTagPosition + 1
+    }
+    if (closingTagPosition === undefined || closingTagPosition === -1) {
+      quotesArray.push(quotes[position])
+      position++
+    } else {
+      quotesArray.push(...[replaceQuotes.quotes[0], ...nestedArray, replaceQuotes.quotes[1]])
+    }
+  }
+
+  return quotesArray
+}
+
+function findClosingQuote (quotes, position) {
+  const openingQuote = quotes[position]
+  for (let i = position + 1; i < quotes.length; i++) {
+    const isIncluded = getPossibleClosingQuotes(openingQuote).includes(quotes[i])
+    if (isIncluded) {
+      return i
+    }
+  }
+}
+
+function getPossibleClosingQuotes (openingQuote) {
+  return doubleQuotePairs.filter(quotePair => quotePair[0] === openingQuote).map((quotePair) => quotePair[1])
+}
+
+function getAllQuotes (str) {
+  return str.match(quotesRegex)
+}
+
+function replaceExistingQuotes (str, replacementQuotes) {
+  let index = 0
+  return str.replace(quotesRegex, (match) => {
+    const replacement = replacementQuotes[index]
+    index++
+    return replacement
+  })
+}

src/config.js

@@ -75,6 +75,11 @@ export default {
     // and content (text content and child elements) will get removed.
     blacklistedElements: ['style', 'script'],
 
-    keepInternalRelativeLinks: false
+    keepInternalRelativeLinks: false,
+
+    replaceQuotes: {
+      quotes: ['“', '”'],
+      singleQuotes: ['‘', '’']
+    }
   }
 }