extwee 1.5.3 → 2.0.0

package/test/TweeParser/notes.twee

@@ -0,0 +1,16 @@
+/**
+  These are some notes at the top of the file
+*/
+:: StoryTitle
+twineExample
+
+:: Start {"position":"102,104","size":"100,100"}
+Start passage
+
+:: StoryData
+{
+    "ifid": "2B68ECD6-348F-4CF5-96F8-549A512A8128",
+    "format": "Harlowe",
+    "formatVersion": "2.1.0",
+    "zoom": "1"
+}

package/test/TweeParser/pasagemetadataerror.twee

@@ -0,0 +1,2 @@
+:: Start {"position}
+Some content

package/test/TweeParser/scriptPassage.twee

@@ -0,0 +1,16 @@
+:: Start
+Content
+
+:: StoryTitle
+Title
+
+:: UserScript [script]
+window.example = {}
+
+:: StoryData
+{
+    "ifid": "2B68ECD6-348F-4CF5-96F8-549A512A8128",
+    "format": "Harlowe",
+    "formatVersion": "2.1.0",
+    "zoom": "1"
+}

package/test/TweeParser/singletag.twee

@@ -0,0 +1,13 @@
+:: Start [tag]
+Content
+
+:: StoryTitle
+Title
+
+:: StoryData
+{
+    "ifid": "2B68ECD6-348F-4CF5-96F8-549A512A8128",
+    "format": "Harlowe",
+    "formatVersion": "2.1.0",
+    "zoom": "1"
+}

package/test/TweeParser/startMetadata.twee

@@ -0,0 +1,14 @@
+:: StoryTitle
+Example
+
+:: StoryData
+ {
+  "ifid": "A74F654F-3F85-44DE-8A87-9845AECD04B0",
+  "format": "Harlowe",
+  "formatVersion": "3.2.1",
+  "zoom": "1",
+  "start": "Untitled Passage"
+}
+
+:: Untitled Passage {"position":"100,99","size":"100,100"}
+Double-click this passage to edit it.

package/test/TweeParser/storydataerror.twee

@@ -0,0 +1,25 @@
+:: StoryTitle
+twineExample
+
+:: Start
+Some content.
+
+:: StoryData
+{
+    "ifid": 2B68ECD6-348F-4CF5-96F8-549A512A8128",
+    "format": "Harlowe",
+    "formatVersion": "2.1.0",
+    "zoom": "1"
+}
+
+:: Script1 [script]
+// Some code
+
+:: Script2 [script]
+//More code here!
+
+:: Style1 [stylesheet]
+body {font-size: 1.2em}
+
+:: Style2 [stylesheet]
+p {font-style: italic;}

package/test/TweeParser/stylePassage.twee

@@ -0,0 +1,16 @@
+:: Start
+Content
+
+:: StoryTitle
+Title
+
+:: UserStylesheet [stylesheet]
+1
+
+:: StoryData
+{
+    "ifid": "2B68ECD6-348F-4CF5-96F8-549A512A8128",
+    "format": "Harlowe",
+    "formatVersion": "2.1.0",
+    "zoom": "1"
+}

package/test/TweeParser/test.twee

@@ -0,0 +1,25 @@
+:: StoryTitle
+twineExample
+
+:: Start
+Some content.
+
+:: StoryData
+{
+    "ifid": "2B68ECD6-348F-4CF5-96F8-549A512A8128",
+    "format": "Harlowe",
+    "formatVersion": "2.1.0",
+    "zoom": "1"
+}
+
+:: Script1 [script]
+// Some code
+
+:: Script2 [script]
+//More code here!
+
+:: Style1 [stylesheet]
+body {font-size: 1.2em}
+
+:: Style2 [stylesheet]
+p {font-style: italic;}

package/test/TweeParser.test.js

@@ -0,0 +1,79 @@
+import FileReader from '../src/FileReader.js';
+import TweeParser from '../src/TweeParser.js';
+
+describe('TweeParser', function () {
+  describe('#parse()', function () {
+    test('Should throw error if non-string is used', function () {
+      expect(() => { TweeParser.parse(1); }).toThrow();
+    });
+
+    test('Should throw error if empty string is used', function () {
+      expect(() => { TweeParser.parse(); }).toThrow();
+    });
+
+    test('Should throw error if no passages are present', function () {
+      expect(() => { TweeParser.parse('()()'); }).toThrow();
+    });
+
+    test('Should throw error if it detects malformed passage headers', function () {
+      expect(() => { TweeParser.parse('::{}[]\nNo name'); }).toThrow();
+    });
+
+    test('Should cut notes before passages', function () {
+      const fr = FileReader.read('test/TweeParser/notes.twee');
+      const story = TweeParser.parse(fr);
+      const p = story.getPassageByName('StoryTitle');
+      expect(p.text).toBe('twineExample');
+    });
+
+    test('Should be able to parse Twee file for Story Name', function () {
+      const fr = FileReader.read('test/TweeParser/example.twee');
+      const story = TweeParser.parse(fr);
+      const p = story.getPassageByName('StoryTitle');
+      expect(p.text).toBe('twineExample');
+    });
+
+    test('Should parse single tag on Start passage', function () {
+      const fr = FileReader.read('test/TweeParser/singletag.twee');
+      const story = TweeParser.parse(fr);
+      const start = story.getPassageByName('Start');
+      expect(start.tags).toHaveLength(1);
+    });
+
+    test('Should parse multiple tag', function () {
+      const fr = FileReader.read('test/TweeParser/multipletags.twee');
+      const story = TweeParser.parse(fr);
+      const start = story.getPassageByName('Start');
+      expect(start.tags).toHaveLength(2);
+    });
+
+    test('Should parse single script passage', function () {
+      const fr = FileReader.read('test/TweeParser/scriptPassage.twee');
+      const story = TweeParser.parse(fr);
+      const p = story.getPassageByName('UserScript');
+      expect(p.tags).toHaveLength(1);
+    });
+
+    test('Should parse single stylesheet passage', function () {
+      const fr = FileReader.read('test/TweeParser/stylePassage.twee');
+      const story = TweeParser.parse(fr);
+      const p = story.getPassageByName('UserStylesheet');
+      expect(p.tags).toHaveLength(1);
+      expect(p.name).toBe('UserStylesheet');
+    });
+
+    test('Should parse StoryTitle', function () {
+      const fr = FileReader.read('test/TweeParser/test.twee');
+      const story = TweeParser.parse(fr);
+      const p = story.getPassageByName('StoryTitle');
+      expect(p).not.toBe(null);
+    });
+
+    test('Should parse StoryAuthor', function () {
+      const fr = FileReader.read('test/TweeParser/example.twee');
+      const story = TweeParser.parse(fr);
+      const p = story.getPassageByName('StoryAuthor');
+      expect(p).not.toBe(null);
+    });
+  });
+});

package/test/TweeWriter/test1.twee

@@ -0,0 +1,18 @@
+:: StoryData
+{
+  "ifid": "DD03696D-5967-4E01-A955-885CDFEA2FE1",
+  "format": "Test",
+  "format-version": "1.2.3",
+  "zoom": 1,
+  "start": "Untitled"
+}
+
+:: StoryTitle
+Title
+
+:: Start
+Content
+
+:: Untitled
+Some stuff
+

package/test/TweeWriter/test3.twee

@@ -0,0 +1,12 @@
+:: StoryData
+{
+  "ifid": "DE7DF8AD-E4CD-499E-A4E7-C5B98B73449A",
+  "start": "Start"
+}
+
+:: Start [tag tags]
+
+
+:: StoryTitle
+Title
+

package/test/TweeWriter/test4.twee

@@ -0,0 +1,14 @@
+:: StoryData
+{
+  "ifid": "D5D54A73-4E5F-4186-9276-EBDE28110006"
+}
+
+:: StoryTitle
+Title
+
+:: Start
+Content
+
+:: Untitled
+Some stuff
+

package/test/TweeWriter/test5.twee

@@ -0,0 +1,20 @@
+:: StoryData
+{
+  "ifid": "FFA1527D-3700-4697-BCD1-386E4A6AE902",
+  "start": "Start",
+  "tag-colors": {
+    "bar": "green",
+    "foo": "red",
+    "qaz": "blue"
+  }
+}
+
+:: StoryTitle
+Title
+
+:: Start
+Content
+
+:: Untitled
+Some stuff
+

package/test/TweeWriter.test.js

@@ -0,0 +1,82 @@
+import FileReader from '../src/FileReader.js';
+import Story from '../src/Story.js';
+import Passage from '../src/Passage.js';
+import TweeWriter from '../src/TweeWriter.js';
+import TweeParser from '../src/TweeParser.js';
+
+describe('TweeWriter', function () {
+  describe('#write()', function () {
+    test('Should throw error if object passed is not instanceof Story', function () {
+      expect(() => { TweeWriter.write({}); }).toThrow();
+    });
+
+    test('Should throw error if output file invalid', function () {
+      expect(() => { TweeWriter.write(new Story(), ''); }).toThrow();
+    });
+
+    test('Should write Twee file', function () {
+      const s = new Story();
+      s.addPassage(new Passage('StoryData', '{}'));
+      s.addPassage(new Passage('StoryTitle', 'Title'));
+      s.addPassage(new Passage('Start', 'Content'));
+      TweeWriter.write(s, 'test/TweeWriter/test1.twee');
+      const fr = FileReader.read('test/TweeWriter/test1.twee');
+      const story = TweeParser.parse(fr);
+      const p = story.getPassageByName('StoryTitle');
+      expect(p.text).toBe('Title');
+    });
+
+    test('Should correctly write Twee file with passage tags', function () {
+      const s = new Story();
+      s.addPassage(new Passage('Start', '', ['tag', 'tags']));
+      s.addPassage(new Passage('StoryTitle', 'Title'));
+      // Verify only one passage.
+      expect(s.size()).toBe(2);
+
+      // Set an ifid property
+      s.IFID = 'DE7DF8AD-E4CD-499E-A4E7-C5B98B73449A';
+
+      // Write contents to file.
+      TweeWriter.write(s, 'test/TweeWriter/test3.twee');
+      // Read file.
+      const fr = FileReader.read('test/TweeWriter/test3.twee');
+      // Parse file.
+      const tp = TweeParser.parse(fr);
+      // Verify only two passages
+      expect(tp.size()).toBe(2);
+    });
+
+    test('Should write format, formatVersion, zoom, and start', function () {
+      const s = new Story();
+      s.addPassage(new Passage('StoryTitle', 'Title'));
+      s.addPassage(new Passage('Start', 'Content'));
+      s.addPassage(new Passage('Untitled', 'Some stuff'));
+
+      s.format = 'Test';
+      s.formatVersion = '1.2.3';
+      s.zoom = 1;
+      s.start = 'Untitled';
+
+      TweeWriter.write(s, 'test/TweeWriter/test1.twee');
+      const fr = FileReader.read('test/TweeWriter/test1.twee');
+      const story2 = TweeParser.parse(fr);
+      expect(story2.format).toBe('Test');
+    });
+
+    test('Should write tag colors', function () {
+      const s = new Story();
+      s.addPassage(new Passage('StoryTitle', 'Title'));
+      s.addPassage(new Passage('Start', 'Content'));
+      s.addPassage(new Passage('Untitled', 'Some stuff'));
+      s.tagColors = {
+        bar: 'green',
+        foo: 'red',
+        qaz: 'blue'
+      };
+      TweeWriter.write(s, 'test/TweeWriter/test5.twee');
+      const fr = FileReader.read('test/TweeWriter/test5.twee');
+      const story2 = TweeParser.parse(fr);
+      expect(story2.tagColors.bar).toBe('green');
+    });
+  });
+});

package/DirectoryReader.js

@@ -1,128 +0,0 @@
-const fs = require("fs");
-const FileReader = require('./FileReader.js');
-const shell = require('shelljs');
-// Tell shelljs to be quiet about warnings
-shell.config.silent = true;
-const UglifyJS = require('uglify-js');
-const CleanCSS = require('clean-css');
-const babel = require("@babel/core");
-
-/**
- * @class DirectoryReader
- * @module DirectoryReader
- */
-class DirectoryReader {
-	/**
-     * @method DirectoryReader
-     * @constructor
-     */
-    constructor (directory) {
-
-      try {
-
-        this.directory = fs.realpathSync(directory);
-
-      } catch(event) {
-
-        throw new Error("Error: Cannot resolve to real path!");
-
-      }
-
-      this.CSScontents = "";
-      this.JScontents = "";
-      this.tweeContents = "";
-
-      // Read the directory
-      this.update();
-
-    }
-
-    update() {
-
-      // Reset
-      this.CSScontents = this.JScontents = this.tweeContents = "";
-
-      // Look for CSS files
-      this.CSScontents += this.processCSS();
-      // Look for JS files
-      this.JScontents += this.processJS();
-      // Look for Twee files
-      this.tweeContents += this.processTwee();
-
-    }
-
-    processJS() {
-
-      let fileContents = "";
-
-      console.info("Processing JS files...");
-      shell.ls('-R', this.directory + '/**/*.js').forEach(function (value) {
-        console.info("  Loading " + value);
-        const file = new FileReader(value);
-
-        let babelResult = {
-          code: ""
-        };
-
-        try {
-
-          babelResult = babel.transformSync(file.contents, {
-            "presets": ["@babel/preset-env"],
-          });
-
-        } catch(event) {
-
-          console.info("Error Babel processing " + value + ". Skipping contents.");
-
-        }
-
-        let uglyResult = UglifyJS.minify(babelResult.code);
-
-        fileContents += uglyResult.code;
-
-      });
-
-      return fileContents;
-
-    }
-
-    processCSS() {
-
-      let fileContents = "";
-
-      console.info("Processing CSS files...");
-      shell.ls('-R', this.directory + '/**/*.css').forEach(function (value) {
-        console.info("  Loading " + value);
-        const file = new FileReader(value);
-        fileContents += file.contents;
-      });
-
-      const output = new CleanCSS({level: 2}).minify(fileContents);
-      return output.styles;
-
-    }
-
-    processTwee() {
-
-      let fileType = ["tw", "tw2", "twee", "twee2", "tw3", "twee3"];
-
-      let fileContents = "";
-
-      console.info("Processing Twee files...");
-      for(let i = 0; i < fileType.length; i++) {
-
-        shell.ls('-R', this.directory + '/**/*.' + fileType[i]).forEach(function (value) {
-          const file = new FileReader(value);
-          console.info("  Loading " + value);
-          fileContents += file.contents;
-        });
-
-      }
-
-      return fileContents;
-
-    }
-
-}
-
-module.exports = DirectoryReader;

package/DirectoryWatcher.js

@@ -1,63 +0,0 @@
-const fs = require("fs");
-const FileReader = require('./FileReader.js');
-const chokidar = require('chokidar');
-
-/**
- * @class DirectoryWatcher
- * @module DirectoryWatcher
- */
-class DirectoryWatcher {
-	/**
-     * @method DirectoryWatcher
-     * @constructor
-     */
-    constructor (directory, callback) {
-
-      this.directory = directory;
-      this.watcher = null;
-      this.callback = callback;
-
-      // Test if callback is a function or not
-      if( !(this.callback instanceof Function) ) {
-
-        throw new Error("Error: Expected function!");
-
-      }
-
-      try {
-
-        this.directory = fs.realpathSync(this.directory);
-
-      } catch(event) {
-
-        throw new Error("Error: Directory does not exist!");
-
-      }
-
-      console.info("Watching " + this.directory + " for changes.");
-      console.info("Press CTRL+C to stop.");
-
-      // Setup the Chokidar watcher
-      this.watcher = chokidar.watch(this.directory, {
-          ignored: /.html/,
-          persistent: true,
-          ignoreInitial: false
-      });
-
-       // Catch change events
-       this.watcher.on('change', (path) => {
-            console.info("Change detected on " + path);
-            callback();
-       });
-
-       // Catch add events
-       this.watcher.on('add', (path) => {
-            console.info("Addition detected on " + path);
-            callback();
-       });
-
-    }
-
-}
-
-module.exports = DirectoryWatcher;

package/FileReader.js

@@ -1,36 +0,0 @@
-const fs = require("fs");
-const path = require('path');
-/**
- * @class FileReader
- * @module FileReader
- */
-class FileReader {
-	/**
-     * @method FileReader
-     * @constructor
-     */
-    constructor (file) {
-
-        this.contents = "";
-        this.readFile(file);
-    }
-
-    readFile(file) {
-
-        // Attempt to find the file
-        if(fs.existsSync(file) ) {
-
-            // The file exists.
-            this.contents = fs.readFileSync(file, 'utf8');
-
-        } else {
-
-            throw new Error("Error: File not found!");
-
-        }
-
-    }
-
-}
-
-module.exports = FileReader;