ttl2html 1.3.2 → 1.3.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 536529ac6440329179bab71d30e570dc92efb464526f5a0a019c59823f67098c
-  data.tar.gz: 4f251ed59bc227e77f80fe3ea88ea1e14e99c10ece1bb7b156d0b19f98518663
+  metadata.gz: 64841e5acabefa8d0ff72ab9a5b342d2cb8c6a5f3ecbcce5d70d9c223ae6f694
+  data.tar.gz: 4c17bd90212017eccb86e6b96d3d2d1fe87c13841f5a0003a8f19d3e011aa1c0
 SHA512:
-  metadata.gz: 7e760bdb6848470e2e2327803e7f527684fa8e703f053cd0fda5eadc374bcaa7aeb837064f018a353f2e7c80b4845994db26106c8b139cdde9bf4e6c501f1254
-  data.tar.gz: 7cb13bd5ae523ef8ac62c843f27f1ce5f65efd70e035c35f35b6062e104b5c89e87d19c8ac4e7778ca0ce6b9881e1bbca92c5c34cda37793cc96add9679d66ff
+  metadata.gz: dd727e999f72c76af779008495bb858eb27bbf05f4e79b8ac9aeee0c61e3b225f8d5710209dcc29538fa7133c0c4da93573e864b2144447840b36ddb22306b36
+  data.tar.gz: 24fd2e31ebd3df0eb3ee62c62005356f6c66ab7b43697a7e1d82206314d1c038038bc44f145035f7aae87506878f19e458c265a1ebcb2a6fe9b389e70f40ce66

data/bin/ttl2html

@@ -37,6 +37,5 @@ end
 if opt_cleanup
   ttl2html.cleanup
 else
-  ttl2html.output_html_files
-  ttl2html.output_turtle_files
+  ttl2html.output_files
 end

data/lib/ttl2html/template.rb

@@ -15,7 +15,7 @@ module TTL2HTML
     def initialize(template, param = {})
       @template = template
       @param = param.dup
-      @template_path = [ Dir.pwd, File.join(Dir.pwd, "templates") ]
+      @template_path = [ File.join(Dir.pwd, "templates") ]
       @template_path << File.join(File.dirname(__FILE__), "..", "..", "templates")
       I18n.load_path << Dir[File.join(File.dirname(__FILE__), "..", "..", "locales") + "/*.yml"]
       I18n.load_path << Dir[File.expand_path("locales") + "/*.yml"]
@@ -39,7 +39,7 @@ module TTL2HTML
       @param.update(param)
       template = find_template_path(template)
       tmpl = open(template){|io| io.read }
-      erb = ERB.new(tmpl, nil, "-")
+      erb = ERB.new(tmpl, trim_mode: "-")
       erb.filename = template
       erb.result(binding)
     end
@@ -143,10 +143,16 @@ module TTL2HTML
       path
     end
     def relative_path(dest)
-      src = @param[:output_file]
-      src = Pathname.new(src).relative_path_from(Pathname.new(@param[:output_dir])) if @param[:output_dir]
-      path = Pathname(dest).relative_path_from(Pathname(File.dirname src))
-      path = path.to_s + "/" if File.directory? path
+      path = nil
+      dest_uri = RDF::IRI.parse(dest)
+      if dest_uri.absolute?
+        path = dest
+      else
+        src = @param[:output_file]
+        src = Pathname.new(src).relative_path_from(Pathname.new(@param[:output_dir])) if @param[:output_dir]
+        path = Pathname(dest).relative_path_from(Pathname(File.dirname src))
+        path = path.to_s + "/" if File.directory? path
+      end
       path
     end
     def relative_path_uri(dest_uri, base_uri)
@@ -160,8 +166,12 @@ module TTL2HTML
     end
     def html_title(param)
       titles = []
-      titles << param[:title]
-      titles << param[:site_title]
+      if @template.start_with? "about.html"
+        titles << t("about.title", title: param[:site_title])
+      else
+        titles << param[:title]
+        titles << param[:site_title]
+      end
       titles.compact.join(" - ")
     end
     def shorten_title(title, length = 140)
@@ -172,6 +182,7 @@ module TTL2HTML
       end
     end
     def get_title(data, default_title = "no title")
+      return default_title if data.nil?
       if @param[:title_property_perclass] and data["http://www.w3.org/1999/02/22-rdf-syntax-ns#type"]
         @param[:title_property_perclass].each do |klass, property|
           if data["http://www.w3.org/1999/02/22-rdf-syntax-ns#type"].include?(klass) and data[property]

data/lib/ttl2html/version.rb

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

data/lib/ttl2html.rb

@@ -22,9 +22,11 @@ module TTL2HTML
     end
 
     def load_config(file)
-      config = {}
-      YAML.load_file(file).each do |k, v|
-        config[k.intern] = v
+      config = { output_turtle: true }
+      open(file) do |io|
+        YAML.safe_load(io, permitted_classes: [Regexp]).each do |k, v|
+          config[k.intern] = v
+        end
       end
       config
     end
@@ -140,7 +142,7 @@ module TTL2HTML
         template = Template.new("default.html.erb", @config)
         param = @config.dup
         param[:uri] = uri
-        param[:turtle_uri] = uri_mapping_to_path(uri, ".ttl")
+        param[:turtle_uri] = uri + ".ttl"
         param[:data] = v
         param[:data_inverse] = @data_inverse[uri]
         param[:data_global] = @data
@@ -167,6 +169,7 @@ module TTL2HTML
         else
           template = Template.new("index.html.erb", @config)
           param = @config.dup
+          param[:class_label] = template.get_title(@data[@config[:top_class]], nil)
           param[:data_global] = @data
           param[:versions] = versions
           param[:toplevel] = toplevel
@@ -177,11 +180,12 @@ module TTL2HTML
           template.output_to(index_html, param)
         end
       end
-      if shapes.size > 0 or versions.size > 0 or toplevel.size > 0
+      if template.find_template_path("about.html") or 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[:content] = template.to_html_raw("about.html", {}) if template.find_template_path("about.html")
         param[:data_global] = @data
         param[:versions] = versions
         param[:toplevel] = toplevel
@@ -204,6 +208,7 @@ module TTL2HTML
             label: label,
             comment: comment,
             html: template.expand_shape(@data, subject.to_s, @prefix),
+            target_class: target_class,
           }
         end
         template.output_to(about_html, param)
@@ -240,33 +245,37 @@ module TTL2HTML
       results
     end
 
-    def shapes2labels(shapes)
-      labels = {}
+    def shapes_parse(shapes)
       shapes.subjects.each do |shape|
         target_class = @data[shape.to_s]["http://www.w3.org/ns/shacl#targetClass"]&.first
         if target_class
-          @data[shape.to_s]["http://www.w3.org/ns/shacl#property"].each do |property|
-            path = @data[property]["http://www.w3.org/ns/shacl#path"].first
-            name = @data[property]["http://www.w3.org/ns/shacl#name"]
-            labels[target_class] ||= {}
-            labels[target_class][path] = name
+          properties = @data[shape.to_s]["http://www.w3.org/ns/shacl#property"]
+          if properties
+            properties.each do |property|
+              path = @data[property]["http://www.w3.org/ns/shacl#path"].first
+              yield target_class, property
+            end
           end
         end
       end
+    end
+    def shapes2labels(shapes)
+      labels = {}
+      shapes_parse(shapes) do |target_class, property|
+        path = @data[property]["http://www.w3.org/ns/shacl#path"].first
+        name = @data[property]["http://www.w3.org/ns/shacl#name"]
+        labels[target_class] ||= {}
+        labels[target_class][path] = name
+      end
       labels
     end
     def shapes2orders(shapes)
       orders = {}
-      shapes.subjects.each do |shape|
-        target_class = @data[shape.to_s]["http://www.w3.org/ns/shacl#targetClass"]&.first
-        if target_class
-          @data[shape.to_s]["http://www.w3.org/ns/shacl#property"].each do |property|
-            path = @data[property]["http://www.w3.org/ns/shacl#path"].first
-            order = @data[property]["http://www.w3.org/ns/shacl#order"]
-            orders[target_class] ||= {}
-            orders[target_class][path] = order&.first&.to_i
-          end
-        end
+      shapes_parse(shapes) do |target_class, property|
+        path = @data[property]["http://www.w3.org/ns/shacl#path"].first
+        order = @data[property]["http://www.w3.org/ns/shacl#order"]
+        orders[target_class] ||= {}
+        orders[target_class][path] = order&.first&.to_i
       end
       orders
     end
@@ -281,10 +290,12 @@ module TTL2HTML
           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"]
+          link = nil
           if not description
             qrev = version["http://www.w3.org/ns/prov#qualifiedRevision"]&.first
-            if description = @data[qrev]
+            if @data[qrev]
               description = @data[qrev]["http://www.w3.org/2000/01/rdf-schema#comment"]
+              link = @data[qrev]["http://www.w3.org/2000/01/rdf-schema#seeAlso"]&.first
             end
           end
           subset = []
@@ -304,6 +315,7 @@ module TTL2HTML
             date: date,
             description: description,
             subset: subset,
+            link: link,
           }
         end
       end
@@ -321,10 +333,29 @@ module TTL2HTML
           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
+        if data["http://purl.org/dc/terms/publisher"]
+          publisher_data = @data[data["http://purl.org/dc/terms/publisher"].first]
+          email = publisher_data["http://xmlns.com/foaf/0.1/mbox"]&.first
+          contact = { email: email }
+          name = publisher_data["http://xmlns.com/foaf/0.1/name"]
+          contact[:name] = name if name
+          members = []
+          if publisher_data["http://xmlns.com/foaf/0.1/member"]
+            publisher_data["http://xmlns.com/foaf/0.1/member"].each do |member|
+              member_data = @data[member]
+              members << {
+                name: member_data["http://xmlns.com/foaf/0.1/name"],
+                org: member_data["http://www.w3.org/2006/vcard/ns#organization-name"]
+              }
+            end
+            contact[:members] = members
+          end
+        end
         result = {
           uri: toplevel.to_s,
           description: data["http://purl.org/dc/terms/description"],
           license: license,
+          contact: contact,
         }
       end
       result
@@ -337,13 +368,21 @@ module TTL2HTML
           Dir.mkdir @config[:output_dir] if not File.exist? @config[:output_dir]
           file = File.join(@config[:output_dir], file)
         end
-        str = format_turtle(uri)
+        dir = File.dirname(file)
+        FileUtils.mkdir_p(dir) if not File.exist?(dir)
+          str = format_turtle(uri)
         str << format_turtle_inverse(uri)
         open(file, "w") do |io|
           io.puts str.strip
         end
       end
     end
+
+    def output_files
+      output_html_files
+      output_turtle_files if @config[:output_turtle]
+    end
+
     def uri_mapping_to_path(uri, suffix = ".html")
       path = nil
       if @config[:uri_mappings]
@@ -380,10 +419,10 @@ module TTL2HTML
       end.each do |uri, v|
         html_file = uri_mapping_to_path(uri, ".html")
         html_file = File.join(@config[:output_dir], html_file) if @config[:output_dir]
-        File.unlink html_file
+        File.unlink html_file if File.exist? html_file
         ttl_file = uri_mapping_to_path(uri, ".ttl")
         ttl_file = File.join(@config[:output_dir], ttl_file) if @config[:output_dir]
-        File.unlink ttl_file
+        File.unlink ttl_file if File.exist? ttl_file
         dir = uri.sub(@config[:base_uri], "")
         dir = File.join(@config[:output_dir], dir) if @config[:output_dir]
         Dir.rmdir dir if File.exist? dir

data/locales/en.yml

@@ -1,11 +1,16 @@
 en:
   about:
     title: "About %{title}"
-    The properties for the textbook resources are as follows:
+    shape-heading: "Resources description"
     shape-note: "The properties for the %{resource} resources are as follows:"
+    shape-target: Target class
     versions: Versions
     version-release: "Version %{version} released."
     version-triples: "%{triples} triples"
+    version-link: "Please refer to <a href=\"%{link}\">here</a> for the revision details."
+    contact: Contact
+    contact-contribution: "This dataset was developed by %{name}"
+    contact-email: "For dataset inquiries, please contact at <a href=\"%{email}\">%{email}</a>"
   default:
     details: Details
     inverse_data: Referred resources

data/locales/ja.yml

@@ -1,10 +1,16 @@
 ja:
   about:
     title: "%{title}について"
+    shape-heading: "各リソースの説明"
     shape-note: "%{resource}リソースが持つプロパティを下表に示します"
+    shape-target: 対象クラス
     versions: 更新履歴
     version-release: "バージョン%{version}を公開。"
     version-triples: "%{triples}トリプル"
+    version-link: "更新の詳細については<a href=\"%{link}\">こちら</a>をご覧ください。"
+    contact: 連絡先
+    contact-contribution: "本データセットは %{name} が開発したものです"
+    contact-email: "データセットに関する問い合わせは <a href=\"%{email}\">%{email}</a> までお問い合わせください。"
   default:
     details: 詳細情報
     inverse_data: 被参照情報

data/templates/about.html.erb

@@ -17,11 +17,22 @@
           </nav>
         </div>
       </div>
-      <%- if param[:shapes] -%>
+      <%- if param[:content] -%>
       <div class="row">
         <div class="col-md">
+        <%= param[:content] %>
+        </div>
+      </div>
+      <%- end -%>
+      <%- if param[:shapes].size > 0 -%>
+      <div class="row">
+        <div class="col-md">
+          <h2 id="shapes"><%=h t("about.shape-heading") %></h2>
           <%- param[:shapes].keys.sort.each do |shape| -%>
             <h3><%=h param[:shapes][shape][:label] %></h3>
+            <%- if param[:shapes][shape][:target_class] -%>
+            <ul><li><%= t("about.shape-target") %>: <a href="<%=h param[:shapes][shape][:target_class] %>"><%=h param[:shapes][shape][:target_class] %></a></li></ul>
+            <%- end -%>
             <p><%= param[:shapes][shape][:comment] %></p>
             <p><%=h t("about.shape-note", resource: param[:shapes][shape][:label]) %></p>
             <%= param[:shapes][shape][:html] -%>
@@ -29,7 +40,7 @@
         </div>
       </div>
       <%- end -%>
-      <%- if param[:versions] -%>
+      <%- if param[:versions].size > 0 -%>
       <div class="row">
         <div class="col-md">
           <h2 id="versions"><%=h t("about.versions") %> <i class="bi bi-info-circle"></i></h2>
@@ -41,4 +52,27 @@
         </div>
       </div>
       <%- end -%>
+      <%- if param[:toplevel] and param[:toplevel][:contact] -%>
+      <div class="row">
+        <div class="col-md">
+          <h2 id="contact"><%=h t("about.contact") %></h2>
+          <%- if param[:toplevel][:contact][:name] -%>
+          <p><%=h t("about.contact-contribution", name: get_language_literal(param[:toplevel][:contact][:name])) %></p>
+          <%- end -%>
+          <%- if param[:toplevel][:contact][:members] -%>
+          <ul>
+          <%- param[:toplevel][:contact][:members].each do |member| -%>
+            <li><%=h get_language_literal(member[:name]) %>
+            <%- if member[:org] -%>
+            (<%=h get_language_literal(member[:org]) %>)
+            <%- end -%>
+          <%- end -%>
+          </ul>
+          <%- end -%>
+          <%- if param[:toplevel][:contact][:email] -%>
+          <p><%= t("about.contact-email", email: param[:toplevel][:contact][:email]) %></p>
+          <%- end -%>
+        </div>
+      </div>
+      <%- end -%>
     </div>

data/templates/layout.html.erb

@@ -3,34 +3,72 @@
   <head>
     <meta charset="utf-8">
     <meta name="viewport" content="width=device-width, initial-scale=1, shrink-to-fit=no">
-    <!-- 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">
+    <%- if param[:css_file] -%>
+    <link rel="stylesheet" href="<%=h relative_path(param[:css_file]) %>">
+    <%- end -%>
+    <%- if param[:custom_css] -%>
+    <style type="text/css"><%=h param[:custom_css] %></style>
+    <%- end -%>
     <title><%=h html_title(param) %></title>
     <meta name="twitter:card" content="summary">
     <meta name="twitter:title" content="<%=h html_title(param) %>">
