From 0ff63cab2acc6c14f7c3b1b72d85f643f46f212d Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?=C3=9E=C3=B3r=C3=B0ur=20H?= Date: Tue, 21 May 2024 11:52:52 +0000 Subject: [PATCH] fix(regulations-admin): Update article detection for amending articles and more (#14861) MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit * Update article detection for amending articles and more * Apply suggestions from code review Co-authored-by: Tryggvi Geir Magnússon * chore: nx format:write update dirty files --------- Co-authored-by: Tryggvi Geir Magnússon Co-authored-by: andes-it Co-authored-by: kodiakhq[bot] <49736102+kodiakhq[bot]@users.noreply.github.com> --- .../src/utils/formatAmendingRegulation.ts | 415 ++++++------------ .../src/utils/getDeletionOrAddition.ts | 172 ++++++++ .../src/utils/groupByArticleTitle.ts | 24 + 3 files changed, 342 insertions(+), 269 deletions(-) create mode 100644 libs/portals/admin/regulations-admin/src/utils/getDeletionOrAddition.ts create mode 100644 libs/portals/admin/regulations-admin/src/utils/groupByArticleTitle.ts diff --git a/libs/portals/admin/regulations-admin/src/utils/formatAmendingRegulation.ts b/libs/portals/admin/regulations-admin/src/utils/formatAmendingRegulation.ts index ab86f336b90a..2b8f6f413dc9 100644 --- a/libs/portals/admin/regulations-admin/src/utils/formatAmendingRegulation.ts +++ b/libs/portals/admin/regulations-admin/src/utils/formatAmendingRegulation.ts @@ -1,7 +1,8 @@ import { asDiv, HTMLText } from '@island.is/regulations' -import qq from '@hugsmidjan/qj/qq' import { GroupedDraftImpactForms, RegDraftForm } from '../state/types' import flatten from 'lodash/flatten' +import { groupElementsByArticleTitleFromDiv } from './groupByArticleTitle' +import { getDeletionOrAddition } from './getDeletionOrAddition' // ---------------------------------------------------------------------- const PREFIX = 'Reglugerð um ' @@ -48,117 +49,6 @@ export const formatAmendingRegTitle = (draft: RegDraftForm) => { // ---------------------------------------------------------------------- -const getLiPoint = (num: number, isStaflidur: boolean) => { - const charNum = num > 22 ? 23 : num - 1 - const bulletPoint = isStaflidur ? String.fromCharCode(97 + charNum) : num - - return bulletPoint -} - -// List item recursion for nested lists -const formatListItemDiff = (item: Element) => { - let oldLiText = '' - let newLiText = '' - let liItemHtml = '' as HTMLText - let lidur = 0 - const returningArray: HTMLText[] = [] - qq('ol > li', item).forEach((liItem) => { - lidur++ - - const liHasDeletion = !!liItem.querySelector('del') - const liHasInsert = !!liItem.querySelector('ins') - - if (liHasDeletion || liHasInsert) { - const oldLiElement = liItem.cloneNode(true) as Element - oldLiElement.querySelectorAll('ins').forEach((e) => e.remove()) - oldLiText = oldLiElement.textContent || '' - - const newLiElement = liItem.cloneNode(true) as Element - newLiElement.querySelectorAll('del').forEach((e) => e.remove()) - newLiText = newLiElement.textContent || '' - - const directArray = Array.from(liItem.children) - const containsDirect = directArray.find((e) => { - let returning = false - const containing = - e.classList.contains('diffdel') || - e.classList.contains('diffmod') || - e.classList.contains('diffins') - if (containing) { - returning = true - } - const needsMoreDrilling = e.nodeName === 'EM' || e.nodeName === 'STRONG' - if (needsMoreDrilling) { - const nestedArray = Array.from(e.children) - returning = !!nestedArray.find( - (ee) => - ee.classList.contains('diffdel') || - ee.classList.contains('diffins') || - ee.classList.contains('diffmod'), - ) - } - return returning - }) - - const isStaflidur = - liItem?.parentElement?.getAttribute('type')?.toLowerCase() === 'a' - - if (containsDirect) { - liItemHtml = (liItemHtml + formatListItemDiff(liItem)) as HTMLText - } else { - liItemHtml = (liItemHtml + - `${isStaflidur ? 'Stafliður' : 'Töluliður'} ${getLiPoint( - lidur, - isStaflidur, - )}, `) as HTMLText - formatListItemDiff(liItem) - lidur = 0 - return - } - - const isLiDeleted = newLiText === '' || newLiText === null - const isLiAddition = oldLiText === '' || oldLiText === null - - const liLidur = isStaflidur ? 'stafliður' : 'töluliður' - const liLidurShortened = isStaflidur ? 'stafl.' : 'tölul.' - - const lidurLabel = liItemHtml === '' ? liLidur.toLowerCase() : liLidur - - if (isLiDeleted) { - liItemHtml = (liItemHtml + - `${getLiPoint( - lidur, - isStaflidur, - )}. ${lidurLabel} fellur brott og breytist númer annarra liða til samræmis.`) as HTMLText - - // Finish up: - returningArray.push(liItemHtml) - liItemHtml = '' as HTMLText - } else if (isLiAddition) { - liItemHtml = (liItemHtml + - `Á eftir ${getLiPoint(lidur - 1, isStaflidur)}. ${ - isStaflidur ? 'staflið' : 'tölulið' - } kemur nýr liður svohljóðandi, og breytist númer annarra lið til samræmis: ${newLiText}`) as HTMLText - - // Finish up: - returningArray.push(liItemHtml) - liItemHtml = '' as HTMLText - } else { - liItemHtml = (liItemHtml + - `${getLiPoint( - lidur, - isStaflidur, - )}. ${liLidurShortened} orðast svo: ${newLiText}`) as HTMLText - - // Finish up: - returningArray.push(liItemHtml) - liItemHtml = '' as HTMLText - } - } - }) - return returningArray -} - export const formatAmendingRegBody = ( regName: string, repeal?: boolean, @@ -176,97 +66,36 @@ export const formatAmendingRegBody = ( return [] } - const additionArray: HTMLText[] = [] + const additionArray: HTMLText[][] = [] const diffString = diff as string const diffDiv = asDiv(diffString) - let grein = 0 - let malsgrein = 0 - qq('div > *', diffDiv).forEach((item) => { - // Increment grein number on every article title - if (item.classList.contains('article__title')) { - grein++ - malsgrein = 0 + let paragraph = 0 + const groupedArticles = groupElementsByArticleTitleFromDiv(diffDiv) + + groupedArticles.forEach((group) => { + // Er allt inni í sub array 'deletion'? + let articleTitle = '' + const testGroup: { + arr: HTMLText[] + title: string + isDeletion?: boolean + } = { + arr: [], + title: '', + isDeletion: undefined, } - let isMalsgrein = false - let isGreinTitle = false - let isTolulidur = false - let isStaflidur = false - - // Increment malsgrein number on every paragraph after article - if (item.nodeName === 'P') { - malsgrein++ - isMalsgrein = true - } - - if (item.nodeName === 'H3') { - isGreinTitle = true - } - - if (item.nodeName === 'OL') { - if (item.getAttribute('type')?.toLowerCase() === 'a') { - isStaflidur = true - } else { - isTolulidur = true - } - } - - const hasDeletion = !!item.querySelector('del') - const hasInsert = !!item.querySelector('ins') - const isGildistokuGrein = - isMalsgrein && - /(öðlast|tekur).*gildi|sett.*með.*(?:heimild|stoð)/.test( - (item.textContent || '').toLowerCase(), - ) - - if (hasDeletion || hasInsert || isGildistokuGrein) { - const oldTextElement = item.cloneNode(true) as Element - const newTextElement = item.cloneNode(true) as Element - let oldText = '' - let newText = '' - - oldTextElement.querySelectorAll('ins').forEach((e) => e.remove()) - oldText = oldTextElement.textContent || '' - - newTextElement.querySelectorAll('del').forEach((e) => e.remove()) - newText = newTextElement.textContent || '' - - let liHtml = '' as HTMLText - if (isStaflidur || isTolulidur) { - liHtml = `

${formatListItemDiff(item).join( - '

', - )}

` as HTMLText - } else { - oldTextElement.querySelectorAll('ins').forEach((e) => e.remove()) - oldText = oldTextElement.textContent || '' - - newTextElement.querySelectorAll('del').forEach((e) => e.remove()) - - if (isGreinTitle) { - const tempElement = newTextElement - - // Select all elements within the temporary element - const insElements = tempElement.querySelectorAll('ins') - - // Iterate through each element and insert a space before and after its content - insElements.forEach((insElement) => { - const content = insElement.textContent - insElement.textContent = ` ${content}
` - }) - - // Retrieve the modified text content from the temporary element - const modifiedTextContent = tempElement?.textContent?.trim() - newText = modifiedTextContent ?? '' - } else { - newText = newTextElement.textContent || '' - } - } - - const isDeleted = - newText === '' || newText === null || newText === '
' - const isAddition = oldText === '' || oldText === null + group.forEach((element) => { + const { + newText, + oldText, + isDeleted, + isAddition, + liHtml, + newTextElement, + } = getDeletionOrAddition(element) const regNameDisplay = regName && regName !== 'self' @@ -274,88 +103,136 @@ export const formatAmendingRegBody = ( : 'reglugerðarinnar' let pushHtml = '' as HTMLText - if (isGildistokuGrein) { - pushHtml = `

${oldText}

` as HTMLText - } else if (isDeleted) { - if (isMalsgrein) { - // Paragraph was deleted - pushHtml = - `

${malsgrein}. mgr. ${grein}. gr. ${regNameDisplay} fellur brott

` as HTMLText - } else if (isGreinTitle) { - // Title was deleted - pushHtml = - `

Fyrirsögn ${grein}. gr. ${regNameDisplay} fellur brott

` as HTMLText - } else if (isStaflidur || isTolulidur) { - // List was deleted - pushHtml = `

${ - isStaflidur ? 'Stafliðir' : 'Töluliðir' - } eftir ${malsgrein}. mgr. ${grein}. gr. ${regNameDisplay} falla brott

` as HTMLText + let isParagraph = false + let isArticleTitle = false + let isNumberList = false + let isLetterList = false + if (element.classList.contains('article__title')) { + articleTitle = element.innerText + testGroup.title = articleTitle + isArticleTitle = true + paragraph = 0 // Reset paragraph count for the new article + // } else if (element.tagName.toLowerCase() === 'p') { + } else if (element.nodeName.toLowerCase() === 'p') { + paragraph++ + isParagraph = true + } else if (element.nodeName.toLowerCase() === 'ol') { + if (element.getAttribute('type')?.toLowerCase() === 'a') { + isLetterList = true } else { - // We don't know what you deleted, but there was a deletion, and here's the deletelog: - pushHtml = - `

Texti í ${grein}. gr. ${regNameDisplay} fellur brott:

${oldText}

` as HTMLText + isNumberList = true } - } else if (isAddition) { - if (isMalsgrein) { - // Paragraph was added - pushHtml = - malsgrein > 1 - ? (`

Á eftir ${ - malsgrein - 1 - }. mgr. ${grein}. gr. ${regNameDisplay} kemur ný málsgrein sem orðast svo:

${newText}

` as HTMLText) - : (`

1. mgr. ${grein}. gr. ${regNameDisplay} orðast svo:

${newText}

` as HTMLText) - } else if (isGreinTitle) { - // Title was added - pushHtml = - `

Fyrirsögn ${grein}. gr. ${regNameDisplay} orðast svo:

${newText}

` as HTMLText - } else if (isStaflidur || isTolulidur) { - // List was added - - // Clean list addition: - const liCleanArray: (string | null)[] = [] - newTextElement.querySelectorAll('ins').forEach((e) => { - if (e.textContent) liCleanArray.push(e.textContent) - }) - - const newLiTextBody = - liCleanArray.length > 0 - ? `
  1. ${liCleanArray.join('
  2. ')}
      3. ` - : `

      ${newText}

      ` + } - pushHtml = `

      ${ - isStaflidur ? 'Stafliðum' : 'Töluliðum' - } eftir ${malsgrein}. mgr. ${grein}. gr. ${regNameDisplay} er bætt við:

      ${newLiTextBody}` as HTMLText + const hasDeletion = !!element.querySelector('del') + const hasInsert = !!element.querySelector('ins') + + const isGildistokuGrein = + isParagraph && + /(öðlast|tekur).*gildi|sett.*með.*(?:heimild|stoð)/.test( + (element.textContent || '').toLowerCase(), + ) + + if (hasDeletion || hasInsert || isGildistokuGrein) { + if (isGildistokuGrein) { + pushHtml = `

      ${oldText}

      ` as HTMLText + } else if (isDeleted) { + // If deletion has never been false, everything is deleted, so it will stay true. + if (testGroup.isDeletion !== false) { + testGroup.isDeletion = true + } + if (isParagraph) { + // Paragraph was deleted + pushHtml = + `

      ${paragraph}. mgr. ${articleTitle} ${regNameDisplay} fellur brott

      ` as HTMLText + } else if (isArticleTitle) { + // Title was deleted + pushHtml = + `

      Fyrirsögn ${articleTitle} ${regNameDisplay} fellur brott

      ` as HTMLText + } else if (isLetterList || isNumberList) { + // List was deleted + pushHtml = `

      ${ + isLetterList ? 'Stafliðir' : 'Töluliðir' + } eftir ${paragraph}. mgr. ${articleTitle} ${regNameDisplay} falla brott

      ` as HTMLText + } else { + // We don't know what you deleted, but there was a deletion, and here's the deletelog: + pushHtml = + `

      Texti í ${articleTitle} ${regNameDisplay} fellur brott:

      ${oldText}

      ` as HTMLText + } + } else if (isAddition) { + testGroup.isDeletion = false + if (isParagraph) { + // Paragraph was added + pushHtml = + paragraph > 1 + ? (`

      Á eftir ${ + paragraph - 1 + }. mgr. ${articleTitle} ${regNameDisplay} kemur ný málsgrein sem orðast svo:

      ${newText}

      ` as HTMLText) + : (`

      1. mgr. ${articleTitle} ${regNameDisplay} orðast svo:

      ${newText}

      ` as HTMLText) + } else if (isArticleTitle) { + // Title was added + pushHtml = + `

      Fyrirsögn ${articleTitle} ${regNameDisplay} orðast svo:

      ${newText}

      ` as HTMLText + } else if (isLetterList || isNumberList) { + // List was added + + // Clean list addition: + const liCleanArray: (string | null)[] = [] + newTextElement.querySelectorAll('ins').forEach((e) => { + if (e.textContent) liCleanArray.push(e.textContent) + }) + + const newLiTextBody = + liCleanArray.length > 0 + ? `
      1. ${liCleanArray.join('
      2. ')}
          3. ` + : `

          ${newText}

          ` + + pushHtml = `

          ${ + isLetterList ? 'Stafliðum' : 'Töluliðum' + } eftir ${paragraph}. mgr. ${articleTitle} ${regNameDisplay} er bætt við:

          ${newLiTextBody}` as HTMLText + } else { + // We don't know what you added, but there was an addition, and here's the additionlog: + pushHtml = + `

          Eftirfarandi texta ${regNameDisplay} var bætt við:

          ${newText}

          ` as HTMLText + } } else { - // We don't know what you added, but there was an addition, and here's the additionlog: - pushHtml = - `

          Eftirfarandi texta ${regNameDisplay} var bætt við:

          ${newText}

          ` as HTMLText + testGroup.isDeletion = false + if (isArticleTitle) { + // Title was changed + pushHtml = + `

          Fyrirsögn ${articleTitle} ${regNameDisplay} orðast svo:

          ${newText}

          ` as HTMLText + } else if (isParagraph) { + // Paragraph was changed + pushHtml = + `

          ${paragraph}. mgr. ${articleTitle} ${regNameDisplay} orðast svo:

          ${newText}

          ` as HTMLText + } else if (isLetterList || isNumberList) { + // List was changed + pushHtml = + `

          ${paragraph}. mgr. ${articleTitle} ${regNameDisplay} breytist:

          ${liHtml}` as HTMLText + } else { + // We don't know what you changed, but there was a change, and here's the changelog: + pushHtml = + `

          Eftirfarandi breytingar ${regNameDisplay} áttu sér stað:

          ${ + oldText ? `Í stað ${oldText} kemur ` : '' + }${newText}

          ` as HTMLText + } } + testGroup.arr.push(pushHtml) } else { - if (isGreinTitle) { - // Title was changed - pushHtml = - `

          Fyrirsögn ${grein}. gr. ${regNameDisplay} orðast svo:

          ${newText}

          ` as HTMLText - } else if (isMalsgrein) { - // Paragraph was changed - pushHtml = - `

          ${malsgrein}. mgr. ${grein}. gr. ${regNameDisplay} orðast svo:

          ${newText}

          ` as HTMLText - } else if (isStaflidur || isTolulidur) { - // List was changed - pushHtml = - `

          ${malsgrein}. mgr. ${grein}. gr. ${regNameDisplay} breytist:

          ${liHtml}` as HTMLText - } else { - // We don't know what you changed, but there was a change, and here's the changelog: - pushHtml = - `

          Eftirfarandi breytingar ${regNameDisplay} áttu sér stað:

          ${ - oldText ? `Í stað ${oldText} kemur ` : '' - }${newText}

          ` as HTMLText - } + testGroup.isDeletion = false } - additionArray.push(pushHtml) + }) + if (testGroup.isDeletion === true) { + const articleTitleNumber = testGroup.title + additionArray.push([ + `

          ${articleTitleNumber} fellur brott

          ` as HTMLText, + ]) + } else { + additionArray.push(testGroup.arr) } }) - return additionArray + return additionArray.flat() } export const formatAmendingBodyWithArticlePrefix = ( diff --git a/libs/portals/admin/regulations-admin/src/utils/getDeletionOrAddition.ts b/libs/portals/admin/regulations-admin/src/utils/getDeletionOrAddition.ts new file mode 100644 index 000000000000..b99a1545a948 --- /dev/null +++ b/libs/portals/admin/regulations-admin/src/utils/getDeletionOrAddition.ts @@ -0,0 +1,172 @@ +import qq from '@hugsmidjan/qj/qq' +import { HTMLText } from '@island.is/regulations-tools/types' + +export const getLiPoint = (num: number, isStaflidur: boolean) => { + const charNum = num > 22 ? 23 : num - 1 + const bulletPoint = isStaflidur ? String.fromCharCode(97 + charNum) : num + + return bulletPoint +} + +export const formatListItemDiff = (item: Element) => { + let oldLiText = '' + let newLiText = '' + let liItemHtml = '' as HTMLText + let lidur = 0 + const returningArray: HTMLText[] = [] + qq('ol > li', item).forEach((liItem) => { + lidur++ + + const liHasDeletion = !!liItem.querySelector('del') + const liHasInsert = !!liItem.querySelector('ins') + + if (liHasDeletion || liHasInsert) { + const oldLiElement = liItem.cloneNode(true) as Element + oldLiElement.querySelectorAll('ins').forEach((e) => e.remove()) + oldLiText = oldLiElement.textContent || '' + + const newLiElement = liItem.cloneNode(true) as Element + newLiElement.querySelectorAll('del').forEach((e) => e.remove()) + newLiText = newLiElement.textContent || '' + + const directArray = Array.from(liItem.children) + const containsDirect = directArray.find((e) => { + let returning = false + const containing = + e.classList.contains('diffdel') || + e.classList.contains('diffmod') || + e.classList.contains('diffins') + if (containing) { + returning = true + } + const needsMoreDrilling = + e.nodeName.toLowerCase() === 'em' || + e.nodeName.toLowerCase() === 'strong' + if (needsMoreDrilling) { + const nestedArray = Array.from(e.children) + returning = !!nestedArray.find( + (ee) => + ee.classList.contains('diffdel') || + ee.classList.contains('diffins') || + ee.classList.contains('diffmod'), + ) + } + return returning + }) + + const isStaflidur = + liItem?.parentElement?.getAttribute('type')?.toLowerCase() === 'a' + + if (containsDirect) { + liItemHtml = (liItemHtml + formatListItemDiff(liItem)) as HTMLText + } else { + liItemHtml = (liItemHtml + + `${isStaflidur ? 'Stafliður' : 'Töluliður'} ${getLiPoint( + lidur, + isStaflidur, + )}, `) as HTMLText + formatListItemDiff(liItem) + lidur = 0 + return + } + + const isLiDeleted = newLiText === '' || newLiText === null + const isLiAddition = oldLiText === '' || oldLiText === null + + const liLidur = isStaflidur ? 'stafliður' : 'töluliður' + const liLidurShortened = isStaflidur ? 'stafl.' : 'tölul.' + + const lidurLabel = liItemHtml === '' ? liLidur.toLowerCase() : liLidur + + if (isLiDeleted) { + liItemHtml = (liItemHtml + + `${getLiPoint( + lidur, + isStaflidur, + )}. ${lidurLabel} fellur brott og breytist númer annarra liða til samræmis.`) as HTMLText + + // Finish up: + returningArray.push(liItemHtml) + liItemHtml = '' as HTMLText + } else if (isLiAddition) { + liItemHtml = (liItemHtml + + `Á eftir ${getLiPoint(lidur - 1, isStaflidur)}. ${ + isStaflidur ? 'staflið' : 'tölulið' + } kemur nýr liður svohljóðandi, og breytist númer annarra lið til samræmis: ${newLiText}`) as HTMLText + + // Finish up: + returningArray.push(liItemHtml) + liItemHtml = '' as HTMLText + } else { + liItemHtml = (liItemHtml + + `${getLiPoint( + lidur, + isStaflidur, + )}. ${liLidurShortened} orðast svo: ${newLiText}`) as HTMLText + + // Finish up: + returningArray.push(liItemHtml) + liItemHtml = '' as HTMLText + } + } + }) + return returningArray +} + +export const getDeletionOrAddition = ( + item: Element, + type?: 'lidur' | 'greinTitle', +) => { + let oldText = '' + let newText = '' + + const oldTextElement = item.cloneNode(true) as Element + const newTextElement = item.cloneNode(true) as Element + + oldTextElement.querySelectorAll('ins').forEach((e) => e.remove()) + oldText = oldTextElement.textContent || '' + + newTextElement.querySelectorAll('del').forEach((e) => e.remove()) + newText = newTextElement.textContent || '' + + let liHtml = '' as HTMLText + if (type === 'lidur') { + liHtml = `

          ${formatListItemDiff(item).join('

          ')}

          ` as HTMLText + } else { + oldTextElement.querySelectorAll('ins').forEach((e) => e.remove()) + oldText = oldTextElement.textContent || '' + + newTextElement.querySelectorAll('del').forEach((e) => e.remove()) + + if (type === 'greinTitle') { + const tempElement = newTextElement + + // Select all elements within the temporary element + const insElements = tempElement.querySelectorAll('ins') + + // Iterate through each element and insert a space before and after its content + insElements.forEach((insElement) => { + const content = insElement.textContent + insElement.textContent = ` ${content}
          ` + }) + + // Retrieve the modified text content from the temporary element + const modifiedTextContent = tempElement?.textContent?.trim() + newText = modifiedTextContent ?? '' + } else { + newText = newTextElement.textContent || '' + } + } + + const isDeleted = newText === '' || newText === null || newText === '
          ' + const isAddition = oldText === '' || oldText === null + + return { + newText, + oldText, + isDeleted, + isAddition, + liHtml, + newTextElement, + } +} diff --git a/libs/portals/admin/regulations-admin/src/utils/groupByArticleTitle.ts b/libs/portals/admin/regulations-admin/src/utils/groupByArticleTitle.ts new file mode 100644 index 000000000000..96e064372852 --- /dev/null +++ b/libs/portals/admin/regulations-admin/src/utils/groupByArticleTitle.ts @@ -0,0 +1,24 @@ +export const groupElementsByArticleTitleFromDiv = ( + div: HTMLDivElement, +): HTMLElement[][] => { + const result: HTMLElement[][] = [] + let currentGroup: HTMLElement[] = [] + + Array.from(div.children).forEach((child) => { + const element = child as HTMLElement + if (element.classList.contains('article__title')) { + if (currentGroup.length > 0) { + result.push(currentGroup) + } + currentGroup = [element] + } else { + currentGroup.push(element) + } + }) + + if (currentGroup.length > 0) { + result.push(currentGroup) + } + + return result +}