Merge pull request #827 from citation-file-format/825-extra-cff-fields

abelsiqueira · web-flow · commit 1418dd68da14 · 2023-01-03T16:59:54.000+01:00
diff --git a/cypress/e2e/errors.cy.ts b/cypress/e2e/errors.cy.ts
@@ -267,4 +267,95 @@ describe('From a fixed app', () => {
             .should('not.have.class', 'q-field--error')
         cy.checkThatAppValidityIs(true)
     })
+
+    it('should validate screen Extra CFF Fields', () => {
+        cy.visit('/extra-cff-fields')
+        // no errors initially
+        cy.checkThatAppValidityIs(true)
+
+        // YAML errors
+        cy.dataCy('input-extra-cff-fields')
+            .type('a: -')
+        cy.checkThatAppValidityIs(false)
+        cy.dataCy('list-raw-errors')
+            .children()
+            .should('have.length', 1)
+        cy.dataCy('item-raw-error-keyword-0')
+            .should('contain.text', 'keyword: "Extra CFF Fields error"')
+        cy.dataCy('item-raw-error-message-0')
+            .should('contain.text', 'YAML Error: end of the stream')
+
+        // wrong field
+        cy.dataCy('input-extra-cff-fields')
+            .clear()
+            .type('bad: field')
+        cy.checkThatAppValidityIs(false)
+        cy.dataCy('list-raw-errors')
+            .children()
+            .should('have.length', 1)
+        cy.dataCy('item-raw-error-keyword-0')
+            .should('contain.text', 'additionalProperties')
+        cy.dataCy('item-raw-error-message-0')
+            .should('contain.text', 'must NOT have additional properties')
+
+        // preferred-citation
+        cy.dataCy('input-extra-cff-fields')
+            .clear()
+            .type('preferred-citation:')
+        cy.checkThatAppValidityIs(false)
+        cy.dataCy('list-raw-errors')
+            .children()
+            .should('have.length', 1)
+        cy.dataCy('item-raw-error-instancePath-0')
+            .should('contain.text', '/preferred-citation')
+        cy.dataCy('item-raw-error-message-0')
+            .should('contain.text', 'must be object')
+
+        cy.dataCy('input-extra-cff-fields')
+            .type('\n  title: The Paper')
+        cy.dataCy('list-raw-errors')
+            .children()
+            .should('have.length', 2)
+        cy.dataCy('item-raw-error-instancePath-0')
+            .should('contain.text', '/preferred-citation')
+        cy.dataCy('item-raw-error-instancePath-1')
+            .should('contain.text', '/preferred-citation')
+        cy.dataCy('item-raw-error-message-0')
+            .should('contain.text', "must have required property 'authors'")
+        cy.dataCy('item-raw-error-message-1')
+            .should('contain.text', "must have required property 'type'")
+
+        cy.dataCy('input-extra-cff-fields')
+            .type('\n  type: article\n  authors:')
+        cy.dataCy('list-raw-errors')
+            .children()
+            .should('have.length', 1)
+        cy.dataCy('item-raw-error-instancePath-0')
+            .should('contain.text', '/preferred-citation/authors')
+        cy.dataCy('item-raw-error-message-0')
+            .should('contain.text', 'must be array')
+
+        cy.dataCy('input-extra-cff-fields')
+            .type(' [{}]')
+        cy.checkThatAppValidityIs(true)
+
+        // Duplicate fields
+        cy.dataCy('input-extra-cff-fields')
+            .clear()
+            .type('title: Another title\n')
+        cy.dataCy('list-raw-errors')
+            .children()
+            .should('have.length', 1)
+        cy.dataCy('item-raw-error-keyword-0')
+            .should('contain.text', 'keyword: "Extra CFF Fields error"')
+        cy.dataCy('item-raw-error-message-0')
+            .should('contain.text', "Duplicate keys: 'title'")
+        cy.dataCy('input-extra-cff-fields')
+            .type('message: Another message')
+        cy.dataCy('list-raw-errors')
+            .children()
+            .should('have.length', 1)
+        cy.dataCy('item-raw-error-message-0')
+            .should('contain.text', "Duplicate keys: 'title', 'message'")
+    })
 })
diff --git a/cypress/e2e/navigation.cy.ts b/cypress/e2e/navigation.cy.ts
@@ -8,7 +8,8 @@ const stepNames = [
     'abstract',
     'keywords',
     'license',
-    'version-specific'
+    'version-specific',
+    'extra-cff-fields'
 ] as Array<StepNameType>
 
 describe('App navigation', () => {
diff --git a/cypress/e2e/spec.cy.ts b/cypress/e2e/spec.cy.ts
@@ -36,7 +36,12 @@ const fullValidCff = {
     license: 'Apache-2.0',
     commit: '123',
     version: 'v1.2.3',
-    'date-released': '2022-01-01'
+    'date-released': '2022-01-01',
+    'preferred-citation': {
+        authors: [{ 'given-names': 'Some', 'family-names': 'Body' }],
+        title: 'The Paper',
+        type: 'article'
+    }
 }
 
 describe('Basic usage', () => {
@@ -225,6 +230,13 @@ describe('Basic usage', () => {
         cy.dataCy('btn-next')
             .click()
 
+        // Extra CFF fields screen
+        cy.url().should('include', '/extra-cff-fields')
+        cy.dataCy('input-extra-cff-fields')
+            .type('preferred-citation:\n  authors:\n  - given-names: Some\n    family-names: Body\n  title: The Paper\n  type: article')
+        cy.dataCy('btn-next')
+            .click()
+
         // Finish screen
         cy.url().should('include', '/finish')
         cy.dataCy('btn-download')
diff --git a/src/components/RawErrorList.vue b/src/components/RawErrorList.vue
@@ -0,0 +1,61 @@
+<template>
+    <h2 v-if="errors.length > 0">
+        Error list
+    </h2>
+    <q-list
+        data-cy="list-raw-errors"
+        dense
+        separator
+    >
+        <q-item
+            v-for="(error, errorIndex) in errors"
+            v-bind:key="errorIndex"
+        >
+            <q-item-section
+                side
+                top
+            >
+                <q-icon
+                    name="warning"
+                    color="red"
+                    size="24px"
+                />
+            </q-item-section>
+            <q-item-section>
+                <q-item-label
+                    v-if="error.instancePath !== ''"
+                    v-bind:data-cy="`item-raw-error-instancePath-${errorIndex}`"
+                >
+                    instancePath: "{{ error.instancePath }}"
+                </q-item-label>
+                <q-item-label
+                    v-if="error.schemaPath !== ''"
+                    v-bind:data-cy="`item-raw-error-schemaPath-${errorIndex}`"
+                >
+                    schemaPath: "{{ error.schemaPath }}"
+                </q-item-label>
+                <q-item-label v-bind:data-cy="`item-raw-error-keyword-${errorIndex}`">
+                    keyword: "{{ error.keyword }}"
+                </q-item-label>
+                <q-item-label v-bind:data-cy="`item-raw-error-message-${errorIndex}`">
+                    message: "{{ error.message }}"
+                </q-item-label>
+            </q-item-section>
+        </q-item>
+    </q-list>
+</template>
+
+<script lang="ts">
+import { defineComponent } from 'vue'
+import { useValidation } from 'src/store/validation'
+
+export default defineComponent({
+    name: 'RawErrorList',
+    setup () {
+        const { errors } = useValidation()
+        return {
+            errors
+        }
+    }
+})
+</script>
diff --git a/src/components/ScreenExtraCffFields.vue b/src/components/ScreenExtraCffFields.vue
@@ -0,0 +1,45 @@
+<template>
+    <h1
+        id="form-title"
+        tabindex="-1"
+    >
+        Extra CFF Fields
+    </h1>
+    <p>
+        The CFF schema supports more fields than this form implements, for instance <code>preferred-citation</code>, or <code>references</code>.
+        These extra fields can be pasted directly here.
+        They will be validated, but the error messages will <strong>not</strong> be parsed, so they may not be helpful.
+    </p>
+
+    <q-input
+        autogrow
+        data-cy="input-extra-cff-fields"
+        input-style="min-height: 100px; max-height: 444px"
+        label="Extra CFF fields"
+        outlined
+        standout
+        type="textarea"
+        v-bind:model-value="extraCffFields"
+        v-on:update:modelValue="setExtraCffFields"
+    />
+
+    <RawErrorList />
+</template>
+
+<script lang="ts">
+import RawErrorList from 'src/components/RawErrorList.vue'
+import { defineComponent } from 'vue'
+import { useCff } from 'src/store/cff'
+
+export default defineComponent({
+    name: 'ScreenCffFields',
+    setup () {
+        const { extraCffFields, setExtraCffFields } = useCff()
+        return {
+            extraCffFields,
+            setExtraCffFields
+        }
+    },
+    components: { RawErrorList }
+})
+</script>
diff --git a/src/error-filtering.ts b/src/error-filtering.ts
@@ -335,13 +335,6 @@ export const screenRelatedResourcesQueries: ErrorQuery[] = [{
 }]
 
 export const screenStartQueries: ErrorQuery[] = [{
-    find: {
-        instancePath: ''
-    },
-    replace: {
-        message: 'Screen Start has errors'
-    }
-}, {
     find: {
         instancePath: '/title'
     },
diff --git a/src/router/routes.ts b/src/router/routes.ts
@@ -49,6 +49,11 @@ const routes: RouteRecordRaw[] = [
         component: () => import('src/components/LayoutStepper.vue'),
         children: [{ path: '', component: () => import('src/components/ScreenVersionSpecific.vue') }]
     },
+    {
+        path: '/extra-cff-fields',
+        component: () => import('src/components/LayoutStepper.vue'),
+        children: [{ path: '', component: () => import('src/components/ScreenExtraCffFields.vue') }]
+    },
     {
         path: '/finish',
         component: () => import('src/components/LayoutStepper.vue'),
diff --git a/src/store/app.ts b/src/store/app.ts
@@ -2,7 +2,7 @@ import { computed, ref } from 'vue'
 import { useRouter } from 'vue-router'
 
 export type StepNameType = 'start' | 'authors' | 'identifiers' | 'related-resources' |
-                    'abstract' | 'keywords' | 'license' | 'version-specific' | 'finish'
+                    'abstract' | 'keywords' | 'license' | 'version-specific' | 'extra-cff-fields' | 'finish'
 
 const stepNames = [
     'start',
@@ -13,6 +13,7 @@ const stepNames = [
     'keywords',
     'license',
     'version-specific',
+    'extra-cff-fields',
     'finish'
 ] as Array<StepNameType>
 
diff --git a/src/store/cff.ts b/src/store/cff.ts
@@ -23,6 +23,7 @@ const getInitialData = () => {
 }
 
 const cff = ref(getInitialData())
+const extraCffFields = ref('')
 
 export const useCff = () => {
     return {
@@ -31,6 +32,7 @@ export const useCff = () => {
         commit: computed(() => cff.value.commit),
         cffVersion: computed(() => cff.value.cffVersion),
         dateReleased: computed(() => cff.value.dateReleased),
+        extraCffFields: computed(() => extraCffFields.value),
         identifiers: computed(() => cff.value.identifiers),
         keywords: computed(() => cff.value.keywords),
         license: computed(() => cff.value.license),
@@ -46,6 +48,7 @@ export const useCff = () => {
         setAuthors: (newAuthors: AuthorsType) => { cff.value.authors = newAuthors },
         setCommit: (newCommit: string) => { cff.value.commit = newCommit === '' ? undefined : newCommit },
         setDateReleased: (newDateReleased: string) => { cff.value.dateReleased = newDateReleased === '' ? undefined : newDateReleased },
+        setExtraCffFields: (newExtraCffFields: string) => { extraCffFields.value = newExtraCffFields },
         setIdentifiers: (newIdentifiers: IdentifiersType) => { cff.value.identifiers = newIdentifiers === [] ? undefined : newIdentifiers },
         setKeywords: (newKeywords: KeywordsType) => { cff.value.keywords = newKeywords === [] ? undefined : newKeywords },
         setLicense: (newLicense: string) => { cff.value.license = newLicense === '' ? undefined : newLicense },
@@ -59,6 +62,7 @@ export const useCff = () => {
         setVersion: (newVersion: string) => { cff.value.version = newVersion === '' ? undefined : newVersion },
         reset: () => {
             cff.value = getInitialData()
+            extraCffFields.value = ''
         }
     }
 }
diff --git a/src/store/cffstr.ts b/src/store/cffstr.ts
@@ -26,7 +26,8 @@ export const useCffstr = () => {
         title,
         type,
         url,
-        version
+        version,
+        extraCffFields
     } = useCff()
 
     const notEmpty = (value: unknown, prop: unknown, subject: unknown) => {
@@ -59,9 +60,9 @@ export const useCffstr = () => {
 
     const makeCffstr = () => {
         const kebabed = makeJavascriptObject()
-        const yamlString = yaml.dump(kebabed, { indent: 2, lineWidth: 53 })
+        const yamlString = yaml.dump(kebabed, { indent: 2, lineWidth: 60 })
         const generatedBy = '# This CITATION.cff file was generated with cffinit.\n# Visit https://bit.ly/cffinit to generate yours today!\n\n'
-        return generatedBy + yamlString
+        return generatedBy + yamlString + extraCffFields.value
     }
     return {
         jsObject: computed(makeJavascriptObject),
diff --git a/src/store/stepper-errors.ts b/src/store/stepper-errors.ts
@@ -54,5 +54,6 @@ export const errorPerStep = {
     keywords: errorStateScreenKeywords,
     license: computed(() => false),
     'version-specific': errorStateScreenVersionSpecific,
+    'extra-cff-fields': computed(() => errors.value.length > 0),
     finish: computed(() => false)
 }
diff --git a/src/store/validation.ts b/src/store/validation.ts
diff --git a/test/jest/__tests__/store/app.jest.spec.ts b/test/jest/__tests__/store/app.jest.spec.ts
diff --git a/test/jest/__tests__/store/validation.jest.spec.ts b/test/jest/__tests__/store/validation.jest.spec.ts

Original file line number	Diff line number	Diff line change
`@@ -54,5 +54,6 @@ export const errorPerStep = {`
`54`	`54`	`keywords: errorStateScreenKeywords,`
`55`	`55`	`license: computed(() => false),`
`56`	`56`	`'version-specific': errorStateScreenVersionSpecific,`
	`57`	`+ 'extra-cff-fields': computed(() => errors.value.length > 0),`
`57`	`58`	`finish: computed(() => false)`
`58`	`59`	`}`