extwee 2.0.5 → 2.2.0

package/test/{TweeParser → Twee/TweeParser}/notes.twee

@@ -1,16 +1,16 @@
-/**
-  These are some notes at the top of the file
-*/
-:: StoryTitle
-twineExample
-
-:: Start {"position":"102,104","size":"100,100"}
-Start passage
-
-:: StoryData
-{
-    "ifid": "2B68ECD6-348F-4CF5-96F8-549A512A8128",
-    "format": "Harlowe",
-    "formatVersion": "2.1.0",
-    "zoom": "1"
-}
+/**
+  These are some notes at the top of the file
+*/
+:: StoryTitle
+twineExample
+
+:: Start {"position":"102,104","size":"100,100"}
+Start passage
+
+:: StoryData
+{
+    "ifid": "2B68ECD6-348F-4CF5-96F8-549A512A8128",
+    "format": "Harlowe",
+    "formatVersion": "2.1.0",
+    "zoom": "1"
+}

package/test/{TweeParser → Twee/TweeParser}/pasagemetadataerror.twee

@@ -1,2 +1,2 @@
-:: Start {"position}
-Some content
+:: Start {"position}
+Some content

package/test/{TweeParser → Twee/TweeParser}/scriptPassage.twee

@@ -1,16 +1,16 @@
-:: Start
-Content
-
-:: StoryTitle
-Title
-
-:: UserScript [script]
-window.example = {}
-
-:: StoryData
-{
-    "ifid": "2B68ECD6-348F-4CF5-96F8-549A512A8128",
-    "format": "Harlowe",
-    "formatVersion": "2.1.0",
-    "zoom": "1"
-}
+:: Start
+Content
+
+:: StoryTitle
+Title
+
+:: UserScript [script]
+window.example = {}
+
+:: StoryData
+{
+    "ifid": "2B68ECD6-348F-4CF5-96F8-549A512A8128",
+    "format": "Harlowe",
+    "formatVersion": "2.1.0",
+    "zoom": "1"
+}

package/test/{TweeParser → Twee/TweeParser}/singletag.twee

@@ -1,13 +1,13 @@
-:: Start [tag]
-Content
-
-:: StoryTitle
-Title
-
-:: StoryData
-{
-    "ifid": "2B68ECD6-348F-4CF5-96F8-549A512A8128",
-    "format": "Harlowe",
-    "formatVersion": "2.1.0",
-    "zoom": "1"
-}
+:: Start [tag]
+Content
+
+:: StoryTitle
+Title
+
+:: StoryData
+{
+    "ifid": "2B68ECD6-348F-4CF5-96F8-549A512A8128",
+    "format": "Harlowe",
+    "formatVersion": "2.1.0",
+    "zoom": "1"
+}

package/test/{TweeParser → Twee/TweeParser}/startMetadata.twee

@@ -1,14 +1,14 @@
-:: StoryTitle
-Example
-
-:: StoryData
- {
-  "ifid": "A74F654F-3F85-44DE-8A87-9845AECD04B0",
-  "format": "Harlowe",
-  "formatVersion": "3.2.1",
-  "zoom": "1",
-  "start": "Untitled Passage"
-}
-
-:: Untitled Passage {"position":"100,99","size":"100,100"}
-Double-click this passage to edit it.
+:: StoryTitle
+Example
+
+:: StoryData
+ {
+  "ifid": "A74F654F-3F85-44DE-8A87-9845AECD04B0",
+  "format": "Harlowe",
+  "formatVersion": "3.2.1",
+  "zoom": "1",
+  "start": "Untitled Passage"
+}
+
+:: Untitled Passage {"position":"100,99","size":"100,100"}
+Double-click this passage to edit it.

package/test/{TweeParser → Twee/TweeParser}/storydataerror.twee

@@ -1,25 +1,25 @@
-:: StoryTitle
-twineExample
-
-:: Start
-Some content.
-
-:: StoryData
-{
-    "ifid": 2B68ECD6-348F-4CF5-96F8-549A512A8128",
-    "format": "Harlowe",
-    "formatVersion": "2.1.0",
-    "zoom": "1"
-}
-
-:: Script1 [script]
-// Some code
-
-:: Script2 [script]
-//More code here!
-
-:: Style1 [stylesheet]
-body {font-size: 1.2em}
-
-:: Style2 [stylesheet]
-p {font-style: italic;}
+:: StoryTitle
+twineExample
+
+:: Start
+Some content.
+
+:: StoryData
+{
+    "ifid": 2B68ECD6-348F-4CF5-96F8-549A512A8128",
+    "format": "Harlowe",
+    "formatVersion": "2.1.0",
+    "zoom": "1"
+}
+
+:: Script1 [script]
+// Some code
+
+:: Script2 [script]
+//More code here!
+
+:: Style1 [stylesheet]
+body {font-size: 1.2em}
+
+:: Style2 [stylesheet]
+p {font-style: italic;}

package/test/{TweeParser → Twee/TweeParser}/stylePassage.twee

@@ -1,16 +1,16 @@
-:: Start
-Content
-
-:: StoryTitle
-Title
-
-:: UserStylesheet [stylesheet]
-1
-
-:: StoryData
-{
-    "ifid": "2B68ECD6-348F-4CF5-96F8-549A512A8128",
-    "format": "Harlowe",
-    "formatVersion": "2.1.0",
-    "zoom": "1"
-}
+:: Start
+Content
+
+:: StoryTitle
+Title
+
+:: UserStylesheet [stylesheet]
+1
+
+:: StoryData
+{
+    "ifid": "2B68ECD6-348F-4CF5-96F8-549A512A8128",
+    "format": "Harlowe",
+    "formatVersion": "2.1.0",
+    "zoom": "1"
+}

package/test/{Story → Twee/TweeParser}/test.twee

@@ -1,25 +1,25 @@
-:: StoryTitle
-twineExample
-
-:: Start
-Some content.
-
-:: StoryData
-{
-    "ifid": "2B68ECD6-348F-4CF5-96F8-549A512A8128",
-    "format": "Harlowe",
-    "formatVersion": "2.1.0",
-    "zoom": "1"
-}
-
-:: Script1 [script]
-// Some code
-
-:: Script2 [script]
-//More code here!
-
-:: Style1 [stylesheet]
-body {font-size: 1.2em}
-
-:: Style2 [stylesheet]
-p {font-style: italic;}
+:: StoryTitle
+twineExample
+
+:: Start
+Some content.
+
+:: StoryData
+{
+    "ifid": "2B68ECD6-348F-4CF5-96F8-549A512A8128",
+    "format": "Harlowe",
+    "formatVersion": "2.1.0",
+    "zoom": "1"
+}
+
+:: Script1 [script]
+// Some code
+
+:: Script2 [script]
+//More code here!
+
+:: Style1 [stylesheet]
+body {font-size: 1.2em}
+
+:: Style2 [stylesheet]
+p {font-style: italic;}

package/test/Twine1HTML/Twine1HTML.Compile.test.js

@@ -0,0 +1,180 @@
+import { compile as compileTwine1HTML } from '../../src/Twine1HTML/compile.js';
+import Story from '../../src/Story.js';
+import { readFileSync } from 'fs';
+import Passage from '../../src/Passage.js';
+
+describe('Twine1HTMLCompiler', () => {
+  describe('compile()', () => {
+    it('story should be instanceof Story', () => {
+      expect(() => { compileTwine1HTML({}); }).toThrow();
+    });
+
+    it('Should create an empty file without valid header.html', function () {
+      // Create story.
+      const s = new Story();
+
+      // Compile Twine 1.
+      const t1 = compileTwine1HTML(s);
+
+      // Test.
+      expect(t1.length).toBe(0);
+    });
+
+    it('Should replace "VERSION" and "TIME" in mock header.html file', function () {
+      // Create story.
+      const s = new Story();
+
+      // Set creator.
+      s.creator = 'Test1';
+
+      // Read mock header.html
+      const header = readFileSync('test/Twine1HTML/Twine1HTMLCompiler/test1.html', 'utf-8');
+
+      // Read engine code.
+      const engine = readFileSync('test/Twine1HTML/Twine1HTMLCompiler/Twine1/engine.js', 'utf-8');
+
+      // Compile file.
+      const result = compileTwine1HTML(s, engine, header);
+
+      // Test for creator.
+      expect(result.includes('Test1')).toBe(true);
+
+      // Test for time.
+      expect(result.includes(new Date().getFullYear().toString())).toBe(true);
+    });
+
+    it('Should include Twine engine code', function () {
+      // Create story.
+      const s = new Story();
+
+      // Read mock header.html
+      const header = readFileSync('test/Twine1HTML/Twine1HTMLCompiler/engineTest.html', 'utf-8');
+
+      // Read engine code.
+      const engine = readFileSync('test/Twine1HTML/Twine1HTMLCompiler/Twine1/engine.js', 'utf-8');
+
+      // Compile file.
+      compileTwine1HTML(s, engine, header);
+
+      // Read file.
+      const result = readFileSync('test/Twine1HTML/Twine1HTMLCompiler/test3.html', 'utf-8');
+
+      // Test for engine.
+      expect(result.includes('function clone(a)')).toBe(true);
+    });
+
+    it('Should include story format based on name', function () {
+      // Create story.
+      const s = new Story();
+
+      // Add passage.
+      s.addPassage(new Passage('Start', 'Work'));
+
+      // Set story start.
+      s.start = 'Start';
+
+      // Read header.html.
+      const header = readFileSync('test/Twine1HTML/Twine1HTMLCompiler/jonah-1.4.2/header.html', 'utf-8');
+
+      // Read code.js.
+      const codeJS = readFileSync('test/Twine1HTML/Twine1HTMLCompiler/jonah-1.4.2/code.js', 'utf-8');
+
+      // Read engine code.
+      const engine = readFileSync('test/Twine1HTML/Twine1HTMLCompiler/Twine1/engine.js', 'utf-8');
+
+      // Compile file.
+      const result = compileTwine1HTML(s, engine, header, 'jonah', codeJS);
+
+      // Test for code.js.
+      expect(result.includes('Tale.prototype.canBookmark')).toBe(true);
+
+      // Test for passage.
+      expect(result.includes('tiddler="Start"')).toBe(true);
+
+      // Test for story size.
+      expect(result.includes('data-size="1"')).toBe(true);
+    });
+
+    it('Should include story format based on name with jQuery and Modernizr', function () {
+      // Create story.
+      const s = new Story();
+
+      // Add passage.
+      s.addPassage(new Passage('Start', 'Work'));
+
+      // Set story start.
+      s.start = 'Start';
+
+      // Read header.html.
+      const header = readFileSync('test/Twine1HTML/Twine1HTMLCompiler/jonah-1.4.2/header.html', 'utf-8');
+
+      // Read code.js.
+      const codeJS = readFileSync('test/Twine1HTML/Twine1HTMLCompiler/jonah-1.4.2/code.js', 'utf-8');
+
+      // Read engine code.
+      const engine = readFileSync('test/Twine1HTML/Twine1HTMLCompiler/Twine1/engine.js', 'utf-8');
+
+      // Read Modernizr.
+      const Modernizr = readFileSync('test/Twine1HTML/Twine1HTMLCompiler/Twine1/modernizr.js');
+
+      // Read jQuery.
+      const jQuery = readFileSync('test/Twine1HTML/Twine1HTMLCompiler/Twine1/jquery.js');
+
+      // Compile file.
+      const result = compileTwine1HTML(s, engine, header, 'jonah', codeJS, { jquery: jQuery, modernizr: Modernizr });
+
+      // Test for code.js.
+      expect(result.includes('Tale.prototype.canBookmark')).toBe(true);
+
+      // Test for passage.
+      expect(result.includes('tiddler="Start"')).toBe(true);
+
+      // Test for story size.
+      expect(result.includes('data-size="1"')).toBe(true);
+
+      // Test for jQuery.
+      expect(result.includes('jQuery v1.11.0')).toBe(true);
+
+      // Test for Modernizr.
+      expect(result.includes('Modernizr 2.6.2')).toBe(true);
+    });
+
+    it('Should include story format based on name without jQuery and Modernizr', function () {
+      // Create story.
+      const s = new Story();
+
+      // Add passage.
+      s.addPassage(new Passage('Start', 'Work'));
+
+      // Set story start.
+      s.start = 'Start';
+
+      // Read header.html.
+      const header = readFileSync('test/Twine1HTML/Twine1HTMLCompiler/jonah-1.4.2/header.html', 'utf-8');
+
+      // Read code.js.
+      const codeJS = readFileSync('test/Twine1HTML/Twine1HTMLCompiler/jonah-1.4.2/code.js', 'utf-8');
+
+      // Read engine code.
+      const engine = readFileSync('test/Twine1HTML/Twine1HTMLCompiler/Twine1/engine.js', 'utf-8');
+
+      // Compile file.
+      const result = compileTwine1HTML(s, engine, header, 'jonah', codeJS, {});
+
+      // Test for code.js.
+      expect(result.includes('Tale.prototype.canBookmark')).toBe(true);
+
+      // Test for passage.
+      expect(result.includes('tiddler="Start"')).toBe(true);
+
+      // Test for story size.
+      expect(result.includes('data-size="1"')).toBe(true);
+
+      // Test for jQuery
+      expect(result.includes('jQuery v1.11.0')).not.toBe(true);
+
+      // Test for Modernizr
+      expect(result.includes('Modernizr 2.6.2')).not.toBe(true);
+    });
+  });
+});

package/test/Twine1HTML/Twine1HTML.Parse.test.js

@@ -0,0 +1,183 @@
+import { parse as parseTwine1HTML } from '../../src/Twine1HTML/parse.js';
+
+describe('Twine1HTML', function () {
+  describe('parse()', function () {
+    it('Should throw error if elements cannot be found', function () {
+      expect(() => { parseTwine1HTML('{'); }).toThrow();
+    });
+
+    it('Should parse a single passage - storeArea', function () {
+      const el = '<div id="storeArea"><div tiddler="Untitled Passage 4" tags="" created="202309031439" modifier="twee" twine-position="401,10">dd</div></div>';
+
+      // Parse Twine 1 HTML.
+      const s = parseTwine1HTML(el);
+
+      // Expect a single passage.
+      expect(s.size()).toBe(1);
+
+      // Expect creator
+      expect(s.creator).toBe('twee');
+
+      // Look for the passage.
+      const p = s.getPassageByName('Untitled Passage 4');
+
+      // Expect passage name.
+      expect(p.name).toBe('Untitled Passage 4');
+
+      // Expect no tags.
+      expect(p.tags.length).toBe(0);
+
+      // Expect position
+      expect(p.metadata.position).toBe('401,10');
+
+      // Expect text
+      expect(p.text).toBe('dd');
+    });
+
+    it('Should parse a single passage - store-area', function () {
+      const el = '<div id="store-area"><div tiddler="Untitled Passage 4" tags="" created="202309031439" modifier="twee" twine-position="401,10">dd</div></div>';
+
+      // Parse Twine 1 HTML.
+      const s = parseTwine1HTML(el);
+
+      // Expect a single passage.
+      expect(s.size()).toBe(1);
+
+      // Expect creator
+      expect(s.creator).toBe('twee');
+
+      // Look for the passage.
+      const p = s.getPassageByName('Untitled Passage 4');
+
+      // Expect passage name.
+      expect(p.name).toBe('Untitled Passage 4');
+
+      // Expect no tags.
+      expect(p.tags.length).toBe(0);
+
+      // Expect position
+      expect(p.metadata.position).toBe('401,10');
+
+      // Expect text
+      expect(p.text).toBe('dd');
+    });
+
+    it('Should override name with StoryTitle', function () {
+      const el = '<div id="storeArea"><div tiddler="StoryTitle" tags="" created="202309031438" modifier="twee" twine-position="10,150">Untitled Story</div></div>';
+      const s = parseTwine1HTML(el);
+      expect(s.name).toBe('Untitled Story');
+    });
+
+    it('Should parse a single passage with multiple tags', function () {
+      const el = '<div id="storeArea"><div tiddler="Untitled Passage 1" tags="tag1, tag2, tag3" created="202309031439" modifier="twee" twine-position="262,10">[[Untitled Passage 2]]</div></div>';
+
+      // Parse Twine 1 HTML.
+      const s = parseTwine1HTML(el);
+
+      // Expect a single passage.
+      expect(s.size()).toBe(1);
+
+      // Expect creator
+      expect(s.creator).toBe('twee');
+
+      // Look for the passage.
+      const p = s.getPassageByName('Untitled Passage 1');
+
+      // Expect passage name.
+      expect(p.name).toBe('Untitled Passage 1');
+
+      // Expect no tags.
+      expect(p.tags.length).toBe(3);
+
+      // Expect position
+      expect(p.metadata.position).toBe('262,10');
+
+      // Expect text
+      expect(p.text).toBe('[[Untitled Passage 2]]');
+    });
+
+    it('Should parse a single passage without twine-position', function () {
+      const el = '<div id="storeArea"><div tiddler="Untitled Passage 1" tags="tag1, tag2, tag3" created="202309031439" modifier="twee">[[Untitled Passage 2]]</div></div>';
+
+      // Parse Twine 1 HTML.
+      const s = parseTwine1HTML(el);
+
+      // Expect a single passage.
+      expect(s.size()).toBe(1);
+
+      // Expect creator
+      expect(s.creator).toBe('twee');
+
+      // Look for the passage.
+      const p = s.getPassageByName('Untitled Passage 1');
+
+      // Expect passage name.
+      expect(p.name).toBe('Untitled Passage 1');
+
+      // Expect no tags.
+      expect(p.tags.length).toBe(3);
+
+      // Expect position to not exist.
+      expect(Object.prototype.hasOwnProperty.call(p.metadata, 'position')).toBe(false);
+
+      // Expect text.
+      expect(p.text).toBe('[[Untitled Passage 2]]');
+    });
+
+    it('Should parse a single passage without tags', function () {
+      const el = '<div id="storeArea"><div tiddler="Untitled Passage 1" created="202309031439" modifier="twee">[[Untitled Passage 2]]</div></div>';
+
+      // Parse Twine 1 HTML.
+      const s = parseTwine1HTML(el);
+
+      // Expect a single passage.
+      expect(s.size()).toBe(1);
+
+      // Expect creator
+      expect(s.creator).toBe('twee');
+
+      // Look for the passage.
+      const p = s.getPassageByName('Untitled Passage 1');
+
+      // Expect passage name.
+      expect(p.name).toBe('Untitled Passage 1');
+
+      // Expect no tags.
+      expect(p.tags.length).toBe(0);
+
+      // Expect position to not exist.
+      expect(Object.prototype.hasOwnProperty.call(p.metadata, 'position')).toBe(false);
+
+      // Expect text.
+      expect(p.text).toBe('[[Untitled Passage 2]]');
+    });
+
+    it('Should parse a single passage without modifier', function () {
+      const el = '<div id="storeArea"><div tiddler="Untitled Passage 1" tags="tag1, tag2, tag3" created="202309031439">[[Untitled Passage 2]]</div></div>';
+
+      // Parse Twine 1 HTML.
+      const s = parseTwine1HTML(el);
+
+      // Expect a single passage.
+      expect(s.size()).toBe(1);
+
+      // Expect default creator
+      expect(s.creator).toBe('extwee');
+
+      // Look for the passage.
+      const p = s.getPassageByName('Untitled Passage 1');
+
+      // Expect passage name.
+      expect(p.name).toBe('Untitled Passage 1');
+
+      // Expect no tags.
+      expect(p.tags.length).toBe(3);
+
+      // Expect position to not exist.
+      expect(Object.prototype.hasOwnProperty.call(p.metadata, 'position')).toBe(false);
+
+      // Expect text.
+      expect(p.text).toBe('[[Untitled Passage 2]]');
+    });
+  });
+});