@eeacms/volto-eea-website-policy 1.6.3 → 1.7.1

package/CHANGELOG.md

@@ -4,6 +4,31 @@ 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).
 
+### [1.7.1](https://github.com/eea/volto-eea-website-policy/compare/1.7.0...1.7.1) - 24 July 2023
+
+#### :rocket: New Features
+
+- feat: Add IMSv4 custom widgets - refs #145772 [Alin Voinea - [`367f0b6`](https://github.com/eea/volto-eea-website-policy/commit/367f0b611d6f69f217b1b0aaa25783968b8911ba)]
+
+#### :house: Internal changes
+
+- chore: Disable InstitutionalMandate DataProvenance widgets for now as there are issues - refs #160747 [Alin Voinea - [`bbdc3fb`](https://github.com/eea/volto-eea-website-policy/commit/bbdc3fb85a6ebd04205d763a75a1288f00efa634)]
+
+#### :hammer_and_wrench: Others
+
+- test: add unit tests - refs #254313 [ana-oprea - [`b51c1a9`](https://github.com/eea/volto-eea-website-policy/commit/b51c1a95f6a0624e75d168627d80009762ac4803)]
+### [1.7.0](https://github.com/eea/volto-eea-website-policy/compare/1.6.3...1.7.0) - 16 June 2023
+
+#### :house: Internal changes
+
+- chore: Move IMS dataFigure to data_visualizations group - refs #253827 [Alin Voinea - [`0d782f9`](https://github.com/eea/volto-eea-website-policy/commit/0d782f90c72080f48f14f5f28a6ef63fba12cc7c)]
+
+#### :hammer_and_wrench: Others
+
+- Release 1.7.0 [Alin Voinea - [`93c05fa`](https://github.com/eea/volto-eea-website-policy/commit/93c05fae93b075223ef3f232963b7b4c9c682f42)]
+- fix overrideBlocks [Miu Razvan - [`6e1a27e`](https://github.com/eea/volto-eea-website-policy/commit/6e1a27e15d1576643be6b88d2b8e888a538fc6e5)]
+- call appendGroup with all parameters [Miu Razvan - [`09a914e`](https://github.com/eea/volto-eea-website-policy/commit/09a914e695c0f05a3076c2e7ae5c708dac2a7787)]
+- changed gropup of plotly to data_visualizations [Miu Razvan - [`6974dc4`](https://github.com/eea/volto-eea-website-policy/commit/6974dc4126d876510bb8ec63732bf350cf79d1ab)]
 ### [1.6.3](https://github.com/eea/volto-eea-website-policy/compare/1.6.2...1.6.3) - 13 June 2023
 
 #### :bug: Bug Fixes

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@eeacms/volto-eea-website-policy",
-  "version": "1.6.3",
+  "version": "1.7.1",
   "description": "@eeacms/volto-eea-website-policy: Volto add-on",
   "main": "src/index.js",
   "author": "European Environment Agency: IDM2 A-Team",

package/src/components/Blocks/ContextNavigation/ContextNavigationEdit.test.jsx

@@ -0,0 +1,64 @@
+import React from 'react';
+import { render, fireEvent } from '@testing-library/react';
+import ContextNavigationEdit from './ContextNavigationEdit';
+import { Router } from 'react-router-dom';
+import { createMemoryHistory } from 'history';
+import '@testing-library/jest-dom/extend-expect';
+
+jest.mock('@plone/volto/components', () => ({
+  InlineForm: ({ onChangeField }) => (
+    <div>
+      <p>InlineForm</p>
+      <input id="test" onChange={onChangeField} />
+    </div>
+  ),
+  SidebarPortal: ({ children }) => (
+    <div>
+      <div>SidebarPortal</div>
+      {children}
+    </div>
+  ),
+}));
+
+jest.mock('@plone/volto/components/theme/Navigation/ContextNavigation', () => {
+  return {
+    __esModule: true,
+    default: ({ params }) => {
+      return <div>ConnectedContextNavigation {params.root_path}</div>;
+    },
+  };
+});
+
+describe('ContextNavigationEdit', () => {
+  it('renders corectly', () => {
+    const history = createMemoryHistory();
+    const { getByText, queryByText } = render(
+      <Router history={history}>
+        <ContextNavigationEdit />
+      </Router>,
+    );
+
+    expect(getByText('Context navigation')).toBeInTheDocument();
+    expect(getByText('ConnectedContextNavigation')).toBeInTheDocument();
+    expect(queryByText('InlineForm')).toBeNull();
+    expect(getByText('SidebarPortal')).toBeInTheDocument();
+  });
+
+  it('renders corectly', () => {
+    const history = createMemoryHistory();
+    const { container, getByText } = render(
+      <Router history={history}>
+        <ContextNavigationEdit selected={true} onChangeBlock={() => {}} />
+      </Router>,
+    );
+
+    expect(getByText('Context navigation')).toBeInTheDocument();
+    expect(getByText('ConnectedContextNavigation')).toBeInTheDocument();
+    expect(getByText('InlineForm')).toBeInTheDocument();
+    expect(getByText('SidebarPortal')).toBeInTheDocument();
+
+    fireEvent.change(container.querySelector('#test'), {
+      target: { value: 'test' },
+    });
+  });
+});

package/src/components/Blocks/ContextNavigation/ContextNavigationView.test.jsx

@@ -0,0 +1,50 @@
+import React from 'react';
+import { render } from '@testing-library/react';
+import ContextNavigationView from './ContextNavigationView';
+import { Router } from 'react-router-dom';
+import { createMemoryHistory } from 'history';
+import '@testing-library/jest-dom/extend-expect';
+
+jest.mock('@plone/volto/components/theme/Navigation/ContextNavigation', () => {
+  return {
+    __esModule: true,
+    default: ({ params }) => {
+      return <div>ConnectedContextNavigation {params.root_path}</div>;
+    },
+  };
+});
+
+describe('ContextNavigationView', () => {
+  let history;
+  beforeEach(() => {
+    history = createMemoryHistory();
+  });
+
+  it('renders corectly', () => {
+    const { container } = render(
+      <Router history={history}>
+        <ContextNavigationView />
+      </Router>,
+    );
+
+    expect(container.firstChild).toHaveTextContent(
+      'ConnectedContextNavigation',
+    );
+  });
+
+  it('renders corectly', () => {
+    const { container } = render(
+      <Router history={history}>
+        <ContextNavigationView
+          data={{
+            navProps: { root_path: 'https://localhost:3000/test' },
+            root_node: [{ '@id': 'root_node' }],
+          }}
+        />
+      </Router>,
+    );
+    expect(container.firstChild).toHaveTextContent(
+      'ConnectedContextNavigation root_node',
+    );
+  });
+});

package/src/components/Widgets/DataProvenance.jsx

@@ -0,0 +1,6 @@
+// import React from 'react';
+// import RichTextWidget from '@plone/volto-slate/widgets/RichTextWidget';
+
+export const DataProvenance = () =>
+  // <RichTextWidget {...props} readOnly={true} />
+  ' Data Provenance ';

package/src/components/Widgets/FrequencyOfDissemination.jsx

@@ -0,0 +1,15 @@
+import React from 'react';
+import cx from 'classnames';
+
+export const FrequencyOfDissemination = ({ value, children, className }) => {
+  if (!value) {
+    return '';
+  }
+
+  const text = value > 1 ? `Every ${value} years` : 'Once a year';
+  return (
+    <span className={cx(className, 'text', 'widget')}>
+      {children ? children(text) : text}
+    </span>
+  );
+};

package/src/components/Widgets/InstitutionalMandate.jsx

@@ -0,0 +1,6 @@
+// import React from 'react';
+// import RichTextWidget from '@plone/volto-slate/widgets/RichTextWidget';
+
+export const InstitutionalMandate = () =>
+  // <RichTextWidget {...props} readOnly={true} />
+  ' Institutional Mandate ';

package/src/helpers.js

@@ -9,3 +9,21 @@ export const createSlateParagraph = (text) => {
 export const serializeText = (text) => {
   return isArray(text) ? serializeNodes(text) : text;
 };
+
+export const appendGroup = (config, id, title) => {
+  const groupExists =
+    config.blocks.groupBlocksOrder.filter((group) => group.id === id).length >
+    0;
+
+  if (!groupExists) {
+    config.blocks.groupBlocksOrder = [
+      ...config.blocks.groupBlocksOrder,
+      {
+        id,
+        title,
+      },
+    ];
+  }
+
+  return config.blocks.groupBlocksOrder;
+};

package/src/helpers.test.js

@@ -0,0 +1,86 @@
+import * as helpers from './helpers';
+import config from '@plone/volto/registry';
+import { serializeNodes } from '@plone/volto-slate/editor/render';
+import { isArray } from 'lodash';
+import '@testing-library/jest-dom/extend-expect';
+
+jest.mock('@plone/volto/registry', () => ({
+  settings: {
+    slate: {
+      defaultValue: jest.fn(),
+    },
+  },
+  blocks: {
+    groupBlocksOrder: [
+      { id: 'group1', title: 'Group1' },
+      { id: 'group2', title: 'Group2' },
+    ],
+  },
+}));
+
+jest.mock('@plone/volto-slate/editor/render', () => ({
+  serializeNodes: jest.fn(),
+}));
+
+describe('createSlateParagraph', () => {
+  it('should return default value when input is not an array', () => {
+    const input = 'test';
+    helpers.createSlateParagraph(input);
+    expect(config.settings.slate.defaultValue).toHaveBeenCalledTimes(1);
+  });
+
+  it('should return input when input is an array', () => {
+    const input = ['test'];
+    const result = helpers.createSlateParagraph(input);
+    expect(result).toBe(input);
+  });
+});
+
+describe('serializeText', () => {
+  beforeEach(() => {
+    jest.resetAllMocks();
+  });
+
+  it('should return the text when it is not an array', () => {
+    const text = 'Hello, World!';
+
+    expect(helpers.serializeText(text)).toEqual(text);
+    expect(isArray(text)).toBe(false);
+    expect(serializeNodes).not.toHaveBeenCalled();
+  });
+
+  it('should call serializeNodes when text is an array', () => {
+    const text = ['Hello', 'World!'];
+
+    helpers.serializeText(text);
+    expect(isArray(text)).toBe(true);
+    expect(serializeNodes).toHaveBeenCalledWith(text);
+  });
+});
+
+describe('appendGroup', () => {
+  beforeEach(() => {
+    jest.resetAllMocks();
+  });
+
+  it('should return the text when it is not an array', () => {
+    const id = 'group2';
+    const title = 'Group2';
+    const result = helpers.appendGroup(config, id, title);
+    expect(result).toEqual([
+      { id: 'group1', title: 'Group1' },
+      { id: 'group2', title: 'Group2' },
+    ]);
+  });
+
+  it('should return the text when it is not an array', () => {
+    const id = 'group3';
+    const title = 'Group3';
+    const result = helpers.appendGroup(config, id, title);
+    expect(result).toEqual([
+      { id: 'group1', title: 'Group1' },
+      { id: 'group2', title: 'Group2' },
+      { id, title },
+    ]);
+  });
+});

package/src/index.js

@@ -1,10 +1,12 @@
 import { runtimeConfig } from '@plone/volto/runtime_config';
 import installContextNavigationBlock from '@eeacms/volto-eea-website-policy/components/Blocks/ContextNavigation';
+import { appendGroup } from './helpers';
+import { FrequencyOfDissemination } from '@eeacms/volto-eea-website-policy/components/Widgets/FrequencyOfDissemination';
+import { DataProvenance } from '@eeacms/volto-eea-website-policy/components/Widgets/DataProvenance';
+import { InstitutionalMandate } from '@eeacms/volto-eea-website-policy/components/Widgets/InstitutionalMandate';
 
 const restrictedBlocks = [
   'imagecards',
-  'embed_eea_tableau_block',
-  'embed_eea_map_block',
   // TODO: use what is needed from volto-datablocks after clean-up
   'conditionalDataBlock',
   'countryFlag',
@@ -15,6 +17,21 @@ const restrictedBlocks = [
   'simpleDataConnectedTable',
 ];
 
+const overrideBlocks = {
+  embed_tableau_visualization: {
+    group: 'data_visualizations',
+  },
+  tableau_block: {
+    group: 'data_visualizations',
+  },
+  embed_eea_map_block: {
+    group: 'data_visualizations',
+  },
+  dataFigure: {
+    group: 'data_visualizations',
+  },
+};
+
 const applyConfig = (config) => {
   // #158717#note-25 any path that isn't static, en or controlpanel is treated as external
   const notInEN = /^(?!(#|\/en|\/static|\/controlpanel|\/cypress|\/login|\/logout|\/contact-form)).*$/;
@@ -78,6 +95,13 @@ const applyConfig = (config) => {
     config,
   );
 
+  // Add groups
+  config.blocks.groupBlocksOrder = appendGroup(
+    config,
+    'data_visualizations',
+    'Data Visualizations (Beta)',
+  );
+
   // Disable some blocks
   restrictedBlocks.forEach((block) => {
     if (config.blocks.blocksConfig[block]) {
@@ -85,6 +109,22 @@ const applyConfig = (config) => {
     }
   });
 
+  // Override blocks config
+  Object.keys(overrideBlocks).forEach((block) => {
+    if (config.blocks.blocksConfig[block]) {
+      config.blocks.blocksConfig[block] = {
+        ...config.blocks.blocksConfig[block],
+        ...overrideBlocks[block],
+      };
+    }
+  });
+
+  // Custom widgets
+  config.widgets.id.data_provenance = DataProvenance;
+  config.widgets.id.institutional_mandate = InstitutionalMandate;
+  config.widgets.views.id.frequency_of_dissemination = FrequencyOfDissemination;
+
+  // Subsite
   config.settings.apiExpanders = [
     ...config.settings.apiExpanders,
     {