neo4j 1.0.0.beta.13 → 1.0.0.beta.14

data/lib/neo4j/property.rb

@@ -1,6 +1,9 @@
 module Neo4j
   module Property
 
+    # Returns a hash of all properties
+    # It also include the id of the node with the key <tt>_neo_id</tt>
+    #
     def props
       ret = {"_neo_id" => neo_id}
       iter = getPropertyKeys.iterator
@@ -11,16 +14,24 @@ module Neo4j
       ret
     end
 
+    # Returns the unique id of this node.
+    # Ids are garbage collected over time so they are only guaranteed to be unique during a specific time span:
+    # if the node is deleted, it's likely that a new node at some point will get the old id. Note:
+    # this makes node ids brittle as public APIs.
     def neo_id
       getId
     end
 
+    # Returns a hash of properties with keys not starting with <tt>_</tt>
+    # That means that the neo_id will not be included in the returned hash.
+    #
     def attributes
       attr = props
       attr.keys.each { |k| attr.delete k if k[0] == ?_ }
       attr
     end
 
+    # Checks if the given key exist as a property.
     def property?(key)
       has_property?(key.to_s)
     end
@@ -29,11 +40,11 @@ module Neo4j
     # If the option <code>{:strict => true}</code> is given, any properties present on
     # the node but not present in the hash will be removed from the node.
     #
-    # === Parameters
-    # struct_or_hash<#each_pair>:: the key and value to be set, should respond to 'each_pair'
+    # ==== Parameters
+    # struct_or_hash:: the key and value to be set, should respond to <tt>each_pair</tt>
     # options:: further options defining the context of the update, should be a Hash
     #
-    # === Returns
+    # ==== Returns
     # self
     #
     def update(struct_or_hash, options={})
@@ -54,11 +65,16 @@ module Neo4j
       self
     end
 
+
+    # Returns the value of the given key or nil if the property does not exist.
     def [](key)
       return unless property?(key)
       get_property(key.to_s)
     end
 
+    # Sets the property of this node.
+    # Property keys are always strings. Valid property value types are the primitives(<tt>String</tt>, <tt>Fixnum</tt>, <tt>Float</tt>, <tt>Boolean</tt>), and arrays of those primitives.
+    #
     def []=(key, value)
       k = key.to_s
       if value.nil?

data/lib/neo4j/rails/model.rb

@@ -10,7 +10,6 @@ module Neo4j
       extend ActiveModel::Callbacks
       extend Neo4j::Validations::ClassMethods
       extend TxMethods
-#      extend ClassMethods::Relationship
 
       define_model_callbacks :create, :save, :update, :destroy
 

data/lib/neo4j/rails/value.rb

@@ -24,9 +24,9 @@ module Neo4j::Rails
       outgoing(java_type.name).new(other_java_node)
     end
 
-    def getSingleRelationship(type, dir)
+    def rel(dir, type)
       # TODO incoming not implemented, needed ?
-      @outgoing_rels[type.name] && @outgoing_rels[type.name].rels.first
+      @outgoing_rels[type.to_s] && @outgoing_rels[type.to_s].rels.first
     end
 
     def getRelationships(*args)

data/lib/neo4j/relationship.rb

@@ -4,6 +4,11 @@ module Neo4j
     include Neo4j::Property
     include Neo4j::Equal
 
+    alias_method :_end_node, :getEndNode
+    alias_method :_start_node, :getStartNode
+    alias_method :_other_node, :getOtherNode
+
+
     def del
       delete
     end
@@ -39,6 +44,17 @@ module Neo4j
     end
 
 
+    # Returns the relationship name
+    #
+    # ====Example
+    #   a = Neo4j::Node.new
+    #   a.outgoing(:friends) << Neo4j::Node.new
+    #   a.rels.first.rel_type # => 'friends'
+    #
+    def rel_type
+      getType().name()
+    end
+
     def class
       Neo4j::Relationship
     end

data/lib/neo4j/relationship_traverser.rb

@@ -15,6 +15,16 @@ module Neo4j
       @dir = dir_to_java(dir)
     end
 
+    def to_s
+      if @type
+        "#{self.class} [type: #{@type} dir:#{@dir}]"
+      elsif @types
+        "#{self.class} [types: #{@types.join(',')} dir:#{@dir}]"
+      else
+        "#{self.class} [types: ANY dir:#{@dir}]"
+      end
+    end
+
     def each
       iterator.each {|i| yield i.wrapper}
     end

