Support Inline scripts

jrjohnson · jrjohnson · commit b2f38191f9fa · 2016-11-21T14:28:37.000-08:00
When indicated in jsonBlueprint configuration this will pull the
contents out of a script tag and add it to the json.
diff --git a/README.md b/README.md
@@ -67,6 +67,45 @@ The root directory where the file matching `fileInputPattern` will be searched f
 
 *Default:* `context.distDir`
 
+### jsonBlueprint
+
+The blueprint indicating what fields to read from the HTML file and convert into JSON.
+
+*Default:*
+```javascript
+base: {
+  selector: 'base',
+  attributes: ['href']
+},
+meta: {
+  selector: 'meta[name*="/config/environment"]',
+  attributes: ['name', 'content']
+},
+link: {
+  selector: 'link',
+  attributes: ['rel', 'href', 'integrity']
+},
+script: {
+  selector: 'script',
+  attributes: ['src', 'integrity'],
+  includeContent: false,
+}
+```
+
+### includeContent
+By default only the attributes of `<script>` tags are read and included in the
+JSON output.  If you wish to include the content of the script tag you must specify that.
+```javascript
+ENV['json-config'] = {
+  jsonBlueprint(context, pluginHelper) {
+    var jsonBlueprint = pluginHelper.readConfigDefault('jsonBlueprint');
+    jsonBlueprint.script.includeContent = true;
+
+    return jsonBlueprint;
+  }
+};
+```
+
 ## What does a converted index.html file look like?
 
 The basic index.html file built by ember-cli will look soemething like this:
diff --git a/index.js b/index.js
@@ -44,7 +44,8 @@ module.exports = {
           },
           script: {
             selector: 'script',
-            attributes: ['src', 'integrity']
+            attributes: ['src', 'integrity'],
+            includeContent: false,
           }
         }
       },
diff --git a/lib/utilities/extract-index-config.js b/lib/utilities/extract-index-config.js
@@ -1,8 +1,9 @@
 var cheerio   = require('cheerio');
 var RSVP      = require('rsvp');
 
-function _get($, selector, attributes) {
+function _get($, selector, attributes, includeContent) {
   attributes = attributes || [];
+  includeContent = includeContent || false;
   var config = [];
   var $tags = $(selector);
 
@@ -15,6 +16,11 @@ function _get($, selector, attributes) {
       return data;
     }, {});
 
+    var content = $tag.text().trim();
+    if (includeContent && content.length) {
+      data['content'] = content;
+    }
+
     config.push(data);
   });
 
