architect4r 0.3.3.1 → 0.3.4

data/ReleaseNotes.md

@@ -1,5 +1,12 @@
 # Release Notes
 
+## v0.3.4
+
+* Allow fetching items, such as nodes and relationships in one query
+  
+  By using the server's cypher_query() method, it is possible to fetch 
+  multiple items of different types by using a single query.
+
 ## v0.3.3
 
 * Add magic timestamp! property for tracking timestamps

data/Specs.md

@@ -2,6 +2,35 @@
 
 Some code which might define the future interface of the gem.
     
+    # Defining
+    
+    class Character < Architect4r::Model::Node
+      property :name, :cast_to => String
+      property :human, :cast_to => TrueClass
+      timestamps!
+      
+      def ships
+        class.find_by_cypher("start s=node(#{id}) match s-[:CrewMembership]->d return d", "d")
+      end
+      
+      def crew_memberships
+        class.find_by_cypher("start s=node(#{id}) match s-[r:CrewMembership]->d return d, r", "d")
+      end
+    end
+    
+    class Ship < Architect4r::Model::Node
+      property :name, :cast_to => String
+    end
+    
+    class CrewMembership < Architect4r::Model::Relationship
+      property :rank, :cast_to => String
+    end
+    
+    neo = Character.find_by_id(15)
+    neo.
+    
+    
+    
     # Finding records
     Instrument.all
     Instrument.find_by_name("Piano")

data/architect4r.gemspec

@@ -7,7 +7,7 @@ Gem::Specification.new do |s|
   s.version     = Architect4r::VERSION
   s.authors     = ["Maximilian Schulz"]
   s.email       = ["m.schulz@kulturfluss.de"]
-  s.homepage    = "http://www.kulturfluss.de/"
+  s.homepage    = "https://github.com/namxam/architect4r/"
   s.summary     = %q{A gem for working with the neo4j REST interface.}
   s.description = %q{This gem is intended for making a neo4j graph db accessible by providing a ruby wrapper for the REST API.}
   

data/lib/architect4r.rb

@@ -62,5 +62,6 @@ module Architect4r
   end
   
   class InvalidCypherQuery < SyntaxError; end
+  class RecordNotFound < StandardError; end
   
 end

data/lib/architect4r/core/cypher_methods.rb

@@ -6,7 +6,6 @@ module Architect4r
       module InstanceMethods
         
         def execute_cypher(query)
-          
           query = self.interpolate_node_model_root_references(query)
           
           url = prepend_base_url("/ext/CypherPlugin/graphdb/execute_query")
@@ -28,22 +27,60 @@ module Architect4r
           elsif response.code == 204
             nil
           else
-            result_data = JSON.parse(response.body)
-            
-            # Convert the columnized result array to hashes within an array
-            results = []
-            
-            result_data['data'].each_with_index do |row, ri|
-              result_row = {}
-              result_data['columns'].each_with_index do |column, ci|
-                result_row[column] = convert_if_possible(row[ci])
-              end
-              results << result_row
+            JSON.parse(response.body)
+          end
+        end
+        
+        def cypher_query(query, transform=true)
+          # Get data from server
+          data = execute_cypher(query)
+          
+          # Create native ruby objects
+          data['data'].map! do |set|
+            set.map { |item| convert_if_possible(item) }
+          end
+          
+          # Transform to hash form
+          if transform
+            transform_cypher_result_to_hash(data)
+          else
+            data
+          end
+        end
+        
+        # Convert the columnized result array to a hashes within an array
+        #
+        # The input would look like:
+        #
+        # { 'data' => [['r1', 'n1'], ['r2', 'n2'], …], 'columns' => ['rel', 'node']}
+        # 
+        # And it would be transformed to:
+        # [ { 'rel' => 'r1', 'node' => 'n1' }, { 'rel' => 'r2', 'node' => 'n2' } ]
+        #
+        def transform_cypher_result_to_hash(input)
+          results = []
+          input['data'].each_with_index do |row, ri|
+            result_row = {}
+            input['columns'].each_with_index do |column, ci|
+              result_row[column] = row[ci]
             end
-            results
+            results << result_row
           end
+          results
         end
         
