From 4ce962860cbd4e7c25168fe398bd73fc3f865fca Mon Sep 17 00:00:00 2001 From: Gregg Kellogg Date: Wed, 7 Nov 2018 12:10:52 -0800 Subject: [PATCH 1/7] Update extract-examples from common. --- common/extract-examples.rb | 10 ++++++++++ 1 file changed, 10 insertions(+) diff --git a/common/extract-examples.rb b/common/extract-examples.rb index 89fb6edb..cf8ebc97 100755 --- a/common/extract-examples.rb +++ b/common/extract-examples.rb @@ -319,6 +319,11 @@ def save_example(examples:, element:, title:, example_number:, error:, warn:) $stdout.write "F".colorize(:red) next end + + # Get base from document, if present + html_base = doc.at_xpath('/html/head/base/@href') + ex[:base] = html_base.to_s if html_base + script_content = doc.at_xpath(xpath) if script_content # Remove (faked) XML comments and unescape sequences @@ -439,6 +444,11 @@ def save_example(examples:, element:, title:, example_number:, error:, warn:) args[0] = if examples[ex[:result_for]][:ext] == 'html' && method == :expand # If we are expanding, and the reference is HTML, find the first script element. doc = Nokogiri::HTML.parse(examples[ex[:result_for]][:content]) + + # Get base from document, if present + html_base = doc.at_xpath('/html/head/base/@href') + options[:base] = html_base.to_s if html_base + script_content = doc.at_xpath(xpath) unless script_content errors << "Example #{ex[:number]} at line #{ex[:line]} references example #{ex[:result_for].inspect} with no JSON-LD script element" From d5bf896a69f24d29e1878f627e75eb766a0d6d86 Mon Sep 17 00:00:00 2001 From: Gregg Kellogg Date: Wed, 7 Nov 2018 13:04:57 -0800 Subject: [PATCH 2/7] Semantic line breaks in WebIDL section. --- index.html | 544 +++++++++++++++++++++++++++-------------------------- 1 file changed, 278 insertions(+), 266 deletions(-) diff --git a/index.html b/index.html index 06f7a35d..56ba2230 100644 --- a/index.html +++ b/index.html @@ -4717,198 +4717,193 @@

The JsonLdProcessor Interface

compact

Compacts the given input using the - context according to the steps in the - Compaction algorithm:

+ context according to the steps in the Compaction algorithm:

    -
  1. Create a new Promise promise and return it. The - following steps are then executed asynchronously.
    2. -
  2. Set expanded input to the result of using the - expand - method using input and options, +
  3. Create a new Promise promise and return it. + The following steps are then executed asynchronously.
    4. +
  4. Set expanded input to the result of + using the expand method + using input + and options, with ordered set to false. -
  5. If context is a dictionary having an @context member, set - context to that member's value, otherwise to context.
    6. +
  6. If context is a dictionary having an @context member, + set context to that member's value, + otherwise to context.
  7. Initialize an active context using context; - the base IRI is set to - the base option from - options, if set; - otherwise, if the - compactToRelative option is - true, to the IRI of the currently being processed - document, if available; otherwise to null.
    8. -
  8. Set compacted output to the result of using the - Compaction algorithm, using active context, + the base IRI is set to the base option from options, if set; + otherwise, if the compactToRelative option is true, + to the IRI of the currently being processed document, if available; + otherwise to null.
    9. +
  9. Set compacted output to the result of using the Compaction algorithm, + using active context, an empty dictionary as inverse context, null as property, - expanded input as element, and if passed, the - compactArrays + expanded input as element, + and if passed, the compactArrays and ordered flags in options.
    10. -
  10. Fulfill the promise passing compacted output. +
  11. Fulfill the promise passing compacted output transforming compacted output from the internal representation to a JSON serialization.
input
-
The dictionary, array of dictionaries to perform the compaction upon or an - IRI referencing the JSON-LD document to compact.
+
The dictionary, + array of dictionaries to perform the compaction upon, + or an IRI referencing the JSON-LD document to compact.
context
The context to use when compacting the input; - it can be specified by using a dictionary, an - IRI, or an array consisting of - dictionaries and IRIs.
+ it can be specified by using a dictionary, + an IRI, + or an array consisting of dictionaries and IRIs.
options
-
A set of options to configure the algorithms. This allows, e.g., - to set the input document's base IRI.
+
A set of options to configure the algorithms. + This allows, e.g., to set the input document's base IRI.
expand
-

Expands the given input according to - the steps in the Expansion algorithm:

+

Expands the given input + according to the steps in the Expansion algorithm:

    -
  1. Create a new Promise promise and return it. The - following steps are then executed asynchronously.
    2. -
  2. If the passed input is a string - representing the IRI of a remote document, dereference it. - If the retrieved document's content type is neither application/json, - nor application/ld+json, nor any other media type using a - +json suffix as defined in [[RFC6839]], reject the promise passing an - loading document failed - error.
    3. -
  3. Initialize a new empty active context. The base IRI - of the active context is set to the IRI of the currently being processed - document, if available; otherwise to null. If set, the - base option from options overrides the base IRI.
    4. -
  4. If an - expandContext option - has been passed, update the active context using the - Context Processing algorithm, passing the - expandContext - as local context. If - expandContext - is a dictionary having an @context member, pass that member's value instead.
    5. -
  5. Once input has been retrieved, the response has an HTTP Link Header [[RFC8288]] - using the http://www.w3.org/ns/json-ld#context link relation - and a content type of application/json or any media type - with a +json suffix as defined in [[RFC6839]] except - application/ld+json, update the active context using the - Context Processing algorithm, passing the - context referenced in the HTTP Link Header as local context. The - HTTP Link Header is ignored for documents served as application/ld+json If - multiple HTTP Link Headers using the http://www.w3.org/ns/json-ld#context - link relation are found, the promise is rejected with a JsonLdError whose code is set to - multiple context link headers +
  6. Create a new Promise promise and return it. + The following steps are then executed asynchronously.
    7. +
  7. If the passed input + is a string representing the IRI of a remote document, dereference it. + If the retrieved document's content type is neither + text/html, + application/json, + application/ld+json, + nor any other media type using a + +json suffix as defined in [[RFC6839]], + reject the promise passing an loading document failed error.
    8. +
  8. Initialize a new empty active context. + The base IRI of the active context is set to the IRI of the currently being processed document, if available; + otherwise to null. + If set, the base option from options overrides the base IRI.
    9. +
  9. If an expandContext option has been passed, + update the active context using the Context Processing algorithm, + passing the expandContext as local context. + If expandContext is a dictionary having an @context member, + pass that member's value instead.
    10. +
  10. Once input has been retrieved, + the response has an HTTP Link Header [[RFC8288]] using the http://www.w3.org/ns/json-ld#context link relation + and a content type of application/json + or any media type with a +json suffix as defined in [[RFC6839]] + except application/ld+json, + update the active context using the Context Processing algorithm, + passing the context referenced in the HTTP Link Header as local context. + The HTTP Link Header is ignored for documents served as application/ld+json. + If multiple HTTP Link Headers using the http://www.w3.org/ns/json-ld#context link relation are found, + the promise is rejected with a JsonLdError whose code is set to multiple context link headers and processing is terminated.
    11. -
  11. If necessary, transform input into the - internal representation. If input cannot be transformed to the - internal representation, reject promise passing a - loading document failed error.
    12. -
  12. Set expanded output to the result of using the - Expansion algorithm, passing the - active context and input as element, - and if passed, the - frameExpansion +
  13. If necessary, transform input into the internal representation. + If input cannot be transformed to the internal representation, + reject promise passing a loading document failed error.
    14. +
  14. Set expanded output to the result of using the Expansion algorithm, + passing the active context and input as element, + and if passed, the frameExpansion and ordered flags in options.
    15. -
  15. Fulfill the promise passing expanded output. +
  16. Fulfill the promise passing expanded output transforming expanded output from the internal representation to a JSON serialization.
input
-
The dictionary or array of dictionaries to perform the expansion upon or an - IRI referencing the JSON-LD document to expand.
+
The dictionary, + or array of dictionaries to perform the expansion upon, + or an IRI referencing the JSON-LD document to expand.
options
-
A set of options to configure the used algorithms. This allows, e.g., - to set the input document's base IRI.
+
A set of options to configure the used algorithms. + This allows, e.g., to set the input document's base IRI.
flatten
-

Flattens the given input and - compacts it using the passed context +

Flattens the given input + and compacts it using the passed context according to the steps in the Flattening algorithm:

    -
  1. Create a new Promise promise and return it. The - following steps are then executed asynchronously.
    2. -
  2. Set expanded input to the result of using the - expand - method using input and options +
  3. Create a new Promise promise and return it. + The following steps are then executed asynchronously.
    4. +
  4. Set expanded input to the result of using the expand method + using input + and options with ordered set to false.
    5. -
  5. If context is a dictionary having an @context member, set - context to that member's value, otherwise to context.
    6. +
  6. If context is a dictionary having an @context member, + set context to that member's value, + otherwise to context.
  7. Initialize an active context using context; - the base IRI is set to - the base option from - options, if set; - otherwise, if the - compactToRelative option is - true, to the IRI of the currently being processed - document, if available; otherwise to null.
    8. + the base IRI is set to the base option + from options, if set; + otherwise, if the compactToRelative option is true, + to the IRI of the currently being processed document, if available; + otherwise to null.
  8. Initialize an empty identifier map.
    9. -
  9. Set flattened output to the result of using the - Flattening algorithm, passing - expanded input as element, active context, and if passed, the - compactArrays +
  10. Set flattened output to the result of using the Flattening algorithm, + passing expanded input as element, + active context, + and if passed, the compactArrays and ordered flags in options.
    11. -
  11. Fulfill the promise passing flattened output. +
  12. Fulfill the promise passing flattened output transforming flattened output from the internal representation to a JSON serialization.
input
-
The dictionary or array of dictionaries or an IRI - referencing the JSON-LD document to flatten.
+
The dictionary, + or array of dictionaries, + or an IRI referencing the JSON-LD document to flatten.
context
The context to use when compacting the flattened expanded input; - it can be specified by using a dictionary, an - IRI, or an array consisting of dictionaries - and IRIs. If not - passed or null is passed, the result will not be compacted - but kept in expanded form.
+ it can be specified by using a dictionary, + an IRI, or an array consisting of dictionaries + and IRIs. + If not passed or null is passed, + the result will not be compacted but kept in expanded form.
options
-
A set of options to configure the used algorithms. This allows, e.g., - to set the input document's base IRI.
+
A set of options to configure the used algorithms. + This allows, e.g., to set the input document's base IRI.
fromRdf
-

Transforms the given input into - a JSON-LD document in expanded form +

Transforms the given input + into a JSON-LD document in expanded form according to the steps in the Serialize RDF as JSON-LD Algorithm:

-

This interface does not define a means of creating - an RdfDataset from an arbitrary input, other than the - toRdf method.

+

This interface does not define a means of creating an RdfDataset + from an arbitrary input, other than the toRdf method.

    -
  1. Create a new Promise promise and return it. The - following steps are then executed asynchronously.
    2. +
  2. Create a new Promise promise and return it. + The following steps are then executed asynchronously.
  3. Set expanded result to the result of invoking the - Serialize RDF as JSON-LD Algorithm - method using dataset + Serialize RDF as JSON-LD Algorithm method + using dataset and options.
  4. Create a new RdfDataset dataset.
  5. Create a new dictionary node map.
  6. Invoke the - Node Map Generation algorithm, passing - expanded input as element and node map.
    7. + Node Map Generation algorithm, + passing expanded input as element + and node map.
  7. Invoke the Deserialize JSON-LD to RDF Algorithm - passing node map, dataset, and if passed, the - produceGeneralizedRdf flag in options - options. + passing node map, + dataset, + and if passed, the produceGeneralizedRdf flag in options.
    The use of blank node identifiers to label properties is obsolete, and may be removed in a future version of JSON-LD, as is the support for generalized RDF Datasets @@ -4919,11 +4914,12 @@

    The JsonLdProcessor Interface

    input
    -
    The dictionary or array of dictionaries or an IRI - referencing the JSON-LD document to flatten.
    +
    The dictionary, + or array of dictionaries, + or an IRI referencing the JSON-LD document to flatten.
    options
    -
    A set of options to configure the used algorithms. This allows, e.g., - to set the input document's base IRI.
    +
    A set of options to configure the used algorithms. + This allows, e.g., to set the input document's base IRI.
@@ -4933,21 +4929,20 @@

The JsonLdProcessor Interface

according to the steps in the Deserialize JSON-LD to RDF Algorithm:

    -
  1. Create a new Promise promise and return it. The - following steps are then executed asynchronously.
    2. +
  2. Create a new Promise promise and return it. + The following steps are then executed asynchronously.
  3. Set expanded input to the result of using the - expand - method using input + expand method + using input and options.
  4. Create a new RdfDataset dataset.
  5. Create a new dictionary node map.
    6. -
  6. Invoke the - Node Map Generation algorithm, passing - expanded input as element and node map.
    7. -
  7. Invoke the - Deserialize JSON-LD to RDF Algorithm - passing node map, dataset, and if passed, the - produceGeneralizedRdf flag in options. +
  8. Invoke the Node Map Generation algorithm, + passing expanded input as element + and node map.
    9. +
  9. Invoke the Deserialize JSON-LD to RDF Algorithm + passing node map, dataset, + and if passed, the produceGeneralizedRdf flag in options.
    The use of blank node identifiers to label properties is obsolete, and may be removed in a future version of JSON-LD, as is the support for generalized RDF Datasets @@ -4958,11 +4953,12 @@

    The JsonLdProcessor Interface

    input
    -
    The dictionary or array of dictionaries or an IRI - referencing the JSON-LD document to flatten.
    +
    The dictionary, + or array of dictionaries, + or an IRI referencing the JSON-LD document to flatten.
    options
    -
    A set of options to configure the used algorithms. This allows, e.g., - to set the input document's base IRI.
    +
    A set of options to configure the used algorithms. + This allows, e.g., to set the input document's base IRI.
    @@ -4971,31 +4967,38 @@

    The JsonLdProcessor Interface

    dictionary JsonLdDictionary {}; -->

    The JsonLdDictionary is the definition of a dictionary - used to contain arbitrary dictionary members which are the result of - parsing a JSON Object. + used to contain arbitrary dictionary members + which are the result of parsing a JSON Object.

    -

    The JsonLdInput type is used to refer to an input value that - that may be a dictionary, an array of dictionaries or a string representing an - IRI which an be dereferenced to retrieve a valid JSON document.

    +

    The JsonLdInput type is used to refer to an input value + that that may be a dictionary, + an array of dictionaries , + or a string representing an IRI + which can be dereferenced to retrieve a valid JSON document.

    -

    The JsonLdContext type is used to refer to a value that - that may be a dictionary, a string representing an - IRI, or an array of dictionaries - and strings.

    +

    The JsonLdContext type is used to refer to a value + that may be a dictionary, + a string representing an IRI, + or an array of dictionaries and strings.

    RDF Dataset Interfaces

    -

    The RdfDataset interface describes operations on an RDF dataset used by the fromRdf and toRdf methods in the JsonLdProcessor interface. The interface may be used for constructing a new RDF dataset, which has a default graph accessible via the defaultGraph attribute.

    +

    The RdfDataset interface describes operations on an RDF dataset + used by the fromRdf + and toRdf methods + in the JsonLdProcessor interface. + The interface may be used for constructing a new RDF dataset, + which has a default graph accessible via the defaultGraph attribute.

           [Constructor]
@@ -5011,7 +5014,8 @@ 
    RDF Dataset Interfaces
    
       
    Provides access to the default graph associated with the RDF dataset.
    
       
    add
    
       
    
-        
    Adds an RdfGraph and its associated graph name to the RdfDataset. Used by the Deserialize JSON-LD to RDF Algorithm.
    
+        
    Adds an RdfGraph and its associated graph name to the RdfDataset.
+          Used by the Deserialize JSON-LD to RDF Algorithm.
    
 
         
    
           
    graphName
    
@@ -5024,13 +5028,19 @@ 
    RDF Dataset Interfaces
    
       
    
       
    iterable
    
       
    The value pairs to iterate over
-        are the list of graph name-graph pairs, with the
-        graph name being null (for the default
-        graph), an IRI or blank node identifier and graph an
-        RdfGraph instance.
    
+        are the list of graph name-graph pairs,
+        with the graph name being null
+        (for the default graph),
+        an IRI,
+        or blank node identifier
+        and graph an RdfGraph instance.
     
 
-    
    The RdfGraph interface describes operations on an RDF graph used by the fromRdf and toRdf methods in the JsonLdProcessor interface. The interface may be used for constructing a new RDF graph, which is composed of zero or more RdfTriple instances.
    
+    
    The RdfGraph interface describes operations on an RDF graph used by the fromRdf
+      and toRdf methods
+      in the JsonLdProcessor interface.
+      The interface may be used for constructing a new RDF graph,
+      which is composed of zero or more RdfTriple instances.
    
 
     
           [Constructor]
@@ -5043,7 +5053,8 @@ 
    RDF Dataset Interfaces
    
     
    
       
    add
    
       
    
-        
    Adds an RdfTriple to the RdfGraph. Used by the Deserialize JSON-LD to RDF Algorithm.
    
+        
    Adds an RdfTriple to the RdfGraph.
+          Used by the Deserialize JSON-LD to RDF Algorithm.
    
 
         
    
           
    triple
    
@@ -5052,9 +5063,9 @@ 
    RDF Dataset Interfaces
    
       
    
       
    iterable
    
       
    A value iterator
-        over the RdfTriple instances associated with the graph.
-        Note that a given RdfTriple instance may appear
-        in more than one graph within a particular RdfDataset instance.
    
+        over the RdfTriple instancesassociated with the graph.
+        Note that a given RdfTriple instance may appear in more than one graph
+        within a particular RdfDataset instance.
     
    
 
     
    The RdfTriple interface describes an RDF Triple.
    
@@ -5070,15 +5081,18 @@ 
    RDF Dataset Interfaces
    
 
     
    
       
    subject
    
-      
    An absolute IRI or blank node identifier denoting the subject of the triple.
    
+      
    An absolute IRI or blank node identifier
+        denoting the subject of the triple.
    
       
    predicate
    
       
    An absolute IRI denoting the predicate of the triple.
-        If used to represent a Generalized RDF Dataset, it may also be a blank node identifier.
+        If used to represent a Generalized RDF Dataset,
+        it may also be a blank node identifier.
         
    The use of blank node identifiers to label properties is obsolete,
           and may be removed in a future version of JSON-LD, as is the support for generalized RDF Datasets.
    
         
    
       
    object
    
-      
    An absolute IRI, blank node identifier or literal denoting the object of the triple.
    
+      
    An absolute IRI, blank node identifier, or literal
+        denoting the object of the triple.
    
     
    
 
     
    The RdfLiteral interface describes an RDF Literal.
    
@@ -5097,10 +5111,11 @@ 
    RDF Dataset Interfaces
    
       
    The lexical value of the literal.
    
       
    datatype
    
       
    An absolute IRI denoting the datatype IRI of the literal.
-        If the value is rdf:langString, language MUST be specified.
    
+        If the value is rdf:langString,
+        language MUST be specified.
       
    language
    
