neomirror 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: ab74e8c31f0b8ea8c07d4fdb8b454f7f1823c37b
-  data.tar.gz: 465c276d4c825cf27d2bf38decb2955287958669
+  metadata.gz: 91d4c19efa74a09c812dfbffc777ebb884f3289c
+  data.tar.gz: 06e831911c25f4022c41038d5af73d1ca20085e6
 SHA512:
-  metadata.gz: 3d952da8b37fd49abd4cf9207992319a39c30f428cda953749e5d1c4cde0d5ece314edb849c39f472a44276c079b260221198ce501b472d8e5578165820a1034
-  data.tar.gz: 0e96b273a81c88048c053e8d450dd40b949845e306b5e31779b37f869bc2863337c3932776ec9e2d974087bb789ac84a866b7237cc58a6f941e42a80d25bd0b8
+  metadata.gz: 171520bb5e991c0605a03d5adb5d8774e16cf31bc494c8f8e4beb635505af69038be2881831a84d78bd2b7b1610897d7d61a7f8956c1b05e0caeb59f9118fd2b
+  data.tar.gz: 13de4c46626309fd61fc6046156a405909e9805a67039ae0a7f8804fe43d1d063338f9b50b904e2b5846e1bd93cf1738ad3b30dde3dcf8c3cecf8e6bf1dce8c9

data/README.md

@@ -163,7 +163,20 @@ class Staff < ActiveRecord::Base
 end
 ```
 
-Even possible reflect model as node (vertex) and relation(s) (edge). But it is probably not needed.
+Even possible reflect model as node (vertex) and relation(s) (edge).
+
+```ruby
+class Group < ActiveRecord::Base
+  include Neomirror::Node
+  include Neomirror::Relationship
+
+  belongs_to :parent, class_name: 'Group', foreign_key: :parent_id
+
+  mirror_neo_node
+
+  mirror_neo_relationship start_node: :self, end_node: :parent, type: :CHILD_OF
+end
+```
 
 ## Compatibility
 
@@ -171,12 +184,12 @@ It is possible to use it outside of ActiveRecord (there is no dependency). Just
 
 Also specify primary key attribute if it is differ from `id` and class don't `respond_to? :primary_key` method.
 
-```
+```ruby
 class Postcode
   attr_accessor :code
   include Neomirror::Node
 
-  self.node_primary_key = :code
+  self.neo_primary_key = :code
 
   mirror_neo_node
 end

data/lib/neomirror/node.rb

@@ -23,10 +23,10 @@ module Neomirror::Node
       @neo_mirror
     end
 
-    def node_primary_key
-      @node_primary_key ||= self.respond_to?(:primary_key) ? self.__send__(:primary_key) : :id
+    def neo_primary_key
+      @neo_primary_key ||= self.respond_to?(:primary_key) ? self.__send__(:primary_key) : :id
     end
-    attr_writer :node_primary_key
+    attr_writer :neo_primary_key
   end
 
   def neo_node
@@ -36,20 +36,17 @@ module Neomirror::Node
   alias_method :node, :neo_node
 
   def neo_node_properties
-    neo_node_properties = ::Hash.new
-    neo_node_properties[:id] = self.__send__(self.class.node_primary_key)
+    hash = { :id => self.__send__(self.class.neo_primary_key) }
     if self.class.neo_mirror && self.class.neo_mirror[:properties]
-      self.class.neo_mirror[:properties].each do |property, rule|
-        neo_node_properties[property] = rule.call(self)
-      end
+      self.class.neo_mirror[:properties].each { |property, rule| hash[property] = rule.call(self) }
     end
-    neo_node_properties
+    hash
   end
 
   def find_neo_node
     raise "Couldn't find neo_node declaration" unless self.class.neo_mirror
     label = self.class.neo_mirror[:label]
-    id = self.__send__(self.class.node_primary_key)
+    id = self.__send__(self.class.neo_primary_key)
     return nil unless node = ::Neomirror.neo.find_nodes_labeled(label, { :id => id }).first
     @neo_node = ::Neography::Node.load(node, ::Neomirror.neo)
   end
@@ -76,8 +73,4 @@ module Neomirror::Node
     ::Neomirror.neo.delete_node!(@neo_node)
     true
   end
-
-  def neo_node_to_cypher
-    ":#{self.class.neo_mirror[:label]} {id:#{self.__send__(self.class.node_primary_key)}}"
-  end
 end

data/lib/neomirror/relationship.rb

@@ -30,11 +30,19 @@ module Neomirror::Relationship
       raise ArgumentError, "Options :start_node and :end_node are mandatory" unless m[:start_node] && m[:end_node]
       m[:start_node] = m[:start_node].to_sym
       m[:end_node] = m[:end_node].to_sym
-      m[:type] = (m[:type] ? m[:type] : self.name.gsub(/^.*::/, '').gsub(/([a-z\d])([A-Z])/, '\1_\2').upcase).to_sym
+      class_name = self.name.gsub(/^.*::/, '').gsub(/([a-z\d])([A-Z])/, '\1_\2')
+      m[:type] = (m[:type] ? m[:type] : class_name.upcase).to_sym
       m[:properties] = Neomirror::PropertyCollector.new(&block).properties if block_given?
       m[:if] = m[:if].to_proc if m[:if]
+      m[:index_name] = "#{m[:start_node] == :self ? class_name.downcase : m[:start_node]}_#{m[:type]}_#{m[:end_node] == :self ? class_name.downcase : m[:end_node]}"
+      ::Neomirror.neo.create_relationship_index(m[:index_name])
       rel_mirrors << m
     end
+
+    def neo_primary_key
+      @neo_primary_key ||= self.respond_to?(:primary_key) ? self.__send__(:primary_key) : :id
+    end
+    attr_writer :neo_primary_key
   end
 
   def neo_relationship(partial_mirror = nil)
@@ -45,7 +53,7 @@ module Neomirror::Relationship
   def neo_relationship_properties(partial_mirror = nil)
     raise "Couldn't find neo_relationship declaration" unless rel_mirror = self.class.rel_mirror(partial_mirror)
     return nil unless rel_mirror[:properties]
-    rel_mirror[:properties].reduce({}) { |h, (property, rule)| h[property] = rule.call(self); h }
+    rel_mirror[:properties].reduce({}) { |hash, (property, rule)| hash[property] = rule.call(self); hash }
   end
 
   def neo_relationship_must_exist?(partial_mirror = nil)
@@ -55,25 +63,30 @@ module Neomirror::Relationship
 
   def find_neo_relationship(partial_mirror = nil)
     raise "Couldn't find neo_relationship declaration" unless rel_mirror = self.class.rel_mirror(partial_mirror)
-    return nil unless (m1 = self.__send__(rel_mirror[:start_node])) && (m2 = self.__send__(rel_mirror[:end_node])) &&
-      (rel = ::Neomirror.neo.execute_query("MATCH (#{m1.neo_node_to_cypher})-[r:#{rel_mirror[:type]}]->(#{m2.neo_node_to_cypher}) RETURN r")["data"].first)
+    return nil unless rel = ::Neomirror.neo.get_relationship_index(rel_mirror[:index_name], :id, self.__send__(self.class.neo_primary_key))
     @neo_rel = ::Neography::Relationship.load(rel, ::Neomirror.neo)
   end
 
   def create_neo_relationship(partial_mirror = nil)
     raise "Couldn't find neo_relationship declaration" unless rel_mirror = self.class.rel_mirror(partial_mirror)
-    return nil unless self.__send__(rel_mirror[:start_node]) && self.__send__(rel_mirror[:end_node]) && 
+    return nil unless (m1 = related_object(rel_mirror[:start_node])) && (m2 = related_object(rel_mirror[:end_node])) &&
       neo_relationship_must_exist?(rel_mirror)
-    ::Neography::Relationship.create(rel_mirror[:type], self.__send__(rel_mirror[:start_node]).neo_node, 
-      self.__send__(rel_mirror[:end_node]).neo_node, neo_relationship_properties(rel_mirror))
+    @neo_rel = ::Neography::Relationship.create(rel_mirror[:type], m1.neo_node, m2.neo_node, neo_relationship_properties(rel_mirror))
+    ::Neomirror.neo.add_relationship_to_index(rel_mirror[:index_name], :id, self.__send__(self.class.neo_primary_key), @neo_rel)
+    @neo_rel
+  end
+
+  def related_object(method_name)
+    method_name == :self ? self : self.__send__(method_name)
   end
 
   def update_neo_relationship(partial_mirror = nil)
     raise "Couldn't find neo_relationship declaration" unless rel_mirror = self.class.rel_mirror(partial_mirror)
     if find_neo_relationship(rel_mirror)
-      if neo_relationship_must_exist?(rel_mirror)
+      if related_object(rel_mirror[:start_node]) && related_object(rel_mirror[:end_node]) && neo_relationship_must_exist?(rel_mirror)
         ::Neomirror.neo.reset_relationship_properties(@neo_rel, neo_relationship_properties(rel_mirror))
       else
+        ::Neomirror.neo.remove_relationship_from_index(rel_mirror[:index_name], :id, self.__send__(self.class.neo_primary_key), @neo_rel)
         ::Neomirror.neo.delete_relationship(@neo_rel)
       end
     else
@@ -83,7 +96,10 @@ module Neomirror::Relationship
 
   def destroy_neo_relationship(partial_mirror = nil)
     raise "Couldn't find neo_relationship declaration" unless rel_mirror = self.class.rel_mirror(partial_mirror)
-    ::Neomirror.neo.delete_relationship(@neo_rel) if find_neo_relationship(rel_mirror)
+    if find_neo_relationship(rel_mirror)
+      ::Neomirror.neo.remove_relationship_from_index(rel_mirror[:index_name], :id, self.__send__(self.class.neo_primary_key), @neo_rel)
+      ::Neomirror.neo.delete_relationship(@neo_rel)
+    end
   end
 
   def create_neo_relationships

data/lib/neomirror/version.rb

@@ -1,3 +1,3 @@
 module Neomirror
-  VERSION = "0.0.1"
+  VERSION = "0.0.2"
 end

data/spec/neomirror/neomirror_spec.rb

@@ -0,0 +1,25 @@
+require "spec_helper"
+
+describe Neomirror do
+  describe "Reflection of model as node and relation" do
+    let(:group) { create(:group) }
+    let(:child_group) { create(:group, parent: group) }
+
+    it "creates neo4j nodes" do
+      group.find_neo_node.should be_a Neography::Node
+      child_group.find_neo_node.should be_a Neography::Node
+    end
+
+    it "creates neo4j relation with object itself" do
+      group.find_neo_relationship.should be_nil
+      child_group.find_neo_relationship.should be_a Neography::Relationship
+      Neomirror.neo.execute_query("MATCH (:Group {id: #{child_group.id}})-[r:CHILD_OF]->(:Group {id: #{group.id}}) RETURN r")["data"].first.should be_present
+    end
+
+    it "destroys relationship on update if actual relationship disappears (both nodes must be present)" do
+      child_group.update(parent_id: nil)
+      child_group.find_neo_relationship.should be_nil
+      Neomirror.neo.execute_query("MATCH (:Group {id: #{child_group.id}})-[r:CHILD_OF]->(:Group {id: #{group.id}}) RETURN r")["data"].first.should be_nil
+    end
+  end
+end

data/spec/neomirror/node_spec.rb

@@ -61,7 +61,7 @@ describe Neomirror::Node do
     end
   end
 
-  describe ".node_primary_key" do
+  describe ".neo_primary_key" do
     let(:postcode) { Postcode.new.tap { |p| p.code = 'ABC' } }
 
     it "sets custom primary key" do
@@ -69,10 +69,4 @@ describe Neomirror::Node do
       postcode.neo_node.id.should == 'ABC'
     end
   end
-
-  describe "#neo_node_to_cypher" do
-    it "represents node as cypher element" do
-      user.neo_node_to_cypher.should == ":User {id:#{user.id}}"
-    end
-  end
 end

data/spec/neomirror/relationship_spec.rb

@@ -92,6 +92,13 @@ describe Neomirror::Relationship do
       staff.find_neo_relationship(type: :VISITOR_OF).should be_nil
       staff.find_neo_relationship(type: :MANAGER_OF).should be_a Neography::Relationship
     end
+
+    it "destroys relationship on update if actual relationship disappears (both nodes must be present)" do
+      staff_of_premises
+      Neomirror.neo.execute_query("MATCH (:User {id: #{user.id}})-[r:STAFF_OF]->(:Premises {id: #{premises.id}}) RETURN r")["data"].first.should be_present
+      staff_of_premises.update(premises_id: nil)
+      Neomirror.neo.execute_query("MATCH (:User {id: #{user.id}})-[r:STAFF_OF]->(:Premises {id: #{premises.id}}) RETURN r")["data"].first.should be_nil
+    end
   end
 
   describe "#destroy_neo_relationship" do

data/spec/spec_helper.rb

@@ -8,7 +8,7 @@ ENV['NEO_URL'] ||= "http://127.0.0.1:7474"
 Neomirror.connection = Neography::Rest.new(ENV['NEO_URL'])
 
 ActiveRecord::Base.connection.execute('CREATE TABLE premises ("id" INTEGER PRIMARY KEY NOT NULL)')
-ActiveRecord::Base.connection.execute('CREATE TABLE groups ("id" INTEGER PRIMARY KEY NOT NULL)')
+ActiveRecord::Base.connection.execute('CREATE TABLE groups ("id" INTEGER PRIMARY KEY NOT NULL, "parent_id" INTEGER DEFAULT NULL)')
 ActiveRecord::Base.connection.execute('CREATE TABLE users ("id" INTEGER PRIMARY KEY NOT NULL, "name" varchar(255) NOT NULL)')
 ActiveRecord::Base.connection.execute('CREATE TABLE memberships ("id" INTEGER PRIMARY KEY NOT NULL, "premises_id" INTEGER DEFAULT NULL, "group_id" INTEGER DEFAULT NULL)')
 ActiveRecord::Base.connection.execute('CREATE TABLE staff ("id" INTEGER PRIMARY KEY NOT NULL, "user_id" INTEGER DEFAULT NULL, "premises_id" INTEGER DEFAULT NULL, "group_id" INTEGER DEFAULT NULL, "roles" TEXT)')

data/spec/support/group.rb

@@ -1,9 +1,10 @@
 class Group < ActiveRecord::Base
   include Neomirror::Node
+  include Neomirror::Relationship
   has_many :memberships
-  has_many :premises, through: :memberships
   has_many :staff
-  has_many :users, through: :staff
+  belongs_to :parent, class_name: 'Group', foreign_key: :parent_id
 
   mirror_neo_node
+  mirror_neo_relationship start_node: :self, end_node: :parent, type: :CHILD_OF
 end

data/spec/support/postcode.rb

@@ -2,7 +2,7 @@ class Postcode
   attr_accessor :code
   include Neomirror::Node
 
-  self.node_primary_key = :code
+  self.neo_primary_key = :code
 
   mirror_neo_node
 end

data/spec/support/premises.rb

@@ -1,9 +1,7 @@
 class Premises < ActiveRecord::Base
   include Neomirror::Node
   has_many :memberships
-  has_many :groups, through: :memberships
   has_many :staff
-  has_many :users, through: :staff
 
   mirror_neo_node
 end

data/spec/support/user.rb

@@ -1,8 +1,6 @@
 class User < ActiveRecord::Base
   include Neomirror::Node
   has_many :staff
-  has_many :premises, through: :staff
-  has_many :groups,   through: :staff
 
   mirror_neo_node do
     property :name

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: neomirror
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - Alex Avoyants
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-06-30 00:00:00.000000000 Z
+date: 2014-07-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: neography
@@ -162,6 +162,7 @@ files:
 - spec/factories/premises.rb
 - spec/factories/staff.rb
 - spec/factories/user.rb
+- spec/neomirror/neomirror_spec.rb
 - spec/neomirror/node_spec.rb
 - spec/neomirror/relationship_spec.rb
 - spec/spec_helper.rb
@@ -202,6 +203,7 @@ test_files:
 - spec/factories/premises.rb
 - spec/factories/staff.rb
 - spec/factories/user.rb
+- spec/neomirror/neomirror_spec.rb
 - spec/neomirror/node_spec.rb
 - spec/neomirror/relationship_spec.rb
 - spec/spec_helper.rb