data/lib/neo4j/to_java.rb

@@ -14,4 +14,18 @@ module Neo4j
       end
     end
   end
-end
+end
+
+
+org.neo4j.kernel.impl.core.IntArrayIterator.class_eval do
+  def each_wrapped
+    while(hasNext())
+      yield self.next().wrapper
+    end
+  end
+
+  def wrapped
+    Enumerator.new(self, :each_wrapped)
+  end
+
+end

data/lib/neo4j/version.rb

@@ -1,3 +1,3 @@
 module Neo4j
-  VERSION = "1.0.0.beta.13"
+  VERSION = "1.0.0.beta.14"
 end

data/neo4j.gemspec

@@ -13,18 +13,18 @@ Gem::Specification.new do |s|
   s.homepage = "http://github.com/andreasronge/neo4j/tree"
   s.rubyforge_project = 'neo4j'
   s.summary = "A graph database for JRuby"
-  s.description = s.summary
+  s.description = <<-EOF
+You can think of Neo4j as a high-performance graph engine with all the features of a mature and robust database.
+The programmer works with an object-oriented, flexible network structure rather than with strict and static tables — yet enjoys all the benefits of a fully transactional, enterprise-strength database.
+It comes included with the Apache Lucene document database.
+EOF
+
   s.require_path = 'lib'
   s.files        = Dir.glob("{bin,lib}/**/*") + %w(README.rdoc CHANGELOG CONTRIBUTORS Gemfile neo4j.gemspec)
   s.has_rdoc = true
   s.extra_rdoc_files = %w( README.rdoc )
   s.rdoc_options = ["--quiet", "--title", "Neo4j.rb", "--opname", "index.html", "--line-numbers", "--main", "README.rdoc", "--inline-source"]
   s.required_ruby_version = ">= 1.8.7"
-  s.add_dependency("activemodel", ["~> 3.0.0"])
-  s.add_dependency("railties", ["~> 3.0.0"])
-  s.add_development_dependency "rspec-apigen", ">= 0.0.4"
-  s.add_development_dependency "rspec", ">= 2.0.0.beta.20"
-  s.add_development_dependency "rspec-rails-matchers", "= 0.2.1"
-
-#  s.add_development_dependency "rspec-unit", ">= 0.0.1"
+  s.add_dependency("activemodel", ">= 3.0.0")
+  s.add_dependency("railties", ">= 3.0.0")
 end

metadata

@@ -7,8 +7,8 @@ version: !ruby/object:Gem::Version
     - 0
     - 0
     - beta
-    - 13
-  version: 1.0.0.beta.13
+    - 14
+  version: 1.0.0.beta.14
 platform: ruby
 authors: 
   - Andreas Ronge
@@ -16,7 +16,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-10-12 00:00:00 +02:00
+date: 2010-10-22 00:00:00 +02:00
 default_executable: 
 dependencies: 
   - !ruby/object:Gem::Dependency 
@@ -24,7 +24,7 @@ dependencies:
     prerelease: false
     requirement: &id001 !ruby/object:Gem::Requirement 
       requirements: 
-        - - ~>
+        - - ">="
           - !ruby/object:Gem::Version 
             segments: 
               - 3
@@ -38,7 +38,7 @@ dependencies:
     prerelease: false
     requirement: &id002 !ruby/object:Gem::Requirement 
       requirements: 
-        - - ~>
+        - - ">="
           - !ruby/object:Gem::Version 
             segments: 
               - 3
@@ -47,51 +47,9 @@ dependencies:
             version: 3.0.0
     type: :runtime
     version_requirements: *id002
