redgraph 0.1.1 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: '0171849182c559f603bf4e09d1cb17eb5a3a4e3d95ddf8e6f1853434c0fc9380'
-  data.tar.gz: 7bdff0a775ebeffffe6b842b07a990292d351ee477c4aa2ef8ec492806a0b048
+  metadata.gz: ba5feef26cde1b47f2da53277c18c3c234ce12f85f315e761c865135b60857b4
+  data.tar.gz: 1cb82a481b616ee4347a52347405155da600c176696de4ccb3efea97076b196d
 SHA512:
-  metadata.gz: 53de618a85999bd837e1fabb458c204ac7e0f783425cef8f1d0c07e810c33f580c41d9fd8bf124015970618d6c905c8945020c06a382ae2f692384d0df856482
-  data.tar.gz: 66866ac946e4b7456684e26587bfcec17eec93de0e4c84bc6827ee77f1f712adce2b895fc38138522c0635fe2ade930a5606e3f638eaec8ab10afc71879e612e
+  metadata.gz: 60ee0fdcb153873a42acfd40534c76db63dae469e680ed949544f15301f51ed3027a87d2fa7c1583a781c7d8077ec3fec4baf62746e86f5937f56bb9355f6941
+  data.tar.gz: cfa1a6bdc454adb49bb6537d7e1b4662de0e5e68f71611045f9d11b3719531f37c883df6f7fd4aa41061bea464d1d78e4f7b559bc19bfa7aa14031d97d8f0bb2

data/CHANGELOG.md

@@ -1,3 +1,9 @@
+## [0.1.2] - 2021-04-12
+
+- Add Graph#relationship_types
+- Add Graph#count_nodes
+- Add Graph#edges
+
 ## [0.1.1] - 2021-04-11
 
 - Graph#nodes:

data/Gemfile

@@ -9,3 +9,5 @@ gem "rake", "~> 13.0"
 
 gem "minitest", "~> 5.0"
 gem "pry", "~> 0.14.0"
+gem "simplecov", "~> 0.21.2"
+

data/Gemfile.lock

@@ -1,13 +1,14 @@
 PATH
   remote: .
   specs:
-    redgraph (0.1.1)
+    redgraph (0.1.2)
       redis (~> 4)
 
 GEM
   remote: https://rubygems.org/
   specs:
     coderay (1.1.3)
+    docile (1.3.5)
     method_source (1.0.0)
     minitest (5.14.4)
     pry (0.14.0)
@@ -15,6 +16,12 @@ GEM
       method_source (~> 1.0)
     rake (13.0.3)
     redis (4.2.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)
 
 PLATFORMS
   x86_64-darwin-20
@@ -24,6 +31,7 @@ DEPENDENCIES
   pry (~> 0.14.0)
   rake (~> 13.0)
   redgraph!
+  simplecov (~> 0.21.2)
 
 BUNDLED WITH
    2.2.15

data/README.md

@@ -20,6 +20,8 @@ Or install it yourself as:
 
 ## Usage
 
