red_grape 0.0.6 → 0.0.7

data/README.md

@@ -4,14 +4,14 @@
 
 ## Description:
 
-redGrape is an in-memory graph database written in ruby. I made this in order to learn how graph databases work so that please do not use this for any serious purpose.
+redGrape is an in-memory graph database written in ruby. I made this application in order to learn how a graph database works so that please do not use this for any serious purpose.
 
 ## Features/Problems:
 
 * REPL
 * load GraphML
 * construct a graph programmatically
-* traverse nodes and edges
+* traverse nodes and edges using a gremlin-like DSL
 
 ## Synopsis:
 
@@ -30,35 +30,35 @@ redGrape is an in-memory graph database written in ruby. I made this in order to
            oOOOo
             oOo
     -------- O --------
-    ruby :001 > g = RedGrape.create_tinker_graph
+    irb(main):001:0> g = RedGrape.create_tinker_graph
      => redgrape[vertices:6 edges:6] 
-    ruby :002 > g.class
+    irb(main):002:0> g.class
      => RedGrape::Graph 
-    ruby :003 > g.V
+    irb(main):003:0> g.V
      => [v[1], v[2], v[3], v[4], v[5], v[6]] 
-    ruby :004 > g.V.name
+    irb(main):004:0> g.V.name
      => ["marko", "vadas", "lop", "josh", "ripple", "peter"] 
-    ruby :005 > g.E
+    irb(main):005:0> g.E
      => [e[7][1-knows->2], e[8][1-knows->4], e[9][1-created->3], e[10][4-created->5], e[11][4-created->3], e[12][6-created->3]] 
-    ruby :006 > v = g.v(1)
+    irb(main):006:0> v = g.v(1)
      => v[1] 
-    ruby :007 > "#{v.name} is #{v.age} years old."
+    irb(main):007:0> "#{v.name} is #{v.age} years old."
      => "marko is 29 years old." 
-    ruby :008 > v.out
+    irb(main):008:0> v.out
      => [v[2], v[4], v[3]] 
-    ruby :009 > v.out('knows')
+    irb(main):009:0> v.out('knows')
      => [v[2], v[4]] 
-    ruby :010 > v.outE
+    irb(main):010:0> v.outE
      => [e[7][1-knows->2], e[8][1-knows->4], e[9][1-created->3]] 
-    ruby :011 > v.outE('knows')
+    irb(main):011:0> v.outE('knows')
      => [e[7][1-knows->2], e[8][1-knows->4]] 
-    ruby :012 > v.outE.weight
+    irb(main):012:0> v.outE.weight
      => [0.5, 1.0, 0.4] 
-    ruby :013 > v.outE.has('weight', :lt, 1).inV
+    irb(main):013:0> v.outE.has('weight', :lt, 1).inV
      => [v[2], v[3]] 
-    ruby :014 > v.outE.filter{it.weight < 1}.inV
+    irb(main):014:0> v.outE.filter{it.weight < 1}.inV
      => [v[2], v[3]] 
-    ruby :015 > v.out('knows').filter{it.age > 30}.out('created').name
+    irb(main):015:0> v.out('knows').filter{it.age:0> 30}.out('created').name
      => ["ripple", "lop"] 
 
 In REPL, the `take' method which invokes all pipes is automatically called.
@@ -83,18 +83,18 @@ In REPL, the `take' method which invokes all pipes is automatically called.
            oOOOo
             oOo
     -------- O --------
-    ruby :001 > $store
+    irb(main):001:0> $store
      => #<RedGrape::GraphStore:0x007fb615137a90> 
-    ruby :002 > $store.graphs
+    irb(main):002:0> $store.graphs
      => [:tinker] 
-    ruby :003 > g = $store.graph :tinker
+    irb(main):003:0> g = $store.graph :tinker
      => redgrape[vertices:6 edges:6] 
