ttl2html 0.3.1 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8a4695d17d266cffe1bdc9b1b902c3cec45dcda2a6278a705d52a7d13b4fea50
-  data.tar.gz: bed7947d84c69ddc661c7d12da8c53aa6f63ec331430c18a9d2f5fdbbbdfe9ef
+  metadata.gz: b9d57dc99fea0827d317a9dc3597cae9c69d1ac38dbcd66000327f1b913dea03
+  data.tar.gz: d30441245cd56e6322fe3ab0b27351a83900b6c6826b3c5a6d611bffa8245d3e
 SHA512:
-  metadata.gz: 8c8b4b8b7c5497477b7ebcd4fd51e79a9d5e1db04c26b9382aecc3af71433eb3b720c0cc0c0cb78295a47634de6fb445ce422bef78a9f40f4b66f153df000993
-  data.tar.gz: 5516d4fc1c2a4f7ebb590bb67ee4a4fe11015548b9c0ea3cdd6b3eca4edeb2d7a3eba9c6265aec58ad26466d7df1f6c3d031e43904530be15ed3c0ad5f08ff24
+  metadata.gz: 6c5068b43cc54072f3958f46b5192c5fe118d5942c0b53d4f2fc35f8e35560a6768a2905d1cd946efc8462faa51b2d2ea4d844f8f73f982e18fb73ea5a812ee5
+  data.tar.gz: 6dc8f656583fc5d8a96baab454b1ea47e446e5694c55f457b3e236e91945595d8b2838d7a7b628d918d7a9c85bb138e081e8919453edce96228572a93dd617eb

data/lib/ttl2html/template.rb

@@ -3,16 +3,21 @@
 require "fileutils"
 require "pathname"
 require "erb"
+require "i18n"
 
 module TTL2HTML
   class Template
     attr_reader :param
     include ERB::Util
+    include I18n::Base
     def initialize(template, param = {})
       @template = template
-      @param = param
+      @param = param.dup
       @template_path = [ Dir.pwd, 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"]
+      I18n.locale = @param[:locale] if @param[:locale]
     end
     def output_to(file, param = {})
       @param.update(param)
@@ -92,9 +97,9 @@ module TTL2HTML
         {
           path: path,
           shorten_path: shorten_path,
-          name: data[property]["http://www.w3.org/ns/shacl#name"].first,
+          name: get_language_literal(data[property]["http://www.w3.org/ns/shacl#name"]),
           example: data[property]["http://www.w3.org/2004/02/skos/core#example"] ? data[property]["http://www.w3.org/2004/02/skos/core#example"].first : nil,
-          description: data[property]["http://www.w3.org/ns/shacl#description"] ? data[property]["http://www.w3.org/ns/shacl#description"].first : nil,
+          description: get_language_literal(data[property]["http://www.w3.org/ns/shacl#description"]),
           required: data[property]["http://www.w3.org/ns/shacl#minCount"] ? data[property]["http://www.w3.org/ns/shacl#minCount"].first.to_i > 0 : false,
           repeatable: repeatable,
           nodeKind: data[property]["http://www.w3.org/ns/shacl#nodeKind"] ? data[property]["http://www.w3.org/ns/shacl#nodeKind"].first : nil,
@@ -108,6 +113,33 @@ module TTL2HTML
     end
 
     # helper method:
+    def uri_mapping_to_path(uri, suffix = ".html")
+      path = nil
+      if @param[:uri_mappings]
+        @param[:uri_mappings].each do |mapping|
+          local_file = uri.sub(@param[:base_uri], "")
+          if mapping["regexp"] =~ local_file
+            path = local_file.sub(mapping["regexp"], mapping["path"])
+          end
+        end
+      end
+      if path.nil?
+        if suffix == ".html"
+          if @param[:data_global] and @param[:data_global].keys.find{|e| e.start_with?(uri + "/") }
+            path = uri + "/index"
+          elsif uri.end_with?("/")
+            path = uri + "index"
+          else
+            path = uri
+          end
+        else
+          path = uri
+        end
+      end
+      path = path.sub(@param[:base_uri], "") if @param[:base_uri]
+      path << suffix
+      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]
@@ -118,12 +150,20 @@ module TTL2HTML
     def relative_path_uri(dest_uri, base_uri)
       if dest_uri.start_with? base_uri
         dest = dest_uri.sub(base_uri, "")
+        dest = uri_mapping_to_path(dest, "")
         relative_path(dest)
       else
         dest_uri
       end
     end
     def get_title(data, default_title = "no title")
+      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]
+            return get_language_literal(data[property])
+          end
+        end
+      end
       if @param[:title_property] and data[@param[:title_property]]
         return get_language_literal(data[@param[:title_property]])
       end
@@ -140,7 +180,11 @@ module TTL2HTML
     end
     def get_language_literal(object)
       if object.respond_to? :has_key?
-        object.values.first
+        if object.has_key?(I18n.locale)
+          object[I18n.locale]
+        else
+          object.values.first
+        end
       elsif object.is_a? Array
         object.first
       else
@@ -157,7 +201,7 @@ module TTL2HTML
     def format_object(object, data)
       if object =~ /\Ahttps?:\/\//
         rel_path = relative_path_uri(object, param[:base_uri])
-        if data[object]
+        if param[:data_global][object]
           "<a href=\"#{rel_path}\">#{get_title(param[:data_global][object]) or object}</a>"
         else
           "<a href=\"#{rel_path}\">#{object}</a>"
@@ -169,7 +213,19 @@ module TTL2HTML
       end
     end
     def format_triples(triples)
-      param_local = @param.merge(data: triples)
+      param_local = @param.dup.merge(data: triples)
+      if @param[:labels_with_class] and triples["http://www.w3.org/1999/02/22-rdf-syntax-ns#type"]
+        @param[:labels_with_class].reverse_each do |k, v|
+          triples["http://www.w3.org/1999/02/22-rdf-syntax-ns#type"].each do |entity_class|
+            if entity_class == k
+              v.each do |property, label_value|
+                param_local[:labels] ||= {}
+                param_local[:labels][property] = label_value
+              end
+            end
+          end
+        end
+      end
       to_html_raw("triples.html.erb", param_local)
     end
   end

data/lib/ttl2html/version.rb

@@ -1 +1 @@
-TTL2HTML::VERSION = "0.3.1"
+TTL2HTML::VERSION = "1.2.0"

data/lib/ttl2html.rb

@@ -1,5 +1,6 @@
 #!/usr/bin/env ruby
 
+require "zlib"
 require "yaml"
 require "nokogiri"
 require "rdf/turtle"
@@ -9,9 +10,7 @@ require "ttl2html/template"
 
 module TTL2HTML
   class App
-    using ProgressBar::Refinements::Enumerator
     def initialize(config = "config.yml")
-      @template = {}
       @config = load_config(config)
       if not @config[:base_uri]
         raise "load_config: base_uri not found"
@@ -67,49 +66,41 @@ module TTL2HTML
     def format_turtle(subject, depth = 1)
       turtle = RDF::Turtle::Writer.new
       result = ""
-      if subject.iri?
-        result << "<#{subject}>\n#{"  "*depth}"
-      else
+      if subject =~ /^_:/
         result << "[\n#{"  "*depth}"
+      else
+        result << "<#{subject}>\n#{"  "*depth}"
       end
-      result << @graph.query([subject, nil, nil]).predicates.sort.map do |predicate|
+      result << @data[subject.to_s].keys.sort.map do |predicate|
         str = "<#{predicate}> "
-        str << @graph.query([subject, predicate, nil]).objects.sort_by do |object|
-          if object.resource? and not object.iri? # blank node:
-            @graph.query([object, nil, nil]).statements.sort_by{|e|
-              [ e.predicate, e.object ]
-            }.map{|e|
-              [ e.predicate, e.object ]
-            }
-          else
-            object
-          end
-        end.map do |object|
-          if object.resource? and not object.iri? # blank node:
+        str << @data[subject.to_s][predicate].sort.map do |object|
+          if object =~ /^_:/ # blank node:
             format_turtle(object, depth + 1)
+          elsif object =~ RDF::URI::IRI
+            turtle.format_uri(RDF::URI.new object)
+          elsif object.respond_to?(:first) and object.first.kind_of?(Symbol)
+            turtle.format_literal(RDF::Literal.new(object[1], language: object[0]))
           else
-            case object
-            when RDF::URI
-              turtle.format_uri(object)
-            else
-              turtle.format_literal(object)
-            end
+            turtle.format_literal(object)
           end
         end.join(", ")
         str
       end.join(";\n#{"  "*depth}")
-      result << " ." if subject.iri?
+      result << " ." if not subject =~ /^_:/
       result << "\n"
-      result << "#{"  "*(depth-1)}]" if not subject.iri?
+      result << "#{"  "*(depth-1)}]" if subject =~ /^_:/
       result
     end
     def format_turtle_inverse(object)
-      turtle = RDF::Turtle::Writer.new
       result = ""
-      @graph.query([nil, nil, object]).statements.sort_by do |e|
-        [ e.subject, e.predicate, object ]
-      end.map do |e|
-        result << "<#{e.subject}> <#{e.predicate}> <#{object}>.\n"
+      return result if not object.start_with? @config[:base_uri]
+      return result if not @data_inverse.has_key? object
+      turtle = RDF::Turtle::Writer.new
+      @data_inverse[object].keys.sort.each do |predicate|
+        @data_inverse[object.to_s][predicate].sort.each do |subject|
+          next if subject =~ /^_:/
+          result << "<#{subject}> <#{predicate}> <#{object}>.\n"
+        end
       end
       result
     end
@@ -121,7 +112,27 @@ module TTL2HTML
       end
     end
     def output_html_files
+      template = Template.new("", @config)
+      shapes = @graph.query([nil,
+                             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)
+      @config[:labels_with_class] ||= {}
+      labels.each do |klass, props|
+        props.each do |property, label|
+          @config[:labels_with_class][klass] ||= {}
+          if @config[:labels_with_class][klass][property]
+            next
+          else
+            @config[:labels_with_class][klass][property] = template.get_language_literal(label)
+          end
+        end
+      end
+      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
         template = Template.new("default.html.erb", @config)
         param = @config.dup
         param[:uri] = uri
@@ -129,21 +140,14 @@ module TTL2HTML
         param[:data_inverse] = @data_inverse[uri]
         param[:data_global] = @data
         param[:title] = template.get_title(v)
-        if @data.keys.find{|e| e.start_with?(uri + "/") }
-          file = uri + "/index.html"
-        elsif uri.end_with?("/")
-          file = uri + "index.html"
-        else
-          file = uri + ".html"
-        end
-        #p uri, param
-        file = file.sub(@config[:base_uri], "")
+        file = uri_mapping_to_path(uri, ".html")
         if @config[:output_dir]
           Dir.mkdir @config[:output_dir] if not File.exist? @config[:output_dir]
           file = File.join(@config[:output_dir], file)
         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
@@ -164,9 +168,6 @@ module TTL2HTML
           template.output_to(index_html, param)
         end
       end
-      shapes = @graph.query([nil,
-                             RDF::URI("http://www.w3.org/1999/02/22-rdf-syntax-ns#type"),
-                             RDF::URI("http://www.w3.org/ns/shacl#NodeShape")])
       if shapes.size > 0
         about_html = @config[:about_file] || "about.html"
         about_html =  File.join(@config[:output_dir], about_html) if @config[:output_dir]
@@ -191,20 +192,69 @@ module TTL2HTML
         template.output_to(about_html, param)
       end
     end
+
+    def shapes2labels(shapes)
+      labels = {}
+      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
+          end
+        end
+      end
+      labels
+    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|
-        file = uri.sub(@config[:base_uri], "")
-        file << ".ttl"
+        progressbar.increment
+        file = uri_mapping_to_path(uri, ".ttl")
         if @config[:output_dir]
           Dir.mkdir @config[:output_dir] if not File.exist? @config[:output_dir]
           file = File.join(@config[:output_dir], file)
         end
-        str = format_turtle(RDF::URI.new uri)
-        str << format_turtle_inverse(RDF::URI.new uri)
+        str = format_turtle(uri)
+        str << format_turtle_inverse(uri)
         open(file, "w") do |io|
           io.puts str.strip
         end
       end
+      progressbar.finish
+    end
+    def uri_mapping_to_path(uri, suffix = ".html")
+      path = nil
+      if @config[:uri_mappings]
+        @config[:uri_mappings].each do |mapping|
+          local_file = uri.sub(@config[:base_uri], "")
+          if mapping["regexp"] =~ local_file
+            path = local_file.sub(mapping["regexp"], mapping["path"])
+          end
+        end
+      end
+      if path.nil?
+        if suffix == ".html"
+          if @data.keys.find{|e| e.start_with?(uri + "/") }
+            path = uri + "/index"
+          elsif uri.end_with?("/")
+            path = uri + "index"
+          else
+            path = uri
+          end
+        else
+          path = uri
+        end
+      end
+      path = path.sub(@config[:base_uri], "")
+      path << suffix
+      #p [uri, path]
+      path
     end
     def cleanup
       @data.select do |uri, v|
@@ -212,15 +262,10 @@ module TTL2HTML
       end.sort_by do |uri, v|
         -(uri.size)
       end.each do |uri, v|
-        if @data.keys.find{|e| e.start_with?(uri + "/") }
-          file = uri + "/index.html"
-        else
-          file = uri + ".html"
-        end
-        html_file = file.sub(@config[:base_uri], "")
+        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
-        ttl_file = uri.sub(@config[:base_uri], "") + ".ttl"
+        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
         dir = uri.sub(@config[:base_uri], "")
@@ -247,4 +292,4 @@ module TTL2HTML
       file
     end
   end
-end
+end

data/locales/en.yml

@@ -0,0 +1,26 @@
+en:
+  about:
+    title: "About %{title}"
+    The properties for the textbook resources are as follows:
+    shape-note: "The properties for the %{resource} resources are as follows:"
+  default:
+    details: Details
+    inverse_data: Referred resources
+  index:
+    list: "List of %{resource}"
+  layout:
+    rdf-data: RDF data
+  shape-table:
+    header:
+      property-name: "Property name"
+      description: "Description"
+      example: "Example of the property value(s)"
+      required: "Required?"
+      repeatable: "Repeatable?"
+      note: "Notes"
+    required: "Required"
+    repeatable: "Repeatable"
+    optional: "Optional"
+    non-repeatable: "Non repeatable"
+    blank-node-structure: "The structural contents of a blank node are as follows:"
+    blank-node-or-structure: "The structural contents of a blank node are either of the followings:"

data/locales/ja.yml

@@ -0,0 +1,25 @@
+ja:
+  about:
+    title: "%{title}について"
+    shape-note: "%{resource}リソースが持つプロパティを下表に示します"
+  default:
+    details: 詳細情報
+    inverse_data: 被参照情報
+  index:
+    list: "%{resource} 一覧"
+  layout:
+    rdf-data: RDFデータ
+  shape-table:
+    header:
+      property-name: プロパティ名
+      description: 説明
+      example: プロパティ値の例
+      required: 必須・省略の別
+      repeatable: 繰り返しの有無
+      note: 備考
+    required: 必須
+    repeatable: 繰り返し有り
+    optional: 省略可能
+    non-repeatable: 繰り返し無し
+    blank-node-structure: ブランクノードの内容は以下の内容からなる構造を持ちます。
+    blank-node-or-structure: ブランクノードの内容は以下のいずれかの内容からなる構造を持ちます。

data/templates/about.html.erb

@@ -1,6 +1,6 @@
     <div class="jumbotron">
       <div class="container">
-        <h1><%=h param[:site_title] %>について</h1>
+        <h1><%=h t("about.title", title: param[:site_title]) %></h1>
       </div>
     </div>
     <div class="container">
@@ -8,7 +8,7 @@
         <div class="col-md-12">
           <ol class="breadcrumb">
             <li><a href="./"><span class="glyphicon glyphicon-home" aria-hidden="true"></span> Home</a></li>
-            <li class="active"><%=h param[:site_title] %>について</li>
+            <li class="active"><%=h t("about.title", title: param[:site_title]) %></li>
           </ol>
         </div>
       </div>
@@ -16,8 +16,9 @@
       <div class="row">
         <div class="col-md-10">
           <%- param[:content].keys.sort.each do |shape| -%>
-            <h3><%=h param[:content][shape][:label] %>をあらわすリソース</h3>
-            <p><%=h param[:content][shape][:label] %>リソースが持つプロパティを下表に示します</p>
+            <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] -%>
           <%- end -%>
         </div>

