ttl2html 1.0.0 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: abc6dcc7ac8d23455d722dae7c9667f18ee48b7c7c797687922c5493037535d5
-  data.tar.gz: aa6d348addb6bfe3b95cc024da7d8dcb7639d532bbd337eac0b42321bc7687d9
+  metadata.gz: 2d481c51d33a3f278444c1029dc50602c11d2b4d3e494e78884d4feabada2059
+  data.tar.gz: c0402991e0ac87f10aa4afc09a89c53ab7aa1103cd4a6f8d7cd42601f3e7cec4
 SHA512:
-  metadata.gz: 733765aed31be6e74dc2f27acc18764385e09a08932f4d1413aa89369640a89426357f1c8395cef1746dfb24f85df41858b4b9a6ba2ed0768d6b401fa7c985a0
-  data.tar.gz: c44db48f508966a30b7953b0425c5f3d72ad1b07c69bb4f0ae5f22894486793f50c8504135a9b3bba812ce57bed5273025c898fb461389b497522c2ea5b843a7
+  metadata.gz: aecbba96f8160b240d653eca3d41e5e6370f39b5805e96d07cbaafae5345e411950de991d053db5a0fbf5bdee1293e474035991968af39f751361cb272013c48
+  data.tar.gz: 0d9992e7381665ef9b137473c46ac3a381674cc6d899ef2a4a16a18853437381eb78362cacef3b59850f29db5820242563c972842eb34cc5f4f5942f3f668120

data/lib/ttl2html/template.rb

@@ -3,16 +3,20 @@
 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
       @template_path = [ Dir.pwd, File.join(Dir.pwd, "templates") ]
       @template_path << File.join(File.dirname(__FILE__), "..", "..", "templates")
+      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 +96,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,
@@ -124,6 +128,13 @@ module TTL2HTML
       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 +151,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

data/lib/ttl2html/version.rb

@@ -1 +1 @@
-TTL2HTML::VERSION = "1.0.0"
+TTL2HTML::VERSION = "1.1.0"

data/lib/ttl2html.rb

@@ -110,6 +110,7 @@ module TTL2HTML
       @graph.query([nil, nil, object]).statements.sort_by do |e|
         [ e.subject, e.predicate, object ]
       end.map do |e|
+        next if e.subject.node?
         result << "<#{e.subject}> <#{e.predicate}> <#{object}>.\n"
       end
       result
@@ -122,6 +123,22 @@ module TTL2HTML
       end
     end
     def output_html_files
+      template = Template.new("")
+      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
       each_data do |uri, v|
         template = Template.new("default.html.erb", @config)
         param = @config.dup
@@ -130,26 +147,7 @@ module TTL2HTML
         param[:data_inverse] = @data_inverse[uri]
         param[:data_global] = @data
         param[:title] = template.get_title(v)
-        file = nil
-        if @config[:uri_mappings]
-          @config[:uri_mappings].each do |mapping|
-            local_file = uri.sub(@config[:base_uri], "")
-            if mapping["regexp"] =~ local_file
-              file = local_file.sub(mapping["regexp"], mapping["path"])
-            end
-          end
-        end
-        if file.nil?
-          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
-        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)
@@ -176,9 +174,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]
@@ -203,10 +198,26 @@ 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
       each_data do |uri, v|
-        file = uri.sub(@config[:base_uri], "")
-        file << ".ttl"
+        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)
@@ -218,21 +229,44 @@ module TTL2HTML
         end
       end
     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|
         uri.start_with? @config[:base_uri]
       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], "")
@@ -259,4 +293,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: 1.0.0
+  version: 1.1.0
 platform: ruby
 authors:
 - Masao Takaku
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-11-13 00:00:00.000000000 Z
+date: 2021-11-21 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