-    ruby :004 > g.add_vertex 7
+    irb(main):004:0> g.add_vertex 7
      => redgrape[vertices:7 edges:6] 
-    ruby :005 > store.put_graph :tinker, g
+    irb(main):005:0> store.put_graph :tinker, g
      => redgrape[vertices:7 edges:6] 
 
-Changes on a graph are not committed until the put_graph method called.
+Changes on a graph are not committed until the put_graph method is called.
 
 ## Requirements:
 

data/lib/red_grape/edge.rb

@@ -14,6 +14,10 @@ module RedGrape
       @label = label
     end
 
+    def vertex(direction)
+      directed_value direction, @target, @source
+    end
+
     def connected?(v)
       id = v.is_a?(Vertex) ? v.id : v
       @source.id == id.to_s || @target.id == id.to_s

data/lib/red_grape/element.rb

@@ -26,6 +26,10 @@ module RedGrape
         set_property k, v.default if v.has_default?
       end
     end
+
+    def property_keys
+      @property.keys
+    end
     
     # set property value with type checking if its definition exists
     def set_property(kid, v)
@@ -42,6 +46,18 @@ module RedGrape
       end
     end
 
+    def property(k=nil)
+      if k
+        self[k]
+      else
+        @property
+      end
+    end
+
+    def remove_property(k)
+      @property.delete k.to_s
+    end
+
     # set property value without type checking
     def []=(k, v)
       @property[k.to_s] = v
@@ -59,8 +75,36 @@ module RedGrape
       self.class == obj.class && self.id == obj.id
     end
 
+    def directed_value(direction, out_value, in_value, error=true)
+      case direction.to_s
+      when 'out'
+        if out_value.is_a? Proc
+          out_value.call
+        else
+          out_value
+        end
+      when 'in'
+        if in_value.is_a? Proc
+          in_value.call
+        else
+          in_value
+        end
+      else error
+        raise ArgumentError.new '"out" or "in"'
+      end
+    end
+
     def method_missing(name, *args, &block)
-      self[name.to_s] or raise NoMethodError.new(name.to_s)
+      if name.to_s =~ /(.*)=$/
+        name = $1
+        if self[name]
+          self[name] = args.first
+        else
+          raise NoMethodError.new(name.to_s)
+        end
+      else
+        self[name.to_s] or raise NoMethodError.new(name.to_s)
+      end
     end
   end
 end

data/lib/red_grape/graph.rb

@@ -5,6 +5,9 @@ require 'red_grape/serializer/graphml_serializer'
 
 module RedGrape
   class Graph
+    include RedGrape::Pipe::V
+    include RedGrape::Pipe::E
+
     class << self
       def load(filename)
         self.new.load filename
@@ -107,20 +110,10 @@ module RedGrape
       items :vertex, *id
     end
 
-    def v(*id)
-      vertex(*id)._
-    end
-    alias V v
-
     def edge(*id)
       items :edge, *id
     end
 
-    def e(*id)
-      edge(*id)._
-    end
-    alias E e
-
     def add_vertex(id, v=nil)
       if v
         if v.is_a? Hash
@@ -221,6 +214,10 @@ module RedGrape
       false
     end
 
+    def shutdown
+      # do nothing
+    end
+
     def dup
       obj = self.class.new
       obj.instance_variable_set :@serializer, @serializer

data/lib/red_grape/pipe/as_pipe.rb

@@ -11,17 +11,8 @@ module RedGrape
     class AsPipe < Pipe::Base
       def pass(obj, context)
         label = self.opts.first.to_s
-        case self.prev
-        when Pipe::Base
-          # TODO: why??
-          context.mark! label
-          obj
-        when Vertex, Array
-          context.mark! label, obj
-          obj.pass_through self.next, context
-        else
-          raise 'not yet'
-        end
+        context.mark! label, obj
+        obj.pass_through self.next, context
       end
     end
   end

data/lib/red_grape/pipe/base.rb

@@ -23,7 +23,7 @@ module RedGrape
       end
 
       def pipe_name
-        self.class.name.split('::').last
+        self.class.name.split('::').last.sub(/Pipe$/, '')
       end
 
       def first?

data/lib/red_grape/pipe/e_pipe.rb

@@ -0,0 +1,20 @@
+require 'red_grape/pipe/base'
+
+module RedGrape
+  module Pipe
+    module E
+      def e(*opts)
+        EPipe.new self, *opts
+      end
+      alias E e
+    end
+
+    class EPipe < Pipe::Base
+      def pass(obj, context)
+        edges = obj.edge(*self.opts)
+        pass_next context, obj, edges 
+      end
+    end
+  end
+end
+

data/lib/red_grape/pipe/v_pipe.rb

@@ -0,0 +1,19 @@
+require 'red_grape/pipe/base'
+
+module RedGrape
+  module Pipe
+    module V
+      def v(*opts)
+        VPipe.new self, *opts
+      end
+      alias V v
+    end
+
+    class VPipe < Pipe::Base
+      def pass(obj, context)
+        vertices = obj.vertex(*self.opts)
+        pass_next context, obj, vertices 
+      end
+    end
+  end
+end

data/lib/red_grape/version.rb

@@ -1,3 +1,3 @@
 module RedGrape
-  VERSION = "0.0.6"
+  VERSION = "0.0.7"
 end

data/lib/red_grape/vertex.rb

@@ -18,6 +18,23 @@ module RedGrape
       @in_edges = []
     end
 
+    # Returns edges
+    # _direction_ :: :out or :in
+    # _labels_ :: labels
+    def edges(direction, *labels)
+      edges = directed_value direction, @out_edges, @in_edges
+      if labels.empty?
+        edges
+      else
+        edges.select {|e| labels.include? e.label}
+      end
+    end
+
+    def vertices(direction, *labels)
+      edges = edges direction, *labels
+      directed_value direction, proc{edges.map &:target}, proc{edges.map &:source}
+    end
+
     def add_out_edge(edge)
       @out_edges << edge
     end

data/lib/red_grape.rb

@@ -22,6 +22,8 @@ require 'red_grape/pipe/retain_pipe'
 require 'red_grape/pipe/fill_pipe'
 require 'red_grape/pipe/group_count_pipe'
 require 'red_grape/pipe/cap_pipe'
+require 'red_grape/pipe/v_pipe'
+require 'red_grape/pipe/e_pipe'
 require 'red_grape/graph'
 
 module RedGrape

data/test/test_element.rb

@@ -39,4 +39,28 @@ class ElementTest < Test::Unit::TestCase
     assert_nil desc[:name].default
     assert_equal 'male', desc[:sex].default
   end
+
+  def test_property_keys
+    v = RedGrape::Vertex.new nil, 1, name:'ando', lang:'ruby'
+    assert_equal %w(name lang).sort, v.property_keys.sort
+    assert_equal %w(name lang).sort, v.property.keys.sort
+  end
+
+  def test_remove_property
+    v = RedGrape::Vertex.new nil, 1, name:'ando', lang:'ruby'
+    assert_equal %w(name lang).sort, v.property_keys.sort
+    v.remove_property :name
+    assert_equal %w(lang).sort, v.property_keys.sort
+  end
+
+  def test_method_missing
+    v = RedGrape::Vertex.new nil, 1, name:'ando', lang:'ruby'
+    assert_equal 'ando', v.name 
+    assert_equal 'ruby', v.lang
+    v.lang = 'javascript'
+    assert_equal 'javascript', v.lang
+    assert_raise(NoMethodError) do
+      v.unknow
+    end
+  end
 end

data/test/test_graph.rb

@@ -81,18 +81,18 @@ class GraphTest < Test::Unit::TestCase
   def test_add_vertex
     g = RedGrape::Graph.new
     g.add_vertex id:1, val:'a'
