@baravak/risloo-profile-cli 3.1.0

package/src/samples/GMIT93.js

@@ -0,0 +1,142 @@
+const { Profile, FS, Mappings } = require("../Profile");
+
+class GMIT93 extends Profile {
+  // Number of pages
+  static pages = 1;
+
+  // Labels of the sample
+  labels = {
+    L1: { eng: "linguistic", fr: "زبانی - کلامی" },
+    L2: { eng: "logical_mathematical", fr: "منطقی - ریاضی" },
+    L3: { eng: "visual_spatial", fr: "دیداری - فضایی" },
+    L4: { eng: "bodily_kinesthetic", fr: "بدنی - جنبشی" },
+    L5: { eng: "interpersonal", fr: "میان‌فردی" },
+    L6: { eng: "intrapersonal", fr: "درون‌فردی" },
+    L7: { eng: "musical", fr: "موسیقیایی" },
+    L8: { eng: "naturalist", fr: "طبیعت‌گرا" },
+  };
+
+  profileSpec = {
+    /* "sample" determines some important info about the sample and profile */
+    /* Default prerequisites: 1. gender, 2. age, 3. education */
+    /* "prerequisites" is synonym to "fields" in our program */
+    sample: {
+      name: "پرسشنامه هوش‌های چندگانه گاردنر" /* Name of the sample */,
+      multiProfile: false /* Whether the sample has multiple profiles or not */,
+      questions: false /* Determines whether to get questions from inital dataset or not */,
+      defaultFields: true /* Determines whether to have default prerequisites in the profile or not */,
+      fields: ["marital_status"] /* In case you want to get some additional fields and show in the profile */,
+    },
+    /* "profile" determines the dimensions of the drawn profile (to be used in svg tag viewbox) */
+    /* calculating its dimensions carefully is of great importance */
+    profile: {
+      get dimensions() {
+        return {
+          width: 634 + 2 * this.padding.x,
+          height: 610 + 2 * this.padding.y,
+        };
+      },
+      padding: {
+        x: 0,
+        y: 52,
+      },
+    },
+    /* "items" is the general term used for independent data elements to be drawn in the profile */
+    items: {
+      minValue: 10 /* Minimum value of items mark provided by the dataset */,
+      maxValue: 50 /* Maximum value of items mark provided by the dataset */,
+      offsetX: 134 /* Horizontal offset between items and left side of profile */,
+      offsetY: 30 /* Vertical offset between two consecutive item in the profile */,
+      get distanceY() {
+        return this.offsetY + this.rect.height;
+      } /* Distance between two consecutive item in the profile */,
+      totalHeight: "" /* To be calculated in the class with the function provided */,
+      calcTotalHeight: function (n) {
+        return this.distanceY * (n - 1) + this.rect.height;
+      } /* Method for calculating the total height of items */,
+      ticks: {
+        num: 5 /* Number of ticks */,
+        heightOffset: 40 /* Half length that the ticks lines of items is greater than items total heigth */,
+        numberOffset: {
+          x: 10 /* Horizontal distance from the line */,
+          y: 10 /* Vertical distance from the line */,
+        },
+      },
+      rect: {
+        height: 40 /* Height of the items rectangle */,
+        get borderRadius() {
+          return this.height / 2;
+        } /* Border Radius of the items rectangle */,
+        colors: [
+          "#8B5CF6",
+          "#EC4899",
+          "#10B981",
+          "#F59E0B",
+          "#007BA4",
+          "#F43F5E",
+          "#71717A",
+          "#047857",
+        ] /* Colors used for theming items body parts */,
+        opacityMappings: new Mappings()
+          .addMapping("10-19", 0.7)
+          .addMapping("20-29", 0.8)
+          .addMapping("30-39", 0.9)
+          .addMapping("40-50", 1) /* Opacity mapping for marks */,
+      },
+      widthCoeff: 10 /* Used for converting mark to the width */,
+      label: {
+        offsetX: 20 /* Horizontal offset of label from item */,
+      },
+    },
+    /* "labels" part which has to be provided for each profile */
+    labels: Object.values(this.labels),
+  };
+
+  constructor(dataset, options, config = {}) {
+    super();
+    this._init(dataset, options, config);
+  }
+
+  _calcContext() {
+    const {
+      spec: { parameters: spec },
+      dataset,
+    } = this;
+
+    const { items: itemsSpec } = spec;
+
+    // ّInit Spec
+    spec.items.totalHeight = spec.items.calcTotalHeight(dataset.score.length);
+
+    // Gather Required Info for Items
+    const items = dataset.score.map((data, index) => ({
+      label: data.label,
+      mark: data.mark,
+      width: data.mark * itemsSpec.widthCoeff,
+      fill: itemsSpec.rect.colors[index],
+      opacity: itemsSpec.rect.opacityMappings.map(data.mark),
+    }));
+
+    // Calculate Ticks Numbers Array for Items
+    const itemsTicksNumbers = FS.createArithmeticSequence(
+      itemsSpec.minValue,
+      (itemsSpec.maxValue - itemsSpec.minValue) / (itemsSpec.ticks.num - 1),
+      itemsSpec.ticks.num
+    );
+
+    // Gather Required Info for Items Ticks
+    const itemsTicks = itemsTicksNumbers.map((tick) => ({
+      number: tick,
+      leftPos: tick * itemsSpec.widthCoeff,
+    }));
+
+    return [
+      {
+        items,
+        itemsTicks,
+      },
+    ];
+  }
+}
+
+module.exports = GMIT93;

package/src/samples/HPL93.js

@@ -0,0 +1,132 @@
+const { Profile, FS } = require("../Profile");
+
+class HPL93 extends Profile {
+  // Number of pages
+  static pages = 1;
+
+  // Labels of the sample
+  labels = {
+    L1: { eng: "raw", fr: "نمره کل" },
+    L2: { eng: "spritual_growth", fr: "رشد معنوی و شکوفایی" },
+    L3: { eng: "nutrition", fr: "تغذیه" },
+    L4: { eng: "stress_management", fr: "مدیریت استرس" },
+    L5: { eng: "physical_activity", fr: "ورزش و فعالیت بدنی" },
+    L6: { eng: "health_self_responsibility", fr: "مسئولیت‌پذیری در مورد سلامت" },
+    L7: { eng: "interpersonal_relationships", fr: "روابط بین‌ فردی" },
+  };
+
+  profileSpec = {
+    /* "sample" determines some important info about the sample and profile */
+    /* Default prerequisites: 1. gender, 2. age, 3. education */
+    /* "prerequisites" is synonym to "fields" in our program */
+    sample: {
+      name: "پرسشنامه سبک زندگی ارتقادهنده سلامت" /* Name of the sample */,
+      multiProfile: false /* Whether the sample has multiple profiles or not */,
+      questions: false /* Determines whether to get questions from inital dataset or not */,
+      defaultFields: true /* Determines whether to have default prerequisites in the profile or not */,
+      fields: ["marital_status"] /* In case you want to get some additional fields and show in the profile */,
+    },
+    /* "profile" determines the dimensions of the drawn profile (to be used in svg tag viewbox) */
+    /* calculating its dimensions carefully is of great importance */
+    profile: {
+      get dimensions() {
+        return {
+          width: 770 + 2 * this.padding.x,
+          height: 600 + 2 * this.padding.y,
+        }
+      },
+      padding: {
+        x: 50,
+        y: 0,
+      },
+    },
+    /* Spec for the polygons drawn in the profile */
+    polygons: {
+      n: 6 /* Number of vertices of the polygons */,
+      get theta() {
+        return (2 * Math.PI) / this.n;
+      },
+      startAngle: FS.toRadians(-60) /* Start angle of the polygon */,
+      radius: 270 /* Radius of the peripheral circle of the main polygon */,
+      centerOffset: 67 /* Radius of the peropheral circle of the smallest polygon */,
+    },
+    /* "raw" is the general term used for total data element in the profile */
+    raw: {
+      maxValue: 216,
+      mark: {
+        paddingY: 18,
+      },
+    },
+    /* "items" is the general term used for independent data elements to be drawn in the profile */
+    items: {
+      maxValues: {
+        [this.labels.L2.eng]: 40,
+        [this.labels.L3.eng]: 28,
+        [this.labels.L4.eng]: 24,
+        [this.labels.L5.eng]: 36,
+        [this.labels.L6.eng]: 56,
+        [this.labels.L7.eng]: 28,
+      } /* Maximum value of marks provided by the dataset */,
+      labels: {
+        offset: 50 /* Offset of the label from the vertice of the polygon */,
+        paddingY: 12 /* Half distance between two parts of the label */,
+      },
+      dataPoints: {
+        radius: 12 /* Radius of the circle of the data point */,
+        fills: {
+          [this.labels.L2.eng]: "#C026D3",
+          [this.labels.L3.eng]: "#EA580C",
+          [this.labels.L4.eng]: "#52525B",
+          [this.labels.L5.eng]: "#2563EB",
+          [this.labels.L6.eng]: "#059669",
+          [this.labels.L7.eng]: "#E11D48",
+        } /* Colors used for theming data points */,
+      },
+    },
+    /* "labels" part which has to be provided for each profile */
+    labels: Object.values(this.labels)
+  };
+
+  constructor(dataset, options, config = {}) {
+    super();
+    this._init(dataset, options, config);
+  }
+
+  _calcContext() {
+    const {
+      spec: { parameters: spec },
+      dataset,
+    } = this;
+
+    // Deconstructing the Spec of the Profile
+    let { polygons: polygonsSpec, items: itemsSpec } = spec;
+
+    const rawData = dataset.score.shift();
+
+    const raw = {
+      label: rawData.label,
+      mark: rawData.mark,
+    };
+
+    // Gather Required Info for Items
+    const items = dataset.score.map((data, index) => ({
+      label: data.label,
+      mark: data.mark,
+      maxValue: itemsSpec.maxValues[data.label.eng],
+      angle: polygonsSpec.startAngle - index * polygonsSpec.theta,
+      radius:
+        (data.mark / itemsSpec.maxValues[data.label.eng]) * (polygonsSpec.radius - polygonsSpec.centerOffset) +
+        polygonsSpec.centerOffset,
+      fill: itemsSpec.dataPoints.fills[data.label.eng],
+    }));
+
+    return [
+      {
+        raw,
+        items,
+      },
+    ];
+  }
+}
+
+module.exports = HPL93;

package/src/samples/IBT93.js

@@ -0,0 +1,99 @@
+const { Mappings } = require("../Profile");
+const PIES93 = require("./PIES93");
+
+const labels = {
+  L1: { eng: "da", fr: "توقع تأیید از دیگران", abbr: "DA" },
+  L2: { eng: "hse", fr: "انتظارات بیش از حد خود", abbr: "HSE" },
+  L3: { eng: "bp", fr: "سرزنش خود", abbr: "BP" },
+  L4: { eng: "fr", fr: "واکنش همراه با ناکامی", abbr: "FR" },
+  L5: { eng: "ei", fr: "بی‌مسئولیتی هیجانی", abbr: "EI" },
+  L6: { eng: "ao", fr: "بیش دلواپسی اضطرابی", abbr: "AO" },
+  L7: { eng: "pa", fr: "اجتناب از مشکل", abbr: "PA" },
+  L8: { eng: "d", fr: "وابستگی", abbr: "D" },
+  L9: { eng: "hc", fr: "درماندگی برای تغییر", abbr: "HC" },
+  L10: { eng: "p", fr: "کمال‌گرایی", abbr: "P" },
+  L11: { eng: "raw", fr: "نمره کل", abbr: "#" },
+};
+
+const customConfig = {
+  sample: {
+    name: "پرسشنامه باورهای غیرمنطقی جونز" /* Name of the sample */,
+  },
+  profile: {
+    get dimensions() {
+      return {
+        width: 834 + 2 * this.padding.x,
+        height: 670 + 2 * this.padding.y,
+      }
+    },
+    padding: {
+      x: 40,
+      y: 8,
+    },
+  },
+  raw: {
+    maxValue: 500,
+    offsetX: 80,
+    ticks: {
+      num: 5 /* Number of ticks */,
+    },
+    rect: {
+      height: 670,
+    },
+  },
+  items: {
+    maxValue: 50,
+    offsetY: 21,
+    ticks: {
+      num: 5 /* Number of ticks */,
+    },
+    body: {
+      colors: [
+        "#06B6D4",
+        "#0EA5E9",
+        "#6366F1",
+        "#7C3AED",
+        "#A855F7",
+        "#D946EF",
+        "#EC4899",
+        "#F43F5E",
+        "#F97316",
+        "#FBBF24",
+      ],
+      opacityMappings: new Mappings()
+        .addMapping("10", 0.6)
+        .addMapping("11-20", 0.7)
+        .addMapping("21-30", 0.8)
+        .addMapping("31-40", 0.9)
+        .addMapping("41-50", 1),
+    },
+    base: {
+      rect: {
+        width: 272,
+      },
+      colors: [
+        "#39C5DE",
+        "#3EB7EC",
+        "#8385F4",
+        "#9661F1",
+        "#B978FA",
+        "#E16BF3",
+        "#F06EAE",
+        "#F7647E",
+        "#FB8F46",
+        "#FCCC50",
+      ],
+    },
+  },
+  labels: Object.values(labels),
+};
+
+// This profile is completely identical to MMFAD9A
+
+class IBT93 extends PIES93 {
+  constructor(dataset, options, config = customConfig) {
+    super(dataset, options, config);
+  }
+}
+
+module.exports = IBT93;

