@ca-plant-list/ca-plant-list 0.4.8 → 0.4.9

package/lib/ebook/plantbook.js

@@ -1,3 +1,4 @@
+import { ProgressMeter } from "../progressmeter.js";
 import { EBook } from "./ebook.js";
 import { EBookSiteGenerator } from "./ebooksitegenerator.js";
 import { GlossaryPages } from "./glossarypages.js";
@@ -10,153 +11,160 @@ import { TaxonPage } from "./pages/taxonpage.js";
 import { TOCPage } from "./pages/tocpage.js";
 
 class PlantBook extends EBook {
-  #taxa;
-  #glossary;
-  #images;
-
-  /**
-   * @param {string} outputDir
-   * @param {Config} config
-   * @param {Taxa} taxa
-   */
-  constructor(outputDir, config, taxa) {
-    super(
-      outputDir,
-      getRequiredConfigValue(config, "filename"),
-      getRequiredConfigValue(config, "pub_id"),
-      getRequiredConfigValue(config, "title")
-    );
-
-    this.#taxa = taxa;
-    const generator = new EBookSiteGenerator(this.getContentDir());
-    this.#glossary = new GlossaryPages(generator);
-    this.#images = new Images(generator, this.getContentDir(), taxa);
-  }
-
-  async createPages() {
-    const contentDir = this.getContentDir();
-
-    await this.#images.createImages();
-
-    console.log("creating taxon pages");
-    const taxonList = this.#taxa.getTaxonList();
-    for (const taxon of taxonList) {
-      const name = taxon.getName();
-      new TaxonPage(
-        contentDir,
-        taxon,
-        this.#images.getTaxonImages(name)
-      ).create();
+    #taxa;
+    #glossary;
+    #images;
+
+    /**
+     * @param {string} outputDir
+     * @param {Config} config
+     * @param {Taxa} taxa
+     */
+    constructor(outputDir, config, taxa) {
+        super(
+            outputDir,
+            getRequiredConfigValue(config, "filename"),
+            getRequiredConfigValue(config, "pub_id"),
+            getRequiredConfigValue(config, "title"),
+        );
+
+        this.#taxa = taxa;
+        const generator = new EBookSiteGenerator(this.getContentDir());
+        this.#glossary = new GlossaryPages(generator);
+        this.#images = new Images(generator, this.getContentDir(), taxa);
     }
 
-    // Create lists.
-    for (const color of this.#taxa.getFlowerColors()) {
-      new PageListFlowerColor(contentDir, color).create();
+    async createPages() {
+        const contentDir = this.getContentDir();
+
+        const taxonList = this.#taxa.getTaxonList();
+
+        await this.#images.createImages(taxonList);
+
+        const meter = new ProgressMeter(
+            "creating taxon pages",
+            taxonList.length,
+        );
+        for (let index = 0; index < taxonList.length; index++) {
+            const taxon = taxonList[index];
+            new TaxonPage(contentDir, taxon, this.#images).create();
+            meter.update(index + 1);
+        }
+        meter.stop();
+
+        // Create lists.
+        for (const color of this.#taxa.getFlowerColors()) {
+            new PageListFlowerColor(contentDir, color).create();
+        }
+
+        PageListFlowers.createPages(contentDir, this.#taxa);
+
+        new PageListFamilies(contentDir, this.#taxa.getFamilies()).create();
+        for (const family of this.#taxa.getFamilies().getFamilies()) {
+            const taxa = family.getTaxa();
+            if (!taxa) {
+                continue;
+            }
+            const name = family.getName();
+            new PageListSpecies(
+                contentDir,
+                taxa,
+                name + ".html",
+                name,
+            ).create();
+        }
+        new PageListSpecies(
+            contentDir,
+            taxonList,
+            "list_species.html",
+            "All Species",
+        ).create();
+
+        this.#glossary.renderPages();
+
+        new TOCPage(contentDir, this.#taxa).create();
     }
 
-    PageListFlowers.createPages(contentDir, this.#taxa);
-
-    new PageListFamilies(contentDir, this.#taxa.getFamilies()).create();
-    for (const family of this.#taxa.getFamilies().getFamilies()) {
-      const taxa = family.getTaxa();
-      if (!taxa) {
-        continue;
-      }
-      const name = family.getName();
-      new PageListSpecies(contentDir, taxa, name + ".html", name).create();
-    }
-    new PageListSpecies(
-      contentDir,
-      taxonList,
-      "list_species.html",
-      "All Species"
-    ).create();
-
-    this.#glossary.renderPages();
-
-    new TOCPage(contentDir, this.#taxa).create();
-  }
-
-  renderManifestEntries() {
-    let xml = "";
-
-    // Add lists.
-    xml +=
-      '<item id="lspecies" href="list_species.html" media-type="application/xhtml+xml" />';
-    xml +=
-      '<item id="lfamilies" href="list_families.html" media-type="application/xhtml+xml" />';
-    for (const color of this.#taxa.getFlowerColors()) {
-      xml +=
-        '<item id="l' +
-        color.getColorName() +
-        '" href="' +
-        color.getFileName() +
-        '" media-type="application/xhtml+xml" />';
+    renderManifestEntries() {
+        let xml = "";
+
+        // Add lists.
+        xml +=
+            '<item id="lspecies" href="list_species.html" media-type="application/xhtml+xml" />';
+        xml +=
+            '<item id="lfamilies" href="list_families.html" media-type="application/xhtml+xml" />';
+        for (const color of this.#taxa.getFlowerColors()) {
+            xml +=
+                '<item id="l' +
+                color.getColorName() +
+                '" href="' +
+                color.getFileName() +
+                '" media-type="application/xhtml+xml" />';
+        }
+
+        // Add family pages.
+        for (const family of this.#taxa.getFamilies().getFamilies()) {
+            const taxa = family.getTaxa();
+            if (!taxa) {
+                continue;
+            }
+            xml +=
+                '<item id="fam' +
+                family.getName() +
+                '" href="' +
+                family.getFileName() +
+                '" media-type="application/xhtml+xml" />';
+        }
+
+        // Add taxon pages.
+        const taxa = this.#taxa.getTaxonList();
+        for (let index = 0; index < taxa.length; index++) {
+            const taxon = taxa[index];
+            xml +=
+                '<item id="t' +
+                index +
+                '" href="' +
+                taxon.getFileName() +
+                '" media-type="application/xhtml+xml" />';
+        }
+
+        xml += PageListFlowers.getManifestEntries();
+        xml += this.#glossary.getManifestEntries();
+        xml += this.#images.getManifestEntries();
+
+        return xml;
     }
 
-    // Add family pages.
-    for (const family of this.#taxa.getFamilies().getFamilies()) {
-      const taxa = family.getTaxa();
-      if (!taxa) {
-        continue;
-      }
-      xml +=
-        '<item id="fam' +
-        family.getName() +
-        '" href="' +
-        family.getFileName() +
-        '" media-type="application/xhtml+xml" />';
-    }
+    renderSpineElements() {
+        let xml = "";
 
-    // Add taxon pages.
-    const taxa = this.#taxa.getTaxonList();
-    for (let index = 0; index < taxa.length; index++) {
-      const taxon = taxa[index];
-      xml +=
-        '<item id="t' +
-        index +
-        '" href="' +
-        taxon.getFileName() +
-        '" media-type="application/xhtml+xml" />';
-    }
+        // Add lists.
+        for (const color of this.#taxa.getFlowerColors()) {
+            xml += '<itemref idref="l' + color.getColorName() + '"/>';
+        }
+        xml += PageListFlowers.getSpineEntries();
 
-    xml += PageListFlowers.getManifestEntries();
-    xml += this.#glossary.getManifestEntries();
-    xml += this.#images.getManifestEntries();
+        xml += '<itemref idref="lfamilies"/>';
+        xml += '<itemref idref="lspecies"/>';
 
-    return xml;
-  }
+        // Add families.
+        for (const family of this.#taxa.getFamilies().getFamilies()) {
+            const taxa = family.getTaxa();
+            if (!taxa) {
+                continue;
+            }
+            xml += '<itemref idref="fam' + family.getName() + '"/>';
+        }
 
-  renderSpineElements() {
-    let xml = "";
+        // Add taxa.
+        for (let index = 0; index < this.#taxa.getTaxonList().length; index++) {
+            xml += '<itemref idref="t' + index + '"/>';
+        }
 
-    // Add lists.
-    for (const color of this.#taxa.getFlowerColors()) {
-      xml += '<itemref idref="l' + color.getColorName() + '"/>';
-    }
-    xml += PageListFlowers.getSpineEntries();
-
-    xml += '<itemref idref="lfamilies"/>';
-    xml += '<itemref idref="lspecies"/>';
-
-    // Add families.
-    for (const family of this.#taxa.getFamilies().getFamilies()) {
-      const taxa = family.getTaxa();
-      if (!taxa) {
-        continue;
-      }
-      xml += '<itemref idref="fam' + family.getName() + '"/>';
-    }
+        xml += this.#glossary.getSpineEntries();
 
-    // Add taxa.
-    for (let index = 0; index < this.#taxa.getTaxonList().length; index++) {
-      xml += '<itemref idref="t' + index + '"/>';
+        return xml;
     }
-
-    xml += this.#glossary.getSpineEntries();
-
-    return xml;
-  }
 }
 
 /**
@@ -165,11 +173,11 @@ class PlantBook extends EBook {
  * @returns {string}
  */
 function getRequiredConfigValue(config, name) {
-  const value = config.getConfigValue("ebook", name);
-  if (value === undefined) {
-    throw new Error(`Failed to find ebook config for ${name}`);
-  }
-  return value;
+    const value = config.getConfigValue("ebook", name);
+    if (value === undefined) {
+        throw new Error(`Failed to find ebook config for ${name}`);
+    }
+    return value;
 }
 
 export { PlantBook };

package/lib/htmltaxon.js

@@ -7,141 +7,148 @@ import { TextUtils } from "./textutils.js";
  * @type {Record<string,{title:string,data:function (Taxon):string}>}
  */
 const TAXA_LIST_COLS = {
-  CESA: {
-    title: "California",
-    data: (t) => RarePlants.getCESADescription(t.getCESA()),
-  },
-  COMMON_NAME: {
-    title: "Common Name",
-    data: (t) => t.getCommonNames().join(", "),
-  },
-  CNPS_RANK: {
-    title: "CNPS Rank",
-    data: (t) =>
-      HTML.getToolTip(
-        HTML.textElement("span", t.getRPIRankAndThreat()),
-        t.getRPIRankAndThreatTooltip()
-      ),
-  },
-  FESA: {
-    title: "Federal",
-    data: (t) => RarePlants.getFESADescription(t.getFESA()),
-  },
-  SPECIES: {
-    title: "Species",
-    data: (t) => t.getHTMLLink(true, true),
-  },
-  SPECIES_BARE: {
-    title: "Species",
-    data: (t) => t.getHTMLLink(true, false),
-  },
+    CESA: {
+        title: "California",
+        data: (t) => RarePlants.getCESADescription(t.getCESA()),
+    },
+    COMMON_NAME: {
+        title: "Common Name",
+        data: (t) => t.getCommonNames().join(", "),
+    },
+    CNPS_RANK: {
+        title: "CNPS Rank",
+        data: (t) =>
+            HTML.getToolTip(
+                HTML.textElement("span", t.getRPIRankAndThreat()),
+                t.getRPIRankAndThreatTooltip(),
+            ),
+    },
+    FESA: {
+        title: "Federal",
+        data: (t) => RarePlants.getFESADescription(t.getFESA()),
+    },
+    SPECIES: {
+        title: "Species",
+        data: (t) => t.getHTMLLink(true, true),
+    },
+    SPECIES_BARE: {
+        title: "Species",
+        data: (t) => t.getHTMLLink(true, false),
+    },
 };
 
 const DEFAULT_TAXA_COLUMNS = [
-  TAXA_LIST_COLS.SPECIES,
-  TAXA_LIST_COLS.COMMON_NAME,
+    TAXA_LIST_COLS.SPECIES,
+    TAXA_LIST_COLS.COMMON_NAME,
 ];
 
 class HTMLTaxon {
-  /**
-   * @param {string[]|undefined} colors
-   */
-  static getFlowerColors(colors, includeColorLink = true) {
-    let html = "";
-    if (colors) {
-      for (const color of colors) {
-        const img = HTML.textElement("img", "", {
-          src: "./i/f-" + color + ".svg",
-          alt: color + " flowers",
-          title: color,
-          class: "flr-color",
-        });
-        if (includeColorLink) {
-          html += HTML.wrap("a", img, {
-            href: "./list_fc_" + color + ".html",
-          });
-        } else {
-          html += img;
+    /**
+     * @param {string[]|undefined} colors
+     */
+    static getFlowerColors(colors, includeColorLink = true) {
+        let html = "";
+        if (colors) {
+            for (const color of colors) {
+                const img = HTML.textElement("img", "", {
+                    src: "./i/f-" + color + ".svg",
+                    alt: color + " flowers",
+                    title: color,
+                    class: "flr-color",
+                });
+                if (includeColorLink) {
+                    html += HTML.wrap("a", img, {
+                        href: "./list_fc_" + color + ".html",
+                    });
+                } else {
+                    html += img;
+                }
+            }
         }
-      }
+        return html;
     }
-    return html;
-  }
 
-  /**
-   * @param {Taxon} taxon
-   * @param {string} classNames
-   * @param {boolean} [includeColorLink=true]
-   */
-  static getFlowerInfo(taxon, classNames = "section", includeColorLink = true) {
-    const lifeCycle = taxon.getLifeCycle();
-    const colors = taxon.getFlowerColors();
-    const monthStart = taxon.getBloomStart();
-    const monthEnd = taxon.getBloomEnd();
+    /**
+     * @param {Taxon} taxon
+     * @param {string} classNames
+     * @param {boolean} [includeColorLink=true]
+     */
+    static getFlowerInfo(
+        taxon,
+        classNames = "section",
+        includeColorLink = true,
+    ) {
+        const lifeCycle = taxon.getLifeCycle();
+        const colors = taxon.getFlowerColors();
+        const monthStart = taxon.getBloomStart();
+        const monthEnd = taxon.getBloomEnd();
 
-    const parts = [];
-    if (lifeCycle) {
-      const text = HTML.wrap("span", TextUtils.ucFirst(lifeCycle), "lc") + ".";
-      parts.push(HTML.wrap("span", text, "lcs"));
+        const parts = [];
+        if (lifeCycle) {
+            const text =
+                HTML.wrap("span", TextUtils.ucFirst(lifeCycle), "lc") + ".";
+            parts.push(HTML.wrap("span", text, "lcs"));
+        }
+
+        if (colors || monthStart) {
+            let html = "Flowers: ";
+            html += this.getFlowerColors(colors, includeColorLink);
+            if (monthStart && monthEnd) {
+                html += HTML.wrap(
+                    "span",
+                    DateUtils.getMonthName(monthStart) +
+                        "-" +
+                        DateUtils.getMonthName(monthEnd),
+                    { class: "flr-time" },
+                );
+            }
+            parts.push(HTML.wrap("span", html));
+        }
+        return parts.length === 0
+            ? ""
+            : HTML.wrap("div", parts.join(""), { class: classNames });
     }
 
-    if (colors || monthStart) {
-      let html = "Flowers: ";
-      html += this.getFlowerColors(colors, includeColorLink);
-      if (monthStart && monthEnd) {
-        html += HTML.wrap(
-          "span",
-          DateUtils.getMonthName(monthStart) +
-            "-" +
-            DateUtils.getMonthName(monthEnd),
-          { class: "flr-time" }
+    /**
+     * @param {Taxon} taxon
+     */
+    static getLink(taxon) {
+        return (
+            HTML.getLink(taxon.getFileName(), taxon.getName()) +
+            this.getFlowerColors(taxon.getFlowerColors())
         );
-      }
-      parts.push(HTML.wrap("span", html));
     }
-    return HTML.wrap("div", parts.join(""), { class: classNames });
-  }
 
-  /**
-   * @param {Taxon} taxon
-   */
-  static getLink(taxon) {
-    return (
-      HTML.getLink(taxon.getFileName(), taxon.getName()) +
-      this.getFlowerColors(taxon.getFlowerColors())
-    );
-  }
-
-  /**
-   * @param {Taxon[]} taxa
-   * @param {TaxaCol[]} [columns]
-   */
-  static getTaxaTable(taxa, columns = DEFAULT_TAXA_COLUMNS) {
-    let html = "<table><thead>";
-    for (const col of columns) {
-      const className = col.class;
-      const atts = className !== undefined ? className : {};
-      html += HTML.textElement("th", col.title, atts);
-    }
-    html += "</thead>";
-    html += "<tbody>";
+    /**
+     * @param {Taxon[]} taxa
+     * @param {TaxaCol[]} [columns]
+     */
+    static getTaxaTable(taxa, columns = DEFAULT_TAXA_COLUMNS) {
+        let html = "<table><thead>";
+        for (const col of columns) {
+            const className = col.class;
+            const atts = className !== undefined ? className : {};
+            html += HTML.textElement("th", col.title, atts);
+        }
+        html += "</thead>";
+        html += "<tbody>";
 
-    for (const taxon of taxa) {
-      html += "<tr>";
-      for (const col of columns) {
-        const data = col.data(taxon);
-        const className = col.class;
-        const atts = className !== undefined ? className : {};
-        html += HTML.wrap("td", data, atts);
-      }
-      html += "</tr>";
-    }
+        for (const taxon of taxa) {
+            html += "<tr>";
+            for (const col of columns) {
+                const data = col.data(taxon);
+                const className = col.class;
+                const atts = className !== undefined ? className : {};
+                html += HTML.wrap("td", data, atts);
+            }
+            html += "</tr>";
+        }
 
-    html += "</tbody>";
-    html += "</table>";
+        html += "</tbody>";
+        html += "</table>";
 
-    return html;
-  }
+        return html;
+    }
 }
 
 export { HTMLTaxon, TAXA_LIST_COLS };

package/lib/inat_photo.js

@@ -1,10 +1,4 @@
-import {
-    CC0,
-    CC_BY,
-    CC_BY_NC,
-    COPYRIGHT,
-    Photo,
-} from "./photo.js";
+import { CC0, CC_BY, CC_BY_NC, COPYRIGHT, Photo } from "./photo.js";
 
 class InatPhoto extends Photo {
     /** @type {number} */
@@ -18,17 +12,25 @@ class InatPhoto extends Photo {
      * @param {InatLicenseCode} licenseCode
      * @param {string} attrName
      */
-    constructor( id, ext, licenseCode, attrName ) {
+    constructor(id, ext, licenseCode, attrName) {
         /** @type {typeof COPYRIGHT | typeof CC_BY | typeof CC_BY_NC | typeof CC0} */
         let rights = COPYRIGHT;
-        if ( licenseCode === "cc0" ) rights = CC0;
-        else if ( licenseCode === "cc-by" ) rights = CC_BY;
-        else if ( licenseCode === "cc-by-nc" ) rights = CC_BY_NC;
-        super( null, attrName, rights );
+        if (licenseCode === "cc0") rights = CC0;
+        else if (licenseCode === "cc-by") rights = CC_BY;
+        else if (licenseCode === "cc-by-nc") rights = CC_BY_NC;
+        super(null, attrName, rights);
         this.inatPhotoId = id;
         this.ext = ext;
     }
 
+    getExt() {
+        return this.ext;
+    }
+
+    getId() {
+        return this.inatPhotoId;
+    }
+
     getUrl() {
         return `https://inaturalist-open-data.s3.amazonaws.com/photos/${this.inatPhotoId}/medium.${this.ext}`;
     }
@@ -38,6 +40,4 @@ class InatPhoto extends Photo {
     }
 }
 
-export {
-    InatPhoto
-};
+export { InatPhoto };

package/lib/progressmeter.js

@@ -0,0 +1,29 @@
+import cliProgress from "cli-progress";
+
+export class ProgressMeter {
+    #meter;
+
+    /**
+     * @param {string} label
+     * @param {number} total
+     */
+    constructor(label, total) {
+        this.#meter = new cliProgress.SingleBar({
+            format: `${label} {percentage}% | {value}/{total}{custom}`,
+            hideCursor: true,
+        });
+        this.#meter.start(total, 0, { custom: "" });
+    }
+
+    stop() {
+        this.#meter.stop();
+    }
+
+    /**
+     * @param {number} current
+     * @param {{ custom: string; }} [custom={ custom: "" }]
+     */
+    update(current, custom = { custom: "" }) {
+        this.#meter.update(current, custom);
+    }
+}