@@ -29,8 +35,10 @@ module.exports = function(data) {
   for(var prop in blueprint) {
     var value = blueprint[prop];
 
-    if (value.selector && value.attributes) {
-      json[prop] = _get($, value.selector, value.attributes);
+    if ('selector' in value && ('attributes' in value || 'includeContent' in value)) {
+      var attributes = 'attributes' in value?value.attributes:[];
+      var includeContent = 'includeContent' in value?value.includeContent:false;
+      json[prop] = _get($, value.selector, value.attributes, value.includeContent);
     }
   }
 
diff --git a/tests/fixtures/dist/index.html b/tests/fixtures/dist/index.html
@@ -17,5 +17,6 @@
   <body>
     <script src="assets/vendor.js" integrity="sha256-oqVuAfXRKap7fdgcCY5uykM6+R9GqQ8K/uxy9rx7HNQlGYl1kPzQho1wx4JwY8wC"></script>
     <script src="assets/app.js"></script>
+    <script>var a = 'foo';</script>
   </body>
 </html>
diff --git a/tests/unit/index-nodetest.js b/tests/unit/index-nodetest.js
@@ -9,10 +9,13 @@ describe('the deploy plugin object', function() {
   var plugin;
   var promise;
   var distDir;
+  var jsonBlueprint;
+  var context;
 
   before(function() {
     fakeRoot = process.cwd() + '/tests/fixtures';
     distDir = 'dist';
+    jsonBlueprint = false;
   });
 
   beforeEach(function() {
@@ -28,7 +31,7 @@ describe('the deploy plugin object', function() {
       name: 'json-config'
     });
 
-    var context = {
+    context = {
       ui: mockUi,
       config: {
         'json-config': {
@@ -44,6 +47,10 @@ describe('the deploy plugin object', function() {
       }
     };
 
+    if (jsonBlueprint) {
+      context.config['json-config'].jsonBlueprint = jsonBlueprint;
+    }
+
     plugin.beforeHook(context);
     plugin.configure(context);
 
@@ -63,7 +70,8 @@ describe('the deploy plugin object', function() {
     it('generates index.json from index.html', function() {
       return assert.isFulfilled(promise)
         .then(function() {
-          var json = require(fakeRoot + '/dist/index.json');
+          var contents = fs.readFileSync(fakeRoot + '/dist/index.json');
+          var json = JSON.parse(contents);
 
           assert.equal(Object.keys(json).length, 4);
 
@@ -73,6 +81,7 @@ describe('the deploy plugin object', function() {
           assert.deepEqual(json.link[1], { rel: 'stylesheet', href: 'assets/app.css' });
           assert.deepEqual(json.script[0], { src: 'assets/vendor.js', integrity: 'sha256-oqVuAfXRKap7fdgcCY5uykM6+R9GqQ8K/uxy9rx7HNQlGYl1kPzQho1wx4JwY8wC' });
           assert.deepEqual(json.script[1], { src: 'assets/app.js' });
+          assert.deepEqual(json.script[2], { });
         });
     });
 
@@ -97,5 +106,31 @@ describe('the deploy plugin object', function() {
           });
       });
     });
+
+    describe('when we ask for script tag contents', function() {
+      before(function() {
+        jsonBlueprint = {
+          script: {
+            selector: 'script',
+            attributes: [],
+            includeContent: true,
+          }
+        };
+      });
+
+      it('provides the contents of the script tag', function() {
+        return assert.isFulfilled(promise)
+          .then(function() {
+            var contents = fs.readFileSync(fakeRoot + '/dist/index.json');
+            var json = JSON.parse(contents);
+
+            assert.equal(Object.keys(json).length, 1);
+
+            assert.deepEqual(json.script[0], {});
+            assert.deepEqual(json.script[1], {});
+            assert.deepEqual(json.script[2], { content: "var a = 'foo';"});
+          });
+      });
+    });
   });
 });
diff --git a/tests/unit/lib/utilities/extract-index-config-nodetest.js b/tests/unit/lib/utilities/extract-index-config-nodetest.js
@@ -11,7 +11,7 @@ describe('extract-index-config', function() {
     subject = require('../../../../lib/utilities/extract-index-config');
   });
 
-  it('extracts the correct config', function() {
+  it('extracts the correct default config', function() {
     var contents = fs.readFileSync(process.cwd() + '/tests/fixtures/dist/index.html');
 
     var plugin = {
@@ -38,6 +38,34 @@ describe('extract-index-config', function() {
         assert.deepEqual(json.base[0], { href: '/' });
         assert.deepEqual(json.script[0], { src: 'assets/vendor.js' });
         assert.deepEqual(json.script[1], { src: 'assets/app.js' });
+        assert.deepEqual(json.script[2], { });
+      });
+  });
+
+  it('extracts script contents when specified', function() {
+    var contents = fs.readFileSync(process.cwd() + '/tests/fixtures/dist/index.html');
+
+    var plugin = {
+      readConfig: function(key) {
+        return {
+          script: {
+            selector: 'script',
+            attributes: ['src'],
+            includeContent: true,
+          }
+        };
+      }
+    };
+
+    return assert.isFulfilled(subject.call(plugin, contents))
+      .then(function(config) {
+        var json = JSON.parse(config);
+
+        assert.equal(Object.keys(json).length, 1);
+
+        assert.deepEqual(json.script[0], { src: 'assets/vendor.js' });
+        assert.deepEqual(json.script[1], { src: 'assets/app.js' });
+        assert.deepEqual(json.script[2], { content: "var a = 'foo';" });
       });
   });
 });

Original file line number	Diff line number	Diff line change
`@@ -44,7 +44,8 @@ module.exports = {`
`44`	`44`	`},`
`45`	`45`	`script: {`
`46`	`46`	`selector: 'script',`
`47`		`- attributes: ['src', 'integrity']`
	`47`	`+ attributes: ['src', 'integrity'],`
	`48`	`+ includeContent: false,`
`48`	`49`	`}`
`49`	`50`	`}`
`50`	`51`	`},`