API Documentation

Source

api/skill/SkillCollection.js

  1. import SimpleSchema from 'simpl-schema';
  2. import { slugify, Slugs } from '../slug/SlugCollection';
  3. import BaseSlugCollection from '../base/BaseSlugCollection';
  5. /** @namespace api/skill */
  7. /**
  8.  * Represents a specific Skill, such as "Software Engineering".
  9.  * @extends api/base.BaseSlugCollection
  10.  * @memberOf api/skill
  11.  */
  12. class SkillCollection extends BaseSlugCollection {
  13.   /**
  14.    * Creates the Skill collection.
  15.    */
  16.   constructor() {
  17.     super('Skill', new SimpleSchema({
  18.       name: { type: String },
  19.       slugID: { type: SimpleSchema.RegEx.Id },
  20.       description: { type: String },
  21.     }));
  22.   }
  24.   /**
  25.    * Defines a new Skill and its associated Slug.
  26.    * @example
  27.    * Skills.define({ name: 'Software Engineering',
  28.    *                    description: 'Methods for group development of large, high quality software systems',
  29.    * });
  30.    * @param { Object } description Object with keys name, slug, description.
  31.    * Slug must be previously undefined.
  32.    * @throws {Meteor.Error} If the Skill definition includes a defined slug.
  33.    * @returns The newly created docID.
  34.    */
  35.   define({
  36.            name,
  37.            description,
  38.          }) {
  39.     const slug = slugify(name); // we automatically build the slug from the name.
  40.     // Get SlugID, throw error if found.
  41.     const slugID = Slugs.define({ name: slug });
  42.     // Define the Skill and get its ID
  43.     const SkillID = this._collection.insert({
  44.       name, description, slugID,
  45.     });
  46.     // Connect the Slug to this Skill
  47.     Slugs.updateEntityID(slugID, SkillID);
  48.     return SkillID;
  49.   }
  51.   /**
  52.    * Update an Skill.
  53.    * @param docID The docID to be updated.
  54.    * @param name The new name (optional).
  55.    * @param description The new description (optional).
  56.    * @throws { Meteor.Error } If docID is not defined.
  57.    */
  58.   update(docID, {
  59.     name, description,
  60.   }) {
  61.     this.assertDefined(docID);
  62.     const updateData = {};
  63.     if (name) {
  64.       updateData.name = name;
  65.     }
  66.     if (description) {
  67.       updateData.description = description;
  68.     }
  69.     this._collection.update(docID, { $set: updateData });
  70.   }
  72.   /**
  73.    * Remove the Skill.
  74.    * @param instance The docID or slug of the entity to be removed.
  75.    * @throws { Meteor.Error } If Skill is associated with any Challenge.
  76.    */
  77.   removeIt(instance) {
  78.     const docID = this.getID(instance);
  79.     // Check that this Skill is not referenced by any Team, Developer, or Challenge.
  81.     // OK, clear to delete.
  82.     super.removeIt(docID);
  83.   }
  85.   /**
  86.    * Returns an object representing the given Skill.
  87.    * @param docID {string} the ID of the Skill.
  88.    * @return {{name: *, description: *}}
  89.    */
  90.   dumpOne(docID) {
  91.     const doc = this.findDoc(docID);
  92.     const { name, description } = doc;
  93.     return { name, description };
  94.   }
  95. }
  97. /**
  98.  * Singleton instance of the SkillCollection.
  99.  * @type {api/skill.SkillCollection}
  100.  * @memberOf api/skill
  101.  */
  102. export const Skills = new SkillCollection();