-  - !ruby/object:Gem::Dependency 
-    name: rspec-apigen
-    prerelease: false
-    requirement: &id003 !ruby/object:Gem::Requirement 
-      requirements: 
-        - - ">="
-          - !ruby/object:Gem::Version 
-            segments: 
-              - 0
-              - 0
-              - 4
-            version: 0.0.4
-    type: :development
-    version_requirements: *id003
-  - !ruby/object:Gem::Dependency 
-    name: rspec
-    prerelease: false
-    requirement: &id004 !ruby/object:Gem::Requirement 
-      requirements: 
-        - - ">="
-          - !ruby/object:Gem::Version 
-            segments: 
-              - 2
-              - 0
-              - 0
-              - beta
-              - 20
-            version: 2.0.0.beta.20
-    type: :development
-    version_requirements: *id004
-  - !ruby/object:Gem::Dependency 
-    name: rspec-rails-matchers
-    prerelease: false
-    requirement: &id005 !ruby/object:Gem::Requirement 
-      requirements: 
-        - - "="
-          - !ruby/object:Gem::Version 
-            segments: 
-              - 0
-              - 2
-              - 1
-            version: 0.2.1
-    type: :development
-    version_requirements: *id005
-description: A graph database for JRuby
+description: "You can think of Neo4j as a high-performance graph engine with all the features of a mature and robust database.\n\
+  The programmer works with an object-oriented, flexible network structure rather than with strict and static tables \xE2\x80\x94 yet enjoys all the benefits of a fully transactional, enterprise-strength database.\n\
+  It comes included with the Apache Lucene document database.\n"
 email: andreas.ronge@gmail.com
 executables: []
 
@@ -114,7 +72,6 @@ files:
   - lib/neo4j/relationship_mixin.rb
   - lib/neo4j/load.rb
   - lib/neo4j/database.rb
-  - lib/neo4j/index.rb
   - lib/neo4j/version.rb
   - lib/neo4j/node_relationship.rb
   - lib/neo4j/equal.rb
@@ -142,6 +99,11 @@ files:
   - lib/neo4j/mapping/class_methods/root.rb
   - lib/neo4j/mapping/class_methods/init_rel.rb
   - lib/neo4j/mapping/class_methods/relationship.rb
+  - lib/neo4j/index/index_registry.rb
+  - lib/neo4j/index/wrapped_query.rb
+  - lib/neo4j/index/indexer.rb
+  - lib/neo4j/index/class_methods.rb
+  - lib/neo4j/index/index.rb
   - README.rdoc
   - CHANGELOG
   - CONTRIBUTORS

data/lib/neo4j/index.rb

