neo4j-wrapper 0.0.1-java

data/lib/neo4j-wrapper/node_mixin/delegates.rb

@@ -0,0 +1,140 @@
+module Neo4j
+  module Wrapper
+    module NodeMixin
+      module Delegates
+        class << self
+          private
+          # @macro  [new] node.delegate
+          #   @method $1(*args, &block)
+          #   Delegates to {http://rdoc.info/github/andreasronge/neo4j-core/master/Neo4j/Core/$2#$1-instance_method Neo4j::Core::Node#$1} using the <tt>_java_entity</tt> instance with the supplied parameters.
+          #   @see Neo4j::NodeMixin#_java_entity
+          #   @see http://rdoc.info/github/andreasronge/neo4j-core/master/Neo4j/Core/$2#$1-instance_method Neo4j::Core::Node#$1
+          def delegate(*args)
+            method_name = args.first
+            class_eval(<<-EOM, __FILE__, __LINE__)
+              def #{method_name}(*args, &block)
+                _java_entity.send(:#{method_name}, *args, &block)
+              end
+            EOM
+          end
+        end
+
+
+        # Methods included from Core::Property
+        # [], #[]=, #neo_id, #property?, #props, #update
+
+        # @macro  node.delegate
+        delegate :[]=, 'Property'
+
+        # @macro  node.delegate
+        delegate :[], 'Property'
+
+        # @macro  node.delegate
+        delegate :property?, 'Property'
+
+        # @macro  node.delegate
+        delegate :props, 'Property'
+
+        # @macro  node.delegate
+        delegate :update, 'Property'
+
+        # @macro  node.delegate
+        delegate :neo_id, 'Property'
+
+
+        #Methods included from Core::Rels
+        # _node, #_nodes, #_rel, #_rels, #node, #nodes, #rel, #rel?, #rels
+
+        # @macro  node.delegate
+        delegate :node, 'Rels'
+
+        # @macro  node.delegate
+        delegate :_node, 'Rels'
+
+        # @macro  node.delegate
+        delegate :nodes, 'Rels'
+
+        # @macro  node.delegate
+        delegate :_nodes, 'Rels'
+
+        # @macro  node.delegate
+        delegate :rel, 'Rels'
+
+        # @macro  node.delegate
+        delegate :_rel, 'Rels'
+
+        # @macro  node.delegate
+        delegate :rels, 'Rels'
+
+        # @macro  node.delegate
+        delegate :_rels, 'Rels'
+
+        # @macro  node.delegate
+        delegate :rel?, 'Rels'
+
+
+        # Methods included from Core::Traversal
+        # both, #eval_paths, #expand, #incoming, #outgoing, #unique
+
+        # @macro  node.delegate
+        delegate :both, 'Traversal'
+
+        # @macro  node.delegate
+        delegate :eval_paths, 'Traversal'
+
+        # @macro  node.delegate
+        delegate :expand, 'Traversal'
+
+        # @macro  node.delegate
+        delegate :incoming, 'Traversal'
+
+        # @macro  node.delegate
+        delegate :outgoing, 'Traversal'
+
+        # @macro  node.delegate
+        delegate :unique, 'Traversal'
+
+
+        # Methods included from Core::Node
+        # #del, #exist?
+
+        # @macro  node.delegate
+        delegate :del, 'Node'
+
+        # @macro  node.delegate
+        delegate :exist?, 'Node'
+
+        # Methods included from Core::Property::Java
+        #get_property, #graph_database, #property_keys, #remove_property, #set_property
+
+        # @macro  node.delegate
+        delegate :get_property, 'Property/Java'
+
+        # @macro  node.delegate
+        delegate :set_property, 'Property/Java'
+
+        # @macro  node.delegate
+        delegate :property_keys, 'Property/Java'
+
+        # @macro  node.delegate
+        delegate :remove_property, 'Property/Java'
+
+        # Methods included from Core::Equal
+        #==, #eql?, #equal?
+
+        # @macro  node.delegate
+        delegate :equal?, 'Equal'
+
+        # @macro  node.delegate
+        delegate :eql?, 'Equal'
+
+
+        # @macro  node.delegate
+        delegate :==
+
+        # @macro  node.delegate
+        delegate :getId
+      end
+    end
+  end
+end

data/lib/neo4j-wrapper/node_mixin/initialize.rb

@@ -0,0 +1,43 @@
+module Neo4j
+  module Wrapper
+    module NodeMixin
+      module Initialize
+
+        # Init this node with the specified java neo node
+        # @param [Neo4j::Node] java_node the node this instance wraps
+        def init_on_load(java_node)
+          @_java_node = java_node
+        end
+
+
+        # Creates a new node and initialize with given properties.
+        # You can override this to provide your own initialization.
+        #
+        # @param [Object, :each_pair] args if the first item in the list implements :each_pair then it will be initialize with those properties
+        def init_on_create(*args)
+          _java_entity[:_classname] = self.class.to_s
+          if args[0].respond_to?(:each_pair)
+            args[0].each_pair { |k, v| respond_to?("#{k}=") ? self.send("#{k}=", v) : _java_entity[k] = v }
+          end
+        end
+
+        # @return [Neo4j::Node] Returns the org.neo4j.graphdb.Node wrapped object
+        # @see http://rdoc.info/github/andreasronge/neo4j-core/master/Neo4j/Node
+        def _java_node
+          @_java_node
+        end
+
+        # Implements the Neo4j::Node#wrapper and Neo4j::Relationship#wrapper method
+        # so that we don't have to care if the node is wrapped or not.
+        # @return self
+        def wrapper
+          self
+        end
+
+        alias_method :_java_entity, :_java_node
+
+      end
+    end
+  end
+
+end

data/lib/neo4j-wrapper/properties/class_methods.rb

@@ -0,0 +1,150 @@
+module Neo4j
+  module Wrapper
+    module Property
+
+      module ClassMethods
+
+        # @return [Hash] a hash of all properties and its configuration defined by property class method
+        def _decl_props
+          @_decl_props ||= {}
+        end
+
+        # make sure the inherited classes inherit the <tt>_decl_props</tt> hash
+        def inherited(klass)
+          klass.instance_variable_set(:@_decl_props, _decl_props.clone)
+          super
+        end
+
+        # Generates accessor method and sets configuration for Neo4j node properties.
+        # The generated accessor creates a wrapper around the <tt>#[]</tt> and <tt>#[]=</tt> operators and
+        # support conversion of values before it is read or written to the database, using the <tt>:type</tt> config parameter.
+        # If a property is set to nil the property will be removed (just like the <tt>#[]=</tt>accessor])
+        # A lucene index can also be specified, using the <tt>:index</tt> config parameter.
+        # If you want to add index on a none declared property you can (still) use the <tt>index</tt> class method, see
+        # {Neo4j::Core::Index::Indexer}[http://rdoc.info/github/andreasronge/neo4j-core/master/Neo4j/Core/Index/Indexer]
+        #
+        # === :type
+        # A property can be of any primitive type (Boolean, String, Fixnum, Float)
+        # and does not even have to be the same. Arrays of primitive types is also supported. Array values must
+        # be of the same type and are mutable, e.g. you have to create a new array if you want to change one value.
+        # To make sure a property is always stored as the same type you can use the TypeConverter, which is specified using
+        # either the <tt>:type</tt> or the <tt>:converter</tt> parameter. This is also important when indexing, e.g finding a
+        # property which has been declared as a Fixnum but queried as a String will not work.
+        #
+        # === :converter
+        # You can implement your own converter, see Neo4j::TypeConverters.
+        # You can write your own converter by writing a class that respond to <tt>:index_as</tt>, <tt>:to_ruby</tt> and
+        # <tt>:to_java</tt>.
+        #
+        # === :index
+        # If a <tt>:index</tt> is specified the property will be automatically indexed.
+        # By default, there are two different indices available: <tt>:fulltext</tt> and <tt>:exact</tt>
+        # If not specified in a query it will use by default an <tt>:exact</tt> index.
+        # Notice, that you can't combine a fulltext and exact lucene query in the same query.
+        # If you are using fulltext index you <b>must</b> specify the type parameter in the find method
+        # (<tt>:exact</tt> is default).
+        # Also, if you want to sort or do range query make sure use the same query parameters as the declared type
+        # For example if you index with <tt>property :age, :index => :exact, :type => Fixnum)</tt> then you must query
+        # with age parameter being a fixnum, see examples below.
+        #
+        # @example a property with an index
+        #
+        #   class Foo
+        #     include Neo4j::NodeMixin
+        #     property :description, :index => :fulltext
+        #   end
+        #
+        # @example Lucene Query
+        #   Foo.find("description: bla", :type => :fulltext)
+        #   Foo.find({:description =>  "bla"}, {:type => :fulltext})
+        #
+        # @example Lucene Query with a Fixnum index
+        #   Foo.find(:age =>  35)
+        #   Foo.find(:age =>  (32..37))
+        #   Foo.find("age: 35") # does not work !
+        #
+        # === More Examples
+        #
+        # @example declare a property
+        #   class Foo
+        #     include Neo4j::NodeMixin
+        #     property :age
+        #   end
+        #
+        # @example use a declared property
+        #   foo = Foo.new
+        #   foo.age = "hej" # first set it to string
+        #   foo.age = 42  # change it to a Fixnum
+        #
+        # However, you can specify an type for the index, see Neo4j::Index::Indexer#index
+        #
+        # @example conversion of none primitive types
+        #
+        #   class Foo
+        #     include Neo4j::NodeMixin
+        #     property :since, :type => DateTime  # will be converted into a fixnum
+        #   end
+        #
+        # @example declare several properties in one line
+        #
+        #   class Foo
+        #     include Neo4j::NodeMixin
+        #     property :name, :description, :type => String, :index => :exact
+        #   end
+        #
+        # @param [Symbol, Hash] props one or more properties and optionally last a Hash for options
+        # @see Neo4j::TypeConverters
+        # @see http://rdoc.info/github/andreasronge/neo4j-core/master/Neo4j/Core/Index/LuceneQuery Neo4j::Core::Index::LuceneQuery
+        # @see http://rdoc.info/github/andreasronge/neo4j-core/master/Neo4j/Core/Index/Indexer Neo4j::Core::Index::Indexer
+        def property(*props)
+          options = props.last.kind_of?(Hash) ? props.pop : {}
+
+          props.uniq.each do |prop|
+            pname = prop.to_sym
+            _decl_props[pname] ||= {}
+            options.each { |key, value| _decl_props[pname][key] = value }
+
+            converter = options[:converter] || Neo4j::TypeConverters.converter(_decl_props[pname][:type])
+            _decl_props[pname][:converter] = converter
+
+            if options.include?(:index)
+              index(pname, :type => options[:index], :field_type => converter.index_as)
+            end
+
+            define_method(pname) do
+              self.class._converter(pname).to_ruby(self[pname])
+            end
+
+            name = (pname.to_s() +"=").to_sym
+            define_method(name) do |value|
+              self[pname] = self.class._converter(pname).to_java(value)
+            end
+          end
+        end
+
+
+        # @param [String, Symbol] prop_name the name of the property
+        # @return [#to_java, #to_ruby, #field_type] a converter for the given property name
+        # @note if the property has not been defined it will return the DefaultConverter
+        # @see Neo4j::TypeConverters::DefaultConverter
+        def _converter(prop_name)
+          prop_conf = _decl_props[prop_name.to_sym]
+          Neo4j::TypeConverters::DefaultConverter unless prop_conf
+          prop_conf[:converter]
+        end
+
+        # Returns true if the given property name has been defined with the class
+        # method property or properties.
+        #
+        # Notice that the node may have properties that has not been declared.
+        # It is always possible to set an undeclared property on a node.
+        #
+        # @return [true, false]
+        def property?(prop_name)
+          return false if _decl_props[prop_name.to_sym].nil?
+          !_decl_props[prop_name.to_sym].nil?
+        end
+      end
+    end
+  end
+end

data/lib/neo4j-wrapper/relationship_mixin/class_methods.rb

@@ -0,0 +1,30 @@
+module Neo4j
+  module Wrapper
+    module RelationshipMixin
+      module ClassMethods
+
+        # Creates a relationship between given nodes.
+        #
+        # You can use two callback method to initialize the relationship
+        # init_on_load:: this method is called when the relationship is loaded from the database
+        # init_on_create:: called when the relationship is created, will be provided with the same argument as the new method
+        #
+        # @param [String, Symbol] type the type of the relationships
+        # @param [Neo4j::Node, Neo4j::NodeMixin] from_node create relationship from this node
+        # @param [Neo4j::Node, Neo4j::NodeMixin] to_node create relationship to this node
+        # @param [Hash] props optional hash of properties to initialize the create relationship with
+        # @see http://rdoc.info/github/andreasronge/neo4j-core/master/Neo4j/Relationship Neo4j::Relationship
+        def new(type, from_node, to_node, *props)
+          rel = Neo4j::Relationship.create(type, from_node, to_node)
+          wrapped_rel = super()
+          Neo4j::IdentityMap.add(rel, wrapped_rel)
+          wrapped_rel.init_on_load(rel)
+          wrapped_rel.init_on_create(type, from_node, to_node, *props)
+          wrapped_rel
+        end
+
+        alias_method :create, :new
+      end
+    end
+  end
+end

data/lib/neo4j-wrapper/relationship_mixin/delegates.rb

@@ -0,0 +1,110 @@
+module Neo4j
+  module Wrapper
+    module RelationshipMixin
+      module Delegates
+
+        class << self
+          private
+          # @macro  [new] node.delegate
+          #   @method $1(*args, &block)
+          #   Delegates to {http://rdoc.info/github/andreasronge/neo4j-core/master/Neo4j/Core/$2#$1-instance_method Neo4j::Core::Relationship#$1} using the <tt>_java_entity</tt> instance with the supplied parameters.
+          #   @see Neo4j::Relationship#_java_entity
+          #   @see http://rdoc.info/github/andreasronge/neo4j-core/master/Neo4j/Core/$2#$1-instance_method Neo4j::Relationship#$1
+          def delegate(*args)
+            method_name = args.first
+            class_eval(<<-EOM, __FILE__, __LINE__)
+              def #{method_name}(*args, &block)
+                _java_entity.send(:#{method_name}, *args, &block)
+              end
+            EOM
+          end
+        end
+
+
+        # Methods included from Core::Property
+        # [], #[]=, #neo_id, #property?, #props, #update
+
+        # @macro  node.delegate
+        delegate :[]=, 'Property'
+
+        # @macro  node.delegate
+        delegate :[], 'Property'
+
+        # @macro  node.delegate
+        delegate :property?, 'Property'
+
+        # @macro  node.delegate
+        delegate :props, 'Property'
+
+        # @macro  node.delegate
+        delegate :update, 'Property'
+
+        # @macro  node.delegate
+        delegate :neo_id, 'Property'
+
+        # Methods included from Core::Relationship
+
+        # @macro  node.delegate
+        delegate :_end_node, 'Relationship'
+
+        # @macro  node.delegate
+        delegate :end_node, 'Relationship'
+
+
+        # @macro  node.delegate
+        delegate :_start_node, 'Relationship'
+
+        # @macro  node.delegate
+        delegate :end_node, 'Relationship'
+
+        # @macro  node.delegate
+        delegate :other_node, 'Relationship'
+
+        # @macro  node.delegate
+        delegate :_other_node, 'Relationship'
+
+        # @macro  node.delegate
+        delegate :del, 'Relationship'
+
+        # @macro  node.delegate
+        delegate :exist?, 'Relationship'
+
+        # @macro  node.delegate
+        delegate :rel_type, 'Relationship'
+
+        # Methods included from Core::Property::Java
+        #get_property, #graph_database, #property_keys, #remove_property, #set_property
+
+        # @macro  node.delegate
+        delegate :get_property, 'Property/Java'
+
+        # @macro  node.delegate
+        delegate :set_property, 'Property/Java'
+
+        # @macro  node.delegate
+        delegate :property_keys, 'Property/Java'
+
+        # @macro  node.delegate
+        delegate :remove_property, 'Property/Java'
+
+        # Methods included from Core::Equal
+        #==, #eql?, #equal?
+
+        # @macro  node.delegate
+        delegate :equal?, 'Equal'
+
+        # @macro  node.delegate
+        delegate :eql?, 'Equal'
+
+
+        # @macro  node.delegate
+        delegate :==
+
+        # @macro  node.delegate
+        delegate :getId
+      end
+
+    end
+  end
+end
+

data/lib/neo4j-wrapper/relationship_mixin/initialize.rb

@@ -0,0 +1,35 @@
+module Neo4j
+  module Wrapper
+    module RelationshipMixin
+      module Initialize
+
+        # Init this node with the specified java neo4j relationship.
+        def init_on_load(java_rel)
+          @_java_rel = java_rel
+        end
+
+
+        # Creates a new node and initialize with given properties.
+        # You can override this to provide your own initialization.
+        #
+        # @param (see Neo4j::Wrapper::RelationshipMixin::ClassMethods#new)
+        def init_on_create(rel_type, from_node, to_node, *props) # :nodoc:
+          _java_entity[:_classname] = self.class.to_s
+          if props.first.respond_to?(:each_pair)
+            props.first.each_pair { |k, v| respond_to?("#{k}=") ? self.send("#{k}=", v) : @_java_rel[k] = v }
+          end
+        end
+
+        # @returns [Neo4j::Relationship] the wrapped relationship object
+        # @see http://rdoc.info/github/andreasronge/neo4j-core/master/Neo4j/Relationship Neo4j::Relationship
+        def _java_rel
+          @_java_rel
+        end
+
+        alias_method :_java_entity, :_java_rel
+
+      end
+    end
+  end
+
+end