wiki-plugin-mech 0.1.1

package/ReadMe.md

@@ -0,0 +1,13 @@
+# Federated Wiki - Mech Plugin
+
+This plugin, type: mech, extends the markup of the federated wiki.
+
+## Build
+
+    npm install
+    grunt build
+
+## License
+
+MIT
+

package/client/mech.js

@@ -0,0 +1,120 @@
+
+(function() {
+
+  function expand(text) {
+    return text
+      .replace(/&/g, '&')
+      .replace(/</g, '&lt;')
+      .replace(/>/g, '&gt;')
+      .replace(/\*(.+?)\*/g, '<i>$1</i>')
+  }
+
+ // https://github.com/dobbs/wiki-plugin-graphviz/blob/main/client/graphviz.js#L86-L103
+  function tree(lines, here, indent) {
+    while (lines.length) {
+      let m = lines[0].match(/( *)(.*)/)
+      let spaces = m[1].length
+      let command = m[2]
+      if (spaces == indent) {
+        here.push({command})
+        lines.shift()
+      } else if (spaces > indent) {
+        var more = []
+        here.push(more)
+        tree(lines, more, spaces)
+      } else {
+        return here
+      }
+    }
+    return here
+  }
+
+  function format(nest,index) {
+    const unique = Math.floor(Math.random()*1000000)
+    const block = (more,path) => {
+      const html = []
+      for (part of more) {
+        const key = `${unique}.${path.join('.')}`
+        index[key] = part
+        part.key = key
+        if(part.command)
+          html.push(`<span id=${key}>${expand(part.command)}</span>`)
+        else
+          html.push(`<div id=${key} style="padding-left:15px">${block(part,[...path,0])}</div>  `)
+        path[path.length-1]++
+      }
+      return html.join("<br>\n")
+    }
+    return block(nest,[0])
+  }
+
+  function click_emit (elem) {
+    const body = this
+    console.log({body,elem})
+    if (!body.length && !elem.innerHTML.match(/button/)) {
+      console.log('trouble')
+      elem.innerHTML += '<button style="border-width:0;color:red;" title="nothing to run">✖︎</button>'
+    } else
+    if (!elem.innerHTML.match(/button/)) {
+      elem.innerHTML += '<button style="border-width:0;">◉</button>'
+      elem.querySelector('button').addEventListener('click',event => run(this))
+    }
+  }
+
+  function click_bind (elem) {
+  }  
+
+  function hello_emit (elem,what) {
+    const want = what == 'world' ? ' 🌎' : ' 😀'
+    elem.innerHTML += want
+  }
+
+  function hello_bind (elem) {
+  }
+
+  const blocks = {
+    CLICK: {emit:click_emit, bind:click_bind},
+    HELLO: {emit:hello_emit, bind:hello_bind}
+  }
+
+  function run (nest) {
+    console.log({nest})
+    const scope = nest.slice()
+    while (scope.length) {
+      const code = scope.shift()
+      if (code.command) {
+        const elem = document.getElementById(code.key)
+        const [op, ...args] = code.command.split(/ +/)
+        const more = scope[0]?.command ? null : scope.shift()
+        console.log({op,args,more})
+        blocks[op].emit.apply(more||[],[elem,...args])        
+      } else {
+        run(code)
+      }
+    }
+  }
+
+  function emit($item, item) {
+    const lines = item.text.split(/\n/)
+    const nest = tree(lines,[],0)
+    const index = {}
+    const html = format(nest,index)
+    $item.append(`<div style="background-color:#eee;padding:15px;border-top:8px;">${html}</div>`)
+    run(nest,index)
+  }
+
+  function bind($item, item) {
+    return $item.dblclick(() => {
+      return wiki.textEditor($item, item);
+    })
+  }
+
+  if (typeof window !== "undefined" && window !== null) {
+    window.plugins.mech = {emit, bind}
+  }
+
+  if (typeof module !== "undefined" && module !== null) {
+    module.exports = {expand}
+  }
+
+}).call(this)

package/factory.json

@@ -0,0 +1,5 @@
+{
+  "name": "Mech",
+  "title": "Mech Plugin",
+  "category": "other"
+}

package/package.json

