extwee 1.6.2 → 2.0.0

package/test/Roundtrip.test.js

@@ -0,0 +1,48 @@
+import TweeWriter from '../src/TweeWriter.js';
+import FileReader from '../src/FileReader.js';
+import TweeParser from '../src/TweeParser.js';
+import HTMLParser from '../src/HTMLParser.js';
+import StoryFormatParser from '../src/StoryFormatParser.js';
+import HTMLWriter from '../src/HTMLWriter.js';
+
+describe('Round-trip testing', () => {
+  test('Should round-trip HTML-to-Twee', () => {
+    // Read HTML
+    const fr = FileReader.read('test/Roundtrip/Example1.html');
+    // Parse HTML
+    const s = HTMLParser.parse(fr);
+    // Write Story into Twee
+    TweeWriter.write(s, 'test/Roundtrip/example1.twee');
+    // Read new Twee file
+    const fr2 = FileReader.read('test/Roundtrip/example1.twee');
+    // Parse the new Twee
+    const s2 = TweeParser.parse(fr2);
+    // Number of passages should be the same, too
+    expect(s2.size()).toBe(s.size());
+    // IFID should be the same
+    expect(s.ifid).toBe(s2.ifid);
+  });
+
+  test('Should round-trip Twee-to-HTML', () => {
+    // Read StoryFormat
+    const storyFormat = FileReader.read('test/Roundtrip/harlowe.js');
+    // Parse StoryFormat
+    const sfp = StoryFormatParser.parse(storyFormat);
+    // Read Twee
+    const fr = FileReader.read('test/Roundtrip/example2.twee');
+    // Parse Twee
+    const story = TweeParser.parse(fr);
+    // Write HTML
+    HTMLWriter.write('test/Roundtrip/round.html', story, sfp);
+    // Read HTML
+    const fr2 = FileReader.read('test/Roundtrip/round.html');
+    // Parse HTML
+    const story2 = HTMLParser.parse(fr2);
+    // Number of passages should be the same, too
+    expect(story2.size()).toBe(story.size());
+    // IFID should be the same
+    expect(story.ifid).toBe(story2.ifid);
+    // Should have same 'start' name
+    expect(story.start).toBe(story2.start);
+  });
+});

package/test/Story/startmeta.twee

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

package/test/Story/test.twee

@@ -1,25 +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;}
+:: 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/Story.test.js

