gremlin2dot 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 329541aa877df7ee19cd655d44becf877b32739d76b41dfd1b5a97b3aad1f619
+  data.tar.gz: 074615b05287eda09c507586b86891bf30d1f34cf113e6b031ae7906550fe60c
+SHA512:
+  metadata.gz: 51e50cc7cd8e90042a07beb665665073f9aa626056c52b40865eb92b1fbdd1e1c57a8dfaa3bf0eec7ea77fe68caf4c260b711e2f6e94a5096b8336145f1f64b6
+  data.tar.gz: 77e8a9450f43d4b50a0540c18695991b7b4a319b7a9efb0d23bd987c71034572518c04679f7347de8e4e7ded6b50da315b9e204f887f8536b99c9c13e36b729f

data/Gemfile

@@ -0,0 +1,2 @@
+gem 'rest-client', '~> 2.0'
+gem 'ruby-graphviz', '~> 1.0'

data/Gemfile.lock

@@ -0,0 +1,28 @@
+GEM
+  specs:
+    domain_name (0.5.20180417)
+      unf (>= 0.0.5, < 1.0.0)
+    http-cookie (1.0.3)
+      domain_name (~> 0.5)
+    mime-types (3.1)
+      mime-types-data (~> 3.2015)
+    mime-types-data (3.2016.0521)
+    netrc (0.11.0)
+    rest-client (2.0.2)
+      http-cookie (>= 1.0.2, < 2.0)
+      mime-types (>= 1.16, < 4.0)
+      netrc (~> 0.8)
+    ruby-graphviz (1.2.2)
+    unf (0.1.4)
+      unf_ext
+    unf_ext (0.0.7.5)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  rest-client (~> 2.0)
+  ruby-graphviz (~> 1.0)
+
+BUNDLED WITH
+   1.16.1

data/README.md

@@ -0,0 +1,6 @@
+gremlin2dot
+===========
+
+Run a Gremlin query (e.g. against AWS Neptune), and visualise the results
+using GraphViz.
+

data/bin/gremlin2dot

@@ -0,0 +1,84 @@
+#!/usr/bin/env ruby
+# vi: set ts=2 sw=2 :
+
+require 'optparse'
+
+def error(message)
+  $stderr.puts message
+  exit 2
+end
+
+endpoint = nil
+query = nil
+use_stdin = false
+
+json_file = nil
+
+canon_file = nil
+dot_file = nil
+png_file = nil
+svg_file = nil
+
+opts = OptionParser.new
+opts.on('-e', '--endpoint URL', 'The URL of the Gremlin endpoint') {|v| endpoint = v }
+opts.on('-q', '--query QUERY', 'The Gremlin query to run') {|v| query = v }
+opts.on('--stdin', 'Read Gremlin results as JSON from standard input') { use_stdin = true }
+opts.on('--save-json FILE', 'Save the JSON to FILE') {|v| json_file = v }
+opts.on('--canon FILE', 'Write the results as canonical DOT to FILE') {|v| canon_file = v }
+opts.on('--dot FILE', 'Write the results as placed DOT to FILE') {|v| dot_file = v }
+opts.on('--png FILE', 'Write the results as PNG to FILE') {|v| png_file = v }
+opts.on('--svg FILE', 'Write the results as SVG to FILE') {|v| svg_file = v }
+opts.order!
+
+if !canon_file and !dot_file and !png_file and !svg_file
+  canon_file = "/dev/stdout"
+end
+
+if endpoint.nil? != query.nil?
+  error "Either specify both --endpoint and --query, or specify --stdin 1"
+end
+
+if use_stdin != endpoint.nil?
+  error "Either specify both --endpoint and --query, or specify --stdin 2"
+end
+
+require 'json'
+require 'gremlin2dot'
+require 'ruby-graphviz'
+
+json_text = if use_stdin
+              $stdin.read
+            else
+              require 'rest-client'
+              RestClient.post(
+                endpoint,
+                { gremlin: query }.to_json,
+                { content_type: :json, accept: :json },
+              ).body
+            end
+
+if json_file
+  IO.write(json_file, json_text)
+end
+
+query_results = JSON.parse(json_text)
+unmangled_data = Gremlin2Dot::Unmangler.new.unmangle(query_results)
+g = Gremlin2Dot::GraphBuilder.build(unmangled_data)
+
+if canon_file
+  g.output(canon: canon_file)
+end
+
+if dot_file
+  g.output(dot: dot_file)
+end
+
+if png_file
+  g.output(png: png_file)
+end
+
+if svg_file
+  g.output(svg: svg_file)
+end
+
+exit

data/lib/gremlin2dot/data_model.rb

@@ -0,0 +1,60 @@
+module Gremlin2Dot
+
+  class Edge < Hash
+    def id ; self['id'] ; end
+    def label ; self['label'] ; end
+    def inVLabel ; self['inVLabel'] ; end
+    def outVLabel ; self['outVLabel'] ; end
+    def inV ; self['inV'] ; end
+    def outV ; self['outV'] ; end
+    def properties ; self['properties'] || {} ; end
+    def inspect ; "#<#{self.class.name} #{super}>" ; end
+  end
+
+  class Vertex < Hash
+    def id ; self['id'] ; end
+    def label ; self['label'] ; end
+    def properties ; self['properties'] || {} ; end
+    def inspect ; "#<#{self.class.name} #{super}>" ; end
+  end
+
+  class VertexProperty < Hash
+    def id ; self['id'] ; end
+    def label ; self['label'] ; end
+    def value ; self['value'] ; end
+
+    def inspect
+      value.inspect
+    end
+
+    def to_s
+      value.to_s
+    end
+
+    def pretty_print(*args)
+      value.pretty_print *args
+    end
+  end
+
+  class Property < Hash
+    def key ; self['key'] ; end
+    def value ; self['value'] ; end
+
+    def inspect
+      value.inspect
+    end
+
+    def to_s
+      value.to_s
+    end
+
+    def pretty_print(*args)
+      value.pretty_print *args
+    end
+  end
+
+  class Tree
+    attr_accessor :key, :items
+  end
+
+end

data/lib/gremlin2dot/graph_builder.rb

@@ -0,0 +1,54 @@
+require 'set'
+
+module Gremlin2Dot
+
+  class GraphBuilder
+
+    def self.build(results)
+      self.new().build(results)
+    end
+
+    def initialize
+      @seen = Set.new
+      @g = GraphViz.new("G")
+    end
+
+    def build(unmangled_data)
+      trees = unmangled_data['result']['data']
+
+      trees.each do |t0|
+        t0.each do |t1|
+          add_thing t1
+        end
+      end
+
+      @g
+    end
+
+    def add_thing(thing)
+      case thing
+      when Vertex
+        node = thing
+        unless @seen.include? node.id
+          label = node.label + node.properties.entries.sort_by(&:first).map {|k, v| "\n#{k}=#{v.first}" }.join("")
+          @g.add_nodes(node.id, label: label)
+          @seen << node.id
+        end
+      when Edge
+        edge = thing
+        unless @seen.include? edge.id
+          label = edge.label + edge.properties.entries.sort_by(&:first).map {|k, v| "\n#{k}=#{v}" }.join("")
+          @g.add_edges(edge.outV, edge.inV, label: label)
+          @seen << edge.id
+        end
+      when Tree
+        add_thing thing.key
+        thing.items.each {|child| add_thing child}
+      else
+        $stderr.puts "Not adding #{thing.class} to the graph"
+      end
+    end
+
+  end
+
+end

data/lib/gremlin2dot/unmangler.rb

@@ -0,0 +1,67 @@
+module Gremlin2Dot
+
+  class Unmangler
+
+    def unmangle(d)
+      if d.kind_of?(Hash) and d.has_key?('@type') and d.has_key?('@value') and d.keys.count == 2
+        case d['@type']
+        when 'g:Map'
+          h = Hash.new
+          raise unless d['@value'].empty?
+          h
+        when 'g:List'
+          unmangle d['@value']
+        when 'g:Tree'
+          # array of hashes, where each hash has 'key'=Vertex/Edge, 'value' = ...
+          # Array of Hash with 'key' and 'value', where ...
+          # – key is a Vertex
+          # – value is a Hash of @type/@value
+
+          d['@value'].map do |item|
+            t = Tree.new
+            t.key = unmangle item['key']
+            t.items = unmangle item['value']
+            t
+          end
+        when 'g:Edge'
+          unmangle_object(d, Edge)
+        when 'g:Vertex'
+          unmangle_object(d, Vertex)
+        when 'g:VertexProperty'
+          unmangle_object(d, VertexProperty)
+          # discard the id
+          # unmangle d['@value']['value']
+        when 'g:Property'
+          unmangle_object(d, Property)
+          # discard the key
+          # unmangle d['@value']['value']
+        when 'g:Int32'
+          d['@value']
+        when 'g:Double'
+          d['@value']
+        when 'g:Date'
+          Time.at(d['@value'] / 1000.0)
+        else
+          $stderr.puts 'Ignoring unknown type ' + d['@type'] + " with value #{d['@value'].inspect[0..200]}..."
+          unmangle d['@value']
+        end
+      elsif d.kind_of? Hash
+        d.entries.map {|k, v| [k, unmangle(v)]}.to_h
+      elsif d.kind_of? Array
+        d.map {|v| unmangle v}
+      else
+        d
+      end
+    end
+
+    def unmangle_object(d, klass)
+      o = klass.new
+      d['@value'].entries.each do |k, v|
+        o[k] = unmangle v
+      end
+      o
+    end
+
+  end
+
+end

data/lib/gremlin2dot.rb

@@ -0,0 +1,3 @@
+require_relative 'gremlin2dot/data_model.rb'
+require_relative 'gremlin2dot/graph_builder.rb'
+require_relative 'gremlin2dot/unmangler.rb'

metadata

@@ -0,0 +1,95 @@
+--- !ruby/object:Gem::Specification
+name: gremlin2dot
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Rachel Evans
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2018-06-28 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rest-client
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: ruby-graphviz
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.5'
+description: "\n"
+email:
+- rachel@rachelevans.org
+executables:
+- gremlin2dot
+extensions: []
+extra_rdoc_files: []
+files:
+- Gemfile
+- Gemfile.lock
+- README.md
+- bin/gremlin2dot
+- lib/gremlin2dot.rb
+- lib/gremlin2dot/data_model.rb
+- lib/gremlin2dot/graph_builder.rb
+- lib/gremlin2dot/unmangler.rb
+homepage: http://rve.org.uk/gems/gremlin2dot
+licenses:
+- Apache-2.0
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.7.6
+signing_key: 
+specification_version: 4
+summary: Run a gremlin query, and visualise using GraphViz
+test_files: []