data/templates/default.html.erb

@@ -7,14 +7,14 @@
     <div class="container">
       <div class="row">
         <div class="col-md-12">
-          <h2>詳細情報</h2>
+          <h2><%=h t("default.details") %></h2>
           <%= format_triples(param[:data]) %>
         </div>
       </div>
       <% if param[:data_inverse] %>
       <div class="row inverse">
         <div class="col-md-12">
-          <h2>被参照情報</h2>
+          <h2><%=h t("default.inverse_data") %></h2>
           <%= format_triples(param[:data_inverse]) %>
         </div>
       </div>

data/templates/index.html.erb

@@ -7,7 +7,7 @@
     <div class="container">
       <div class="row">
         <div class="col-md-12">
-          <h2><%=h param[:class_label] %> 一覧</h2>
+          <h2><%=h t("index.list", resource: param[:class_label]) %></h2>
           <ul>
             <% param[:index_data].each do |e| %>
               <li><%= format_object(e, param[:data_global]) %></li>

data/templates/layout.html.erb

@@ -22,7 +22,7 @@
     <hr>
     <footer>
       <%- if param[:uri] -%>
-      <p class="pull-right"><a href="<%=h param[:uri] %>.ttl"><img src="https://www.w3.org/RDF/icons/rdf_flyer.24" alt="RDFデータ"></a></p>
+      <p class="pull-right"><a href="<%=h param[:uri] %>.ttl"><img src="https://www.w3.org/RDF/icons/rdf_flyer.24" alt="<%=h t("layout.rdf-data") %>"></a></p>
       <%- end -%>
     </footer>
 

