earl-report 0.7.1 → 0.9.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c6dcbb408bb40367d46daa74a9992ccb11b5ccec84d63ab89eb75cc94ad45fdb
-  data.tar.gz: 5731c42e85ff773264d754c3cf7aea3ecb7eedfa0507e5c7289e7390de669f11
+  metadata.gz: 96f39fab33a1be32b13d921e1ae02c692a841a9285fc6f79b8b75e0338c395c4
+  data.tar.gz: e4f8b52306cc7b25c9602e9f99dab808ae84d27c4b795e97f2185ba0a570213e
 SHA512:
-  metadata.gz: 76722b2059adaf67a4ab6166e9d7c8ed1f1216f9026598f93597ec0bfcaf724b7ea09f8612045f86857c47cf51e8943a3bc274b3e1d1397c3ccdee04b938c95c
-  data.tar.gz: cd209db5e59d358121730784e2b2f76da344dd2d324e50df5bc2b70013ccabd4aff341c58d637fc11a11f3adccc7ebaf52cf86912ac051ec4ac647df6c8dc707
+  metadata.gz: 978c03c37788f29f3fed96181f547dc40e7d65cac035331eef8155e10a77612f4917d028a54b063f9ae7ec259837a8e02433de78a7e2282d9724008ff67f4b6f
+  data.tar.gz: 836e06dfa27dddc721083926cf443304016e9ac7de7c73003096b673c14ebdcd52deb9d202525057c7042be1c61dbf30754fc922b58302c3e670973ff3a2a19a

data/README.md

@@ -1,5 +1,5 @@
 # earl-report
-Ruby gem to consolidate multiple EARL report and generate a rollup conformance report.
+Ruby gem to consolidate multiple [EARL][] report and generate a rollup conformance report.
 
 [![Gem Version](https://badge.fury.io/rb/earl-report.png)](http://badge.fury.io/rb/earl-report)
 [![Build Status](https://github.com/gkellogg/earl-report/workflows/CI/badge.svg?branch=develop)](https://github.com/gkellogg/earl-report/actions?query=workflow%3ACI)
@@ -8,8 +8,9 @@ Ruby gem to consolidate multiple EARL report and generate a rollup conformance r
 ## Description
 Reads a test manifest in the
 [standard RDF WG format](http://www.w3.org/2011/rdf-wg/wiki/Turtle_Test_Suite)
-along with one or more individual EARL reports and generates a rollup report in
-HTML+RDFa in [ReSpec][] format.
+along with one or more individual <abbr title="Evaluation and Report Language (EARL) 1.0 Schema">[EARL][]</abbr> reports and generates a rollup report in HTML in [ReSpec][] format.
+
+[EARL]() reports use the [Evaluation and Report Language (EARL) 1.0 Schema][EARL] to describe test results in RDF to relate the results for a given _subject_ to a _test_ defined in a _test manifest_.
 
 ## Individual EARL reports
 Results for individual implementations should be specified in Turtle form, but
@@ -26,13 +27,13 @@ in the following form:
         dc:date "2012-11-17T15:19:11-05:00"^^xsd:dateTime];
       earl:mode earl:automatic ] .
 
-Additionally, `earl:subject` is expected to reference a [DOAP]() description
+Additionally, `earl:subject` is expected to reference a [DOAP][] description
 of the reported software, in the following form:
 
     <https://rubygems.org/gems/rdf-turtle> a doap:Project, earl:TestSubject, earl:Software ;
       doap:name          "RDF::Turtle" ;
       doap:developer     <https://greggkellogg.net/foaf#me> ;
-      doap:homepage      <http://ruby-rdf.github.com/rdf-turtle> ;
+      doap:homepage      <https://ruby-rdf.github.io/rdf-turtle> ;
       doap:description   "RDF::Turtle is an Turtle reader/writer for the RDF.rb library suite."@en ;
       doap:release [
                          doap:name "RDF::Turtle 3.1.0" ;
@@ -41,26 +42,26 @@ of the reported software, in the following form:
       ] ;
       doap:programming-language "Ruby" .
 
-The [DOAP]() description may be included in the [EARL]() report. If not found,
+The [DOAP][] description may be included in the [EARL][] report. If not found,
 the IRI identified by `earl:subject` will be dereferenced and is presumed to
-provide a [DOAP]() specification of the test subject.
+provide a [DOAP][] specification of the test subject.
 
-The `doap:developer` is expected to reference a [FOAF]() profile for the agent
+The `doap:developer` is expected to reference a [FOAF][] profile for the agent
 (user or organization) responsible for the test subject. It is expected to be
 of the following form:
 
     <https://greggkellogg.net/foaf#me> foaf:name "Gregg Kellogg" .
 
 If not found, the IRI identified by `doap:developer`
-will be dereferenced and is presumed to provide a [FOAF]() profile of the developer.
+will be dereferenced and is presumed to provide a [FOAF][] profile of the developer.
 
 Assertions are added to each test entry based on that test being referenced from the assertion.
 
 ## Manifest query
 The test manifest is used to find test entries and a manifest. The built-in
-query is based on the [standard RDF WG format](). Alternative manifest formats
+query is based on the [standard RDF WG format][]. Alternative manifest formats
 can be used by specifying a customized manifest query, but may require a custom
-[Haml]() template for report generation. The default query is the following:
+[Haml][] template for report generation. The default query is the following:
 
     PREFIX mf: <http://www.w3.org/2001/sw/DataAccess/tests/test-manifest#>
     PREFIX rdf: <http://www.w3.org/1999/02/22-rdf-syntax-ns#>
@@ -75,7 +76,7 @@ can be used by specifying a customized manifest query, but may require a custom
     }
 
 ## Report generation template
-The report template is in [ReSpec][] form using [Haml]() to generate individual report elements.
+The report template is in [ReSpec][] form using [Haml][] to generate individual report elements.
 
 ## Changes from previous versions
 ### Version 0.7

data/VERSION

@@ -1 +1 @@
-0.7.1
+0.9.0

data/lib/earl_report/views/earl_report.html.haml

@@ -204,6 +204,7 @@
             Test Manifests
           %ul.toc
             - tests['entries'].sort_by {|m| m['title'].to_s.downcase}.each_with_index do |manifest, ndx|
+              - manifest['rdfs:comment'] = manifest['rdfs:comment']['@value'] if manifest['rdfs:comment'].is_a?(Hash)
               %li.tocline
                 %span.secno="2.#{ndx+1}"
                 %a.tocxref{href: "##{manifest['rdfs:comment'].gsub(' ', '-')}"}
@@ -296,6 +297,7 @@
         Test Manifests
       - tests['entries'].each_with_index do |manifest, ndx2|
         - test_cases = manifest['entries']
+        - manifest['title'] = manifest['title']['@value'] if manifest['title'].is_a?(Hash)
         %section{id: manifest['rdfs:comment'].gsub(' ', '-'), typeof: manifest['@type'].join(" "), resource: manifest['@id']}
           %h2
             %span.secno="2.#{ndx2+1}"
@@ -319,6 +321,7 @@
                     %a{href: '#' + subject_refs[subject['@id']]}<=subject['name']
             - test_cases.each do |test|
               - test['title'] ||= test['rdfs:label']
+              - test['title'] = test['title']['@value'] if test['title'].is_a?(Hash)
               - test['title'] = Array(test['title']).first
               - tid = "test_#{Digest::MD5.hexdigest(test['@id'])}"
               - (test_info[tid] ||= []) << test
@@ -391,6 +394,7 @@
               - if subject['developer']
                 %dt= "Developer"
                 - subject['developer'].each do |dev|
+                  - dev['foaf:name'] = dev['foaf:name']['@value'] if dev['foaf:name'].is_a?(Hash)
                   %dd{rel: "doap:developer"}
                     %div{resource: dev['@id'], typeof: Array(dev['@type']).join(" ")}
                       - if dev.has_key?('@id')

data/lib/earl_report.rb

@@ -1,12 +1,18 @@
 # EARL reporting
 require 'json/ld'
-require 'rdf/ordered_repo'
 require 'rdf/turtle'
 require 'rdf/vocab'
 require 'sparql'
 require 'haml'
 require 'open-uri'
 
+# Optionally, beautify HTML output
+begin
+  require 'htmlbeautifier'
+rescue LoadError
+  # No beautification
+end
+
 ##
 # EARL reporting class.
 # Instantiate a new class using one or more input graphs
@@ -68,16 +74,16 @@ class EarlReport
   ASSERTION_QUERY = %(
     PREFIX earl: <http://www.w3.org/ns/earl#>
     
-    SELECT ?test ?subject ?by ?mode ?outcome
+    SELECT ?test ?subject ?by ?mode ?outcome ?info
     WHERE {
       ?a a earl:Assertion;
         earl:assertedBy ?by;
-        earl:result [earl:outcome ?outcome];
+        earl:result ?result;
         earl:subject ?subject;
         earl:test ?test .
-      OPTIONAL {
-        ?a earl:mode ?mode .
-      }
+      ?result earl:outcome ?outcome .
+      OPTIONAL {?a earl:mode ?mode .}
+      OPTIONAL {?result earl:info ?info .}
     }
     ORDER BY ?subject
   ).freeze
@@ -396,6 +402,7 @@ class EarlReport
           graph << RDF::Statement(a, RDF::Vocab::EARL.result, r)
           graph << RDF::Statement(r, RDF.type, RDF::Vocab::EARL.TestResult)
           graph << RDF::Statement(r, RDF::Vocab::EARL.outcome, solution[:outcome])
+          graph << RDF::Statement(r, RDF::Vocab::EARL.info, solution[:info]) if solution[:info]
         end
 
         # See if subject did not report results, which may indicate a formatting error in the EARL source
@@ -496,7 +503,14 @@ class EarlReport
       end
 
       # Generate HTML report
-      html = Haml::Engine.new(haml, format: :xhtml).render(self, tests: json_hash)
+      html = if Haml.const_defined?(:Template)
+        Haml::Template.new(format: :xhtml) {haml}.render(self, tests: json_hash)
+      else
+        Haml::Engine.new(haml, format: :xhtml).render(self, tests: json_hash)
+      end
+      if defined?(::HtmlBeautifier)
+        html = HtmlBeautifier.beautify(html)
+      end
       io.write(html) if io
       html
     else
@@ -524,7 +538,7 @@ class EarlReport
         # Reorder test assertions to make them consistent with subject order
         Array(framed['entries']).each do |manifest|
           manifest['entries'].each do |test|
-            test['assertions'] = test['assertions'].sort_by {|a| a['subject']}
+            test['assertions'] = test['assertions'].sort_by {|a| a['subject'].to_s}
           end
         end
         framed

data/spec/test-files/doap.ttl

@@ -9,7 +9,7 @@
 
 <https://rubygems.org/gems/rdf-turtle> a doap:Project, earl:TestSubject, earl:Software ;
   doap:name          "RDF::Turtle" ;
-  doap:homepage      <http://ruby-rdf.github.com/rdf-turtle> ;
+  doap:homepage      <https://ruby-rdf.github.io/rdf-turtle> ;
   doap:license       <http://creativecommons.org/publicdomain/zero/1.0/> ;
   doap:shortdesc     "Turtle reader/writer for Ruby."@en ;
   doap:description   "RDF::Turtle is an Turtle reader/writer for the RDF.rb library suite."@en ;

data/spec/test-files/report-complete.ttl

@@ -9,7 +9,7 @@
 
 <https://rubygems.org/gems/rdf-turtle> a doap:Project, earl:TestSubject, earl:Software ;
   doap:name          "RDF::Turtle" ;
-  doap:homepage      <http://ruby-rdf.github.com/rdf-turtle> ;
+  doap:homepage      <https://ruby-rdf.github.io/rdf-turtle> ;
   doap:license       <http://creativecommons.org/publicdomain/zero/1.0/> ;
   doap:shortdesc     "Turtle reader/writer for Ruby."@en ;
   doap:description   "RDF::Turtle is an Turtle reader/writer for the RDF.rb library suite."@en ;

data/spec/test-files/report-no-foaf.ttl

@@ -9,7 +9,7 @@
 
 <https://rubygems.org/gems/rdf-turtle> a doap:Project, earl:TestSubject, earl:Software ;
   doap:name          "RDF::Turtle" ;
-  doap:homepage      <http://ruby-rdf.github.com/rdf-turtle> ;
+  doap:homepage      <https://ruby-rdf.github.io/rdf-turtle> ;
   doap:license       <http://creativecommons.org/publicdomain/zero/1.0/> ;
   doap:shortdesc     "Turtle reader/writer for Ruby."@en ;
   doap:description   "RDF::Turtle is an Turtle reader/writer for the RDF.rb library suite."@en ;

data/spec/test-files/report-no-test.ttl

@@ -9,7 +9,7 @@
 
 <https://rubygems.org/gems/rdf-turtle> a doap:Project, earl:TestSubject, earl:Software ;
   doap:name          "RDF::Turtle" ;
-  doap:homepage      <http://ruby-rdf.github.com/rdf-turtle> ;
+  doap:homepage      <https://ruby-rdf.github.io/rdf-turtle> ;
   doap:license       <http://creativecommons.org/publicdomain/zero/1.0/> ;
   doap:shortdesc     "Turtle reader/writer for Ruby."@en ;
   doap:description   "RDF::Turtle is an Turtle reader/writer for the RDF.rb library suite."@en ;