neo4j_bolt 0.1.7 → 0.1.8

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 86471d4b049b4054a378f5084ae13dda181bd818a205ee4a67e6aa4bc5d0607f
-  data.tar.gz: b1e855e4689946026eaa7971acb730577a57973b02605c893916d15e2438b1f3
+  metadata.gz: 1ac7e327b2ece44cd23a4408c81c0a9a41d52faf277c24b56280a15f1b79aeec
+  data.tar.gz: a24414f311a40ff6cb79d18a18497200f79ed7e2a58e070b5e321a4dc31cc757
 SHA512:
-  metadata.gz: e4e414cb24861f58ae67f2a5c92da46f720c861fd49131befa16a9c046ea557d1e31fb40130fe892aa91b38d0ec3de881d4da94de4fde4a5288ab0add379c33f
-  data.tar.gz: be8ed37b6ea0a7e358c25257eea3be90f78c2fd1342a4666bc244a5a379e241780a6df01d4005c4b26a4986a2fd24cd0a65f7569f4de19bcbf4a65517a33aa8a
+  metadata.gz: f716cd2380decb532dbe6954030e4ead5ea0a1edde1868922b81d2105801d7ed6bb9e5b35e3eb22f79ca9413408582bca6da44a9fa767ad6fa554b929df84436
+  data.tar.gz: 35f82570c1bcf2b56a61a17d9bbf189f2055386efd1c6f83cd3c60313069d26380ce050394665ede60ef9ea4eb27626bf7438b43a4070e361a2b9ed626c51893

data/Gemfile

@@ -5,3 +5,4 @@ gemspec
 
 gem "rake", "~> 12.0"
 gem "rspec", "~> 3.0"
+gem "gli"

data/Gemfile.lock

@@ -1,12 +1,13 @@
 PATH
   remote: .
   specs:
-    neo4j_bolt (0.1.6)
+    neo4j_bolt (0.1.8)
 
 GEM
   remote: https://rubygems.org/
   specs:
     diff-lcs (1.5.0)
+    gli (2.21.0)
     rake (12.3.3)
     rspec (3.11.0)
       rspec-core (~> 3.11.0)
@@ -26,6 +27,7 @@ PLATFORMS
   ruby
 
 DEPENDENCIES
+  gli
   neo4j_bolt!
   rake (~> 12.0)
   rspec (~> 3.0)

data/bin/neo4j_bolt

