json-ld 3.0.2 → 3.1.0

data/spec/flatten_spec.rb

@@ -6,60 +6,60 @@ describe JSON::LD::API do
 
   describe ".flatten" do
     {
-      "single object" => {
-        input: {"@id" => "http://example.com", "@type" => RDF::RDFS.Resource.to_s},
-        output: [
-          {"@id" => "http://example.com", "@type" => [RDF::RDFS.Resource.to_s]}
-        ]
+      "single object": {
+        input: %({"@id": "http://example.com", "@type": "http://www.w3.org/2000/01/rdf-schema#Resource"}),
+        output: %([
+          {"@id": "http://example.com", "@type": ["http://www.w3.org/2000/01/rdf-schema#Resource"]}
+        ])
       },
-      "embedded object" => {
-        input: {
-          "@context" => {
-            "foaf" => RDF::Vocab::FOAF.to_s
+      "embedded object": {
+        input: %({
+          "@context": {
+            "foaf": "http://xmlns.com/foaf/0.1/"
           },
-          "@id" => "http://greggkellogg.net/foaf",
-          "@type" => "http://xmlns.com/foaf/0.1/PersonalProfileDocument",
-          "foaf:primaryTopic" => [{
-            "@id" => "http://greggkellogg.net/foaf#me",
-            "@type" => "http://xmlns.com/foaf/0.1/Person"
+          "@id": "http://greggkellogg.net/foaf",
+          "@type": "http://xmlns.com/foaf/0.1/PersonalProfileDocument",
+          "foaf:primaryTopic": [{
+            "@id": "http://greggkellogg.net/foaf#me",
+            "@type": "http://xmlns.com/foaf/0.1/Person"
           }]
-        },
-        output: [
+        }),
+        output: %([
           {
-            "@id" => "http://greggkellogg.net/foaf",
-            "@type" => ["http://xmlns.com/foaf/0.1/PersonalProfileDocument"],
-            "http://xmlns.com/foaf/0.1/primaryTopic" => [{"@id" => "http://greggkellogg.net/foaf#me"}]
+            "@id": "http://greggkellogg.net/foaf",
+            "@type": ["http://xmlns.com/foaf/0.1/PersonalProfileDocument"],
+            "http://xmlns.com/foaf/0.1/primaryTopic": [{"@id": "http://greggkellogg.net/foaf#me"}]
           },
           {
-            "@id" => "http://greggkellogg.net/foaf#me",
-            "@type" => ["http://xmlns.com/foaf/0.1/Person"]
+            "@id": "http://greggkellogg.net/foaf#me",
+            "@type": ["http://xmlns.com/foaf/0.1/Person"]
           }
-        ]
+        ])
       },
-      "embedded anon" => {
-        input: {
-          "@context" => {
-            "foaf" => RDF::Vocab::FOAF.to_s
+      "embedded anon": {
+        input: %({
+          "@context": {
+            "foaf": "http://xmlns.com/foaf/0.1/"
           },
-          "@id" => "http://greggkellogg.net/foaf",
-          "@type" => "foaf:PersonalProfileDocument",
-          "foaf:primaryTopic" => {
-            "@type" => "foaf:Person"
+          "@id": "http://greggkellogg.net/foaf",
+          "@type": "foaf:PersonalProfileDocument",
+          "foaf:primaryTopic": {
+            "@type": "foaf:Person"
           }
-        },
-        output: [
+        }),
+        output: %([
           {
-            "@id" => "_:b0",
-            "@type" => [RDF::Vocab::FOAF.Person.to_s]
+            "@id": "_:b0",
+            "@type": ["http://xmlns.com/foaf/0.1/Person"]
           },
           {
-            "@id" => "http://greggkellogg.net/foaf",
-            "@type" => [RDF::Vocab::FOAF.PersonalProfileDocument.to_s],
-            RDF::Vocab::FOAF.primaryTopic.to_s => [{"@id" => "_:b0"}]
+            "@id": "http://greggkellogg.net/foaf",
+            "@type": ["http://xmlns.com/foaf/0.1/PersonalProfileDocument"],
+            "http://xmlns.com/foaf/0.1/primaryTopic": [{"@id": "_:b0"}]
           }
-        ]
+        ])
       },
-      "reverse properties" => {
+      "reverse properties": {
         input: %([
           {
             "@id": "http://example.com/people/markus",
@@ -103,7 +103,7 @@ describe JSON::LD::API do
           }
         ])
       },
-      "Simple named graph (Wikidata)" => {
+      "Simple named graph (Wikidata)": {
         input: %q({
           "@context": {
             "rdf": "http://www.w3.org/1999/02/22-rdf-syntax-ns#",
@@ -156,7 +156,7 @@ describe JSON::LD::API do
             }]
           }]),
       },
-      "Test Manifest (shortened)" => {
+      "Test Manifest (shortened)": {
         input: %q{
           {
             "@id": "",
@@ -180,7 +180,7 @@ describe JSON::LD::API do
           }]
         },
       },
-      "@reverse bnode issue (0045)" => {
+      "@reverse bnode issue (0045)": {
         input: %q{
           {
             "@context": {
@@ -234,7 +234,7 @@ describe JSON::LD::API do
           }
         ])
       },
-      "coerced @list containing an deep list" => {
+      "coerced @list containing an deep list": {
         input: %([{
           "http://example.com/foo": [{"@list": [{"@list": [{"@list": [{"@value": "baz"}]}]}]}]
         }]),
@@ -243,7 +243,7 @@ describe JSON::LD::API do
           "http://example.com/foo": [{"@list": [{"@list": [{"@list": [{"@value": "baz"}]}]}]}]
         }]),
       },
-      "@list containing empty @list" => {
+      "@list containing empty @list": {
         input: %({
           "http://example.com/foo": {"@list": [{"@list": []}]}
         }),
@@ -252,7 +252,7 @@ describe JSON::LD::API do
           "http://example.com/foo": [{"@list": [{"@list": []}]}]
         }])
       },
-      "coerced @list containing mixed list values" => {
+      "coerced @list containing mixed list values": {
         input: %({
           "@context": {"foo": {"@id": "http://example.com/foo", "@container": "@list"}},
           "foo": [
@@ -282,6 +282,387 @@ describe JSON::LD::API do
     }.each do |title, params|
       it(title) {run_flatten(params)}
     end
+
+    context "@included" do
+      {
+        "Basic Included array": {
+          input: %({
+            "@context": {
+              "@version": 1.1,
+              "@vocab": "http://example.org/"
+            },
+            "prop": "value",
+            "@included": [{
+              "prop": "value2"
+            }]
+          }),
+          output: %([{
+            "@id": "_:b0",
+            "http://example.org/prop": [{"@value": "value"}]
+          }, {
+            "@id": "_:b1",
+            "http://example.org/prop": [{"@value": "value2"}]
+          }])
+        },
+        "Basic Included object": {
+          input: %({
+            "@context": {
+              "@version": 1.1,
+              "@vocab": "http://example.org/"
+            },
+            "prop": "value",
+            "@included": {
+              "prop": "value2"
+            }
+          }),
+          output: %([{
+            "@id": "_:b0",
+            "http://example.org/prop": [{"@value": "value"}]
+          }, {
+            "@id": "_:b1",
+            "http://example.org/prop": [{"@value": "value2"}]
+          }])
+        },
+        "Multiple properties mapping to @included are folded together": {
+          input: %({
+            "@context": {
+              "@version": 1.1,
+              "@vocab": "http://example.org/",
+              "included1": "@included",
+              "included2": "@included"
+            },
+            "included1": {"prop": "value1"},
+            "included2": {"prop": "value2"}
+          }),
+          output: %([{
+            "@id": "_:b1",
+            "http://example.org/prop": [{"@value": "value1"}]
+          }, {
+            "@id": "_:b2",
+            "http://example.org/prop": [{"@value": "value2"}]
+          }])
+        },
+        "Included containing @included": {
+          input: %({
+            "@context": {
+              "@version": 1.1,
+              "@vocab": "http://example.org/"
+            },
+            "prop": "value",
+            "@included": {
+              "prop": "value2",
+              "@included": {
+                "prop": "value3"
+              }
+            }
+          }),
+          output: %([{
+            "@id": "_:b0",
+            "http://example.org/prop": [{"@value": "value"}]
+          }, {
+            "@id": "_:b1",
+            "http://example.org/prop": [{"@value": "value2"}]
+          }, {
+            "@id": "_:b2",
+            "http://example.org/prop": [{"@value": "value3"}]
+          }])
+        },
+        "Property value with @included": {
+          input: %({
+            "@context": {
+              "@version": 1.1,
+              "@vocab": "http://example.org/"
+            },
+            "prop": {
+              "@type": "Foo",
+              "@included": {
+                "@type": "Bar"
+              }
+            }
+          }),
+          output: %([{
+            "@id": "_:b0",
+            "http://example.org/prop": [
+              {"@id": "_:b1"}
+            ]
+          }, {
+            "@id": "_:b1",
+            "@type": ["http://example.org/Foo"]
+          }, {
+            "@id": "_:b2",
+            "@type": ["http://example.org/Bar"]
+          }])
+        },
+        "json.api example": {
+          input: %({
+            "@context": {
+              "@version": 1.1,
+              "@vocab": "http://example.org/vocab#",
+              "@base": "http://example.org/base/",
+              "id": "@id",
+              "type": "@type",
+              "data": "@nest",
+              "attributes": "@nest",
+              "links": "@nest",
+              "relationships": "@nest",
+              "included": "@included",
+              "self": {"@type": "@id"},
+              "related": {"@type": "@id"},
+              "comments": {
+                "@context": {
+                  "data": null
+                }
+              }
+            },
+            "data": [{
+              "type": "articles",
+              "id": "1",
+              "attributes": {
+                "title": "JSON:API paints my bikeshed!"
+              },
+              "links": {
+                "self": "http://example.com/articles/1"
+              },
+              "relationships": {
+                "author": {
+                  "links": {
+                    "self": "http://example.com/articles/1/relationships/author",
+                    "related": "http://example.com/articles/1/author"
+                  },
+                  "data": { "type": "people", "id": "9" }
+                },
+                "comments": {
+                  "links": {
+                    "self": "http://example.com/articles/1/relationships/comments",
+                    "related": "http://example.com/articles/1/comments"
+                  },
+                  "data": [
+                    { "type": "comments", "id": "5" },
+                    { "type": "comments", "id": "12" }
+                  ]
+                }
+              }
+            }],
+            "included": [{
+              "type": "people",
+              "id": "9",
+              "attributes": {
+                "first-name": "Dan",
+                "last-name": "Gebhardt",
+                "twitter": "dgeb"
+              },
+              "links": {
+                "self": "http://example.com/people/9"
+              }
+            }, {
+              "type": "comments",
+              "id": "5",
+              "attributes": {
+                "body": "First!"
+              },
+              "relationships": {
+                "author": {
+                  "data": { "type": "people", "id": "2" }
+                }
+              },
+              "links": {
+                "self": "http://example.com/comments/5"
+              }
+            }, {
+              "type": "comments",
+              "id": "12",
+              "attributes": {
+                "body": "I like XML better"
+              },
+              "relationships": {
+                "author": {
+                  "data": { "type": "people", "id": "9" }
+                }
+              },
+              "links": {
+                "self": "http://example.com/comments/12"
+              }
+            }]
+          }),
+          output: %([{
+            "@id": "_:b0",
+            "http://example.org/vocab#self": [{"@id": "http://example.com/articles/1/relationships/comments"}
+            ],
+            "http://example.org/vocab#related": [{"@id": "http://example.com/articles/1/comments"}]
+          }, {
+            "@id": "http://example.org/base/1",
+            "@type": ["http://example.org/vocab#articles"],
+            "http://example.org/vocab#title": [{"@value": "JSON:API paints my bikeshed!"}],
+            "http://example.org/vocab#self": [{"@id": "http://example.com/articles/1"}],
+            "http://example.org/vocab#author": [{"@id": "http://example.org/base/9"}],
+            "http://example.org/vocab#comments": [{"@id": "_:b0"}]
+          }, {
+            "@id": "http://example.org/base/12",
+            "@type": ["http://example.org/vocab#comments"],
+            "http://example.org/vocab#body": [{"@value": "I like XML better"}],
+            "http://example.org/vocab#author": [{"@id": "http://example.org/base/9"}],
+            "http://example.org/vocab#self": [{"@id": "http://example.com/comments/12"}]
+          }, {
+            "@id": "http://example.org/base/2",
+            "@type": ["http://example.org/vocab#people"]
+          }, {
+            "@id": "http://example.org/base/5",
+            "@type": ["http://example.org/vocab#comments"],
+            "http://example.org/vocab#body": [{"@value": "First!"}
+            ],
+            "http://example.org/vocab#author": [{"@id": "http://example.org/base/2"}],
+            "http://example.org/vocab#self": [{"@id": "http://example.com/comments/5"}]
+          }, {
+            "@id": "http://example.org/base/9",
+            "@type": ["http://example.org/vocab#people"],
+            "http://example.org/vocab#first-name": [{"@value": "Dan"}],
+            "http://example.org/vocab#last-name": [{"@value": "Gebhardt"}],
+            "http://example.org/vocab#twitter": [{"@value": "dgeb"}],
+            "http://example.org/vocab#self": [
+              {"@id": "http://example.com/people/9"},
+              {"@id": "http://example.com/articles/1/relationships/author"}
+            ],
+            "http://example.org/vocab#related": [{"@id": "http://example.com/articles/1/author"}]
+          }])
+        },
+      }.each do |title, params|
+        it(title) {run_flatten(params)}
+      end
+    end
+  end
+
+  context "html" do
+    {
+      "Flattens embedded JSON-LD script element": {
+        input: %(
+        <html>
+          <head>
+            <script type="application/ld+json">
+            {
+              "@context": {
+                "foo": {"@id": "http://example.com/foo", "@container": "@list"}
+              },
+              "foo": [{"@value": "bar"}]
+            }
+            </script>
+          </head>
+        </html>),
+        context: %({"foo": {"@id": "http://example.com/foo", "@container": "@list"}}),
+        output: %({
+          "@context": {
+            "foo": {"@id": "http://example.com/foo", "@container": "@list"}
+          },
+          "@graph": [{"@id": "_:b0","foo": ["bar"]}]
+        })
+      },
+      "Flattens first script element with extractAllScripts: false": {
+        input: %(
+        <html>
+          <head>
+            <script type="application/ld+json">
+            {
+              "@context": {
+                "foo": {"@id": "http://example.com/foo", "@container": "@list"}
+              },
+              "foo": [{"@value": "bar"}]
+            }
+            </script>
+            <script type="application/ld+json">
+            {
+              "@context": {"ex": "http://example.com/"},
+              "@graph": [
+                {"ex:foo": {"@value": "foo"}},
+                {"ex:bar": {"@value": "bar"}}
+              ]
+            }
+            </script>
+          </head>
+        </html>),
+        context: %({"foo": {"@id": "http://example.com/foo", "@container": "@list"}}),
+        output: %({
+          "@context": {
+            "foo": {"@id": "http://example.com/foo", "@container": "@list"}
+          },
+          "@graph": [{"@id": "_:b0","foo": ["bar"]}]
+        }),
+        extractAllScripts: false
+      },
+      "Flattens targeted script element": {
+        input: %(
+        <html>
+          <head>
+            <script id="first" type="application/ld+json">
+            {
+              "@context": {
+                "foo": {"@id": "http://example.com/foo", "@container": "@list"}
+              },
+              "foo": [{"@value": "bar"}]
+            }
+            </script>
+            <script id="second" type="application/ld+json">
+            {
+              "@context": {"ex": "http://example.com/"},
+              "@graph": [
+                {"ex:foo": {"@value": "foo"}},
+                {"ex:bar": {"@value": "bar"}}
+              ]
+            }
+            </script>
+          </head>
+        </html>),
+        context: %({"ex": "http://example.com/"}),
+        output: %({
+          "@context": {"ex": "http://example.com/"},
+          "@graph": [
+            {"@id": "_:b0", "ex:foo": "foo"},
+            {"@id": "_:b1", "ex:bar": "bar"}
+          ]
+        }),
+        base: "http://example.org/doc#second"
+      },
+      "Flattens all script elements by default": {
+        input: %(
+        <html>
+          <head>
+            <script type="application/ld+json">
+            {
+              "@context": {
+                "foo": {"@id": "http://example.com/foo", "@container": "@list"}
+              },
+              "foo": [{"@value": "bar"}]
+            }
+            </script>
+            <script type="application/ld+json">
+            [
+              {"http://example.com/foo": {"@value": "foo"}},
+              {"http://example.com/bar": {"@value": "bar"}}
+            ]
+            </script>
+          </head>
+        </html>),
+        context: %({
+          "ex": "http://example.com/",
+          "foo": {"@id": "http://example.com/foo", "@container": "@list"}
+        }),
+        output: %({
+          "@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"}
+          ]
+        })
+      },
+    }.each do |title, params|
+      it(title) do
+        params[:input] = StringIO.new(params[:input])
+        params[:input].send(:define_singleton_method, :content_type) {"text/html"}
+        run_flatten params.merge(validate: true)
+      end
+    end
   end
 
   def run_flatten(params)
@@ -289,11 +670,17 @@ describe JSON::LD::API do
     input = ::JSON.parse(input) if input.is_a?(String)
     output = ::JSON.parse(output) if output.is_a?(String)
     context = ::JSON.parse(context) if context.is_a?(String)
+    params[:base] ||= nil
     pending params.fetch(:pending, "test implementation") unless input
     if params[:exception]
-      expect {JSON::LD::API.flatten(input, context, params.merge(logger: logger))}.to raise_error(params[:exception])
+      expect {JSON::LD::API.flatten(input, context, logger: logger, **params)}.to raise_error(params[:exception])
     else
-      jld = JSON::LD::API.flatten(input, context, params.merge(logger: logger))
+      jld = nil
+      if params[:write]
+        expect{jld = JSON::LD::API.flatten(input, context, logger: logger, **params)}.to write(params[:write]).to(:error)
+      else
+        expect{jld = JSON::LD::API.flatten(input, context, logger: logger, **params)}.not_to write.to(:error)
+      end
       expect(jld).to produce_jsonld(output, logger)
     end
   end