proiel 1.1.1 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 66a5e6fc550b5d017d0b49396ec931624cc9cc12
-  data.tar.gz: a89f0936a25eb4092728ac527f8816095f721818
+  metadata.gz: 5ead6b41029599129af6a717b0398980876a139c
+  data.tar.gz: 11a555a98a41029dfb721e9613bbb5be23847cfd
 SHA512:
-  metadata.gz: c956426f6bd2b6e90b9254a72f256d14937c99d0ca5183897b414fd17c6a88803082c0c88690b1ad695347b29cc1bfd86de2a933cfcbff453b4fb93ad4b9e623
-  data.tar.gz: 756f1beb29e9ec3174e9b65aa7a52428a6fa87f1d9db9bec18e112afb26ff372c05d333e96e2c60b889d4a8cd72540c315ecd0719bae2ba3e2a5d6e8bbe8b4b8
+  metadata.gz: 475971ca8443be39f3ef2a634ff8afd50931b248130e439991d473d06fcf0b7695d38d0629856654738ecaa853af1d63ba8675849eef52055b431252d07e205e
+  data.tar.gz: c33088acdb1e3fb130386204b02e3f54ca6566a05310c3397e8471c88360a742aafb8e5edc515e0d185280625994c606fed987f8cb7518a23c34a5e13686474b

data/LICENSE

@@ -1,4 +1,4 @@
-Copyright (c) 2015 Marius L. Jøhndal
+Copyright (c) 2015-2016 Marius L. Jøhndal
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

data/lib/proiel/source.rb

@@ -29,7 +29,10 @@ module PROIEL
     def initialize(parent, id, export_time, language, metadata, alignment_id, &block)
       @treebank = parent
       @id = id.freeze
-      @export_time = DateTime.parse(export_time).freeze
+
+      raise ArgumentError, 'string or nil expected' unless export_time.nil? or export_time.is_a?(String)
+      @export_time = export_time.nil? ? nil : DateTime.parse(export_time).freeze
+
       @language = language.freeze
       @metadata = metadata.freeze
 

data/lib/proiel/version.rb

@@ -5,5 +5,5 @@
 #++
 module PROIEL
   # Gem version
-  VERSION = '1.1.1'
+  VERSION = '1.2.0'
 end

data/lib/proiel/visualization/graphviz/classic.dot.erb

@@ -0,0 +1,23 @@
+digraph G {
+  charset="UTF-8";
+  graph [truecolor=true,bgcolor=transparent];
+  root [label="",shape=circle];
+
+  <%- @graph.tokens.select { |t| t.empty_token_sort != 'P' }.each do |token| -%>
+    <%- if token.empty_token_sort == 'C' or token.part_of_speech == 'C-' -%>
+      <%= node token.id, token.form || token.empty_token_sort, shape: :diamond -%>
+    <%- elsif token.is_empty? -%>
+      <%= node token.id, token.empty_token_sort,               shape: :circle -%>
+    <%- else -%>
+      <%= node token.id, token.form,                           shape: :box -%>
+    <%- end -%>
+
+    <%- if token.relation -%>
+      <%= edge (token.head ? token.head.id : :root), token.id, token.relation.to_s.upcase, weight: 1.0, color: :orange -%>
+    <%- end -%>
+
+    <%- token.slashes.each do |(relation, target)| -%>
+      <%= edge token.id, target, relation.to_s.upcase, weight: 0.0, color: :blue, style: :dashed %>
+    <%- end -%>
+  <%- end -%>
+}

data/lib/proiel/visualization/graphviz/linearized.dot.erb