@@ -0,0 +1,213 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "neo4j_bolt"
+require "gli"
+
+include Neo4jBolt
+
+class App
+    extend GLI::App
+
+    program_desc 'run various Neo4j housekeeping tasks'
+    version Neo4jBolt::VERSION
+
+    flag [:v, :verbosity], :default_value => 0
+    flag [:h, :host], :default_value => 'localhost:7687'
+
+    pre do |global_options, command, options, args|
+        host = global_options[:host]
+        Neo4jBolt.bolt_host = host.split(':').first
+        Neo4jBolt.bolt_port = host.split(':').last.to_i
+        Neo4jBolt.bolt_verbosity = global_options[:verbosity].to_i
+        true
+    end
+
+    # --------------------------------------------
+
+    desc 'Console'
+    command :console do |c|
+        c.action do
+            require "irb"
+            IRB.start(__FILE__)
+        end
+    end
+
+    # --------------------------------------------
+
+    desc 'Dump database'
+    long_desc 'Dump all nodes and relationships.'
+    command :dump do |c|
+        c.flag [:o, :out_file], :default_value => '/dev/stdout'
+        c.action do |global_options, options|
+            File.open(options[:out_file], 'w') do |f|
+                dump_database(f)
+            end
+        end
+    end
+
+    # --------------------------------------------
+
+    desc 'Load database dump'
+    long_desc 'Load nodes and relationships from a database dump.'
+    command :load do |c|
+        # c.flag [:i, :in_file], :desc => 'input path', :required => true
+        c.switch [:f, :force], :default_value => false, :desc => 'force appending nodes even if the database is not empty'
+        c.action do |global_options, options, args|
+            help_now!('input path is required') if args.empty?
+            path = args.shift
+            File.open(path, 'r') do |f|
+                load_database_dump(f, force_append: options[:force])
+            end
+        end
+    end
+
+    # --------------------------------------------
+
+    desc 'Clear database'
+    long_desc 'Clear all nodes and relationships'
+    command :clear do |c|
+        c.switch [:srsly], :required => true, :negatable => false, :desc => 'Specify --srsly to really clear the database'
+        c.action do |global_options, options, args|
+            if options[:srsly]
+                neo4j_query("MATCH (n) DETACH DELETE n;")
+            else
+                STDERR.puts "Doing nothing unless you specify --srsly."
+            end
+        end
+    end
+
+    # --------------------------------------------
+
+    desc 'Visualize database'
+    long_desc 'Generate a GraphViz-formatted visual representation of the database'
+    command :visualize do |c|
+        c.flag [:o, :out_file], :default_value => '/dev/stdout'
+        c.switch [:p, :properties], :default_value => false, :desc => 'include properties'
+        c.action do |global_options, options|
+            File.open(options[:out_file], 'w') do |f|
+                all_labels = Set.new()
+
+                TR = {'String' => 'string',
+                      'Array' => 'list',
+                      'Hash' => 'hash',
+                      'TrueClass' => 'true',
+                      'FalseClass' => 'false',
+                      'NilClass' => 'null',
+                      'Integer' => 'int',
+                      'Float' => 'float'
+                    }
+
+                neo4j_query("MATCH (n) RETURN DISTINCT labels(n) AS labels") do |entry|
+                    labels = entry['labels']
+                    if labels.size != 1
+                        raise "multiple labels per node not supported yet: #{labels.join(' ')}"
+                    end
+                    all_labels << labels.first
+                end
+
+                all_relationships = Set.new()
+
+                neo4j_query("MATCH (a)-[r]->(b) RETURN DISTINCT labels(a) AS la, type(r) AS t, labels(b) AS lb;") do |entry|
+                    la = entry['la'].first
+                    t = entry['t']
+                    lb = entry['lb'].first
+                    all_relationships << "#{la}/#{t}/#{lb}"
+                end
+
+                properties_for_label = {}
+                counts_for_label = {}
+
+                all_labels.to_a.sort.each do |label|
+                    properties_for_label[label] ||= {}
+                    if options[:properties]
+                        neo4j_query("MATCH (n:#{label}) RETURN n") do |entry|
+                            counts_for_label[label] ||= 0
+                            counts_for_label[label] += 1
+                            node = entry['n']
+                            node.each_pair do |key, value|
+                                properties_for_label[label][key] ||= {:classes => Set.new()}
+                                properties_for_label[label][key][:classes] << value.class
+                            end
+                        end
+                    end
+                end
+
+                all_relationships.each do |s|
+                    properties_for_label[s] ||= {}
+                    parts = s.split('/')
+                    la = parts[0]
+                    type = parts[1]
+                    lb = parts[2]
+                    if options[:properties]
+                        neo4j_query("MATCH (a:#{la})-[r:#{type}]->(b:#{lb}) RETURN r") do |entry|
+                            counts_for_label[s] ||= 0
+                            counts_for_label[s] += 1
+                            rel = entry['r']
+                            rel.each_pair do |key, value|
+                                properties_for_label[s][key] ||= {:classes => Set.new()}
+                                properties_for_label[s][key][:classes] << value.class
+                            end
+                        end
+                    end
+                end
+
+                dot = StringIO.open do |io|
+                    io.puts "digraph {"
+                    io.puts "graph [fontname = Helvetica, fontsize = 10, nodesep = 0.2, ranksep = 0.3];"
+                    io.puts "node [fontname = Helvetica, fontsize = 10, shape = none, margin = 0];"
+                    io.puts "edge [fontname = Helvetica, fontsize = 10, arrowsize = 0.6, color = \"#000000\"];"
+                    io.puts 'rankdir=LR;'
+                    io.puts 'splines=true;'
+                    properties_for_label.keys.sort.each do |lbl|
+                        label = "<<table valign='top' align='left' border='0' cellborder='0' cellspacing='0' cellpadding='4'>"
+                        label += "<tr><td border='1' bgcolor='#fce94f' valign='top' align='left' colspan='2'><b>#{lbl}</b>"
+                        if options[:properties]
+                            label += " <i>(#{counts_for_label[lbl]})</i>"
+                        end
+                        label += "</td></tr>"
+                        properties_for_label[lbl].keys.sort.each do |key|
+                            label += "<tr>"
+                            label += "<td border='1' valign='top' align='left' colspan='1'>#{key}</td>"
+                            label += "<td border='1' valign='top' align='left' colspan='1'>#{properties_for_label[lbl][key][:classes].to_a.map { |x| TR[x.to_s] || x.to_s }.sort.join(' / ')}</td>"
+                            label += "</tr>"
+                        end
+                        label += "</table>>"
+                        io.puts "\"#{lbl}\" [label = #{label}, pencolor = \"#000000\"];"
+                    end
+                    all_relationships.each do |s|
+                        parts = s.split('/')
+                        la = parts[0]
+                        type = parts[1]
+                        lb = parts[2]
+
+                        label = "<<table valign='top' align='left' border='0' cellborder='0' cellspacing='0' cellpadding='4'>"
+                        label += "<tr><td border='1' bgcolor='#d3d7cf' valign='top' align='left' colspan='2'><b>#{type}</b>"
+                        if options[:properties]
+                            label += " <i>(#{counts_for_label[s]})</i>"
+                        end
+                        label += "</td></tr>"
+                        (properties_for_label[s] || {}).keys.sort.each do |key|
+                            label += "<tr>"
+                            label += "<td border='1' valign='top' align='left' colspan='1'>#{key}</td>"
+                            label += "<td border='1' valign='top' align='left' colspan='1'>#{properties_for_label[s][key][:classes].to_a.map { |x| TR[x.to_s] || x.to_s }.sort.join(' / ')}</td>"
+                            label += "</tr>"
+                        end
+                        label += "</table>>"
+                        io.puts "\"#{s}\" [label = #{label}, pencolor = \"#000000\"];"
+
+                        io.puts "\"#{la}\" -> \"#{s}\";"
+                        io.puts "\"#{s}\" -> \"#{lb}\";"
+                    end
+
+                    io.puts "}"
+                    io.string
+                end
+                f.puts dot
+            end
+        end
+    end
+
+end
+
+exit App.run(ARGV)

