feat: initial commit

Author: andreaspitzer

.gitignore

@@ -0,0 +1,104 @@
+# Logs
+logs
+*.log
+npm-debug.log*
+yarn-debug.log*
+yarn-error.log*
+lerna-debug.log*
+
+# Diagnostic reports (https://nodejs.org/api/report.html)
+report.[0-9]*.[0-9]*.[0-9]*.[0-9]*.json
+
+# Runtime data
+pids
+*.pid
+*.seed
+*.pid.lock
+
+# Directory for instrumented libs generated by jscoverage/JSCover
+lib-cov
+
+# Coverage directory used by tools like istanbul
+coverage
+*.lcov
+
+# nyc test coverage
+.nyc_output
+
+# Grunt intermediate storage (https://gruntjs.com/creating-plugins#storing-task-files)
+.grunt
+
+# Bower dependency directory (https://bower.io/)
+bower_components
+
+# node-waf configuration
+.lock-wscript
+
+# Compiled binary addons (https://nodejs.org/api/addons.html)
+build/Release
+
+# Dependency directories
+node_modules/
+jspm_packages/
+
+# TypeScript v1 declaration files
+typings/
+
+# TypeScript cache
+*.tsbuildinfo
+
+# Optional npm cache directory
+.npm
+
+# Optional eslint cache
+.eslintcache
+
+# Microbundle cache
+.rpt2_cache/
+.rts2_cache_cjs/
+.rts2_cache_es/
+.rts2_cache_umd/
+
+# Optional REPL history
+.node_repl_history
+
+# Output of 'npm pack'
+*.tgz
+
+# Yarn Integrity file
+.yarn-integrity
+
+# dotenv environment variables file
+.env
+.env.test
+
+# parcel-bundler cache (https://parceljs.org/)
+.cache
+
+# Next.js build output
+.next
+
+# Nuxt.js build / generate output
+.nuxt
+dist
+
+# Gatsby files
+.cache/
+# Comment in the public line in if your project uses Gatsby and *not* Next.js
+# https://nextjs.org/blog/next-9-1#public-directory-support
+# public
+
+# vuepress build output
+.vuepress/dist
+
+# Serverless directories
+.serverless/
+
+# FuseBox cache
+.fusebox/
+
+# DynamoDB Local files
+.dynamodb/
+
+# TernJS port file
+.tern-port

.travis.yml