@@ -0,0 +1,282 @@
+import Story from '../src/Story.js';
+import Passage from '../src/Passage';
+import FileReader from '../src/FileReader.js';
+
+// Pull the name and version of this project from package.json.
+// These are used as the 'creator' and 'creator-version'.
+const { name, version } = JSON.parse(FileReader.read('package.json'));
+
+describe('Story', function () {
+  describe('#constructor()', function () {
+    test('Should have extwee name', function () {
+      const s = new Story();
+      expect(s.creator).toBe(name);
+    });
+
+    test('Should have extwee version', function () {
+      const s = new Story();
+      expect(s.creatorVersion).toBe(version);
+    });
+  });
+
+  describe('creator', function () {
+    test('Set using String', function () {
+      const s = new Story();
+      s.creator = 'New';
+      expect(s.creator).toBe('New');
+    });
+
+    test('Should throw error if not String', function () {
+      const s = new Story();
+      expect(() => {
+        s.creator = 1;
+      }).toThrow();
+    });
+  });
+
+  describe('creatorVersion', function () {
+    test('Set using String', function () {
+      const s = new Story();
+      s.creatorVersion = 'New';
+      expect(s.creatorVersion).toBe('New');
+    });
+
+    test('Should throw error if not String', function () {
+      const s = new Story();
+      expect(() => {
+        s.creatorVersion = 1;
+      }).toThrow();
+    });
+  });
+
+  describe('IFID', function () {
+    test('Set using String', function () {
+      const s = new Story();
+      s.IFID = 'New';
+      expect(s.IFID).toBe('New');
+    });
+
+    test('Should throw error if not String', function () {
+      const s = new Story();
+      expect(() => {
+        s.IFID = 1;
+      }).toThrow();
+    });
+  });
+
+  describe('format', function () {
+    test('Set using String', function () {
+      const s = new Story();
+      s.format = 'New';
+      expect(s.format).toBe('New');
+    });
+
+    test('Should throw error if not String', function () {
+      const s = new Story();
+      expect(() => {
+        s.format = 1;
+      }).toThrow();
+    });
+  });
+
+  describe('formatVersion', function () {
+    test('Set using String', function () {
+      const s = new Story();
+      s.formatVersion = 'New';
+      expect(s.formatVersion).toBe('New');
+    });
+
+    test('Should throw error if not String', function () {
+      const s = new Story();
+      expect(() => {
+        s.formatVersion = 1;
+      }).toThrow();
+    });
+  });
+
+  describe('zoom', function () {
+    test('Set using Number', function () {
+      const s = new Story();
+      s.zoom = 1.0;
+      expect(s.zoom).not.toBe(0);
+    });
+
+    test('Should throw error if not String', function () {
+      const s = new Story();
+      expect(() => {
+        s.zoom = null;
+      }).toThrow();
+    });
+  });
+
+  describe('metadata', function () {
+    test('Set metadata', function () {
+      const s = new Story();
+      s.metadata = {};
+      expect(s.metadata).not.toBe(null);
+    });
+
+    test('Should throw error if not object', function () {
+      const s = new Story();
+      expect(() => {
+        s.metadata = 1;
+      }).toThrow();
+    });
+  });
+
+  describe('start', function () {
+    test('Set start', function () {
+      const s = new Story();
+      s.start = 'Start';
+      expect(s.start).not.toBe('');
+    });
+
+    test('Should throw error if not String', function () {
+      const s = new Story();
+      expect(() => {
+        s.start = 1;
+      }).toThrow();
+    });
+  });
+
+  describe('tagColors', function () {
+    test('Set tagColors', function () {
+      const s = new Story();
+      s.tagColors = {
+        bar: 'green'
+      };
+      const count = Object.keys(s.tagColors).length;
+      expect(count).toBe(1);
+    });
+
+    test('Should throw error if not object', function () {
+      const s = new Story();
+      expect(() => {
+        s.tagColors = null;
+      }).toThrow();
+    });
+  });
+
+  describe('addPassage()', function () {
+    test('addPassage() - should increase size', function () {
+      const s = new Story();
+      const p = new Passage();
+      s.addPassage(p);
+      expect(s.size()).toBe(1);
+    });
+
+    test('addPassage() - should throw error if non-Passage', function () {
+      const s = new Story();
+      expect(() => {
+        s.addPassage(null);
+      }).toThrow();
+    });
+
+    test('addPassage() - should prevent passages with same name being added', function () {
+      const s = new Story();
+      const p = new Passage('A');
+      const p2 = new Passage('A');
+      s.addPassage(p);
+      s.addPassage(p2);
+      expect(s.size()).toBe(1);
+    });
+  });
+
+  describe('removePassage()', function () {
+    test('removePassage() - should decrease size', function () {
+      const s = new Story();
+      s.addPassage(new Passage('Find'));
+      s.addPassage(new Passage('Find2'));
+      s.removePassage('Find');
+      expect(s.size()).toBe(1);
+    });
+  });
+
+  describe('getPassagesByTag()', function () {
+    test('getPassagesByTag() - should find passages', function () {
+      const s = new Story();
+      const p = new Passage('Find', '', ['one']);
+      const p2 = new Passage('Find2', '', ['one']);
+      s.addPassage(p);
+      s.addPassage(p2);
+      const ps = s.getPassagesByTag('one');
+      expect(ps).toHaveLength(2);
+    });
+
+    test('getPassagesByTag() - should find none if none in collection', function () {
+      const s = new Story();
+      const ps = s.getPassagesByTag('one');
+      expect(ps).toHaveLength(0);
+    });
+
+    test('getPassagesByTag() - should find none if no tags match search', function () {
+      const s = new Story();
+      const p = new Passage('Find', '', ['one']);
+      const p2 = new Passage('Find2', '', ['one']);
+      s.addPassage(p);
+      s.addPassage(p2);
+      const ps = s.getPassagesByTag('two');
+      expect(ps).toHaveLength(0);
+    });
+  });
+
+  describe('getPassageByName()', function () {
+    test('getPassageByName() - should get passage by name', function () {
+      const s = new Story();
+      const p = new Passage('Find');
+      s.addPassage(p);
+      const passage = s.getPassageByName('Find');
+      expect(passage.name).toBe('Find');
+    });
+  });
+
+  describe('getPassageByPID()', function () {
+    test('getPassageByPID() - should get passage by PID', function () {
+      const s = new Story();
+      const p = new Passage('Find', '', [], {}, 12);
+      s.addPassage(p);
+      const passage = s.getPassageByPID(12);
+      expect(passage.name).toBe('Find');
+    });
+
+    test('getPassageByPID() - should return null if not found', function () {
+      const s = new Story();
+      expect(s.getPassageByPID(12)).toBe(null);
+    });
+  });
+
+  describe('forEach()', function () {
+    test('forEach() - should return if non-function', function () {
+      const s = new Story();
+      s.addPassage(new Passage('A'));
+      s.addPassage(new Passage('B'));
+      let passageNames = '';
+      s.forEach((p) => {
+        passageNames += p.name;
+      });
+      expect(passageNames).toBe('AB');
+    });
+
+    test('forEach() - should throw error if non-function', function () {
+      const s = new Story();
+      expect(() => {
+        s.forEach(null);
+      }).toThrow();
+    });
+  });
+
+  describe('size()', function () {
+    test('size() - should report number of passages', function () {
+      // Create a Story
+      const s = new Story();
+      // Create a Passage
+      const p = new Passage('');
+      // Test initial size
+      expect(s.size()).toBe(0);
+      // Add a passage
+      s.addPassage(p);
+      // Test size after adding one
+      expect(s.size()).toBe(1);
+    });
+  });
+});

