Skip to content

Algorithm updates and tests to allow @container: @set on @type #41

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.

Sign up for GitHub

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

Merged
merged 2 commits into from
Oct 3, 2018
Merged

Algorithm updates and tests to allow @container: @set on @type #41

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
80a5565
Algorithm updates and tests to allow `@container: @set` on @type or a…
gkellogg Oct 1, 2018
487c4fc
Add code modifier to `@set`.
gkellogg Oct 2, 2018
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
59 changes: 33 additions & 26 deletions index.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1125,7 +1125,7 @@ <h2>Create Term Definition</h2>
<section class="informative">
<h3>Overview</h3>

<p><a>term definitions</a> are created by
<p><a>Term definitions</a> are created by
parsing the information in the given <a>local context</a> for the
given <a>term</a>. If the given <a>term</a> is a
<a>compact IRI</a>, it may omit an <a>IRI mapping</a> by
Expand Down Expand Up @@ -1165,14 +1165,21 @@ <h3>Algorithm</h3>
<li>Set the value associated with <var>defined</var>'s <var>term</var> <a>member</a> to
<code>false</code>. This indicates that the <a>term definition</a>
is now being created but is not yet complete.</li>
<li>Since <a>keywords</a> cannot be overridden,
<var>term</var> must not be a <a>keyword</a>. Otherwise, a
<li>Initialize <var>value</var> to a copy of the value associated with the <a>member</a>
<var>term</var> in <var>local context</var>.</li>
<li class="changed">If <a data-link-for="JsonLdOptions">processingMode</a>
is <code>json-ld-1.1</code>
and <var>term</var> is <code>@type</code>, <var>value</var>
MUST be a <a>dictionary</a> with the member <code>@container</code>
and value <code>@set</code>. Any other value means that a
<a data-link-for="JsonLdErrorCode">keyword redefinition</a> error has
been detected and processing is aborted.</li>
<li><span class="changed">Otherwise</span>, since <a>keywords</a> cannot be overridden,
<var>term</var> MUST NOT be a <a>keyword</a> and a
<a data-link-for="JsonLdErrorCode">keyword redefinition</a>
error has been detected and processing is aborted.</li>
<li>Remove any existing <a>term definition</a> for <var>term</var> in
<var>active context</var>.</li>
<li>Initialize <var>value</var> to a copy of the value associated with the <a>member</a>
<var>term</var> in <var>local context</var>.</li>
<li>If <var>value</var> is <code>null</code> or <var>value</var>
is a <a class="changed">dictionary</a> containing the key-value pair
<code>@id</code>-<code>null</code>, set the
Expand All @@ -1183,15 +1190,15 @@ <h3>Algorithm</h3>
to a <a class="changed">dictionary</a> consisting of a single <a>member</a> whose
key is <code>@id</code> and whose value is <var>value</var>.
<span class="changed">Set <var>simple term</var> to <code>true</code></span>.</li>
<li>Otherwise, <var>value</var> must be a <a class="changed">dictionary</a>, if not, an
<li>Otherwise, <var>value</var> MUST be a <a class="changed">dictionary</a>, if not, an
<a data-link-for="JsonLdErrorCode">invalid term definition</a>
error has been detected and processing is aborted.
<span class="changed">Set <var>simple term</var> to <code>false</code></span>.</li>
<li>Create a new <a>term definition</a>, <var>definition</var>.</li>
<li>If <var>value</var> contains the <a>member</a> <code>@type</code>:
<ol>
<li>Initialize <var>type</var> to the value associated with the
<code>@type</code> <a>member</a>, which must be a <a>string</a>. Otherwise, an
<code>@type</code> <a>member</a>, which MUST be a <a>string</a>. Otherwise, an
<a data-link-for="JsonLdErrorCode">invalid type mapping</a>
error has been detected and processing is aborted.</li>
<li>Set <var>type</var> to the result of using the
Expand Down Expand Up @@ -1283,6 +1290,8 @@ <h3>Algorithm</h3>
of <var>definition</var> to <var>term</var>.</li>
</ol>
</li>
<li class="changed">Otherwise, if term is <code>@type</code>, set the <a>IRI mapping</a>
of <var>definition</var> to <code>@type</code>.</li>
<li>Otherwise, if <var>active context</var> has a
<a>vocabulary mapping</a>, the <a>IRI mapping</a>
of <var>definition</var> is set to the result of concatenating the value
Expand All @@ -1293,7 +1302,7 @@ <h3>Algorithm</h3>
<li>If <var>value</var> contains the <a>member</a> <code>@container</code>:
<ol>
<li>Initialize <var>container</var> to the value associated with the
<code>@container</code> <a>member</a>, which must be either
<code>@container</code> <a>member</a>, which MUST be either
<code class="changed">@graph</code>,
<code class="changed">@id</code>,
<code>@index</code>,
Expand Down Expand Up @@ -1341,7 +1350,7 @@ <h3>Algorithm</h3>
does not contain the <a>member</a> <code>@type</code>:
<ol>
<li>Initialize <var>language</var> to the value associated with the
<code>@language</code> <a>member</a>, which must be either <code>null</code>
<code>@language</code> <a>member</a>, which MUST be either <code>null</code>
or a <a>string</a>. Otherwise, an
<a data-link-for="JsonLdErrorCode">invalid language mapping</a>
error has been detected and processing is aborted.</li>
Expand All @@ -1356,8 +1365,8 @@ <h3>Algorithm</h3>
<a data-link-for="JsonLdErrorCode">invalid term definition</a>
has been detected and processing is aborted.</li>
<li>Initialize <a>nest value</a> in <var>definition</var> to the value associated with the
<code>@nest</code> <a>member</a>, which must be a <a>string</a> and
must not be a keyword other than <code>@nest</code>. Otherwise, an
<code>@nest</code> <a>member</a>, which MUST be a <a>string</a> and
MUST NOT be a keyword other than <code>@nest</code>. Otherwise, an
<a data-link-for="JsonLdErrorCode">invalid @nest value</a>
error has been detected and processing is aborted.</li>
</ol>
Expand All @@ -1369,7 +1378,7 @@ <h3>Algorithm</h3>
<a data-link-for="JsonLdErrorCode">invalid term definition</a>
has been detected and processing is aborted.</li>
<li>Initialize the <a>prefix flag</a> to the value associated with the
<code>@prefix</code> <a>member</a>, which must be a <a>boolean</a>. Otherwise, an
<code>@prefix</code> <a>member</a>, which MUST be a <a>boolean</a>. Otherwise, an
<a data-link-for="JsonLdErrorCode">invalid @prefix value</a>
error has been detected and processing is aborted.</li>
</ol>
Expand Down Expand Up @@ -2398,6 +2407,12 @@ <h3>Algorithm</h3>
passing <var>active context</var>, <var>inverse context</var>,
<var>expanded property</var> for <var>var</var>,
and <code>true</code> for <var>vocab</var>.</li>
<li class="changed">If <a>processing mode</a> is <code>json-ld-1.1</code>,
<var>element</var> does not have an <code>@value</code> member,
<var>expanded property</var> is <code>@type</code>,
and the <a>term definition</a> for <var>alias</var> in the
<var>active context</var> has a <a>container mapping</a> including <code>@set</code>,
ensure that <var>compacted value</var> is an <a>array</a>.</li>
<li>Add a <a>member</a> <var>alias</var> to <var>result</var> whose value is
set to <var>compacted value</var> and continue to the next
<var>expanded property</var>.</li>
Expand All @@ -2417,7 +2432,7 @@ <h3>Algorithm</h3>
<li>If the <a>term definition</a> for <var>property</var> in the
<var>active context</var> indicates that <var>property</var> is
a <a>reverse property</a>
<ol>
<ol>
<li>If the <a>term definition</a> for <var>property</var> in
the <var>active context</var> has a
<a>container mapping</a> <span class="changed">including</span> <code>@set</code> or
Expand Down Expand Up @@ -5457,20 +5472,8 @@ <h2>Changes since 1.0 Recommendation of 16 January 2014</h2>
a context. When this is set, vocabulary-relative IRIs, such as the
<a>members</a> of <a>node objects</a>, are expanded or compacted relative
to the <a>base IRI</a> using string concatenation.</li>
<li><a>Lists</a> may now have <a>members</a> which are themselves <a>lists</a>.</li>
<li>The <a href="#deserialize-json-ld-to-rdf-algorithm">Deserialize JSON-LD to RDF Algorithm</a>
has been updated to ensure that only <a>well-formed</a> <a>triples</a>
are emitted; previously, it only ensured that <a>triples</a> containing
<a>relative IRIs</a> were excluded.</li>
<li>The API now adds an <a data-link-for="JsonLdOptions">ordered</a>
option, defaulting to <code>false</code> This is used in algorithms to
control interation of <a>dictionary member</a> keys. Previously, the
algorithms always required such an order. The instructions for
evaluating test results have been updated accordingly.</li>
<li>The <a href="#generate-blank-node-identifier">Generate Blank Node Identifier algorithm</a>
has been updated to remove the specifics of how new blank node
identifiers are created.</li>
</ul>
<p>Additionally, see <a href="#changes-from-cg" class="sectionRef"></a>.</p>
</section>