-      
    An optional language tag as defined by [[BCP47]]. If this value is specified,
-        datatype MUST be rdf:langString
    
+      
    An optional language tag as defined by [[BCP47]].
+        If this value is specified, datatype MUST be rdf:langString.
    @@ -5128,22 +5143,24 @@

    The JsonLdOptions Type

    base
    -
    The base IRI to use when expanding or compacting the document. If set, this overrides - the input document's IRI.
    +
    The base IRI to use when expanding or compacting the document. + If set, this overrides the input document's IRI.
    compactArrays
    -
    If set to true, the JSON-LD processor replaces arrays with just - one element with that element during compaction. If set to false, +
    If set to true, the JSON-LD processor replaces arrays + with just one element with that element during compaction. + If set to false, all arrays will remain arrays even if they have just one element.
    documentLoader
    The callback of the loader to be used to retrieve remote documents and contexts. - If specified, it is used to retrieve remote documents and contexts; otherwise, - if not specified, the processor's built-in loader is used.
    + If specified, it is used to retrieve remote documents and contexts; + otherwise, if not specified, the processor's built-in loader is used.
    expandContext
    A context that is used to initialize the active context when expanding a document.
    produceGeneralizedRdf
    -
    If set to true, the JSON-LD processor may emit blank nodes for - triple predicates, otherwise they will be omitted. +
    If set to true, the JSON-LD processor may emit + blank nodes for triple predicates, + otherwise they will be omitted. Generalized RDF Datasets are defined in [[RDF11-CONCEPTS]].
    The use of blank node identifiers to label properties is obsolete, @@ -5153,20 +5170,21 @@

    The JsonLdOptions Type

    processingMode
    Sets the processing mode. - If set to json-ld-1.0 or json-ld-1.1, the - implementation must produce exactly the same results as the algorithms - defined in this specification. - If set to another value, the JSON-LD processor is allowed to extend - or modify the algorithms defined in this specification to enable - application-specific optimizations. The definition of such - optimizations is beyond the scope of this specification and thus - not defined. Consequently, different implementations may implement - different optimizations. Developers must not define modes beginning - with json-ld as they are reserved for future versions - of this specification.
    + If set to json-ld-1.0 or json-ld-1.1, + the implementation must produce exactly the same results as the + algorithms defined in this specification. + If set to another value, + the JSON-LD processor is allowed to extend or modify the algorithms defined in this specification + to enable application-specific optimizations. + The definition of such optimizations is beyond the scope of this specification + and thus not defined. + Consequently, different implementations may implement different optimizations. + Developers must not define modes beginning with json-ld + as they are reserved for future versions of this specification.
    compactToRelative
    -
    Determines if IRIs are compacted relative to the - base option or document location when compacting.
    +
    Determines if IRIs are compacted + relative to the base option + or document location when compacting.
    frameExpansion
    Enables special frame processing rules for the Expansion Algorithm.
    Enables special rules for the Serialize RDF as JSON-LD Algorithm @@ -5178,19 +5196,19 @@

    The JsonLdOptions Type

    Enables special rules for the Serialize RDF as JSON-LD Algorithm causing rdf:type properties to be kept as IRIs in the output, rather than use @type.
    ordered
    -
    If set to true, certain algorithm - processing steps where indicated are ordered lexicographically. - If false, order - is not considered in processing.
    +
    If set to true, + certain algorithm processing steps where indicated are ordered lexicographically. + If false, order is not considered in processing.

    Remote Document and Context Retrieval

    -

    Users of an API implementation can utilize a callback to control how remote - documents and contexts are retrieved. This section details the parameters of - that callback and the data structure used to return the retrieved context.

    +

    Users of an API implementation can utilize a callback to control how + remote documents and contexts are retrieved. + This section details the parameters of that callback + and the data structure used to return the retrieved context.

    LoadDocumentCallback

    @@ -5207,9 +5225,8 @@

    LoadDocumentCallback

    The URL of the remote document or context to load.
    -

    All errors result in the Promise being rejected with - a JsonLdError whose code is set to - loading document failed +

    All errors result in the Promise being rejected with a JsonLdError + whose code is set to loading document failed or multiple context link headers as described in the next section.

    @@ -5230,20 +5247,20 @@

    RemoteDocument

    contextUrl
    -
    If available, the value of the HTTP Link Header [[RFC8288]] using the - http://www.w3.org/ns/json-ld#context link relation in the - response. If the response's content type is application/ld+json, - the HTTP Link Header is ignored. If multiple HTTP Link Headers using - the http://www.w3.org/ns/json-ld#context link relation are found, - the Promise of the LoadDocumentCallback is rejected with - a JsonLdError whose code is set to - multiple context link headers.
    +
    If available, the value of the HTTP Link Header [[RFC8288]] + using the http://www.w3.org/ns/json-ld#context link relation + in the response. + If the response's content type is application/ld+json, + the HTTP Link Header is ignored. + If multiple HTTP Link Headers using the http://www.w3.org/ns/json-ld#context link relation are found, + the Promise of the LoadDocumentCallback is rejected + with a JsonLdError whose code is set to multiple context link headers.
    documentUrl
    -
    The final URL of the loaded document. This is important - to handle HTTP redirects properly.
    +
    The final URL of the loaded document. + This is important to handle HTTP redirects properly.
    document
    -
    The retrieved document. This can either be the raw payload or the already - parsed document.
    +
    The retrieved document. + This can either be the raw payload or the already parsed document.
    @@ -5251,8 +5268,8 @@

    RemoteDocument

    Error Handling

    -

    This section describes the datatype definitions used within the - JSON-LD API for error handling.

    +

    This section describes the datatype definitions + used within the JSON-LD API for error handling.

    JsonLdError

    @@ -5268,19 +5285,17 @@

    JsonLdError

    code
    -
    a string representing the particular error type, as described in - the various algorithms in this document.
    +
    A string representing the particular error type, + as described in the various algorithms in this document.
    message
    -
    an optional error message containing additional debugging information. - The specific contents of error messages are outside the scope of this - specification.
    +
    An optional error message containing additional debugging information. + The specific contents of error messages are outside the scope of this specification.

    JsonLdErrorCode

    -

    The JsonLdErrorCode represents the collection of valid JSON-LD error - codes.

    +

    The JsonLdErrorCode represents the collection of valid JSON-LD error codes.
    +
    +

    HTML Content Algorithms

    +
    +

    Extract Script Content Algorithm

    + +

    The algorithm extracts the text content a + JSON-LD script element into a dictionary or array of dictionaries. + A JSON-LD script element is a script element + within an HTML [[HTML52]] document with the with the type attribute set to + application/ld+json.

    + +
    +

    Overview

    +

    As a data block + may be inside a comment, and may be escaped, the algorithm extracts the JSON from any comment, + removes REVERSE SOLIDUS escapes, + and reverses HTML Character references. +

    + +
    +

    Algorithm

    +

    The algorithm takes a single required input variable: source, + the textContent of an HTML script element.

    +

    For the purpose of this algorithm, the following tokens are defined in [[ABNF]]:

    + + 
    +  space-character = %20 ; SPACE
