@eeacms/volto-hero-block 5.3.1 → 5.4.0

package/CHANGELOG.md

@@ -4,6 +4,23 @@ 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).
 
+### [5.4.0](https://github.com/eea/volto-hero-block/compare/5.3.1...5.4.0) - 12 June 2023
+
+#### :house: Internal changes
+
+
+#### :hammer_and_wrench: Others
+
+- Release 5.4.0 [Alin Voinea - [`1b54e52`](https://github.com/eea/volto-hero-block/commit/1b54e52ad0f3185917d19015220037efb407422c)]
+- test: jest should look for addons in node_modules Refs #253277 [valentinab25 - [`531ac2a`](https://github.com/eea/volto-hero-block/commit/531ac2a53eec82921d21d2606553580597fc8c82)]
+- test: Add cypress test for basic functionality and demo gif to README - refs #253277 [ana-oprea - [`9f8cd97`](https://github.com/eea/volto-hero-block/commit/9f8cd978e1cd776f44be1adc23aae19cf1efda49)]
+- test: Add unit tests for Hero, Copyright and helpers - refs #253277 [ana-oprea - [`3949378`](https://github.com/eea/volto-hero-block/commit/3949378060a7eb373e8ded529f7047d5c5a60aa9)]
+- test: Fix test config, coverage Refs #253277 [valentinab25 - [`33c1d94`](https://github.com/eea/volto-hero-block/commit/33c1d949c32b69556c05a74cc28ed9aef4112f83)]
+- merge develop into this branch [Miu Razvan - [`cc1cda3`](https://github.com/eea/volto-hero-block/commit/cc1cda3edcbd2c2cbbdda8a3ec03d7084b6eca5c)]
+- clean up [Miu Razvan - [`2a51fcf`](https://github.com/eea/volto-hero-block/commit/2a51fcf5a79a6497a3f7609216efe944c45a0af0)]
+- other: update getFieldURL function [Miu Razvan - [`8c9ee98`](https://github.com/eea/volto-hero-block/commit/8c9ee980e898cb09a553f5956871c0b285c80280)]
+- update with getFieldURL on buttonLink [tedw87 - [`4d1fd61`](https://github.com/eea/volto-hero-block/commit/4d1fd61faba366a96a54c23e67d7d306364924fe)]
+- refactor code [tedw87 - [`0bf669d`](https://github.com/eea/volto-hero-block/commit/0bf669d7d150d1b9e33ff6e727d6cf47f6d4871e)]
 ### [5.3.1](https://github.com/eea/volto-hero-block/compare/5.3.0...5.3.1) - 22 May 2023
 
 #### :hammer_and_wrench: Others
@@ -11,7 +28,6 @@ Generated by [`auto-changelog`](https://github.com/CookPete/auto-changelog).
 - put return statement [Dobricean Ioan Dorian - [`8eff5fd`](https://github.com/eea/volto-hero-block/commit/8eff5fdf977fcbb8cc952d3f45b577b02ca59cb9)]
 - change name and refactor to be more efficent [Dobricean Ioan Dorian - [`ff24145`](https://github.com/eea/volto-hero-block/commit/ff2414542833998ef282376de3fbda8698287849)]
 - stop-image-disappear over and over [Dobricean Ioan Dorian - [`c5b6f54`](https://github.com/eea/volto-hero-block/commit/c5b6f545ac422d95b8d802349aa4cf27af820829)]
-- Add Sonarqube tag using industry-frontend addons list [EEA Jenkins - [`3d38dd0`](https://github.com/eea/volto-hero-block/commit/3d38dd09a36525bda448f67a6d218bc7690a4cc3)]
 ### [5.3.0](https://github.com/eea/volto-hero-block/compare/5.2.0...5.3.0) - 27 March 2023
 
 #### :rocket: New Features
@@ -50,11 +66,9 @@ Generated by [`auto-changelog`](https://github.com/CookPete/auto-changelog).
 - fix onScreen hook error #16 from eea/fix-onscreen-hook [ichim-david - [`9123541`](https://github.com/eea/volto-hero-block/commit/91235413f423d7e6c4788d70b687b3ed5d4884b4)]
 - no need for comments [andreiggr - [`a14f9c3`](https://github.com/eea/volto-hero-block/commit/a14f9c3bdddfa22e6b4bbc8318f0ca5bdc9c2d38)]
 - fix hook [andreiggr - [`f7fae73`](https://github.com/eea/volto-hero-block/commit/f7fae73007f79af2f06da1d9b72a53ad86fef4ac)]
-- Add Sonarqube tag using eea-website-frontend addons list [EEA Jenkins - [`6b78fc0`](https://github.com/eea/volto-hero-block/commit/6b78fc044a933ab9b4b4694901aa26628ef0a836)]
 - eslint [andreiggr - [`68451b7`](https://github.com/eea/volto-hero-block/commit/68451b725420015fbd5b695e97b8742988d49913)]
 - lazy load huge img on first 10px [andreiggr - [`67dc7d3`](https://github.com/eea/volto-hero-block/commit/67dc7d3475188d692e053032c2639dd1a585c029)]
 - lazy load huge bgimage wip [andreiggr - [`86e45ec`](https://github.com/eea/volto-hero-block/commit/86e45ece842f1cd7452920dffa3a9b4aea945f56)]
-- Add Sonarqube tag using ims-frontend addons list [EEA Jenkins - [`87cbb38`](https://github.com/eea/volto-hero-block/commit/87cbb383290a168f85703573670e17f4e1ed7747)]
 ## [4.0.0](https://github.com/eea/volto-hero-block/compare/3.0.1...4.0.0) - 7 February 2023
 
 #### :nail_care: Enhancements
@@ -80,7 +94,6 @@ Generated by [`auto-changelog`](https://github.com/CookPete/auto-changelog).
 
 #### :hammer_and_wrench: Others
 
-- Add Sonarqube tag using advisory-board-frontend addons list [EEA Jenkins - [`ab85c7b`](https://github.com/eea/volto-hero-block/commit/ab85c7bd5bd1e3aec95e02f9b4d026b1203d5739)]
 ## [3.0.0](https://github.com/eea/volto-hero-block/compare/2.1.0...3.0.0) - 22 December 2022
 
 #### :rocket: New Features
@@ -89,11 +102,8 @@ Generated by [`auto-changelog`](https://github.com/CookPete/auto-changelog).
 
 #### :hammer_and_wrench: Others
 
-- Add Sonarqube tag using advisory-board-frontend addons list [EEA Jenkins - [`f06f58c`](https://github.com/eea/volto-hero-block/commit/f06f58c7cd4cfc15a03208e9c7a4e31fe2eba2f6)]
-- Add Sonarqube tag using climate-energy-frontend addons list [EEA Jenkins - [`20e5bcb`](https://github.com/eea/volto-hero-block/commit/20e5bcb3c4dd538595741928319c3204c5d18f8c)]
 - Cosmetics [Alin Voinea - [`9dac70c`](https://github.com/eea/volto-hero-block/commit/9dac70c0a3bea8e188ede9123f4f99de8e0f6987)]
 - test(Jenkins): Run tests and cypress with latest canary @plone/volto [Alin Voinea - [`2d4005f`](https://github.com/eea/volto-hero-block/commit/2d4005f0f31b121e1b7d2e94414f3dff92ec1a16)]
-- Add Sonarqube tag using cca-frontend addons list [EEA Jenkins - [`2931fcc`](https://github.com/eea/volto-hero-block/commit/2931fccbee5f8e117e5ae9095ba57e63e465ddb3)]
 ### [2.1.0](https://github.com/eea/volto-hero-block/compare/2.0.0...2.1.0) - 12 December 2022
 
 #### :bug: Bug Fixes
@@ -102,12 +112,6 @@ Generated by [`auto-changelog`](https://github.com/CookPete/auto-changelog).
 
 #### :hammer_and_wrench: Others
 
-- Add Sonarqube tag using bise-frontend addons list [EEA Jenkins - [`93be4f9`](https://github.com/eea/volto-hero-block/commit/93be4f96fb72cacfc25f9b058cb379d80060ee13)]
-- yarn 3 [Alin Voinea - [`8e2dccd`](https://github.com/eea/volto-hero-block/commit/8e2dccd47cbef3c0871407baa376ce61c540c754)]
-- Add Sonarqube tag using marine-frontend addons list [EEA Jenkins - [`6bc3af3`](https://github.com/eea/volto-hero-block/commit/6bc3af35b4edf07971d1b0ce1648965e8d6e3bc0)]
-- Add Sonarqube tag using clms-frontend addons list [EEA Jenkins - [`d7dbbd2`](https://github.com/eea/volto-hero-block/commit/d7dbbd21277dd76bf59d91a4dc8e022b2a6ff99c)]
-- Add Sonarqube tag using demo-kitkat-frontend addons list [EEA Jenkins - [`3c1f0d6`](https://github.com/eea/volto-hero-block/commit/3c1f0d6e7f8e5318aee3413ec3687d8492376f9d)]
-- Add Sonarqube tag using forests-frontend addons list [EEA Jenkins - [`843017a`](https://github.com/eea/volto-hero-block/commit/843017aa7dbea71cc7888663496e352d287440b4)]
 ## [2.0.0](https://github.com/eea/volto-hero-block/compare/1.0.0...2.0.0) - 16 November 2022
 
 #### :nail_care: Enhancements
@@ -117,7 +121,6 @@ Generated by [`auto-changelog`](https://github.com/CookPete/auto-changelog).
 #### :hammer_and_wrench: Others
 
 - test(estlint): Fix .project.eslintrc.js [Alin Voinea - [`b8f0971`](https://github.com/eea/volto-hero-block/commit/b8f0971b21a5334d40c1b8f5103cea61d9ffe6f1)]
-- Add Sonarqube tag using circularity-frontend addons list [EEA Jenkins - [`581dedf`](https://github.com/eea/volto-hero-block/commit/581dedf07410ef2ca09e6ddaa05fbf176400adbb)]
 ## [1.0.0](https://github.com/eea/volto-hero-block/compare/0.2.0...1.0.0) - 28 October 2022
 
 #### :nail_care: Enhancements
@@ -129,7 +132,6 @@ Generated by [`auto-changelog`](https://github.com/CookPete/auto-changelog).
 - Remove cypress.json [Alin Voinea - [`593bdf2`](https://github.com/eea/volto-hero-block/commit/593bdf207ca4fd3f2393117b6f64a44727881ad0)]
 - test(cypress): Upgrade to Cypress 10 / Razzle 4 [Alin Voinea - [`edd48a5`](https://github.com/eea/volto-hero-block/commit/edd48a5c13824bce5e03e46790f1890656b340d8)]
 - Cleanup [Alin Voinea - [`9d72ee7`](https://github.com/eea/volto-hero-block/commit/9d72ee7a06d1c6fed46586d30bb85eae39e670bf)]
-- Add Sonarqube tag using eea-website-frontend addons list [EEA Jenkins - [`95986d0`](https://github.com/eea/volto-hero-block/commit/95986d0b8fd5c3cbb9e6da9059f71e066a8e171b)]
 ### [0.2.0](https://github.com/eea/volto-hero-block/compare/0.1.4...0.2.0) - 6 July 2022
 
 #### :bug: Bug Fixes
@@ -168,7 +170,6 @@ Generated by [`auto-changelog`](https://github.com/CookPete/auto-changelog).
 - Update slate footnote support [Miu Razvan - [`c1522b4`](https://github.com/eea/volto-hero-block/commit/c1522b4164dbe6de01771d211d7e0bf3009f44d4)]
 - Use justify content for text and button as well [Miu Razvan - [`08599cc`](https://github.com/eea/volto-hero-block/commit/08599cc45546d9b349128c4f8ce9c01318385811)]
 - Add dependencies [Miu Razvan - [`30e2881`](https://github.com/eea/volto-hero-block/commit/30e2881a2a97a899e7f4cc614a0405c300ac6fee)]
-- Add Sonarqube tag using eea-website-frontend addons list [EEA Jenkins - [`b415422`](https://github.com/eea/volto-hero-block/commit/b41542285edd29440a324b101a4dbae9334830bf)]
 ### 0.1.0 - 10 June 2022
 
 #### :hammer_and_wrench: Others

package/README.md

@@ -19,7 +19,7 @@ Enhanced Hero Block [Volto](https://github.com/plone/volto) add-on
 
 ## Features
 
-Demo GIF
+![Hero Block](https://github.com/eea/volto-hero-block/raw/docs/docs/volto-hero.gif)
 
 ## Upgrade
 

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-hero-block",
-  "version": "5.3.1",
+  "version": "5.4.0",
   "description": "@eeacms/volto-hero-block: Volto add-on",
   "main": "src/index.js",
   "author": "European Environment Agency: IDM2 A-Team",

package/src/components/Blocks/Hero/Copyright.test.jsx

@@ -0,0 +1,35 @@
+import React from 'react';
+import renderer from 'react-test-renderer';
+import Copyright from './Copyright';
+import { Icon } from 'semantic-ui-react';
+import { Provider } from 'react-intl-redux';
+import configureStore from 'redux-mock-store';
+import config from '@plone/volto/registry';
+
+const mockStore = configureStore();
+
+test('renders copyright', () => {
+  const store = mockStore({
+    intl: {
+      locale: 'en',
+      messages: {},
+    },
+  });
+  const copyrightPrefix =
+    config.blocks.blocksConfig.hero?.copyrightPrefix || '';
+
+  const component = renderer.create(
+    <Provider store={store}>
+      <Copyright copyrightPosition={'left'}>
+        <Copyright.Prefix>{copyrightPrefix}</Copyright.Prefix>
+        <Copyright.Icon>
+          <Icon className={'copyright outline'} />
+        </Copyright.Icon>
+        <Copyright.Text>Copyright Text Test</Copyright.Text>
+      </Copyright>
+    </Provider>,
+  );
+
+  const json = component.toJSON();
+  expect(json).toMatchSnapshot();
+});

package/src/components/Blocks/Hero/Edit.jsx

@@ -18,11 +18,13 @@ import {
 } from '@plone/volto-slate/actions';
 
 import { createSlateHeader } from '@eeacms/volto-hero-block/helpers';
+import { getFieldURL } from '@eeacms/volto-hero-block/helpers';
 
 import Copyright from './Copyright';
 import Hero from './Hero';
 
-const Metadata = ({ buttonLabel, buttonLink, inverted, styles }) => {
+const Metadata = ({ buttonLabel, inverted, styles, ...props }) => {
+  const buttonLink = getFieldURL(props.buttonLink);
   const { buttonVariant } = styles || {};
 
   return buttonLabel ? (

package/src/components/Blocks/Hero/Hero.jsx

@@ -2,7 +2,7 @@ import React from 'react';
 import cx from 'classnames';
 import PropTypes from 'prop-types';
 import { isInternalURL } from '@plone/volto/helpers/Url/Url';
-import { isImageGif } from '@eeacms/volto-hero-block/helpers';
+import { isImageGif, getFieldURL } from '@eeacms/volto-hero-block/helpers';
 import { useFirstVisited } from '@eeacms/volto-hero-block/hooks';
 
 Hero.propTypes = {
@@ -19,7 +19,6 @@ Hero.propTypes = {
 };
 
 function Hero({
-  image,
   overlay = true,
   fullWidth = true,
   fullHeight = true,
@@ -27,7 +26,9 @@ function Hero({
   spaced = false,
   inverted = true,
   styles,
+  ...props
 }) {
+  const image = getFieldURL(props.image);
   const isExternal = !isInternalURL(image);
   const { alignContent = 'center', backgroundVariant = 'primary' } =
     styles || {};

package/src/components/Blocks/Hero/Hero.test.jsx

@@ -0,0 +1,40 @@
+import React from 'react';
+import renderer from 'react-test-renderer';
+import Hero from './Hero';
+import { Provider } from 'react-intl-redux';
+import configureStore from 'redux-mock-store';
+
+const mockStore = configureStore();
+
+test('renders a hero component', () => {
+  const store = mockStore({
+    intl: {
+      locale: 'en',
+      messages: {},
+    },
+  });
+  const component = renderer.create(
+    <Provider store={store}>
+      <Hero
+        image=""
+        overlay={true}
+        fullWidth={true}
+        fullHeight={true}
+        spaced={false}
+        inverted={true}
+        styles={{ alignContent: 'center', backgroundVariant: 'primary' }}
+      >
+        <Hero.Text
+          quoted={false}
+          styles={{ textVariant: 'white', textAlign: 'left' }}
+        >
+          Text test
+        </Hero.Text>
+        <Hero.Meta styles={{ buttonAlign: 'left' }}>Test meta</Hero.Meta>
+      </Hero>
+    </Provider>,
+  );
+
+  const json = component.toJSON();
+  expect(json).toMatchSnapshot();
+});

package/src/components/Blocks/Hero/View.jsx

@@ -6,9 +6,11 @@ import { BodyClass } from '@plone/volto/helpers';
 import Hero from './Hero';
 import Copyright from './Copyright';
 import { serializeText } from '@eeacms/volto-hero-block/helpers';
+import { getFieldURL } from '@eeacms/volto-hero-block/helpers';
 import config from '@plone/volto/registry';
 
-const Metadata = ({ buttonLabel, buttonLink, inverted, styles }) => {
+const Metadata = ({ buttonLabel, inverted, styles, ...props }) => {
+  const buttonLink = getFieldURL(props.buttonLink);
   const { buttonVariant = 'white' } = styles || {};
 
   return buttonLabel ? (

package/src/helpers.js

@@ -1,5 +1,23 @@
-import { isArray } from 'lodash';
 import { serializeNodes } from '@plone/volto-slate/editor/render';
+import isArray from 'lodash/isArray';
+import isObject from 'lodash/isObject';
+import isString from 'lodash/isString';
+import { isInternalURL, flattenToAppURL } from '@plone/volto/helpers';
+
+export const getFieldURL = (data) => {
+  let url = data;
+  const _isObject = data && isObject(data) && !isArray(data);
+  if (_isObject && data['@type'] === 'URL') {
+    url = data['value'] ?? data['url'] ?? data['href'] ?? data;
+  } else if (_isObject) {
+    url = data['@id'] ?? data['url'] ?? data['href'] ?? data;
+  }
+  if (isArray(data)) {
+    url = data.map((item) => getFieldURL(item));
+  }
+  if (isString(url) && isInternalURL(url)) return flattenToAppURL(url);
+  return url;
+};
 
 const createEmptyHeader = () => {
   return {

package/src/helpers.test.js

@@ -0,0 +1,66 @@
+import { createSlateHeader, serializeText, isImageGif } from './helpers';
+import { isArray } from 'lodash';
+import { serializeNodes } from '@plone/volto-slate/editor/render';
+
+jest.mock('@plone/volto-slate/editor/render', () => ({
+  serializeNodes: jest.fn(),
+}));
+
+describe('createSlateHeader', () => {
+  it('should return the text if it is an array', () => {
+    const text = ['some', 'text'];
+    expect(createSlateHeader(text)).toEqual(text);
+  });
+
+  it('should return an array with an empty header if the text is not an array', () => {
+    const text = 'some text';
+    expect(createSlateHeader(text)).toEqual([
+      {
+        type: 'h2',
+        children: [{ text: '' }],
+      },
+    ]);
+  });
+});
+
+describe('serializeText', () => {
+  it('should return the text when it is not an array', () => {
+    const text = 'Hello, World!';
+
+    expect(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!'];
+
+    serializeText(text);
+    expect(isArray(text)).toBe(true);
+    expect(serializeNodes).toHaveBeenCalledWith(text);
+  });
+});
+
+describe('isImageGif', () => {
+  it('should return true when input is a gif image', () => {
+    const input = 'image.gif';
+    const result = isImageGif(input);
+    expect(result).toBeTruthy();
+  });
+
+  it('should return false when input is not a gif image', () => {
+    const input = 'image.jpg';
+    const result = isImageGif(input);
+    expect(result).toBeFalsy();
+  });
+
+  it('should return false when input is null or undefined', () => {
+    let input;
+    let result = isImageGif(input);
+    expect(result).toBeFalsy();
+
+    input = null;
+    result = isImageGif(input);
+    expect(result).toBeFalsy();
+  });
+});