+        # Parses a cypher query and replaces all placeholders for model roots 
+        # with the neo4j ids. It should make development faster, as you can 
+        # skip manual id retrieval:
+        #
+        # So instead of writing:
+        #
+        #     "start s=node(#{Person.model_root.id}) match s-->d return d"
+        # 
+        # you can write:
+        # 
+        #     "start s=node(:person_root) match s-->d return d"
+        #
         def interpolate_node_model_root_references(query)
           query.scan(/node\((:[^)]*_root)\)/i).flatten.uniq.each do |str|
             model_name = str.match(/^:(.*)_root$/)[1].to_s.classify

data/lib/architect4r/model/node.rb

@@ -25,19 +25,18 @@ module Architect4r
           def self.model_root
             @model_root ||= begin
               # Check if there is already a model root,
-              query = "start root = node(0) match (root)-[r:#{  model_root_relation_type}]->(x) where r.architect4r_type and r.architect4r_type = '#{name}' return x"
-              the_root = connection.execute_cypher(query).to_a.first
+              query = "start root = node(0) match root-[r:#{model_root_relation_type}]->x where r.architect4r_type and r.architect4r_type = '#{name}' return x"
+              the_root = connection.cypher_query(query).to_a.first
               the_root &&= the_root['x']
               
               # otherwise create one
               the_root ||= begin 
-                m_root = connection.create_node(:name => "#{name} Root")
+                m_root = connection.create_node(:name => "#{name} Root", :root_for => name)
                 connection.create_relationship(0, m_root, model_root_relation_type, { 'architect4r_type' => name })
-                m_root
+                
+                # Return model root node
+                GenericNode.send(:build_from_database, m_root)
               end
-              
-              # Return model root node
-              GenericNode.send(:build_from_database, the_root)
             end
           end
           

data/lib/architect4r/model/queries.rb

@@ -11,22 +11,24 @@ module Architect4r
         
         def count(opts = {}, &block)
           data = connection.execute_cypher("start s=node(#{self.model_root.id}) match (s)<-[:model_type]-(d) return count(d)")
-          data.first['count(d)']
+          data['data'].flatten.first
         end
         
         def find_by_id(id)
           data = connection.execute_cypher("start s=node(#{self.model_root.id}), d=node(#{id.to_i}) match s<-[r:model_type]-d return d")
-          data &&= data.first && data.first['d']
+          data &&= data['data'] && data['data'].flatten.first
           self.build_from_database(data)
         end
         
         def find_by_id!(id)
-          raise 'not implemented'
+          self.find_by_id(id) || raise(Architect4r::RecordNotFound.new("Could not find the #{self.name} with id #{id}!"))
         end
         
+        # Use this method only to fetch items of the same class.
         def find_by_cypher(query, identifier)
-          if data = connection.execute_cypher(query)
-            data.map { |item| build_from_database(item[identifier]) }
+          if result_data = connection.execute_cypher(query)
+            result_data = connection.transform_cypher_result_to_hash(result_data)
+            result_data.map { |item| connection.convert_if_possible(item[identifier]) }
           else
             nil
           end

data/lib/architect4r/server.rb

@@ -39,16 +39,6 @@ module Architect4r
       response.success? ? JSON.parse(response.body) : nil
     end
     
-    protected
-    
-    def prepend_base_url(url)
-      if url[0,4] == "http"
-        url
-      else
-        "http://#{configuration.host}:#{configuration.port}#{configuration.path}/db/data#{url}"
-      end
-    end
-    
     def node_url(url_or_id)
       if url_or_id.is_a?(Hash)
         url_or_id['self'].to_s
@@ -69,10 +59,33 @@ module Architect4r
       end
     end
     
-    def convert_if_possible(data)
+    # Build a node or relationship from the hash neo4j returns.
+    def convert_if_possible(object_hash)
+      if klass = object_hash.is_a?(Hash) && object_hash['data']
+        if model_string = object_hash['data']['architect4r_type']
+          data = begin
+            eval("#{model_string}.send(:build_from_database, object_hash)")
+          rescue => ex
+            data
+          end
+        elsif object_hash['self'].match(/node\/\d+$/i)
+          data = GenericNode.send(:build_from_database, object_hash)
+        end
+      end
       data
     end
     
