neo4j-core 0.0.14-java → 0.0.15-java

data/README.rdoc

@@ -20,7 +20,7 @@ The Neo4j module is public and the Neo4j::Core(::*) are internal modules.
 
 {Neo4j} The Database
 
-{Neo4j::Cypher} Cypher Query Generator, see RSpec spec/neo4j/cypher_spec
+{Neo4j::Cypher} Cypher Query DSL, see {Neo4j Wiki}[https://github.com/andreasronge/neo4j/wiki/Neo4j%3A%3ACore-Cypher]
 
 {Neo4j::Algo} Included algorithms, like shortest path
 

data/lib/neo4j/cypher.rb

@@ -1,5 +1,14 @@
 module Neo4j
+
+  # Generates a Cypher string from a Ruby DSL.
+  # This class is used by the {Ņeo4j#query} method.
+  # Methods on in this class returns object from the {Neo4j::Core::Cypher} module (e.g. {Neo4j::Cypher#node} can return a #{Neo4j::Core::Cypher::StartNode}).
+  #
+  # @example usage
+  #   Neo4j::Cypher.new { node }
+  #
   class Cypher
+    # @private
     attr_reader :expressions
 
     include Neo4j::Core::Cypher
@@ -20,6 +29,7 @@ module Neo4j
     # @param args the argument for the dsl_block
     # @yield the block which will be evaluated in the context of this object in order to create an Cypher Query string
     # @yieldreturn [Return, Object] If the return is not an instance of Return it will be converted it to a Return object (if possible).
+    # @see Neo4j::Core::Cypher
     def initialize(*args, &dsl_block)
       @expressions = []
       @variables = []

data/lib/neo4j/neo4j.rb

@@ -58,9 +58,10 @@ module Neo4j
     end
 
     # Checks read only mode of the database. Only one process can have write access to the database.
+    # It will always return false if the database is not started yet.
     # @return [true, false] if the database has started up in read only mode
     def read_only?
-      (@db && @db.graph && @db.read_only?)
+      !!(@db && @db.graph && @db.read_only?)
     end
 
     # Returns a started db instance. Starts it's not running.

data/lib/neo4j-core/cypher/cypher.rb

@@ -1,5 +1,9 @@
 module Neo4j
   module Core
+
+    # This module contains a number of mixins and classes used by the neo4j.rb cypher DSL.
+    # The Cypher DSL is evaluated in the context of {Neo4j::Cypher} which contains a number of methods (e.g. {Neo4j::Cypher#node})
+    # which returns classes from this module.
     module Cypher
 
       module MathFunctions
@@ -19,6 +23,7 @@ module Neo4j
           _add_math_func(:sign, value)
         end
 
+        # @private
         def _add_math_func(name, value=nil)
           value ||= self.respond_to?(:var_name) ? self.var_name : to_s
           expressions.delete(self)
@@ -119,23 +124,27 @@ module Neo4j
           self
         end
 
+        # generates a <tt>ID</tt> cypher fragment.
         def neo_id
           Property.new(@expressions, self, 'ID').to_function!
         end
 
+        # generates a <tt>has</tt> cypher fragment.
         def property?(p)
           p = Property.new(expressions, self, p)
           p.binary_operator("has")
         end
 
+        # generates a <tt>is null</tt> cypher fragment.
         def exist?
           p = Property.new(expressions, self, p)
           p.binary_operator("", " is null")
         end
 
+        # Can be used instead of [_classname] == klass
         def is_a?(klass)
-          return super if klass.class != Class || !klass.instance_methods.include?("wrapper")
-          super
+          return super if klass.class != Class || !klass.respond_to?(:_load_wrapper)
+          self[:_classname] == klass.to_s
         end
       end
 
@@ -236,7 +245,16 @@ module Neo4j
 
       end
 
+      # A property is returned from a Variable by using the [] operator.
+      #
+      # It has a number of useful method like
+      # <tt>count</tt>, <tt>sum</tt>, <tt>avg</tt>, <tt>min</tt>, <tt>max</tt>, <tt>collect</tt>, <tt>head</tt>, <tt>last</tt>, <tt>tail</tt>,
+      #
+      # @example
+      #  n=node(2, 3, 4); n[:name].collect
+      #  # same as START n0=node(2,3,4) RETURN collect(n0.property)
       class Property
+        # @private
         attr_reader :expressions, :var_name
         include Comparable
         include MathOperator
@@ -250,17 +268,20 @@ module Neo4j
           @var_name = @prop_name ? "#{@var.to_s}.#{@prop_name}" : @var.to_s
         end
 
+        # @private
         def to_function!(var = @var.to_s)
           @var_name = "#{@prop_name}(#{var})"
           self
         end
 
+        # Make it possible to rename a property with a different name (AS)
         def as(new_name)
           @var_name = "#{@var_name} AS #{new_name}"
         end
 
         # required by the Predicate Methods Module
         # @see PredicateMethods
+        # @private
         def iterable
           var_name
         end
@@ -269,10 +290,12 @@ module Neo4j
           self
         end
 
+        # @private
         def in?(values)
           binary_operator("", " IN [#{values.map { |x| %Q["#{x}"] }.join(',')}]")
         end
 
+        # Only return distinct values/nodes/rels/paths
         def distinct
           @var_name = "distinct #{@var_name}"
           self
@@ -290,16 +313,19 @@ module Neo4j
           end
         end
 
+        # @private
         def function(func_name_pre, func_name_post = "")
           ExprOp.new(self, nil, func_name_pre, func_name_post)
         end
 
+        # @private
         def binary_operator(op, post_fix = "")
           ExprOp.new(self, nil, op, post_fix).binary!
         end
       end
 
       class Start < Expression
+        # @private
         attr_reader :var_name
         include Variable
         include Matchable
@@ -311,7 +337,9 @@ module Neo4j
 
       end
 
+      # Can be created from a <tt>node</tt> dsl method.
       class StartNode < Start
+        # @private
         attr_reader :nodes
 
         def initialize(nodes, expressions)
@@ -325,7 +353,10 @@ module Neo4j
         end
       end
 
+
+      # Can be created from a <tt>rel</tt> dsl method.
       class StartRel < Start
+        # @private
         attr_reader :rels
 
         def initialize(rels, expressions)
@@ -381,10 +412,12 @@ module Neo4j
           opts.each_pair { |k, v| self.send(k, v) }
         end
 
+        # @private
         def return_method
           @name_or_ref.respond_to?(:return_method) && @name_or_ref.return_method
         end
 
+        # @private
         def as_return_method
           if return_method[:bracket]
             "#{return_method[:name]}(#@var_name)"
@@ -432,6 +465,7 @@ module Neo4j
         end
       end
 
+      # Can be used to skip result from a return clause
       class Skip < Expression
         def initialize(expressions, value)
           super(expressions, :skip)
@@ -443,6 +477,7 @@ module Neo4j
         end
       end
 
+      # Can be used to limit result from a return clause
       class Limit < Expression
         def initialize(expressions, value)
           super(expressions, :limit)
@@ -479,8 +514,11 @@ module Neo4j
         end
       end
 
+      # Created from a node's match operator like >> or <.
       class Match < Expression
+        # @private
         attr_reader :dir, :expressions, :left, :right, :var_name, :dir_op
+        # @private
         attr_accessor :algorithm, :next, :prev
         include Variable
 
@@ -495,19 +533,29 @@ module Neo4j
         end
 
 
+        # Generates a <tt>x in nodes(m3)</tt> cypher expression.
+        #
+        # @example
+        #   p.nodes.all? { |x| x[:age] > 30 }
         def nodes
           Entities.new(@expressions, "nodes", self)
         end
 
+        # Generates a <tt>x in relationships(m3)</tt> cypher expression.
+        #
+        # @example
+        #   p.relationships.all? { |x| x[:age] > 30 }
         def rels
           Entities.new(@expressions, "relationships", self)
         end
 
+        # returns the length of the path
         def length
           self.return_method = {:name => 'length', :bracket => true}
           self
         end
 
+        # @private
         def find_match_start
           c = self
           while (c.prev) do
@@ -516,26 +564,32 @@ module Neo4j
           c
         end
 
+        # @private
         def left_var_name
           @left.respond_to?(:var_name) ? @left.var_name : @left.to_s
         end
 
+        # @private
         def right_var_name
           @right.respond_to?(:var_name) ? @right.var_name : @right.to_s
         end
 
+        # @private
         def right_expr
           @right.respond_to?(:expr) ? @right.expr : right_var_name
         end
 
+        # @private
         def referenced!
           @referenced = true
         end
 
+        # @private
         def referenced?
           !!@referenced
         end
 
+        # @private
         def to_s
           curr = find_match_start
           result = (referenced? || curr.referenced?) ? "#{var_name} = " : ""
@@ -548,6 +602,8 @@ module Neo4j
         end
       end
 
+      # The left part of a match clause, e.g. node < rel(':friends')
+      # Can return {MatchRelRight} using a match operator method.
       class MatchRelLeft < Match
         def initialize(left, right, expressions, dir)
           super(left, right, expressions, dir, dir == :incoming ? '<-' : '-')
@@ -619,6 +675,7 @@ module Neo4j
           "#{dir_op}(#{right_var_name})"
         end
 
+        # negate this match
         def not
           expressions.delete(self)
           ExprOp.new(left, nil, "not").binary!
@@ -635,6 +692,8 @@ module Neo4j
 
       end
 
+      # The right part of a match clause (node_b), e.g. node_a > rel(':friends') > node_b
+      #
       class MatchNode < Match
         attr_reader :dir_op
 

data/lib/neo4j-core/database.rb

@@ -67,7 +67,8 @@ module Neo4j
       end
 
 
-      def running? #:nodoc:
+      # true if the database has started
+      def running?
         @running
       end
 

data/lib/neo4j-core/traversal/prune_evaluator.rb

@@ -1,9 +1,9 @@
 module Neo4j
   module Core
 
-    # Implements the Neo4j PruneEvaluator Java interface, only used internally.
-    # @private
     module Traversal
+      # Implements the Neo4j PruneEvaluator Java interface, only used internally.
+      # @private
       class PruneEvaluator
         include Java::OrgNeo4jGraphdbTraversal::PruneEvaluator
 

data/lib/neo4j-core/version.rb

@@ -1,5 +1,5 @@
 module Neo4j
   module Core
-    VERSION = "0.0.14"
+    VERSION = "0.0.15"
   end
 end

data/neo4j-core.gemspec

@@ -27,5 +27,5 @@ It comes included with the Apache Lucene document database.
   s.extra_rdoc_files = %w( README.rdoc )
   s.rdoc_options = ["--quiet", "--title", "Neo4j::Core", "--line-numbers", "--main", "README.rdoc", "--inline-source"]
 
-  s.add_dependency("neo4j-community", "1.7.0")
+  s.add_dependency("neo4j-community", ">= 1.7.0")
 end

metadata

@@ -2,7 +2,7 @@
 name: neo4j-core
 version: !ruby/object:Gem::Version 
   prerelease: 
-  version: 0.0.14
+  version: 0.0.15
 platform: java
 authors: 
   - Andreas Ronge
@@ -10,7 +10,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2012-04-24 00:00:00 Z
+date: 2012-04-27 00:00:00 Z
 dependencies: 
   - !ruby/object:Gem::Dependency 
     name: neo4j-community
@@ -18,7 +18,7 @@ dependencies:
     requirement: &id001 !ruby/object:Gem::Requirement 
       none: false
       requirements: 
-        - - "="
+        - - ">="
           - !ruby/object:Gem::Version 
             version: 1.7.0
     type: :runtime