ttl2html 1.3.1 → 1.3.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7291dd5276af9d25f9c91f5d798a1ad7614abe6d35ccf36aaa35beceb523d0ae
-  data.tar.gz: baca08577305a96a85b7c18015181a578dfbfc70344c73a599ebab582a591a69
+  metadata.gz: 536529ac6440329179bab71d30e570dc92efb464526f5a0a019c59823f67098c
+  data.tar.gz: 4f251ed59bc227e77f80fe3ea88ea1e14e99c10ece1bb7b156d0b19f98518663
 SHA512:
-  metadata.gz: fd0e4667b20caaa5444bf8c5013e8e2d9fabc944628201a340c33865f3ae747def16b4860a70eb11dad6da9b5db014bb2aeb48d8a00ef9a48ea0aa1b3bf6db84
-  data.tar.gz: 8e85d33dabd668ce182e0d10483ae95f46c44bb3a421d5153823ae6df6d0768d9ce00b8f0f010f219a8861aaa3f5349c20e1727ac3742383e22be518d2d3cebc
+  metadata.gz: 7e760bdb6848470e2e2327803e7f527684fa8e703f053cd0fda5eadc374bcaa7aeb837064f018a353f2e7c80b4845994db26106c8b139cdde9bf4e6c501f1254
+  data.tar.gz: 7cb13bd5ae523ef8ac62c843f27f1ce5f65efd70e035c35f35b6062e104b5c89e87d19c8ac4e7778ca0ce6b9881e1bbca92c5c34cda37793cc96add9679d66ff

data/lib/ttl2html/template.rb

@@ -4,12 +4,14 @@ require "fileutils"
 require "pathname"
 require "erb"
 require "i18n"
+require "action_view"
 
 module TTL2HTML
   class Template
     attr_reader :param
     include ERB::Util
     include I18n::Base
+    include ActionView::Helpers::NumberHelper
     def initialize(template, param = {})
       @template = template
       @param = param.dup
@@ -156,6 +158,12 @@ module TTL2HTML
         dest_uri
       end
     end
+    def html_title(param)
+      titles = []
+      titles << param[:title]
+      titles << param[:site_title]
+      titles.compact.join(" - ")
+    end
     def shorten_title(title, length = 140)
       if title.length > length
         title[0..length] + "..."
@@ -248,5 +256,9 @@ module TTL2HTML
       end
       to_html_raw("triples.html.erb", param_local)
     end
+    def format_version_info(version)
+      param_local = @param.dup.merge(data: version)
+      to_html_raw("version.html.erb", param_local)
+    end
   end
-end
+end

data/lib/ttl2html/version.rb

@@ -1 +1 @@
-TTL2HTML::VERSION = "1.3.1"
+TTL2HTML::VERSION = "1.3.2"

data/lib/ttl2html.rb

@@ -105,11 +105,16 @@ module TTL2HTML
       result
     end
 
-    def each_data
+    def each_data(label = :each_data)
+      progressbar = ProgressBar.create(title: label,
+        total: @data.size,
+        format: "(%t) %a %e %P% Processed: %c from %C")
       @data.each do |uri, v|
+        progressbar.increment
         next if not uri.start_with? @config[:base_uri]
         yield uri, v
       end
+      progressbar.finish
     end
     def output_html_files
       template = Template.new("", @config)
@@ -117,6 +122,8 @@ module TTL2HTML
                              RDF::URI("http://www.w3.org/1999/02/22-rdf-syntax-ns#type"),
                              RDF::URI("http://www.w3.org/ns/shacl#NodeShape")])
       labels = shapes2labels(shapes)
+      versions = extract_versions
+      toplevel = extract_toplevel
       @config[:labels_with_class] ||= {}
       labels.each do |klass, props|
         props.each do |property, label|
@@ -129,11 +136,7 @@ module TTL2HTML
         end
       end
       @config[:orders_with_class] = shapes2orders(shapes)
-      progressbar = ProgressBar.create(title: :output_html_files,
-        total: @data.size,
-        format: "(%t) %a %e %P% Processed: %c from %C")
-      each_data do |uri, v|
-        progressbar.increment
+      each_data(:output_html_files) do |uri, v|
         template = Template.new("default.html.erb", @config)
         param = @config.dup
         param[:uri] = uri
@@ -152,7 +155,6 @@ module TTL2HTML
         end
         template.output_to(file, param)
       end
-      progressbar.finish
       index_html = "index.html"
       index_html = File.join(@config[:output_dir], "index.html") if @config[:output_dir]
       if @config.has_key? :top_class
