extwee 2.2.0 → 2.2.2

package/test/Story.test.js

@@ -1,7 +1,9 @@
-import Story from '../src/Story.js';
+import { Story, creatorName, creatorVersion } from '../src/Story.js';
 import Passage from '../src/Passage';
 import { parse as parseTwee } from '../src/Twee/parse.js';
 import { readFileSync } from 'node:fs';
+import { parse as HTMLParser } from 'node-html-parser';
+import { generate as generateIFID } from '../src/IFID/generate.js';
 
 // Pull the name and version of this project from package.json.
 // These are used as the 'creator' and 'creator-version'.
@@ -27,6 +29,11 @@ describe('Story', () => {
       s = new Story('Test');
       expect(s.name).toBe('Test');
     });
+
+    it('Should have default name', () => {
+      s = new Story();
+      expect(s.name).toBe('Untitled Story');
+    });
   });
 
   describe('creator', () => {
@@ -222,6 +229,31 @@ describe('Story', () => {
     });
   });
 
+  describe('passages', () => {
+    let s = null;
+
+    beforeEach(() => {
+      s = new Story();
+    });
+
+    it('Set passages to a new array containing at least one Passage', () => {
+      s.passages = [new Passage()];
+      expect(s.passages.length).toBe(1);
+    });
+
+    it('Should throw error if trying to set to a non-Array type', () => {
+      expect(() => {
+        s.passages = null;
+      }).toThrow();
+    });
+
+    it('Should throw error if trying to set to an array containing non-Passage types', () => {
+      expect(() => {
+        s.passages = [null];
+      }).toThrow();
+    });
+  });
+
   describe('addPassage()', () => {
     let s = null;
 
@@ -241,14 +273,6 @@ describe('Story', () => {
       }).toThrow();
     });
 