<section class="appendix informative" id="changes-from-cg">
Expand All @@ -5489,6 +5492,10 @@ <h2>Changes since JSON-LD Community Group Final Report</h2>
<li>The <a href="#generate-blank-node-identifier">Generate Blank Node Identifier algorithm</a>
has been updated to remove the specifics of how new blank node
identifiers are created.</li>
<li>Values of <code>@type</code>, or an alais of <code>@type</code>, may now have their <code>@container</code> set to <code>@set</code>
to ensure that <code>@type</code> members are always represented as an array. This
also allows a term to be defined for <code>@type</code>, where the value MUST be a <a>dictionary</a>
with <code>@container</code> set to <code>@set</code>.</li>
</ul>
</section>

Expand Down
27 changes: 27 additions & 0 deletions tests/compact-manifest.jsonld
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -869,6 +869,33 @@
"context": "compact/0103-context.jsonld",
"expect": "compact/0103-out.jsonld",
"option": {"processingMode": "json-ld-1.1", "specVersion": "json-ld-1.1"}
}, {
"@id": "#t0104",
"@type": ["jld:PositiveEvaluationTest", "jld:CompactTest"],
"name": "Compact @type with @container: @set",
"purpose": "Ensures that a single @type value is represented as an array",
"input": "compact/0104-in.jsonld",
"context": "compact/0104-context.jsonld",
"expect": "compact/0104-out.jsonld",
"option": {"processingMode": "json-ld-1.1", "specVersion": "json-ld-1.1"}
}, {
"@id": "#t0105",
"@type": ["jld:PositiveEvaluationTest", "jld:CompactTest"],
"name": "Compact @type with @container: @set using an alias of @type",
"purpose": "Ensures that a single @type value is represented as an array",
"input": "compact/0105-in.jsonld",
"context": "compact/0105-context.jsonld",
"expect": "compact/0105-out.jsonld",
"option": {"processingMode": "json-ld-1.1", "specVersion": "json-ld-1.1"}
}, {
"@id": "#t0106",
Copy link
Contributor

Choose a reason for hiding this comment

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

Won't this test be a negative test in 1.0 mode?

Copy link
Member Author

Choose a reason for hiding this comment

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

I think the tests are reasonable to check both 1.0 and 1.1 modes. The negative test is in expansion, to make sure a 1.0 processor fails. A 1.0 processor compacting with an alias of @type will allow a @container definition but ignore it when actually compacting.

Copy link
Contributor

Choose a reason for hiding this comment

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

Ah, I thought it failed in 1.0.

Copy link
Member Author

Choose a reason for hiding this comment

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

We actually never checked that keyword aliases should only be for simple term definitions; we just ignore everything else. We could consider tightening these up in 1.1, and require that keyword aliases only be simple term definitions.

"@type": ["jld:PositiveEvaluationTest", "jld:CompactTest"],
"name": "Do not compact @type with @container: @set to an array using an alias of @type",
"purpose": "Ensures that a single @type value is not represented as an array in 1.0",
"input": "compact/0106-in.jsonld",
"context": "compact/0106-context.jsonld",
"expect": "compact/0106-out.jsonld",
"option": {"processingMode": "json-ld-1.0", "specVersion": "json-ld-1.1"}
}, {
"@id": "#tc001",
"@type": ["jld:PositiveEvaluationTest", "jld:CompactTest"],
Expand Down
5 changes: 5 additions & 0 deletions tests/compact/0104-context.jsonld
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
{
"@context": {
"@type": {"@container": "@set"}
}
}
3 changes: 3 additions & 0 deletions tests/compact/0104-in.jsonld
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
{
"@type": "http://example.org/type"
}
6 changes: 6 additions & 0 deletions tests/compact/0104-out.jsonld
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
{
"@context": {
"@type": {"@container": "@set"}
},
"@type": ["http://example.org/type"]
}
5 changes: 5 additions & 0 deletions tests/compact/0105-context.jsonld
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
{
"@context": {
"type": {"@id": "@type", "@container": "@set"}
}
}
3 changes: 3 additions & 0 deletions tests/compact/0105-in.jsonld
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
{
"@type": "http://example.org/type"
}
6 changes: 6 additions & 0 deletions tests/compact/0105-out.jsonld
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
{
"@context": {
"type": {"@id": "@type", "@container": "@set"}
},
"type": ["http://example.org/type"]
}
5 changes: 5 additions & 0 deletions tests/compact/0106-context.jsonld
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
{
"@context": {
"type": {"@id": "@type", "@container": "@set"}
}
}
3 changes: 3 additions & 0 deletions tests/compact/0106-in.jsonld
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
{
"@type": "http://example.org/type"
}
6 changes: 6 additions & 0 deletions tests/compact/0106-out.jsonld
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
{
"@context": {
"type": {"@id": "@type", "@container": "@set"}
},
"type": "http://example.org/type"
}
7 changes: 7 additions & 0 deletions tests/expand-manifest.jsonld
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1180,6 +1180,13 @@
"purpose": "Verifies that an exception is raised in Expansion when an invalid set or list object is found",
"input": "expand/e041-in.jsonld",
"expect": "invalid set or list object"
}, {
"@id": "#te042",
"@type": [ "jld:NegativeEvaluationTest", "jld:ExpandTest" ],
"name": "Keywords may not be redefined",
"purpose": "Verifies that an exception is raised on expansion when processing an invalid context attempting to define @container on a keyword",
"input": "expand/e042-in.jsonld",
"expect": "keyword redefinition"
Copy link
Contributor

Choose a reason for hiding this comment

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

Does this need to be in 1.0 mode?

Copy link
Member Author

Choose a reason for hiding this comment

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

I added a test to be sure that a 1.0 processor would fail if @type were so defined. We didn’t have good relevant tests before.

Copy link
Member Author

Choose a reason for hiding this comment

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

If processingMode is not set in the test definition, it defaults to 1.0. expand/e042-in.jsonld is the following:

{
  "@context": {
    "@type": {"@container": "@set"}
  },
  "@type": "http://example.org/type"
}

which a 1.0 processor should fail on.

Copy link
Contributor

Choose a reason for hiding this comment

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

Yeah, I was forgetting it defaulted to 1.0.

}, {
"@id": "#tec01",
"@type": [ "jld:NegativeEvaluationTest", "jld:ExpandTest" ],
Expand Down
6 changes: 6 additions & 0 deletions tests/expand/e042-in.jsonld
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
{
"@context": {
"@type": {"@container": "@set"}
},
"@type": "http://example.org/type"
}