neo4j 1.2.5-java → 1.2.6-java

data/CHANGELOG

@@ -1,3 +1,11 @@
+ == 1.2.6 / 2011-11-02
+* Generators can now generate relationships as well [#195]
+* Better will_paginate support for Neo4j::Rails::Model [#194]
+* Fixing updated_at to be set only if model has changed (pull #68, Deepak N)
+* Bringing back changes removed during identiy map to fix bug [#190] (Deepak N)
+* Fixing updated_at to be set only if model has changed, using callbacks instead of overriding method for stamping time (Deepak N)
+* Added versioning support (pull #67) (Vivek Prahlad)
+
  == 1.2.5 / 2011-10-21
 * Faster traversals by avoiding loading Ruby wrappers (new method 'raw' on traversals) [#189]
 * Support for IdentityMap [#188]

data/Gemfile

@@ -6,7 +6,7 @@ group 'test' do
   gem "rake", ">= 0.8.7"
   gem "rdoc", ">= 2.5.10"
   gem "horo", ">= 1.0.2"
-  gem "rspec", ">= 2.0.0"
+  gem "rspec", "= 2.6.0"
 
   # use this version for rspec-rails-matchers which work with latest RSpec (Rspec => RSpec)
   gem "rspec-rails-matchers", :git => 'git://github.com/afcapel/rspec-rails-matchers.git'

data/lib/generators/neo4j.rb

@@ -2,63 +2,71 @@ require 'rails/generators/named_base'
 require 'rails/generators/active_model'
 
 module Neo4j
-	module Generators #:nodoc:
-	end
+  module Generators #:nodoc:
+  end
 end
 
 class Neo4j::Generators::Base < Rails::Generators::NamedBase #:nodoc:
-	def self.source_root
-		@_neo4j_source_root ||= File.expand_path(File.join(File.dirname(__FILE__),
-			'neo4j', generator_name, 'templates'))
-	end
+  def self.source_root
+    @_neo4j_source_root ||= File.expand_path(File.join(File.dirname(__FILE__),
+                                                       'neo4j', generator_name, 'templates'))
+  end
 end
 
 class Neo4j::Generators::ActiveModel < Rails::Generators::ActiveModel #:nodoc:
-	def self.all(klass)
-		"#{klass}.all"
-	end
+  def self.all(klass)
+    "#{klass}.all"
+  end
 
-	def self.find(klass, params=nil)
-		"#{klass}.find(#{params})"
-	end
+  def self.find(klass, params=nil)
+    "#{klass}.find(#{params})"
+  end
 
-	def self.build(klass, params=nil)
-		if params
-			"#{klass}.new(#{params})"
-		else
-			"#{klass}.new"
-		end
-	end
+  def self.build(klass, params=nil)
+    if params
+      "#{klass}.new(#{params})"
+    else
+      "#{klass}.new"
+    end
+  end
 
-	def save
-		"#{name}.save"
-	end
+  def save
+    "#{name}.save"
+  end
 
-	def update_attributes(params=nil)
-		"#{name}.update_attributes(#{params})"
-	end
+  def update_attributes(params=nil)
+    "#{name}.update_attributes(#{params})"
+  end
 
-	def errors
-		"#{name}.errors"
-	end
+  def errors
+    "#{name}.errors"
+  end
 
-	def destroy
-		"#{name}.destroy"
-	end
+  def destroy
+    "#{name}.destroy"
+  end
 end
 
 module Rails
   module Generators
     class GeneratedAttribute #:nodoc:
       def type_class
-      	case type.to_s.downcase
-					when 'datetime' 										then 'DateTime'
-					when 'date' 												then 'Date'
-					when 'text' 												then 'String'
-					when 'integer', 'number', 'fixnum' 	then 'Fixnum'
-					when 'float' 												then 'Float'
-					else 'String'
-      	end
+        case type.to_s.downcase
+          when 'any' then
+            'any'
+          when 'datetime' then
+            'DateTime'
+          when 'date' then
+            'Date'
+          when 'text' then
+            'String'
+          when 'integer', 'number', 'fixnum' then
+            'Fixnum'
+          when 'float' then
+            'Float'
+          else
+            'String'
+        end
       end
     end
   end

data/lib/generators/neo4j/model/model_generator.rb

@@ -7,7 +7,10 @@ class Neo4j::Generators::ModelGenerator < Neo4j::Generators::Base #:nodoc:
 	
 	class_option :timestamps, :type => :boolean
 	class_option :parent,     :type => :string, :desc => "The parent class for the generated model"
-	
+  class_option :indices,    :type => :array,  :desc => "The properties which should be indexed"
+  class_option :has_one,    :type => :array,  :desc => "A list of has_one relationships"
+  class_option :has_n,      :type => :array,  :desc => "A list of has_n relationships"
+
 	def create_model_file
 		template "model.erb", File.join('app/models', "#{singular_name}.rb")
 	end
@@ -20,7 +23,47 @@ class Neo4j::Generators::ModelGenerator < Neo4j::Generators::Base #:nodoc:
 	def timestamps?
 		options[:timestamps]
 	end
-	
+
+  def has_n?
+    options[:has_n]
+  end
+
+  def has_n_statements
+    txt = ""
+    options[:has_n].each do |key|
+      to, from = key.split(':')
+      txt << (from ? "\n  has_n(:#{to}).from(:#{from})\n" : "\n  has_n :#{to}")
+    end
+    txt
+  end
+
+  def has_one?
+    options[:has_one]
+  end
+
+  def has_one_statements
+    txt = ""
+    options[:has_one].each do |key|
+      to, from = key.split(':')
+      txt << (from ? "\n  has_one(:#{to}).from(:#{from})\n" : "\n  has_one :#{to}")
+    end
+    txt
+  end
+
+  def indices?
+    options[:indices]
+  end
+
+  def indices_statements
+    puts "indices_statements #{options[:indices].inspect}"
+    txt = ""
+    options[:indices].each do |key|
+      txt << %Q{
+  index :#{key}}
+    end
+    txt
+  end
+
 	def parent?
 		options[:parent]
 	end

data/lib/generators/neo4j/model/templates/model.erb

@@ -1,7 +1,11 @@
 class <%= class_name %> < <%= parent? ? options[:parent].classify : "Neo4j::Rails::Model" %>
 <% attributes.each do |attribute| -%>
-  property :<%= attribute.name %><%= ", :type => #{attribute.type_class}" %>
+  property :<%= attribute.name %><%= ", :type => #{attribute.type_class}" unless attribute.type_class == 'any' %>
 <% end -%>
+<%= indices_statements if indices? -%>
+
+<%= has_n_statements if has_n? -%>
+<%= has_one_statements if has_one? -%>
 
 <%= timestamp_statements if timestamps? -%>
 end

data/lib/neo4j.rb

@@ -70,6 +70,7 @@ end
 
 require 'neo4j/version'
 require 'neo4j/neo4j'
+require 'neo4j/paginate'
 require 'neo4j/node'
 require 'neo4j/relationship'
 require 'neo4j/relationship_set'
@@ -104,7 +105,4 @@ require 'neo4j/batch/batch'
 
 require 'orm_adapter/adapters/neo4j'
 
-require 'neo4j/identity_map'
-
-
-
+require 'neo4j/identity_map'

data/lib/neo4j/index/indexer.rb

@@ -330,9 +330,10 @@ module Neo4j
       def index_prefix
         return "" unless Neo4j.running?
         return "" unless @indexer_for.respond_to?(:ref_node_for_class)
-        ref_node = @indexer_for.ref_node_for_class
-        ref_node_name = ref_node[:name]
-        ref_node_name.blank? ? "" : ref_node_name + "_"
+        ref_node = @indexer_for.ref_node_for_class.wrapper
+        prefix = ref_node.send(:_index_prefix) if ref_node.respond_to?(:_index_prefix)
+        prefix ||= ref_node[:name] # To maintain backward compatiblity
+        prefix.blank? ? "" : prefix + "_"
       end
     end
   end

data/lib/neo4j/paginate.rb

@@ -0,0 +1,25 @@
+module Neo4j
+  module Paginate
+    def self.included(base)
+      base.send(:include, WillPaginate::Finders::Base)
+    end
+
+
+    def wp_query(options, pager, args, &block) #:nodoc:
+      page = pager.current_page || 1
+      per_page = pager.per_page
+      to = per_page * page
+      from = to - per_page
+      i = 0
+      res = []
+      each do |node|
+        res << node.wrapper if i >= from
+        i += 1
+        break if i >= to
+      end
+      pager.replace res
+      pager.total_entries ||= count
+    end
+
+  end
+end

data/lib/neo4j/rails/model.rb

@@ -262,9 +262,9 @@ module Neo4j
       include Attributes # handles how to save and retrieve attributes
       include Mapping::Property # allows some additional options on the #property class method
       include Serialization # enable to_xml and to_json
-      include Timestamps # handle created_at, updated_at timestamp properties
       include Validations # enable validations
       include Callbacks # enable callbacks
+      include Timestamps # handle created_at, updated_at timestamp properties
       include ActiveModel::Observing # enable observers
       include Finders # ActiveRecord style find
       include Relationships # for none persisted relationships

data/lib/neo4j/rails/rails.rb

@@ -23,3 +23,4 @@ require 'neo4j/rails/model'
 require 'neo4j/rails/rack_middleware'
 require 'neo4j/rails/rel_persistence'
 require 'neo4j/rails/relationship'
+require 'neo4j/rails/versioning/versioning'

data/lib/neo4j/rails/relationship.rb

@@ -88,6 +88,10 @@ module Neo4j
         @properties = {}
       end
 
+      def wrapper
+        self
+      end
+
       # --------------------------------------
       # Public Class Methods
       # --------------------------------------
@@ -128,9 +132,9 @@ module Neo4j
       include Attributes # handles how to save and retrieve attributes
       include Mapping::Property # allows some additional options on the #property class method
       include Serialization # enable to_xml and to_json
-      include Timestamps # handle created_at, updated_at timestamp properties
       include Validations # enable validations
       include Callbacks # enable callbacks
+      include Timestamps # handle created_at, updated_at timestamp properties
       include Finders # ActiveRecord style find
       include Compositions
     end

data/lib/neo4j/rails/relationships/node_dsl.rb

@@ -9,6 +9,7 @@ module Neo4j
       #
       class NodesDSL
         include Enumerable
+        include Neo4j::Paginate
 
         def initialize(storage, dir)
           @storage = storage

data/lib/neo4j/rails/relationships/relationships.rb

@@ -2,13 +2,19 @@ module Neo4j
   module Rails
     module Relationships
 
-
       def write_changed_relationships #:nodoc:
         @_relationships.each_value do |storage|
           storage.persist
         end
       end
 
+      def relationships_changed?
+        @_relationships.each_value do |storage|
+          return true if !storage.persisted?
+        end
+        false
+      end
+
       def clear_relationships #:nodoc:
         @_relationships && @_relationships.each_value{|storage| storage.remove_from_identity_map}
         @_relationships = {}

data/lib/neo4j/rails/relationships/rels_dsl.rb

@@ -18,6 +18,7 @@ module Neo4j
       #
       class RelsDSL
         include Enumerable
+        include Neo4j::Paginate
 
         def initialize(storage, dir=:both)
           @storage = storage

data/lib/neo4j/rails/relationships/storage.rb

@@ -14,13 +14,15 @@ module Neo4j
           @target_class = (dsl && dsl.target_class) || Neo4j::Rails::Model
           @outgoing_rels = []
           @incoming_rels = []
+          @persisted_related_nodes = {}
+          @persisted_relationships = {}
+          @persisted_node_to_relationships = {}
         end
 
         def to_s #:nodoc:
           "Storage #{object_id} node: #{@node.id} rel_type: #{@rel_type} outgoing #{@outgoing_rels.size} incoming #{@incoming_rels.size}"
         end
 
-
         def remove_from_identity_map
           @outgoing_rels.each {|r| Neo4j::IdentityMap.remove(r._java_rel)}
           @incoming_rels.each {|r| Neo4j::IdentityMap.remove(r._java_rel)}
@@ -35,7 +37,6 @@ module Neo4j
           counter
         end
 
-
         def build(attrs)
           @target_class.new(attrs)
         end
@@ -60,14 +61,34 @@ module Neo4j
         end
 
         def each_rel(dir, &block) #:nodoc:
-          relationships(dir).each { |rel| block.call rel }          
+          relationships(dir).each { |rel| block.call rel }
           if @node.persisted?
-            @node._java_node.getRelationships(java_rel_type, dir_to_java(dir)).each do |rel|
-              block.call(rel.wrapper)
-            end
+            cache_relationships(dir) if @persisted_relationships[dir].nil?
+            @persisted_relationships[dir].each {|rel| block.call rel unless !rel.exist?}
+          end
+        end
+
+        def cache_relationships(dir)
+          @persisted_relationships[dir] ||= []
+          node._java_node.getRelationships(java_rel_type, dir_to_java(dir)).each do |rel|
+            @persisted_relationships[dir] << rel.wrapper
+          end
+        end
+
+        def cache_persisted_nodes_and_relationships(dir)
+          @persisted_related_nodes[dir] ||= []
+          @persisted_node_to_relationships[dir] ||= {}
+          @node._java_node.getRelationships(java_rel_type, dir_to_java(dir)).each do |rel|
+            end_node = rel.getOtherNode(@node._java_node).wrapper
+            @persisted_related_nodes[dir] << end_node
+            @persisted_node_to_relationships[dir][end_node]=rel
           end
         end
-        
+
+        def relationship_deleted?(dir,node)
+          @persisted_node_to_relationships[dir][node].nil? || !@persisted_node_to_relationships[dir][node].exist?
+        end
+
         def each_node(dir, &block)
           relationships(dir).each do |rel|
             if rel.start_node == @node
@@ -76,18 +97,14 @@ module Neo4j
               block.call rel.start_node
             end
           end
-
           if @node.persisted?
-            @node._java_node.getRelationships(java_rel_type, dir_to_java(dir)).each do |rel|
-              end_node = rel.getOtherNode(@node._java_node).wrapper
-              block.call(end_node)
-            end
+            cache_persisted_nodes_and_relationships(dir) if @persisted_related_nodes[dir].nil?
+            @persisted_related_nodes[dir].each {|node| block.call node unless relationship_deleted?(dir,node)}
           end
         end
 
         def single_relationship(dir, raw = false)
           rel = relationships(dir).first
-#          puts "single_relationship #{dir} for #{self}, got #{rel && rel._java_rel} @node.persisted?=#{@node.persisted?}, #{@node._java_node}"
           if rel.nil? && @node.persisted?
             java_rel = @node._java_node.getSingleRelationship(java_rel_type, dir_to_java(dir))
             raw ? java_rel : java_rel && java_rel.wrapper
@@ -145,7 +162,7 @@ module Neo4j
           out_rels = @outgoing_rels.clone
           in_rels = @incoming_rels.clone
 
-          [@outgoing_rels, @incoming_rels].each{|c| c.clear}
+          [@outgoing_rels, @incoming_rels, @persisted_related_nodes, @persisted_node_to_relationships, @persisted_relationships].each{|c| c.clear}
 
           out_rels.each do |rel|
             rel.end_node.rm_incoming_rel(@rel_type.to_sym, rel) if rel.end_node

data/lib/neo4j/rails/timestamps.rb

@@ -6,16 +6,10 @@ module Neo4j
 
 			TIMESTAMP_PROPERTIES = [ :created_at, :created_on, :updated_at, :updated_on ]
 
-			def write_changed_attributes
-				update_timestamp
-				super
-			end
-
-			def init_on_create(*args)
-				create_timestamp
-				super
-			end
-
+      included do
+        before_create :create_timestamp
+        before_save :update_timestamp, :if => :new_or_changed?
+      end
 			# Set the timestamps for this model if timestamps is set to true in the config
 			# and the model is set up with the correct property name, e.g.:
 			#
@@ -50,6 +44,10 @@ module Neo4j
 				send("#{attribute}=", value)
 			end
 
+      def new_or_changed?
+        self.new? or self.changed?
+      end
+
 			module ClassMethods
 				def property_setup(property, options)
 					super

data/lib/neo4j/rails/versioning/versioning.rb

@@ -0,0 +1,131 @@
+module Neo4j
+  module Rails
+    # Adds snapshot based versioning to Neo4j Rails models
+    # To use versioning, include this module in your model.
+    #
+    # Example:
+    #   class VersionableModel < Neo4j::Rails::Model
+    #     include Neo4j::Rails::Versioning
+    #   end
+    #
+    # To find out the number of versions of an instance, you can use the current_version method.
+    #
+    # To retrieve a snapshot of an older version, use the version method.
+    #   snapshot = instance.version(1) #Retrieves version 1.
+    #
+    # Note that the version numbers start from 1 onwards.
+    #
+    # The snapshot retains all the properties and relationships at the point when a versioned model is saved.
+    # The snapshot also allows you to traverse incoming and outgoing relationships.
+    #
+    # For example:
+    #   snapshot.incoming(:friends) would return a collection of nodes that are related via the friends relationship.
+    #
+    # The snapshot node creates relationships with a model's related nodes with a "version_" prefix in order to
+    # avoid name clashes. However, you can call the incoming and outgoing methods using your model's relationship names.
+    #
+    # To control the maximum number of versions created, you can use the max_versions property.
+    #
+    # Example:
+    #   class MaxVersionableModel < Neo4j::Rails::Model
+    #     include Neo4j::Rails::Versioning
+    #     max_versions 10
+    #   end
+    module Versioning
+      extend ActiveSupport::Concern
+
+      class Version
+        include Neo4j::RelationshipMixin
+        property :number, :type => Fixnum
+        property :instance_id, :type => Fixnum
+        property :model_classname
+        index :number, :instance_id, :model_classname
+      end
+
+      class Snapshot
+        include Neo4j::NodeMixin
+
+        def incoming(rel_type)
+          super "version_#{rel_type.to_s}".to_sym
+        end
+
+        def outgoing(rel_type)
+          super "version_#{rel_type.to_s}".to_sym
+        end
+      end
+
+      included do
+        class_attribute :version_max
+        property :_version, :type => Fixnum
+      end
+
+      ##
+      # Returns the current version of a model instance
+      def current_version
+        self._version ||= 0
+      end
+
+      ##
+      # Returns the snapshot version for a given instance.
+      # @param [ Integer ] number The version number to retrieve.
+      # Returns nil in case a version is not found.
+      def version(number)
+        Version.find(:model_classname => _classname, :instance_id => neo_id, :number => number) {|query| query.first.nil? ? nil : query.first.end_node}
+      end
+
+      ##
+      # Overrides Rails's save method to save snapshots.
+      def save
+        if self.changed? || self.relationships_changed?
+          self._version = current_version + 1
+          super
+          revise
+        end
+      end
+
+      private
+      def revise
+        Neo4j::Transaction.run do
+          snapshot = Snapshot.new(self.props.reject{|key, value| key.to_sym == :_classname})
+          version_relationships(snapshot)
+          delete_old_version if version_max.present? && number_of_versions >= version_max
+          Version.new(:version, self, snapshot, :model_classname => _classname, :instance_id => neo_id, :number => current_version)
+        end
+      end
+
+      def number_of_versions
+        Version.find(:model_classname => _classname, :instance_id => neo_id) {|query| query.size}
+      end
+
+      def version_relationships(snapshot)
+        self._java_node.getRelationships().each do |rel|
+          if (self._java_node == rel.getStartNode())
+            snapshot._java_node.createRelationshipTo(rel.getEndNode(), relationship_type(rel.getType()))
+          else
+            rel.getStartNode().createRelationshipTo(snapshot._java_node, relationship_type(rel.getType()))
+          end
+        end
+      end
+
+      def relationship_type(rel_type)
+        org.neo4j.graphdb.DynamicRelationshipType.withName( "version_#{rel_type.name}" )
+      end
+
+      def delete_old_version
+        versions = Version.find(:model_classname => _classname).asc(:number)
+        versions.first.del
+        versions.close
+      end
+
+      module ClassMethods #:nodoc:
+
+        # Sets the maximum number of versions to store.
+        #
+        # @param [ Integer ] number The maximum number of versions to store.
+        def max_versions(number)
+          self.version_max = number.to_i
+        end
+      end
+    end
+  end
+end

data/lib/neo4j/traversal/traverser.rb

@@ -31,7 +31,7 @@ module Neo4j
     class Traverser
       include Enumerable
       include ToJava
-      include WillPaginate::Finders::Base
+      include Neo4j::Paginate
 
 
       def initialize(from, type = nil, dir=nil)
@@ -85,22 +85,6 @@ module Neo4j
       end
 
 
-      def wp_query(options, pager, args, &block) #:nodoc:
-        page = pager.current_page || 1
-        per_page = pager.per_page
-        to = per_page * page
-        from = to - per_page
-        i = 0
-        res = []
-        iterator.each do |node|
-          res << node.wrapper if i >= from
-          i += 1
-          break if i >= to
-        end
-        pager.replace res
-        pager.total_entries ||= count
-      end
-
       def <<(other_node)
         new(other_node)
         self

data/lib/neo4j/version.rb

@@ -1,3 +1,3 @@
 module Neo4j
-  VERSION = "1.2.5"
+  VERSION = "1.2.6"
 end

metadata

@@ -2,7 +2,7 @@
 name: neo4j
 version: !ruby/object:Gem::Version 
   prerelease: 
-  version: 1.2.5
+  version: 1.2.6
 platform: java
 authors: 
   - Andreas Ronge
@@ -10,7 +10,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-10-21 00:00:00 +02:00
+date: 2011-11-03 00:00:00 +01:00
 default_executable: 
 dependencies: 
   - !ruby/object:Gem::Dependency 
@@ -92,6 +92,7 @@ files:
   - lib/neo4j/neo4j.rb
   - lib/neo4j/node.rb
   - lib/neo4j/load.rb
+  - lib/neo4j/paginate.rb
   - lib/neo4j/database.rb
   - lib/neo4j/relationship_set.rb
   - lib/neo4j/version.rb
@@ -143,6 +144,7 @@ files:
   - lib/neo4j/rails/relationships/node_dsl.rb
   - lib/neo4j/rails/relationships/relationships.rb
   - lib/neo4j/rails/relationships/storage.rb
+  - lib/neo4j/rails/versioning/versioning.rb
   - lib/neo4j/rails/mapping/property.rb
   - lib/neo4j/rails/validations/associated.rb
   - lib/neo4j/rails/validations/uniqueness.rb