Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Added LD+JSON asset and test case #1936

Merged
merged 19 commits into from
Sep 23, 2018
Merged
Show file tree
Hide file tree
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions src/Parser.js
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,7 @@ class Parser {
this.registerExtension('vue', './assets/VueAsset');
this.registerExtension('json', './assets/JSONAsset');
this.registerExtension('json5', './assets/JSONAsset');
this.registerExtension('json-ld', './assets/JSONLDAsset');
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

let's make the extension .jsonld as specified here: https://json-ld.org/spec/latest/json-ld/#iana-considerations

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

πŸ‘

this.registerExtension('yaml', './assets/YAMLAsset');
this.registerExtension('yml', './assets/YAMLAsset');
this.registerExtension('toml', './assets/TOMLAsset');
Expand Down
3 changes: 2 additions & 1 deletion src/assets/HTMLAsset.js
Original file line number Diff line number Diff line change
Expand Up @@ -64,7 +64,8 @@ const META = {
const SCRIPT_TYPES = {
'application/javascript': 'js',
'text/javascript': 'js',
'application/json': false
'application/json': false,
'application/ld+json': 'json-ld'
};

// Options to be passed to `addURLDependency` for certain tags + attributes
Expand Down
35 changes: 35 additions & 0 deletions src/assets/JSONLDAsset.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,35 @@
const Asset = require('../Asset');

// A list of all attributes in a schema that may produce a dependency
// Based on https://schema.org/Place
const SCHEMA_ATTRS = [
"logo",
"photo",
"image"
];
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Good start. I guess we should go through the specs and find all the possible attributes that are URLs

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Not sure if they list every single property, but https://schema.org/ImageObject has a dependents list: "Instances of ImageObject may appear as values for the following properties"


class JSONLDAsset extends Asset {
constructor(name, options) {
super(name, options);
this.type = 'json-ld';
}

parse(content) {
return JSON.parse(content.trim());
}

collectDependencies() {
for (let schemaKey in this.ast) {
if (SCHEMA_ATTRS.includes(schemaKey)) {
this.ast[schemaKey] = this.addURLDependency(this.ast[schemaKey]);
this.isAstDirty = true
}
}
}

generate() {
return JSON.stringify(this.ast);
}
}

module.exports = JSONLDAsset;
Binary file added test/integration/schema-jsonld/images/image.jpeg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added test/integration/schema-jsonld/images/logo.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
23 changes: 23 additions & 0 deletions test/integration/schema-jsonld/index.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
<html>
<head>
<title>hi</title>
</head>
<body>

<p>text 123</p>

<script type="application/ld+json">
{
"@context": "http://schema.org",
"@type": "LocalBusiness",
"description": "This is your business description.",
"name": "Parcel's parcel",
"telephone": "555-111-2345",
"openingHours": "Mo,Tu,We,Th,Fr 09:00-17:00",
"logo": "images/logo.png",
"image": "images/image.jpeg"
}
</script>

</body>
</html>
25 changes: 25 additions & 0 deletions test/schema-jsonld.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
const assert = require('assert');
const {bundle, run, assertBundleTree} = require('./utils');

describe('schema ld+json', function() {
it('Should parse a LD+JSON schema and collect dependencies', async function() {
let b = await bundle(__dirname + '/integration/schema-jsonld/index.html');

await assertBundleTree(b, {
name: 'index.html',
assets: ['index.html'],
childBundles: [
{
type: 'jpeg'
},
{
type: 'png'
}
]
});

let output = await run(b);
assert.equal(typeof output, 'function');
assert.equal(output(), 3);
});
});