@thegetty/quire-cli 0.20.3 → 0.20.4

package/bin/themes/default/tests/e2e/specs/quire-entry.spec.js

@@ -0,0 +1,104 @@
+describe("Quire Entry Template", () => {
+  beforeEach(() => {
+    cy.visit("/catalogue/1/");
+  });
+
+  it("will go to the next image", () => {
+    cy.get("#next-image").click();
+    cy.get(".first-image").should("not.be.visible");
+    cy.get(".current-image").should("be.visible");
+  });
+
+  it("will go to the previous image", () => {
+    cy.get("#prev-image").click();
+    cy.get(".first-image").should("not.be.visible");
+    cy.get(".last-image").should("be.visible");
+  });
+
+  it("will download the image", () => {
+    cy.get(".quire-image-control--download").then(anchor => {
+      let href = anchor.attr("href");
+      let url = new URL(href, window.location.origin).href;
+      cy.request(url).then(response => {
+        expect(response.status).to.eq(200);
+      });
+    });
+  });
+
+  /**
+   *
+   * This mostly works. However in some browsers for
+   * cypress, It will error with "Failed to execute
+   * 'requestFullscreen' on 'Element': API can only be initiated by
+   * a user gesture." This test passes becasue it does not
+   * detect that fullscreen API has been initialized, but
+   * it looks that the "fullscreen" class has been added to
+   * style the button.
+   * Issues on Github => https://github.com/cypress-io/cypress/issues/311,
+   * https://github.com/cypress-io/cypress/issues/1213
+   *
+   */
+  it("should fullscreen the image", () => {
+    cy.get("#toggleFullscreen").click();
+    cy.get("#toggleFullscreen").then(element => {
+      let c = element.attr("class");
+      expect(c.indexOf("fullscreen") !== -1).to.eq(true);
+    });
+  });
+
+  // Test Core Elements of Entry
+
+  it("will have a main heading element", () => {
+    cy.get(".quire-page__header__title").should("exist");
+    cy.get(".quire-page__header__title")
+      .invoke("text")
+      .then(text => {
+        expect(text.length > 0).to.eq(true);
+      });
+  });
+
+  it("will have a tombstone element", () => {
+    cy.get(".quire-entry__tombstone").should("exist");
+    cy.get(".quire-entry__tombstone")
+      .invoke("text")
+      .then(text => {
+        expect(text.length > 0).to.eq(true);
+      });
+  });
+
+  it("will have a caption for the entry figure", () => {
+    cy.get(
+      ".current-image div:nth-child(3) span:nth-child(1) span:nth-child(1)"
+    ).should("exist");
+    cy.get(
+      ".current-image div:nth-child(3) span:nth-child(1) span:nth-child(1)"
+    )
+      .invoke("text")
+      .then(text => {
+        expect(text.length > 0).to.eq(true);
+      });
+  });
+
+  it("will have core wrapper class 'quire__primary' with an id", () => {
+    cy.get(".quire__primary").then(element => {
+      cy.get(element).should("exist");
+      let id = element.attr("id");
+      expect(id.length > 0).to.eq(true);
+    });
+  });
+
+  it("will have a hero section with section element to display main heading", () => {
+    cy.get(".quire-entry__header")
+      .find(".quire-page__header__title")
+      .then(element => {
+        cy.get(element).should("exist");
+        let id = element.attr("id");
+        expect(id.length > 0).to.eq(true);
+        cy.get(element)
+          .invoke("text")
+          .then(text => {
+            expect(text.length > 0).to.eq(true);
+          });
+      });
+  });
+});

package/bin/themes/default/tests/e2e/specs/quire-essay.spec.js

