extwee 2.0.5 → 2.0.6

package/test/Passage.test.js

@@ -2,7 +2,7 @@ import Passage from '../src/Passage.js';
 
 describe('Passage', () => {
   describe('#constructor()', () => {
-    test('Set default values', () => {
+    it('Set default values', () => {
       const p = new Passage();
       expect(p.name).toBe('');
       expect(p.tags).toHaveLength(0);
@@ -13,13 +13,13 @@ describe('Passage', () => {
   });
 
   describe('name', () => {
-    test('Set name', () => {
+    it('Set name', () => {
       const p = new Passage();
       p.name = 'New';
       expect(p.name).toBe('New');
     });
 
-    test('Throw error if name is not String', () => {
+    it('Throw error if name is not String', () => {
       const p = new Passage();
       expect(() => {
         p.name = 1;
@@ -28,13 +28,13 @@ describe('Passage', () => {
   });
 
   describe('tags', () => {
-    test('Set tags', () => {
+    it('Set tags', () => {
       const p = new Passage();
       p.tags = ['tag'];
       expect(p.tags).toHaveLength(1);
     });
 
-    test('Throw error if tags is not Array', () => {
+    it('Throw error if tags is not Array', () => {
       const p = new Passage();
       expect(() => {
         p.tags = 1;
@@ -43,13 +43,13 @@ describe('Passage', () => {
   });
 
   describe('metadata', () => {
-    test('Set metadata', () => {
+    it('Set metadata', () => {
       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', () => {
+    it('Throw error if metadata is not an Object', () => {
       const p = new Passage();
       expect(() => {
         p.metadata = 1;
@@ -58,13 +58,13 @@ describe('Passage', () => {
   });
 
   describe('text', () => {
-    test('Set text', () => {
+    it('Set text', () => {
       const p = new Passage();
       p.text = 'New';
       expect(p.text).toBe('New');
     });
 
-    test('Throw error if text is not a String', () => {
+    it('Throw error if text is not a String', () => {
       const p = new Passage();
       expect(() => {
         p.text = 1;
@@ -73,13 +73,13 @@ describe('Passage', () => {
   });
 
   describe('pid', () => {
-    test('Set PID', () => {
+    it('Set PID', () => {
       const p = new Passage();
       p.pid = 12;
       expect(p.pid).toBe(12);
     });
 
-    test('Throw error if pid is not a Number', () => {
+    it('Throw error if pid is not a Number', () => {
       const p = new Passage();
       expect(() => {
         p.pid = [];
@@ -88,15 +88,15 @@ describe('Passage', () => {
   });
 
   describe('toString()', () => {
-    test('Create name string', () => {
+    it('Create name string', () => {
       const p = new Passage('Name', 'Test');
       expect(p.toString()).toBe(':: Name\nTest\n\n');
     });
-    test('Create tags string', () => {
+    it('Create tags string', () => {
       const p = new Passage('Name', 'Test', ['tags', 'another']);
       expect(p.toString()).toBe(':: Name [tags another]\nTest\n\n');
     });
-    test('Create metadata string', () => {
+    it('Create metadata string', () => {
       const p = new Passage('Name', 'Test', ['tags', 'another'], { position: '100,100' });
       expect(p.toString()).toBe(':: Name [tags another] {"position":"100,100"}\nTest\n\n');
     });

package/test/Roundtrip/example4.twee

@@ -0,0 +1,27 @@
+:: StoryTitle
+Example4
+
+:: user[script]
+console.log("Hi!");
+
+:: user2[script]
+console.log("Hi!");
+
+:: style1[stylesheet]
+body {
+    color: #ccc;
+}
+
+:: style2[stylesheet]
+html {
+    color: #ccc;
+}
+
+:: Start
+[[Another passage]]
+
+:: Another passage
+[[A third]]
+
+:: A third
+Double-click this passage to edit it.

package/test/Roundtrip/round.html

@@ -11,12 +11,9 @@
 
 <tw-story></tw-story>
 
-<tw-storydata name="Example1" startnode="4" creator="extwee" creator-version="2.0.5" ifid="CB42C064-4C1F-4D2B-9618-E9A7FCCE0AE2" zoom="0" format="Harlowe" format-version="3.0.2" options hidden>
+<tw-storydata name="Example1" startnode="4" creator="extwee" creator-version="2.0.6" ifid="BB4B4C20-2E2D-4283-B125-5550042AD3EB" zoom="0" format="Harlowe" format-version="3.0.2" 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="StoryTitle">Example1</tw-passagedata>
-	<tw-passagedata pid="2" name="UserScript" tags="script" ></tw-passagedata>
-	<tw-passagedata pid="3" name="UserStylesheet" tags="stylesheet" ></tw-passagedata>
 	<tw-passagedata pid="4" name="Start">[[Another passage]]</tw-passagedata>
 	<tw-passagedata pid="5" name="Another passage">[[A third]]</tw-passagedata>
 	<tw-passagedata pid="6" name="A third">Double-click this passage to edit it.</tw-passagedata>

package/test/Roundtrip.test.js

@@ -6,7 +6,7 @@ import StoryFormatParser from '../src/StoryFormatParser.js';
 import HTMLWriter from '../src/HTMLWriter.js';
 
 describe('Round-trip testing', () => {
-  test('Should round-trip HTML-to-Twee', () => {
+  it('Should round-trip HTML-to-Twee', () => {
     // Read HTML
     const fr = FileReader.read('test/Roundtrip/Example1.html');
     // Parse HTML
@@ -23,7 +23,7 @@ describe('Round-trip testing', () => {
     expect(s.ifid).toBe(s2.ifid);
   });
 
-  test('Should round-trip Twee-to-HTML', () => {
+  it('Should round-trip Twee-to-HTML', () => {
     // Read StoryFormat
     const storyFormat = FileReader.read('test/Roundtrip/harlowe.js');
     // Parse StoryFormat

package/test/Story.test.js

@@ -7,7 +7,7 @@ import FileReader from '../src/FileReader.js';
 const { name, version } = JSON.parse(FileReader.read('package.json'));
 
 describe('Story', () => {
-  describe('#constructor()', () => {
+  describe('#constructor()', () => {
     let s = null;
 
     beforeEach(() => {
@@ -23,7 +23,7 @@ describe('Story', () => {
     });
   });
 
-  describe('creator', () => {
+  describe('creator', () => {
     let s = null;
 
     beforeEach(() => {
@@ -42,7 +42,7 @@ describe('Story', () => {
     });
   });
 
-  describe('creatorVersion', () => {
+  describe('creatorVersion', () => {
     let s = null;
 
     beforeEach(() => {
@@ -61,7 +61,7 @@ describe('Story', () => {
     });
   });
 
-  describe('IFID', () => {
+  describe('IFID', () => {
     let s = null;
 
     beforeEach(() => {
@@ -80,7 +80,7 @@ describe('Story', () => {
     });
   });
 
-  describe('format', () => {
+  describe('format', () => {
     let s = null;
 
     beforeEach(() => {
@@ -99,7 +99,7 @@ describe('Story', () => {
     });
   });
 
-  describe('formatVersion', () => {
+  describe('formatVersion', () => {
     let s = null;
 
     beforeEach(() => {
@@ -118,7 +118,7 @@ describe('Story', () => {
     });
   });
 
-  describe('name', () => {
+  describe('name', () => {
     let s = null;
 
     beforeEach(() => {
@@ -137,7 +137,7 @@ describe('Story', () => {
     });
   });
 
-  describe('zoom', () => {
+  describe('zoom', () => {
     let s = null;
 
     beforeEach(() => {
@@ -156,7 +156,7 @@ describe('Story', () => {
     });
   });
 
-  describe('metadata', () => {
+  describe('metadata', () => {
     let s = null;
 
     beforeEach(() => {
@@ -175,7 +175,7 @@ describe('Story', () => {
     });
   });
 
-  describe('start', () => {
+  describe('start', () => {
     let s = null;
 
     beforeEach(() => {
@@ -194,7 +194,7 @@ describe('Story', () => {
     });
   });
 
-  describe('tagColors', () => {
+  describe('tagColors', () => {
     let s = null;
 
     beforeEach(() => {
@@ -216,7 +216,7 @@ describe('Story', () => {
     });
   });
 
-  describe('addPassage()', () => {
+  describe('addPassage()', () => {
     let s = null;
 
     beforeEach(() => {
@@ -244,22 +244,22 @@ describe('Story', () => {
     });
   });
 
-  describe('removePassage()', () => {
+  describe('removePassageByName()', () => {
     let s = null;
 
     beforeEach(() => {
       s = new Story();
     });
 
-    it('removePassage() - should decrease size', () => {
+    it('removePassageByName() - should decrease size', () => {
       s.addPassage(new Passage('Find'));
       s.addPassage(new Passage('Find2'));
-      s.removePassage('Find');
+      s.removePassageByName('Find');
       expect(s.size()).toBe(1);
     });
   });
 
-  describe('getPassagesByTag()', () => {
+  describe('getPassagesByTag()', () => {
     let s = null;
 
     beforeEach(() => {
@@ -290,7 +290,7 @@ describe('Story', () => {
     });
   });
 
-  describe('getPassageByName()', () => {
+  describe('getPassageByName()', () => {
     let s = null;
 
     beforeEach(() => {
@@ -305,7 +305,7 @@ describe('Story', () => {
     });
   });
 
-  describe('getPassageByPID()', () => {
+  describe('getPassageByPID()', () => {
     let s = null;
 
     beforeEach(() => {
@@ -324,7 +324,7 @@ describe('Story', () => {
     });
   });
 
-  describe('forEach()', () => {
+  describe('forEach()', () => {
     let s = null;
 
     beforeEach(() => {
@@ -346,9 +346,30 @@ describe('Story', () => {
         s.forEach(null);
       }).toThrow();
     });
+
+    it('forEach() - should ignore StoryTitle', () => {
+      let count = 0;
+      s.addPassage(new Passage('StoryTitle', 'Test'));
+      s.forEach(() => {count++});
+      expect(count).toBe(0);
+    });
+
+    it('forEach() - should ignore "script" tags', () => {
+      let count = 0;
+      s.addPassage(new Passage('Test', 'Test', ['script']));
+      s.forEach(() => {count++});
+      expect(count).toBe(0);
+    });
+
+    it('forEach() - should ignore "stylesheet" tags', () => {
+      let count = 0;
+      s.addPassage(new Passage('Test', 'Test', ['stylesheet']));
+      s.forEach(() => {count++});
+      expect(count).toBe(0);
+    });
   });
 
-  describe('size()', () => {
+  describe('size()', () => {
     let s = null;
 
     beforeEach(() => {
@@ -365,5 +386,38 @@ describe('Story', () => {
       // Test size after adding one
       expect(s.size()).toBe(1);
     });
+
+    it('size() - should not count StoryTitle', () => {
+      // Create a Passage
+      const p = new Passage('StoryTitle', 'Test');
+      // Test initial size
+      expect(s.size()).toBe(0);
+      // Add a passage
+      s.addPassage(p);
+      // Test size after adding one
+      expect(s.size()).toBe(0);
+    });
+
+    it('size() - should not count script tags', () => {
+      // Create a Passage
+      const p = new Passage('Test', 'Test', ['script']);
+      // Test initial size
+      expect(s.size()).toBe(0);
+      // Add a passage
+      s.addPassage(p);
+      // Test size after adding one
+      expect(s.size()).toBe(0);
+    });
+
+    it('size() - should not count script tags', () => {
+      // Create a Passage
+      const p = new Passage('Test', 'Test', ['stylesheet']);
+      // Test initial size
+      expect(s.size()).toBe(0);
+      // Add a passage
+      s.addPassage(p);
+      // Test size after adding one
+      expect(s.size()).toBe(0);
+    });
   });
 });

package/test/StoryFormat.test.js

@@ -1,8 +1,8 @@
 import StoryFormat from '../src/StoryFormat.js';
 
-describe('StoryFormat', function () {
-  describe('#constructor()', function () {
-    test('Should create default values', function () {
+describe('StoryFormat', () => {
+  describe('#constructor()', () => {
+    it('Should create default values', () => {
       const sf = new StoryFormat();
       expect(sf.name).toBe('');
       expect(sf.version).toBe('');
@@ -15,14 +15,14 @@ describe('StoryFormat', function () {
     });
   });
 
-  describe('name', function () {
-    test('Set new String', function () {
+  describe('name', () => {
+    it('Set new String', () => {
       const sf = new StoryFormat();
       sf.name = 'New';
       expect(sf.name).toBe('New');
     });
 
-    test('Throw error if non-String', function () {
+    it('Throw error if non-String', () => {
       const sf = new StoryFormat();
       expect(() => {
         sf.name = 1;
@@ -30,14 +30,14 @@ describe('StoryFormat', function () {
     });
   });
 
-  describe('version', function () {
-    test('Set new String', function () {
+  describe('version', () => {
+    it('Set new String', () => {
       const sf = new StoryFormat();
       sf.version = 'New';
       expect(sf.version).toBe('New');
     });
 
-    test('Throw error if non-String', function () {
+    it('Throw error if non-String', () => {
       const sf = new StoryFormat();
       expect(() => {
         sf.version = 1;
@@ -45,14 +45,14 @@ describe('StoryFormat', function () {
     });
   });
 
-  describe('author', function () {
-    test('Set new String', function () {
+  describe('author', () => {
+    it('Set new String', () => {
       const sf = new StoryFormat();
       sf.author = 'New';
       expect(sf.author).toBe('New');
     });
 
-    test('Throw error if non-String', function () {
+    it('Throw error if non-String', () => {
       const sf = new StoryFormat();
       expect(() => {
         sf.author = 1;
@@ -60,14 +60,14 @@ describe('StoryFormat', function () {
     });
   });
 
-  describe('image', function () {
-    test('Set new String', function () {
+  describe('image', () => {
+    it('Set new String', () => {
       const sf = new StoryFormat();
       sf.image = 'New';
       expect(sf.image).toBe('New');
     });
 
-    test('Throw error if non-String', function () {
+    it('Throw error if non-String', () => {
       const sf = new StoryFormat();
       expect(() => {
         sf.image = 1;
@@ -75,14 +75,14 @@ describe('StoryFormat', function () {
     });
   });
 
-  describe('url', function () {
-    test('Set new String', function () {
+  describe('url', () => {
+    it('Set new String', () => {
       const sf = new StoryFormat();
       sf.url = 'New';
       expect(sf.url).toBe('New');
     });
 
-    test('Throw error if non-String', function () {
+    it('Throw error if non-String', () => {
       const sf = new StoryFormat();
       expect(() => {
         sf.url = 1;
@@ -90,14 +90,14 @@ describe('StoryFormat', function () {
     });
   });
 
-  describe('license', function () {
-    test('Set new String', function () {
+  describe('license', () => {
+    it('Set new String', () => {
       const sf = new StoryFormat();
       sf.license = 'New';
       expect(sf.license).toBe('New');
     });
 
-    test('Throw error if non-String', function () {
+    it('Throw error if non-String', () => {
       const sf = new StoryFormat();
       expect(() => {
         sf.license = 1;
@@ -105,14 +105,14 @@ describe('StoryFormat', function () {
     });
   });
 
-  describe('proofing', function () {
-    test('Set new String', function () {
+  describe('proofing', () => {
+    it('Set new String', () => {
       const sf = new StoryFormat();
       sf.proofing = true;
       expect(sf.proofing).toBe(true);
     });
 
-    test('Throw error if non-String', function () {
+    it('Throw error if non-String', () => {
       const sf = new StoryFormat();
       expect(() => {
         sf.proofing = 1;
@@ -120,14 +120,14 @@ describe('StoryFormat', function () {
     });
   });
 
-  describe('source', function () {
-    test('Set new String', function () {
+  describe('source', () => {
+    it('Set new String', () => {
       const sf = new StoryFormat();
       sf.source = 'New';
       expect(sf.source).toBe('New');
     });
 
-    test('Throw error if non-String', function () {
+    it('Throw error if non-String', () => {
       const sf = new StoryFormat();
       expect(() => {
         sf.source = 1;
@@ -135,14 +135,14 @@ describe('StoryFormat', function () {
     });
   });
 
-  describe('description', function () {
-    test('Set new String', function () {
+  describe('description', () => {
+    it('Set new String', () => {
       const sf = new StoryFormat();
       sf.description = 'New';
       expect(sf.description).toBe('New');
     });
 
-    test('Throw error if non-String', function () {
+    it('Throw error if non-String', () => {
       const sf = new StoryFormat();
       expect(() => {
         sf.description = 1;

package/test/StoryFormatParser.test.js

@@ -1,87 +1,87 @@
 import StoryFormatParser from '../src/StoryFormatParser.js';
 import FileReader from '../src/FileReader';
 
-describe('StoryFormatParser', function () {
-  describe('#parse()', function () {
-    test('Should throw error if JSON missing', function () {
+describe('StoryFormatParser', () => {
+  describe('#parse()', () => {
+    it('Should throw error if JSON missing', () => {
       const fr = FileReader.read('test/StoryFormatParser/example.js');
       expect(() => { StoryFormatParser.parse(fr); }).toThrow();
     });
 
-    test('Should throw error if JSON malformed', function () {
+    it('Should throw error if JSON malformed', () => {
       const fr = FileReader.read('test/StoryFormatParser/example2.js');
       expect(() => { StoryFormatParser.parse(fr); }).toThrow();
     });
 
-    test('Should correctly parse a StoryFormat name', function () {
+    it('Should correctly parse a StoryFormat name', () => {
       const fr = FileReader.read('test/StoryFormatParser/format.js');
       const sfp = StoryFormatParser.parse(fr);
       expect(sfp.name).toBe('Snowman');
     });
 
-    test('Should correctly parse Harlowe story format', function () {
+    it('Should correctly parse Harlowe story format', () => {
       const fr = FileReader.read('test/StoryFormatParser/harlowe.js');
       const sfp = StoryFormatParser.parse(fr);
       expect(sfp.name).toBe('Harlowe');
     });
 
-    test('Should detect missing name and set default', function () {
+    it('Should detect missing name and set default', () => {
       const fr = FileReader.read('test/StoryFormatParser/missingName.js');
       const sfp = StoryFormatParser.parse(fr);
       expect(sfp.name).toBe('Untitled Story Format');
     });
 
-    test('Should detect missing author and set default', function () {
+    it('Should detect missing author and set default', () => {
       const fr = FileReader.read('test/StoryFormatParser/missingAuthor.js');
       const sfp = StoryFormatParser.parse(fr);
       expect(sfp.author).toBe('');
     });
 
-    test('Should detect missing description and set default', function () {
+    it('Should detect missing description and set default', () => {
       const fr = FileReader.read('test/StoryFormatParser/missingDescription.js');
       const sfp = StoryFormatParser.parse(fr);
       expect(sfp.description).toBe('');
     });
 
-    test('Should detect missing image and set default', function () {
+    it('Should detect missing image and set default', () => {
       const fr = FileReader.read('test/StoryFormatParser/missingImage.js');
       const sfp = StoryFormatParser.parse(fr);
       expect(sfp.image).toBe('');
     });
 
-    test('Should detect missing url and set default', function () {
+    it('Should detect missing url and set default', () => {
       const fr = FileReader.read('test/StoryFormatParser/missingURL.js');
       const sfp = StoryFormatParser.parse(fr);
       expect(sfp.url).toBe('');
     });
 
-    test('Should detect missing license and set default', function () {
+    it('Should detect missing license and set default', () => {
       const fr = FileReader.read('test/StoryFormatParser/missingLicense.js');
       const sfp = StoryFormatParser.parse(fr);
       expect(sfp.license).toBe('');
     });
 
-    test('Should detect proofing license and set default', function () {
+    it('Should detect proofing license and set default', () => {
       const fr = FileReader.read('test/StoryFormatParser/missingProofing.js');
       const sfp = StoryFormatParser.parse(fr);
       expect(sfp.proofing).toBe(false);
     });
 
-    test('Should throw error if version does not exist', function () {
+    it('Should throw error if version does not exist', () => {
       const fr = FileReader.read('test/StoryFormatParser/missingVersion.js');
       expect(() => {
         StoryFormatParser.parse(fr);
       }).toThrow();
     });
 
-    test('Should throw error if version is not semantic style', function () {
+    it('Should throw error if version is not semantic style', () => {
       const fr = FileReader.read('test/StoryFormatParser/versionWrong.js');
       expect(() => {
         StoryFormatParser.parse(fr);
       }).toThrow();
     });
 
-    test('Should throw error if source is not found', function () {
+    it('Should throw error if source is not found', () => {
       const fr = FileReader.read('test/StoryFormatParser/missingSource.js');
       expect(() => {
         StoryFormatParser.parse(fr);

package/test/TweeWriter/test1.twee

@@ -1,6 +1,6 @@
 :: StoryData
 {
-  "ifid": "040C569C-2902-48C7-B8FD-0471A2190DA6",
+  "ifid": "6BD10D27-BA22-42E1-A024-4E1AD35D8B59",
   "format": "Test",
   "format-version": "1.2.3",
   "zoom": 1,