+The gem assumes you have a recent version of [RedisGraph](https://oss.redislabs.com/redisgraph/) up and running.
+
 Basic usage:
 
     graph = Redgraph::Graph.new('movies', url: "redis://localhost:6379/1")
@@ -44,10 +46,21 @@ To get all nodes:
 
     @graph.nodes
 
-Optional filters:
+Optional filters that can be combined:
 
     @graph.nodes(label: 'actor')
     @graph.nodes(properties: {name: "Al Pacino"})
+    @graph.nodes(limit: 10, skip: 20)
+
+Counting nodes
+
+    @graph.count_nodes(label: 'actor')
+
+Getting edges:
+
+    @graph.edges
+    @graph.edges(src: actor, dest: film)
+    @graph.edges(kind: 'FRIEND_OF', limit: 10, skip: 20)
 
 ## Development
 
@@ -55,7 +68,7 @@ After checking out the repo, run `bin/setup` to install dependencies. Then, run
 
     TEST_REDIS_URL=YOUR-REDIS-URL rake test
 
-to run the tests.
+to run the tests. Test coverage will be enabled if you set the `COVERAGE` environment variable to any value.
 
 You can use a `TEST_REDIS_URL` such as `redis://localhost:6379/1`. Make sure you're not overwriting important databases.
 
@@ -63,8 +76,6 @@ 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`.
 
-Run `bin/console` for an interactive prompt.
-
 ## Contributing
 
 Bug reports and pull requests are welcome on GitHub at https://github.com/pzac/redgraph.

data/lib/redgraph/edge.rb

@@ -4,7 +4,7 @@ module Redgraph
   class Edge
     attr_accessor :id, :src, :dest, :type, :properties
 
-    def initialize(src:, dest:, type:, properties: {})
+    def initialize(src: nil, dest: nil, type: nil, properties: {})
       @src = src
       @dest = dest
       @type = type
@@ -14,5 +14,9 @@ module Redgraph
     def persisted?
       !id.nil?
     end
+
+    def ==(other)
+      super || other.instance_of?(self.class) && !id.nil? && other.id == id
+    end
   end
 end

data/lib/redgraph/graph.rb

@@ -49,6 +49,13 @@ module Redgraph
       result.resultset.map(&:values).flatten
     end
 
+    # Returns an array of existing relationship types
+    #
+    def relationship_types
+      result = query("CALL db.relationshipTypes()")
+      result.resultset.map(&:values).flatten
+    end
+
     # Adds a node. If successul it returns the created object, otherwise false
     #
     def add_node(node)
@@ -90,18 +97,25 @@ module Redgraph
       result = query(cmd)
 
       result.resultset.map do |item|
-        (node_id, labels, props) = item["node"]
-        attrs = {}
-
-        props.each do |(index, type, value)|
-          attrs[get_property(index)] = value
-        end
-        Node.new(label: get_label(labels.first), properties: attrs).tap do |node|
-          node.id = node_id
-        end
+        node_from_resultset_item(item["node"])
       end
     end
 
+    # Counts nodes. Options:
+    #
+    # - label: filter by label
+    # - properties: filter by properties
+    #
+    def count_nodes(label: nil, properties: nil)
+      _label = ":`#{label}`" if label
+      _props = quote_hash(properties) if properties
+
+      cmd = "MATCH (node#{_label} #{_props}) RETURN COUNT(node)"
+      result = query(cmd)
+
+      result.resultset.first["COUNT(node)"]
+    end
+
     # Adds an edge. If successul it returns the created object, otherwise false
     #
     def add_edge(edge)
@@ -114,6 +128,45 @@ module Redgraph
       edge
     end
 
+    # Finds edges. Options:
+    #
+    # - type
+    # - src
+    # - dest
+    # - properties
+    # - limit
+    # - skip
+    #
+    def edges(type: nil, src: nil, dest: nil, properties: nil, limit: nil, skip: nil)
+      _type = ":`#{type}`" if type
+      _props = quote_hash(properties) if properties
+      _limit = "LIMIT #{limit}" if limit
+      _skip = "SKIP #{skip}" if skip
+
+      _where = if src || dest
+        clauses = [
+          ("ID(src) = #{src.id}" if src),
+          ("ID(dest) = #{dest.id}" if dest)
+        ].compact.join(" AND ")
+        "WHERE #{clauses}"
+      end
+
+      cmd = "MATCH (src)-[edge#{_type} #{_props}]->(dest) #{_where}
+             RETURN src, edge, dest #{_skip} #{_limit}"
+      result = query(cmd)
+
+      result.resultset.map do |item|
+        src = node_from_resultset_item(item["src"])
+        dest = node_from_resultset_item(item["dest"])
+        edge = edge_from_resultset_item(item["edge"])
+
+        edge.src = src
+        edge.dest = dest
+
+        edge
+      end
+    end
+
     private
 
     def query(cmd)
@@ -130,8 +183,9 @@ module Redgraph
     def escape_value(x)
       case x
       when Integer then x
+      when NilClass then "''"
       else
-        "'#{x}'"
+        '"' + x.gsub('"', '\"') + '"'
       end
     end
 
@@ -144,5 +198,39 @@ module Redgraph
       @properties ||= properties
       @properties[id] || (@properties = properties)[id]
     end
+
+    def get_relationship_type(id)
+      @relationship_types ||= relationship_types
+      @relationship_types[id] || (@relationship_types = relationship_types)[id]
+    end
+
+    # Builds a Node object from the raw data
+    #
+    def node_from_resultset_item(item)
+      (node_id, labels, props) = item
+      attrs = {}
+
+      props.each do |(index, type, value)|
+        attrs[get_property(index)] = value
+      end
+      Node.new(label: get_label(labels.first), properties: attrs).tap do |node|
+        node.id = node_id
+      end
+    end
+
+    def edge_from_resultset_item(item)
+      (edge_id, type_id, _src_id, _dest_id, props) = item
+      attrs = {}
+
+      props.each do |(index, type, value)|
+        attrs[get_property(index)] = value
+      end
+
+      Edge.new.tap do |edge|
+        edge.id = edge_id
+        edge.type = get_relationship_type(type_id)
+        edge.properties = attrs
+      end
+    end
   end
 end

data/lib/redgraph/version.rb

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

data/redgraph.gemspec

@@ -15,7 +15,7 @@ Gem::Specification.new do |spec|
 
   spec.metadata["homepage_uri"] = spec.homepage
   spec.metadata["source_code_uri"] = spec.homepage
-  spec.metadata["changelog_uri"] = "#{spec.homepage}/CHANGELOG.md"
+  spec.metadata["changelog_uri"] = "#{spec.homepage}/blob/master/CHANGELOG.md"
 
   spec.files = Dir.chdir(File.expand_path(__dir__)) do
     `git ls-files -z`.split("\x0")

data/test/graph_manipulation_test.rb

@@ -17,6 +17,35 @@ class GraphManipulationTest < Minitest::Test
     assert_predicate result, :persisted?
   end
 
+  def test_add_node_with_special_chars
+    [
+      "apo'str",
+      "two''apos",
+      "Foø'bÆ®",
+      "aa\nbb",
+      'aaa "bbb" ccc'
+    ].each do |name|
+
+      node = Redgraph::Node.new(label: 'actor', properties: {name: name})
+      result = @graph.add_node(node)
+      assert_predicate result, :persisted?
+
+      item = @graph.find_node_by_id(node.id)
+
+      assert_equal(name, item.properties["name"])
+    end
+  end
+
+  def test_add_node_with_nil_value
+    node = Redgraph::Node.new(label: 'actor', properties: {name: nil})
+    result = @graph.add_node(node)
+    assert_predicate result, :persisted?
+
+    item = @graph.find_node_by_id(node.id)
+
+    assert_equal("", item.properties["name"])
+  end
+
   def test_add_edge
     actor = Redgraph::Node.new(label: 'actor', properties: {name: "Al Pacino"})
     @graph.add_node(actor)

data/test/graph_queries_test.rb

@@ -62,6 +62,17 @@ class GraphQueriesTest < Minitest::Test
     assert_includes(dramas, casino)
   end
 
+  def test_count_nodes
+    quick_add_node(label: 'film', properties: {name: "Scarface", genre: "drama"})
+    quick_add_node(label: 'film', properties: {name: "Casino", genre: "drama"})
+    quick_add_node(label: 'film', properties: {name: "Mamma Mia", genre: "musical"})
+
+
+    assert_equal(5, @graph.count_nodes)
+    assert_equal(3, @graph.count_nodes(label: 'film'))
+    assert_equal(2, @graph.count_nodes(properties: {genre: "drama"}))
+  end
+
   def test_limit_nodes
     10.times do |i|
       quick_add_node(label: 'token', properties: {number: i})
@@ -82,9 +93,73 @@ class GraphQueriesTest < Minitest::Test
     assert_equal([3,4,5], items.map{|item| item.properties["number"]})
   end
 
+  def test_find_edge
+    quick_add_edge(type: 'FRIEND_OF', src: @al, dest: @john, properties: {since: 1980})
+    edge = @graph.edges.first
+
+    assert_equal('FRIEND_OF', edge.type)
+    assert_equal(1980, edge.properties["since"])
+    assert_equal(@al, edge.src)
+    assert_equal(@john, edge.dest)
+
+  end
+
+  def test_find_all_edges
+    marlon = quick_add_node(label: 'actor', properties: {name: "Marlon Brando"})
+    film = quick_add_node(label: 'film', properties: {name: "The Godfather"})
+    quick_add_edge(type: 'ACTOR_IN', src: marlon, dest: film, properties: {role: 'Don Vito'})
+    quick_add_edge(type: 'ACTOR_IN', src: @al,    dest: film, properties: {role: 'Michael'})
+
+    edges = @graph.edges
+    assert_equal(2, edges.size)
+  end
+
+  def test_filter_edges
+    marlon = quick_add_node(label: 'actor', properties: {name: "Marlon Brando"})
+    film = quick_add_node(label: 'film', properties: {name: "The Godfather"})
+    other_film = quick_add_node(label: 'film', properties: {name: "Carlito's Way"})
+    e_donvito = quick_add_edge(type: 'ACTOR_IN', src: marlon, dest: film, properties: {role: 'Don Vito'})
+    e_michael = quick_add_edge(type: 'ACTOR_IN', src: @al, dest: film, properties: {role: 'Michael'})
+    e_carlito = quick_add_edge(type: 'ACTOR_IN', src: @al, dest: other_film, properties: {role: 'Carlito'})
+    quick_add_edge(type: 'FRIEND_OF', src: @al, dest: marlon, properties: {since: 1980})
+
+    edges = @graph.edges(type: "FRIEND_OF")
+    assert_equal(1, edges.size)
+
+    edges = @graph.edges(type: "ACTOR_IN")
+    assert_equal(3, edges.size)
+
+    edges = @graph.edges(type: "ACTOR_IN", limit: 2)
+    assert_equal(2, edges.size)
+
+    edges = @graph.edges(type: "ACTOR_IN", skip: 2, limit: 10)
+    assert_equal(1, edges.size)
+
+    edges = @graph.edges(properties: {role: "Carlito"})
+    assert_equal([e_carlito], edges)
+
+    edges = @graph.edges(src: marlon)
+    assert_equal([e_donvito], edges)
+
+    edges = @graph.edges(type: 'ACTOR_IN', dest: film)
+    assert_equal(2, edges.size)
+    assert_includes(edges, e_donvito)
+    assert_includes(edges, e_michael)
+
+    edges = @graph.edges(src: @al, dest: marlon)
+    assert_equal(1, edges.size)
+    edge = edges[0]
+    assert_equal('FRIEND_OF', edge.type)
+    assert_equal(1980, edge.properties["since"])
+  end
+
   private
 
   def quick_add_node(label:, properties:)
     @graph.add_node(Redgraph::Node.new(label: label, properties: properties))
   end
+
+  def quick_add_edge(type:, src:, dest:, properties:)
+    @graph.add_edge(Redgraph::Edge.new(type: type, src: src, dest: dest, properties: properties))
+  end
 end

data/test/graph_test.rb

@@ -42,6 +42,19 @@ class GraphTest < Minitest::Test
     assert_equal(["name", "age"], @graph.properties)
   end
 
+  def test_relationship_types
+    @graph = create_sample_graph("foobar")
+
+    actor = Redgraph::Node.new(label: "actor", properties: {"name": "Harrison Ford"})
+    @graph.add_node(actor)
+    film = Redgraph::Node.new(label: "film", properties: {"name": "Star Wars"})
+    @graph.add_node(film)
+    edge = Redgraph::Edge.new(type: "ACTED_IN", src: actor, dest: film)
+    @graph.add_edge(edge)
+
+    assert_equal(["ACTED_IN"], @graph.relationship_types)
+  end
+
   private
 
   def create_sample_graph(name)

data/test/test_helper.rb

@@ -1,5 +1,14 @@
 # frozen_string_literal: true
 
+if ENV['COVERAGE']
+  require 'simplecov'
+
+  SimpleCov.start do
+    enable_coverage :branch
+    add_filter %r{^/test/}
+  end
+end
+
 $LOAD_PATH.unshift File.expand_path("../lib", __dir__)
 require "redgraph"
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: redgraph
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.2
 platform: ruby
 authors:
 - Paolo Zaccagnini
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-04-11 00:00:00.000000000 Z
+date: 2021-04-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: redis
@@ -60,7 +60,7 @@ licenses:
 metadata:
   homepage_uri: https://github.com/pzac/redgraph
   source_code_uri: https://github.com/pzac/redgraph
-  changelog_uri: https://github.com/pzac/redgraph/CHANGELOG.md
+  changelog_uri: https://github.com/pzac/redgraph/blob/master/CHANGELOG.md
 post_install_message:
 rdoc_options: []
 require_paths: