architect4r 0.4 → 0.4.1

data/README.md

@@ -68,6 +68,22 @@ Quick Start
     Fanship.new(@user, @instrument, { :reason => 'Because I like you' })
 
 
+Logging
+-------
+
+In order to log the debug output from architect4r to a logfile, just override the default 
+logger instance. If you are using rails, you might wanna add this to an initializer:
+
+    
+    # Create a logger instance
+    file = File.open('log/output.log', File::WRONLY | File::APPEND)
+    logger = Logger.new(file, 'daily')
+    logger.level = Logger::DEBUG
+    
+    # Set architect4r logger
+    Architect4r.logger = logger
+
+
 Development
 -----------
 

data/ReleaseNotes.md

@@ -1,5 +1,11 @@
 # Release Notes
 
+## v0.4.1
+
+* Allow logging of cypher queries for easier debugging
+
+* Add proper node comparison, so we can detect multiple instances of the same node.
+
 ## v0.4
 
 * Upgrade to neo4j 1.6 GA

data/lib/architect4r.rb

@@ -3,6 +3,11 @@
 #
 require 'architect4r/version'
 
+#
+# External libraries
+#
+require 'logger'
+
 #
 # Extensions
 #
@@ -57,6 +62,14 @@ end
 #
 module Architect4r
   
+  def self.logger
+    @log ||= Logger.new(STDOUT)
+  end
+  
+  def self.logger=(logger_instance)
+    @log = logger_instance
+  end
+  
   def self.version
     "Architect4r version #{Architect4r::VERSION}"
   end

data/lib/architect4r/core/cypher_methods.rb

@@ -8,14 +8,19 @@ module Architect4r
         def execute_cypher(query)
           query = self.interpolate_node_model_root_references(query)
           
+          Architect4r.logger.debug("[Architect4r][execute_cypher] QUERY: #{query}")
+          
           url = prepend_base_url("/cypher")
           response = Typhoeus::Request.post(url, 
             :headers => { 'Accept' => 'application/json', 'Content-Type' => 'application/json' },
             :body => { 'query' => query }.to_json)
           
+          msg = JSON.parse(response.body)
+          
+          Architect4r.logger.debug("[Architect4r][execute_cypher] CODE: #{response.code} => #{msg.inspect}")
+          
           # Check if there might be an error with the query
           if response.code == 400
-            msg = JSON.parse(response.body)
             if msg['exception'].to_s.match /org.neo4j.graphdb.NotFoundException/
               nil
             else
@@ -26,7 +31,7 @@ module Architect4r
           elsif response.code == 204
             nil
           else
-            JSON.parse(response.body)
+            msg
           end
         end
         
@@ -34,6 +39,8 @@ module Architect4r
           # Get data from server
           data = execute_cypher(query)
           
+          Architect4r.logger.debug("[Architect4r][cypher_query] #{data.inspect}")
+          
           # Create native ruby objects
           data['data'].map! do |set|
             set.map { |item| convert_if_possible(item) }

data/lib/architect4r/model/node.rb

@@ -51,11 +51,26 @@ module Architect4r
         end
       end
       
+      # Override to_s to make debugging easier. It now includes the id and properties
+      #
       def to_s
         prop_data = @properties_data.collect { |key, value| "#{key}='#{value}'" }.join(' ')
         "#<#{self.class.name}:#{object_id} id=#{id} #{prop_data} neo4j_uri='#{@raw_data['self']}'>"
       end
       
+      # Calculate hash manually in order to only include unique properties for comparison
+      #
+      def hash
+        [self.class, self.id].hash
+      end
+      
+      # Override comparison of instances
+      #
+      def ==(other)
+        other.is_a?(self.class) && id.present? && other.id == id
+      end
+      alias :eql? :==
+      
       # Create the document. Validation is enabled by default and will return
       # false if the document is not valid. If all goes well, the document will
       # be returned.

data/lib/architect4r/version.rb

@@ -1,3 +1,3 @@
 module Architect4r
-  VERSION = "0.4"
+  VERSION = "0.4.1"
 end

data/spec/model/node_spec.rb

@@ -30,6 +30,26 @@ describe "Model Node" do
     
   end
   
+  describe "equality of two instances of the same node" do
+    
+    subject { Person.create(:name => 'Alfons', :human => true) }
+    let(:instance_1) { Person.find_by_id(subject.id) }
+    let(:instance_2) { Person.find_by_id(subject.id) }
+    
+    it "should have the same hash" do
+      instance_1.hash.should equal(instance_2.hash)
+    end
+    
+    it "should be eql" do
+      instance_1.should eql(instance_2)
+    end
+    
+    it "should be ==" do
+      instance_1.should == instance_2
+    end
+    
+  end
+  
   describe "connection" do
     
     it { should respond_to(:connection) }

data/spec/spec_helper.rb

@@ -10,8 +10,7 @@ unless defined?(TEST_SERVER)
     :config => {
       :host => 'localhost', 
       :port => '7474', 
-      :path => '', 
-      :log_level => 'OFF'
+      :path => ''
     }
   }
   

metadata

@@ -1,12 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: architect4r
 version: !ruby/object:Gem::Version 
-  hash: 3
+  hash: 13
   prerelease: 
   segments: 
   - 0
   - 4
-  version: "0.4"
+  - 1
+  version: 0.4.1
 platform: ruby
 authors: 
 - Maximilian Schulz
@@ -14,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2012-01-30 00:00:00 Z
+date: 2012-01-31 00:00:00 Z
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: activemodel