@@ -1,248 +0,0 @@
-module Neo4j
-
-  module Index
-    def add_index(field, value=self[field])
-      self.class.add_index(wrapped_entity, field.to_s, value)
-    end
-
-    def rm_index(field, value=self[field])
-      self.class.rm_index(wrapped_entity, field.to_s, value)
-    end
-
-    module ClassMethods
-      extend Forwardable
-
-      def_delegators :@indexer, :index, :find, :index?, :index_type?, :clear_index_type, :rm_index_type, :add_index, :rm_index, :index_type_for, :index_name
-
-
-      # Sets which indexer should be used for the given node class
-      # Returns the old one if there was an old indexer.
-      def node_indexer(clazz)
-        indexer(clazz, :node)
-      end
-
-      # Sets which indexer should be used for the given relationship class
-      # Returns the old one if there was an old indexer.
-      def rel_indexer(clazz)
-        indexer(clazz, :rel)
-      end
-
-      def indexer(clazz, type)  #:nodoc:
-        old = @indexer
-        @@indexers ||= {}
-        if @@indexers.include?(clazz)
-          # we want to reuse an existing index
-          @indexer = @@indexers[clazz]
-          @indexer.include_trigger(self)
-        else
-          @indexer = Indexer.new(clazz, type)
-          @@indexers[clazz] = @indexer
-        end
-        old
-      end
-    end
-
-    class WrappedQuery
-      include Enumerable
-
-      def initialize(index, query)
-        @index = index
-        @query = query
-      end
-
-      def each
-        hits.each{|n| yield n.wrapper}
-      end
-
-      def close
-        @hits.close if @hits
-      end
-
-      def empty?
-        hits.size == 0
-      end
-
-      def size
-        hits.size
-      end
-
-      def hits
-        @hits ||= perform_query
-      end
-
-      def desc(*fields)
-        @order = fields.inject(@order || {}){|memo, field| memo[field] = true; memo}
-        self
-      end
-
-      def asc(*fields)
-        @order = fields.inject(@order || {}){|memo, field| memo[field] = false; memo}
-        self
-      end
-
-      def perform_query
-        if @order
-          java_sort_fields = @order.keys.inject([]) do |memo, field|
-            memo << org.apache.lucene.search.SortField.new(field.to_s, org.apache.lucene.search.SortField::STRING, @order[field])
-          end
-          sort = org.apache.lucene.search.Sort.new(*java_sort_fields)
-          @query = org.neo4j.index.impl.lucene.QueryContext.new(@query).sort(sort)
-        end
-        @index.query(@query)
-      end
-    end
-
-    class Indexer
-      attr_reader :index_name
-
-      def initialize(clazz, type)
-        @index_name = clazz.to_s
-
-        # do we want to index nodes or relationships ?
-        @type = type
-
-        @indexes = {}  # key = type, value = java neo4j index
-        @field_types = {}  # key = field, value = type (e.g. :exact or :fulltext)
-        @triggered_by = clazz.to_s
-      end
-
-      #  add an index on a field that will be automatically updated by events.
-      def index(field, conf = {})
-        type = conf[:type] || :exact
-        @field_types[field.to_s] = type
-        Neo4j.default_db.event_handler.add(self)
-      end
-
-      def index?(field)
-        @field_types.include?(field.to_s)
-      end
-
-      def index_type_for(field)
-        return nil unless index?(field)
-        @field_types[field.to_s]
-      end
-
-      def index_type?(type)
-        @field_types.values.include?(type)
-      end
-
-      def add_index(entity, field, value)
-        index_for_field(field.to_s).add(entity, field, value)
-      end
-
-      def rm_index(entity, field, value)
-        index_for_field(field).remove(entity, field, value)
-      end
-
-      def find(query, params = {})
-        type = params[:type] || :exact
-        index = index_for_type(type)
-        query = (params[:wrapped].nil? || params[:wrapped]) ? WrappedQuery.new(index, query) : index.query(query)
-
-        if block_given?
-          begin
-            ret = yield query
-          ensure
-            query.close
-          end
-          ret
-        else
-          query
-        end
-      end
-
-      # clears the index, if no type is provided clear all types of indexes
-      def clear_index_type(type=nil)
-        if type
-          #raise "can't clear index of type '#{type}' since it does not exist ([#{@field_types.values.join(',')}] exists)" unless index_type?(type)
-          @indexes[type] && @indexes[type].clear
-        else
-          @indexes.each_value{|index| index.clear}
-        end
-      end
-
-      def rm_index_type(type=nil)
-        if type
-          #raise "can't remove index of type '#{type}' since it does not exist ([#{@field_types.values.join(',')}] exists)" unless index_type?(type)
-          @field_types.delete_if {|k,v| v == type}
-        else
-          @field_types.clear
-        end
-      end
-
-      def index_for_field(field)
-        type = @field_types[field]
-        @indexes[type] ||= create_index_with(type)
-      end
-
-      def index_for_type(type)
-        @indexes[type] ||= create_index_with(type)
-      end
-
-      def lucene_config(type)
-        conf = Neo4j::Config[:lucene][type.to_sym]
-        raise "unknown lucene type #{type}" unless conf
-        conf
-      end
-
-      def create_index_with(type)
-        db=Neo4j.started_db
-        index_config = lucene_config(type)
-        if @type == :node
-          db.lucene.node_index("#{@index_name}-#{type}", index_config)
-        else
-          db.lucene.relationship_index("#{@index_name}-#{type}", index_config)
-        end
-      end
-
-
-      # ------------------------------------------------------------------
-      # Event Handling
-
-      def include_trigger(clazz)
-         @triggered_by << clazz.to_s  unless @triggered_by.include?(clazz.to_s)
-      end
-
-      def trigger?(classname)
-        @triggered_by.include?(classname || (@type==:node ? 'Neo4j::Node' : 'Neo4j::Relationship'))
-      end
-
-      def on_node_created(node)
-        return unless trigger?(node['_classname'])
-        @field_types.keys.each {|field| add_index(node, field, node[field]) if node.property?(field)}
-      end
-
-      def on_node_deleted(node, old_props)
-        return unless trigger?(old_props['_classname'])
-        @field_types.keys.each {|field| rm_index(node, field, old_props[field]) if old_props[field]}
-      end
-
-      def on_property_changed(node, field, old_val, new_val)
-        return unless trigger?(node[:_classname]) && @field_types.include?(field)
-
-        rm_index(node, field, old_val) if old_val
-
-        # add index
-        add_index(node, field, new_val) if new_val
-      end
-
-      def on_rel_property_changed(rel, field, old_val, new_val)
-        # works exactly like for nodes
-        on_property_changed(rel, field, old_val, new_val)
-      end
-
-      def on_relationship_created(rel)
-        # works exactly like for nodes
-        on_node_created(rel)
-      end
-
-      def on_relationship_deleted(rel, old_props)
-        # works exactly like for nodes
-        on_node_deleted(rel, old_props)
-      end
-
-    end
-
-  end
-
-end