+    <meta property="og:title" content="<%=h html_title(param) %>">
+    <meta property="og:type" content="website">
+    <%- if param[:uri] -%>
+    <meta property="og:url" content="<%=h param[:uri] %>">
+    <%- end -%>
+    <%- if param[:logo] -%>
+    <meta property="og:image" content="<%=h URI.parse(param[:base_uri]) + param[:logo] %>">
+    <%- end -%>
+    <%- if param[:google_analytics] -%>
+    <script async src="https://www.googletagmanager.com/gtag/js?id=<%=h param[:google_analytics] %>"></script>
+    <script>
+      window.dataLayer = window.dataLayer || [];
+      function gtag(){dataLayer.push(arguments);}
+      gtag('js', new Date());
+      gtag('config', '<%=u param[:google_analytics] %>');
+    </script>
+    <%- end -%>
   </head>
   <body>
-    <nav class="navbar navbar-expand-lg navbar-dark bg-dark">
+    <nav class="navbar navbar-expand-lg navbar-light">
+      <%- if param[:logo] -%>
+      <a class="navbar-brand" href="<%=h relative_path_uri(param[:base_uri], param[:base_uri]) %>"><img src="<%=h relative_path(param[:logo]) %>" height="30"></a>
+      <%- end -%>
       <button class="navbar-toggler" type="button" data-toggle="collapse" data-target="#navbarSupportedContent" aria-controls="navbarSupportedContent" aria-expanded="false" aria-label="Toggle navigation">
         <span class="navbar-toggler-icon"></span>
       </button>
       <div class="collapse navbar-collapse" id="navbarSupportedContent">
         <ul class="navbar-nav mr-auto">
-          <li class="nav-item<%= ' class="active"' if param[:active] == :home %>">
-            <a class="navbar-brand" href="/">Home</a>
+          <li class="nav-item<%= ' active' if @template == "index.html.erb" %>">
+            <a class="nav-link" href="<%=h relative_path_uri(param[:base_uri], param[:base_uri]) %>">Home</a>
           </li>
-          <li class="nav-item<%= ' class="active"' if param[:active] == :about %>">
-            <a class="navbar-brand" href="/about">About</a>
+          <li class="nav-item<%= ' active' if @template == "about.html.erb" %>">
+            <a class="nav-link" href="<%=h relative_path(param[:about_file] || "about.html") %>">About</a>
           </li>
+          <%- if param[:additional_link] -%>
+            <%- param[:additional_link].each do |link| -%>
+            <li class="nav-item"><a class="nav-link" href="<%=h link["href"] %>"><%=h link["label"] %></a></li>
+            <%- end -%>
+          <%- end -%>
         </ul>
       </div>
     </nav>
     <%= param[:content] %>
     <hr>
     <footer>
-      <%- if param[:uri] -%>
-      <p class="text-right"><a href="<%=h relative_path(param[:turtle_uri]) %>"><img src="https://www.w3.org/RDF/icons/rdf_flyer.24" alt="<%=h t("layout.rdf-data") %>"></a></p>
+      <%- if param[:turtle_uri] -%>
+        <p class="float-right"><a href="<%=h param[:turtle_uri] %>"><img src="https://www.w3.org/RDF/icons/rdf_flyer.24" alt="<%=h t("layout.rdf-data") %>"></a></p>
+      <%- end -%>
+      <%- if param[:admin_name] -%>
+      <p>
+        <%- if param[:copyright_year] -%>
+        &copy; <%=h param[:copyright_year] %>
+        <%- end -%>
+        <%=h param[:admin_name] %>
+      </p>
       <%- end -%>
     </footer>
 

data/templates/version.html.erb

@@ -1,6 +1,10 @@
         <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>
+        <dd><%=h get_language_literal(param[:data][:description]) %>
+        <%- if param[:data][:link] -%>
+        <%= t("about.version-link", link: param[:data][:link]) %>
+        <%- end -%>
+        </dd>
         <%- if param[:data][:datadump] -%>
         <dd><ul>
           <li><a href="<%=h param[:data][:datadump] %>"><%=h File.basename(param[:data][:datadump]) %></a>

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ttl2html
 version: !ruby/object:Gem::Version
-  version: 1.3.2
+  version: 1.3.5
 platform: ruby
 authors:
 - Masao Takaku
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-12-14 00:00:00.000000000 Z
+date: 2022-07-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: nokogiri
@@ -180,7 +180,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.32
+rubygems_version: 3.3.3
 signing_key:
 specification_version: 4
 summary: ttl2html