+                  / %09 ; CHARACTER TABULATION (tab)
+                  / %0A ; LINE FEED (LF)
+                  / %0C ; FORM FEED (FF)
+                  / %0D ; CARRIAGE RETURN (CR)
+  comment-open    = *space-character "<!--" *space-character
+  comment-close   = *space-character "-->" *space-character
+
    + +
      +
    1. If source begins with comment-open and ends with comment-close, + remove those sequences from source.
      2. +
    2. If source contains comment-open or comment-close, + an invalid script element has been detected, and processing is aborted.
      3. +
    3. For all occurances of the any of the character sequences + <\script, + <\/script, + <\!--, + or --\> + in source using a case-insenstive match, + replace the sequence with the equivalent sequence excluding the REVERSE SOLIDUS (\).
      4. +
    4. For all occurances of a HTML Character reference in source, + replace the sequence with the equivalent Unicode character as defined + in Named character references in [[HTML52]].
      5. +
    5. If source is not a valid JSON document, + an invalid script element has been detected, and processing is aborted.
      6. +
    6. Return the result of transforming source into the internal representation.
      7. +
    +
    +
    +
    +

    The Application Programming Interface

    @@ -4716,7 +4774,7 @@

    The JsonLdProcessor Interface

    compact
    -

    Compacts the given input using the +

    Compacts the given input using the context according to the steps in the Compaction algorithm:

      @@ -4726,7 +4784,8 @@

      The JsonLdProcessor Interface

      using the expand method using input and options, - with ordered set to false. + with ordered set to false, + and extractAllScripts defaulting to false.
    1. If context is a dictionary having an @context member, set context to that member's value, otherwise to context.
      2. @@ -4754,7 +4813,7 @@

      The JsonLdProcessor Interface

      array of dictionaries to perform the compaction upon, or an IRI referencing the JSON-LD document to compact.
    context
    -
    The context to use when compacting the input; +
    The context to use when compacting the input; it can be specified by using a dictionary, an IRI, or an array consisting of dictionaries and IRIs.
    @@ -4773,8 +4832,8 @@

    The JsonLdProcessor Interface

  10. Create a new Promise promise and return it. The following steps are then executed asynchronously.
  11. If the passed input - is a string representing the IRI of a remote document, dereference it. - If the retrieved document's content type is neither + is a string representing the IRI of a remote document, dereference it as original input. + If the retrieved document's Content-Type is neither text/html, application/json, application/ld+json, @@ -4792,20 +4851,55 @@

    The JsonLdProcessor Interface

    pass that member's value instead.
  12. Once input has been retrieved, the response has an HTTP Link Header [[RFC8288]] using the http://www.w3.org/ns/json-ld#context link relation - and a content type of application/json + and a Content-Type of application/json or any media type with a +json suffix as defined in [[RFC6839]] except application/ld+json, update the active context using the Context Processing algorithm, passing the context referenced in the HTTP Link Header as local context. - The HTTP Link Header is ignored for documents served as application/ld+json. + The HTTP Link Header is ignored for documents served as application/ld+json + or text/html. If multiple HTTP Link Headers using the http://www.w3.org/ns/json-ld#context link relation are found, the promise is rejected with a JsonLdError whose code is set to multiple context link headers and processing is terminated.
    13. -
  13. If necessary, transform input into the internal representation. +
  14. If the retrieved document's Content-Type is text/html + and the passed input is + a string representing the IRI of a remote document, + extract the content of the JSON-LD script element(s) into original input: +
      +
    1. If the original passed input parameter + contains a fragment identifier, + set source to the textContent + of the script element in input + having an id attribute + that matches the fragment identifier, after decoding percent encoded sequences. + If no element is found + or the located element is not a script element with type application/ld+json, + reject promise passing an invalid script element error. + Set original input to the result of the Extract Script Content algorithm, + using source.
      2. +
    2. Otherwise, if the extractAllScripts option is not present, or false, + locate the first JSON-LD script element in input, + and set source to its textContent, if found. + Set original input to the result of the Extract Script Content algorithm, + using source. + If no JSON-LD script element is found, set original input to a new empty array.
      3. +
    3. Otherwise, set original input to a new empty array. + For each JSON-LD script element in input: +
        +
      1. Set source to its textContent.
        2. +
      2. Set script content to the result of the Extract Script Content algorithm, + using source.
        3. +
      3. If script content is an array, merge it to the end of original input.
        4. +
      4. Otherwise, append script content to original input.
        5. +
      +
      4. +
    +
    15. +
  15. If necessary, transform original input into the internal representation. If input cannot be transformed to the internal representation, reject promise passing a loading document failed error.
  16. Set expanded output to the result of using the Expansion algorithm, - passing the active context and input as element, + passing the active context and original input as element, and if passed, the frameExpansion and ordered flags in options.
    17. @@ -4837,7 +4931,8 @@

    The JsonLdProcessor Interface

  17. Set expanded input to the result of using the expand method using input and options - with ordered set to false.
    18. + with ordered set to false, + and extractAllScripts defaulting to true.
  18. If context is a dictionary having an @context member, set context to that member's value, otherwise to context.
    19. @@ -4934,7 +5029,9 @@

    The JsonLdProcessor Interface

  19. Set expanded input to the result of using the expand method using input - and options.
    20. + and options + with ordered set to false, + and extractAllScripts defaulting to true.
  20. Create a new RdfDataset dataset.
  21. Create a new dictionary node map.
  22. Invoke the Node Map Generation algorithm, @@ -5132,6 +5229,7 @@

    The JsonLdOptions Type

    boolean compactToRelative = true; LoadDocumentCallback documentLoader = null; (JsonLdDictionary? or USVString) expandContext = null; + boolean extractAllScripts = false; boolean frameExpansion = false; boolean ordered = false; USVString processingMode = null; @@ -5157,6 +5255,11 @@

    The JsonLdOptions Type

    otherwise, if not specified, the processor's built-in loader is used.
    expandContext
    A context that is used to initialize the active context when expanding a document.
    +
    extractAllScripts
    +
    If set to true, + when extracting JSON-LD script elements from HTML, + unless a specific fragment identifier is targeted, + extracts all encountered JSON-LD script elements using an array form, if necessary.
    produceGeneralizedRdf
    If set to true, the JSON-LD processor may emit blank nodes for triple predicates, @@ -5242,6 +5345,7 @@

    RemoteDocument

    USVString contextUrl = null; USVString documentUrl; any document; + USVString contentType; }; --> @@ -5250,7 +5354,7 @@

    RemoteDocument

    If available, the value of the HTTP Link Header [[RFC8288]] using the http://www.w3.org/ns/json-ld#context link relation in the response. - If the response's content type is application/ld+json, + If the response's Content-Type is application/ld+json, the HTTP Link Header is ignored. If multiple HTTP Link Headers using the http://www.w3.org/ns/json-ld#context link relation are found, the Promise of the LoadDocumentCallback is rejected @@ -5261,6 +5365,9 @@

    RemoteDocument

    document
    The retrieved document. This can either be the raw payload or the already parsed document.
    +
    contentType
    +
    The Content-Type + of the loaded document.
    @@ -5323,6 +5430,7 @@

    JsonLdErrorCode

    "invalid reverse property map", "invalid reverse property value", "invalid scoped context", + "invalid script element", "invalid set or list object", "invalid term definition", "invalid type mapping", @@ -5410,6 +5518,10 @@

    JsonLdErrorCode

    The local context defined within a term definition is invalid.
    +
    invalid script element
    +
    A script element in HTML input + which is the target of a fragment identifier + does not have an appropriate type attribute.
    invalid set or list object
    A set object or list object with disallowed members @@ -5574,7 +5686,11 @@

    Changes since JSON-LD Community Group Final Report

    and may be removed in a future version of JSON-LD, as is the support for generalized RDF Datasets and thus the produceGeneralizedRdf option may be also be removed.
    23. - +
  23. Added API steps to accept text/html as input, + extracting either a specifically targeted script element, + the first found JSON-LD script element, + or all JSON-LD script elements.
    24. +
  24. Added contentType field to RemoteDocument.
    25. @@ -5620,10 +5736,9 @@

    Acknowledgements

    Paolo Ciccarese, Paul Frazze, Paul Warren, - Rego Gmür, + Reto Gmür, Rob Trainer, - Ted Thibodeau Jr., - and Victor Charpenay.

    + and Ted Thibodeau Jr..

    For the 1.0 version of the specification, the editors would like to thank Mark Birbeck, who provided a great deal of the initial push behind the JSON-LD work via his work on RDFj. From 46302eb79ddb149fd1735bd47f080937735b767b Mon Sep 17 00:00:00 2001 From: Gregg Kellogg Date: Sun, 11 Nov 2018 17:00:36 -0800 Subject: [PATCH 4/7] HTML tests for expand, compact, flatten and toRdf. --- tests/compact-manifest.jsonld | 36 ++++++++ tests/compact/h001-context.jsonld | 5 ++ tests/compact/h001-in.html | 12 +++ tests/compact/h001-out.jsonld | 6 ++ tests/compact/h002-context.jsonld | 5 ++ tests/compact/h002-in.html | 21 +++++ tests/compact/h002-out.jsonld | 6 ++ tests/compact/h003-context.jsonld | 3 + tests/compact/h003-in.html | 21 +++++ tests/compact/h003-out.jsonld | 7 ++ tests/compact/h004-context.jsonld | 6 ++ tests/compact/h004-in.html | 21 +++++ tests/compact/h004-out.jsonld | 15 ++++ tests/expand-manifest.jsonld | 136 ++++++++++++++++++++++++++++++ tests/expand/h001-in.html | 12 +++ tests/expand/h001-out.jsonld | 3 + tests/expand/h002-in.html | 21 +++++ tests/expand/h002-out.jsonld | 3 + tests/expand/h003-in.html | 21 +++++ tests/expand/h003-out.jsonld | 4 + tests/expand/h004-in.html | 21 +++++ tests/expand/h004-out.jsonld | 10 +++ tests/expand/h005-in.html | 18 ++++ tests/expand/h005-out.jsonld | 5 ++ tests/expand/h006-in.html | 1 + tests/expand/h006-out.jsonld | 1 + tests/expand/h007-in.html | 1 + tests/expand/h007-out.jsonld | 1 + tests/expand/h008-in.html | 14 +++ tests/expand/h008-out.jsonld | 3 + tests/expand/h009-in.html | 13 +++ tests/expand/h009-out.jsonld | 6 ++ tests/expand/h010-in.html | 10 +++ tests/expand/h010-out.jsonld | 3 + tests/expand/h011-in.html | 21 +++++ tests/expand/h012-in.html | 12 +++ tests/expand/h013-in.html | 12 +++ tests/expand/h014-in.html | 14 +++ tests/expand/h015-in.html | 13 +++ tests/expand/h016-in.html | 13 +++ tests/expand/h017-in.html | 7 ++ tests/flatten-manifest.jsonld | 36 ++++++++ tests/flatten/h001-context.jsonld | 5 ++ tests/flatten/h001-in.html | 12 +++ tests/flatten/h001-out.jsonld | 7 ++ tests/flatten/h002-context.jsonld | 5 ++ tests/flatten/h002-in.html | 21 +++++ tests/flatten/h002-out.jsonld | 7 ++ tests/flatten/h003-context.jsonld | 3 + tests/flatten/h003-in.html | 21 +++++ tests/flatten/h003-out.jsonld | 7 ++ tests/flatten/h004-context.jsonld | 6 ++ tests/flatten/h004-in.html | 18 ++++ tests/flatten/h004-out.jsonld | 11 +++ tests/toRdf-manifest.jsonld | 24 ++++++ tests/toRdf/h001-in.html | 12 +++ tests/toRdf/h001-out.nq | 3 + tests/toRdf/h002-in.html | 21 +++++ tests/toRdf/h002-out.nq | 3 + tests/toRdf/h003-in.html | 21 +++++ tests/toRdf/h003-out.nq | 2 + 61 files changed, 808 insertions(+) create mode 100644 tests/compact/h001-context.jsonld create mode 100644 tests/compact/h001-in.html create mode 100644 tests/compact/h001-out.jsonld create mode 100644 tests/compact/h002-context.jsonld create mode 100644 tests/compact/h002-in.html create mode 100644 tests/compact/h002-out.jsonld create mode 100644 tests/compact/h003-context.jsonld create mode 100644 tests/compact/h003-in.html create mode 100644 tests/compact/h003-out.jsonld create mode 100644 tests/compact/h004-context.jsonld create mode 100644 tests/compact/h004-in.html create mode 100644 tests/compact/h004-out.jsonld create mode 100644 tests/expand/h001-in.html create mode 100644 tests/expand/h001-out.jsonld create mode 100644 tests/expand/h002-in.html create mode 100644 tests/expand/h002-out.jsonld create mode 100644 tests/expand/h003-in.html create mode 100644 tests/expand/h003-out.jsonld create mode 100644 tests/expand/h004-in.html create mode 100644 tests/expand/h004-out.jsonld create mode 100644 tests/expand/h005-in.html create mode 100644 tests/expand/h005-out.jsonld create mode 100644 tests/expand/h006-in.html create mode 100644 tests/expand/h006-out.jsonld create mode 100644 tests/expand/h007-in.html create mode 100644 tests/expand/h007-out.jsonld create mode 100644 tests/expand/h008-in.html create mode 100644 tests/expand/h008-out.jsonld create mode 100644 tests/expand/h009-in.html create mode 100644 tests/expand/h009-out.jsonld create mode 100644 tests/expand/h010-in.html create mode 100644 tests/expand/h010-out.jsonld create mode 100644 tests/expand/h011-in.html create mode 100644 tests/expand/h012-in.html create mode 100644 tests/expand/h013-in.html create mode 100644 tests/expand/h014-in.html create mode 100644 tests/expand/h015-in.html create mode 100644 tests/expand/h016-in.html create mode 100644 tests/expand/h017-in.html create mode 100644 tests/flatten/h001-context.jsonld create mode 100644 tests/flatten/h001-in.html create mode 100644 tests/flatten/h001-out.jsonld create mode 100644 tests/flatten/h002-context.jsonld create mode 100644 tests/flatten/h002-in.html create mode 100644 tests/flatten/h002-out.jsonld create mode 100644 tests/flatten/h003-context.jsonld create mode 100644 tests/flatten/h003-in.html create mode 100644 tests/flatten/h003-out.jsonld create mode 100644 tests/flatten/h004-context.jsonld create mode 100644 tests/flatten/h004-in.html create mode 100644 tests/flatten/h004-out.jsonld create mode 100644 tests/toRdf/h001-in.html create mode 100644 tests/toRdf/h001-out.nq create mode 100644 tests/toRdf/h002-in.html create mode 100644 tests/toRdf/h002-out.nq create mode 100644 tests/toRdf/h003-in.html create mode 100644 tests/toRdf/h003-out.nq diff --git a/tests/compact-manifest.jsonld b/tests/compact-manifest.jsonld index 666580d5..d99be60e 100644 --- a/tests/compact-manifest.jsonld +++ b/tests/compact-manifest.jsonld @@ -1130,6 +1130,42 @@ "input": "compact/ep15-in.jsonld", "context": "compact/ep15-context.jsonld", "expect": "invalid container mapping" + }, { + "@id": "#th001", + "@type": ["jld:PositiveEvaluationTest", "jld:CompactTest"], + "name": "Compacts embedded JSON-LD script element", + "purpose": "Tests embedded JSON-LD in HTML", + "input": "compact/h001-in.html", + "context": "compact/h001-context.jsonld", + "expect": "compact/h001-out.jsonld", + "option": {"specVersion": "json-ld-1.1"} + }, { + "@id": "#th002", + "@type": ["jld:PositiveEvaluationTest", "jld:CompactTest"], + "name": "Compacts first embedded JSON-LD script element", + "purpose": "Tests embedded JSON-LD in HTML", + "input": "compact/h002-in.html", + "context": "compact/h002-context.jsonld", + "expect": "compact/h002-out.jsonld", + "option": {"specVersion": "json-ld-1.1"} + }, { + "@id": "#th003", + "@type": ["jld:PositiveEvaluationTest", "jld:CompactTest"], + "name": "Compacts targeted JSON-LD script element", + "purpose": "Tests embedded JSON-LD in HTML with fragment identifier", + "input": "compact/h003-in.html#second", + "context": "compact/h003-context.jsonld", + "expect": "compact/h003-out.jsonld", + "option": {"specVersion": "json-ld-1.1"} + }, { + "@id": "#th004", + "@type": ["jld:PositiveEvaluationTest", "jld:CompactTest"], + "name": "Compacts all embedded JSON-LD script elements with extractAllScripts option", + "purpose": "Tests embedded JSON-LD in HTML extracting all elements", + "input": "compact/h004-in.html", + "context": "compact/h004-context.jsonld", + "expect": "compact/h004-out.jsonld", + "option": {"specVersion": "json-ld-1.1", "extractAllScripts": true} }, { "@id": "#tm001", "@type": ["jld:PositiveEvaluationTest", "jld:CompactTest"], diff --git a/tests/compact/h001-context.jsonld b/tests/compact/h001-context.jsonld new file mode 100644 index 00000000..c9ee5d89 --- /dev/null +++ b/tests/compact/h001-context.jsonld @@ -0,0 +1,5 @@ +{ + "@context": { + "foo": {"@id": "http://example.com/foo", "@container": "@list"} + } +} \ No newline at end of file diff --git a/tests/compact/h001-in.html b/tests/compact/h001-in.html new file mode 100644 index 00000000..57328e38 --- /dev/null +++ b/tests/compact/h001-in.html @@ -0,0 +1,12 @@ + + + + + \ No newline at end of file diff --git a/tests/compact/h001-out.jsonld b/tests/compact/h001-out.jsonld new file mode 100644 index 00000000..fa6a4cf0 --- /dev/null +++ b/tests/compact/h001-out.jsonld @@ -0,0 +1,6 @@ +{ + "@context": { + "foo": {"@id": "http://example.com/foo", "@container": "@list"} + }, + "foo": ["bar"] +} \ No newline at end of file diff --git a/tests/compact/h002-context.jsonld b/tests/compact/h002-context.jsonld new file mode 100644 index 00000000..c9ee5d89 --- /dev/null +++ b/tests/compact/h002-context.jsonld @@ -0,0 +1,5 @@ +{ + "@context": { + "foo": {"@id": "http://example.com/foo", "@container": "@list"} + } +} \ No newline at end of file diff --git a/tests/compact/h002-in.html b/tests/compact/h002-in.html new file mode 100644 index 00000000..b287ab50 --- /dev/null +++ b/tests/compact/h002-in.html @@ -0,0 +1,21 @@ + + + + + + \ No newline at end of file diff --git a/tests/compact/h002-out.jsonld b/tests/compact/h002-out.jsonld new file mode 100644 index 00000000..fa6a4cf0 --- /dev/null +++ b/tests/compact/h002-out.jsonld @@ -0,0 +1,6 @@ +{ + "@context": { + "foo": {"@id": "http://example.com/foo", "@container": "@list"} + }, + "foo": ["bar"] +} \ No newline at end of file diff --git a/tests/compact/h003-context.jsonld b/tests/compact/h003-context.jsonld new file mode 100644 index 00000000..bd58ee54 --- /dev/null +++ b/tests/compact/h003-context.jsonld @@ -0,0 +1,3 @@ +{ + "@context": {"ex": "http://example.com/"} +} \ No newline at end of file diff --git a/tests/compact/h003-in.html b/tests/compact/h003-in.html new file mode 100644 index 00000000..f18c1dae --- /dev/null +++ b/tests/compact/h003-in.html @@ -0,0 +1,21 @@ + + + + + + \ No newline at end of file diff --git a/tests/compact/h003-out.jsonld b/tests/compact/h003-out.jsonld new file mode 100644 index 00000000..f68d33ae --- /dev/null +++ b/tests/compact/h003-out.jsonld @@ -0,0 +1,7 @@ +{ + "@context": {"ex": "http://example.com/"}, + "@graph": [ + {"ex:foo": "foo"}, + {"ex:bar": "bar"} + ] +} \ No newline at end of file diff --git a/tests/compact/h004-context.jsonld b/tests/compact/h004-context.jsonld new file mode 100644 index 00000000..c68c329c --- /dev/null +++ b/tests/compact/h004-context.jsonld @@ -0,0 +1,6 @@ +{ + "@context": { + "ex": "http://example.com/", + "foo": {"@id": "http://example.com/foo", "@container": "@list"} + } +} \ No newline at end of file diff --git a/tests/compact/h004-in.html b/tests/compact/h004-in.html new file mode 100644 index 00000000..b287ab50 --- /dev/null +++ b/tests/compact/h004-in.html @@ -0,0 +1,21 @@ + + + + + + \ No newline at end of file diff --git a/tests/compact/h004-out.jsonld b/tests/compact/h004-out.jsonld new file mode 100644 index 00000000..deede214 --- /dev/null +++ b/tests/compact/h004-out.jsonld @@ -0,0 +1,15 @@ +{ + "@context": { + "ex": "http://example.com/", + "foo": {"@id": "http://example.com/foo", "@container": "@list"} + }, + "@graph": [ + {"foo": ["bar"]}, + { + "@graph": [ + {"ex:foo": "foo"}, + {"ex:bar": "bar"} + ] + } + ] +} \ No newline at end of file diff --git a/tests/expand-manifest.jsonld b/tests/expand-manifest.jsonld index a943a60c..dde9c18d 100644 --- a/tests/expand-manifest.jsonld +++ b/tests/expand-manifest.jsonld @@ -1297,6 +1297,142 @@ "input": "expand/es02-in.jsonld", "expect": "invalid container mapping", "option": {"processingMode": "json-ld-1.1", "specVersion": "json-ld-1.1"} + }, { + "@id": "#th001", + "@type": ["jld:PositiveEvaluationTest", "jld:ExpandTest"], + "name": "Expands embedded JSON-LD script element", + "purpose": "Tests embedded JSON-LD in HTML", + "input": "expand/h001-in.html", + "expect": "expand/h001-out.jsonld", + "option": {"specVersion": "json-ld-1.1"} + }, { + "@id": "#th002", + "@type": ["jld:PositiveEvaluationTest", "jld:ExpandTest"], + "name": "Expands first embedded JSON-LD script element", + "purpose": "Tests embedded JSON-LD in HTML", + "input": "expand/h002-in.html", + "expect": "expand/h002-out.jsonld", + "option": {"specVersion": "json-ld-1.1"} + }, { + "@id": "#th003", + "@type": ["jld:PositiveEvaluationTest", "jld:ExpandTest"], + "name": "Expands targeted JSON-LD script element", + "purpose": "Tests embedded JSON-LD in HTML with fragment identifier", + "input": "expand/h003-in.html#second", + "expect": "expand/h003-out.jsonld", + "option": {"specVersion": "json-ld-1.1"} + }, { + "@id": "#th004", + "@type": ["jld:PositiveEvaluationTest", "jld:ExpandTest"], + "name": "Expands all embedded JSON-LD script elements with extractAllScripts option", + "purpose": "Tests embedded JSON-LD in HTML extracting all elements", + "input": "expand/h004-in.html", + "expect": "expand/h004-out.jsonld", + "option": {"specVersion": "json-ld-1.1", "extractAllScripts": true} + }, { + "@id": "#th005", + "@type": ["jld:PositiveEvaluationTest", "jld:ExpandTest"], + "name": "Expands multiple embedded JSON-LD script elements where one is an array", + "purpose": "Tests embedded JSON-LD in HTML extracting all elements with array", + "input": "expand/h005-in.html", + "expect": "expand/h005-out.jsonld", + "option": {"specVersion": "json-ld-1.1", "extractAllScripts": true} + }, { + "@id": "#th006", + "@type": ["jld:PositiveEvaluationTest", "jld:ExpandTest"], + "name": "Expands as empty with no embedded JSON-LD script elements", + "purpose": "Tests embedded JSON-LD in HTML when none exist", + "input": "expand/h006-in.html", + "expect": "expand/h006-out.jsonld", + "option": {"specVersion": "json-ld-1.1"} + }, { + "@id": "#th007", + "@type": ["jld:PositiveEvaluationTest", "jld:ExpandTest"], + "name": "Expands as empty with no embedded JSON-LD script elements and extractAllScripts", + "purpose": "Tests embedded JSON-LD in HTML when none exist extracting all elements", + "input": "expand/h007-in.html", + "expect": "expand/h007-out.jsonld", + "option": {"specVersion": "json-ld-1.1", "extractAllScripts": true} + }, { + "@id": "#th008", + "@type": ["jld:PositiveEvaluationTest", "jld:ExpandTest"], + "name": "Expands embedded JSON-LD script element with comments", + "purpose": "Tests embedded JSON-LD in HTML with comments", + "input": "expand/h008-in.html", + "expect": "expand/h008-out.jsonld", + "option": {"specVersion": "json-ld-1.1"} + }, { + "@id": "#th009", + "@type": ["jld:PositiveEvaluationTest", "jld:ExpandTest"], + "name": "Expands embedded JSON-LD script element with escaped tokens", + "purpose": "Tests embedded JSON-LD in HTML with escapes", + "input": "expand/h009-in.html", + "expect": "expand/h009-out.jsonld", + "option": {"specVersion": "json-ld-1.1"} + }, { + "@id": "#th010", + "@type": ["jld:PositiveEvaluationTest", "jld:ExpandTest"], + "name": "Expands embedded JSON-LD script element with HTML character references", + "purpose": "Tests embedded JSON-LD in HTML with character references", + "input": "expand/h010-in.html", + "expect": "expand/h010-out.jsonld", + "option": {"specVersion": "json-ld-1.1"} + }, { + "@id": "#th011", + "@type": ["jld:NegativeEvaluationTest", "jld:ExpandTest"], + "name": "Errors if no element found at target", + "purpose": "Tests embedded JSON-LD in HTML with fragment identifier that doesn't exist", + "input": "expand/h011-in.html#third", + "expect": "invalid script element", + "option": {"specVersion": "json-ld-1.1"} + }, { + "@id": "#th012", + "@type": ["jld:NegativeEvaluationTest", "jld:ExpandTest"], + "name": "Errors if targeted element is not a script element", + "purpose": "Tests embedded JSON-LD in HTML which isn't a script element", + "input": "expand/h012-in.html#first", + "expect": "invalid script element", + "option": {"specVersion": "json-ld-1.1"} + }, { + "@id": "#th013", + "@type": ["jld:NegativeEvaluationTest", "jld:ExpandTest"], + "name": "Errors if targeted element does not have type application/ld+json", + "purpose": "Tests embedded JSON-LD in HTML with wrong type", + "input": "expand/h013-in.html#first", + "expect": "invalid script element", + "option": {"specVersion": "json-ld-1.1"} + }, { + "@id": "#th014", + "@type": ["jld:NegativeEvaluationTest", "jld:ExpandTest"], + "name": "Errors if uncommented script text contains comment", + "purpose": "Tests embedded JSON-LD in HTML with comments leftover", + "input": "expand/h014-in.html", + "expect": "invalid script element", + "option": {"specVersion": "json-ld-1.1"} + }, { + "@id": "#th015", + "@type": ["jld:NegativeEvaluationTest", "jld:ExpandTest"], + "name": "Errors if end comment missing", + "purpose": "Tests embedded JSON-LD in HTML with unballanced comments", + "input": "expand/h015-in.html", + "expect": "invalid script element", + "option": {"specVersion": "json-ld-1.1"} + }, { + "@id": "#th016", + "@type": ["jld:NegativeEvaluationTest", "jld:ExpandTest"], + "name": "Errors if start comment missing", + "purpose": "Tests embedded JSON-LD in HTML with unballanced comments", + "input": "expand/h016-in.html", + "expect": "invalid script element", + "option": {"specVersion": "json-ld-1.1"} + }, { + "@id": "#th017", + "@type": ["jld:NegativeEvaluationTest", "jld:ExpandTest"], + "name": "Errors if uncommented script is not valid JSON", + "purpose": "Tests embedded JSON-LD in HTML which is invalid JSON", + "input": "expand/h017-in.html", + "expect": "invalid script element", + "option": {"specVersion": "json-ld-1.1"} }, { "@id": "#tm001", "@type": ["jld:PositiveEvaluationTest", "jld:ExpandTest"], diff --git a/tests/expand/h001-in.html b/tests/expand/h001-in.html new file mode 100644 index 00000000..57328e38 --- /dev/null +++ b/tests/expand/h001-in.html @@ -0,0 +1,12 @@ + + + + + \ No newline at end of file diff --git a/tests/expand/h001-out.jsonld b/tests/expand/h001-out.jsonld new file mode 100644 index 00000000..e793da70 --- /dev/null +++ b/tests/expand/h001-out.jsonld @@ -0,0 +1,3 @@ +[{ + "http://example.com/foo": [{"@list": [{"@value": "bar"}]}] +}] \ No newline at end of file diff --git a/tests/expand/h002-in.html b/tests/expand/h002-in.html new file mode 100644 index 00000000..b287ab50 --- /dev/null +++ b/tests/expand/h002-in.html @@ -0,0 +1,21 @@ + + + + + + \ No newline at end of file diff --git a/tests/expand/h002-out.jsonld b/tests/expand/h002-out.jsonld new file mode 100644 index 00000000..e793da70 --- /dev/null +++ b/tests/expand/h002-out.jsonld @@ -0,0 +1,3 @@ +[{ + "http://example.com/foo": [{"@list": [{"@value": "bar"}]}] +}] \ No newline at end of file diff --git a/tests/expand/h003-in.html b/tests/expand/h003-in.html new file mode 100644 index 00000000..f18c1dae --- /dev/null +++ b/tests/expand/h003-in.html @@ -0,0 +1,21 @@ + + + + + + \ No newline at end of file diff --git a/tests/expand/h003-out.jsonld b/tests/expand/h003-out.jsonld new file mode 100644 index 00000000..83d36929 --- /dev/null +++ b/tests/expand/h003-out.jsonld @@ -0,0 +1,4 @@ +[ + {"http://example.com/foo": [{"@value": "foo"}]}, + {"http://example.com/bar": [{"@value": "bar"}]} +] \ No newline at end of file diff --git a/tests/expand/h004-in.html b/tests/expand/h004-in.html new file mode 100644 index 00000000..b287ab50 --- /dev/null +++ b/tests/expand/h004-in.html @@ -0,0 +1,21 @@ + + + + + + \ No newline at end of file diff --git a/tests/expand/h004-out.jsonld b/tests/expand/h004-out.jsonld new file mode 100644 index 00000000..58be8a87 --- /dev/null +++ b/tests/expand/h004-out.jsonld @@ -0,0 +1,10 @@ +[ + {"http://example.com/foo": [{"@list": [{"@value": "bar"}]}]}, + { + "@graph": [{ + "http://example.com/foo": [{"@value": "foo"}] + }, { + "http://example.com/bar": [{"@value": "bar"}] + }] + } +] \ No newline at end of file diff --git a/tests/expand/h005-in.html b/tests/expand/h005-in.html new file mode 100644 index 00000000..1c07a03f --- /dev/null +++ b/tests/expand/h005-in.html @@ -0,0 +1,18 @@ + + + + + + \ No newline at end of file diff --git a/tests/expand/h005-out.jsonld b/tests/expand/h005-out.jsonld new file mode 100644 index 00000000..602ce014 --- /dev/null +++ b/tests/expand/h005-out.jsonld @@ -0,0 +1,5 @@ +[ + {"http://example.com/foo": [{"@list": [{"@value": "bar"}]}]}, + {"http://example.com/foo": [{"@value": "foo"}]}, + {"http://example.com/bar": [{"@value": "bar"}]} +] \ No newline at end of file diff --git a/tests/expand/h006-in.html b/tests/expand/h006-in.html new file mode 100644 index 00000000..4301ea4d --- /dev/null +++ b/tests/expand/h006-in.html @@ -0,0 +1 @@ + \ No newline at end of file diff --git a/tests/expand/h006-out.jsonld b/tests/expand/h006-out.jsonld new file mode 100644 index 00000000..0637a088 --- /dev/null +++ b/tests/expand/h006-out.jsonld @@ -0,0 +1 @@ +[] \ No newline at end of file diff --git a/tests/expand/h007-in.html b/tests/expand/h007-in.html new file mode 100644 index 00000000..4301ea4d --- /dev/null +++ b/tests/expand/h007-in.html @@ -0,0 +1 @@ + \ No newline at end of file diff --git a/tests/expand/h007-out.jsonld b/tests/expand/h007-out.jsonld new file mode 100644 index 00000000..0637a088 --- /dev/null +++ b/tests/expand/h007-out.jsonld @@ -0,0 +1 @@ +[] \ No newline at end of file diff --git a/tests/expand/h008-in.html b/tests/expand/h008-in.html new file mode 100644 index 00000000..178034ab --- /dev/null +++ b/tests/expand/h008-in.html @@ -0,0 +1,14 @@ + + + + + \ No newline at end of file diff --git a/tests/expand/h008-out.jsonld b/tests/expand/h008-out.jsonld new file mode 100644 index 00000000..e793da70 --- /dev/null +++ b/tests/expand/h008-out.jsonld @@ -0,0 +1,3 @@ +[{ + "http://example.com/foo": [{"@list": [{"@value": "bar"}]}] +}] \ No newline at end of file diff --git a/tests/expand/h009-in.html b/tests/expand/h009-in.html new file mode 100644 index 00000000..1a85b642 --- /dev/null +++ b/tests/expand/h009-in.html @@ -0,0 +1,13 @@ + + + + + \ No newline at end of file diff --git a/tests/expand/h009-out.jsonld b/tests/expand/h009-out.jsonld new file mode 100644 index 00000000..44cc49c8 --- /dev/null +++ b/tests/expand/h009-out.jsonld @@ -0,0 +1,6 @@ +[{ + "http://example/comment-start": [{"@value": ""}], + "http://example/script-start": [{"@value": ""}] +}] \ No newline at end of file diff --git a/tests/expand/h010-in.html b/tests/expand/h010-in.html new file mode 100644 index 00000000..384ea36e --- /dev/null +++ b/tests/expand/h010-in.html @@ -0,0 +1,10 @@ + + + + + \ No newline at end of file diff --git a/tests/expand/h010-out.jsonld b/tests/expand/h010-out.jsonld new file mode 100644 index 00000000..4246a085 --- /dev/null +++ b/tests/expand/h010-out.jsonld @@ -0,0 +1,3 @@ +[{ + "http://example/foo": [{"@value": "<&>"}] +}] \ No newline at end of file diff --git a/tests/expand/h011-in.html b/tests/expand/h011-in.html new file mode 100644 index 00000000..f18c1dae --- /dev/null +++ b/tests/expand/h011-in.html @@ -0,0 +1,21 @@ + + + + + + \ No newline at end of file diff --git a/tests/expand/h012-in.html b/tests/expand/h012-in.html new file mode 100644 index 00000000..7700c932 --- /dev/null +++ b/tests/expand/h012-in.html @@ -0,0 +1,12 @@ + + + 

    +    {
+      "@context": {
+        "foo": {"@id": "http://example.com/foo", "@container": "@list"}
+      },
+      "foo": [{"@value": "bar"}]
+    }
+
    + + \ No newline at end of file diff --git a/tests/expand/h013-in.html b/tests/expand/h013-in.html new file mode 100644 index 00000000..4e0d64a4 --- /dev/null +++ b/tests/expand/h013-in.html @@ -0,0 +1,12 @@ + + + + + \ No newline at end of file diff --git a/tests/expand/h014-in.html b/tests/expand/h014-in.html new file mode 100644 index 00000000..ceeeff8b --- /dev/null +++ b/tests/expand/h014-in.html @@ -0,0 +1,14 @@ + + + + + \ No newline at end of file diff --git a/tests/expand/h015-in.html b/tests/expand/h015-in.html new file mode 100644 index 00000000..eb0e188a --- /dev/null +++ b/tests/expand/h015-in.html @@ -0,0 +1,13 @@ + + + + + \ No newline at end of file diff --git a/tests/expand/h016-in.html b/tests/expand/h016-in.html new file mode 100644 index 00000000..1bc35a18 --- /dev/null +++ b/tests/expand/h016-in.html @@ -0,0 +1,13 @@ + + + + + \ No newline at end of file diff --git a/tests/expand/h017-in.html b/tests/expand/h017-in.html new file mode 100644 index 00000000..be515958 --- /dev/null +++ b/tests/expand/h017-in.html @@ -0,0 +1,7 @@ + + + + + \ No newline at end of file diff --git a/tests/flatten-manifest.jsonld b/tests/flatten-manifest.jsonld index adbbcc37..be4c3dcb 100644 --- a/tests/flatten-manifest.jsonld +++ b/tests/flatten-manifest.jsonld @@ -348,6 +348,42 @@ "option": {"specVersion": "json-ld-1.1"}, "input": "flatten/e001-in.jsonld", "expect": "conflicting indexes" + }, { + "@id": "#th001", + "@type": ["jld:PositiveEvaluationTest", "jld:FlattenTest"], + "name": "Flattens embedded JSON-LD script element", + "purpose": "Tests embedded JSON-LD in HTML", + "input": "flatten/h001-in.html", + "context": "flatten/h001-context.jsonld", + "expect": "flatten/h001-out.jsonld", + "option": {"specVersion": "json-ld-1.1"} + }, { + "@id": "#th002", + "@type": ["jld:PositiveEvaluationTest", "jld:FlattenTest"], + "name": "Flattens first embedded JSON-LD script element", + "purpose": "Tests embedded JSON-LD in HTML", + "input": "flatten/h002-in.html", + "context": "flatten/h002-context.jsonld", + "expect": "flatten/h002-out.jsonld", + "option": {"specVersion": "json-ld-1.1", "extractAllScripts": false} + }, { + "@id": "#th003", + "@type": ["jld:PositiveEvaluationTest", "jld:FlattenTest"], + "name": "Flattens targeted JSON-LD script element", + "purpose": "Tests embedded JSON-LD in HTML with fragment identifier", + "input": "flatten/h003-in.html#second", + "context": "flatten/h003-context.jsonld", + "expect": "flatten/h003-out.jsonld", + "option": {"specVersion": "json-ld-1.1"} + }, { + "@id": "#th004", + "@type": ["jld:PositiveEvaluationTest", "jld:FlattenTest"], + "name": "Flattens all script elements by default", + "purpose": "Tests embedded JSON-LD in HTML with fragment identifier", + "input": "flatten/h004-in.html", + "context": "flatten/h004-context.jsonld", + "expect": "flatten/h004-out.jsonld", + "option": {"specVersion": "json-ld-1.1"} }, { "@id": "#tli01", "@type": [ "jld:PositiveEvaluationTest", "jld:FlattenTest" ], diff --git a/tests/flatten/h001-context.jsonld b/tests/flatten/h001-context.jsonld new file mode 100644 index 00000000..c9ee5d89 --- /dev/null +++ b/tests/flatten/h001-context.jsonld @@ -0,0 +1,5 @@ +{ + "@context": { + "foo": {"@id": "http://example.com/foo", "@container": "@list"} + } +} \ No newline at end of file diff --git a/tests/flatten/h001-in.html b/tests/flatten/h001-in.html new file mode 100644 index 00000000..57328e38 --- /dev/null +++ b/tests/flatten/h001-in.html @@ -0,0 +1,12 @@ + + + + + \ No newline at end of file diff --git a/tests/flatten/h001-out.jsonld b/tests/flatten/h001-out.jsonld new file mode 100644 index 00000000..b62c9ff4 --- /dev/null +++ b/tests/flatten/h001-out.jsonld @@ -0,0 +1,7 @@ +{ + "@context": { + "foo": {"@id": "http://example.com/foo", "@container": "@list"} + }, + "@graph": [{"@id": "_:b0","foo": ["bar"]} + ] +} \ No newline at end of file diff --git a/tests/flatten/h002-context.jsonld b/tests/flatten/h002-context.jsonld new file mode 100644 index 00000000..c9ee5d89 --- /dev/null +++ b/tests/flatten/h002-context.jsonld @@ -0,0 +1,5 @@ +{ + "@context": { + "foo": {"@id": "http://example.com/foo", "@container": "@list"} + } +} \ No newline at end of file diff --git a/tests/flatten/h002-in.html b/tests/flatten/h002-in.html new file mode 100644 index 00000000..b287ab50 --- /dev/null +++ b/tests/flatten/h002-in.html @@ -0,0 +1,21 @@ + + + + + + \ No newline at end of file diff --git a/tests/flatten/h002-out.jsonld b/tests/flatten/h002-out.jsonld new file mode 100644 index 00000000..b62c9ff4 --- /dev/null +++ b/tests/flatten/h002-out.jsonld @@ -0,0 +1,7 @@ +{ + "@context": { + "foo": {"@id": "http://example.com/foo", "@container": "@list"} + }, + "@graph": [{"@id": "_:b0","foo": ["bar"]} + ] +} \ No newline at end of file diff --git a/tests/flatten/h003-context.jsonld b/tests/flatten/h003-context.jsonld new file mode 100644 index 00000000..bd58ee54 --- /dev/null +++ b/tests/flatten/h003-context.jsonld @@ -0,0 +1,3 @@ +{ + "@context": {"ex": "http://example.com/"} +} \ No newline at end of file diff --git a/tests/flatten/h003-in.html b/tests/flatten/h003-in.html new file mode 100644 index 00000000..f18c1dae --- /dev/null +++ b/tests/flatten/h003-in.html @@ -0,0 +1,21 @@ + + + + + + \ No newline at end of file diff --git a/tests/flatten/h003-out.jsonld b/tests/flatten/h003-out.jsonld new file mode 100644 index 00000000..cd0c43e1 --- /dev/null +++ b/tests/flatten/h003-out.jsonld @@ -0,0 +1,7 @@ +{ + "@context": {"ex": "http://example.com/"}, + "@graph": [ + {"@id": "_:b0", "ex:foo": "foo"}, + {"@id": "_:b1", "ex:bar": "bar"} + ] +} \ No newline at end of file diff --git a/tests/flatten/h004-context.jsonld b/tests/flatten/h004-context.jsonld new file mode 100644 index 00000000..c68c329c --- /dev/null +++ b/tests/flatten/h004-context.jsonld @@ -0,0 +1,6 @@ +{ + "@context": { + "ex": "http://example.com/", + "foo": {"@id": "http://example.com/foo", "@container": "@list"} + } +} \ No newline at end of file diff --git a/tests/flatten/h004-in.html b/tests/flatten/h004-in.html new file mode 100644 index 00000000..cfac7160 --- /dev/null +++ b/tests/flatten/h004-in.html @@ -0,0 +1,18 @@ + + + + + + \ No newline at end of file diff --git a/tests/flatten/h004-out.jsonld b/tests/flatten/h004-out.jsonld new file mode 100644 index 00000000..e0315dd2 --- /dev/null +++ b/tests/flatten/h004-out.jsonld @@ -0,0 +1,11 @@ +{ + "@context": { + "ex": "http://example.com/", + "foo": {"@id": "http://example.com/foo", "@container": "@list"} + }, + "@graph": [ + {"@id": "_:b0", "foo": ["bar"]}, + {"@id": "_:b1", "ex:foo": "foo"}, + {"@id": "_:b2", "ex:bar": "bar"} + ] +} \ No newline at end of file diff --git a/tests/toRdf-manifest.jsonld b/tests/toRdf-manifest.jsonld index 8402e443..6a9ab44c 100644 --- a/tests/toRdf-manifest.jsonld +++ b/tests/toRdf-manifest.jsonld @@ -877,6 +877,30 @@ "purpose": "IRI resolution according to RFC3986.", "input": "toRdf/0129-in.jsonld", "expect": "toRdf/0129-out.nq" + }, { + "@id": "#th001", + "@type": ["jld:PositiveEvaluationTest", "jld:ToRDFTest"], + "name": "Transforms embedded JSON-LD script element", + "purpose": "Tests embedded JSON-LD in HTML", + "input": "toRdf/h001-in.html", + "expect": "toRdf/h001-out.nq", + "option": {"specVersion": "json-ld-1.1"} + }, { + "@id": "#th002", + "@type": ["jld:PositiveEvaluationTest", "jld:ToRDFTest"], + "name": "Transforms first embedded JSON-LD script element", + "purpose": "Tests embedded JSON-LD in HTML", + "input": "toRdf/h002-in.html", + "expect": "toRdf/h002-out.nq", + "option": {"specVersion": "json-ld-1.1", "extractAllScripts": false} + }, { + "@id": "#th003", + "@type": ["jld:PositiveEvaluationTest", "jld:ToRDFTest"], + "name": "Transforms targeted JSON-LD script element", + "purpose": "Tests embedded JSON-LD in HTML with fragment identifier", + "input": "toRdf/h003-in.html#second", + "expect": "toRdf/h003-out.nq", + "option": {"specVersion": "json-ld-1.1"} }, { "@id": "#tli01", "@type": ["jld:PositiveEvaluationTest", "jld:ToRDFTest"], diff --git a/tests/toRdf/h001-in.html b/tests/toRdf/h001-in.html new file mode 100644 index 00000000..5f7274ed --- /dev/null +++ b/tests/toRdf/h001-in.html @@ -0,0 +1,12 @@ + + + + +) \ No newline at end of file diff --git a/tests/toRdf/h001-out.nq b/tests/toRdf/h001-out.nq new file mode 100644 index 00000000..91e9e279 --- /dev/null +++ b/tests/toRdf/h001-out.nq @@ -0,0 +1,3 @@ +_:b0 _:b1 . +_:b1 "bar" . +_:b1 . diff --git a/tests/toRdf/h002-in.html b/tests/toRdf/h002-in.html new file mode 100644 index 00000000..b287ab50 --- /dev/null +++ b/tests/toRdf/h002-in.html @@ -0,0 +1,21 @@ + + + + + + \ No newline at end of file diff --git a/tests/toRdf/h002-out.nq b/tests/toRdf/h002-out.nq new file mode 100644 index 00000000..91e9e279 --- /dev/null +++ b/tests/toRdf/h002-out.nq @@ -0,0 +1,3 @@ +_:b0 _:b1 . +_:b1 "bar" . +_:b1 . diff --git a/tests/toRdf/h003-in.html b/tests/toRdf/h003-in.html new file mode 100644 index 00000000..f18c1dae --- /dev/null +++ b/tests/toRdf/h003-in.html @@ -0,0 +1,21 @@ + + + + + + \ No newline at end of file diff --git a/tests/toRdf/h003-out.nq b/tests/toRdf/h003-out.nq new file mode 100644 index 00000000..44f69e9a --- /dev/null +++ b/tests/toRdf/h003-out.nq @@ -0,0 +1,2 @@ +_:b0 "foo" . +_:b1 "bar" . From 7c42ee702b9ff59bfe939205873c465b346abc18 Mon Sep 17 00:00:00 2001 From: Gregg Kellogg Date: Sun, 11 Nov 2018 17:28:51 -0800 Subject: [PATCH 5/7] Update replacement for comments that should remain in the output. --- common/common.js | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/common/common.js b/common/common.js index b9e93ab1..14be9d70 100644 --- a/common/common.js +++ b/common/common.js @@ -271,6 +271,6 @@ function unComment(doc, content) { return content .replace(//, '') - .replace(/< !--/g, ''); + .replace(/< !\s*-\s*-/g, ''); } From b2d384d38a8c9f9af2de3ed56500f79b2dba77ee Mon Sep 17 00:00:00 2001 From: Gregg Kellogg Date: Sun, 11 Nov 2018 17:47:06 -0800 Subject: [PATCH 6/7] More work at undoing comments that should be viewable in the HTML when extracting examples. --- common/extract-examples.rb | 18 ++++++++++-------- 1 file changed, 10 insertions(+), 8 deletions(-) diff --git a/common/extract-examples.rb b/common/extract-examples.rb index cf8ebc97..5035f657 100755 --- a/common/extract-examples.rb +++ b/common/extract-examples.rb @@ -329,8 +329,8 @@ def save_example(examples:, element:, title:, example_number:, error:, warn:) # Remove (faked) XML comments and unescape sequences content = script_content .inner_html - .sub(/^\s*< !--/, '') - .sub(/-- >\s*$/, '') + .sub(/^\s*< !\s*-\s*-/, '') + .sub(/-\s*- >\s*$/, '') .gsub(/</, '<') end @@ -443,7 +443,10 @@ def save_example(examples:, element:, title:, example_number:, error:, warn:) # Set argument to referenced content to be parsed args[0] = if examples[ex[:result_for]][:ext] == 'html' && method == :expand # If we are expanding, and the reference is HTML, find the first script element. - doc = Nokogiri::HTML.parse(examples[ex[:result_for]][:content]) + doc = Nokogiri::HTML.parse( + examples[ex[:result_for]][:content] + .sub(/^\s*< !\s*-\s*-/, '') + .sub(/-\s*- >\s*$/, '')) # Get base from document, if present html_base = doc.at_xpath('/html/head/base/@href') @@ -457,12 +460,13 @@ def save_example(examples:, element:, title:, example_number:, error:, warn:) end StringIO.new(script_content .inner_html - .sub(/^\s*< !--/, '') - .sub(/-- >\s*$/, '') .gsub(/</, '<')) elsif examples[ex[:result_for]][:ext] == 'html' && ex[:target] # Only use the targeted script - doc = Nokogiri::HTML.parse(examples[ex[:result_for]][:content]) + doc = Nokogiri::HTML.parse( + examples[ex[:result_for]][:content] + .sub(/^\s*< !\s*-\s*-/, '') + .sub(/-\s*- >\s*$/, '')) script_content = doc.at_xpath(xpath) unless script_content errors << "Example #{ex[:number]} at line #{ex[:line]} references example #{ex[:result_for].inspect} with no JSON-LD script element" @@ -471,8 +475,6 @@ def save_example(examples:, element:, title:, example_number:, error:, warn:) end StringIO.new(script_content .to_html - .sub(/^\s*< !--/, '') - .sub(/-- >\s*$/, '') .gsub(/</, '<')) else StringIO.new(examples[ex[:result_for]][:content]) From 6a6171a94753bb62275c8384056c48747fed9422 Mon Sep 17 00:00:00 2001 From: Gregg Kellogg Date: Tue, 13 Nov 2018 14:16:25 -0800 Subject: [PATCH 7/7] Test invalid JSON-LD inside a comment (updates h017 expansion test). --- tests/expand/h017-in.html | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/tests/expand/h017-in.html b/tests/expand/h017-in.html index be515958..90a0e2f6 100644 --- a/tests/expand/h017-in.html +++ b/tests/expand/h017-in.html @@ -1,7 +1,7 @@ \ No newline at end of file