@@ -0,0 +1,42 @@
+{
+  "name": "wiki-plugin-mech",
+  "version": "0.1.1",
+  "description": "Federated Wiki - Mechanism Scripting Plugin",
+  "keywords": [
+    "mech",
+    "mechansim",
+    "scripting",
+    "wiki",
+    "federated wiki",
+    "plugin"
+  ],
+  "author": {
+    "name": "Ward Cunningham",
+    "email": "ward@c2.com",
+    "url": "https://c2.com/ward"
+  },
+  "contributors": [],
+  "scripts": {
+    "test": "mocha"
+  },
+  "devDependencies": {
+    "expect.js": "^0.3.1",
+    "grunt": "^1.0.1",
+    "grunt-contrib-coffee": "^2.0.0",
+    "grunt-contrib-watch": "^1.0.0",
+    "grunt-git-authors": "^3.2.0",
+    "grunt-mocha-test": "^0.13.2",
+    "mocha": "^5.2.0"
+  },
+  "license": "MIT",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/wardcunningham/wiki-plugin-mech.git"
+  },
+  "bugs": {
+    "url": "https://github.com/wardcunningham/wiki-plugin-mech/issues"
+  },
+  "engines": {
+    "node": ">=0.10"
+  }
+}

package/pages/about-mech-plugin

@@ -0,0 +1,325 @@
+{
+  "title": "About Mech Plugin",
+  "story": [
+    {
+      "type": "paragraph",
+      "id": "�3���82�962�����",
+      "text": "The Mech plugin allows one to script interactive mechanisms in the style of block languages like Squeak. We use capitalized keywords for blocks and indent them with spaces to show where blocks nest within others."
+    },
+    {
+      "type": "paragraph",
+      "id": "aadc413ae00c5c37",
+      "text": "Say \"HELLO\" for a friendly greating."
+    },
+    {
+      "type": "mech",
+      "id": "7d0dcd7919c2f899",
+      "text": "HELLO",
+      "alias": "7�b2����ef9�27ac"
+    },
+    {
+      "type": "paragraph",
+      "id": "567acaf3531aa3ea",
+      "text": "Say \"HELLO world\" to great the whole world."
+    },
+    {
+      "type": "mech",
+      "id": "7�b2����ef9�27ac",
+      "text": "HELLO world"
+    },
+    {
+      "type": "paragraph",
+      "id": "9e56be61e4552e9a",
+      "text": "Say \"CLICK\" to run indented commands only when clicked."
+    },
+    {
+      "type": "mech",
+      "id": "0223ec356575839a",
+      "text": "CLICK\n  HELLO\n  HELLO world",
+      "alias": "7�b2����ef9�27ac"
+    },
+    {
+      "type": "paragraph",
+      "id": "0da4de7b855c9a0d",
+      "text": "CLICK expects to be followed with indented commands and will complain if it doesn't find any."
+    },
+    {
+      "type": "mech",
+      "id": "9a40751dd94dfb43",
+      "text": "CLICK\nHELLO",
+      "alias": "7�b2����ef9�27ac"
+    },
+    {
+      "type": "paragraph",
+      "id": "d22aa70fbdde7da0",
+      "text": "See the [[Catalog of Mech Blocks]] for more ideas."
+    }
+  ],
+  "journal": [
+    {
+      "type": "create",
+      "item": {
+        "title": "About Mech Plugin",
+        "story": [
+          {
+            "type": "paragraph",
+            "id": "�3���82�962�����",
+            "text": "Here we describe the purpose of the plugin and include a sample."
+          },
+          {
+            "type": "mech",
+            "id": "7�b2����ef9�27ac",
+            "text": "This is text in the new plugin. You can *double-click* to edit it too."
+          }
+        ]
+      },
+      "date": 1716488666000,
+      "certificate": "from mkplugin.sh"
+    },
+    {
+      "type": "edit",
+      "id": "7�b2����ef9�27ac",
+      "item": {
+        "type": "mech",
+        "id": "7�b2����ef9�27ac",
+        "text": "HELLO"
+      },
+      "date": 1716683838652
+    },
+    {
+      "type": "edit",
+      "id": "�3���82�962�����",
+      "item": {
+        "type": "paragraph",
+        "id": "�3���82�962�����",
+        "text": "The Mech plugin allows one to script interactive mechanisms in the style of block languages like Squeak. We use capitalized keywords for blocks and indent them with spaces to show where blocks nest within others."
+      },
+      "date": 1716684272077
+    },
+    {
+      "type": "add",
+      "id": "d22aa70fbdde7da0",
+      "item": {
+        "type": "paragraph",
+        "id": "d22aa70fbdde7da0",
+        "text": "See the [[Catalog of Mech Blocks]]"
+      },
+      "after": "�3���82�962�����",
+      "date": 1716684321178
+    },
+    {
+      "type": "edit",
+      "id": "d22aa70fbdde7da0",
+      "item": {
+        "type": "paragraph",
+        "id": "d22aa70fbdde7da0",
+        "text": "See the [[Catalog of Mech Blocks]] for more ideas."
+      },
+      "date": 1716684349332
+    },
+    {
+      "type": "add",
+      "id": "aadc413ae00c5c37",
+      "item": {
+        "type": "paragraph",
+        "id": "aadc413ae00c5c37",
+        "text": "Say HELLO for a friendly greating."
+      },
+      "after": "�3���82�962�����",
+      "date": 1716684398273
+    },
+    {
+      "id": "7d0dcd7919c2f899",
+      "type": "add",
+      "item": {
+        "type": "mech",
+        "id": "7d0dcd7919c2f899",
+        "text": "HELLO",
+        "alias": "7�b2����ef9�27ac"
+      },
+      "after": "aadc413ae00c5c37",
+      "date": 1716684414784
+    },
+    {
+      "item": {
+        "type": "factory",
+        "id": "567acaf3531aa3ea"
+      },
+      "id": "567acaf3531aa3ea",
+      "type": "add",
+      "after": "7�b2����ef9�27ac",
+      "date": 1716684474280
+    },
+    {
+      "type": "edit",
+      "id": "567acaf3531aa3ea",
+      "item": {
+        "type": "paragraph",
+        "id": "567acaf3531aa3ea",
+        "text": "Say HELLO world to great the whole world."
+      },
+      "date": 1716684507788
+    },
+    {
+      "id": "7�b2����ef9�27ac",
+      "type": "move",
+      "order": [
+        "�3���82�962�����",
+        "aadc413ae00c5c37",
+        "7d0dcd7919c2f899",
+        "d22aa70fbdde7da0",
+        "567acaf3531aa3ea",
+        "7�b2����ef9�27ac"
+      ],
+      "date": 1716684514976
+    },
+    {
+      "type": "edit",
+      "id": "7�b2����ef9�27ac",
+      "item": {
+        "type": "mech",
+        "id": "7�b2����ef9�27ac",
+        "text": "HELLO world"
+      },
+      "date": 1716684519493
+    },
+    {
+      "type": "edit",
+      "id": "aadc413ae00c5c37",
+      "item": {
+        "type": "paragraph",
+        "id": "aadc413ae00c5c37",
+        "text": "Say \"HELLO\" for a friendly greating."
+      },
+      "date": 1716684535093
+    },
+    {
+      "type": "edit",
+      "id": "567acaf3531aa3ea",
+      "item": {
+        "type": "paragraph",
+        "id": "567acaf3531aa3ea",
+        "text": "Say \"HELLO world\" to great the whole world."
+      },
+      "date": 1716684544028
+    },
+    {
+      "item": {
+        "type": "factory",
+        "id": "9e56be61e4552e9a"
+      },
+      "id": "9e56be61e4552e9a",
+      "type": "add",
+      "after": "7�b2����ef9�27ac",
+      "date": 1716684568232
+    },
+    {
+      "type": "edit",
+      "id": "9e56be61e4552e9a",
+      "item": {
+        "type": "paragraph",
+        "id": "9e56be61e4552e9a",
+        "text": "Say \"CLICK\" to run indented commands only when clicked."
+      },
+      "date": 1716684595412
+    },
+    {
+      "id": "0223ec356575839a",
+      "type": "add",
+      "item": {
+        "type": "mech",
+        "id": "0223ec356575839a",
+        "text": "HELLO",
+        "alias": "7�b2����ef9�27ac"
+      },
+      "after": "9e56be61e4552e9a",
+      "date": 1716684601922
+    },
+    {
+      "type": "edit",
+      "id": "0223ec356575839a",
+      "item": {
+        "type": "mech",
+        "id": "0223ec356575839a",
+        "text": "CLICK\n  HELLO\n  HELLO world",
+        "alias": "7�b2����ef9�27ac"
+      },
+      "date": 1716684627691
+    },
+    {
+      "id": "d22aa70fbdde7da0",
+      "type": "move",
+      "order": [
+        "�3���82�962�����",
+        "aadc413ae00c5c37",
+        "7d0dcd7919c2f899",
+        "567acaf3531aa3ea",
+        "7�b2����ef9�27ac",
+        "9e56be61e4552e9a",
+        "0223ec356575839a",
+        "d22aa70fbdde7da0"
+      ],
+      "date": 1716684663443
+    },
+    {
+      "type": "add",
+      "id": "0da4de7b855c9a0d",
+      "item": {
+        "type": "paragraph",
+        "id": "0da4de7b855c9a0d",
+        "text": "CLICK expects to be followed with indented commands and will complain if it doesn't find any. Hover for the error message."
+      },
+      "after": "9e56be61e4552e9a",
+      "date": 1716684726522
+    },
+    {
+      "type": "edit",
+      "id": "0da4de7b855c9a0d",
+      "item": {
+        "type": "paragraph",
+        "id": "0da4de7b855c9a0d",
+        "text": "CLICK expects to be followed with indented commands and will complain if it doesn't find any."
+      },
+      "date": 1716684736166
+    },
+    {
+      "id": "0da4de7b855c9a0d",
+      "type": "move",
+      "order": [
+        "�3���82�962�����",
+        "aadc413ae00c5c37",
+        "7d0dcd7919c2f899",
+        "567acaf3531aa3ea",
+        "7�b2����ef9�27ac",
+        "9e56be61e4552e9a",
+        "0223ec356575839a",
+        "0da4de7b855c9a0d",
+        "d22aa70fbdde7da0"
+      ],
+      "date": 1716684740993
+    },
+    {
+      "id": "9a40751dd94dfb43",
+      "type": "add",
+      "item": {
+        "type": "mech",
+        "id": "9a40751dd94dfb43",
+        "text": "HELLO",
+        "alias": "7�b2����ef9�27ac"
+      },
+      "after": "0da4de7b855c9a0d",
+      "date": 1716684744388
+    },
+    {
+      "type": "edit",
+      "id": "9a40751dd94dfb43",
+      "item": {
+        "type": "mech",
+        "id": "9a40751dd94dfb43",
+        "text": "CLICK\nHELLO",
+        "alias": "7�b2����ef9�27ac"
+      },
+      "date": 1716684753588
+    }
+  ]
+}

package/pages/catalog-of-mech-blocks

@@ -0,0 +1,55 @@
+{
+  "title": "Catalog of Mech Blocks",
+  "story": [
+    {
+      "type": "paragraph",
+      "id": "2802ed0bdf73bd98",
+      "text": "Our work here is just beginning."
+    },
+    {
+      "type": "paragraph",
+      "id": "fc6c61ba9968734b",
+      "text": "There are no more blocks yet other than CLICK and HELLO."
+    }
+  ],
+  "journal": [
+    {
+      "type": "create",
+      "item": {
+        "title": "Catalog of Mech Blocks",
+        "story": []
+      },
+      "date": 1716684800514
+    },
+    {
+      "item": {
+        "type": "factory",
+        "id": "2802ed0bdf73bd98"
+      },
+      "id": "2802ed0bdf73bd98",
+      "type": "add",
+      "date": 1716684802651
+    },
+    {
+      "type": "edit",
+      "id": "2802ed0bdf73bd98",
+      "item": {
+        "type": "paragraph",
+        "id": "2802ed0bdf73bd98",
+        "text": "Our work here is just beginning."
+      },
+      "date": 1716684821373
+    },
+    {
+      "type": "add",
+      "id": "fc6c61ba9968734b",
+      "item": {
+        "type": "paragraph",
+        "id": "fc6c61ba9968734b",
+        "text": "There are no more blocks yet other than CLICK and HELLO."
+      },
+      "after": "2802ed0bdf73bd98",
+      "date": 1716684839583
+    }
+  ]
+}

package/server/server.js

@@ -0,0 +1,17 @@
+// mech plugin, server-side component
+// These handlers are launched with the wiki server.
+
+(function() {
+  function startServer(params) {
+    var app = params.app,
+        argv = params.argv
+
+    return app.get('/plugin/mech/:thing', (req, res) => {
+      var thing = req.params.thing;
+      return res.json({thing});
+    })
+  }
+
+  module.exports = {startServer}
+
+}).call(this)