@@ -0,0 +1,54 @@
+digraph G {
+  charset="UTF-8"; rankdir=TD; ranksep=.0005; nodesep=.05;
+  graph [truecolor=true,bgcolor=transparent];
+
+  node [shape=none]; {
+    depthR ->
+    <% (0..@sentence.max_depth).each do |depth| %>
+      depth<%= depth %> ->
+    <% end %>
+    WORDS [style=invis];
+  }
+
+  node [shape=point]; {
+    rank = same;
+    depthR [label=""];
+    root;
+  }
+
+  <% @graph.tokens.select { |t| t.empty_token_sort != 'P' }.inject({}) { |k, e| (k[e.depth] ||= []) << e; k }.sort.each do |depth, tokens| %>
+    node [shape=point]; {
+      rank = same;
+      <%= node "depth#{depth}" %>
+      <% tokens.each do |t| %>
+        <%= node t.id %>
+      <% end %>
+    }
+  <% end %>
+
+  node [shape=none]; {
+    rank = same;
+    WORDS [label=""];
+    <% @graph.tokens.select { |t| t.empty_token_sort != 'P' }.reject { |t| t.is_empty? }.sort_by { |t| t.token_number }.each do |t| %>
+      <%= node "f#{t.id}", t.form %>
+    <% end %>
+  }
+
+  <% @graph.tokens.select { |t| t.empty_token_sort != 'P' }.each do |t| %>
+    <% if t.relation %>
+      <%= edge (t.head ? t.head.id : :root), t.id, t.relation.to_s.upcase, fontcolor: :black, fontsize: 10 %>
+    <% end %>
+
+    <% unless t.is_empty? %>
+      <%= edge "f#{t.id}", t.id, '', arrowhead: :none, color: :lightgrey %>
+    <% end %>
+
+    <% t.slashes.each do |slash_edge| %>
+      <%= edge t.id, slash_edge.target_id, slash_edge.relation.to_s.upcase, color: :blue, weight: 0.0, style: :dotted, fontsize: 10 %>
+    <% end %>
+  <% end %>
+
+  <% @graph.tokens.select { |t| t.empty_token_sort.blank? }.sort_by(&:token_number).each_cons(2) do |n1, n2| %>
+    <%= edge "f#{n1.id}", "f#{n2.id}", '', weight: 10.0, style: :invis %>
+  <% end %>
+}

data/lib/proiel/visualization/graphviz/packed.dot.erb

@@ -0,0 +1,23 @@
+digraph G {
+  charset="UTF-8";
+  graph [truecolor=true,bgcolor=transparent];
+  root [label="",shape=none];
+
+  <% @graph.tokens.each do |token| %>
+    <% if token.conjunction? %>
+      <%= node token.id, token.form || token.empty_token_sort, shape: :none %>
+    <% elsif token.is_empty? %>
+      <%= node token.id, token.empty_token_sort, shape: :none %>
+    <% else %>
+      <%= node token.id, token.form, shape: :none %>
+    <% end %>
+
+    <% if token.relation %>
+      <%= edge (token.head ? token.head.id : :root), token.id, token.relation.to_s.upcase, weight: 0.0, color: :purple %>
+    <% end %>
+
+    <% token.slashes.each do |slash_edge| %>
+      <%= edge token.id, slash_edge.target_id, slash_edge.relation.to_s.upcase, weight: 0.0, color: :purple, style: :dashed %>
+    <% end %>
+  <% end %>
+}

data/lib/proiel/visualization/graphviz.rb

