ttl2html 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3285a319273819d00281486dadbdea6c82c162856157075db553e18b659b16cc
-  data.tar.gz: 2f66f22a4ad30bd4dc6e0e9a44f24be37cf2e5c11396f4a2c85414becb1dbe6a
+  metadata.gz: fbbc4da0cfa20d2803025a5273b8399a1376af7e6e2a181cad79eaba19e7da9f
+  data.tar.gz: 6962165c275071e94c34152e6474777f94f46f196fb1b04804b3ea17d6a0c8c5
 SHA512:
-  metadata.gz: 4301d623df7599b6344806d66c97c71efb0633f45f663be45a460d5ceb23c1fe452d4ed2b01b2df4f02109d4168b8a31acb2dccb21a7f4e4234926cc59e4f4f5
-  data.tar.gz: 930b188d2f0d89601ba6af9199fd0ce87d40b3a00bd8a6711c14a82cb7dc52dae90d871772cd4e39dd4680ef8894e4c9245651e2a158c33f690f887a267f597a
+  metadata.gz: 2129bdefbb7b498a06301479638c96d1d35a67a8812a28202d0fc3eae1a706e393433b684f0e629c7cc0a2a7ba8e05d3cf5caa1a51e10731a9b0145c009af7b1
+  data.tar.gz: 5e5e04ce0c0f2e1e8434cba7ac54a146eb23fb00ab39e007f4c78146f78cd1ddda4bdd89ae7d168ddb831c935b4ff3bde306e9f274c0477b67e9e7b1c49b0d3c

data/lib/ttl2html/template.rb

@@ -48,7 +48,65 @@ module TTL2HTML
       end
       return nil
     end
-  
+
+    def expand_shape(data, uri, prefixes = {})
+      return nil if not data[uri]
+      return nil if not data[uri]["http://www.w3.org/ns/shacl#property"]
+      result = data[uri]["http://www.w3.org/ns/shacl#property"].sort_by do |e|
+        e["http://www.w3.org/ns/shacl#order"]
+      end.map do |property|
+        path = data[property]["http://www.w3.org/ns/shacl#path"].first
+        shorten_path = path.dup
+        prefixes.each do |prefix, val|
+          if path.index(val) == 0
+            shorten_path = path.sub(/\A#{val}/, "#{prefix}:")
+          end
+        end
+        repeatable = false
+        if data[property]["http://www.w3.org/ns/shacl#maxCount"]
+          max_count = data[property]["http://www.w3.org/ns/shacl#maxCount"].first.to_i
+          if max_count > 1
+            repeatable = true
+          end
+        else
+          repeatable = true
+        end
+        nodes = nil
+        if data[property]["http://www.w3.org/ns/shacl#node"]
+          node = data[property]["http://www.w3.org/ns/shacl#node"].first
+          if data[node]["http://www.w3.org/ns/shacl#or"]
+            node_or = data[data[node]["http://www.w3.org/ns/shacl#or"].first]
+            node_mode = :or
+            nodes = []
+            nodes << expand_shape(data, node_or["http://www.w3.org/1999/02/22-rdf-syntax-ns#first"].first, prefixes)
+            rest = node_or["http://www.w3.org/1999/02/22-rdf-syntax-ns#rest"].first
+            while data[rest] do
+              nodes << expand_shape(data, data[rest]["http://www.w3.org/1999/02/22-rdf-syntax-ns#first"].first, prefixes)
+              rest = data[rest]["http://www.w3.org/1999/02/22-rdf-syntax-ns#rest"].first
+            end
+          else
+            nodes = expand_shape(data, node, prefixes)
+          end
+          #p nodes
+        end
+        {
+          path: path,
+          shorten_path: shorten_path,
+          name: data[property]["http://www.w3.org/ns/shacl#name"].first,
+          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,
+          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,
+          nodes: nodes,
+          node_mode: node_mode,
+        }
+      end
+      template = "shape-table.html.erb"
+      tmpl = Template.new(template)
+      tmpl.to_html_raw(template, {properties: result})
+    end
+
     # helper method:
     def relative_path(dest)
       src = @param[:output_file]

data/lib/ttl2html/version.rb

@@ -1 +1 @@
-TTL2HTML::VERSION = "0.1.0"
+TTL2HTML::VERSION = "0.2.0"

data/lib/ttl2html.rb

@@ -18,6 +18,7 @@ module TTL2HTML
       end
       @data = {}
       @data_inverse = {}
+      @prefix = {}
       @graph = RDF::Graph.new
     end
 
@@ -33,6 +34,7 @@ module TTL2HTML
       STDERR.puts "loading #{file}..."
       count = 0
       RDF::Turtle::Reader.open(file) do |reader|
+        @prefix.merge! reader.prefixes
         reader.statements.each do |statement|
           @graph.insert(statement)
           s = statement.subject
@@ -137,17 +139,48 @@ module TTL2HTML
       end
       index_html = "index.html"
       index_html = File.join(@config[:output_dir], "index.html") if @config[:output_dir]
-      if @config.has_key? :top_class and not File.exist? index_html
-        template = Template.new("index.html.erb", @config)
+      if @config.has_key? :top_class
+        subjects = @graph.query([nil,
+                                RDF::URI("http://www.w3.org/1999/02/22-rdf-syntax-ns#type"),
+                                RDF::URI(@config[:top_class])]).subjects
+        if subjects.empty?
+          STDERR.puts "WARN: top_class parameter specified as [#{@config[:top_class]}], but there is no instance data."
+          STDERR.puts "  Skip generation of top page."
+        else
+          template = Template.new("index.html.erb", @config)
+          param = @config.dup
+          param[:data_global] = @data
+          subjects.each do |subject|
+            param[:index_data] ||= []
+            param[:index_data] << subject.to_s
+          end
+          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]
+        template = Template.new("about.html.erb", @config)
         param = @config.dup
         param[:data_global] = @data
