redgraph 0.2.1 → 0.2.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2fd53776ff217146cd6ca4924da40a43f5bf929fad03b73b79f32d371ea955e8
-  data.tar.gz: 551afc973f8e732ad532e74395e6c73251f14d68db73f667a207b234bd64163b
+  metadata.gz: a48865b552ec9fdcb51a032b9dbafacc7f63cb9f08b980fdb6ad512732132131
+  data.tar.gz: 369db06d98cada1d39d962dd88b3f265fd8d300ba96876716f503971bd6dc010
 SHA512:
-  metadata.gz: dd7f88ae09acb7f09b6c8de949d4f31bbc52b12e4b914f035de99c7cd9b409c14eac3e592f834cc968517b796fed0cf3a085f7eba4915e630b2e66c424ae9870
-  data.tar.gz: 979aac39193d3150441ddf5baca14772a35c6cfd00f09df42752277aed3d955869822b2d97150209f1e71ad5ab95e566dc645d15d3e8262675dd858bd6fbb1dd
+  metadata.gz: cd8fca4012fd1392201c28496e90201c90819d8dd7ac988c71daeb5a7ce3e3d21c7c6249a1c2ef3af3025b7e8afcfde6de4ecf1d88f930960a3784b4701084ac
+  data.tar.gz: 77c95eff0ef122edb13a8644467510477c703b16d97d155b2938de38d9ed70dd59d4d8cfda5173bfec41a8caf2f6a0b255287a55e0f466983ab6c9b2ee7deacb

data/.github/workflows/tests-falkordb.yml

@@ -0,0 +1,26 @@
+name: Test with FalkorDB
+
+on: [push,pull_request]
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+
+    services:
+      redis:
+        image: falkordb/falkordb
+        ports: ["6379:6379"]
+
+    steps:
+    - uses: actions/checkout@v2
+    - name: Set up Ruby
+      uses: ruby/setup-ruby@v1
+      with:
+        ruby-version: 3.2.2
+    - name: Run the default task
+      env:
+        TEST_REDIS_URL: redis://localhost:6379/0
+      run: |
+        gem install bundler -v 2.4.10
+        bundle install
+        bundle exec rake

data/.github/workflows/{main.yml → tests-redisgraph.yml}

@@ -1,4 +1,4 @@
-name: Ruby
+name: Test with RedisGraph
 
 on: [push,pull_request]
 
@@ -16,11 +16,11 @@ jobs:
     - name: Set up Ruby
       uses: ruby/setup-ruby@v1
       with:
-        ruby-version: 3.0.0
+        ruby-version: 3.2.2
     - name: Run the default task
       env:
         TEST_REDIS_URL: redis://localhost:6379/0
       run: |
-        gem install bundler -v 2.2.15
+        gem install bundler -v 2.4.10
         bundle install
         bundle exec rake

data/CHANGELOG.md

@@ -1,3 +1,12 @@
+## [0.2.3] - 2023-12-17
+
+- Add ActiveSupport notifications
+
+## [0.2.2] - 2022-05-15
+
+- Nodes allow multiple labels
+- Friendlier exception message when the RedisGraph module is missing
+
 ## [0.2.1]
 
 - Add NodeModel#destroy method

data/CHEATSHEET.md

@@ -0,0 +1,13 @@
+# Cheatsheet
+
+Add node
+```
+GRAPH.QUERY movies "CREATE(:actor {name: 'Al Pacino'})"
+GRAPH.QUERY movies "CREATE(:actor {name: 'John Travolta'})"
+```
+
+Query graph
+```
+GRAPH.QUERY movies "MATCH (n) RETURN n"
+GRAPH.QUERY movies "MATCH (n) WHERE ID(n) = 1  RETURN n"
+```

data/Gemfile

@@ -8,6 +8,6 @@ gemspec
 gem "rake", "~> 13.0"
 
 gem "minitest", "~> 5.0"
+gem "minitest-focus", "~> 1.4.0"
 gem "pry", "~> 0.14.0"
 gem "simplecov", "~> 0.21.2"
-

data/Gemfile.lock

@@ -1,50 +1,65 @@
 PATH
   remote: .
   specs:
