extwee 1.5.3 → 2.0.0

package/test/HTMLWriter.test.js

@@ -0,0 +1,279 @@
+import FileReader from '../src/FileReader.js';
+import StoryFormatParser from '../src/StoryFormatParser.js';
+import HTMLParser from '../src/HTMLParser.js';
+import TweeParser from '../src/TweeParser.js';
+import HTMLWriter from '../src/HTMLWriter.js';
+import Story from '../src/Story.js';
+import Passage from '../src/Passage.js';
+
+describe('HTMLWriter', function () {
+  describe('#write()', function () {
+    test('story should be instanceof Story', function () {
+      expect(() => { HTMLWriter.write('test/HTMLWriter/test.html', {}); }).toThrow();
+    });
+
+    test('storyFormat should be instanceof StoryFormat', function () {
+      const s = new Story();
+      expect(() => { HTMLWriter.write('test/HTMLWriter/test.html', s, {}); }).toThrow();
+    });
+
+    test('Read, write, and read HTML', function () {
+      // Read HTML.
+      const fr = FileReader.read('test/HTMLParser/twineExample3.html');
+      // Parse HTML.
+      const story = HTMLParser.parse(fr);
+
+      const s1Title = story.getPassageByName('StoryTitle').text;
+
+      // Read StoryFormat.
+      const fr2 = FileReader.read('test/StoryFormatParser/format.js');
+      // Parse StoryFormat.
+      const storyFormat = StoryFormatParser.parse(fr2);
+
+      // Write HTML.
+      HTMLWriter.write('test/HTMLWriter/test2.html', story, storyFormat);
+
+      // Read HTML.
+      const fr3 = FileReader.read('test/HTMLWriter/test2.html');
+      // Parse HTML.
+      const story2 = HTMLParser.parse(fr3);
+
+      const s2Title = story2.getPassageByName('StoryTitle').text;
+
+      // Test both names to be the same.
+      expect(s1Title).toBe(s2Title);
+    });
+
+    test('Should write one and two-tag passages', function () {
+      // Read HTML.
+      const fr = FileReader.read('test/HTMLWriter/TestTags.html');
+      // Parse HTML.
+      const story = HTMLParser.parse(fr);
+
+      // Read StoryFormat.
+      const fr2 = FileReader.read('test/StoryFormatParser/format.js');
+      // Parse StoryFormat.
+      const storyFormat = StoryFormatParser.parse(fr2);
+
+      // Write HTML.
+      HTMLWriter.write('test/HTMLWriter/test3.html', story, storyFormat);
+
+      // Read HTML.
+      const fr3 = FileReader.read('test/HTMLWriter/test3.html');
+      // Parse HTML.
+      const story2 = HTMLParser.parse(fr3);
+
+      let tags = '';
+      let tags2 = '';
+
+      // Combine contents of tags.
+      story.forEach((p) => {
+        tags += p.tags.join('');
+      });
+
+      // Combine contents of tags.
+      story2.forEach((p) => {
+        tags2 += p.tags.join('');
+      });
+
+      // Test combination tags.
+      // They should be the same.
+      expect(tags).toBe(tags2);
+    });
+
+    test('Should throw error if file path invalid', function () {
+      // Read HTML.
+      const fr = FileReader.read('test/HTMLParser/twineExample3.html');
+      // Parse HTML.
+      const story = HTMLParser.parse(fr);
+
+      // Read StoryFormat.
+      const fr2 = FileReader.read('test/StoryFormatParser/format.js');
+      // Parse StoryFormat.
+      const storyFormat = StoryFormatParser.parse(fr2);
+
+      // Throw error if path is invalid.
+      expect(() => {
+        HTMLWriter.write('test2/HTMLWriter/test2.html', story, storyFormat);
+      }).toThrow();
+    });
+
+    test('Should not add optional position to passages', function () {
+      // 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 = FileReader.read('test/StoryFormatParser/format.js');
+      // Parse StoryFormat.
+      const storyFormat = StoryFormatParser.parse(fr2);
+
+      // Write out HTML with story and storyFormat.
+      // (Will add position to passages without them.)
+      HTMLWriter.write('test/HTMLWriter/test4.html', story, storyFormat);
+
+      // Read new HTML file.
+      const fr3 = FileReader.read('test/HTMLWriter/test4.html');
+      // Parse new HTML file.
+      const story2 = HTMLParser.parse(fr3);
+
+      // Verify none of the directly created passages have position.
+      story.forEach((passage) => {
+        expect(Object.prototype.hasOwnProperty.call(passage.metadata, 'position')).toBe(false);
+      });
+
+      // Verify none parsed passages have position.
+      story2.forEach((passage) => {
+        expect(Object.prototype.hasOwnProperty.call(passage.metadata, 'position')).toBe(false);
+      });
+    });
+
+    test("Don't write creator if missing originally", function () {
+      // 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'));
+
+      // Read StoryFormat.
+      const fr2 = FileReader.read('test/StoryFormatParser/format.js');
+      // Parse StoryFormat.
+      const storyFormat = StoryFormatParser.parse(fr2);
+
+      // Write the HTML.
+      HTMLWriter.write('test/HTMLWriter/creator.html', story, storyFormat);
+
+      // Read HTML.
+      const fr3 = FileReader.read('test/HTMLWriter/creator.html');
+      // Parse HTML.
+      const story2 = HTMLParser.parse(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);
+    });
+
+    test('Throw error if StoryTitle does not exist', function () {
+      // Create a new story.
+      const story = new Story();
+
+      // Create a passage.
+      story.addPassage(new Passage('A'));
+
+      // Read StoryFormat.
+      const fr2 = FileReader.read('test/StoryFormatParser/format.js');
+      // Parse StoryFormat.
+      const storyFormat = StoryFormatParser.parse(fr2);
+
+      expect(() => {
+        HTMLWriter.write('test', story, storyFormat);
+      }).toThrow();
+    });
+
+    test('Throw error if no start or Start exists', function () {
+      // 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 = FileReader.read('test/StoryFormatParser/format.js');
+      // Parse StoryFormat.
+      const storyFormat = StoryFormatParser.parse(fr2);
+
+      // Throws error
+      expect(() => {
+        HTMLWriter.write('test/HTMLWriter/test6.html', story, storyFormat);
+      }).toThrow();
+    });
+
+    test('Write with Start without start', function () {
+      // 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 Start
+      story.addPassage(new Passage('Start', 'Content'));
+
+      // Read StoryFormat.
+      const fr2 = FileReader.read('test/StoryFormatParser/format.js');
+      // Parse StoryFormat.
+      const storyFormat = StoryFormatParser.parse(fr2);
+
+      // Write file
+      HTMLWriter.write('test/HTMLWriter/test6.html', story, storyFormat);
+
+      // Read new HTML file.
+      const fr3 = FileReader.read('test/HTMLWriter/test6.html');
+      // Parse new HTML file.
+      const story2 = HTMLParser.parse(fr3);
+
+      // Should not be start
+      expect(story2.start).toBe('Start');
+    });
+
+    test('Throw error if starting passage property does not exist', function () {
+      // 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 = FileReader.read('test/StoryFormatParser/format.js');
+      // Parse StoryFormat.
+      const storyFormat = StoryFormatParser.parse(fr2);
+
+      // Throws error
+      expect(() => {
+        HTMLWriter.write('test/HTMLWriter/test7.html', story, storyFormat);
+      }).toThrow();
+    });
+
+    test('Should correctly replace all instances of STORY_NAME', function () {
+      const fr = FileReader.read('test/HTMLWriter/example6.twee');
+      const story = TweeParser.parse(fr);
+      const storyFormatFile = FileReader.read('test/StoryFormatParser/format_doublename.js');
+      const sfp = StoryFormatParser.parse(storyFormatFile);
+      HTMLWriter.write('test/HTMLWriter/test11.html', story, sfp);
+      const frh = FileReader.read('test/HTMLWriter/test11.html');
+      expect(frh.indexOf('STORY_NAME')).toBe(-1);
+    });
+  });
+});