@@ -0,0 +1,18 @@
+language: node_js
+
+node_js:
+  - node
+  - lts/*
+
+jobs:
+  include:
+    # Define the release stage that runs semantic-release
+    - stage: release
+      node_js: lts/*
+      # Advanced: optionally overwrite your default `script` step to skip the tests
+      # script: skip
+      deploy:
+        provider: script
+        skip_cleanup: true
+        script:
+          - npx semantic-release

README.md

@@ -0,0 +1,129 @@
+# mx2json
+
+Create a JSON representation of a Machinations Google Doc
+
+> ⚠️ This is WIP. You’ll need quite a few things for this:
+> 1. A Google Docs API Key with `spreadsheets.readonly` permissions
+> 2. The ID of your Google Sheet
+> 3. use 1 & 2 to create the API URL to your Google Doc, something like `https://sheets.googleapis.com/v4/spreadsheets/18J84rwqwC9AuyabZAK9d4JM6cUZn8jBnhZoT0NHMTp8/values/A%3AZ?key=…`
+4. `curl` this, optionally store the result in a file
+
+## CLI
+
+`mx2json` always reads from `stdin`. Use the pipe (`|`) or redirect (`<`) operators.
+
+##### Read from a file
+`$ mx2json < curl https://....`<br/>
+
+##### Read from a URL
+`$ curl https://.... | mx2json`
+
+## API
+
+`mx2json(doc, toJson)`
+
+**`doc`** is the Machinations Google Sheet, either in JSON or already parsed Object.
+
+**`toJson`** `boolean` or `function`. Set to `true` to get a JSON. Pass a `function`, to get the return value of that function.
+
+```js
+const mx2object = require('mx2json')
+const model = mx2object(myDoc)
+const json = mx2object(myDoc, true)
+const custom = mx2object(mDoc, doc => /* whatever */)
+```
+
+# Example Result
+
+```json
+{
+  "diagramProperties": {
+    "name": "Untitled",
+    "url": "https://my.machinations.io/diagram/22179",
+    "owner": "Andreas Pizsa",
+    "creationDate": "10/22/2019",
+    "lastChange": "10/31/2019",
+    "timeInterval": 1,
+    "timeStepsLimit": 100,
+    "numberOfRunsBatch": 10,
+    "numberOfRunsTotal": 20
+  },
+  "globalVariables": [
+    {
+      "id": 1,
+      "name": "Dice",
+      "value": "D6"
+    },
+    {
+      "id": 2,
+      "name": "Skill"
+    },
+    {
+      "id": 3,
+      "name": "Multiplayer"
+    },
+    {
+      "id": 4,
+      "name": "Strategy"
+    }
+  ],
+  "pools": [
+    {
+      "id": 11,
+      "label": "",
+      "geometry": "{\"_attributes\":{\"x\":\"360\",\"y\":\"110\",\"width\":\"60\",\"height\":\"60\",\"TRANSLATE_CONTROL_POINTS\":\"1\",\"relative\":\"0\",\"as\":\"geometry\"},\"mxPoint\":{\"_attributes\":{\"x\":\"0\",\"y\":\"40\",\"as\":\"offset\"}}}",
+      "style": "shape=pool-shape;whiteSpace=wrap;html=1;strokeWidth=2;aspect=fixed;resizable=0;fontSize=16;fontColor=#000000;strokeColor=#000000;",
+      "activation": "passive",
+      "activationMode": "pull-any",
+      "resources": 10,
+      "resourcesColor": "Black",
+      "capacityLimit": -1,
+      "capacityDisplay": 25,
+      "overflow": "block",
+      "showInChart": 0
+    },
+    {
+      "id": 15,
+      "label": "",
+      "geometry": "{\"_attributes\":{\"x\":\"150\",\"y\":\"110\",\"width\":\"60\",\"height\":\"60\",\"TRANSLATE_CONTROL_POINTS\":\"1\",\"relative\":\"0\",\"as\":\"geometry\"},\"mxPoint\":{\"_attributes\":{\"x\":\"0\",\"y\":\"40\",\"as\":\"offset\"}}}",
+      "style": "shape=pool-shape;whiteSpace=wrap;html=1;strokeWidth=2;aspect=fixed;resizable=0;fontSize=16;fontColor=#000000;strokeColor=#000000;",
+      "activation": "interactive",
+      "activationMode": "push-any",
+      "resources": 5,
+      "resourcesColor": "Black",
+      "capacityLimit": -1,
+      "capacityDisplay": 25,
+      "overflow": "block",
+      "showInChart": 0
+    }
+  ],
+  "resourceConnections": [
+    {
+      "id": 14,
+      "label": 1,
+      "geometry": "{\"_attributes\":{\"x\":\"0\",\"y\":\"0\",\"width\":\"60\",\"height\":\"60\",\"relative\":\"1\",\"TRANSLATE_CONTROL_POINTS\":\"1\",\"as\":\"geometry\"},\"mxPoint\":[{\"_attributes\":{\"x\":\"240\",\"y\":\"148.33333333333337\",\"as\":\"sourcePoint\"}},{\"_attributes\":{\"x\":\"324.8528137423857\",\"y\":\"150\",\"as\":\"targetPoint\"}},{\"_attributes\":{\"x\":\"20\",\"y\":\"10\",\"as\":\"offset\"}}]}",
+      "style": "shape=resource-connection;endArrow=classic;html=1;strokeWidth=2;fontSize=16;fontColor=#000000;strokeColor=#000000;",
+      "source": 15,
+      "target": 11,
+      "transfer": "interval-based",
+      "colorCoding": 0,
+      "colorCodingColor": "Orange",
+      "shuffleSource": 0,
+      "limitsMinimum": -9999,
+      "limitsMaximum": 9999
+    }
+  ],
+  "stateConnections": [
+    {
+      "id": 16,
+      "label": ">0",
+      "geometry": "{\"_attributes\":{\"x\":\"0\",\"y\":\"0\",\"width\":\"60\",\"height\":\"60\",\"relative\":\"1\",\"TRANSLATE_CONTROL_POINTS\":\"1\",\"as\":\"geometry\"},\"mxPoint\":[{\"_attributes\":{\"x\":\"420\",\"y\":\"200\",\"as\":\"sourcePoint\"}},{\"_attributes\":{\"x\":\"504.8528137423857\",\"y\":\"140\",\"as\":\"targetPoint\"}},{\"_attributes\":{\"x\":\"20\",\"y\":\"10\",\"as\":\"offset\"}}],\"Array\":{\"_attributes\":{\"as\":\"points\"},\"mxPoint\":{\"_attributes\":{\"x\":\"350\",\"y\":\"290\"}}}}",
+      "style": "shape=state-connection;endArrow=classic;dashed=1;dashPattern=4 3;html=1;strokeWidth=2;fontSize=16;fontColor=#000000;strokeColor=#000000;",
+      "source": 11,
+      "target": 14,
+      "colorCoding": 0,
+      "colorCodingColor": "Black"
+    }
+  ]
+}
+```

api.js

@@ -0,0 +1,101 @@
+// GET https://sheets.googleapis.com/v4/spreadsheets/18J84rwqwC9AuyabZAK9d4JM6cUZn8jBnhZoT0NHMTp8/values/Sheet1!A1:D5
+
+const {camelCase} = require('change-case')
+const flatMap = require('lodash.flatmap')
+
+/*------------------------------------------------------------------------------
+  Utility functions
+------------------------------------------------------------------------------*/
+const {toPairs, fromPairs, pipe} = require('./utils')
+
+/*------------------------------------------------------------------------------
+  objectFromMxGoogleDoc
+------------------------------------------------------------------------------*/
+function objectFromMxGoogleDoc({values}) {
+  let section
+  let expectColumnNames = false
+  let columnNames
+  return values.reduce((result, row) => {
+    if (row.length === 0) {
+      return result
+    }
+
+    if (row.length === 1) {
+      section = camelCase(row[0])
+      expectColumnNames = true
+      return {
+        ...result,
+        [section]: []
+      }
+    }
+
+    if (section === 'diagramProperties') {
+      result[section].push({
+        [camelCase(row[1])]: row[2]
+      })
+      return result
+    }
+
+    if (expectColumnNames) {
+      expectColumnNames = false
+      columnNames = row.filter(col => col.length)
+      return result
+    }
+
+    result[section].push(
+      keysAndValuesToObject(columnNames, row)
+    )
+
+    return result
+  }, {})
+}
+
+const cleanupDiagramProperties = input => ({
+  ...input,
+  diagramProperties: fromPairs(flatMap(input.diagramProperties, toPairs))
+})
+
+function keysAndValuesToObject(keys, values) {
+  return keys.reduce((result, key, index) => ({
+    ...result,
+    [camelCase(key)]: values[index]
+  }), {})
+}
+
+function deepNumericValuesToIntegers(arg) {
+  if (Array.isArray(arg)) {
+    return arg.map(deepNumericValuesToIntegers)
+  }
+
+  if (typeof arg !== 'object') {
+    return /^-?\d+$/.test(arg) ? parseInt(arg, 10) : arg
+  }
+
+  return Object
+    .entries(arg)
+    .reduce((result, [key, value]) => ({
+      ...result,
+      [key]: deepNumericValuesToIntegers(value)
+    }), {})
+}
+
+const mxToObject = (doc, toJson = false) => {
+  const fromJson = typeof doc === 'string'
+    ? JSON.parse
+    : x => x
+
+  toJson = (typeof toJson === 'function' && toJson)
+    || toJson
+    ? arg => JSON.stringify(arg, null, 2)
+    : x => x
+
+  return pipe(
+    fromJson,
+    objectFromMxGoogleDoc,
+    cleanupDiagramProperties,
+    deepNumericValuesToIntegers,
+    toJson
+  )(doc)
+}
+
+module.exports = mxToObject

cli.js

@@ -0,0 +1,29 @@
+#!/usr/bin/env node
+
+const mxToObject = require('./api')
+const {pipe} = require('./utils')
+
+// eslint-disable-next-line no-unused-expressions
+require('yargs')
+  .scriptName('mx2json')
+  .command(
+    '$0',
+    'Convert Machinations Google Doc file to JSON',
+    {},
+    async argv => {
+      if (/^.*?:.*/.test(argv.file)) {
+        console.error(`use\n   curl "${argv.file}" | ${argv.$0}\nto use URLs`)
+        return
+      }
+
+      const input = argv.file
+        ? await require('fs').promises.readFile(argv.file, 'utf8')
+        : await require('get-stdin')()
+
+      pipe(
+        mxToObject,
+        doc => JSON.stringify(doc, null, 2),
+        console.log.bind(console)
+      )(input)
+    })
+  .argv

client_id.json

@@ -0,0 +1 @@
+{"installed":{"client_id":"738175170949-mkv82e49f610n0tt7psc33557lqghk1j.apps.googleusercontent.com","project_id":"machinatics","auth_uri":"https://accounts.google.com/o/oauth2/auth","token_uri":"https://oauth2.googleapis.com/token","auth_provider_x509_cert_url":"https://www.googleapis.com/oauth2/v1/certs","client_secret":"zuOH3f393pol78zggDsVI-Mp","redirect_uris":["urn:ietf:wg:oauth:2.0:oob","http://localhost"]}}