-    redgraph (0.2.1)
+    redgraph (0.2.3)
       activesupport (>= 3.0.0)
       redis (~> 4)
 
 GEM
   remote: https://rubygems.org/
   specs:
-    activesupport (6.1.3.1)
+    activesupport (7.1.2)
+      base64
+      bigdecimal
       concurrent-ruby (~> 1.0, >= 1.0.2)
+      connection_pool (>= 2.2.5)
+      drb
       i18n (>= 1.6, < 2)
       minitest (>= 5.1)
+      mutex_m
       tzinfo (~> 2.0)
-      zeitwerk (~> 2.3)
+    base64 (0.2.0)
+    bigdecimal (3.1.5)
     coderay (1.1.3)
-    concurrent-ruby (1.1.8)
+    concurrent-ruby (1.2.2)
+    connection_pool (2.4.1)
     docile (1.3.5)
-    i18n (1.8.10)
+    drb (2.2.0)
+      ruby2_keywords
+    i18n (1.14.1)
       concurrent-ruby (~> 1.0)
     method_source (1.0.0)
     minitest (5.14.4)
+    minitest-focus (1.4.0)
+      minitest (>= 4, < 6)
+    mutex_m (0.2.0)
     pry (0.14.0)
       coderay (~> 1.1)
       method_source (~> 1.0)
     rake (13.0.3)
-    redis (4.2.5)
+    redis (4.8.1)
+    ruby2_keywords (0.0.5)
     simplecov (0.21.2)
       docile (~> 1.1)
       simplecov-html (~> 0.11)
       simplecov_json_formatter (~> 0.1)
     simplecov-html (0.12.3)
     simplecov_json_formatter (0.1.2)
-    tzinfo (2.0.4)
+    tzinfo (2.0.6)
       concurrent-ruby (~> 1.0)
-    zeitwerk (2.4.2)
 
 PLATFORMS
+  arm64-darwin-21
+  arm64-darwin-23
   x86_64-darwin-20
 
 DEPENDENCIES
   minitest (~> 5.0)
+  minitest-focus (~> 1.4.0)
   pry (~> 0.14.0)
   rake (~> 13.0)
   redgraph!
   simplecov (~> 0.21.2)
 
 BUNDLED WITH
-   2.2.15
+   2.2.22

data/README.md

@@ -5,6 +5,18 @@
 
 A simple RedisGraph library. This gem owes **a lot** to the existing [redisgraph-rb](https://github.com/RedisGraph/redisgraph-rb) gem, but tries to provide a friendlier interface, similar to the existing [Python](https://github.com/RedisGraph/redisgraph-py) and [Elixir](https://github.com/crflynn/redisgraph-ex) clients.
 
+## July 2023 update:
+
+Sadly RedisGraph is no longer in active development. More info [here](https://redis.com/blog/redisgraph-eol/).
+
+## Nov 2023 update:
+
+There is an active fork, [FalkorDB](https://github.com/FalkorDB/FalkorDB/). AFAIK at this time there are no arm64 builds available.
+
+## Dec 2023 update:
+
+FalkorDB has arm64 builds now.
+
 ## Installation
 
 Add this line to your application's Gemfile:
@@ -36,13 +48,20 @@ Create a couple nodes:
 
 ```ruby
 actor = Redgraph::Node.new(label: 'actor', properties: {name: "Al Pacino"})
-=> #<Redgraph::Node:0x00007f8d5f95cf88 @label="actor", @properties={:name=>"Al Pacino"}>
+=> #<Redgraph::Node:0x00007fce3baa0580 @id=nil, @labels=["actor"], @properties={"name"=>"Al Pacino"}>
 graph.add_node(actor)
-=> #<Redgraph::Node:0x00007f8d5f95cf88 @id=0, @label="actor", @properties={:name=>"Al Pacino"}>
+=> #<Redgraph::Node:0x00007fce3baa0580 @id=0, @labels=["actor"], @properties={"name"=>"Al Pacino"}>
 film = Redgraph::Node.new(label: 'film', properties: {name: "Scarface"})
-=> #<Redgraph::Node:0x00007f8d5f85ccc8 @label="film", @properties={:name=>"Scarface"}>
+=> #<Redgraph::Node:0x00007fce3e8c6c48 @id=nil, @labels=["film"], @properties={"name"=>"Scarface"}>
 graph.add_node(film)
-=> #<Redgraph::Node:0x00007f8d5f85ccc8 @id=1, @label="film", @properties={:name=>"Scarface"}>
+=> #<Redgraph::Node:0x00007fce3e8c6c48 @id=1, @labels=["film"], @properties={"name"=>"Scarface"}>
+```
+
+Nodes might have multiple labels, although they're not supported by RedisGraph yet (you can track the feature progress [here](https://github.com/RedisGraph/RedisGraph/pull/1561)):
+
+```ruby
+item = Redgraph::Node.new(labels: ['film', 'drama'], properties: {name: "Casino"})
+=> #<Redgraph::Node:0x00007fce3bc73308 @id=nil, @labels=["film", "drama"], @properties={"name"=>"Casino"}>
 ```
 
 Create an edge between those nodes:
@@ -50,7 +69,7 @@ Create an edge between those nodes:
 ```ruby
 edge = Redgraph::Edge.new(src: actor, dest: film, type: 'ACTOR_IN', properties: {role: "Tony Montana"})
 => #<Redgraph::Edge:0x00007f8d5f9ae3d8 @dest=#<Redgraph::Node:0x00007f8d5f85ccc8 @id=1, @label="film", @properties={:name=>"Scarface"}>, @dest_id=1, @properties={:role=>"Tony Montana"}, @src=#<Redgraph::Node:0x00007f8d5f95cf88 @id=0, @label="actor", @properties={:name=>"Al Pacino"}>, @src_id=0, @type="ACTOR_IN">
-@graph.add_edge(edge)
+graph.add_edge(edge)
 => #<Redgraph::Edge:0x00007f8d5f9ae3d8 @dest=#<Redgraph::Node:0x00007f8d5f85ccc8 @id=1, @label="film", @properties={:name=>"Scarface"}>, @dest_id=1, @id=0, @properties={:role=>"Tony Montana"}, @src=#<Redgraph::Node:0x00007f8d5f95cf88 @id=0, @label="actor", @properties={:name=>"Al Pacino"}>, @src_id=0, @type="ACTOR_IN">
 ```
 
@@ -64,52 +83,52 @@ graph.merge_node(film)
 Same with edges:
 
 ```ruby
-@graph.merge_edge(edge)
+graph.merge_edge(edge)
 => #<Redgraph::Edge:0x00007f8d5f9ae3d8 @dest=#<Redgraph::Node:0x00007f8d5f85ccc8 @id=1, @label="film", @properties={:name=>"Scarface"}>, @dest_id=1, @id=0, @properties={:role=>"Tony Montana"}, @src=#<Redgraph::Node:0x00007f8d5f95cf88 @id=0, @label="actor", @properties={:name=>"Al Pacino"}>, @src_id=0, @type="ACTOR_IN">
 ```
 
 Find a node by id:
 
 ```ruby
-@graph.find_node_by_id(1)
+graph.find_node_by_id(1)
 => #<Redgraph::Node:0x00007f8d5c2c6e88 @id=1, @label="film", @properties={"name"=>"Scarface"}>
 ```
 
 To get all nodes:
 
 ```ruby
-@graph.nodes
+graph.nodes
 => [#<Redgraph::Node:0x00007f8d5c2ee0a0 @id=0, @label="actor", @properties={"name"=>"Al Pacino"}>, #<Redgraph::Node:0x00007f8d5c2edfd8 @id=1, @label="film", @properties={"name"=>"Scarface"}>]
 ```
 
 Optional filters that can be combined:
 
 ```ruby
-@graph.nodes(label: 'actor')
-@graph.nodes(properties: {name: "Al Pacino"})
-@graph.nodes(limit: 10, skip: 20)
+graph.nodes(label: 'actor')
+graph.nodes(properties: {name: "Al Pacino"})
+graph.nodes(limit: 10, skip: 20)
 ```
 
 Counting nodes
 
 ```ruby
-@graph.count_nodes(label: 'actor')
+graph.count_nodes(label: 'actor')
 => 1
 ```
 
 Getting edges:
 
 ```ruby
-@graph.edges
-@graph.edges(src: actor, dest: film)
-@graph.edges(kind: 'FRIEND_OF', limit: 10, skip: 20)
-@graph.count_edges
+graph.edges
+graph.edges(src: actor, dest: film)
+graph.edges(kind: 'FRIEND_OF', limit: 10, skip: 20)
+graph.count_edges
 ```
 
 Running custom queries
 
 ```ruby
-@graph.query("MATCH (src)-[edge:FRIEND_OF]->(dest) RETURN src, edge")
+graph.query("MATCH (src)-[edge:FRIEND_OF]->(dest) RETURN src, edge")
 ```
 
 ### NodeModel
@@ -129,7 +148,7 @@ And this will give you stuff such as
 ```ruby
 Actor.count
 john = Actor.new(name: "John Travolta")
-john.add_to_graph # Will add the node to the graph
+john.add_to_graph
 john.add_relation(type: "ACTED_IN", node: film, properties: {role: "Tony Manero"})
 john.reload
 john.destroy
@@ -145,6 +164,10 @@ Actor.query("MATCH (node) RETURN node ORDER BY node.name")
 ```
 And the result rows object will be instances of the classes defined by the `_type` attribute.
 
+### Notifications
+
+You can optionally subscribe to `redgraph.query` ActiveSupport notifications.
+
 ## Development
 
 After checking out the repo, run `bin/setup` to install dependencies. Then, run 
@@ -159,6 +182,22 @@ You can also run `bin/console` for an interactive prompt that will allow you to
 
 To install this gem onto your local machine, run `bundle exec rake install`.
 
+### Installing RedisGraph
+
+If you're using an Apple silicon mac you might want to use the docker image: I've had issues compiling the module (OpenMP problems). Just do a:
+
+    docker run -p 6380:6379 -it --rm redislabs/redisgraph
+
+or, to try FalkorDB
+
+    docker run -p 6380:6379 -it --rm falkordb/falkordb:edge
+
+and then
+
+    TEST_REDIS_URL=redis://localhost:6380/0 be rake test
+
+I'm using port 6380 to not interphere with the other redis instance.
+
 ## Contributing
 
 Bug reports and pull requests are welcome on GitHub at https://github.com/pzac/redgraph.

data/lib/redgraph/graph.rb

@@ -19,7 +19,7 @@ module Redgraph
       @graph_name = graph_name
       @connection = Redis.new(redis_options)
       @module_version = module_version
-      raise ServerError unless @module_version
+      raise ServerError, "Can't find RedisGraph module" unless @module_version
     end
 
     # Returns the version of the RedisGraph module
@@ -99,7 +99,11 @@ module Redgraph
     private
 
     def _query(cmd)
-      data = @connection.call("GRAPH.QUERY", graph_name, cmd, "--compact")
+      data = nil
+      query = ["GRAPH.QUERY", graph_name, cmd, "--compact"]
+      ActiveSupport::Notifications.instrument(NOTIFICATIONS_KEY, query: query.join(' ')) do
+        data = @connection.call(*query)
+      end
       QueryResponse.new(data, self)
     end
   end

data/lib/redgraph/node.rb

@@ -4,14 +4,19 @@ module Redgraph
   class Node
     include Util
 
-    attr_accessor :id, :label, :properties
+    attr_accessor :id, :labels, :properties
 
-    def initialize(label: nil, properties: nil, id: nil)
+    def initialize(label: nil, properties: nil, id: nil, labels: nil)
       @id = id
-      @label = label
+      raise(Error, "You can either define a single label or a label array") if label && labels
+      @labels = labels || (label ? [label] : [])
       @properties = (properties || {}).with_indifferent_access
     end
 
+    def label
+      labels.first
+    end
+
     def persisted?
       id.present?
     end
@@ -21,7 +26,7 @@ module Redgraph
     end
 
     def to_query_string(item_alias: 'node')
-      _label = ":#{label}" if label
+      _label = labels.map {|l| ":`#{l}`"}.join
       "(#{item_alias}#{_label} #{properties_to_string(properties)})"
     end
   end

data/lib/redgraph/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Redgraph
-  VERSION = "0.2.1"
+  VERSION = "0.2.3"
 end

data/lib/redgraph.rb

@@ -4,6 +4,8 @@ require "active_support/core_ext/hash/indifferent_access"
 require "active_support/core_ext/object/blank"
 require "active_support/core_ext/string/inflections"
 require "active_support/concern"
+require 'active_support/notifications'
+require 'active_support/isolated_execution_state'
 
 require_relative "redgraph/version"
 require_relative "redgraph/util"
@@ -14,6 +16,8 @@ require_relative "redgraph/query_response"
 require_relative "redgraph/node_model"
 
 module Redgraph
+  NOTIFICATIONS_KEY = "redgraph.query".freeze
+
   class Error < StandardError; end
   class ServerError < Error; end
   class MissingAliasPrefixError < Error

data/test/graph_node_methods_test.rb

@@ -26,7 +26,7 @@ class GraphNodeMethodsTest < Minitest::Test
   end
 
   def test_find_node_by_wrong_id
-    node = @graph.find_node_by_id("-1")
+    node = @graph.find_node_by_id(999999)
 
     assert_nil(node)
   end

data/test/graph_queries_test.rb

@@ -42,4 +42,15 @@ class GraphQueriesTest < Minitest::Test
     result = @graph.query("MATCH (src)-[edge:FRIEND_OF]->(dest) RETURN src, edge")
     assert_equal([[@al, edge]], result)
   end
+
+  def test_query_notifications
+    payload = nil
+    subscription = ActiveSupport::Notifications.subscribe Redgraph::NOTIFICATIONS_KEY do |name, start, finish, id, _payload|
+      payload = _payload
+    end
+
+    query = "MATCH (n) RETURN n.name ORDER BY n.name"
+    result = @graph.query(query)
+    assert_includes(payload[:query], query)
+  end
 end

data/test/node_model_class_methods_test.rb

@@ -65,7 +65,7 @@ class NodeModelClassMethodsTest < Minitest::Test
 
   def test_find_bad_id
     quick_add_node(label: 'actor', properties: {name: "Al Pacino"})
-    item = Actor.find("-1")
+    item = Actor.find(999999)
     assert_nil(item)
   end
 

data/test/node_test.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+require "test_helper"
+
+class NodeTest < Minitest::Test
+  def test_single_labels
+    node = Redgraph::Node.new(label: "film")
+    assert_equal(["film"], node.labels)
+    assert_equal("film", node.label)
+  end
+
+  def test_multiple_labels
+    node = Redgraph::Node.new(labels: ["film", "drama"])
+    assert_equal(["film", "drama"], node.labels)
+    assert_equal("film", node.label)
+  end
+
+  def test_conflicting_labels
+    assert_raises(Redgraph::Error) do
+      Redgraph::Node.new(labels: ["film", "drama"], label: "film")
+    end
+  end
+end

data/test/test_helper.rb

@@ -13,10 +13,12 @@ $LOAD_PATH.unshift File.expand_path("../lib", __dir__)
 require "redgraph"
 
 require "minitest/autorun"
+require "minitest/focus"
 require "pry"
 
 unless $REDIS_URL = ENV['TEST_REDIS_URL']
-  puts "To run the tests you need to define the TEST_REDIS_URL environment variable"
+  puts "To run the tests you need to define the TEST_REDIS_URL environment variable. Ex:"
+  puts "  TEST_REDIS_URL=redis://localhost:6379/0"
   exit(1)
 end
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: redgraph
 version: !ruby/object:Gem::Version
-  version: 0.2.1
+  version: 0.2.3
 platform: ruby
 authors:
 - Paolo Zaccagnini
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-04-23 00:00:00.000000000 Z
+date: 2023-12-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: redis
@@ -45,9 +45,11 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- ".github/workflows/main.yml"
+- ".github/workflows/tests-falkordb.yml"
+- ".github/workflows/tests-redisgraph.yml"
 - ".gitignore"
 - CHANGELOG.md
+- CHEATSHEET.md
 - Gemfile
 - Gemfile.lock
 - LICENSE.txt
@@ -79,6 +81,7 @@ files:
 - test/node_model_labels_test.rb
 - test/node_model_persistence_test.rb
 - test/node_model_test.rb
+- test/node_test.rb
 - test/redgraph_test.rb
 - test/test_helper.rb
 homepage: https://github.com/pzac/redgraph
@@ -103,7 +106,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.3
+rubygems_version: 3.4.10
 signing_key:
 specification_version: 4
 summary: A simple RedisGraph client