+    
+    protected
+    
+    def prepend_base_url(url)
+      if url[0,4] == "http"
+        url
+      else
+        "http://#{configuration.host}:#{configuration.port}#{configuration.path}/db/data#{url}"
+      end
+    end
+    
   end
   
   

data/lib/architect4r/version.rb

@@ -1,3 +1,3 @@
 module Architect4r
-  VERSION = "0.3.3.1"
+  VERSION = "0.3.4"
 end

data/spec/core/cypher_methods_spec.rb

@@ -67,4 +67,26 @@ describe Architect4r::Server do
     
   end
   
+  describe "custom cypher queries" do
+    
+    it "should return all native objects from queries" do
+      neo = Person.create(:name => 'Neo', :human => true)
+      niobe = Person.create(:name => 'Niobe', :human => true)
+      logos = Ship.create(:name => 'Logos', :crew_size => 2)
+      
+      CrewMembership.create(logos, niobe, { :rank => 'Captain' })
+      CrewMembership.create(logos, neo, { :rank => 'Member' })
+      
+      result = subject.cypher_query("start s=node(#{logos.id}) match s-[membership:CrewMembership]->person return membership, person")
+      result.should be_a(Array)
+      
+      result[0]['membership'].should be_a(CrewMembership)
+      result[0]['person'].should be_a(Person)
+      
+      result[1]['membership'].should be_a(CrewMembership)
+      result[1]['person'].should be_a(Person)
+    end
+    
+  end
+  
 end

data/spec/model/node_spec.rb

@@ -40,7 +40,7 @@ describe "Model Node" do
       Person.create(:name => 'Morpheus', :human => true)
       m_root = Person.model_root
       Person.create(:name => 'Trinity', :human => true)
-      Person.model_root.should == m_root
+      Person.model_root.id.should == m_root.id
     end
     
   end

data/spec/model/queries_spec.rb

@@ -22,6 +22,19 @@ describe "Node Queries" do
       Person.find_by_id(ship.id).should be_nil
     end
     
+    it "should return nil when the node is not found" do
+      Person.find_by_id(-1).should be_nil
+    end
+    
+    it "should raise an exception when banged finder is used an no record found" do
+      lambda { Person.find_by_id!(-1) }.should raise_error(Architect4r::RecordNotFound)
+    end
+    
+    it "should not raise an exception when banged finder is used an a record is found" do
+      person = Person.create(:name => 'The Architect', :human => false)
+      lambda { Person.find_by_id!(person.id) }.should_not raise_error(Architect4r::RecordNotFound)
+    end
+    
   end
   
   describe "counting records" do
@@ -40,7 +53,7 @@ describe "Node Queries" do
       Person.create(:name => 'Neo', :human => true)
       Person.create(:name => 'Trinity', :human => true)
       Person.create(:name => 'Morpheus', :human => true)
-      results = Person.find_by_cypher("start s=node(#{Person.model_root.id}) match s<-[:model_type]-d return d limit 2", 'd')
+      results = Person.find_by_cypher("start s=node(:person_root) match s<-[:model_type]-d return d limit 2", 'd')
       results.size.should == 2
       results.first.should be_a(Person)
     end

data/spec/spec_helper.rb

@@ -24,10 +24,11 @@ RSpec.configure do |config|
   
   config.before(:suite) do
     neo_manager.reset_to_sample_data(File.join(File.dirname(__FILE__), "fixtures/graph.db.default/"))
+    neo_manager.start
   end
   
   config.after(:suite) do
-    neo_manager.start
+    neo_manager.stop
   end
 end
 

metadata

@@ -1,14 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: architect4r
 version: !ruby/object:Gem::Version 
-  hash: 89
+  hash: 27
   prerelease: 
   segments: 
   - 0
   - 3
-  - 3
-  - 1
-  version: 0.3.3.1
+  - 4
+  version: 0.3.4
 platform: ruby
 authors: 
 - Maximilian Schulz
@@ -16,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-10-26 00:00:00 Z
+date: 2011-10-27 00:00:00 Z
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: activemodel
@@ -266,7 +265,7 @@ files:
 - spec/model/validations_spec.rb
 - spec/server_spec.rb
 - spec/spec_helper.rb
-homepage: http://www.kulturfluss.de/
+homepage: https://github.com/namxam/architect4r/
 licenses: []
 
 post_install_message: