gatsby-theme-q3 3.1.4 → 3.2.2

package/src/components/SearchEngine.jsx

@@ -1,32 +1,89 @@
 import React from 'react';
+import { get, isFunction, isObject } from 'lodash';
 import PropTypes from 'prop-types';
 import { Helmet } from 'react-helmet';
+import { browser } from 'q3-ui-helpers';
 import useSiteMetaData from './useSiteMetaData';
 
+const withContent = (output) => (content) =>
+  content && isFunction(output) ? output(content) : [];
+
+export const getStartUrl = () =>
+  browser.isBrowserReady()
+    ? get(window, 'location.host')
+    : '';
+
+export const generateMetaDescriptionOptions = withContent(
+  (content) => [
+    {
+      name: 'description',
+      content,
+    },
+    {
+      property: 'og:description',
+      content,
+    },
+    {
+      name: 'twitter:description',
+      content,
+    },
+  ],
+);
+
+export const generateMetaTitleOptions = withContent(
+  (content) => [
+    {
+      property: 'og:title',
+      content,
+    },
+    {
+      name: 'twitter:title',
+      content,
+    },
+  ],
+);
+
+export const generateBrand = (xs) =>
+  xs ? `%s | ${xs}` : undefined;
+
+export const generateIcons = (site = {}) =>
+  site?.favicon
+    ? [
+        {
+          src: site.favicon,
+          sizes: '512x512',
+          type: 'image/png',
+        },
+      ]
+    : [];
+
+export const generateManifest = (site = {}) => ({
+  background_color: site.color,
+  description: site.description,
+  display: 'fullscreen',
+  icons: generateIcons(site),
+  name: site.title,
+  start_url: getStartUrl(),
+  short_name: site.brand,
+  theme_color: site.color,
+});
+
 const SEO = ({ description, lang, meta, title }) => {
   const site = useSiteMetaData();
   const metaDescription = description || site.description;
+  const metaTitle = title || site.title;
+  const manifestData = generateManifest(site);
 
   return (
     <Helmet
       htmlAttributes={{
         lang,
       }}
-      title={title || site.title}
-      titleTemplate={`%s | ${site.brand}`}
+      title={metaTitle}
+      titleTemplate={generateBrand(site.brand)}
       meta={[
-        {
-          name: 'description',
-          content: metaDescription,
-        },
-        {
-          property: 'og:title',
-          content: title,
-        },
-        {
-          property: 'og:description',
-          content: metaDescription,
-        },
+        ...generateMetaTitleOptions(metaTitle),
+        ...generateMetaDescriptionOptions(metaDescription),
         {
           property: 'og:type',
           content: 'website',
@@ -35,16 +92,18 @@ const SEO = ({ description, lang, meta, title }) => {
           name: 'twitter:card',
           content: 'summary',
         },
-        {
-          name: 'twitter:title',
-          content: title,
-        },
-        {
-          name: 'twitter:description',
-          content: metaDescription,
-        },
       ].concat(meta)}
-    />
+    >
+      {isObject(manifestData) ? (
+        <link
+          rel="manifest"
+          href={`data:application/manifest+json,${encodeURIComponent(
+            JSON.stringify(manifestData),
+          )}`}
+        />
+      ) : null}
+      <link rel="icon" href={site.favicon} />
+    </Helmet>
   );
 };
 

package/src/components/Wrapper.jsx

@@ -1,38 +1,14 @@
 /* eslint-disable import/no-extraneous-dependencies */
 import React from 'react';
-import axios from 'axios';
 import PropTypes from 'prop-types';
 import AuthProvider from 'q3-ui-permissions';
-import LocaleBundles from './LocaleBundles';
 
-const setBaseUrlForRest = (
-  baseURL = process.env.GATSBY_APP_BASE_URL ||
-    'http://localhost:9000',
-) => {
-  axios.defaults.baseURL = baseURL;
-  return axios.defaults;
-};
-
-const Wrapper = ({ baseURL, children, locale }) => {
-  setBaseUrlForRest(baseURL);
-
-  return (
-    <LocaleBundles locale={locale}>
-      <AuthProvider>{children}</AuthProvider>
-    </LocaleBundles>
-  );
-};
-
-Wrapper.defaultProps = {
-  baseURL: undefined,
-};
+const Wrapper = ({ children }) => (
+  <AuthProvider>{children}</AuthProvider>
+);
 
 Wrapper.propTypes = {
-  baseURL: PropTypes.string,
   children: PropTypes.node.isRequired,
-
-  // eslint-disable-next-line
-  locale: PropTypes.object.isRequired,
 };
 
 export default Wrapper;

package/src/components/__tests__/SearchEngine.test.jsx

@@ -0,0 +1,58 @@
+import {
+  generateMetaDescriptionOptions,
+  getStartUrl,
+  generateIcons,
+  generateBrand,
+} from '../SearchEngine';
+
+jest.mock('q3-ui-locale', () => ({
+  browser: {
+    isBrowserReady: jest.fn(),
+  },
+}));
+
+const host = 'https://google.ca';
+
+beforeEach(() => {
+  Object.defineProperty(window, 'location', {
+    value: {
+      host,
+    },
+  });
+});
+
+describe('SearchEngine', () => {
+  it('should not render descriptions without content', () => {
+    expect(generateMetaDescriptionOptions().length).toBe(0);
+  });
+
+  it('should render descriptions with content', () => {
+    expect(
+      generateMetaDescriptionOptions('foo').length,
+    ).toBeGreaterThanOrEqual(1);
+  });
+
+  it('should return host', () => {
+    expect(getStartUrl()).toMatch(host);
+  });
+
+  it('should render favicon', () => {
+    expect(
+      generateIcons({
+        favicon: host,
+      }),
+    ).toHaveLength(1);
+  });
+
+  it('should not render favicon', () => {
+    expect(
+      generateIcons({
+        favicon: undefined,
+      }),
+    ).toHaveLength(0);
+  });
+
+  it('should include template literals', () => {
+    expect(generateBrand('3merge')).toMatch('%s | 3merge');
+  });
+});

package/src/components/useSiteMetaData.js

@@ -1,22 +1,23 @@
-import { get } from 'lodash';
+import { get, merge } from 'lodash';
 import { useStaticQuery, graphql } from 'gatsby';
+import useRunTime from 'gatsby-theme-q3-mui/src/components/useRunTime';
 
 export default () =>
-  get(
-    useStaticQuery(graphql`
-      query {
-        site {
-          siteMetadata {
-            appDirectory
-            brand
-            description
-            favicon
-            logo
-            title
+  merge(
+    get(
+      useStaticQuery(graphql`
+        query {
+          site {
+            siteMetadata {
+              appDirectory
+              description
+              title
+            }
           }
         }
-      }
-    `),
-    'site.siteMetadata',
-    {},
+      `),
+      'site.siteMetadata',
+      {},
+    ),
+    useRunTime(),
   );

package/src/components/withPublicTemplate.jsx

@@ -0,0 +1,11 @@
+import React from 'react';
+import PublicTemplate from './PublicTemplate';
+
+const withPublicTemplate = (Component) => (props) =>
+  (
+    <PublicTemplate {...props}>
+      <Component {...props} />
+    </PublicTemplate>
+  );
+
+export default withPublicTemplate;

package/src/components/withSuccessOp.jsx

@@ -20,7 +20,7 @@ const withSuccessOp = (Component, msg) => {
           component={Link}
           to="/login"
           variant="contained"
-          color="primary"
+          color="secondary"
         >
           {t('labels:login')}
         </Button>

package/src/pages/login.jsx

@@ -9,48 +9,56 @@ import Box from '@material-ui/core/Box';
 import { Form, Field } from 'q3-ui-forms/lib/builders';
 import FormBox from '../components/FormBox';
 import withAuthenticate from '../components/withAuthenticate';
+import withPublicTemplate from '../components/withPublicTemplate';
 
-export default withAuthenticate(({ authenticate }) => {
-  const { t } = useTranslation();
+const Login = withPublicTemplate(
+  withAuthenticate(({ authenticate }) => {
+    const { t } = useTranslation();
 
-  return (
-    <FormBox
-      renderBottom={
-        <>
-          <Form onSubmit={authenticate}>
-            <Field
-              name="email"
-              type="email"
-              required
-              xl={12}
-              lg={12}
-            />
-            <Field
-              required
-              name="password"
-              type="password"
-              xl={12}
-              lg={12}
-            />
-          </Form>
-          <Box mt={2} mb={1}>
-            <Divider />
-          </Box>
-          <Grid container spacing={1}>
-            <MuiLink component={Link} to="/password-reset">
-              {t('labels:requestNewPassword')}
-            </MuiLink>
-            <MuiLink component={Link} to="/reverify">
-              {t('labels:reverifyLink')}
-            </MuiLink>
-          </Grid>
-        </>
-      }
-      renderTop={
-        <Typography variant="h1" gutterBottom>
-          {t('titles:login')}
-        </Typography>
-      }
-    />
-  );
-});
+    return (
+      <FormBox
+        renderBottom={
+          <>
+            <Form onSubmit={authenticate}>
+              <Field
+                name="email"
+                type="email"
+                required
+                xl={12}
+                lg={12}
+              />
+              <Field
+                required
+                name="password"
+                type="password"
+                xl={12}
+                lg={12}
+              />
+            </Form>
+            <Box mt={2} mb={1}>
+              <Divider />
+            </Box>
+            <Grid container spacing={1}>
+              <MuiLink
+                component={Link}
+                to="/password-reset"
+              >
+                {t('labels:requestNewPassword')}
+              </MuiLink>
+              <MuiLink component={Link} to="/reverify">
+                {t('labels:reverifyLink')}
+              </MuiLink>
+            </Grid>
+          </>
+        }
+        renderTop={
+          <Typography variant="h1" gutterBottom>
+            {t('titles:login')}
+          </Typography>
+        }
+      />
+    );
+  }),
+);
+
+export default Login;

package/src/pages/password-change.jsx

@@ -8,6 +8,7 @@ import { Form, Field } from 'q3-ui-forms/lib/builders';
 import FormBoxContent from '../components/FormBoxContent';
 import FormBox from '../components/FormBox';
 import withSuccessOp from '../components/withSuccessOp';
+import withPublicTemplate from '../components/withPublicTemplate';
 
 const PasswordChange = ({ onSuccess, location }) => {
   const { passwordResetToken, email } = queryString.parse(
@@ -64,7 +65,8 @@ PasswordChange.propTypes = {
   }).isRequired,
 };
 
-export default withSuccessOp(
-  PasswordChange,
-  'passwordChangeNotice',
+const PasswordChangeWithTemplate = withPublicTemplate(
+  withSuccessOp(PasswordChange, 'passwordChangeNotice'),
 );
+
+export default PasswordChangeWithTemplate;

package/src/pages/password-reset.jsx

@@ -5,6 +5,7 @@ import { Form, Field } from 'q3-ui-forms/lib/builders';
 import FormBox from '../components/FormBox';
 import FormBoxContent from '../components/FormBoxContent';
 import withSuccessOp from '../components/withSuccessOp';
+import withPublicTemplate from '../components/withPublicTemplate';
 
 const PasswordReset = ({ onSuccess }) => (
   <FormBox
@@ -39,7 +40,8 @@ PasswordReset.propTypes = {
   onSuccess: PropTypes.func.isRequired,
 };
 
-export default withSuccessOp(
-  PasswordReset,
-  'passwordResetNotice',
+const PasswordResetWithTemplate = withPublicTemplate(
+  withSuccessOp(PasswordReset, 'passwordResetNotice'),
 );
+
+export default PasswordResetWithTemplate;

package/src/pages/reverify.jsx

@@ -9,6 +9,7 @@ import FormBox from '../components/FormBox';
 import FormBoxContent from '../components/FormBoxContent';
 import FormBoxNotice from '../components/FormBoxNotice';
 import { hasOp, toOp } from '../components/utils';
+import withPublicTemplate from '../components/withPublicTemplate';
 
 const Reverify = ({ location: { search, pathname } }) => {
   const { t } = useTranslation();
@@ -23,7 +24,7 @@ const Reverify = ({ location: { search, pathname } }) => {
           component={Link}
           to="/reverify"
           variant="contained"
-          color="primary"
+          color="secondary"
         >
           {t('labels:tryAgain')}
         </Button>
@@ -67,4 +68,5 @@ Reverify.propTypes = {
   }).isRequired,
 };
 
-export default Reverify;
+const ReverifyWithTemplate = withPublicTemplate(Reverify);
+export default ReverifyWithTemplate;

package/src/pages/verify.jsx

@@ -8,19 +8,14 @@ import { Form, Field } from 'q3-ui-forms/lib/builders';
 import FormBoxContent from '../components/FormBoxContent';
 import FormBox from '../components/FormBox';
 import withAuthenticate from '../components/withAuthenticate';
+import withPublicTemplate from '../components/withPublicTemplate';
 
-export default withAuthenticate(
-  ({ authenticate, ...props }) => {
-    const {
-      verificationCode,
-      id,
-      email,
-    } = queryString.parse(
-      get(props, 'location.search', ''),
-      {
+const Verify = withPublicTemplate(
+  withAuthenticate(({ authenticate, ...props }) => {
+    const { verificationCode, id, email } =
+      queryString.parse(get(props, 'location.search', ''), {
         decode: false,
-      },
-    );
+      });
 
     return (
       <FormBox
@@ -69,5 +64,7 @@ export default withAuthenticate(
         }
       />
     );
-  },
+  }),
 );
+
+export default Verify;

package/__tests__/config.int.test.js

@@ -1,73 +0,0 @@
-import { get } from 'lodash';
-import config from '../gatsby-config';
-
-const CANONICAL = 'gatsby-plugin-canonical-urls';
-const MANIFEST = 'gatsby-plugin-manifest';
-const ROBOTS = 'gatsby-plugin-robots-txt';
-
-const ENV = {
-  contentfulSpaceID: 1,
-  contentfulAccessToken: 1,
-};
-
-const containsResolver = (plugins = [], name) =>
-  plugins.find(
-    (p) => typeof p === 'object' && p.resolve === name,
-  );
-
-const checkPlugins = (args = {}, plugin) => {
-  const { plugins } = config({ ...ENV, ...args });
-  const statement = expect(
-    containsResolver(plugins, plugin),
-  );
-
-  return {
-    has: () => statement.not.toBeUndefined(),
-    hasNot: () => statement.toBeUndefined(),
-  };
-};
-
-describe('gatsby-config', () => {
-  describe('plugins', () => {
-    it('should error without contentful access token', () => {
-      process.env.URL =
-        'https://development.netlify.3merge.com';
-      expect(() =>
-        config({
-          contentfulSpaceID: '1',
-        }),
-      ).toThrowError();
-    });
-
-    it('should include conditional plugins', () =>
-      [CANONICAL, MANIFEST].forEach((name) =>
-        checkPlugins(
-          {
-            brandingColor: '#FFF',
-            title: 'Foo',
-            siteUrl: 'https://google.ca',
-          },
-          name,
-        ).has(),
-      ));
-
-    it('should exclude conditional plugins', () =>
-      [CANONICAL, MANIFEST].forEach((name) =>
-        checkPlugins({}, name).hasNot(),
-      ));
-
-    it.each([
-      ['https://dev.netlify.3merge.com', 'disallow'],
-      ['https://3merge.com', 'allow'],
-    ])('should disable indexing', (url, key) => {
-      process.env.URL = url;
-      const { plugins } = config({ ...ENV });
-      const res = containsResolver(plugins, ROBOTS);
-      const prod = get(
-        res,
-        'options.env.production.policy',
-      )[0];
-      expect(prod).toHaveProperty(key, '/');
-    });
-  });
-});

package/helpers/__tests__/loadContent.unit.test.js

@@ -1,13 +0,0 @@
-const path = require('path');
-const loadContent = require('../loadContent');
-
-describe('loadContent', () => {
-  it('should fetch all content from directory', () => {
-    const out = loadContent(
-      path.resolve(__dirname, '../../__fixtures__'),
-    );
-
-    expect(out).toHaveProperty('en');
-    expect(out).toHaveProperty('fr');
-  });
-});