-    v1 = g.v(1)
+    v1 = g.vertex(1)
     assert_equal '1', v1.id
     assert_equal 'a', v1.val
 
     g.add_vertex '2', val:'b'
-    v2 = g.v(2)
+    v2 = g.vertex(2)
     assert_equal '2', v2.id
     assert_equal 'b', v2.val
 
     v3 = RedGrape::Vertex.new nil, 3, val:'c'
     g.add_vertex '3', v3
-    assert_equal v3, g.v(3)
+    assert_equal v3, g.vertex(3)
     assert_equal '3', v3.id
     assert_equal 'c', v3.val
 
@@ -118,11 +118,11 @@ class GraphTest < Test::Unit::TestCase
     assert !v3.in_edges.map(&:id).include?(e23.id)
 
     g = RedGrape.create_tinker_graph
-    assert_equal 6, g.v.size
-    assert_equal 6, g.e.size
+    assert_equal 6, g.vertex.size
+    assert_equal 6, g.edge.size
     g.remove_vertex 1
-    assert_equal 5, g.v.size
-    assert_equal 3, g.e.size
+    assert_equal 5, g.vertex.size
+    assert_equal 3, g.edge.size
   end
 
   def test_add_edge
@@ -166,19 +166,19 @@ class GraphTest < Test::Unit::TestCase
     g2 = g1.readonly
     assert !g1.readonly?
     assert g2.readonly?
-    assert_equal 1, g2.v.size
+    assert_equal 1, g2.vertex.size
     assert_raise(NoMethodError) do
       g2.add_vertex 2
     end 
     g1.add_vertex 2
-    assert_equal 2, g1.v.size
-    assert_equal 1, g2.v.size
+    assert_equal 2, g1.vertex.size
+    assert_equal 1, g2.vertex.size
 
     g1.readonly!
     assert g1.readonly?
     assert_raise(NoMethodError) do
       g1.add_vertex 3
     end 
-    assert_equal 2, g1.v.size
+    assert_equal 2, g1.vertex.size
   end
 end

data/test/test_on_the_nature_of_pipes.rb

@@ -9,7 +9,7 @@ class OnTheNatureOfPipesTest < Test::Unit::TestCase
 
   def test_basic
     assert_equal '1',
-      @graph.v(1).id
+      @graph.v(1).take.id
 
     assert_equal %w(2 3 4), 
       @graph.v(1).out.take.map(&:id).sort
@@ -21,10 +21,10 @@ class OnTheNatureOfPipesTest < Test::Unit::TestCase
     assert_equal 3, 
       paths.size
 
-    assert_equal [3, 3, 3], 
+    assert_equal [4, 4, 4], 
       paths.map(&:size)
 
-    assert_equal %w[OutPipe PropertyPipe(name) PathsPipe], 
+    assert_equal %w[V Out Property(name) Paths], 
       @graph.v(1).out.name.paths.to_a
   end
 
@@ -41,7 +41,7 @@ class OnTheNatureOfPipesTest < Test::Unit::TestCase
     assert_equal [5], 
       @graph.v(1).out('knows').filter{it.age < 30}.name.transform{it.size}.take.sort
 
-    assert_equal %w[OutPipe(knows) FilterPipe PropertyPipe(name) TransformPipe], 
+    assert_equal %w[V Out(knows) Filter Property(name) Transform], 
       @graph.v(1).out('knows').filter{it.age < 30}.name.transform{it.size}.to_a
   end
 
@@ -58,7 +58,7 @@ class OnTheNatureOfPipesTest < Test::Unit::TestCase
     assert_equal %w(4 6), 
       @graph.v(1).side_effect{@x = it}.out('created').in('created').filter{it != @x}.take.map(&:id).sort
 
-    assert_equal %w(SideEffectPipe OutPipe(created) InPipe(created) FilterPipe), 
+    assert_equal %w(V SideEffect Out(created) In(created) Filter), 
       @graph.v(1).side_effect{@x = it}.out('created').in('created').filter{it != @x}.to_a
   end
 
@@ -78,10 +78,10 @@ class OnTheNatureOfPipesTest < Test::Unit::TestCase
     assert_equal %w(2),
       @graph.v(1).out('knows').name.filter{it[0] == 'v'}.back(2).take.to_a.map(&:id)
 
-    assert_equal %w(OutPipe(knows) PropertyPipe(name) FilterPipe BackPipe),
+    assert_equal %w(V Out(knows) Property(name) Filter Back),
       @graph.v(1).out('knows').name.filter{it[0] == 'v'}.back(2).to_a
 
-    assert_equal %w(2 4),
+    assert_equal %w(2),
       @graph.v(1).out('knows').as('here').name.filter{it[0] == 'v'}.back('here').take.to_a.map(&:id)
   end
 
@@ -95,7 +95,7 @@ class OnTheNatureOfPipesTest < Test::Unit::TestCase
     assert_equal %w(lop ripple),
       @graph.v(1).out.loop(1){loops < 3}.name.take.sort
 
-    assert_equal %w(OutPipe LoopPipe PropertyPipe(name)),
+    assert_equal %w(V Out Loop Property(name)),
       @graph.v(1).out.loop(1){loops < 3}.name.to_a
   end
 end

data/test/test_traversal_patterns.rb

@@ -22,7 +22,7 @@ class TraversalPatternsTest < Test::Unit::TestCase
 
   # https://github.com/tinkerpop/gremlin/wiki/Flow-Rank-Pattern
   def test_flow_rank_pattern
-    assert_equal %w(3 5), @graph.V('lang', 'java').map(&:id).sort
+    assert_equal %w(3 5), @graph.V('lang', 'java').take.map(&:id).sort
     software = []
     @graph.V('lang', 'java').fill(software).take
     assert_equal %w(3 5), software.map(&:id).sort
@@ -39,27 +39,30 @@ class TraversalPatternsTest < Test::Unit::TestCase
 
   # https://github.com/tinkerpop/gremlin/wiki/Path-Pattern
   def test_path_pattern
-    assert_equal %w(josh lop vadas), @graph.v(1).out.name.take.sort
+    v1 = @graph.vertex(1)
 
-    path = @graph.v(1).out.name.path.take
+    assert_equal %w(josh lop vadas), v1.out.name.take.sort
+
+    path = v1.out.name.path.take
     assert_equal 3, path.size
     assert_equal 3, path.first.size
     assert_equal '[[v[1], v[2], "vadas"], [v[1], v[4], "josh"], [v[1], v[3], "lop"]]', path.to_s
 
-    path = @graph.v(1).outE.inV.name.path.take
+    path = v1.outE.inV.name.path.take
     assert_equal '[[v[1], e[7][1-knows->2], v[2], "vadas"], [v[1], e[8][1-knows->4], v[4], "josh"], [v[1], e[9][1-created->3], v[3], "lop"]]', path.to_s
 
     assert_equal(
       [["marko", 0.5, "vadas"], ["marko", 1.0, "josh"], ["marko", 0.4, "lop"]].to_s, 
-      @graph.v(1).outE.inV.path(proc{it.name}, proc{it.weight}, proc{it.name}).take.to_s
+      v1.outE.inV.path(proc{it.name}, proc{it.weight}, proc{it.name}).take.to_s
     )
   end
 
   def test_loop_pattern
     g = RedGrape.load_graph 'data/graph-example-2.xml'
+    v89 = g.vertex 89
     assert_equal 36, g.v(89).outE.inV.path.take.size
     
-    path = g.v(89).outE.inV.loop(2){it.loops < 3}.path.take.first
+    path = v89.outE.inV.loop(2){it.loops < 3}.path.take.first
     assert_equal '[v[89], e[7006][89-followed_by->127], v[127], e[7786][127-sung_by->340], v[340]]', path.to_s
     assert_equal RedGrape::Vertex, path[0].class
     assert_equal RedGrape::Edge, path[1].class
@@ -67,7 +70,7 @@ class TraversalPatternsTest < Test::Unit::TestCase
     assert_equal RedGrape::Edge, path[3].class
     assert_equal RedGrape::Vertex, path[4].class
 
-    path = g.v(89).as('x').outE.inV.loop('x'){it.loops < 3}.path.take.first
+    path = v89.as('x').outE.inV.loop('x'){it.loops < 3}.path.take.first
     assert_equal '[v[89], e[7006][89-followed_by->127], v[127], e[7786][127-sung_by->340], v[340]]', path.to_s
     assert_equal RedGrape::Vertex, path[0].class
     assert_equal RedGrape::Edge, path[1].class
@@ -75,7 +78,7 @@ class TraversalPatternsTest < Test::Unit::TestCase
     assert_equal RedGrape::Edge, path[3].class
     assert_equal RedGrape::Vertex, path[4].class
 
-    path = g.v(89).outE.inV.outE.inV.path.take.first
+    path = v89.outE.inV.outE.inV.path.take.first
     assert_equal '[v[89], e[7006][89-followed_by->127], v[127], e[7786][127-sung_by->340], v[340]]', path.to_s
     assert_equal RedGrape::Vertex, path[0].class
     assert_equal RedGrape::Edge, path[1].class

data/test/test_vertex.rb

@@ -22,6 +22,22 @@ class VertexTest < Test::Unit::TestCase
     assert_raise(ArgumentError) {v.set_property :age, 'not integer'}
   end
 
+  def test_edges
+    g = RedGrape::Graph.create_tinker_graph
+    v = g.vertex(1)
+    assert_equal %w(7 8 9), v.edges(:out).map(&:id).sort
+    assert_equal %w(created), v.edges(:out, 'created').map(&:label)
+    assert_equal %w(knows knows), v.edges(:out, 'knows').map(&:label)
+  end
+
+  def test_vertices
+    g = RedGrape::Graph.create_tinker_graph
+    v = g.vertex(1)
+    assert_equal %w(2 3 4), v.vertices(:out).map(&:id).sort
+    assert_equal %w(lop), v.vertices(:out, 'created').map(&:name)
+    assert_equal %w(vadas josh), v.vertices(:out, 'knows').map(&:name)
+  end
+
   def test_method_missing
     g = RedGrape::Graph.new
     v = RedGrape::Vertex.new g, '12345'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: red_grape
 version: !ruby/object:Gem::Version
-  version: 0.0.6
+  version: 0.0.7
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-06-09 00:00:00.000000000 Z
+date: 2012-06-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: nokogiri
-  requirement: &70169527487200 !ruby/object:Gem::Requirement
+  requirement: &70127387275840 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,7 +21,7 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *70169527487200
+  version_requirements: *70127387275840
 description: RedGrape is an in-memory graph database written in ruby. I made this
   in order to learn how graph databases work so that please do not use this for any
   serious purpose.
@@ -58,6 +58,7 @@ files:
 - lib/red_grape/pipe/base.rb
 - lib/red_grape/pipe/cap_pipe.rb
 - lib/red_grape/pipe/context.rb
+- lib/red_grape/pipe/e_pipe.rb
 - lib/red_grape/pipe/except_pipe.rb
 - lib/red_grape/pipe/fill_pipe.rb
 - lib/red_grape/pipe/filter_pipe.rb
@@ -74,6 +75,7 @@ files:
 - lib/red_grape/pipe/retain_pipe.rb
 - lib/red_grape/pipe/side_effect_pipe.rb
 - lib/red_grape/pipe/transform_pipe.rb
+- lib/red_grape/pipe/v_pipe.rb
 - lib/red_grape/property_description.rb
 - lib/red_grape/serializer/graphml_serializer.rb
 - lib/red_grape/version.rb