Publish standalone Document Parser (ampproject#1552)

Make it possible to standalone parse a document. Also
set different runtime types.

Author: sebastianbenz

lib/Document.js

@@ -33,6 +33,9 @@ module.exports = class Document {
     this.body = '';
     this.elementsAfterBody = '';
     this.isAmpStory = false;
+    this.isAmpWeb = false;
+    this.isAmpAds = false;
+    this.isAmpEmail = false;
   }
 
   addSection(section) {

lib/DocumentParser.js

@@ -140,7 +140,13 @@ class DocumentParser {
   updateHtmlTag(line) {
     if (this.extractTag(line) == 'html') {
       this.document.lang = this.attr(line, 'lang') || DEFAULT_LANG;
-      return;
+      if (line.includes('4ads')) {
+        this.document.isAmpAds = true;
+      } else if (line.includes('4email')) {
+        this.document.isAmpEmail = true;
+      } else {
+        this.document.isAmpWeb = true;
+      }
     }
   }
 
@@ -159,7 +165,7 @@ class DocumentParser {
     if (!this.document.title) {
       const title = /\s*<title>(.*?)<\/title>/g.exec(line);
       if (title) {
-        this.document.title = title[1];
+        this.document.title = title[1].trim();
       }
     }
     if (line.indexOf('<style amp-custom>') > -1) {

lib/ExampleFile.js

@@ -136,7 +136,7 @@ class ExampleFile {
   }
 
   title() {
-    return FileName.toString(this.fileName());
+    return FileName.toString(this.fileName()).trim();
   }
 
   url() {

lib/Preview.js

@@ -177,5 +177,4 @@ function writeFile(filePath, content) {
   fs.writeFileSync(filePath, content);
 };
 
-module.exports = {};
-module.exports.generatePreview = generateEmbeds;
+module.exports = generateEmbeds;

lib/Standalone.js

@@ -0,0 +1,38 @@
+/**
+ * Copyright 2015 Google Inc. All Rights Reserved.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *      http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS-IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+"use strict";
+
+const {parse} = require('./DocumentParser.js');
+const ExampleFile = require('./ExampleFile.js');
+
+const {promisify} = require('util');
+const fs = require('fs');
+const readFileAsync = promisify(fs.readFile); 
+
+module.exports = async (filePath) => {
+  const contents = await readFileAsync(filePath, 'utf-8');
+  const doc = parse(contents);
+  const exampleFile = ExampleFile.fromPath(filePath);
+  if (!doc.title) {
+    console.warn(`${filePath} has no title`);
+    doc.title = exampleFile.title(); 
+  } else if (doc.title !== exampleFile.title()) {
+    console.warn(`${filePath} has invalid title: "${exampleFile.title()}" vs "${doc.title}"`);
+  }
+  exampleFile.document = doc;
+  return exampleFile;
+}

lib/index.js

@@ -0,0 +1,22 @@
+/**
+ * Copyright 2015 Google Inc. All Rights Reserved.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *      http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS-IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+"use strict";
+
+module.exports = {};
+module.exports.generatePreview = require('./Preview.js');
+module.exports.loadExample = require('./Standalone.js');
+

package.json

@@ -1,12 +1,12 @@
 {
   "name": "amp-by-example",
-  "version": "0.1.5",
+  "version": "0.2.1",
   "description": "AMP by example",
   "repository": {
     "type": "git",
     "url": "https://github.com/ampproject/amp-by-example.git"
   },
-  "main": "lib/Preview.js",
+  "main": "lib/index.js",
   "engines": {
     "node": ">=4.0.0"
   },

spec/compiler/DocumentParserSpec.js

@@ -256,6 +256,37 @@ describe("DocumentParser", function() {
     });
   });
 
+  describe('parses runtime', function() {
+    it('amp-story', function() {
+      const document = parse('<html ⚡>', '<body>', '<amp-story standalone>', '</amp-story>', '</body>');
+      expect(document.isAmpStory).toBe(true);
+      expect(document.isAmpWeb).toBe(true);
+      expect(document.isAmpEmail).toBe(false);
+      expect(document.isAmpAds).toBe(false);
+    });
+    it('amp-mail', function() {
+      const document = parse('<html ⚡4email>', '<body>', '</body>');
+      expect(document.isAmpStory).toBe(false);
+      expect(document.isAmpWeb).toBe(false);
+      expect(document.isAmpEmail).toBe(true);
+      expect(document.isAmpAds).toBe(false);
+    });
+    it('amp-ad', function() {
+      const document = parse('<html ⚡4ads>', '<body>', '</body>');
+      expect(document.isAmpStory).toBe(false);
+      expect(document.isAmpWeb).toBe(false);
+      expect(document.isAmpEmail).toBe(false);
+      expect(document.isAmpAds).toBe(true);
+    });
+    it('amp-web', function() {
+      const document = parse('<html ⚡>', '<body>', '</body>');
+      expect(document.isAmpStory).toBe(false);
+      expect(document.isAmpWeb).toBe(true);
+      expect(document.isAmpEmail).toBe(false);
+      expect(document.isAmpAds).toBe(false);
+    });
+  });
+
   function newSection(comment, doc, preview, isFirstSection, isLastSection) {
     const section = new CodeSection(comment, doc, preview);
     section.isLastSection = isLastSection;