package/test/StoryFormat.test.js

@@ -0,0 +1,152 @@
+import StoryFormat from '../src/StoryFormat.js';
+
+describe('StoryFormat', function () {
+  describe('#constructor()', function () {
+    test('Should create default values', function () {
+      const sf = new StoryFormat();
+      expect(sf.name).toBe('');
+      expect(sf.version).toBe('');
+      expect(sf.author).toBe('');
+      expect(sf.image).toBe('');
+      expect(sf.url).toBe('');
+      expect(sf.license).toBe('');
+      expect(sf.proofing).toBe(false);
+      expect(sf.source).toBe('');
+    });
+  });
+
+  describe('name', function () {
+    test('Set new String', function () {
+      const sf = new StoryFormat();
+      sf.name = 'New';
+      expect(sf.name).toBe('New');
+    });
+
+    test('Throw error if non-String', function () {
+      const sf = new StoryFormat();
+      expect(() => {
+        sf.name = 1;
+      }).toThrow();
+    });
+  });
+
+  describe('version', function () {
+    test('Set new String', function () {
+      const sf = new StoryFormat();
+      sf.version = 'New';
+      expect(sf.version).toBe('New');
+    });
+
+    test('Throw error if non-String', function () {
+      const sf = new StoryFormat();
+      expect(() => {
+        sf.version = 1;
+      }).toThrow();
+    });
+  });
+
+  describe('author', function () {
+    test('Set new String', function () {
+      const sf = new StoryFormat();
+      sf.author = 'New';
+      expect(sf.author).toBe('New');
+    });
+
+    test('Throw error if non-String', function () {
+      const sf = new StoryFormat();
+      expect(() => {
+        sf.author = 1;
+      }).toThrow();
+    });
+  });
+
+  describe('image', function () {
+    test('Set new String', function () {
+      const sf = new StoryFormat();
+      sf.image = 'New';
+      expect(sf.image).toBe('New');
+    });
+
+    test('Throw error if non-String', function () {
+      const sf = new StoryFormat();
+      expect(() => {
+        sf.image = 1;
+      }).toThrow();
+    });
+  });
+
+  describe('url', function () {
+    test('Set new String', function () {
+      const sf = new StoryFormat();
+      sf.url = 'New';
+      expect(sf.url).toBe('New');
+    });
+
+    test('Throw error if non-String', function () {
+      const sf = new StoryFormat();
+      expect(() => {
+        sf.url = 1;
+      }).toThrow();
+    });
+  });
+
+  describe('license', function () {
+    test('Set new String', function () {
+      const sf = new StoryFormat();
+      sf.license = 'New';
+      expect(sf.license).toBe('New');
+    });
+
+    test('Throw error if non-String', function () {
+      const sf = new StoryFormat();
+      expect(() => {
+        sf.license = 1;
+      }).toThrow();
+    });
+  });
+
+  describe('proofing', function () {
+    test('Set new String', function () {
+      const sf = new StoryFormat();
+      sf.proofing = true;
+      expect(sf.proofing).toBe(true);
+    });
+
+    test('Throw error if non-String', function () {
+      const sf = new StoryFormat();
+      expect(() => {
+        sf.proofing = 1;
+      }).toThrow();
+    });
+  });
+
+  describe('source', function () {
+    test('Set new String', function () {
+      const sf = new StoryFormat();
+      sf.source = 'New';
+      expect(sf.source).toBe('New');
+    });
+
+    test('Throw error if non-String', function () {
+      const sf = new StoryFormat();
+      expect(() => {
+        sf.source = 1;
+      }).toThrow();
+    });
+  });
+
+  describe('description', function () {
+    test('Set new String', function () {
+      const sf = new StoryFormat();
+      sf.description = 'New';
+      expect(sf.description).toBe('New');
+    });
+
+    test('Throw error if non-String', function () {
+      const sf = new StoryFormat();
+      expect(() => {
+        sf.description = 1;
+      }).toThrow();
+    });
+  });
+});

package/test/StoryFormatParser/example.js

@@ -0,0 +1,3 @@
+[
+  error
+]

package/test/StoryFormatParser/{test2.js → example2.js}

@@ -1,3 +1,3 @@
-{
-  "malformed:
-}
+{
+  "malformed:
+}