extwee 2.0.5 → 2.2.0

package/test/StoryFormat.test.js

@@ -1,152 +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();
-    });
-  });
-});
+import StoryFormat from '../src/StoryFormat.js';
+
+describe('StoryFormat', () => {
+  describe('constructor()', () => {
+    it('Should create default values', () => {
+      const sf = new StoryFormat();
+      expect(sf.name).toBe('Untitled Story Format');
+      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', () => {
+    it('Set new String', () => {
+      const sf = new StoryFormat();
+      sf.name = 'New';
+      expect(sf.name).toBe('New');
+    });
+
+    it('Throw error if non-String', () => {
+      const sf = new StoryFormat();
+      expect(() => {
+        sf.name = 1;
+      }).toThrow();
+    });
+  });
+
+  describe('version', () => {
+    it('Set new String', () => {
+      const sf = new StoryFormat();
+      sf.version = 'New';
+      expect(sf.version).toBe('New');
+    });
+
+    it('Throw error if non-String', () => {
+      const sf = new StoryFormat();
+      expect(() => {
+        sf.version = 1;
+      }).toThrow();
+    });
+  });
+
+  describe('author', () => {
+    it('Set new String', () => {
+      const sf = new StoryFormat();
+      sf.author = 'New';
+      expect(sf.author).toBe('New');
+    });
+
+    it('Throw error if non-String', () => {
+      const sf = new StoryFormat();
+      expect(() => {
+        sf.author = 1;
+      }).toThrow();
+    });
+  });
+
+  describe('image', () => {
+    it('Set new String', () => {
+      const sf = new StoryFormat();
+      sf.image = 'New';
+      expect(sf.image).toBe('New');
+    });
+
+    it('Throw error if non-String', () => {
+      const sf = new StoryFormat();
+      expect(() => {
+        sf.image = 1;
+      }).toThrow();
+    });
+  });
+
+  describe('url', () => {
+    it('Set new String', () => {
+      const sf = new StoryFormat();
+      sf.url = 'New';
+      expect(sf.url).toBe('New');
+    });
+
+    it('Throw error if non-String', () => {
+      const sf = new StoryFormat();
+      expect(() => {
+        sf.url = 1;
+      }).toThrow();
+    });
+  });
+
+  describe('license', () => {
+    it('Set new String', () => {
+      const sf = new StoryFormat();
+      sf.license = 'New';
+      expect(sf.license).toBe('New');
+    });
+
+    it('Throw error if non-String', () => {
+      const sf = new StoryFormat();
+      expect(() => {
+        sf.license = 1;
+      }).toThrow();
+    });
+  });
+
+  describe('proofing', () => {
+    it('Set new String', () => {
+      const sf = new StoryFormat();
+      sf.proofing = true;
+      expect(sf.proofing).toBe(true);
+    });
+
+    it('Throw error if non-String', () => {
+      const sf = new StoryFormat();
+      expect(() => {
+        sf.proofing = 1;
+      }).toThrow();
+    });
+  });
+
+  describe('source', () => {
+    it('Set new String', () => {
+      const sf = new StoryFormat();
+      sf.source = 'New';
+      expect(sf.source).toBe('New');
+    });
+
+    it('Throw error if non-String', () => {
+      const sf = new StoryFormat();
+      expect(() => {
+        sf.source = 1;
+      }).toThrow();
+    });
+  });
+
+  describe('description', () => {
+    it('Set new String', () => {
+      const sf = new StoryFormat();
+      sf.description = 'New';
+      expect(sf.description).toBe('New');
+    });
+
+    it('Throw error if non-String', () => {
+      const sf = new StoryFormat();
+      expect(() => {
+        sf.description = 1;
+      }).toThrow();
+    });
+  });
+});

package/test/TWS/Parse.test.js

@@ -0,0 +1,78 @@
+import fs from 'node:fs';
+import { parse as parseTWS } from '../../src/TWS/parse.js';
+
+describe('TWSParser', () => {
+  describe('#parse()', () => {
+    it('Should throw error if input is not Buffer', function () {
+      expect(() => { parseTWS(0); }).toThrow();
+    });
+
+    describe('Story parsing', function () {
+      let r = null;
+
+      beforeAll(() => {
+        const contents = fs.readFileSync('test/TWS/TWSParser/Example1.tws', 'binary');
+        const b = Buffer.from(contents, 'binary');
+        r = parseTWS(b);
+      });
+
+      it('Should parse StoryTitle', function () {
+        expect(r.name).toBe('Untitled Story');
+      });
+
+      it('Should parse zoom', function () {
+        expect(r.zoom).toBe(1);
+      });
+
+      it('Should parse start passage', function () {
+        expect(r.start).toBe('Start');
+      });
+    });
+
+    describe('Passage parsing', function () {
+      let r = null;
+
+      beforeAll(() => {
+        const contents = fs.readFileSync('test/TWS/TWSParser/Example5.tws', 'binary');
+        const b = Buffer.from(contents, 'binary');
+        r = parseTWS(b);
+      });
+
+      it('Should parse passage - tags', function () {
+        const p = r.getPassageByName('Untitled Passage 1');
+        expect(p.tags.length).toBe(3);
+      });
+
+      it('Should parse passage - text', function () {
+        const p = r.getPassageByName('Untitled Passage 2');
+        expect(p.text).toBe('dd');
+      });
+
+      it('Should set Story start (to start passage)', function () {
+        expect(r.start).toBe('Start');
+      });
+    });
+
+    describe('Exceptions and parsing issues', function () {
+      it('Should throw error if parsing a Buffer but not pickle data', function () {
+        const contents = 'Test';
+        const b = Buffer.from(contents);
+        expect(() => { parseTWS(b); }).toThrow();
+      });
+
+      it('Should create default Story object if pickle data but not TWS data', function () {
+        const contents = fs.readFileSync('test/TWS/TWSParser/nostory.tws', 'binary');
+        const b = Buffer.from(contents, 'binary');
+        const r = parseTWS(b);
+        expect(r.size()).toBe(0);
+      });
+
+      it('Should parse storyPanel but no scale', function () {
+        const contents = fs.readFileSync('test/TWS/TWSParser/noscale.tws', 'binary');
+        const b = Buffer.from(contents, 'binary');
+        const r = parseTWS(b);
+        expect(r.zoom).toBe(0);
+      });
+    });
+  });
+});

package/test/TWS/TWSParser/Example1.tws

@@ -0,0 +1,150 @@
+(dp0
+S'buildDestination'
+p1
+S''
+p2
+sS'saveDestination'
+p3
+V\u005c\u005cMac\u005cDropbox\u005cExample1.tws
+p4
+sS'metadata'
+p5
+(dp6
+sS'target'
+p7
+S'sugarcane'
+p8
+sS'storyPanel'
+p9
+(dp10
+S'widgets'
+p11
+(lp12
+(dp13
+S'selected'
+p14
+I00
+sS'pos'
+p15
+(lp16
+I10
+aI10
+asS'passage'
+p17
+(itiddlywiki
+Tiddler
+p18
+(dp20
+S'text'
+p21
+S'Your story will display this passage first. Edit it by double clicking it.'
+p22
+sS'title'
+p23
+S'Start'
+p24
+sS'modified'
+p25
+ctime
+struct_time
+p26
+((I2023
+I9
+I3
+I14
+I38
+I52
+I6
+I246
+I1
+tp27
+(dp28
+tp29
+Rp30
+sS'tags'
+p31
+(lp32
+sS'created'
+p33
+g30
+sbsa(dp34
+g14
+I00
+sg15
+(lp35
+I10
+aI150
+asg17
+(itiddlywiki
+Tiddler
+p36
+(dp37
+g21
+S'Untitled Story'
+p38
+sg23
+S'StoryTitle'
+p39
+sg25
+g26
+((I2023
+I9
+I3
+I14
+I38
+I52
+I6
+I246
+I1
+tp40
+(dp41
+tp42
+Rp43
+sg31
+(lp44
+sg33
+g43
+sbsa(dp45
+g14
+I00
+sg15
+(lp46
+I10
+aI290
+asg17
+(itiddlywiki
+Tiddler
+p47
+(dp48
+g21
+S'Anonymous'
+p49
+sg23
+S'StoryAuthor'
+p50
+sg25
+g26
+((I2023
+I9
+I3
+I14
+I38
+I52
+I6
+I246
+I1
+tp51
+(dp52
+tp53
+Rp54
+sg31
+(lp55
+sg33
+g54
+sbsasS'scale'
+p56
+I1
+sS'snapping'
+p57
+I00
+ss.