neo4j_bolt 0.4.2 → 0.4.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 66da85ac04ffd0ef43fea4fba9a676ea2168770f85825573652a58dbc0a48f2b
-  data.tar.gz: 132911b813e88d5a3efb590fe5cd29da0c8adb6663b06b9931bb0a03f4fcae9c
+  metadata.gz: 38ed2e6727f1bc4baccc838b195d72a2392bbb82788598d704a1e81bd0f20de0
+  data.tar.gz: d781a67c3eee09dd9e32a9af60fe1fb65a61bb8afddb96307dd897cbcd99ddf1
 SHA512:
-  metadata.gz: 37e9205800f8661683bc246c6a962a15254c2d1e4a33d5b948f85d5e59d9ac38911e67c4a2e18bb318bc9f3ceeb3eedb7199004e98b0ce1694ae2e0f16f9ce8e
-  data.tar.gz: 3f7066485f251b5939b9a448b441290f16714311ebd7baa2b2baa27d785ae2463902c63b6c14b532df5adfe574242c8e415305967677110d92943a431e4360d3
+  metadata.gz: e1d4c318c5adb68878da6368dc8d694a63c79cc953ab0e87ffe5aceaf77ce9d47d06b35a80cef8ea835ac90e6753974a59c2bb2bd9088f144fdf8761976b9b8a
+  data.tar.gz: d28fd8341cbbfe89391c7685331ed8fc666864edb7222f8ccb3530ddd3e93b2bad68d9fa6ebdf75049cad99c8d68926b356e3b55fadcb795e017dfc0be9d0f22

data/README.md

@@ -159,6 +159,13 @@ end
 
 Passing `progress_io:` is optional for the Ruby API. The CLI always reports dump/load progress on stderr, so dump data written to stdout remains safe to redirect or pipe. In `auto` mode a terminal gets a colored, in-place progress bar while redirected stderr receives periodic plain-text progress lines. Set `NEO4J_BOLT_PROGRESS=pretty` to force the terminal display through a container or other wrapper that hides the TTY, or `NEO4J_BOLT_PROGRESS=plain` to force log-friendly output. `NO_COLOR` disables colors without disabling the in-place display.
 
+Both `dump` and `load` accept `--color COLOR` to choose the spinner and filled progress-bar accent. The default is `cyan`. The Ruby API exposes the same setting as `progress_color:`. Available colors are `red`, `green`, `yellow`, `blue`, `magenta`, `cyan`, `white`, `bright-red`, `bright-green`, `bright-yellow`, `bright-blue`, `bright-magenta`, `bright-cyan`, and `bright-white`.
+
+```bash
+neo4j_bolt dump --color magenta -o database.dump
+neo4j_bolt load --color bright-blue database.dump
+```
+
 The `0, 1, 2, ...` IDs are synthetic dump-local IDs. Database-internal IDs and element IDs are never written to the persistent format. Dumping keeps the count, node, and relationship reads in one transaction, so the driver-provided entity identity used to connect the two streamed result sets stays within Neo4j's transaction-scoped identity guarantee. To keep dump numbering deterministic, ordering uses `elementId()` on modern Neo4j and an internal `id()` fallback only on Neo4j 4.4, where `elementId()` does not exist. Old Neo4jBolt dumps remain loadable.
 
 For relational loads, the adapter assigns a random temporary label and dump-ID property to imported nodes. After the nodes are committed it builds a temporary `neo4j_bolt_` index on that property, uses indexed lookups while creating relationships, drops the index, and removes the temporary metadata in batches. No database-internal identity is carried from one load transaction to another. Loading a relational dump therefore requires permission to create and drop an index.
@@ -175,8 +182,8 @@ The `neo4j_bolt` executable retains these commands:
 | --- | --- |
 | `neo4j_bolt console` | Open an IRB console with Neo4jBolt loaded |
 | `neo4j_bolt clear --srsly` | Delete all nodes and relationships |
-| `neo4j_bolt dump` | Write the textual database dump |
-| `neo4j_bolt load [--force] [--batch-size N] PATH` | Load a textual dump |
+| `neo4j_bolt dump [--color COLOR]` | Write the textual database dump |
+| `neo4j_bolt load [--force] [--batch-size N] [--color COLOR] PATH` | Load a textual dump |
 | `neo4j_bolt index ls` | List constraints and indexes |
 | `neo4j_bolt index rm --force` | Remove all constraints and indexes |
 | `neo4j_bolt visualize` | Generate a GraphViz document |

data/bin/neo4j_bolt

@@ -47,9 +47,10 @@ class App
     long_desc 'Dump all nodes and relationships.'
     command :dump do |c|
         c.flag [:o, 'out-file'.to_sym], :default_value => '/dev/stdout'
+        c.flag [:color], :default_value => 'cyan', :desc => 'progress accent color'
         c.action do |global_options, options|
             File.open(options['out-file'.to_sym], 'w') do |f|
-                dump_database(f, progress_io: $stderr)
+                dump_database(f, progress_io: $stderr, progress_color: options[:color])
             end
         end
     end
@@ -63,6 +64,7 @@ class App
         c.switch [:f, :force], :default_value => false, :desc => 'force appending nodes even if the database is not empty'
         c.flag [:b, 'batch-size'.to_sym], :default_value => Neo4jBolt::LOAD_INITIAL_BATCH_SIZE,
                :desc => 'initial batch size; automatically reduced on transaction-memory errors'
+        c.flag [:color], :default_value => 'cyan', :desc => 'progress accent color'
         c.action do |global_options, options, args|
             help_now!('input path is required') if args.empty?
             path = args.shift
@@ -71,6 +73,7 @@ class App
                     f,
                     force_append: options[:force],
                     progress_io: $stderr,
+                    progress_color: options[:color],
                     initial_batch_size: options['batch-size'.to_sym]
                 )
             end

data/lib/neo4j_bolt/version.rb

@@ -1,3 +1,3 @@
 module Neo4jBolt
-    VERSION = "0.4.2"
+    VERSION = "0.4.3"
 end

data/lib/neo4j_bolt.rb

@@ -29,13 +29,35 @@ module Neo4jBolt
       reset: "\e[0m",
       bold: "\e[1m",
       dim: "\e[2m",
-      cyan: "\e[36m",
+      red: "\e[31m",
       green: "\e[32m",
-      yellow: "\e[33m"
+      yellow: "\e[33m",
+      blue: "\e[34m",
+      magenta: "\e[35m",
+      cyan: "\e[36m",
+      white: "\e[37m",
+      bright_red: "\e[91m",
+      bright_green: "\e[92m",
+      bright_yellow: "\e[93m",
+      bright_blue: "\e[94m",
+      bright_magenta: "\e[95m",
+      bright_cyan: "\e[96m",
+      bright_white: "\e[97m"
+    }.freeze
+    ACCENT_STYLES = {
+      "red" => :red, "green" => :green, "yellow" => :yellow, "blue" => :blue,
+      "magenta" => :magenta, "cyan" => :cyan, "white" => :white,
+      "bright-red" => :bright_red, "bright-green" => :bright_green,
+      "bright-yellow" => :bright_yellow, "bright-blue" => :bright_blue,
+      "bright-magenta" => :bright_magenta, "bright-cyan" => :bright_cyan,
+      "bright-white" => :bright_white
     }.freeze
 
-    def initialize(io)
+    def initialize(io, color: "cyan")
       @io = io
+      @accent_style = ACCENT_STYLES.fetch(color.to_s) do
+        raise ArgumentError, "progress color must be one of: #{ACCENT_STYLES.keys.join(', ')}"
+      end
       mode = ENV.fetch("NEO4J_BOLT_PROGRESS", "auto")
       unless %w[auto pretty plain].include?(mode)
         raise ArgumentError, "NEO4J_BOLT_PROGRESS must be auto, pretty, or plain"
@@ -110,7 +132,7 @@ module Neo4jBolt
       spinner = SPINNER[@spinner_index % SPINNER.length]
       @spinner_index += 1
 
-      parts = [color(:cyan, spinner), color(:bold, label)]
+      parts = [color(@accent_style, spinner), color(:bold, label)]
       if percent
         percent = [[percent.to_i, 0].max, 100].min
         parts << progress_bar(percent)
@@ -123,7 +145,7 @@ module Neo4jBolt
     def progress_bar(percent)
       filled = (percent * BAR_WIDTH / 100.0).round
       empty = BAR_WIDTH - filled
-      "#{color(:cyan, '━' * filled)}#{color(:dim, '─' * empty)}"
+      "#{color(@accent_style, '━' * filled)}#{color(:dim, '─' * empty)}"
     end
 
     def terminal_parts(message, strip_percent: false)
@@ -514,8 +536,8 @@ module Neo4jBolt
     nil
   end
 
-  def dump_database(io, progress_io: nil)
-    progress = ProgressReporter.new(progress_io)
+  def dump_database(io, progress_io: nil, progress_color: "cyan")
+    progress = ProgressReporter.new(progress_io, color: progress_color)
     dumped_nodes = 0
     dumped_relationships = 0
 
@@ -574,7 +596,7 @@ module Neo4jBolt
     progress&.close
   end
 
-  def load_database_dump(io, force_append: false, progress_io: nil,
+  def load_database_dump(io, force_append: false, progress_io: nil, progress_color: "cyan",
                          initial_batch_size: LOAD_INITIAL_BATCH_SIZE)
     raise Error, "load_database_dump cannot run inside a transaction" if transaction_context
 
@@ -586,7 +608,7 @@ module Neo4jBolt
       raise Error, "There are nodes in this database, exiting now." unless count.zero?
     end
 
-    progress = ProgressReporter.new(progress_io)
+    progress = ProgressReporter.new(progress_io, color: progress_color)
     node_batches = Hash.new { |hash, key| hash[key] = [] }
     relationship_batches = Hash.new { |hash, key| hash[key] = [] }
     total_nodes, total_relationships = parse_dump(io, node_batches, relationship_batches, progress)

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: neo4j_bolt
 version: !ruby/object:Gem::Version
-  version: 0.4.2
+  version: 0.4.3
 platform: ruby
 authors:
 - Michael Specht