@ca-plant-list/ca-plant-list 0.3.3 → 0.3.5

package/lib/genera.js

@@ -1,62 +1,76 @@
 import { Config } from "./config.js";
 import { Families } from "./families.js";
 import { Files } from "./files.js";
+// eslint-disable-next-line no-unused-vars
+import { Taxon } from "./taxon.js";
 
 class Genera {
+    #families;
+    #genera;
 
-    static #genera;
-
-    static {
+    /**
+     * @param {Families} families
+     */
+    constructor(families) {
         const dataDir = Config.getPackageDir() + "/data";
-        this.#genera = JSON.parse( Files.read( dataDir + "/genera.json" ) );
+        this.#genera = JSON.parse(Files.read(dataDir + "/genera.json"));
+        this.#families = families;
     }
 
-    static addTaxon( taxon ) {
-
+    /**
+     * @param {Taxon} taxon
+     */
+    addTaxon(taxon) {
         const genusName = taxon.getGenusName();
-        const genusData = this.#genera[ genusName ];
-        if ( !genusData ) {
-            console.log( taxon.getName() + " genus not found" );
+        const genusData = this.#genera[genusName];
+        if (!genusData) {
+            console.log(taxon.getName() + " genus not found");
             return;
         }
 
-        if ( genusData.taxa === undefined ) {
+        if (genusData.taxa === undefined) {
             genusData.taxa = [];
         }
-        genusData.taxa.push( taxon );
+        genusData.taxa.push(taxon);
 
-        const family = this.getFamily( genusName );
-        if ( !family ) {
-            console.log( taxon.getName() + " family not found" );
+        const family = this.getFamily(genusName);
+        if (!family) {
+            console.log(taxon.getName() + " family not found");
             return;
         }
-        family.addTaxon( taxon );
+        family.addTaxon(taxon);
     }
 
-    static getGenus( genusName ) {
-        return new Genus( this.#genera[ genusName ] );
+    /**
+     * @param {string} genusName
+     */
+    getGenus(genusName) {
+        return new Genus(this.#genera[genusName]);
     }
 
-    static getFamily( genusName ) {
-        const genus = this.#genera[ genusName ];
-        if ( genus ) {
-            return Families.getFamily( genus.family );
+    /**
+     * @param {string} genusName
+     */
+    getFamily(genusName) {
+        const genus = this.#genera[genusName];
+        if (genus) {
+            return this.#families.getFamily(genus.family);
         }
     }
-
 }
 
 class Genus {
-
     #data;
 
-    constructor( data ) {
+    constructor(data) {
         this.#data = data;
     }
 
     getTaxa() {
-        return this.#data.taxa.sort( ( a, b ) => a.getName().localeCompare( b.getName() ) );
+        return this.#data.taxa.sort((a, b) =>
+            a.getName().localeCompare(b.getName())
+        );
     }
 }
 
-export { Genera };
+export { Genera };

package/lib/html.js

@@ -8,41 +8,60 @@ export const HTML_OPTIONS = {
 
 /** HTML utility functions. */
 export class HTML {
-
-    static arrayToLI( items ) {
-        return items.reduce( ( itemHTML, currVal ) => itemHTML + "<li>" + currVal + "</li>", "" );
+    /**
+     * @param {string[]} items
+     */
+    static arrayToLI(items) {
+        return items.reduce(
+            (itemHTML, currVal) => itemHTML + "<li>" + currVal + "</li>",
+            ""
+        );
     }
 
-    static escapeAttribute( value ) {
-        return value.replaceAll( "\"", "&quot;" );
+    /**
+     * @param {string} value
+     */
+    static escapeAttribute(value) {
+        return value.replaceAll('"', "&quot;");
     }
 
-    static escapeText( text ) {
-        return text.replaceAll( "&", "&amp;" ).replaceAll( "<", "&lt;" ).replaceAll( ">", "&gt;" );
+    /**
+     * @param {string} text
+     */
+    static escapeText(text) {
+        return text
+            .replaceAll("&", "&amp;")
+            .replaceAll("<", "&lt;")
+            .replaceAll(">", "&gt;");
     }
 
     /**
      * @deprecated
      */
-    static getElement( elName, text, attributes = {}, options = 0 ) {
+    static getElement(elName, text, attributes = {}, options = 0) {
         let html = "<" + elName;
-        html += this.renderAttributes( attributes );
-        if ( !( options & HTML_OPTIONS.NO_ESCAPE ) ) {
-            text = this.escapeText( text );
+        html += this.renderAttributes(attributes);
+        if (!(options & HTML_OPTIONS.NO_ESCAPE)) {
+            text = this.escapeText(text);
         }
         html += ">" + text + "</" + elName + ">";
         return html;
-
     }
 
-    static #getElement( elName, text, attributes, escape ) {
+    /**
+     * @param {string} elName
+     * @param {string} text
+     * @param {string|Object<string,string>|undefined} attributes
+     * @param {boolean} escape
+     */
+    static #getElement(elName, text, attributes, escape) {
         let html = "<" + elName;
-        html += this.renderAttributes( attributes );
-        if ( escape && ( typeof text === "string" ) ) {
-            text = this.escapeText( text );
+        html += this.renderAttributes(attributes);
+        if (escape && typeof text === "string") {
+            text = this.escapeText(text);
         }
         // If tag is empty, make it self-closing so it is XHTML (epub) compatible.
-        if ( text === "" ) {
+        if (text === "") {
             return html + "/>";
         }
         return html + ">" + text + "</" + elName + ">";
@@ -50,22 +69,22 @@ export class HTML {
 
     /**
      * Generate HTML for an &lt;a> element.
-     * @param {string|undefined} href 
-     * @param {string} linkText 
-     * @param {Object} [attributes] 
+     * @param {string|undefined} href
+     * @param {string} linkText
+     * @param {Object} [attributes]
      * @param {boolean} [openInNewWindow] true if the link should open in a new window.
      * @returns {string} an HTML &lt;a> element.
      */
-    static getLink( href, linkText, attributes = {}, openInNewWindow ) {
+    static getLink(href, linkText, attributes = {}, openInNewWindow) {
         let html = "<a";
-        if ( href !== undefined ) {
-            html += this.renderAttribute( "href", href );
+        if (href !== undefined) {
+            html += this.renderAttribute("href", href);
         }
-        html += this.renderAttributes( attributes );
-        if ( openInNewWindow ) {
-            html += this.renderAttribute( "target", "_blank" );
+        html += this.renderAttributes(attributes);
+        if (openInNewWindow) {
+            html += this.renderAttribute("target", "_blank");
         }
-        return html + ">" + this.escapeText( linkText ) + "</a>";
+        return html + ">" + this.escapeText(linkText) + "</a>";
     }
 
     /**
@@ -76,32 +95,42 @@ export class HTML {
      * @param {boolean} options.icon [true] display an icon after the text
      * @returns {string} A &lt;span> element to be used as a Bootstrap tooltip.
      */
-    static getToolTip( text, tooltip, options = {} ) {
-        const func = text.charAt( 0 ) === "<" ? HTML.wrap : HTML.textElement;
-        if ( options.icon !== false ) {
+    static getToolTip(text, tooltip, options = {}) {
+        const func = text.charAt(0) === "<" ? HTML.wrap : HTML.textElement;
+        if (options.icon !== false) {
             text += " ⓘ";
         }
-        return func( "span", text, { "data-bs-html": "true", "title": tooltip } );
+        return func("span", text, { "data-bs-html": "true", title: tooltip });
     }
 
-    static renderAttribute( n, v ) {
-        return " " + n + "=\"" + this.escapeAttribute( v ) + "\"";
+    static renderAttribute(n, v) {
+        return " " + n + '="' + this.escapeAttribute(v) + '"';
     }
 
-    static renderAttributes( attributes ) {
+    /**
+     * @param {string|Object<string,string>|undefined} attributes
+     */
+    static renderAttributes(attributes = {}) {
+        if (typeof attributes === "string") {
+            return this.renderAttribute("class", attributes);
+        }
         let html = "";
-        for ( const [ k, v ] of Object.entries( attributes ) ) {
-            html += this.renderAttribute( k, v );
+        for (const [k, v] of Object.entries(attributes)) {
+            html += this.renderAttribute(k, v);
         }
         return html;
     }
 
-    static textElement( elName, text, attributes = {} ) {
-        return HTML.#getElement( elName, text, attributes, true );
+    static textElement(elName, text, attributes = {}) {
+        return HTML.#getElement(elName, text, attributes, true);
     }
 
-    static wrap( elName, text, attributes = {} ) {
-        return HTML.#getElement( elName, text, attributes, false );
+    /**
+     * @param {string} elName
+     * @param {string} text
+     * @param {string|Object<string,string>|undefined} [attributes]
+     */
+    static wrap(elName, text, attributes) {
+        return HTML.#getElement(elName, text, attributes, false);
     }
-
 }

package/lib/htmltaxon.js

@@ -0,0 +1,51 @@
+import { DateUtils } from "./dateutils.js";
+import { HTML } from "./html.js";
+// eslint-disable-next-line no-unused-vars
+import { Taxon } from "./taxon.js";
+import { TextUtils } from "./textutils.js";
+
+class HTMLTaxon {
+    /**
+     * @param {Taxon} taxon
+     */
+    static getFlowerInfo(taxon) {
+        const lifeCycle = taxon.getLifeCycle();
+        const colors = taxon.getFlowerColors();
+        const monthStart = taxon.getBloomStart();
+        const monthEnd = taxon.getBloomEnd();
+
+        const parts = [];
+        if (lifeCycle) {
+            parts.push(
+                HTML.wrap("span", TextUtils.ucFirst(lifeCycle), "lc") + "."
+            );
+        }
+
+        if (colors || monthStart) {
+            let html = "Flowers: ";
+            if (colors) {
+                for (const color of colors) {
+                    html += HTML.textElement("img", "", {
+                        src: "./i/f-" + color + ".svg",
+                        alt: color + " flowers",
+                        title: color,
+                        class: "flr-color",
+                    });
+                }
+            }
+            if (monthStart && monthEnd) {
+                html += HTML.wrap(
+                    "span",
+                    DateUtils.getMonthName(monthStart) +
+                        "-" +
+                        DateUtils.getMonthName(monthEnd),
+                    { class: "flr-time" }
+                );
+            }
+            parts.push(HTML.wrap("span", html));
+        }
+        return HTML.wrap("div", parts.join(" "), { class: "section" });
+    }
+}
+
+export { HTMLTaxon };

package/lib/index.js

@@ -5,12 +5,13 @@
  * calrecnum:string;
  * CESA:string;
  * CRPR:string;
- * common_name:string;
+ * "common name":string;
  * FESA:string;
  * flower_color:string;
  * GRank:string;
  * "inat id":string;
  * "jepson id":string;
+ * life_cycle:"annual"|"perennial"|undefined
  * SRank:string;
  * status:string;
  * "RPI ID":string;

package/lib/taxa.js

@@ -2,7 +2,9 @@ import { Config } from "./config.js";
 import { HTML } from "./html.js";
 import { CSV } from "./csv.js";
 import { RarePlants } from "./rareplants.js";
-import { ErrorLog, Taxon } from "./index.js";
+import { ErrorLog, Families, Taxon } from "./index.js";
+import { Genera } from "./genera.js";
+import { TextUtils } from "./textutils.js";
 
 const FLOWER_COLORS = [
     { name: "white", color: "white" },
@@ -12,6 +14,7 @@ const FLOWER_COLORS = [
     { name: "yellow", color: "yellow" },
     { name: "blue", color: "blue" },
     { name: "purple", color: "purple" },
+    { name: "green", color: "green" },
 ];
 
 /**
@@ -70,9 +73,7 @@ class FlowerColor {
     }
 
     getColorName(uc = false) {
-        return uc
-            ? this.#color[0].toUpperCase() + this.#color.substring(1)
-            : this.#color;
+        return uc ? TextUtils.ucFirst(this.#color) : this.#color;
     }
 
     getFileName() {
@@ -85,6 +86,7 @@ class FlowerColor {
 }
 
 class Taxa {
+    #families;
     #errorLog;
     /** @type {Object<string,Taxon>} */
     #taxa = {};
@@ -123,6 +125,8 @@ class Taxa {
 
         const dataDir = Config.getPackageDir() + "/data";
 
+        this.#families = new Families();
+
         const taxaCSV = CSV.parseFile(dataDir, "taxa.csv");
         this.#loadTaxa(
             taxaCSV,
@@ -186,6 +190,10 @@ class Taxa {
         return html;
     }
 
+    getFamilies() {
+        return this.#families;
+    }
+
     /**
      * @param {string} name
      */
@@ -257,6 +265,7 @@ class Taxa {
      * @param {boolean} showFlowerErrors
      */
     #loadTaxa(taxaCSV, inclusionList, taxaMeta, taxonClass, showFlowerErrors) {
+        const genera = new Genera(this.#families);
         for (const row of taxaCSV) {
             const name = row["taxon_name"];
 
@@ -276,7 +285,7 @@ class Taxa {
             if (status !== undefined) {
                 row["status"] = status;
             }
-            const taxon = new taxonClass(row, taxaMeta[name]);
+            const taxon = new taxonClass(row, genera, taxaMeta[name]);
             this.#taxa[name] = taxon;
             const colors = taxon.getFlowerColors();
             if (colors) {

package/lib/taxon.js

@@ -1,6 +1,7 @@
 import { HTML } from "./index.js";
-import { Genera } from "./genera.js";
 import { RarePlants } from "./rareplants.js";
+// eslint-disable-next-line no-unused-vars
+import { Genera } from "./genera.js";
 
 const TAXA_COLNAMES = {
     BLOOM_START: "bloom_start",
@@ -10,6 +11,8 @@ const TAXA_COLNAMES = {
 };
 
 class Taxon {
+    /** @type {Genera} */
+    #genera;
     #name;
     #genus;
     #commonNames;
@@ -21,6 +24,7 @@ class Taxon {
     #iNatID;
     /**@type {string|undefined} */
     #iNatSyn;
+    #lifeCycle;
     #flowerColors;
     #bloomStart;
     #bloomEnd;
@@ -35,8 +39,10 @@ class Taxon {
 
     /**
      * @param {import("./index.js").TaxonData} data
+     * @param {Genera} genera
      */
-    constructor(data) {
+    constructor(data, genera) {
+        this.#genera = genera;
         const name = data["taxon_name"];
         const commonNames = data["common name"];
         const cesa = data["CESA"];
@@ -52,6 +58,7 @@ class Taxon {
         this.#jepsonID = data["jepson id"];
         this.#calRecNum = data["calrecnum"];
         this.#iNatID = data["inat id"];
+        this.#lifeCycle = data.life_cycle;
         const colors = data["flower_color"];
         this.#flowerColors = colors ? colors.split(",") : undefined;
         if (data["bloom_start"]) {
@@ -66,7 +73,7 @@ class Taxon {
         this.#fesa = fesa ? fesa : undefined;
         this.#rankCNDDB = rankCNDDB ? rankCNDDB : undefined;
         this.#rankGlobal = rankGlobal ? rankGlobal : undefined;
-        Genera.addTaxon(this);
+        genera.addTaxon(this);
     }
 
     /**
@@ -144,7 +151,7 @@ class Taxon {
     }
 
     getFamily() {
-        return Genera.getFamily(this.#genus);
+        return this.#genera.getFamily(this.#genus);
     }
 
     getFESA() {
@@ -160,7 +167,7 @@ class Taxon {
     }
 
     getGenus() {
-        return Genera.getGenus(this.#genus);
+        return this.#genera.getGenus(this.#genus);
     }
 
     getGenusName() {
@@ -229,6 +236,10 @@ class Taxon {
         return this.#jepsonID;
     }
 
+    getLifeCycle() {
+        return this.#lifeCycle;
+    }
+
     getName() {
         return this.#name;
     }

package/lib/textutils.js

@@ -0,0 +1,10 @@
+class TextUtils {
+    /**
+     * @param {string} t
+     */
+    static ucFirst(t) {
+        return t[0].toUpperCase() + t.substring(1);
+    }
+}
+
+export { TextUtils };