package/test/Passage.test.js

@@ -0,0 +1,104 @@
+import Passage from '../src/Passage.js';
+
+describe('Passage', function () {
+  describe('#constructor()', function () {
+    test('Set default values', function () {
+      const p = new Passage();
+      expect(p.name).toBe('');
+      expect(p.tags).toHaveLength(0);
+      expect(p.text).toBe('');
+      expect(typeof p.metadata).toBe('object');
+      expect(p.pid).toBe(-1);
+    });
+  });
+
+  describe('name', function () {
+    test('Set name', function () {
+      const p = new Passage();
+      p.name = 'New';
+      expect(p.name).toBe('New');
+    });
+
+    test('Throw error if name is not String', function () {
+      const p = new Passage();
+      expect(() => {
+        p.name = 1;
+      }).toThrow();
+    });
+  });
+
+  describe('tags', function () {
+    test('Set tags', function () {
+      const p = new Passage();
+      p.tags = ['tag'];
+      expect(p.tags).toHaveLength(1);
+    });
+
+    test('Throw error if tags is not Array', function () {
+      const p = new Passage();
+      expect(() => {
+        p.tags = 1;
+      }).toThrow();
+    });
+  });
+
+  describe('metadata', function () {
+    test('Set metadata', function () {
+      const p = new Passage();
+      p.metadata = { position: '100,100' };
+      expect(p.metadata).toEqual({ position: '100,100' });
+    });
+
+    test('Throw error if metadata is not an Object', function () {
+      const p = new Passage();
+      expect(() => {
+        p.metadata = 1;
+      }).toThrow();
+    });
+  });
+
+  describe('text', function () {
+    test('Set text', function () {
+      const p = new Passage();
+      p.text = 'New';
+      expect(p.text).toBe('New');
+    });
+
+    test('Throw error if text is not a String', function () {
+      const p = new Passage();
+      expect(() => {
+        p.text = 1;
+      }).toThrow();
+    });
+  });
+
+  describe('pid', function () {
+    test('Set PID', function () {
+      const p = new Passage();
+      p.pid = 12;
+      expect(p.pid).toBe(12);
+    });
+
+    test('Throw error if pid is not a Number', function () {
+      const p = new Passage();
+      expect(() => {
+        p.pid = [];
+      }).toThrow();
+    });
+  });
+
+  describe('toString()', function () {
+    test('Create name string', function () {
+      const p = new Passage('Name', 'Test');
+      expect(p.toString()).toBe(':: Name\nTest\n\n');
+    });
+    test('Create tags string', function () {
+      const p = new Passage('Name', 'Test', ['tags', 'another']);
+      expect(p.toString()).toBe(':: Name [tags another]\nTest\n\n');
+    });
+    test('Create metadata string', function () {
+      const p = new Passage('Name', 'Test', ['tags', 'another'], { position: '100,100' });
+      expect(p.toString()).toBe(':: Name [tags another] {"position":"100,100"}\nTest\n\n');
+    });
+  });
+});