@eeacms/volto-slate-footnote 6.0.2 → 6.1.1

package/CHANGELOG.md

@@ -4,6 +4,29 @@ All notable changes to this project will be documented in this file. Dates are d
 
 Generated by [`auto-changelog`](https://github.com/CookPete/auto-changelog).
 
+### [6.1.1](https://github.com/eea/volto-slate-footnote/compare/6.1.0...6.1.1) - 12 June 2023
+
+#### :house: Internal changes
+
+- chore: [JENKINS] Deprecate circularity website [valentinab25 - [`ded882a`](https://github.com/eea/volto-slate-footnote/commit/ded882a1ca1183c2ba74ff4246111123ee36e6cb)]
+
+#### :hammer_and_wrench: Others
+
+- test: jest should look for addons in node_modules Refs #253277 [valentinab25 - [`3e0749c`](https://github.com/eea/volto-slate-footnote/commit/3e0749cc5bd7f5810ac6fd7a3feee4df0435ee0a)]
+- test: Add unit tests for utils - refs #253277 [ana-oprea - [`a709895`](https://github.com/eea/volto-slate-footnote/commit/a709895d9953742ef6d39f8d9673c06b2efe6a64)]
+- test: Fix test config, coverage Refs #253277 [valentinab25 - [`dc4d6dc`](https://github.com/eea/volto-slate-footnote/commit/dc4d6dc9b39bfe2c892156f32c764153d1366486)]
+- Add Sonarqube tag using eea-website-frontend addons list [EEA Jenkins - [`4f0ecee`](https://github.com/eea/volto-slate-footnote/commit/4f0ecee224d5d6604dfbb562556e45437edbb8ec)]
+### [6.1.0](https://github.com/eea/volto-slate-footnote/compare/6.0.2...6.1.0) - 27 March 2023
+
+#### :hammer_and_wrench: Others
+
+- Add Sonarqube tag using eea-website-frontend addons list [EEA Jenkins - [`23959ee`](https://github.com/eea/volto-slate-footnote/commit/23959ee43d45ec5eaa483590415a75fc58faae03)]
+- Add Sonarqube tag using advisory-board-frontend addons list [EEA Jenkins - [`7aa6f34`](https://github.com/eea/volto-slate-footnote/commit/7aa6f3439953cc3d8f28875eff9fbcc24084cbc7)]
+- Add Sonarqube tag using advisory-board-frontend addons list [EEA Jenkins - [`b117d15`](https://github.com/eea/volto-slate-footnote/commit/b117d15e51b3cf10717b9dd9dfef8304d46ad556)]
+- test(Jenkins): Run tests and cypress with latest canary @plone/volto [Alin Voinea - [`97ed8fb`](https://github.com/eea/volto-slate-footnote/commit/97ed8fbd92f76c2b3128b62cdc1a77611e79410a)]
+- Add Sonarqube tag using cca-frontend addons list [EEA Jenkins - [`cb22f5e`](https://github.com/eea/volto-slate-footnote/commit/cb22f5e8e9d3aed0a3b4374b6d4d80c8c2bb66e1)]
+- yarn 3 [Alin Voinea - [`f5bb904`](https://github.com/eea/volto-slate-footnote/commit/f5bb904eecf740ffd57dbccf9a597c99ea2dfc0c)]
+- Add Sonarqube tag using demo-kitkat-frontend addons list [EEA Jenkins - [`59cf6d3`](https://github.com/eea/volto-slate-footnote/commit/59cf6d334a460e373dda3e2e28754fcdd9fb0281)]
 ### [6.0.2](https://github.com/eea/volto-slate-footnote/compare/6.0.1...6.0.2) - 16 November 2022
 
 #### :hammer_and_wrench: Others

package/Jenkinsfile

@@ -4,9 +4,9 @@ pipeline {
   environment {
         GIT_NAME = "volto-slate-footnote"
         NAMESPACE = "@eeacms"
-        SONARQUBE_TAGS = "volto.eea.europa.eu,biodiversity.europa.eu,www.eea.europa.eu-ims,climate-energy.eea.europa.eu,sustainability.eionet.europa.eu,forest.eea.europa.eu,clms.land.copernicus.eu,industry.eea.europa.eu,water.europa.eu-freshwater,demo-www.eea.europa.eu,clmsdemo.devel6cph.eea.europa.eu,circularity.eea.europa.eu,prod-www.eea.europa.eu,water.europa.eu-marine"
+        SONARQUBE_TAGS = "volto.eea.europa.eu,biodiversity.europa.eu,www.eea.europa.eu-ims,climate-energy.eea.europa.eu,sustainability.eionet.europa.eu,forest.eea.europa.eu,clms.land.copernicus.eu,industry.eea.europa.eu,water.europa.eu-freshwater,demo-www.eea.europa.eu,clmsdemo.devel6cph.eea.europa.eu,water.europa.eu-marine,climate-adapt.eea.europa.eu,climate-advisory-board.devel4cph.eea.europa.eu,climate-advisory-board.europa.eu,www.eea.europa.eu-en"
         DEPENDENCIES = ""
-        VOLTO = "alpha"
+        VOLTO = ""
     }
 
   stages {
@@ -41,19 +41,19 @@ pipeline {
 
           "ES lint": {
             node(label: 'docker') {
-              sh '''docker run -i --rm --name="$BUILD_TAG-eslint" -e NAMESPACE="$NAMESPACE" -e VOLTO=$VOLTO -e GIT_NAME=$GIT_NAME -e GIT_BRANCH="$BRANCH_NAME" -e GIT_CHANGE_ID="$CHANGE_ID" plone/volto-addon-ci:alpha eslint'''
+              sh '''docker run -i --rm --name="$BUILD_TAG-eslint" -e NAMESPACE="$NAMESPACE" -e VOLTO=$VOLTO -e GIT_NAME=$GIT_NAME -e GIT_BRANCH="$BRANCH_NAME" -e GIT_CHANGE_ID="$CHANGE_ID" plone/volto-addon-ci eslint'''
             }
           },
 
           "Style lint": {
             node(label: 'docker') {
-              sh '''docker run -i --rm --name="$BUILD_TAG-stylelint" -e NAMESPACE="$NAMESPACE" -e VOLTO=$VOLTO -e GIT_NAME=$GIT_NAME -e GIT_BRANCH="$BRANCH_NAME" -e GIT_CHANGE_ID="$CHANGE_ID" plone/volto-addon-ci:alpha stylelint'''
+              sh '''docker run -i --rm --name="$BUILD_TAG-stylelint" -e NAMESPACE="$NAMESPACE" -e VOLTO=$VOLTO -e GIT_NAME=$GIT_NAME -e GIT_BRANCH="$BRANCH_NAME" -e GIT_CHANGE_ID="$CHANGE_ID" plone/volto-addon-ci stylelint'''
             }
           },
 
           "Prettier": {
             node(label: 'docker') {
-              sh '''docker run -i --rm --name="$BUILD_TAG-prettier" -e VOLTO=$VOLTO -e NAMESPACE="$NAMESPACE" -e GIT_NAME=$GIT_NAME -e GIT_BRANCH="$BRANCH_NAME" -e GIT_CHANGE_ID="$CHANGE_ID" plone/volto-addon-ci:alpha prettier'''
+              sh '''docker run -i --rm --name="$BUILD_TAG-prettier" -e VOLTO=$VOLTO -e NAMESPACE="$NAMESPACE" -e GIT_NAME=$GIT_NAME -e GIT_BRANCH="$BRANCH_NAME" -e GIT_CHANGE_ID="$CHANGE_ID" plone/volto-addon-ci prettier'''
             }
           }
         )
@@ -77,8 +77,8 @@ pipeline {
             node(label: 'docker') {
               script {
                 try {
-                  sh '''docker pull plone/volto-addon-ci:alpha'''
-                  sh '''docker run -i --name="$BUILD_TAG-volto" -e NAMESPACE="$NAMESPACE" -e GIT_NAME=$GIT_NAME -e GIT_BRANCH="$BRANCH_NAME" -e GIT_CHANGE_ID="$CHANGE_ID" -e VOLTO=$VOLTO plone/volto-addon-ci:alpha'''
+                  sh '''docker pull plone/volto-addon-ci'''
+                  sh '''docker run -i --name="$BUILD_TAG-volto" -e NAMESPACE="$NAMESPACE" -e GIT_NAME=$GIT_NAME -e GIT_BRANCH="$BRANCH_NAME" -e GIT_CHANGE_ID="$CHANGE_ID" -e VOLTO=$VOLTO plone/volto-addon-ci'''
                   sh '''rm -rf xunit-reports'''
                   sh '''mkdir -p xunit-reports'''
                   sh '''docker cp $BUILD_TAG-volto:/opt/frontend/my-volto-project/coverage xunit-reports/'''
@@ -126,7 +126,7 @@ pipeline {
               script {
                 try {
                   sh '''docker pull eeacms/plone-backend; docker run --rm -d --name="$BUILD_TAG-plone" -e SITE="Plone" -e PROFILES="eea.kitkat:testing" eeacms/plone-backend'''
-                  sh '''docker pull plone/volto-addon-ci:alpha; docker run -i --name="$BUILD_TAG-cypress" --link $BUILD_TAG-plone:plone -e NAMESPACE="$NAMESPACE" -e GIT_NAME=$GIT_NAME -e GIT_BRANCH="$BRANCH_NAME" -e GIT_CHANGE_ID="$CHANGE_ID" -e DEPENDENCIES="$DEPENDENCIES" -e NODE_ENV=development -e VOLTO="$VOLTO" plone/volto-addon-ci:alpha cypress'''
+                  sh '''docker pull plone/volto-addon-ci; docker run -i --name="$BUILD_TAG-cypress" --link $BUILD_TAG-plone:plone -e NAMESPACE="$NAMESPACE" -e GIT_NAME=$GIT_NAME -e GIT_BRANCH="$BRANCH_NAME" -e GIT_CHANGE_ID="$CHANGE_ID" -e DEPENDENCIES="$DEPENDENCIES" -e NODE_ENV=development -e VOLTO="$VOLTO" plone/volto-addon-ci cypress'''
                 } finally {
                   try {
                     sh '''rm -rf cypress-reports cypress-results cypress-coverage'''
@@ -188,6 +188,7 @@ pipeline {
             def nodeJS = tool 'NodeJS';
             withSonarQubeEnv('Sonarqube') {
               sh '''sed -i "s#/opt/frontend/my-volto-project/src/addons/${GIT_NAME}/##g" xunit-reports/coverage/lcov.info'''
+              sh '''sed -i "s#src/addons/${GIT_NAME}/##g" xunit-reports/coverage/lcov.info'''
               sh "export PATH=${scannerHome}/bin:${nodeJS}/bin:$PATH; sonar-scanner -Dsonar.javascript.lcov.reportPaths=./xunit-reports/coverage/lcov.info,./cypress-coverage/coverage/lcov.info -Dsonar.sources=./src -Dsonar.projectKey=$GIT_NAME-$BRANCH_NAME -Dsonar.projectVersion=$BRANCH_NAME-$BUILD_NUMBER"
               sh '''try=2; while [ \$try -gt 0 ]; do curl -s -XPOST -u "${SONAR_AUTH_TOKEN}:" "${SONAR_HOST_URL}api/project_tags/set?project=${GIT_NAME}-${BRANCH_NAME}&tags=${SONARQUBE_TAGS},${BRANCH_NAME}" > set_tags_result; if [ \$(grep -ic error set_tags_result ) -eq 0 ]; then try=0; else cat set_tags_result; echo "... Will retry"; sleep 60; try=\$(( \$try - 1 )); fi; done'''
             }

package/jest-addon.config.js

@@ -5,19 +5,19 @@ module.exports = {
     '!src/**/*.d.ts',
   ],
   moduleNameMapper: {
+    '\\.(css|less|scss|sass)$': 'identity-obj-proxy',
     '@plone/volto/cypress': '<rootDir>/node_modules/@plone/volto/cypress',
     '@plone/volto/babel': '<rootDir>/node_modules/@plone/volto/babel',
     '@plone/volto/(.*)$': '<rootDir>/node_modules/@plone/volto/src/$1',
     '@package/(.*)$': '<rootDir>/src/$1',
     '@root/(.*)$': '<rootDir>/src/$1',
     '@plone/volto-quanta/(.*)$': '<rootDir>/src/addons/volto-quanta/src/$1',
-    '@eeacms/(.*?)/(.*)$': '<rootDir>/src/addons/$1/src/$2',
+    '@eeacms/(.*?)/(.*)$': '<rootDir>/node_modules/@eeacms/$1/src/$2',
     '@plone/volto-slate':
       '<rootDir>/node_modules/@plone/volto/packages/volto-slate/src',
     '~/(.*)$': '<rootDir>/src/$1',
     'load-volto-addons':
       '<rootDir>/node_modules/@plone/volto/jest-addons-loader.js',
-    '\\.(css|less|scss|sass)$': 'identity-obj-proxy',
   },
   transform: {
     '^.+\\.js(x)?$': 'babel-jest',

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@eeacms/volto-slate-footnote",
-  "version": "6.0.2",
+  "version": "6.1.1",
   "description": "volto-slate-footnote: Volto add-on",
   "main": "src/index.js",
   "author": "European Environment Agency: IDM2 A-Team",
@@ -19,10 +19,9 @@
     "url": "git@github.com:eea/volto-slate-footnote.git"
   },
   "addons": [],
-  "dependencies": {},
   "devDependencies": {
-    "@plone/scripts": "*",
     "@cypress/code-coverage": "^3.10.0",
+    "@plone/scripts": "*",
     "babel-plugin-transform-class-properties": "^6.24.1",
     "md5": "^2.3.0"
   },

package/src/editor/utils.test.js

@@ -0,0 +1,213 @@
+import {
+  makeFootnote,
+  openAccordionIfContainsFootnoteReference,
+  getAllBlocksAndSlateFields,
+} from './utils';
+import { getAllBlocks } from '@plone/volto-slate/utils';
+
+jest.mock('@plone/volto-slate/utils', () => ({
+  getAllBlocks: jest.fn(),
+}));
+
+describe('makeFootnote', () => {
+  it('should remove xml version string from footnote', () => {
+    const xmlString = '<?xml version="1.0"?>Test text';
+    const expectedResult = 'Test text';
+    expect(makeFootnote(xmlString)).toEqual(expectedResult);
+  });
+
+  it('should return empty string when footnote is null or undefined', () => {
+    expect(makeFootnote(null)).toEqual('');
+    expect(makeFootnote(undefined)).toEqual('');
+  });
+});
+
+describe('openAccordionIfContainsFootnoteReference', () => {
+  it('should open accordion if it contains footnote reference', () => {
+    document.body.innerHTML = `
+      <div class="accordion">
+        <div class="title">Accordion</div>
+        <div id="footnote">Footnote</div>
+      </div>
+    `;
+
+    const title = document.querySelector('.title');
+    title.click = jest.fn();
+
+    openAccordionIfContainsFootnoteReference('#footnote');
+
+    expect(title.click).toHaveBeenCalled();
+  });
+
+  it('should not do anything if accordion does not contain footnote reference', () => {
+    document.body.innerHTML = `
+      <div class="accordion">
+        <div class="title">Accordion</div>
+      </div>
+    `;
+
+    const title = document.querySelector('.title');
+    title.click = jest.fn();
+
+    openAccordionIfContainsFootnoteReference('#footnote');
+
+    expect(title.click).not.toHaveBeenCalled();
+  });
+});
+
+describe('getAllBlocksAndSlateFields', () => {
+  afterEach(() => {
+    jest.clearAllMocks();
+  });
+
+  it('handles metadataSection correctly', () => {
+    const properties = { '1': ['test'] };
+    const blocks = [
+      {
+        '@type': 'metadataSection',
+        fields: [
+          { field: { widget: 'slate', id: '1' } },
+          { field: { widget: 'other', id: '2' } },
+        ],
+      },
+    ];
+    getAllBlocks.mockReturnValue(blocks);
+
+    const expected = [{ '@type': 'slate', id: '1', value: ['test'] }];
+    const result = getAllBlocksAndSlateFields(properties);
+
+    expect(result).toEqual(expected);
+  });
+
+  it('handles metadataSection correctly with no properties', () => {
+    const properties = {};
+    const blocks = [
+      {
+        '@type': 'metadataSection',
+        fields: [
+          { field: { widget: 'slate', id: '1' } },
+          { field: { widget: 'other', id: '2' } },
+        ],
+      },
+    ];
+    getAllBlocks.mockReturnValue(blocks);
+
+    const result = getAllBlocksAndSlateFields(properties);
+
+    expect(result).toEqual([]);
+  });
+
+  it('handles metadata correctly', () => {
+    const properties = { '1': ['metadata test'] };
+    const blocks = [
+      {
+        '@type': 'metadata',
+        data: { id: '1', widget: 'slate' },
+      },
+    ];
+    getAllBlocks.mockReturnValue(blocks);
+
+    const expected = [{ '@type': 'slate', id: '1', value: ['metadata test'] }];
+    const result = getAllBlocksAndSlateFields(properties);
+
+    expect(result).toEqual(expected);
+  });
+
+  it('handles metadata correctly with no properties', () => {
+    const properties = {};
+    const blocks = [
+      {
+        '@type': 'metadata',
+        data: { id: '1', widget: 'slate' },
+      },
+    ];
+    getAllBlocks.mockReturnValue(blocks);
+
+    const expected = [{ '@type': 'slate', id: '1', value: null }];
+    const result = getAllBlocksAndSlateFields(properties);
+
+    expect(result).toEqual(expected);
+  });
+
+  it('handles metadata correctly with no slate widgets', () => {
+    const properties = {};
+    const blocks = [
+      {
+        '@type': 'metadata',
+        data: { id: '1', widget: 'test' },
+      },
+    ];
+    getAllBlocks.mockReturnValue(blocks);
+
+    const expected = [];
+    const result = getAllBlocksAndSlateFields(properties);
+
+    expect(result).toEqual(expected);
+  });
+
+  it('handles slateTable correctly', () => {
+    const properties = {};
+    const blocks = [
+      {
+        '@type': 'slateTable',
+        table: {
+          rows: [{ cells: [{ cell1: '1' }, { cell2: '2' }] }],
+        },
+      },
+    ];
+    getAllBlocks.mockReturnValue(blocks);
+
+    const expected = [
+      { '@type': 'slate', cell1: '1' },
+      { '@type': 'slate', cell2: '2' },
+    ];
+    const result = getAllBlocksAndSlateFields(properties);
+
+    expect(result).toEqual(expected);
+  });
+
+  it('handles slateTable correctly with no rows', () => {
+    const properties = {};
+    const blocks = [
+      {
+        '@type': 'slateTable',
+        table: {},
+      },
+    ];
+    getAllBlocks.mockReturnValue(blocks);
+
+    const expected = [];
+    const result = getAllBlocksAndSlateFields(properties);
+
+    expect(result).toEqual(expected);
+  });
+
+  it('handles slateTable correctly with no cells', () => {
+    const properties = {};
+    const blocks = [
+      {
+        '@type': 'slateTable',
+        table: {
+          rows: [{ cells: undefined }],
+        },
+      },
+    ];
+    getAllBlocks.mockReturnValue(blocks);
+
+    const expected = [];
+    const result = getAllBlocksAndSlateFields(properties);
+
+    expect(result).toEqual(expected);
+  });
+
+  it('handles defaultOperation correctly', () => {
+    const properties = {};
+    const blocks = [{ block: '1', '@type': 'testType' }];
+    getAllBlocks.mockReturnValue(blocks);
+
+    const expected = [blocks[0]];
+    const result = getAllBlocksAndSlateFields(properties);
+
+    expect(result).toEqual(expected);
+  });
+});