package/src/samples/IUS93.js

@@ -0,0 +1,204 @@
+const { Profile, FS } = require("../Profile");
+
+class IUS93 extends Profile {
+  // Number of pages
+  static pages = 1;
+
+  // Labels of the sample
+  labels = {
+    L1: { eng: "raw", title: "نمره کل", desc: "" },
+    L2: { eng: "factor_1", title: "عامل ۱", desc: "بلاتکلیفی تلویحات خودارجاعی و رفتار منفی دارد" },
+    L3: { eng: "factor_2", title: "عامل ۲", desc: "بلاتکلیفی غیرمنصفانه است و همه چیز را تباه می‌کند" },
+  };
+
+  profileSpec = {
+    /* "sample" determines some important info about the sample and profile */
+    /* Default prerequisites: 1. gender, 2. age, 3. education */
+    /* "prerequisites" is synonym to "fields" in our program */
+    sample: {
+      name: "پرسشنامه عدم تحمل بلاتکلیفی" /* Name of the sample */,
+      multiProfile: false /* Whether the sample has multiple profiles or not */,
+      questions: false /* Determines whether to get questions from inital dataset or not */,
+      defaultFields: true /* Determines whether to have default prerequisites in the profile or not */,
+      fields: ["marital_status"] /* In case you want to get some additional fields and show in the profile */,
+    },
+    /* "profile" determines the dimensions of the drawn profile (to be used in svg tag viewbox) */
+    /* calculating its dimensions carefully is of great importance */
+    profile: {
+      get dimensions() {
+        return {
+          width: 506 + 2 * this.padding.x,
+          height: 627 + 2 * this.padding.y,
+        }
+      },
+      padding: {
+        x: 10,
+        y: 45,
+      },
+    },
+    /* "raw" is the general term used for total data element in the profile */
+    raw: {
+      maxValue: 135 /* Maximum value of raw mark provided by the dataset */,
+      fill: "#B91C1C" /* Color used in the raw element */,
+      circle: {
+        R: 140 /* Radius of the outer circle of the raw element */,
+        r: 85 /* Radius of the inner circle of the raw element */,
+        brs: {
+          tl: 0 /* Top left border radius */,
+          bl: 0 /* Bottom left border radius */,
+          tr: 12 /* Top right border radius */,
+          br: 12 /* Bottom right border radius */,
+        } /* Border radiuses at each end of the gauge of the raw element */,
+        angles: {
+          start: FS.toRadians(-90),
+          end: FS.toRadians(180),
+        } /* Angles of each end of the raw element */,
+        direction: false /* Clockwise direction for the raw gauge element */,
+        get totalAngle() {
+          return this.direction
+            ? 2 * Math.PI - (this.angles.end - this.angles.start)
+            : this.angles.end - this.angles.start;
+        },
+      },
+      rect: {
+        width: 135 /* Width of the label rect of the raw element */,
+        height: 55 /* Height of the label rect of the raw element */,
+        rb: 8 /* Border radius of the label rect of the raw element */,
+        offsetX: 5 /* Offset between rectangle and the beginning of the gauge */,
+      },
+      ticks: {
+        num: 2 /* Number of ticks */,
+        line: {
+          width: 12 /* Width of the tick line */,
+          offset: 4 /* Offset from the element */,
+        },
+        number: {
+          offset: 8 /* Offset from the line */,
+        },
+      },
+    },
+    /* "items" is the general term used for independent data elements to be drawn in the profile */
+    items: {
+      offsetX: 102 /* Horizontal offset between two items */,
+      offsetY: 63 /* Vertical offset between items and raw */,
+      get distanceX() {
+        return this.offsetX + this.circle.R * 2;
+      } /* Horizontal distance between two items */,
+      maxValues: {
+        factor_1: 75,
+        factor_2: 60,
+      } /* Maximum value of items */,
+      fills: {
+        factor_1: "#D97706",
+        factor_2: "#1E3A8A",
+      } /* Color used in items */,
+      circle: {
+        R: 90 /* Radius of the outer circle of the items element */,
+        r: 50 /* Radius of the inner circle of the items element */,
+        brs: {
+          tl: 0 /* Top left border radius */,
+          bl: 0 /* Bottom left border radius */,
+          tr: 12 /* Top right border radius */,
+          br: 12 /* Bottom right border radius */,
+        } /* Border radiuses at each end of the gauge of the items element */,
+        angles: {
+          start: FS.toRadians(-90),
+          end: FS.toRadians(180),
+        } /* Angles of each end of the items element */,
+        direction: false /* Clockwise direction for the items gauge element */,
+        get totalAngle() {
+          return this.direction
+            ? 2 * Math.PI - (this.angles.end - this.angles.start)
+            : this.angles.end - this.angles.start;
+        },
+      },
+      rect: {
+        width: 85 /* Width of the label rect of the items element */,
+        height: 40 /* Width of the label rect of the items element */,
+        rb: 8 /* Width of the label rect of the items element */,
+        offsetX: 5 /* Offset between rectangle and the beginning of the gauge */,
+      },
+      ticks: {
+        num: 2 /* Number of ticks */,
+        line: {
+          width: 12 /* Width of the tick line */,
+          offset: 4 /* Offset from the element */,
+        },
+        number: {
+          offset: 8 /* Offset from the line */,
+        },
+      },
+      label: {
+        offsetY: 30,
+        lineHeight: 25,
+      },
+    },
+    /* "labels" part which has to be provided for each profile */
+    labels: Object.values(this.labels),
+  };
+
+  constructor(dataset, options, config = {}) {
+    super();
+    this._init(dataset, options, config);
+  }
+
+  _calcContext() {
+    const {
+      spec: { parameters: spec },
+      dataset,
+    } = this;
+
+    // Deconstructing the Spec of the Profile
+    const { raw: rawSpec, items: itemsSpec } = spec;
+
+    // Separate Raw Data from the Dataset
+    const rawData = dataset.score.shift();
+
+    // Calculate Ticks Numbers Array for Raw
+    const rawTicksNumbers = FS.createArithmeticSequence(
+      rawSpec.maxValue,
+      -rawSpec.maxValue / (rawSpec.ticks.num - 1),
+      rawSpec.ticks.num
+    ).reverse();
+
+    // Gather Required Info for Raw
+    const raw = {
+      label: rawData.label,
+      mark: rawData.mark,
+      zeta: (rawData.mark / rawSpec.maxValue) * rawSpec.circle.totalAngle + rawSpec.circle.angles.start,
+      fill: rawSpec.fill,
+      opacity: FS.roundTo2(0.5 * (1 + rawData.mark / rawSpec.maxValue)),
+      ticks: rawTicksNumbers.map((tick) => ({
+        number: tick,
+        angle: (tick / rawSpec.maxValue) * rawSpec.circle.totalAngle + rawSpec.circle.angles.start,
+      })),
+    };
+
+    // Calculate Ticks Numbers Object for Items
+    const itemsTicksNumbers = Object.fromEntries(
+      Object.entries(itemsSpec.maxValues).map((entry) => [
+        entry[0],
+        FS.createArithmeticSequence(entry[1], -entry[1] / (itemsSpec.ticks.num - 1), itemsSpec.ticks.num).reverse(),
+      ])
+    );
+
+    // Gather Required Info for Items
+    const items = dataset.score.map((data) => ({
+      label: data.label,
+      mark: data.mark,
+      zeta:
+        (data.mark / itemsSpec.maxValues[data.label.eng]) * itemsSpec.circle.totalAngle + itemsSpec.circle.angles.start,
+      fill: itemsSpec.fills[data.label.eng],
+      opacity: FS.roundTo2(0.5 * (1 + data.mark / itemsSpec.maxValues[data.label.eng])),
+      ticks: itemsTicksNumbers[data.label.eng].map((tick) => ({
+        number: tick,
+        angle:
+          (tick / itemsSpec.maxValues[data.label.eng]) * itemsSpec.circle.totalAngle + itemsSpec.circle.angles.start,
+      })),
+    }));
+
+    return [{ raw, items }];
+  }
+}
+
+module.exports = IUS93;