data/lib/neo4j_bolt/version.rb

@@ -1,3 +1,3 @@
 module Neo4jBolt
-  VERSION = "0.1.7"
+  VERSION = "0.1.8"
 end

data/lib/neo4j_bolt.rb

@@ -5,12 +5,12 @@ require 'yaml'
 
 module Neo4jBolt
     class << self
-        attr_accessor :bolt_host, :bolt_port
+        attr_accessor :bolt_host, :bolt_port, :bolt_verbosity
     end
     self.bolt_host = 'localhost'
     self.bolt_port = 7687
+    self.bolt_verbosity = 0
 
-    NEO4J_DEBUG = 0
     CONSTRAINT_INDEX_PREFIX = 'neo4j_bolt_'
 
     module ServerState
@@ -115,7 +115,7 @@ module Neo4jBolt
                     end
                     chunk = @socket.read(length).unpack('C*')
                     @data += chunk
-                    if NEO4J_DEBUG >= 3
+                    if Neo4jBolt.bolt_verbosity >= 3
                         dump()
                     end
                 end
@@ -753,7 +753,7 @@ module Neo4jBolt
         end
 
         def run_query(query, data = {}, &block)
-            if NEO4J_DEBUG >= 1
+            if Neo4jBolt.bolt_verbosity >= 1
                 STDERR.puts query
                 STDERR.puts data.to_json
                 STDERR.puts '-' * 40
@@ -791,7 +791,7 @@ module Neo4jBolt
                                 keys.each.with_index do |key, i|
                                     entry[key] = fix_value(data[:data][i])
                                 end
-                                if NEO4J_DEBUG >= 1
+                                if Neo4jBolt.bolt_verbosity >= 1
                                     STDERR.puts ">>> #{entry.to_json}"
                                     STDERR.puts '-' * 40
                                 end
@@ -938,7 +938,7 @@ module Neo4jBolt
             transaction do
                 node_count = neo4j_query_expect_one('MATCH (n) RETURN COUNT(n) as count;')['count']
                 unless node_count == 0
-                    raise "Error: There are nodes in this database, exiting now."
+                    raise "There are nodes in this database, exiting now."
                 end
             end
         end

data/neo4j_bolt.gemspec

@@ -22,8 +22,8 @@ Gem::Specification.new do |spec|
   spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
     `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
   end
-  spec.bindir        = "exe"
-  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.bindir        = "bin"
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]
 
   spec.add_development_dependency "rspec", "~> 3.2"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: neo4j_bolt
 version: !ruby/object:Gem::Version
-  version: 0.1.7
+  version: 0.1.8
 platform: ruby
 authors:
 - Michael Specht
 autorequire: 
-bindir: exe
+bindir: bin
 cert_chain: []
-date: 2022-10-28 00:00:00.000000000 Z
+date: 2022-10-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
@@ -27,7 +27,10 @@ dependencies:
 description: 
 email:
 - micha.specht@gmail.com
-executables: []
+executables:
+- console
+- neo4j_bolt
+- setup
 extensions: []
 extra_rdoc_files: []
 files:
@@ -40,6 +43,7 @@ files:
 - README.md
 - Rakefile
 - bin/console
+- bin/neo4j_bolt
 - bin/setup
 - lib/neo4j_bolt.rb
 - lib/neo4j_bolt/version.rb