@@ -0,0 +1,105 @@
+describe("Quire Essay Template", () => {
+  beforeEach(() => {
+    cy.visit("/essay/");
+  });
+
+  it("figure will have an id with deepzoom or map or iiif", () => {
+    cy.get(".q-figure__wrapper")
+      .find("figure.quire-figure")
+      .then(element => {
+        cy.get(element).should("exist");
+        let id = element.attr("id");
+        expect(
+          id.indexOf("deepzoom") !== -1 ||
+            id.indexOf("map") !== -1 ||
+            id.indexOf("iiif") !== -1
+        ).to.eq(true);
+      });
+  });
+
+  it("figure will have caption element with text", () => {
+    cy.get(".q-figure__wrapper")
+      .find(".quire-figure__caption")
+      .then(element => {
+        cy.get(element).should("exist");
+        cy.get(element)
+          .invoke("text")
+          .then(text => {
+            expect(text.length > 0).to.eq(true);
+          });
+      });
+  });
+
+  it("figure will have popup element with data-type of 'inline'", () => {
+    cy.get(".q-figure__wrapper")
+      .find(".popup")
+      .then(element => {
+        cy.get(element).should("exist");
+        let dataType = element.attr("data-type");
+        expect(dataType.indexOf("inline") !== -1).to.eq(true);
+      });
+  });
+
+  it("figure will have image element with class of 'quire-figure__image' that has a source attribute", () => {
+    cy.get(".q-figure__wrapper")
+      .find(".quire-figure__image")
+      .then(element => {
+        cy.get(element).should("exist");
+        let src = element.attr("src");
+        expect(src.length > 0).to.eq(true);
+      });
+  });
+
+  it("figure group will have a child of 'quire-figure--group__row'", () => {
+    cy.get("figure.quire-figure--group")
+      .find(".quire-figure--group__row")
+      .then(element => {
+        cy.get(element).should("exist");
+      });
+  });
+
+  it("'quire-figure--group__row' will have a child of 'quire-figure--group__item' and 2 groups of them for class 'quire-grid--2'", () => {
+    cy.get(".quire-figure--group__row")
+      .find(".quire-grid--2.quire-figure--group__item")
+      .then(element => {
+        cy.get(element).should("exist");
+        cy.get(element).should("have.length", 4);
+      });
+  });
+
+  it("will have core wrapper class 'quire__primary'", () => {
+    cy.get(".quire__primary").then(element => {
+      cy.get(element).should("exist");
+      let id = element.attr("id");
+      expect(id.length > 0).to.eq(true);
+    });
+  });
+
+  it("will have a hero section with section element to display main heading", () => {
+    cy.get(".quire-page__header")
+      .find(".quire-page__header__title")
+      .then(element => {
+        cy.get(element).should("exist");
+        let id = element.attr("id");
+        expect(id.length > 0).to.eq(true);
+        cy.get(element)
+          .invoke("text")
+          .then(text => {
+            expect(text.length > 0).to.eq(true);
+          });
+      });
+  });
+
+  it("will have a hero section with section element to display contributor or author info", () => {
+    cy.get(".quire-page__header")
+      .find(".quire-page__header__contributor")
+      .then(element => {
+        cy.get(element).should("exist");
+        cy.get(element)
+          .invoke("text")
+          .then(text => {
+            expect(text.length > 0).to.eq(true);
+          });
+      });
+  });
+});

package/bin/themes/default/tests/e2e/specs/quire-menu.spec.js

@@ -0,0 +1,38 @@
+describe("Quire Site Menu Core Elements and Functions", () => {
+  beforeEach(() => {
+    cy.visit("/");
+  });
+
+  it("toggles the side menu", () => {
+    cy.get("#site-menu").should("not.be.visible");
+    cy.get("#quire-controls-menu-button").click();
+    cy.get("#site-menu").should("be.visible");
+  });
+
+  it("should have a title", () => {
+    cy.get(".quire-menu__header__title").should("exist");
+  });
+
+  it("should have nav link list", () => {
+    cy.get("#site-menu").should("not.be.visible");
+    cy.get("#quire-controls-menu-button").click();
+    cy.get("#site-menu").should("be.visible");
+    cy.get("#nav ul li a").should("exist");
+    cy.get("#nav > ul:nth-child(2) > li:nth-child(1) > a:nth-child(1)")
+      .should("exist")
+      .click();
+  });
+
+  it("should have other formats", () => {
+    cy.get("div.quire-menu__formats:nth-child(3) h6").should("exist");
+    cy.get("div.quire-menu__formats:nth-child(3) ul li").should(
+      "have.length",
+      3
+    );
+  });
+
+  it("should have cite this page", () => {
+    cy.get("div.quire-menu__formats:nth-child(4) h6").should("exist");
+    cy.get("div.quire-menu__formats:nth-child(4) div").should("have.length", 2);
+  });
+});

package/bin/themes/default/tests/e2e/specs/quire-modal.spec.js

@@ -0,0 +1,69 @@
+describe("Quire Modal Image viewer Core Functions", () => {
+  beforeEach(() => {
+    cy.visit("/essay/");
+  });
+
+  // click 1st image and open modal viewer
+  it("open modal image viewer", () => {
+    cy.get(".mfp-content").should("not.be.visible");
+    cy.get(
+      "#content div div.content figure.quire-figure.is-pulled-center"
+    ).click();
+    cy.get(".mfp-content").should("be.visible");
+  });
+
+  // click 1st image and open modal viewer and go to next image
+  it("open modal image viewer and go to next image", async () => {
+    cy.get(".mfp-content").should("not.be.visible");
+    cy.get(
+      "#content div div.content figure.quire-figure.is-pulled-center"
+    ).click();
+    cy.get(".mfp-content").should("be.visible");
+    cy.get(".mfp-arrow-right").click();
+    cy.get(".quire-counter-container span").then(element => {
+      let title = element.attr("title");
+      expect(title.indexOf("2 of 8") !== -1).to.eq(true);
+    });
+  });
+
+  // click 1st image and open modal viewer and got to the previous image
+  it("open modal image viewer and go to previous image", async () => {
+    cy.get(".mfp-content").should("not.be.visible");
+    cy.get(
+      "#content div div.content figure.quire-figure.is-pulled-center"
+    ).click();
+    cy.get(".mfp-content").should("be.visible");
+    cy.get(".mfp-arrow-left").click();
+    cy.get(".quire-counter-container span").then(element => {
+      let title = element.attr("title");
+      expect(title.indexOf("8 of 8") !== -1).to.eq(true);
+    });
+  });
+
+  /**
+   *
+   * This mostly works. However in some browsers for
+   * cypress, it will warn with "Failed to execute
+   * 'requestFullscreen' on 'Element': API can only be initiated by
+   * a user gesture." This test passes becasue it does not
+   * detect that fullscreen API has been initialized, but
+   * it looks that the "fullscreen" class has been added to
+   * style the button.
+   * Issues on Github => https://github.com/cypress-io/cypress/issues/311,
+   * https://github.com/cypress-io/cypress/issues/1213
+   *
+   */
+  // click 1st image and open modal viewer and click full screen button
+  it("open modal image viewer and click full screen button", async () => {
+    cy.get(".mfp-content").should("not.be.visible");
+    cy.get(
+      "#content div div.content figure.quire-figure.is-pulled-center"
+    ).click();
+    cy.get(".mfp-content").should("be.visible");
+    cy.get("#toggleFullscreen").click();
+    cy.get("#toggleFullscreen").then(element => {
+      let c = element.attr("class");
+      expect(c.indexOf("fullscreen") !== -1).to.eq(true);
+    });
+  });
+});

package/bin/themes/default/tests/e2e/specs/quire-next-back-buttons.spec.js

@@ -0,0 +1,27 @@
+describe("Quire < Prev Next > Buttons", () => {
+  beforeEach(() => {
+    cy.visit("/contents/");
+  });
+
+  it("will have a 'quire-contents-buttons' with 2 buttons", () => {
+    cy.get(".quire-contents-buttons ul")
+      .find(".quire-nav-button a")
+      .then(anchor => {
+        cy.get(anchor).should("exist");
+        cy.get(anchor).should("have.length", 2);
+      });
+  });
+
+  it("Both buttons will link to pages that have a status code of 200", () => {
+    cy.get(".quire-contents-buttons ul")
+      .find(".quire-nav-button a")
+      .then(anchor => {
+        cy.get(anchor).should("exist");
+        let href = anchor.attr("href");
+        let url = new URL(href, window.location.origin).href;
+        cy.request(url).then(response => {
+          expect(response.status).to.eq(200);
+        });
+      });
+  });
+});

package/bin/themes/default/tests/e2e/specs/quire-page.spec.js

@@ -0,0 +1,28 @@
+describe("Quire Page Template", () => {
+  beforeEach(() => {
+    cy.visit("/contributors/");
+  });
+
+  it("will have core wrapper class 'quire__primary' with an id", () => {
+    cy.get(".quire__primary").then(element => {
+      cy.get(element).should("exist");
+      let id = element.attr("id");
+      expect(id.length > 0).to.eq(true);
+    });
+  });
+
+  it("will have a hero section with section element to display main heading", () => {
+    cy.get(".quire-page__header")
+      .find(".quire-page__header__title")
+      .then(element => {
+        cy.get(element).should("exist");
+        let id = element.attr("id");
+        expect(id.length > 0).to.eq(true);
+        cy.get(element)
+          .invoke("text")
+          .then(text => {
+            expect(text.length > 0).to.eq(true);
+          });
+      });
+  });
+});

