Source: PleesTracker/engine.js

  1. /*
  2.  * Copyright 2020-2022 Sleepdiary Developers <sleepdiary@pileofstuff.org>
  3.  *
  4.  * Permission is hereby granted, free of charge, to any person
  5.  * obtaining a copy of this software and associated documentation
  6.  * files (the "Software"), to deal in the Software without
  7.  * restriction, including without limitation the rights to use, copy,
  8.  * modify, merge, publish, distribute, sublicense, and/or sell copies
  9.  * of the Software, and to permit persons to whom the Software is
  10.  * furnished to do so, subject to the following conditions:
  11.  *
  12.  * The above copyright notice and this permission notice shall be
  13.  * included in all copies or substantial portions of the Software.
  14.  *
  15.  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
  16.  * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
  17.  * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
  18.  * NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS
  19.  * BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN
  20.  * ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
  21.  * CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
  22.  * SOFTWARE.
  23.  */
  25. "use strict";
  27. /**
  28.  * @public
  29.  * @unrestricted
  30.  * @augments DiaryBase
  31.  *
  32.  * @example
  33.  * let diary = new_sleep_diary(contents_of_my_file));
  34.  *
  35.  * console.log(diary.records);
  36.  * -> [
  37.  *      {
  38.  *        "sid"   : 1,
  39.  *        "start" : 12345678,
  40.  *        "stop"  : 23456789,
  41.  *        "rating": 5,
  42.  *      },
  43.  *      ...
  44.  *    ]
  45.  *
  46.  */
  47. class DiaryPleesTracker extends DiaryBase {
  49.     /**
  50.      * @param {Object} file - file contents
  51.      * @param {Function=} serialiser - function to serialise output
  52.      */
  53.     constructor(file,serialiser) {
  55.         super(file,serialiser); // call the SleepDiary constructor
  57.         /**
  58.          * Spreadsheet manager
  59.          * @protected
  60.          * @type {Spreadsheet}
  61.          */
  62.         this["spreadsheet"] = new Spreadsheet(this,[
  63.             {
  64.                 "sheet" : "Records",
  65.                 "member" : "records",
  66.                 "cells": [
  67.                     {
  68.                         "member": "sid",
  69.                         "regexp": /^[1-9][0-9]*$/,
  70.                         "type": "number",
  71.                     },
  72.                     {
  73.                         "member": "start",
  74.                         "type": "time",
  75.                     },
  76.                     {
  77.                         "member": "stop",
  78.                         "type": "time",
  79.                     },
  80.                     {
  81.                         "member": "rating",
  82.                         "regexp": /^[0-5]$/,
  83.                         "type": "number",
  84.                     },
  85.                 ]
  86.             }
  87.         ]);
  89.         if ( !this.initialise_from_common_formats(file) ) {
  90.             /**
  91.              * Individual records from the sleep diary
  92.              * @type {Array}
  93.              */
  94.             this["records"] = (
  95.                 file["to"]("Standard")["records"]
  96.                     .filter( r => r["status"] == "asleep" )
  97.                     .map( (r,n) => ({
  98.                         "start"   : r["start"],
  99.                         "stop"    : r["end"  ],
  100.                         "sid"     : n+1,
  101.                         "rating"  : 0,
  102.                     }))
  103.             );
  104.         }
  106.     }
  108.     ["to"](to_format) {
  110.         switch ( to_format ) {
  112.         case "output":
  114.             return this.serialise({
  115.                 "file_format": () => "string",
  116.                 "contents": (
  117.                     // can't use output_csv() here, because PleesTracker requires numeric times
  118.                     "sid,start,stop,rating\n" +
  119.                         this["records"]
  120.                         .map(
  121.                             r => [
  122.                                 r["sid"   ],
  123.                                 r["start" ],
  124.                                 r["stop"  ],
  125.                                 r["rating"],
  126.                             ].join(',') + "\n"
  127.                         ).join("")
  128.                 ),
  129.             });
  131.         case "Standard":
  133.             return new DiaryStandard({
  134.                 "records": this["records"].map(
  135.                     r => ({
  136.                         "status" : "asleep",
  137.                         "start"  : r["start"],
  138.                         "end"    : r["stop" ],
  139.                     })
  140.                 ),
  141.             }, this.serialiser);
  143.         default:
  145.             return super["to"](to_format);
  147.         }
  149.     }
  151.     ["merge"](other) {
  153.         other = other["to"](this["file_format"]());
  155.         this["records"] = this["records"].concat(
  156.             DiaryBase.unique(
  157.                 this["records"],
  158.                 other["records"],
  159.                 ["start","stop"]
  160.             )
  161.         );
  163.         this["records"].forEach( (record,n) => record["sid"]=n+1 );
  165.         return this;
  166.     }
  168.     ["file_format"]() { return "PleesTracker"; }
  169.     ["format_info"]() {
  170.         return {
  171.             "name": "PleesTracker",
  172.             "title": "Plees Tracker",
  173.             "url": "/src/PleesTracker",
  174.             "statuses": [ "asleep" ],
  175.             "extension": ".csv",
  176.             "logo": "https://raw.githubusercontent.com/vmiklos/plees-tracker/master/app/src/main/res/mipmap-xxxhdpi/ic_launcher_round.png",
  177.             "timezone": "UTC",
  178.         }
  179.     }
  181. }
  183. DiaryBase.register(DiaryPleesTracker);