feat(plugin-macro): Ported bannerbox to latest approach

plugins/plugin-annotations/src/bannerbox.mjs

@@ -1,37 +1,110 @@
-// Export macros
-export const bannerboxMacros = {
-  bannerbox: function (so, { Point, paths, Path, getId, macro }) {
-    // Spread so settings into defaults
-    so = {
-      topLeft: new Point(0, 0),
-      bottomRight: new Point(100, 100),
-      text: '',
-      margin: 15,
-      textClassName: 'text-xs fill-note',
-      boxClassName: 'stroke-xs stroke-note lashed',
-      dy: 4,
-      spaces: 12,
-      repeat: 99,
-      ...so,
-    }
-    const offset = Math.sqrt(2 * Math.pow(so.margin, 2))
-    const id = getId()
-    paths[id] = new Path()
-      .move(so.topLeft.shift(135, offset))
-      .line(new Point(so.bottomRight.x, so.topLeft.y).shift(45, offset))
-      .line(so.bottomRight.shift(315, offset))
-      .line(new Point(so.topLeft.x, so.bottomRight.y).shift(225, offset))
-      .line(so.topLeft.shift(135, offset))
-      .close()
-      .addClass(so.boxClassName)
-
-    macro('banner', {
-      path: paths[id],
-      text: so.text,
-      className: so.textClassName,
-      repeat: so.repeat,
-      spaces: so.spaces,
-      dy: so.dy,
-    })
+/*
+ * Defaults for the bannerbox macro
+ */
+const macroDefaults = {
+  classes: {
+    text: 'text-xs fill-note',
+    box: 'stroke-xs stroke-note lashed',
   },
+  dy: 4,
+  id: 'bannerbox',
+  margin: 15,
+  repeat: 99,
+  spaces: 12,
+  text: '',
 }
+
+/*
+ * Helper method to get the various IDs for points added by this macro
+ */
+const getIds = (id) => ({
+  box: `__macro_bannerbox_${id}_box`,
+})
+
+/*
+ * Removing all this is easy as all IDs are available in the store
+ * and all we need to remove are paths.
+ */
+const rmbannerbox = function (id = macroDefaults.id, { paths, store, part }) {
+  for (const pid of Object.values(
+    store.get(['parts', part.name, 'macros', 'bannerbox', 'ids', id, 'paths'], {})
+  ))
+    delete paths[pid]
+}
+
+/*
+ * The bannerbox macro
+ */
+const bannerbox = function (config, { Point, paths, Path, part, macro, log, store, complete }) {
+  /*
+   * Don't add a title when complete is false, unless force is true
+   */
+  if (!complete && !config.force) return
+
+  /*
+   * Merge macro defaults with user-provided config to create the macro config (mc)
+   */
+  const mc = {
+    ...macroDefaults,
+    ...config,
+    classes: macroDefaults.classes,
+  }
+  if (config.classes) mc.classes = { ...mc.classes, ...config.classes }
+
+  /*
+   * Make sure mc.topLeft and mc.bottomRight are Point instances
+   */
+  if (!mc.topLeft || typeof mc.topLeft.attr !== 'function') {
+    log.warn(`Bannerbox macro called without a valid topLeft point. Using (0,0) for topLeft.`)
+    mc.topLeft = new Point(0, 0)
+  }
+  if (!mc.topRight || typeof mc.bottomRight.attr !== 'function') {
+    log.warn(
+      `Bannerbox macro called without a valid bottomRight point. Using (6660,666) for bottomRight.`
+    )
+    mc.bottomRight = new Point(666, 666)
+  }
+
+  /*
+   * Get the list of IDs
+   * Initialize the verticle cadence
+   */
+  const ids = getIds(mc.id)
+
+  /*
+   * Calculate the offset from the bounding box
+   */
+  const offset = Math.sqrt(2 * Math.pow(mc.margin, 2))
+
+  /*
+   * Bannerbox: box
+   */
+  paths[ids.box] = new Path()
+    .move(mc.topLeft.shift(135, offset))
+    .line(new Point(mc.bottomRight.x, mc.topLeft.y).shift(45, offset))
+    .line(mc.bottomRight.shift(315, offset))
+    .line(new Point(mc.topLeft.x, mc.bottomRight.y).shift(225, offset))
+    .line(mc.topLeft.shift(135, offset))
+    .close()
+    .addClass(mc.classes.box)
+
+  /*
+   * Call the banner macro on the box
+   */
+  macro('banner', {
+    id: mc.id,
+    path: paths[ids.box],
+    text: mc.text,
+    className: mc.classes.text,
+    repeat: mc.repeat,
+    spaces: mc.spaces,
+    dy: mc.dy,
+  })
+
+  /*
+   * Store all IDs in the store so we can remove this macro with rmtitle
+   */
+  store.set(['parts', part.name, 'macros', 'bannerbox', 'ids', mc.id, 'paths'], ids)
+}
+
+export const bannerboxMacros = { bannerbox, rmbannerbox }