@@ -166,6 +168,8 @@ module TTL2HTML
           template = Template.new("index.html.erb", @config)
           param = @config.dup
           param[:data_global] = @data
+          param[:versions] = versions
+          param[:toplevel] = toplevel
           subjects.sort.each do |subject|
             param[:index_data] ||= []
             param[:index_data] << subject.to_s
@@ -173,13 +177,15 @@ module TTL2HTML
           template.output_to(index_html, param)
         end
       end
-      if shapes.size > 0
+      if shapes.size > 0 or versions.size > 0 or toplevel.size > 0
         about_html = @config[:about_file] || "about.html"
         about_html =  File.join(@config[:output_dir], about_html) if @config[:output_dir]
         template = Template.new("about.html.erb", @config)
         param = @config.dup
         param[:data_global] = @data
-        param[:content] = {}
+        param[:versions] = versions
+        param[:toplevel] = toplevel
+        param[:shapes] = {}
         shapes.subjects.each do |subject|
           label = comment = nil
           target_class = @data[subject.to_s]["http://www.w3.org/ns/shacl#targetClass"]
@@ -194,7 +200,7 @@ module TTL2HTML
           else
             label = template.get_title(@data[subject.to_s])
           end
-          param[:content][subject] = {
+          param[:shapes][subject] = {
             label: label,
             comment: comment,
             html: template.expand_shape(@data, subject.to_s, @prefix),
@@ -265,12 +271,67 @@ module TTL2HTML
       orders
     end
 
+    def extract_versions
+      versions = []
+      ["http://purl.org/pav/hasVersion", "http://purl.org/pav/hasCurrentVersion", "http://purl.org/dc/terms/hasVersion"].each do |prop|
+        objects = @graph.query([nil, RDF::URI(prop), nil]).objects
+        objects.each do |o|
+          uri = o.to_s
+          version = @data[uri]
+          next if not version
+          next if not version["http://www.w3.org/1999/02/22-rdf-syntax-ns#type"].include? "http://rdfs.org/ns/void#Dataset"
+          description = version["http://purl.org/dc/terms/description"]
+          if not description
+            qrev = version["http://www.w3.org/ns/prov#qualifiedRevision"]&.first
+            if description = @data[qrev]
+              description = @data[qrev]["http://www.w3.org/2000/01/rdf-schema#comment"]
+            end
+          end
+          subset = []
+          if version["http://rdfs.org/ns/void#subset"]
+            version["http://rdfs.org/ns/void#subset"].each do |s|
+              subset << @data[s]["http://rdfs.org/ns/void#dataDump"].first
+            end
+          end
+          date = version["http://purl.org/pav/createdOn"]&.first
+          date = version["http://purl.org/dc/terms/issued"]&.first if date.nil?
+          versions << {
+            uri: uri,
+            version: version["http://purl.org/pav/version"]&.first,
+            triples: version["http://rdfs.org/ns/void#triples"]&.first,
+            datadump: version["http://rdfs.org/ns/void#dataDump"]&.first,
+            bytesize: version["http://www.w3.org/ns/dcat#byteSize"]&.first,
+            date: date,
+            description: description,
+            subset: subset,
+          }
+        end
+      end
+      versions.sort_by{|v| [ v[:date], v[:uri] ] }
+    end
+    def extract_toplevel
+      result = {}
+      toplevel = @graph.query([nil, RDF::URI("http://purl.org/pav/hasCurrentVersion"), nil]).subjects.first
+      data  = @data[toplevel.to_s]
+      if toplevel
+        license = {}
+        if data["http://purl.org/dc/terms/license"]
+          license_data = @data[data["http://purl.org/dc/terms/license"].first]
+          license[:url] = license_data["http://www.w3.org/1999/02/22-rdf-syntax-ns#value"]&.first
+          license[:icon] = license_data["http://xmlns.com/foaf/0.1/thumbnail"]&.first
+          license[:label] = license_data["http://www.w3.org/2000/01/rdf-schema#label"]
+        end
+        result = {
+          uri: toplevel.to_s,
+          description: data["http://purl.org/dc/terms/description"],
+          license: license,
+        }
+      end
+      result
+    end
+
     def output_turtle_files
-      progressbar = ProgressBar.create(title: :output_turtle_files,
-        total: @data.size,
-        format: "(%t) %a %e %P% Processed: %c from %C")
-      each_data do |uri, v|
-        progressbar.increment
+      each_data(:output_turtle_files) do |uri, v|
         file = uri_mapping_to_path(uri, ".ttl")
         if @config[:output_dir]
           Dir.mkdir @config[:output_dir] if not File.exist? @config[:output_dir]
@@ -282,7 +343,6 @@ module TTL2HTML
           io.puts str.strip
         end
       end
-      progressbar.finish
     end
     def uri_mapping_to_path(uri, suffix = ".html")
       path = nil

data/locales/en.yml

@@ -3,11 +3,17 @@ en:
     title: "About %{title}"
     The properties for the textbook resources are as follows:
     shape-note: "The properties for the %{resource} resources are as follows:"
+    versions: Versions
+    version-release: "Version %{version} released."
+    version-triples: "%{triples} triples"
   default:
     details: Details
     inverse_data: Referred resources
   index:
     list: "List of %{resource}"
+    latest-news: "Latest news"
+    past-versions: "Past versions"
+    license-text: "This dataset is freely usable as <a href=\"%{url}\">%{label}</a>"
   layout:
     rdf-data: RDF data
   shape-table:

data/locales/ja.yml

@@ -2,11 +2,17 @@ ja:
   about:
     title: "%{title}について"
     shape-note: "%{resource}リソースが持つプロパティを下表に示します"
+    versions: 更新履歴
+    version-release: "バージョン%{version}を公開。"
+    version-triples: "%{triples}トリプル"
   default:
     details: 詳細情報
     inverse_data: 被参照情報
   index:
     list: "%{resource} 一覧"
+    latest-news: 最新のお知らせ
+    past-versions: 過去の更新履歴
+    license-text: "このデータセットは<a href=\"%{url}\">%{label}</a>として自由に利用できます。"
   layout:
     rdf-data: RDFデータ
   shape-table:

data/templates/about.html.erb

@@ -1,6 +1,9 @@
     <div class="jumbotron">
       <div class="container">
         <h1><%=h t("about.title", title: param[:site_title]) %></h1>
+        <%- if param[:toplevel] and param[:toplevel][:description] -%>
+        <p><%= get_language_literal(param[:toplevel][:description]) %></p>
+        <%- end -%>
       </div>
     </div>
     <div class="container">
@@ -10,18 +13,32 @@
             <ol class="breadcrumb">
               <li class="breadcrumb-item"><a href="./"><i class="bi bi-house-door-fill"></i> Home</a></li>
               <li class="breadcrumb-item active" aria-current="page"><%=h t("about.title", title: param[:site_title]) %></li>
-          </ol>
-        </nav>
+            </ol>
+          </nav>
+        </div>
       </div>
+      <%- if param[:shapes] -%>
       <div class="row">
         <div class="col-md">
-          <%- param[:content].keys.sort.each do |shape| -%>
-            <h3><%=h param[:content][shape][:label] %></h3>
-            <p><%= param[:content][shape][:comment] %></p>
-            <p><%=h t("about.shape-note", resource: param[:content][shape][:label]) %></p>
-            <%= param[:content][shape][:html] -%>
+          <%- param[:shapes].keys.sort.each do |shape| -%>
+            <h3><%=h param[:shapes][shape][:label] %></h3>
+            <p><%= param[:shapes][shape][:comment] %></p>
+            <p><%=h t("about.shape-note", resource: param[:shapes][shape][:label]) %></p>
+            <%= param[:shapes][shape][:html] -%>
           <%- end -%>
         </div>
       </div>
-    </div>
-    
+      <%- end -%>
+      <%- if param[:versions] -%>
+      <div class="row">
+        <div class="col-md">
+          <h2 id="versions"><%=h t("about.versions") %> <i class="bi bi-info-circle"></i></h2>
+          <dl>
+          <%- param[:versions].reverse_each do |version| -%>
+            <%= format_version_info(version) %>
+          <%- end -%>
+          </dl>
+        </div>
+      </div>
+      <%- end -%>
+    </div>

data/templates/index.html.erb

@@ -1,6 +1,9 @@
     <div class="jumbotron">
       <div class="container">
         <h1><%=h param[:site_title] %></h1>
+        <%- if param[:toplevel] and param[:toplevel][:description] -%>
+        <p><%= get_language_literal(param[:toplevel][:description]) %></p>
+        <%- end -%>
         <p><i class="bi bi-link-45deg"></i> <a href="<%=h param[:base_uri] %>"><%=h param[:base_uri] %></a></p>
       </div>
     </div>
@@ -9,10 +12,31 @@
         <div class="col-md-12">
           <h2><%=h t("index.list", resource: param[:class_label]) %></h2>
           <ul>
-            <% param[:index_data].each do |e| %>
+            <%- param[:index_data].each do |e| -%>
               <li><%= format_object(e, param[:data_global]) %></li>
-            <% end %>
+            <%- end -%>
           </ul>
         </div>
       </div>
-    </div>
+      <%- if param[:versions].size > 0 -%>
+      <div class="row">
+        <div class="col-md">
+          <h2 id="versions"><%=h t("index.latest-news") %> <i class="bi bi-info-circle"></i></h2>
+          <dl>
+            <%= format_version_info(param[:versions].last) %>
+          </dl>
+          <%- if param[:versions].size > 1 -%>
+          <p><a href="about#versions">&raquo; <%=h t("index.past-versions") %></a></p>
+          <%- end -%>
+          <%- if param[:toplevel] and param[:toplevel][:license] -%>
+          <p>
+            <%- if param[:toplevel][:license][:icon] -%>
+            <a href="<%=h param[:toplevel][:license][:url] %>"><img src="<%=h param[:toplevel][:license][:icon] %>"></a>
+            <%- end -%>
+            <%= t("index.license-text", label: get_language_literal(param[:toplevel][:license][:label]), url: param[:toplevel][:license][:url]) %>
+          </p>
+          <%- end -%>
+        </div>
+      </div>
+      <%- end -%>
+    </div>

data/templates/layout.html.erb

@@ -6,9 +6,9 @@
     <!-- The above 3 meta tags *must* come first in the head; any other head content must come *after* these tags -->
     <link rel="stylesheet" href="https://stackpath.bootstrapcdn.com/bootstrap/4.5.0/css/bootstrap.min.css" integrity="sha384-9aIt2nRpC12Uk9gS9baDl411NQApFmC26EwAOH8WgZl5MYYxFfc+NcPb1dKGj7Sk" crossorigin="anonymous">
     <link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/bootstrap-icons@1.7.1/font/bootstrap-icons.css">
-    <title><% if param[:title] %><%=h param[:title] %><% end %><% if param[:site_title] %> - <%=h param[:site_title] %><% end %></title>
+    <title><%=h html_title(param) %></title>
     <meta name="twitter:card" content="summary">
-    <meta name="twitter:title" content="<% if param[:title] %><%=h param[:title] %><% end %><% if param[:site_title] %> - <%=h param[:site_title] %><% end %>">
+    <meta name="twitter:title" content="<%=h html_title(param) %>">
   </head>
   <body>
     <nav class="navbar navbar-expand-lg navbar-dark bg-dark">

data/templates/version.html.erb

@@ -0,0 +1,28 @@
+        <dt><%=h param[:data][:date] %></dt>
+        <dd><%=h t("about.version-release", version: param[:data][:version]) %></dd>
+        <dd><%=h get_language_literal(param[:data][:description]) %></dd>
+        <%- if param[:data][:datadump] -%>
+        <dd><ul>
+          <li><a href="<%=h param[:data][:datadump] %>"><%=h File.basename(param[:data][:datadump]) %></a>
+          <%- 
+          fileinfo = []
+          if param[:data][:triples]
+            fileinfo << t("about.version-triples", triples: number_with_delimiter(param[:data][:triples].to_i))
+          end
+          if param[:data][:bytesize]
+            fileinfo << number_to_human_size(param[:data][:bytesize])
+          end
+          -%>
+          <%- if fileinfo.size > 0 -%>
+          (<%=h fileinfo.join(", ") %>)
+          <%- end -%>
+          <%- if param[:data][:subset].size > 0 -%>
+          <ul>
+            <%- param[:data][:subset].each do |subset| -%>
+            <li><a href="<%=h subset %>"><%=h File.basename(subset) %></a></li>
+            <%- end -%>
+          </ul>
+          </li>
+          <%- end -%>
+        </dd>
+        <%- end -%>

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ttl2html
 version: !ruby/object:Gem::Version
-  version: 1.3.1
+  version: 1.3.2
 platform: ruby
 authors:
 - Masao Takaku
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-12-04 00:00:00.000000000 Z
+date: 2021-12-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: nokogiri
@@ -80,6 +80,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: actionview
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -146,6 +160,7 @@ files:
 - templates/layout.html.erb
 - templates/shape-table.html.erb
 - templates/triples.html.erb
+- templates/version.html.erb
 homepage: https://github.com/masao/ttl2html
 licenses:
 - MIT
@@ -165,7 +180,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.3
+rubygems_version: 3.2.32
 signing_key:
 specification_version: 4
 summary: ttl2html