-        @graph.query([nil,
-                      RDF::URI("http://www.w3.org/1999/02/22-rdf-syntax-ns#type"),
-                      RDF::URI(@config[:top_class])]).subjects.sort.each do |subject|
-          param[:index_data] ||= []
-          param[:index_data] << subject.to_s
+        param[:content] = {}
+        shapes.subjects.each do |subject|
+          label = nil
+          target_class = @data[subject.to_s]["http://www.w3.org/ns/shacl#targetClass"]
+          if target_class and @data[target_class.first]
+            label = template.get_title(@data[target_class.first])
+          else
+            label = template.get_title(@data[subject.to_s])
+          end
+          param[:content][subject] = {
+            label: label,
+            html: template.expand_shape(@data, subject.to_s, @prefix),
+          }
         end
-        template.output_to(index_html, param)
+        template.output_to(about_html, param)
       end
     end
     def output_turtle_files

data/templates/about.html.erb

@@ -0,0 +1,24 @@
+    <div class="jumbotron">
+      <div class="container">
+        <h1><%=h param[:site_title] %>について</h1>
+      </div>
+    </div>
+    <div class="container">
+      <div class="row">
+        <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>
+          </ol>
+        </div>
+      </div>
+
+      <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>
+            <%= param[:content][shape][:html] -%>
+          <%- end -%>
+        </div>
+      </div>

data/templates/shape-table.html.erb

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: ttl2html
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Masao Takaku
@@ -122,9 +122,11 @@ files:
 - lib/ttl2html/template.rb
 - lib/ttl2html/version.rb
 - lib/xlsx2shape.rb
+- templates/about.html.erb
 - templates/default.html.erb
 - templates/index.html.erb
 - templates/layout.html.erb
+- templates/shape-table.html.erb
 - templates/triples.html.erb
 homepage: https://github.com/masao/ttl2html
 licenses: