Merge pull request #630 from citation-file-format/619-message-type-fields

Update message field based on type

Author: fdiblen

src/components/ScreenStart.vue

@@ -12,6 +12,16 @@
         </div>
 
         <div id="form-content">
+            <h2 class="question">
+                What type of work does this CITATION.cff describe?
+                <SchemaGuideLink anchor="#type" />
+            </h2>
+            <q-option-group
+                type="radio"
+                v-bind:model-value="type"
+                v-bind:options="typeOptions"
+                v-on:update:modelValue="[setType, setMessagePlaceHolder]"
+            />
             <h2 class="question">
                 What is the title of the work?
                 <SchemaGuideLink anchor="#title" />
@@ -35,46 +45,14 @@
                 bg-color="white"
                 label="message"
                 outlined
+                standout
                 v-bind:class="[messageErrors.length > 0 ? 'has-error' : '']"
                 v-bind:model-value="message"
                 v-bind:error="messageErrors.length > 0"
                 v-bind:error-message="messageErrors.join(', ')"
-                v-on:new-value="setMessage"
                 v-on:update:modelValue="setMessage"
-            >
-                <template v-slot:append>
-                    <q-btn-dropdown
-                        class="dropdown"
-                        flat
-                    >
-                        <q-list>
-                            <q-item
-                                clickable
-                                v-bind:key="messageOption"
-                                v-close-popup
-                                v-for="messageOption in messageOptions"
-                                v-on:click="setMessage(messageOption)"
-                            >
-                                <q-item-section>
-                                    <q-item-label>{{ messageOption }}</q-item-label>
-                                </q-item-section>
-                            </q-item>
-                        </q-list>
-                    </q-btn-dropdown>
-                </template>
-            </q-input>
-            <h2 class="question">
-                What type of work does this CITATION.cff describe?
-                <SchemaGuideLink anchor="#type" />
-            </h2>
-            <q-option-group
-                type="radio"
-                v-bind:model-value="type"
-                v-bind:options="typeOptions"
-                v-on:update:modelValue="setType"
             />
         </div>
-
         <div id="form-button-bar">
             <StepperActions />
         </div>
@@ -105,14 +83,6 @@ export default defineComponent({
         })
         const { message, title, type, setMessage, setTitle, setType } = useCff()
         const { errors } = useValidation()
-        const messageOptions = [
-            'If you use this software, please cite it using the metadata from this file.',
-            'Please cite this software using these metadata.',
-            'Please cite this software using the metadata from \'preferred-citation\'.',
-            'If you use this dataset, please cite it using the metadata from this file.',
-            'Please cite this dataset using these metadata.',
-            'Please cite this dataset using the metadata from \'preferred-citation\'.'
-        ]
         const messageErrors = computed(() => {
             return messageQueries
                 .filter(byError(errors.value))
@@ -123,10 +93,17 @@ export default defineComponent({
                 .filter(byError(errors.value))
                 .map(query => query.replace.message)
         })
+        const setMessagePlaceHolder = () => {
+            const messagePlaceHolderRegex = /(software|dataset)/igm
+            const matches = messagePlaceHolderRegex.exec(message.value)
+            if (matches) {
+                // search and replace all occurrences
+                setMessage(message.value.split(matches[0]).join(type.value))
+            }
+        }
         return {
             message,
             messageErrors,
-            messageOptions,
             title,
             titleErrors,
             type,
@@ -135,6 +112,7 @@ export default defineComponent({
                 { label: 'Dataset', value: 'dataset' }
             ],
             setMessage,
+            setMessagePlaceHolder,
             setTitle,
             setType
         }

src/store/cff.ts

@@ -11,7 +11,7 @@ const getInitialData = () => {
         identifiers: undefined,
         keywords: undefined,
         license: undefined,
-        message: '',
+        message: 'If you use this software, please cite it using the metadata from this file.',
         repository: undefined,
         repositoryArtifact: undefined,
         repositoryCode: undefined,

test/jest/__tests__/store/cffstr.jest.spec.ts

@@ -12,7 +12,7 @@ describe('useCffstr', () => {
     })
     describe('initial content', () => {
         it('should only have fields with defaults', () => {
-            const expected = generatedBy + "cff-version: 1.2.0\ntitle: ''\nmessage: ''\ntype: software\nauthors: []\n"
+            const expected = generatedBy + "cff-version: 1.2.0\ntitle: ''\nmessage: >-\n  If you use this software, please cite it using the\n  metadata from this file.\ntype: software\nauthors: []\n"
             expect(cffstr.value).toEqual(expected)
         })
     })
@@ -23,7 +23,7 @@ describe('useCffstr', () => {
         })
 
         it('should have title', () => {
-            const expected = generatedBy + "cff-version: 1.2.0\ntitle: sometitle\nmessage: ''\ntype: software\nauthors: []\n"
+            const expected = generatedBy + "cff-version: 1.2.0\ntitle: sometitle\nmessage: >-\n  If you use this software, please cite it using the\n  metadata from this file.\ntype: software\nauthors: []\n"
             expect(cffstr.value).toEqual(expected)
         })
     })
@@ -34,7 +34,7 @@ describe('useCffstr', () => {
         })
 
         it('should have a keyword', () => {
-            const expected = generatedBy + "cff-version: 1.2.0\ntitle: ''\nmessage: ''\ntype: software\nauthors: []\nkeywords:\n  - keyword1\n"
+            const expected = generatedBy + "cff-version: 1.2.0\ntitle: ''\nmessage: >-\n  If you use this software, please cite it using the\n  metadata from this file.\ntype: software\nauthors: []\nkeywords:\n  - keyword1\n"
             expect(cffstr.value).toEqual(expected)
         })
     })
@@ -45,7 +45,7 @@ describe('useCffstr', () => {
         })
 
         it('should have a identifier', () => {
-            const expected = generatedBy + "cff-version: 1.2.0\ntitle: ''\nmessage: ''\ntype: software\nauthors: []\nidentifiers:\n  - type: doi\n    value: 10.5281/zenodo.5171937\n"
+            const expected = generatedBy + "cff-version: 1.2.0\ntitle: ''\nmessage: >-\n  If you use this software, please cite it using the\n  metadata from this file.\ntype: software\nauthors: []\nidentifiers:\n  - type: doi\n    value: 10.5281/zenodo.5171937\n"
             expect(cffstr.value).toEqual(expected)
         })
     })