extwee 2.2.0 → 2.2.2

package/test/Twine2HTML/Twine2HTML.Compile.test.js

@@ -1,8 +1,10 @@
 import { parse as parseStoryFormat } from '../../src/StoryFormat/parse.js';
 import { parse as parseTwine2HTML } from '../../src/Twine2HTML/parse.js';
 import { compile as compileTwine2HTML } from '../../src/Twine2HTML/compile.js';
-import Story from '../../src/Story.js';
+import { Story } from '../../src/Story.js';
 import Passage from '../../src/Passage.js';
+import StoryFormat from '../../src/StoryFormat.js';
+import { generate as generateIFID } from '../../src/IFID/generate.js';
 import { readFileSync } from 'node:fs';
 
 describe('Twine2HTMLCompiler', () => {
@@ -16,29 +18,6 @@ describe('Twine2HTMLCompiler', () => {
       expect(() => { compileTwine2HTML(s, {}); }).toThrow();
     });
 
-    it('Read, write, and read HTML', () => {
-      // Read HTML.
-      const fr = readFileSync('test/Twine2HTML/Twine2HTMLParser/twineExample3.html', 'utf-8');
-
-      // Parse HTML.
-      const story = parseTwine2HTML(fr);
-
-      // Read StoryFormat.
-      const fr2 = readFileSync('test/StoryFormat/StoryFormatParser/format.js', 'utf-8');
-
-      // Parse StoryFormat.
-      const storyFormat = parseStoryFormat(fr2);
-
-      // Write HTML.
-      const fr3 = compileTwine2HTML(story, storyFormat);
-
-      // Parse HTML.
-      const story2 = parseTwine2HTML(fr3);
-
-      // Test both names to be the same.
-      expect(story.name).toBe(story2.name);
-    });
-
     it('Should write one and two-tag passages', () => {
       // Read HTML.
       const fr = readFileSync('test/Twine2HTML/Twine2HTMLCompiler/TestTags.html', 'utf-8');
@@ -47,7 +26,7 @@ describe('Twine2HTMLCompiler', () => {
       const story = parseTwine2HTML(fr);
 
       // Read StoryFormat.
-      const fr2 = readFileSync('test/StoryFormat/StoryFormatParser/format.js', 'utf-8');
+      const fr2 = readFileSync('test/Twine2HTML/Twine2HTMLCompiler/format.js', 'utf-8');
 
       // Parse StoryFormat.
       const storyFormat = parseStoryFormat(fr2);
@@ -62,12 +41,12 @@ describe('Twine2HTMLCompiler', () => {
       let tags2 = '';
 
       // Combine contents of tags.
-      story.forEachPassage((p) => {
+      story.passages.forEach((p) => {
         tags += p.tags.join('');
       });
 
       // Combine contents of tags.
-      story2.forEachPassage((p) => {
+      story2.passages.forEach((p) => {
         tags2 += p.tags.join('');
       });
 
@@ -76,148 +55,84 @@ describe('Twine2HTMLCompiler', () => {
       expect(tags).toBe(tags2);
     });
 
-    it('Should not add optional position to passages', () => {
-      // Create Story.
-      const story = new Story();
-      // Add passage.
-      story.addPassage(new Passage('A'));
-      // Add passage.
-      story.addPassage(new Passage('B'));
-      // Add StoryTitle
-      story.addPassage(new Passage('StoryTitle', 'Title'));
-      // Add Start
-      story.addPassage(new Passage('Start', 'Content'));
-
-      // Read StoryFormat.
-      const fr2 = readFileSync('test/StoryFormat/StoryFormatParser/format.js', 'utf-8');
-
-      // Parse StoryFormat.
-      const storyFormat = parseStoryFormat(fr2);
-
-      // Set start
-      story.start = 'Start';
-
-      // Write out HTML with story and storyFormat.
-      // (Will add position to passages without them.)
-      const fr3 = compileTwine2HTML(story, storyFormat);
-
-      // Parse new HTML file.
-      const story2 = parseTwine2HTML(fr3);
-
-      // Verify none of the directly created passages have position.
-      story.forEachPassage((passage) => {
-        expect(Object.prototype.hasOwnProperty.call(passage.metadata, 'position')).toBe(false);
-      });
-
-      // Verify none parsed passages have position.
-      story2.forEachPassage((passage) => {
-        expect(Object.prototype.hasOwnProperty.call(passage.metadata, 'position')).toBe(false);
-      });
-    });
-
-    it("Don't write creator if missing originally", () => {
+    it('Throw error if IFID does not exist', () => {
       // Create a new story.
       const story = new Story();
 
       // Create a passage.
       story.addPassage(new Passage('A'));
 
-      // Create another passage.
-      story.addPassage(new Passage('B'));
-
-      // Create another passage.
-      story.addPassage(new Passage('StoryTitle', 'Title'));
-
-      // Add Start
-      story.addPassage(new Passage('Start', 'Content'));
-
-      // Set start
-      story.start = 'Start';
-
       // Read StoryFormat.
-      const fr2 = readFileSync('test/StoryFormat/StoryFormatParser/format.js', 'utf-8');
+      const fr2 = readFileSync('test/Twine2HTML/Twine2HTMLCompiler/format.js', 'utf-8');
 
       // Parse StoryFormat.
       const storyFormat = parseStoryFormat(fr2);
 
-      // Write the HTML.
-      const fr3 = compileTwine2HTML(story, storyFormat);
-
-      // Parse HTML.
-      const story2 = parseTwine2HTML(fr3);
-
-      // Test creator (should be default)
-      expect(story.creator).toBe('extwee');
-
-      // Test parsed creator (should be default)
-      expect(story2.creator).toBe('extwee');
-
-      // Creator should be the same
-      expect(story.creator).toBe(story2.creator);
+      expect(() => {
+        compileTwine2HTML(story, storyFormat);
+      }).toThrow();
     });
 
-    it('Throw error if StoryTitle does not exist', () => {
+    it('Throw error if starting passage property does not exist', () => {
       // Create a new story.
       const story = new Story();
 
       // Create a passage.
       story.addPassage(new Passage('A'));
 
+      // Create StoryTitle
+      story.addPassage(new Passage('StoryTitle', 'Name'));
+
+      // Set a passage that doesn't exist
+      story.start = 'Nope';
+
       // Read StoryFormat.
-      const fr2 = readFileSync('test/StoryFormat/StoryFormatParser/format.js', 'utf-8');
+      const fr2 = readFileSync('test/Twine2HTML/Twine2HTMLCompiler/format.js', 'utf-8');
 
       // Parse StoryFormat.
       const storyFormat = parseStoryFormat(fr2);
 
+      // Throws error.
       expect(() => {
         compileTwine2HTML(story, storyFormat);
       }).toThrow();
     });
 
-    it('Throw error if no start or Start exists', () => {
+    it('Throw error if source is empty string in StoryFormat', () => {
       // Create a new story.
       const story = new Story();
 
-      // Create a passage.
-      story.addPassage(new Passage('A'));
-
-      // Create StoryTitle
-      story.addPassage(new Passage('StoryTitle', 'Name'));
-
-      // Read StoryFormat.
-      const fr2 = readFileSync('test/StoryFormat/StoryFormatParser/format.js', 'utf-8');
+      // Create StoryFormat.
+      const sf = new StoryFormat();
 
-      // Parse StoryFormat.
-      const storyFormat = parseStoryFormat(fr2);
+      // Set source to empty string.
+      sf.source = '';
 
       // Throws error.
       expect(() => {
-        compileTwine2HTML(story, storyFormat);
+        compileTwine2HTML(story, sf);
       }).toThrow();
     });
 
-    it('Throw error if starting passage property does not exist', () => {
+    it('Throw error if story name is empty string', () => {
       // Create a new story.
       const story = new Story();
 
-      // Create a passage.
-      story.addPassage(new Passage('A'));
-
-      // Create StoryTitle
-      story.addPassage(new Passage('StoryTitle', 'Name'));
+      // Create StoryFormat.
+      const sf = new StoryFormat();
 
-      // Set a passage that doesn't exist
-      story.start = 'Nope';
+      // Set source to non-empty string.
+      sf.source = 'Test';
 
-      // Read StoryFormat.
-      const fr2 = readFileSync('test/StoryFormat/StoryFormatParser/format.js', 'utf-8');
+      // Generate IFID (to avoid throwing error).
+      story.IFID = generateIFID();
 
-      // Parse StoryFormat.
-      const storyFormat = parseStoryFormat(fr2);
+      // Set story name to empty string.
+      story.name = '';
 
       // Throws error.
       expect(() => {
-        compileTwine2HTML(story, storyFormat);
+        compileTwine2HTML(story, sf);
       }).toThrow();
     });
   });

package/test/Twine2HTML/Twine2HTML.Parse.test.js

@@ -1,12 +1,12 @@
 import { readFileSync } from 'node:fs';
-import { parse as parseTwine2HTML, escapeMetacharacters } from '../../src/Twine2HTML/parse.js';
+import { parse as parseTwine2HTML } from '../../src/Twine2HTML/parse.js';
 
 // Pull the name and version of this project from package.json.
 // These are used as the 'creator' and 'creator-version'.
 const { version } = JSON.parse(readFileSync('package.json', 'utf-8'));
 
 describe('Twine2HTMLParser', () => {
-  describe('#parse()', () => {
+  describe('Errors', () => {
     it('Should throw error if content is not a string', () => {
       expect(() => { parseTwine2HTML({}); }).toThrow();
     });
@@ -14,7 +14,9 @@ describe('Twine2HTMLParser', () => {
     it('Should throw error if content is not Twine-2 style HTML', () => {
       expect(() => { parseTwine2HTML(''); }).toThrow();
     });
+  });
 
+  describe('#parse()', () => {
     it('Should be able to parse Twine 2 HTML for story name', () => {
       const fr = readFileSync('test/Twine2HTML/Twine2HTMLParser/twineExample.html', 'utf-8');
       const story = parseTwine2HTML(fr);
@@ -34,18 +36,6 @@ describe('Twine2HTMLParser', () => {
       expect(p.tags).toHaveLength(2);
     });
 
-    it('Should have default name', () => {
-      const fr = readFileSync('test/Twine2HTML/Twine2HTMLParser/missingName.html', 'utf-8');
-      const story = parseTwine2HTML(fr);
-      expect(story.name).toBe('');
-    });
-
-    it('Should set a missing IFID to an empty string', () => {
-      const fr = readFileSync('test/Twine2HTML/Twine2HTMLParser/missingIFID.html', 'utf-8');
-      const tp = parseTwine2HTML(fr);
-      expect(tp.IFID).toBe('');
-    });
-
     it('Should have Extwee for creator when missing', () => {
       const fr = readFileSync('test/Twine2HTML/Twine2HTMLParser/missingCreator.html', 'utf-8');
       const tp = parseTwine2HTML(fr);
@@ -73,7 +63,7 @@ describe('Twine2HTMLParser', () => {
     it('Should have empty string as zoom when missing', () => {
       const fr = readFileSync('test/Twine2HTML/Twine2HTMLParser/missingZoom.html', 'utf-8');
       const tp = parseTwine2HTML(fr);
-      expect(tp.zoom).toBe(0);
+      expect(tp.zoom).toBe(1);
     });
 
     it('Should not have position if passage does not', () => {
@@ -120,19 +110,10 @@ describe('Twine2HTMLParser', () => {
       expect(stylesheetPassages.length).toBe(1);
     });
 
-    it('Should throw error if startNode is missing', () => {
+    it('Should parse HTML without passage start node', () => {
       const fr = readFileSync('test/Twine2HTML/Twine2HTMLParser/missingStartnode.html', 'utf-8');
-      expect(() => { parseTwine2HTML(fr); }).toThrow();
-    });
-
-    it('Should throw error if passage name is missing', () => {
-      const fr = readFileSync('test/Twine2HTML/Twine2HTMLParser/missingPassageName.html', 'utf-8');
-      expect(() => { parseTwine2HTML(fr); }).toThrow();
-    });
-
-    it('Should throw error without PID', () => {
-      const fr = readFileSync('test/Twine2HTML/Twine2HTMLParser/missingPID.html', 'utf-8');
-      expect(() => { parseTwine2HTML(fr); }).toThrow();
+      const story = parseTwine2HTML(fr);
+      expect(story.start).toBe('');
     });
 
     it('Should parse tag colors', () => {
@@ -143,18 +124,6 @@ describe('Twine2HTMLParser', () => {
       expect(tagColors.a).toBe('red');
     });
 
-    it('Should throw error if startnode is missing', () => {
-      const fr = readFileSync('test/Twine2HTML/Twine2HTMLParser/missingStartnode.html', 'utf-8');
-      expect(() => { parseTwine2HTML(fr); }).toThrow();
-    });
-
-    it('Should throw error when startnode has PID that does not exist', () => {
-      const fr = readFileSync('test/Twine2HTML/Twine2HTMLParser/lyingStartnode.html', 'utf-8');
-      expect(() => {
-        parseTwine2HTML(fr);
-      }).toThrow();
-    });
-
     it('Do not update name and color if those attributes do not exist', () => {
       const fr = readFileSync('test/Twine2HTML/Twine2HTMLParser/lyingTagColors.html', 'utf-8');
       const story = parseTwine2HTML(fr);
@@ -163,10 +132,61 @@ describe('Twine2HTMLParser', () => {
     });
   });
 
-  describe('#escapeMetacharacters()', () => {
-    it('Should escape metacharacters', () => {
-      /* eslint no-useless-escape: "off" */
-      expect(escapeMetacharacters('\\\{\\\}\\\[\\\]\\\\')).toBe('\\\\{\\\\}\\\\[\\\\]\\\\');
+  describe('Unescaping', () => {
+    it('Should unescape HTML metacharacters for passage searching', () => {
+      const fr = readFileSync('test/Twine2HTML/Twine2HTMLParser/unescaping.html', 'utf-8');
+      const story = parseTwine2HTML(fr);
+      expect(story.getPassageByName('"Test"').text).toBe('Success');
+    });
+  });
+
+  describe('Warnings', () => {
+    beforeEach(() => {
+      // Mock console.warn.
+      jest.spyOn(console, 'warn').mockImplementation();
+    });
+
+    afterEach(() => {
+      // Restore all mocks.
+      jest.restoreAllMocks();
+    });
+
+    it('Should generate a warning if name attribute is missing from tw-storydata', () => {
+      const s = '<tw-storydata ifid=\'E70FC479-01D9-4E44-AC6A-AFF9F5E1C475\'></tw-storydata>';
+      parseTwine2HTML(s);
+      expect(console.warn).toHaveBeenCalledWith('Warning: The name attribute is missing from tw-storydata!');
+    });
+
+    it('Should generate a warning if ifid attribute is missing from tw-storydata', () => {
+      const s = '<tw-storydata name=\'Test\'></tw-storydata>';
+      parseTwine2HTML(s);
+      expect(console.warn).toHaveBeenCalledWith('Warning: The ifid attribute is missing from tw-storydata!');
+    });
+
+    it('Should generate a warning if ifid on tw-storydata is malformed', () => {
+      const s = '<tw-storydata ifid=\'1234\'></tw-storydata>';
+      parseTwine2HTML(s);
+      expect(console.warn).toHaveBeenCalledWith('Warning: The IFID is not in valid UUIDv4 formatting on tw-storydata!');
+    });
+
+    it('Should generate warning if passage name is missing', () => {
+      const fr = `<tw-storydata name="Tags" startnode="1" creator="Twine" creator-version="2.3.9" ifid="1A6023FC-F68A-4E55-BE9A-5EDFDB7879E6" zoom="1" format="Harlowe" format-version="3.1.0" options="" 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" tags="this-one another-one-like-this" position="200,99" size="100,100">Double-click this passage to edit it.</tw-passagedata>
+  </tw-storydata>`;
+      parseTwine2HTML(fr);
+      expect(console.warn).toHaveBeenCalledWith('Warning: name attribute is missing! Default passage name will be used.');
+    });
+
+    it('Should generate error if passage PID is missing', () => {
+      const fr = `<tw-storydata name="Tags" startnode="1" creator="Twine" creator-version="2.3.9" ifid="1A6023FC-F68A-4E55-BE9A-5EDFDB7879E6" zoom="1" format="Harlowe" format-version="3.1.0" options="" 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 name="Untitled Passage" tags="this-one another-one-like-this" position="200,99" size="100,100">Double-click this passage to edit it.</tw-passagedata>
+  </tw-storydata>`;
+      parseTwine2HTML(fr);
+      expect(console.warn).toHaveBeenCalledWith('Warning: pid attribute is missing! Default PID will be used.');
     });
   });
 });

package/test/Twine2HTML/Twine2HTMLCompiler/format.js

@@ -0,0 +1,9 @@
+window.storyFormat({
+	"name": "Test Story Format",
+	"version": "1.0.0",
+	"author": "Dan Cox",
+    "description": "A test story format.",
+    "source": "<!DOCTYPE html><html><head><meta charset=\"utf-8\"><title>{{STORY_NAME}}</title><style>body { font-family: Arial, sans-serif; }</style></head><body>{{STORY_DATA}}</body></html>",
+    "license": "MIT",
+    "proofing": false
+});

package/test/Twine2HTML/Twine2HTMLParser/missingZoom.html

@@ -6,6 +6,6 @@
 </head>
 <body>
 <tw-story></tw-story>
-<tw-storydata name="Tags" startnode="1" creator="Twine" creator-version="2.3.9" ifid="1A6023FC-F68A-4E55-BE9A-5EDFDB7879E6 format="Harlowe" format-version="3.1.0" options="" 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="Untitled Passage" tags="this-one another-one-like-this" position="200,99" size="100,100">Double-click this passage to edit it.</tw-passagedata></tw-storydata>
+<tw-storydata name="Tags" startnode="1" creator="Twine" creator-version="2.3.9" ifid="1A6023FC-F68A-4E55-BE9A-5EDFDB7879E6" format="Harlowe" format-version="3.1.0" options="" 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="Untitled Passage" tags="this-one another-one-like-this" position="200,99" size="100,100">Double-click this passage to edit it.</tw-passagedata></tw-storydata>
 </body>
 </html>