Adds back links to specs for each test that used data-tests. (#178)

* Build test-map by scanning specs for `data-tests` attributes.
* Update HAML templates to add "references" with back references to places in the spec that reference each test using `data-tests`.
* Rename SPARQL1.0 to SPARQL 1.0.
* Rename SPARQL1.1 to SPARQL 1.1.
* Use relative locations of specs and their related test manifests and resolve the test links extracted from the spec. Also fixes some other inconsistencies in the templates.

---------

Co-authored-by: gkellogg <[email protected]>

Author: gkellogg

.gitignore

@@ -0,0 +1 @@
+/.byebug_history

Gemfile

@@ -9,3 +9,4 @@ gem 'kramdown',       '~> 2.5'
 gem 'htmlbeautifier', '~> 1.4'
 gem 'logger',         '~> 1.7'
 gem 'ostruct',        '~> 0.6'
+gem 'nokogiri',       '~> 1.18'

Gemfile.lock

@@ -32,7 +32,12 @@ GEM
     logger (1.7.0)
     matrix (0.4.2)
     multi_json (1.15.0)
+    nokogiri (1.18.8-arm64-darwin)
+      racc (~> 1.4)
+    nokogiri (1.18.8-x86_64-linux-gnu)
+      racc (~> 1.4)
     ostruct (0.6.1)
+    racc (1.8.1)
     rack (3.1.14)
     rake (13.2.1)
     rdf (3.3.2)
@@ -65,6 +70,7 @@ DEPENDENCIES
   json-ld
   kramdown (~> 2.5)
   logger (~> 1.7)
+  nokogiri (~> 1.18)
   ostruct (~> 0.6)
   rake
   rdf-turtle

Rakefile

@@ -3,16 +3,110 @@ require 'rdf/turtle'
 require 'json/ld'
 require 'haml'
 require 'htmlbeautifier'
+require 'nokogiri'
+require 'rake/clean'
 
 task default: :index
 
 MANIFESTS = Dir.glob("**/manifest*.ttl").reject {|f| f.include?('-az')}
 
+SPECS = {
+  "rdf-concepts/spec/index.html"  => "FIXME",
+  "rdf-n-quads/spec/index.html"   => "rdf/rdf12/rdf-n-quads/",
+  "rdf-n-triples/spec/index.html" => "rdf/rdf12/rdf-n-triples/",
+  "rdf-schema/spec/index.html"    => "FIXME",
+  "rdf-semantics/spec/index.html" => "rdf/rdf12/rdf-semantics/",
+  "rdf-trig/spec/index.html"      => "rdf/rdf12/rdf-trig/",
+  "rdf-turtle/spec/index.html"    => "rdf/rdf12/rdf-turtle/",
+  "rdf-xml/spec/index.html"       => "rdf/rdf12/rdf-xml/",
+
+  "sparql-concepts/spec/index.html"             => "",
+  "sparql-entailment/spec/index.html"           => "",
+  "sparql-federated-query/spec/index.html"      => "",
+  "sparql-graph-store-protocol/spec/index.html" => "",
+  "sparql-protocol/spec/index.html"             => "",
+  "sparql-query/spec/index.html"                => "",
+  "sparql-results-csv-tsv/spec/index.html"      => "",
+  "sparql-results-json/spec/index.html"         => "",
+  "sparql-results-xml/spec/index.html"          => "",
+  "sparql-service-description/spec/index.html"  => "",
+  "sparql-update/spec/index.html"               => ""
+}
+
+JSON_STATE = {
+                 :indent => "  ",
+                  :space => " ",
+           :space_before => "",
+              :object_nl => "\n",
+               :array_nl => "\n",
+              :allow_nan => false,
+             :ascii_only => false,
+            :max_nesting => 100,
+            :script_safe => false,
+                 :strict => false,
+                  :depth => 0,
+  :buffer_initial_length => 1024
+}
+
+CLOBBER.include("test-map.json")
+desc "Build map of test references"
+file "test-map.json" do
+  puts "Generate test-map.json"
+  # Test map will be like the following:
+  # {
+  #   "rdf/rdf11/rdf-xml/index.html" => {
+  #     "xmlbase-test001" => [
+  #       "https://w3c.github.io/rdf-xml/spec/index.html#baseURIs-tests1"
+  #     ]
+  #   }
+  # }
+  test_map = {}
+  failed = false
+  SPECS.each do |spec, ts|
+    spec = "https://w3c.github.io/#{spec}"
+    ts = RDF::URI("https://w3c.github.io/rdf-tests/#{ts}")
+    puts "  Spec: #{spec}"
+    RDF::Util::File.open_file(spec) do |f|
+      dom = Nokogiri::HTML.parse(f)
+      # Extract each referenced test from the data-tests attribute
+      dom.css("*[data-tests]").each do |el|
+        id = el['id']
+        raise StandardError, "In #{spec}, data-tests found on element without an anchor" unless id
+
+        el.attributes['data-tests']
+          .value
+          .split(',')
+          .map(&:strip)
+          .each do |ref|
+
+            man, anchor = ref.split('#')
+            man = ts.join(man).to_s.sub('https://w3c.github.io/rdf-tests/', '')
+            ((test_map[man] ||= {})[anchor] ||= []) << "#{spec}##{id}"
+        end
+      end
+    end
+    rescue IOError => e
+      failed = true
+      puts "Failed to open URL: #{e.message}"
+    rescue StandardError => e
+      failed = true
+      puts "An error occurred: #{e.message}"
+  end
+
+  unless failed
+    File.open("test-map.json", "w") do |f|
+      f.write(test_map.to_json(JSON_STATE))
+    end
+  end
+end
+
 desc "Build HTML manifests"
 task index: MANIFESTS.
   select {|m| File.exist?(m)}.
   map {|m| m.sub(/manifest(.*)\.ttl$/, 'index\1.html')}
 
+CLOBBER.include(MANIFESTS.map {|ttl| ttl.sub(/manifest(.*)\.ttl$/, 'index\1.html')})
+
 MANIFESTS.each do |ttl|
   html = ttl.sub(/manifest(.*)\.ttl$/, 'index\1.html')
   base = 'https://w3c.github.io/rdf-tests/' + ttl.sub('manifest.ttl', '')
@@ -30,7 +124,7 @@ MANIFESTS.each do |ttl|
 
   if template_path
     desc "Build #{html}"
-    file html => [ttl, frame_path, template_path] do
+    file html => [ttl, frame_path, template_path, 'test-map.json'] do
       puts "Generate #{html}"
       frame, template, man = File.read(frame_path), File.read(template_path), nil
 
@@ -75,7 +169,8 @@ MANIFESTS.each do |ttl|
         rendered = haml_runner.render(self,
             man: man,
             haml_indent: true,
-            ttl: ttl.split('/').last
+            ttl: ttl.split('/').last,
+            test_map: JSON.parse(File.read('test-map.json')).fetch(html, {})
           )
         beautified = HtmlBeautifier.beautify(rendered) + "\n"
         f.write(beautified)

local-biblio.js

@@ -113,12 +113,12 @@
       rdfs:comment "A type of test specifically for syntax testing of SPARQL Update. Syntax tests are not required to have an associated result, only an action. Tests are expected to define their spec version." .
 
 :PositiveSyntaxTest11 rdf:type rdfs:Class ;
-      rdfs:label "Positive Syntax Test for SPARQL1.1 Query" ;
-      rdfs:comment "A type of test specifically for syntax testing of new features in the SPARQL1.1 Query Language. Syntax tests are not required to have an associated result, only an action." .
+      rdfs:label "Positive Syntax Test for SPARQL 1.1 Query" ;
+      rdfs:comment "A type of test specifically for syntax testing of new features in the SPARQL 1.1 Query Language. Syntax tests are not required to have an associated result, only an action." .
 
 :PositiveUpdateSyntaxTest11 rdf:type rdfs:Class ;
-      rdfs:label "Positive Syntax Test for SPARQL1.1 Update" ;
-      rdfs:comment "A type of test specifically for syntax testing of SPARQL1.1 Update. Syntax tests are not required to have an associated result, only an action." .
+      rdfs:label "Positive Syntax Test for SPARQL 1.1 Update" ;
+      rdfs:comment "A type of test specifically for syntax testing of SPARQL 1.1 Update. Syntax tests are not required to have an associated result, only an action." .
 
 
 :NegativeSyntaxTest rdf:type rdfs:Class ;
@@ -130,12 +130,12 @@
       rdfs:comment "A type of test specifically for syntax testing of SPARQL Update. Syntax tests are not required to have an associated result, only an action. Negative syntax tests are tests of which the result should be a parser error. Tests are expected to define their spec version." .
 
 :NegativeSyntaxTest11 rdf:type rdfs:Class ;
-      rdfs:label "Negative Syntax Test for SPARQL1.1 Query" ;
-      rdfs:comment "A type of test specifically for syntax testing of new features in the SPARQL1.1 Query Language. Syntax tests are not required to have an associated result, only an action. Negative syntax tests are tests of which the result should be a parser error." .
+      rdfs:label "Negative Syntax Test for SPARQL 1.1 Query" ;
+      rdfs:comment "A type of test specifically for syntax testing of new features in the SPARQL 1.1 Query Language. Syntax tests are not required to have an associated result, only an action. Negative syntax tests are tests of which the result should be a parser error." .
 
 :NegativeUpdateSyntaxTest11 rdf:type rdfs:Class ;
-      rdfs:label "Negative Syntax Test for SPARQL1.1 Update" ;
-      rdfs:comment "A type of test specifically for syntax testing of SPARQL1.1 Update. Syntax tests are not required to have an associated result, only an action. Negative syntax tests are tests of which the result should be a parser error." .
+      rdfs:label "Negative Syntax Test for SPARQL 1.1 Update" ;
+      rdfs:comment "A type of test specifically for syntax testing of SPARQL 1.1 Update. Syntax tests are not required to have an associated result, only an action. Negative syntax tests are tests of which the result should be a parser error." .
 
 
 :QueryEvaluationTest rdf:type rdfs:Class ;

ns/test-manifest.ttl

@@ -6,7 +6,7 @@
     <meta content='width=device-width, initial-scale=1.0' name='viewport'>
     <link href='https://www.w3.org/StyleSheets/TR/base' rel='stylesheet' type='text/css'>
     <style>
-      body: {bacground-image: none;}
+      body {background-image: none;}
       dl.editor>dd {
         margin: 0 0 0 40px;
       }
@@ -65,12 +65,14 @@ <h2 id='abstract'>Abstract</h2>
       <p property='rdfs:comment'>
         <p>These test suites are a product previous RDF working groups, and has been maintained by the <a href="https://www.w3.org/community/rdf-tests/">RDF Test Curation Community Group</a>. Community maintained at <a href="https://github.com/w3c/rdf-tests/tree/main/rdf/rdf11/">https://github.com/w3c/rdf-tests/tree/main/rdf/rdf11</a>. Conformance with RDF 1.1 specifications can be determined via successfully running the tests for relevant specifications.</p>
       </p>
-      <p>This page describes W3C RDF 1.1 Working Group's test suite.</p>
-      <h3 id="contributing-tests">Contributing Tests</h3>
+      <p>
+        This page describes W3C RDF 1.1 Working Group's test suite.
+      </p>
+      <h3 id='contributing-tests'>Contributing Tests</h3>
       <p>The test manifests and entries are built automatically from <a href="manifest.ttl">manifest.ttl</a> using a Rake task. Tests may be contributed via pull request to <a href="https://github.com/w3c/rdf-tests">https://github.com/w3c/rdf-tests</a> with suitable changes to the <a href="manifest.ttl">manifest.ttl</a> and referenced files.</p>
-      <h3 id="distribution">Distribution</h3>
+      <h3 id='distribution'>Distribution</h3>
       <p>Distributed under both the <a href="http://www.w3.org/Consortium/Legal/2008/04-testsuite-license">W3C Test Suite License</a> and the <a href="http://www.w3.org/Consortium/Legal/2008/03-bsd-license">W3C 3-clause BSD License</a>. To contribute to a W3C Test Suite, see the <a href="http://www.w3.org/2004/10/27-testcases">policies and contribution forms</a>.</p>
-      <h3 id="disclaimer">Disclaimer</h3>
+      <h3 id='disclaimer'>Disclaimer</h3>
       <p>UNDER BOTH MUTUALLY EXCLUSIVE LICENSES, THIS DOCUMENT AND ALL DOCUMENTS, TESTS AND SOFTWARE THAT LINK THIS STATEMENT ARE PROVIDED "AS IS," AND COPYRIGHT HOLDERS MAKE NO REPRESENTATIONS OR WARRANTIES, EXPRESS OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, NON-INFRINGEMENT, OR TITLE; THAT THE CONTENTS OF THE DOCUMENT ARE SUITABLE FOR ANY PURPOSE; NOR THAT THE IMPLEMENTATION OF SUCH CONTENTS WILL NOT INFRINGE ANY THIRD PARTY PATENTS, COPYRIGHTS, TRADEMARKS OR OTHER RIGHTS.
         COPYRIGHT HOLDERS WILL NOT BE LIABLE FOR ANY DIRECT, INDIRECT, SPECIAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF ANY USE OF THE DOCUMENT OR THE PERFORMANCE OR IMPLEMENTATION OF THE CONTENTS THEREOF.</p>
     </div>

rdf/rdf11/index.html

@@ -5,7 +5,7 @@
     <meta content='width=device-width, initial-scale=1.0' name='viewport'>
     <link href='https://www.w3.org/StyleSheets/TR/base' rel='stylesheet' type='text/css'>
     <style>
-      body: {bacground-image: none;}
+      body {background-image: none;}
       dl.editor>dd {
         margin: 0 0 0 40px;
       }
@@ -92,11 +92,11 @@ <h2 id='abstract'>Abstract</h2>
       <p>Tests can be run from the web or by downloading either a <a href="TESTS.tar.gz">tarball</a> or <a href="TESTS.zip">zip file</a>.</p>
       <p>The home of the test suite is <a href="http://www.w3.org/2013/rdf-mt-tests/">http://www.w3.org/2013/rdf-mt-tests/</a>.</p>
       <p>See <a href="http://www.w3.org/2011/rdf-wg/wiki/RDF_Test_Suites">http://www.w3.org/2011/rdf-wg/wiki/RDF_Test_Suites</a> for more details. Per RFC 3986 section 5.1.3, the base IRI for parsing each file is the retrieval IRI for that file, but changing base IRIs should not affect any testing results.</p>
-      <h3 id="contributing-tests">Contributing Tests</h3>
+      <h3 id='contributing-tests'>Contributing Tests</h3>
       <p>The test manifests and entries are built automatically from <a href="manifest.ttl">manifest.ttl</a> using a Rake task. Tests may be contributed via pull request to <a href="https://github.com/w3c/rdf-tests">https://github.com/w3c/rdf-tests</a> with suitable changes to the <a href="manifest.ttl">manifest.ttl</a> and referenced files.</p>
-      <h3 id="distribution">Distribution</h3>
+      <h3 id='distribution'>Distribution</h3>
       <p>Distributed under both the <a href="http://www.w3.org/Consortium/Legal/2008/04-testsuite-license">W3C Test Suite License</a> and the <a href="http://www.w3.org/Consortium/Legal/2008/03-bsd-license">W3C 3-clause BSD License</a>. To contribute to a W3C Test Suite, see the <a href="http://www.w3.org/2004/10/27-testcases">policies and contribution forms</a>.</p>
-      <h3 id="disclaimer">Disclaimer</h3>
+      <h3 id='disclaimer'>Disclaimer</h3>
       <p>UNDER BOTH MUTUALLY EXCLUSIVE LICENSES, THIS DOCUMENT AND ALL DOCUMENTS, TESTS AND SOFTWARE THAT LINK THIS STATEMENT ARE PROVIDED "AS IS," AND COPYRIGHT HOLDERS MAKE NO REPRESENTATIONS OR WARRANTIES, EXPRESS OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, NON-INFRINGEMENT, OR TITLE; THAT THE CONTENTS OF THE DOCUMENT ARE SUITABLE FOR ANY PURPOSE; NOR THAT THE IMPLEMENTATION OF SUCH CONTENTS WILL NOT INFRINGE ANY THIRD PARTY PATENTS, COPYRIGHTS, TRADEMARKS OR OTHER RIGHTS.
         COPYRIGHT HOLDERS WILL NOT BE LIABLE FOR ANY DIRECT, INDIRECT, SPECIAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF ANY USE OF THE DOCUMENT OR THE PERFORMANCE OR IMPLEMENTATION OF THE CONTENTS THEREOF.</p>
     </div>
@@ -831,7 +831,7 @@ <h2>
         </dt>
         <dd inlist='true' property='mf:entry' resource='#rdfs-container-membership-superProperty-test001' typeof='mf:NegativeEntailmentTest'>
           <div property='rdfs:comment'>
-            <p>While it is a superproperty, _:a &lt;rdfs:contains (@@member?)&gt; _:b . does NOT entail _:a <rdf:_n> _:b . for any _n.</rdf:_n></p>
+            <p>While it is a superproperty, <code>_:a &lt;rdfs:contains (@@member?)&gt; _:b .</code> does NOT entail <code>_:a &lt;rdf:_n&gt; _:b . for any _n.</code></p>
           </div>
           <dl class='test-detail'>
             <dt>type</dt>

rdf/rdf11/rdf-mt/index.html

@@ -370,8 +370,8 @@
 <#rdfs-container-membership-superProperty-test001> a mf:NegativeEntailmentTest;
   mf:name "rdfs-container-membership-superProperty-test001";
   rdfs:comment """
-    While it is a superproperty, _:a <rdfs:contains (@@member?)>
-    _:b . does NOT entail _:a <rdf:_n> _:b . for any _n.
+    While it is a superproperty, `_:a <rdfs:contains (@@member?)> _:b .`
+    does NOT entail `_:a <rdf:_n> _:b . for any _n.`
   """;
   rdft:approval rdft:Approved;
   mf:entailmentRegime "RDFS" ;