-    it('addPassage() - should prevent passages with same name being added', () => {
-      const p = new Passage('A');
-      const p2 = new Passage('A');
-      s.addPassage(p);
-      s.addPassage(p2);
-      expect(s.size()).toBe(1);
-    });
-
     it('addPassage() - should override StoryData: ifid', function () {
       // Generate object.
       const o = {
@@ -350,30 +374,6 @@ describe('Story', () => {
     });
   });
 
-  describe('forEachPassage()', () => {
-    let s = null;
-
-    beforeEach(() => {
-      s = new Story();
-    });
-
-    it('forEachPassage() - should return if non-function', () => {
-      s.addPassage(new Passage('A'));
-      s.addPassage(new Passage('B'));
-      let passageNames = '';
-      s.forEachPassage((p) => {
-        passageNames += p.name;
-      });
-      expect(passageNames).toBe('AB');
-    });
-
-    it('forEachPassage() - should throw error if non-function', () => {
-      expect(() => {
-        s.forEachPassage(null);
-      }).toThrow();
-    });
-  });
-
   describe('size()', () => {
     let s = null;
 
@@ -399,15 +399,15 @@ describe('Story', () => {
       const s = new Story();
       // Convert to string and then back to object.
       const result = JSON.parse(s.toJSON());
-      expect(result.name).toBe('');
+      expect(result.name).toBe('Untitled Story');
       expect(Object.keys(result.tagColors).length).toBe(0);
       expect(result.ifid).toBe('');
       expect(result.start).toBe('');
       expect(result.formatVersion).toBe('');
       expect(result.format).toBe('');
-      expect(result.creator).toBe('extwee');
-      expect(result.creatorVersion).toBe('2.2.0');
-      expect(result.zoom).toBe(0);
+      expect(result.creator).toBe(creatorName);
+      expect(result.creatorVersion).toBe(creatorVersion);
+      expect(result.zoom).toBe(1);
       expect(Object.keys(result.metadata).length).toBe(0);
     });
 
@@ -430,10 +430,81 @@ describe('Story', () => {
       s = new Story();
     });
 
+    it('Should not generate format if empty', function () {
+      // Add one passage.
+      s.addPassage(new Passage('Start', 'Content'));
+
+      // Add an IFID (to prevent warning)
+      s.IFID = generateIFID();
+
+      // Set format to empty string.
+      s.format = '';
+
+      // Convert to Twee.
+      const t = s.toTwee();
+
+      // Test for format in metadata, should not exist.
+      expect(t.includes(`"'format":`)).not.toBe(true);
+    });
+
+    it('Should not generate formatVersion if empty', function () {
+      // Add one passage.
+      s.addPassage(new Passage('Start', 'Content'));
+
+      // Add an IFID (to prevent warning)
+      s.IFID = generateIFID();
+
+      // Set formatVersion to empty string.
+      s.formatVersion = '';
+
+      // Convert to Twee.
+      const t = s.toTwee();
+
+      // Test for formatVersion in metadata, should not exist.
+      expect(t.includes(`"'format-version":`)).not.toBe(true);
+    });
+
+    it('Should not generate zoom if zero', function () {
+      // Add one passage.
+      s.addPassage(new Passage('Start', 'Content'));
+
+      // Add an IFID (to prevent warning)
+      s.IFID = generateIFID();
+
+      // Set zoom to 0.
+      s.zoom = 0;
+
+      // Convert to Twee.
+      const t = s.toTwee();
+
+      // Test for zoom in metadata, should not exist.
+      expect(t.includes(`"'zoom":`)).not.toBe(true);
+    });
+
+    it('Should not generate start if empty', function () {
+      // Add one passage.
+      s.addPassage(new Passage('Start', 'Content'));
+
+      // Add an IFID (to prevent warning)
+      s.IFID = generateIFID();
+
+      // Set start to empty string.
+      s.start = '';
+
+      // Convert to Twee.
+      const t = s.toTwee();
+
+      // Test for start in metadata, should not exist.
+      expect(t.includes(`"'start":`)).not.toBe(true);
+    });
+
     it('Should detect StoryTitle text', function () {
       // Add one passage.
       s.addPassage(new Passage('StoryTitle', 'Content'));
 
+      // Add an IFID (to prevent warning)
+      s.IFID = generateIFID();
+
       // Convert to Twee.
       const t = s.toTwee();
 
@@ -472,6 +543,7 @@ describe('Story', () => {
       s.formatVersion = '1.2.3';
       s.zoom = 1;
       s.start = 'Untitled';
+      s.IFID = 'DE7DF8AD-E4CD-499E-A4E7-C5B98B73449A';
 
       // Convert to Twee.
       const t = s.toTwee();
@@ -484,6 +556,7 @@ describe('Story', () => {
       expect(story2.format).toBe('Test');
       expect(story2.zoom).toBe(1);
       expect(story2.start).toBe('Untitled');
+      expect(story2.IFID).toBe('DE7DF8AD-E4CD-499E-A4E7-C5B98B73449A');
     });
 
     it('Should write tag colors', () => {
@@ -491,6 +564,8 @@ describe('Story', () => {
       s.addPassage(new Passage('Start', 'Content'));
       s.addPassage(new Passage('Untitled', 'Some stuff'));
 
+      s.IFID = 'DE7DF8AD-E4CD-499E-A4E7-C5B98B73449A';
+
       // Add tag colors.
       s.tagColors = {
         bar: 'green',
@@ -515,6 +590,9 @@ describe('Story', () => {
       s.addPassage(new Passage('Test', 'Test', ['script']));
       s.addPassage(new Passage('Start', 'Content'));
 
+      // Set IFID.
+      s.IFID = 'DE7DF8AD-E4CD-499E-A4E7-C5B98B73449A';
+
       // Convert into Twee.
       const t = s.toTwee();
 
@@ -533,6 +611,9 @@ describe('Story', () => {
       s.addPassage(new Passage('Test', 'Test', ['stylesheet']));
       s.addPassage(new Passage('Start', 'Content'));
 
+      // Set IFID.
+      s.IFID = 'DE7DF8AD-E4CD-499E-A4E7-C5B98B73449A';
+
       // Convert into Twee.
       const t = s.toTwee();
 
@@ -554,18 +635,6 @@ describe('Story', () => {
       s = new Story();
     });
 
-    it('Should throw error if no starting passage', function () {
-      // No start set.
-      expect(() => { s.toTwine2HTML(); }).toThrow();
-    });
-
-    it('Should throw error if starting passage cannot be found', function () {
-      // Set start.
-      s.start = 'Unknown';
-      // Has a start, but not part of collection.
-      expect(() => { s.toTwine2HTML(); }).toThrow();
-    });
-
     it('Should encode name', () => {
       // Add passage.
       s.addPassage(new Passage('Start', 'Word'));
@@ -617,6 +686,114 @@ describe('Story', () => {
       // Expect the script passage text to be encoded.
       expect(result.includes('<script role="script" id="twine-user-script" type="text/twine-javascript">Word')).toBe(true);
     });
+
+    it('Should encode format', () => {
+      // Add passage.
+      s.addPassage(new Passage('Start', 'Word'));
+      // Set start.
+      s.start = 'Start';
+      // Set format.
+      s.format = 'Harlowe';
+      // Create HTML.
+      const result = s.toTwine2HTML();
+      // Expect the format to be encoded.
+      expect(result.includes('format="Harlowe"')).toBe(true);
+    });
+
+    it('Should encode formatVersion', () => {
+      // Add passage.
+      s.addPassage(new Passage('Start', 'Word'));
+      // Set start.
+      s.start = 'Start';
+      // Set formatVersion.
+      s.formatVersion = '3.2.0';
+      // Create HTML.
+      const result = s.toTwine2HTML();
+      // Expect the formatVersion to be encoded.
+      expect(result.includes('format-version="3.2.0"')).toBe(true);
+    });
+
+    it('Should encode zoom', () => {
+      // Add passage.
+      s.addPassage(new Passage('Start', 'Word'));
+      // Set start.
+      s.start = 'Start';
+      // Set zoom.
+      s.zoom = 2;
+      // Create HTML.
+      const result = s.toTwine2HTML();
+      // Expect the zoom to be encoded.
+      expect(result.includes('zoom="2"')).toBe(true);
+    });
+
+    it('Should encode start', () => {
+      // Add passage.
+      s.addPassage(new Passage('Start', 'Word'));
+      // Set start.
+      s.start = 'Start';
+      // Create HTML.
+      const result = s.toTwine2HTML();
+      // Expect the start to be encoded.
+      expect(result.includes('startnode="1"')).toBe(true);
+    });
+
+    it('Should encode start if property is not set but Start passage is', () => {
+      // Add passage.
+      s.addPassage(new Passage('Start', 'Word'));
+      // Create HTML.
+      const result = s.toTwine2HTML();
+      // Expect the start to be encoded.
+      expect(result.includes('startnode="1"')).toBe(true);
+    });
+
+    it('Should encode creator', () => {
+      // Add passage.
+      s.addPassage(new Passage('Start', 'Word'));
+      // Set start.
+      s.start = 'Start';
+      // Create HTML.
+      const result = s.toTwine2HTML();
+      // Expect the creator to be encoded.
+      expect(result.includes(`creator="${creatorName}"`)).toBe(true);
+    });
+
+    it('Should encode creatorVersion', () => {
+      // Add passage.
+      s.addPassage(new Passage('Start', 'Word'));
+      // Set start.
+      s.start = 'Start';
+      // Create HTML.
+      const result = s.toTwine2HTML();
+      // Expect the creatorVersion to be encoded.
+      expect(result.includes(`creator-version="${creatorVersion}"`)).toBe(true);
+    });
+
+    it('Should not encode creatorVersion if not set', () => {
+      // Add passage.
+      s.addPassage(new Passage('Start', 'Word'));
+      // Set start.
+      s.start = 'Start';
+      // Set creatorVersion to empty string.
+      s.creatorVersion = '';
+      // Create HTML.
+      const result = s.toTwine2HTML();
+      // Expect the creatorVersion to be encoded.
+      expect(result.includes(`creator-version="${creatorVersion}"`)).not.toBe(true);
+    });
+
+   it('Should not encode creator if not set', () => {
+      // Add passage.
+      s.addPassage(new Passage('Start', 'Word'));
+      // Set start.
+      s.start = 'Start';
+      // Set creator to empty string.
+      s.creator = '';
+      // Create HTML.
+      const result = s.toTwine2HTML();
+      // Expect the creator to be encoded.
+      expect(result.includes(`creator="${creatorName}"`)).not.toBe(true);
+    });
+
   });
 
   describe('toTwine1HTML()', function () {
@@ -635,4 +812,76 @@ describe('Story', () => {
       expect(result.includes('<div tiddler="Start"')).toBe(true);
     });
   });
+
+  describe('Escaping', function () {
+    it('Should produce valid Twine 2 Story HTML', function () {
+      // Create a new Story.
+      const s = new Story('"Abuse" &test');
+      // Add a passage.
+      s.addPassage(new Passage('"Test"', 'Word'));
+      // Set start.
+      s.start = '"Test"';
+      // Parse HTML.
+      const root = HTMLParser(s.toTwine2HTML());
+      // Expect correct name attribute for tw-storydata.
+      expect(root.querySelector('tw-storydata').getAttribute('name')).toBe('"Abuse" &test');
+      // Expect correct name attribute for tw-passagedata.
+      expect(root.querySelector('tw-passagedata').getAttribute('name')).toBe('"Test"');
+      // Use Twine 2 result.
+      const s2 = `<tw-storydata name="&quot;Abuse&quot; &amp;test" startnode="1" creator="Twine" creator-version="2.8.1" format="Harlowe" format-version="3.3.8" ifid="452A9D80-C759-42C5-B001-5B861A2410C5" options="" tags="" zoom="1" hidden><style role="stylesheet" id="twine-user-stylesheet" type="text/twine-css"></style><script role="script" id="twine-user-script" type="text/twine-javascript"></script><tw-passagedata pid="1" name="&quot;Test&quot;" tags="&amp;tag &quot;bad&quot;" position="300,100" size="100,100"></tw-passagedata></tw-storydata>`;
+      // Parse HTML.
+      const root2 = HTMLParser(s2);
+      // Expect correct name attribute for tw-storydata.
+      expect(root2.querySelector('tw-storydata').getAttribute('name')).toBe('"Abuse" &test');
+      // Expect correct name attribute for tw-passagedata.
+      expect(root2.querySelector('tw-passagedata').getAttribute('name')).toBe('"Test"');
+    });
+
+    it('Should produce valid Twine 1 Story HTML', function () {
+      // Create a new Story.
+      const s = new Story('"Abuse" &test');
+      // Add a passage.
+      s.addPassage(new Passage('"Test"', 'Word'));
+      // Set start.
+      s.start = '"Test"';
+      // Parse HTML.
+      const root = HTMLParser(s.toTwine1HTML());
+      // Expect correct name attribute for div.
+      expect(root.querySelector('div').getAttribute('tiddler')).toBe('"Test"');
+    });
+  });
+
+  describe('Warnings', function () {
+    beforeEach(() => {
+      // Mock console.warn.
+      jest.spyOn(console, 'warn').mockImplementation();
+    });
+
+    afterEach(() => {
+      // Restore all mocks.
+      jest.restoreAllMocks();
+    });
+
+    it('Should generate warning if a passage with the same name already exists', function () {
+      // Create a new Story.
+      const s = new Story();
+      // Add a passage.
+      s.addPassage(new Passage('Test'));
+      // Add a passage with the same name.
+      s.addPassage(new Passage('Test'));
+      // Expect warning.
+      expect(console.warn).toHaveBeenCalledWith('Warning: A passage with the name "Test" already exists!');
+    });
+
+    it('Should generate a warning if story IFID is not in the correct format', function () {
+      // Create a new Story.
+      const s = new Story();
+      // Set IFID.
+      s.IFID = 'Test';
+      // Create Twee
+      s.toTwee();
+      // Expect warning.
+      expect(console.warn).toHaveBeenCalledWith('Warning: IFID is not in UUIDv4 format! A new IFID was generated.');
+    });
+  });
 });