package/bin/themes/default/tests/e2e/specs/quire-search.spec.js

@@ -0,0 +1,48 @@
+describe("Quire Site Search Core Functions", () => {
+  beforeEach(() => {
+    cy.visit("/");
+  });
+
+  it("should open search", () => {
+    cy.get("#js-search").should("not.be.visible");
+    cy.get(".search-button").click();
+    cy.get("#js-search").should("be.visible");
+  });
+
+  it("should perform a search", () => {
+    cy.get("#js-search").should("not.be.visible");
+    cy.get(".search-button").click();
+    cy.get("#js-search").should("be.visible");
+    cy.get("input[name=search]").type("Walker Evans");
+  });
+
+  it("should click a search link", () => {
+    cy.get("#js-search").should("not.be.visible");
+    cy.get(".search-button").click();
+    cy.get("#js-search").should("be.visible");
+    cy.get("input[name=search]").type("Walker Evans");
+    cy.get("li.quire-search__inner__list-item:nth-child(1) a:nth-child(1)")
+      .should("exist")
+      .click();
+  });
+
+  it("search.json data and element should exist", () => {
+    cy.get("#js-search").should("exist");
+    cy.get("#js-search").then(element => {
+      cy.get(element).should("exist");
+      let dataSearchindex = element.attr("data-search-index");
+      expect(dataSearchindex.length > 0).to.eq(true);
+    });
+  });
+
+  it("will check that search.json actually exists", () => {
+    cy.get("#js-search").should("exist");
+    cy.get("#js-search").then(element => {
+      let href = element.attr("data-search-index");
+      let url = new URL(href, window.location.origin).href;
+      cy.request(url).then(response => {
+        expect(response.status).to.eq(200);
+      });
+    });
+  });
+});

package/bin/themes/default/tests/e2e/specs/quire-splash.spec.js

@@ -0,0 +1,38 @@
+describe("Quire Splash Page Tempalte", () => {
+  beforeEach(() => {
+    cy.visit("/intro/");
+  });
+
+  it("figure will have popup element with data-type of 'inline'", () => {
+    cy.get(".q-figure__wrapper")
+      .find(".popup")
+      .then(element => {
+        cy.get(element).should("exist");
+        let dataType = element.attr("data-type");
+        expect(dataType.indexOf("inline") !== -1).to.eq(true);
+      });
+  });
+
+  it("will have core wrapper class 'quire__primary'", () => {
+    cy.get(".quire__primary").then(element => {
+      cy.get(element).should("exist");
+      let id = element.attr("id");
+      expect(id.length > 0).to.eq(true);
+    });
+  });
+
+  it("will have a hero section with section element to display main heading", () => {
+    cy.get(".quire-page__header")
+      .find(".quire-page__header__title")
+      .then(element => {
+        cy.get(element).should("exist");
+        let id = element.attr("id");
+        expect(id.length > 0).to.eq(true);
+        cy.get(element)
+          .invoke("text")
+          .then(text => {
+            expect(text.length > 0).to.eq(true);
+          });
+      });
+  });
+});

package/bin/themes/default/tests/e2e/support/commands.js

@@ -0,0 +1,25 @@
+// ***********************************************
+// This example commands.js shows you how to
+// create various custom commands and overwrite
+// existing commands.
+//
+// For more comprehensive examples of custom
+// commands please read more here:
+// https://on.cypress.io/custom-commands
+// ***********************************************
+//
+//
+// -- This is a parent command --
+// Cypress.Commands.add("login", (email, password) => { ... })
+//
+//
+// -- This is a child command --
+// Cypress.Commands.add("drag", { prevSubject: 'element'}, (subject, options) => { ... })
+//
+//
+// -- This is a dual command --
+// Cypress.Commands.add("dismiss", { prevSubject: 'optional'}, (subject, options) => { ... })
+//
+//
+// -- This is will overwrite an existing command --
+// Cypress.Commands.overwrite("visit", (originalFn, url, options) => { ... })

package/bin/themes/default/tests/e2e/support/index.js

@@ -0,0 +1,20 @@
+// ***********************************************************
+// This example support/index.js is processed and
+// loaded automatically before your test files.
+//
+// This is a great place to put global configuration and
+// behavior that modifies Cypress.
+//
+// You can change the location of this file or turn off
+// automatically serving support files with the
+// 'supportFile' configuration option.
+//
+// You can read more here:
+// https://on.cypress.io/configuration
+// ***********************************************************
+
+// Import commands.js using ES2015 syntax:
+import "./commands";
+
+// Alternatively you can use CommonJS syntax:
+// require('./commands')

package/bin/themes/default/theme.toml

@@ -0,0 +1,22 @@
+# theme.toml template for a Hugo theme
+# See https://github.com/spf13/hugoThemes#themetoml for an example
+
+name = "Quire Starter Theme"
+theme_version = "v0.18.0"
+license = ""
+licenselink = ""
+description = ""
+homepage = "https://github.com/gettypubs/quire-starter-theme/"
+tags = []
+features = []
+min_version = ""
+
+[author]
+  name = "J. Paul Getty Trust"
+  homepage = "http://www.getty.edu/"
+
+# If porting an existing theme
+[original]
+  name = ""
+  homepage = ""
+  repo = ""

package/bin/themes/default/tsconfig.json

@@ -0,0 +1,5 @@
+{
+    "compilerOptions": {
+        // "types": ["jest", "node"]
+    }
+}

package/bin/themes/default/webpack/webpack.config.dev.js

@@ -0,0 +1,128 @@
+// @ts-check
+
+const path = require("path");
+const webpack = require("webpack");
+const MiniCssExtractPlugin = require("mini-css-extract-plugin");
+const autoprefixer = require("autoprefixer");
+
+const PATHS = {
+  source: path.join(__dirname, "../source"),
+  build: path.join(__dirname, "../static")
+};
+
+module.exports = {
+  mode: "development",
+  watch: true,
+  watchOptions: {
+    aggregateTimeout: 300,
+    poll: 3000
+  },
+  entry: {
+    source: path.join(PATHS.source, "js", "application.js")
+  },
+  output: {
+    path: PATHS.build,
+    publicPath: "/",
+    filename: path.join("js", "application.js")
+  },
+  module: {
+    rules: [
+      {
+        test: /\.js$/,
+        exclude: /node_modules/,
+        use: {
+          loader: "babel-loader",
+          options: {
+            presets: ["@babel/preset-env"]
+          }
+        }
+      },
+      {
+        test: /\.scss$/,
+        exclude: [/node_modules/, path.join(PATHS.build, "css", "epub.scss")],
+        use: [
+          "style-loader",
+          MiniCssExtractPlugin.loader,
+          "css-loader",
+          {
+            loader: "postcss-loader",
+            options: {
+              autoprefixer: {
+                browsers: ["last 3 versions"]
+              },
+              plugins: () => [autoprefixer]
+            }
+          },
+          "sass-loader"
+        ]
+      },
+      {
+        test: /\.css$/,
+        use: [
+          "style-loader",
+          MiniCssExtractPlugin.loader,
+          "css-loader",
+          {
+            loader: "postcss-loader",
+            options: {
+              autoprefixer: {
+                browsers: ["last 3 versions"]
+              },
+              plugins: () => [autoprefixer]
+            }
+          },
+          "sass-loader"
+        ]
+      },
+      {
+        test: /\.(woff|woff2|eot|ttf|otf)$/,
+        use: [
+          {
+            loader: "file-loader",
+            options: {
+              name: "[name].[ext]",
+              outputPath: "fonts/"
+            }
+          }
+        ]
+      },
+      {
+        test: /\.(jpg|png|gif|svg)$/,
+        use: [
+          {
+            loader: "file-loader",
+            options: {
+              name: "[name].[ext]",
+              outputPath: "img/"
+            }
+          }
+        ]
+      }
+    ]
+  },
+  optimization: {
+    runtimeChunk: false,
+    splitChunks: {
+      cacheGroups: {
+        default: false,
+        commons: {
+          test: /[\\/]node_modules[\\/]/,
+          name: "vendor_app",
+          chunks: "all",
+          minChunks: 2
+        }
+      }
+    }
+  },
+  plugins: [
+    new MiniCssExtractPlugin({
+      filename: "css/application.css",
+      chunkFilename: "css/[id].css"
+    }),
+    new webpack.ProvidePlugin({
+      $: "jquery",
+      jQuery: "jquery",
+      "window.jQuery": "jquery"
+    })
+  ]
+};