@@ -0,0 +1,103 @@
+module PROIEL
+  module Visualization
+    module Graphviz
+      DEFAULT_GRAPHVIZ_BINARY = 'dot'.freeze
+      DEFAULT_TEMPLATES = %i(classic linearized packed)
+      SUPPORTED_OUTPUT_FORMATS = %i(png svg)
+
+      class GraphvizError < Exception
+      end
+
+      def self.generate_to_file(template, graph, output_format, output_filename, options = {})
+        raise ArgumentError, 'string expected' unless output_filename.is_a?(String)
+
+        result = PROIEL::Visualization::Graphviz.generate(template, graph, output_format, options)
+
+        File.open(output_filename, 'w') do |f|
+          f.write(result)
+        end
+      end
+
+      def self.generate(template, graph, output_format, options = {})
+        raise ArgumentError, 'string or symbol expected' unless template.is_a?(String) or template.is_a?(Symbol)
+
+        dot_code = generate_dot(template, graph)
+
+        if output_format.to_sym == :dot
+          dot_code
+        else
+          generate_image(dot_code, output_format, options)
+        end
+      end
+
+      def self.template_filename(template)
+        raise ArgumentError, 'string or symbol expected' unless template.is_a?(String) or template.is_a?(Symbol)
+        raise ArgumentError, 'invalid template' unless DEFAULT_TEMPLATES.include?(template.to_sym)
+
+        File.join(File.dirname(__FILE__), 'graphviz', "#{template}.dot.erb")
+      end
+
+      def self.generate_image(dot_code, output_format, options = {})
+        raise ArgumentError, 'string expected' unless dot_code.is_a?(String)
+        raise ArgumentError, 'string or symbol expected' unless output_format.is_a?(String) or output_format.is_a?(Symbol)
+        raise ArgumentError, 'invalid output format' unless SUPPORTED_OUTPUT_FORMATS.include?(output_format.to_sym)
+
+        graphviz_binary = options[:graphviz_binary] || DEFAULT_GRAPHVIZ_BINARY
+
+        result, errors = nil, nil
+
+        Open3.popen3("dot -T#{output_format}") do |dot, img, err|
+          dot.write dot_code
+          dot.close
+
+          result, errors = img.read, err.read
+        end
+
+        raise GraphvizError, "graphviz exited with errors: #{errors}" unless errors.nil? or errors == ''
+
+        result
+      end
+
+      def self.generate_dot(template, graph)
+        filename = template_filename(template)
+
+        content = File.read(filename)
+
+        template = ERB.new(content, nil, '-')
+        template.filename = filename
+
+        TemplateContext.new(graph).generate(template)
+      end
+
+      class TemplateContext
+        def initialize(graph)
+          @graph = graph
+        end
+
+        def generate(template)
+          template.result(binding)
+        end
+
+        protected
+
+        # Creates a node with an identifier and a label.
+        def node(identifier, label = '', options = {})
+          attrs = join_attributes(options.merge(label: label))
+
+          "#{identifier} [#{attrs}];"
+        end
+
+        # Creates an edge with a label from one identifier to another identifier.
+        def edge(identifier1, identifier2, label = '', options = {})
+          attrs = join_attributes(options.merge(label: label))
+
+          "#{identifier1} -> #{identifier2} [#{attrs}];"
+        end
+
+        def join_attributes(attrs)
+          attrs.map { |a, v| %|#{a}="#{v.to_s.gsub('"', '\\"')}"| }.join(',')
+        end
+      end
+    end
+  end
+end

data/lib/proiel/visualization.rb

@@ -0,0 +1 @@
+require 'proiel/visualization/graphviz'

data/lib/proiel.rb

@@ -10,6 +10,9 @@ require 'ostruct'
 require 'sax-machine'
 require 'memoist'
 require 'nokogiri'
+require 'singleton'
+require 'erb'
+require 'open3'
 
 require 'proiel/version'
 require 'proiel/utils'
@@ -27,3 +30,4 @@ require 'proiel/source'
 require 'proiel/div'
 require 'proiel/sentence'
 require 'proiel/token'
+require 'proiel/visualization'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: proiel
 version: !ruby/object:Gem::Version
-  version: 1.1.1
+  version: 1.2.0
 platform: ruby
 authors:
 - Marius L. Jøhndal
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-06-12 00:00:00.000000000 Z
+date: 2016-08-31 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: json
@@ -72,28 +72,28 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.10'
+        version: '1.12'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.10'
+        version: '1.12'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '11.2'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '11.2'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -128,28 +128,28 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.10'
+        version: '0.12'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.10'
+        version: '0.12'
 - !ruby/object:Gem::Dependency
   name: yard
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.8.7
+        version: '0.9'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.8.7
+        version: '0.9'
 description: This provides a library of functions for reading and manipulating treebanks
   using the PROIEL dependency format.
 email:
@@ -184,6 +184,11 @@ files:
 - lib/proiel/treebank_object.rb
 - lib/proiel/utils.rb
 - lib/proiel/version.rb
+- lib/proiel/visualization.rb
+- lib/proiel/visualization/graphviz.rb
+- lib/proiel/visualization/graphviz/classic.dot.erb
+- lib/proiel/visualization/graphviz/linearized.dot.erb
+- lib/proiel/visualization/graphviz/packed.dot.erb
 homepage: http://proiel.github.com
 licenses:
 - MIT
@@ -209,4 +214,3 @@ signing_key:
 specification_version: 4
 summary: A library for working with treebanks using the PROIEL dependency format
 test_files: []
-has_rdoc: