redgraph 0.2.1 → 0.2.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2fd53776ff217146cd6ca4924da40a43f5bf929fad03b73b79f32d371ea955e8
-  data.tar.gz: 551afc973f8e732ad532e74395e6c73251f14d68db73f667a207b234bd64163b
+  metadata.gz: 8b51ea5b1c1c11aab62f08cfe08508130f65def1a3b527ddcaf9419140c4e12a
+  data.tar.gz: 6518c572f6a4c14c733653acf1282c9b8473a8737b028a5695f93f953766f0bd
 SHA512:
-  metadata.gz: dd7f88ae09acb7f09b6c8de949d4f31bbc52b12e4b914f035de99c7cd9b409c14eac3e592f834cc968517b796fed0cf3a085f7eba4915e630b2e66c424ae9870
-  data.tar.gz: 979aac39193d3150441ddf5baca14772a35c6cfd00f09df42752277aed3d955869822b2d97150209f1e71ad5ab95e566dc645d15d3e8262675dd858bd6fbb1dd
+  metadata.gz: 634966fdde2e4567654b9a2d3e77eb77b26b8d1c8def562deeef8015d0b798ef8c7a9dd993dd15eabeeac4e2cc32013b748649c3f599dcc524742edd67d0b252
+  data.tar.gz: 9dba064e18ded1c51b80eca7d17cf487e1748b31fcbc18be656d57dcbe70954c563f3e7ee7bcd6ed847e4d9e170b40c0a498007980642349f1a4aa1ba5f0c706

data/CHANGELOG.md

@@ -1,3 +1,8 @@
+## [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/Gemfile.lock

@@ -1,23 +1,22 @@
 PATH
   remote: .
   specs:
-    redgraph (0.2.1)
+    redgraph (0.2.2)
       activesupport (>= 3.0.0)
       redis (~> 4)
 
 GEM
   remote: https://rubygems.org/
   specs:
-    activesupport (6.1.3.1)
+    activesupport (7.0.3)
       concurrent-ruby (~> 1.0, >= 1.0.2)
       i18n (>= 1.6, < 2)
       minitest (>= 5.1)
       tzinfo (~> 2.0)
-      zeitwerk (~> 2.3)
     coderay (1.1.3)
-    concurrent-ruby (1.1.8)
+    concurrent-ruby (1.1.10)
     docile (1.3.5)
-    i18n (1.8.10)
+    i18n (1.10.0)
       concurrent-ruby (~> 1.0)
     method_source (1.0.0)
     minitest (5.14.4)
@@ -25,7 +24,7 @@ GEM
       coderay (~> 1.1)
       method_source (~> 1.0)
     rake (13.0.3)
-    redis (4.2.5)
+    redis (4.6.0)
     simplecov (0.21.2)
       docile (~> 1.1)
       simplecov-html (~> 0.11)
@@ -34,9 +33,9 @@ GEM
     simplecov_json_formatter (0.1.2)
     tzinfo (2.0.4)
       concurrent-ruby (~> 1.0)
-    zeitwerk (2.4.2)
 
 PLATFORMS
+  arm64-darwin-21
   x86_64-darwin-20
 
 DEPENDENCIES
@@ -47,4 +46,4 @@ DEPENDENCIES
   simplecov (~> 0.21.2)
 
 BUNDLED WITH
-   2.2.15
+   2.2.22

data/README.md

@@ -36,13 +36,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 +57,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 +71,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 +136,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
@@ -159,6 +166,15 @@ 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
+    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

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.2"
 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
+      node = Redgraph::Node.new(labels: ["film", "drama"], label: "film")
+    end
+  end
+end

data/test/test_helper.rb

@@ -16,7 +16,8 @@ require "minitest/autorun"
 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.2
 platform: ruby
 authors:
 - Paolo Zaccagnini
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-04-23 00:00:00.000000000 Z
+date: 2022-05-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: redis
@@ -79,6 +79,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 +104,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.3
+rubygems_version: 3.2.22
 signing_key:
 specification_version: 4
 summary: A simple RedisGraph client