data/templates/shape-table.html.erb

@@ -1,6 +1,11 @@
 <table class="table table-condensed">
   <tr>
-    <th>プロパティ名</th><th>説明</th><th>プロパティ値の例</th><th>必須・省略の別<br>繰り返しの有無</th><th>備考</th>
+    <th><%=h t('shape-table.header.property-name') %></th>
+    <th><%=h t('shape-table.header.description') %></th>
+    <th><%=h t('shape-table.header.example') %></th>
+    <th><%=h t('shape-table.header.required') %><br>
+        <%=h t('shape-table.header.repeatable') %></th>
+    <th><%=h t('shape-table.header.note') %></th>
   </tr>
   <tbody>
   <%- param[:properties].each do |property| -%>
@@ -10,7 +15,7 @@
       <%- else -%>
       <td><code><%=h property[:shorten_path] %></code></td>
       <%- end -%>
-      <td><%= property[:name_ja] %></td>
+      <td><%= property[:name] %></td>
       <%- if property[:nodeKind] == "http://www.w3.org/ns/shacl#IRI" -%>
       <td class="url"><%= property[:example] %></td>
       <%- else -%>
@@ -19,31 +24,31 @@
       <td>
         <div>
         <%- if property[:required] -%>
-          <strong>必須</strong>
+          <strong><%=h t('shape-table.required') %></strong>
         <%- else -%>
-          省略可能
+        <%=h t('shape-table.optional') %>
         <%- end -%>
         </div>
         <div>
         <%- if property[:repeatable] -%>
-          繰り返し有り
+        <%=h t('shape-table.repeatable') %>
         <%- else -%>
-          繰り返し無し
+        <%=h t('shape-table.non-repeatable') %>
         <%- end -%>
         </div>
       </td>
-      <td><%= property[:description_ja] %></td>
+      <td><%= property[:description] %></td>
     </tr>
     <%- if property[:nodeKind] == "http://www.w3.org/ns/shacl#BlankNode" -%>
     <tr>
       <td colspan="4">
         <%- if property[:node_mode] == :or -%>
-        ブランクノードの内容は以下のいずれかの内容からなる構造を持ちます。
+        <%=h t("shape-table.blank-node-or-structure") %>
         <%- property[:nodes].each do |e| -%>
           <div class="blank_node"><%= e.sub(/class="table"/, 'class="table table-condensed"') %></div>
         <%- end -%>
         <%- else -%>
-        ブランクノードの内容は以下の構造を持ちます。
+        <%=h t("shape-table.blank-node-structure") %>
         <div class="blank_node"><%= property[:nodes].sub(/class="table"/, 'class="table table-condensed"') %></div>
         <%- end -%>
       </td>

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ttl2html
 version: !ruby/object:Gem::Version
-  version: 0.3.1
+  version: 1.2.0
 platform: ruby
 authors:
 - Masao Takaku
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-10-23 00:00:00.000000000 Z
+date: 2021-11-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: nokogiri
@@ -52,6 +52,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: i18n
+  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: ruby-progressbar
   requirement: !ruby/object:Gem::Requirement
@@ -124,6 +138,8 @@ files:
 - lib/ttl2html/template.rb
 - lib/ttl2html/version.rb
 - lib/xlsx2shape.rb
+- locales/en.yml
+- locales/ja.yml
 - templates/about.html.erb
 - templates/default.html.erb
 - templates/index.html.erb