Merge pull request #639 from CenterForOpenScience/release/carbon

Carbon! AKA Remainder of the Registries overview page

Author: jamescdavis

CHANGELOG.md

@@ -5,6 +5,29 @@ The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/)
 and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.html).
 
 ## [Unreleased]
+### Added
+- Features:
+    - Registries overview navigation menu (#600)
+    - Editable registration institutions (#617)
+    - Display registration wiki count (#625)
+    - Add `citation_doi` to `<meta>` tags (#628)
+- Components:
+    - `citation-viewer` - displays citations for a node (#608)
+- Data:
+    - `Node.bibliographicContributors` relationship (#604)
+    - `OsfModel.sparseHasMany`, `sparseLoadAll` (#614)
+- Utils:
+    - Sparse fieldset utils (#614)
+
+### Changed
+- Components:
+    - `contributor-list` - display only bibliographic contributors (#604)
+
+### Fixed
+- Registries discover page - recognize links to registrations on test.osf.io (#597)
+- Registration form rendering errors (#620)
+- Allow withdrawing registrations without justification (#622)
+- Position tooltips and footer correctly (#624, #626)
 
 ## [19.3.0]
 ### Added

app/adapters/citation-style.ts

@@ -0,0 +1,13 @@
+import OsfAdapter from './osf-adapter';
+
+export default class CitationStyleAdapter extends OsfAdapter {
+    pathForType(_: string): string {
+        return 'citations/styles';
+    }
+}
+
+declare module 'ember-data/types/registries/adapter' {
+    export default interface AdapterRegistry {
+        'citation-style': CitationStyleAdapter;
+    } // eslint-disable-line semi
+}

app/application/styles.scss

@@ -1,5 +1,5 @@
 .Application {
-    height: 100%;
+    min-height: 100vh;
     display: flex;
     flex-direction: column;
 }

app/dashboard/controller.ts

@@ -75,7 +75,7 @@ export default class Dashboard extends Controller {
         const user: User = yield this.currentUser.user;
 
         const nodes: QueryHasManyResult<Node> = yield user.queryHasMany('nodes', {
-            embed: ['contributors', 'parent', 'root'],
+            embed: ['bibliographic_contributors', 'parent', 'root'],
             // eslint-disable-next-line ember/no-global-jquery
             filter: this.filter ? { title: $('<div>').text(this.filter).html() } : undefined,
             page: more ? this.incrementProperty('page') : this.set('page', 1),
@@ -96,7 +96,7 @@ export default class Dashboard extends Controller {
         try {
             const node: Node = yield this.store.findRecord('node', id);
             const linkedNodes: QueryHasManyResult<Node> = yield node.queryHasMany('linkedNodes', {
-                embed: 'contributors',
+                embed: 'bibliographic_contributors',
                 page: { size: 5 },
             });
             this.set(dest, linkedNodes);

app/guid-node/forks/controller.ts

@@ -25,7 +25,7 @@ export default class GuidNodeForks extends Controller {
 
     reloadList?: (page?: number) => void; // bound by paginated-list
 
-    forksQueryParams = { embed: 'contributors' };
+    forksQueryParams = { embed: 'bibliographic_contributors' };
 
     @reads('model.taskInstance.value')
     node?: Node;

app/guid-registration/forks/controller.ts

@@ -25,7 +25,7 @@ export default class GuidRegistrationForks extends Controller {
 
     reloadList?: (page?: number) => void;
 
-    forksQueryParams = { embed: 'contributors' };
+    forksQueryParams = { embed: 'bibliographic_contributors' };
 
     @reads('model.taskInstance.value')
     node?: Registration;

app/locales/en/translations.ts

@@ -94,6 +94,7 @@ export default {
         required: 'Required',
         options: 'Options',
         optional: 'Optional',
+        optional_paren: '(optional)',
         services: {
             collections: 'Collections',
             institutions: 'Institutions',
@@ -1077,10 +1078,15 @@ export default {
             citation: 'Citation',
         },
 
+        form_view: {
+            none_selected: 'None selected',
+        },
+
         overview: {
             title: 'Overview',
             collapse: 'Collapse',
             expand: 'Expand',
+            contents: 'Contents',
             see_more: 'See more',
             metadata: 'Metadata',
             component_of: 'This is a component of a registration:',
@@ -1136,7 +1142,7 @@ export default {
             },
 
             form_view: {
-                no_files: 'No files uploaded',
+                no_files: 'No files selected',
             },
 
             withdrawn: {
@@ -1348,6 +1354,16 @@ export default {
             add_institution_error: 'Error adding institution',
             remove_institution_error: 'Error removing institution',
             no_affiliations: 'No affiliations to add',
+            no_affiliated_institution: {
+                user: 'You have no institutional affiliations',
+                project: 'This project has no affiliated institutions',
+                registration: 'This registration has no affiliated institutions',
+            },
+        },
+        'citation-viewer': {
+            get_more: 'Get more citations',
+            placeholder: 'Enter citation style (e.g. "APA")',
+            type_to_search: 'Start typing to search citation styles',
         },
     },
     settings: {

app/models/citation-style.ts

@@ -0,0 +1,16 @@
+import { attr } from '@ember-decorators/data';
+
+import OsfModel from './osf-model';
+
+export default class CitationStyleModel extends OsfModel {
+    @attr('fixstring') title?: string;
+    @attr('fixstring') shortTitle?: string;
+    @attr('fixstring') summary?: string;
+    @attr('date') dateParsed?: string;
+}
+
+declare module 'ember-data/types/registries/model' {
+    export default interface ModelRegistry {
+        'citation-style': CitationStyleModel;
+    } // eslint-disable-line semi
+}

app/models/node.ts

@@ -94,6 +94,9 @@ export default class NodeModel extends BaseFileItem.extend(Validations, Collecta
     @hasMany('contributor', { inverse: 'node' })
     contributors!: DS.PromiseManyArray<ContributorModel>;
 
+    @hasMany('contributor', { inverse: null })
+    bibliographicContributors!: DS.PromiseManyArray<ContributorModel>;
+
     @belongsTo('node', { inverse: 'children' })
     parent!: DS.PromiseObject<NodeModel> & NodeModel;
 

app/models/osf-model.ts

@@ -15,7 +15,12 @@ import CurrentUser from 'ember-osf-web/services/current-user';
 import getHref from 'ember-osf-web/utils/get-href';
 import getRelatedHref from 'ember-osf-web/utils/get-related-href';
 import getSelfHref from 'ember-osf-web/utils/get-self-href';
-import pathJoin from 'ember-osf-web/utils/path-join';
+import {
+    buildFieldsParam,
+    parseSparseResource,
+    SparseFieldset,
+    SparseModel,
+} from 'ember-osf-web/utils/sparse-fieldsets';
 
 import {
     BaseMeta,
@@ -41,6 +46,17 @@ export interface QueryHasManyResult<T> extends Array<T> {
     links?: Links | PaginationLinks;
 }
 
+export interface RequestOptions {
+    queryParams?: object;
+    ajaxOptions?: object;
+}
+
+export interface SparseHasManyResult {
+    sparseModels: SparseModel[];
+    meta: PaginatedMeta;
+    links?: Links | PaginationLinks;
+}
+
 export interface PaginatedQueryOptions {
     'page[size]': number;
     page: number;
@@ -70,6 +86,21 @@ export default class OsfModel extends Model {
         return pluralize(underscore(this.modelName));
     }
 
+    getHasManyLink<T extends OsfModel, R extends RelationshipsFor<T>>(
+        this: T,
+        relationshipName: R,
+    ): string {
+        const reference = this.hasMany(relationshipName);
+
+        // HACK: ember-data discards/ignores the link if an object on the belongsTo side
+        // came first. In that case, grab the link where we expect it from OSF's API
+        const url = reference.link() || getRelatedHref(this.relationshipLinks[relationshipName]);
+        if (!url) {
+            throw new Error(`Could not find a link for '${relationshipName}' relationship`);
+        }
+        return url;
+    }
+
     /*
      * Query a hasMany relationship with query params
      *
@@ -89,18 +120,8 @@ export default class OsfModel extends Model {
         queryParams?: object,
         ajaxOptions?: object,
     ): Promise<QueryHasManyResult<RT>> {
-        const reference = this.hasMany(propertyName);
-
-        // HACK: ember-data discards/ignores the link if an object on the belongsTo side
-        // came first. In that case, grab the link where we expect it from OSF's API
-        const url = reference.link() || getRelatedHref(this.relationshipLinks[propertyName]);
-
-        if (!url) {
-            throw new Error(`Could not find a link for '${propertyName}' relationship`);
-        }
-
         const options: object = {
-            url,
+            url: this.getHasManyLink(propertyName),
             data: queryParams,
             ...ajaxOptions,
         };
@@ -186,20 +207,15 @@ export default class OsfModel extends Model {
         relatedModel: OsfModel,
     ) {
         const apiRelationshipName = underscore(relationshipName);
-        let url = getSelfHref(this.relationshipLinks[apiRelationshipName]);
+        const url = getSelfHref(this.relationshipLinks[apiRelationshipName]);
 
-        let data = JSON.stringify({
+        const data = JSON.stringify({
             data: [{
                 id: relatedModel.id,
                 type: relatedModel.apiType,
             }],
         });
 
-        if (url && action === 'delete') {
-            data = '';
-            url = pathJoin(url, relatedModel.id);
-        }
-
         if (!url) {
             throw new Error(`Couldn't find self link for ${apiRelationshipName} relationship`);
         }
@@ -271,4 +287,86 @@ export default class OsfModel extends Model {
             throw new Error(`Unexpected response ${errorContext}`);
         }
     }
+
+    /**
+     * Fetch one page of a has-many relationship using sparse fieldsets.
+     * See https://developer.osf.io/#tag/Sparse-Fieldsets
+     *
+     * The API response includes only the specified fields.
+     * This is useful for potentially long lists that require rendering only a few fields.
+     *
+     * Does NOT use ember-data. This means a few things:
+     * - Attributes don't pass through the transforms (e.g. 'fixstring') set with `DS.attr`, they remain as
+     *   represented in JSON. In particular, date fields are not deserialized to `Date` objects.
+     * - Sparse models aren't put in the store. This means no potential interactions with code that does use
+     *   the store, but if you want caching you'll have to do it yourself.
+     *
+     * Example:
+     * ```ts
+     * const contributors = await node.sparseHasMany(
+     *     'contributors',
+     *     { contributor: ['users'], user: ['fullName'] },
+     *     { queryParams: { 'page[size]': 100 } },
+     * });
+     *
+     * contributors.sparseModels.forEach(contrib => {
+     *     console.log(contrib.users.fullName);
+     * );
+     * ```
+     */
+    async sparseHasMany<T extends OsfModel>(
+        this: T,
+        relationshipName: RelationshipsFor<T>,
+        fieldset: SparseFieldset,
+        options: RequestOptions = {},
+    ): Promise<SparseHasManyResult> {
+        const response: ResourceCollectionDocument = await this.currentUser.authenticatedAJAX({
+            url: this.getHasManyLink(relationshipName),
+            data: {
+                fields: buildFieldsParam(fieldset),
+                ...options.queryParams,
+            },
+            ...options.ajaxOptions,
+        });
+
+        const { data, meta, links } = response;
+
+        return {
+            sparseModels: data.map(parseSparseResource),
+            meta,
+            ...(links ? { links } : {}),
+        };
+    }
+
+    /**
+     * Fetch the entirety of a has-many relationship using sparse fieldsets.
+     * See `sparseHasMany` above.
+     */
+    async sparseLoadAll<T extends OsfModel>(
+        this: T,
+        relationshipName: RelationshipsFor<T>,
+        fieldset: SparseFieldset,
+        options: RequestOptions = {},
+    ): Promise<SparseModel[]> {
+        const sparseModels: SparseModel[] = [];
+        let page = 1;
+        let totalPages = 0;
+
+        do { // eslint-disable-next-line no-await-in-loop
+            const response = await this.sparseHasMany(relationshipName, fieldset, {
+                ...options,
+                queryParams: {
+                    ...options.queryParams,
+                    page,
+                    'page[size]': 100,
+                },
+            });
+
+            sparseModels.push(...response.sparseModels);
+            totalPages = Math.ceil(response.meta.total / response.meta.per_page);
+            page++;
+        } while (page <= totalPages);
+
+        return sparseModels;
+    }
 }

app/models/registration-schema.ts

@@ -8,6 +8,7 @@ export interface AbstractQuestion {
     required?: boolean;
     description?: string;
     properties?: Subquestion[];
+    options?: string[];
 }
 
 export interface Subquestion extends AbstractQuestion {