neo4j-core 5.0.10 → 5.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 973a3091e4ac4ffe027b846627a315a70b79e182
-  data.tar.gz: d9cc32add98996c8efacb94e44034f78cd2c39b3
+  metadata.gz: 413db701027dd75c0757902fba22db6a5b289781
+  data.tar.gz: 59d07ba453f252c053fbd6b353b3604415cd3a0f
 SHA512:
-  metadata.gz: 38e2ebd378bfcccc0fad41b1adcae148da01a6f692f978c3bb134593ad7e2bcc93cb4e3ea7ca637386a4e747442ff2db232ef9eed18d551334c038a109b9f1c3
-  data.tar.gz: c136b1a82abad7ca652b516cd4a3e50da7170a0cc4b6e529f8134d30cb734886f0d56351d13d0304faff390ffa590cb611931ddbd887a6605d9ad143c4288034
+  metadata.gz: cf46b06d8cf1c4b4152fe7ce4f870ca019cdb475d06a2e2d902db223c7d6d2c8abf20b44cba5a352e3e3b4122d4e79e698bdc105a169e41fdc51bca506958474
+  data.tar.gz: 9dcdf5e2fdb993c3de4203a0e21029bc497fd6562096bdd6b76b761565c0e56206f16cccd2bc449d5625c8235931f4312810697ed2b547a41d3fb42286d98bb1

data/Gemfile

@@ -2,20 +2,16 @@ source 'https://rubygems.org'
 
 gemspec
 
-gem 'zip'
-
 # gem 'neo4j-advanced',   '>= 1.8.1', '< 2.0', :require => false
 # gem 'neo4j-enterprise', '>= 1.8.1', '< 2.0', :require => false
 
 group 'development' do
   gem 'guard-rspec', require: false
-  gem 'overcommit'
 end
 
 group 'test' do
   gem 'coveralls', require: false
   gem 'simplecov-html', require: false
-  gem 'rake', '>= 0.8.7'
   gem 'rspec', '~> 3.0'
   gem 'rspec-its'
 end

data/README.md

@@ -1,25 +1,51 @@
-# Neo4j-core v3.0 [![Code Climate](https://codeclimate.com/github/neo4jrb/neo4j-core.png)](https://codeclimate.com/github/neo4jrb/neo4j-core) [![Build Status](https://travis-ci.org/neo4jrb/neo4j-core.png)](https://travis-ci.org/neo4jrb/neo4j-core) [![Coverage Status](https://coveralls.io/repos/neo4jrb/neo4j-core/badge.png?branch=master)](https://coveralls.io/r/neo4jrb/neo4j-core?branch=master) [![PullReview stats](https://www.pullreview.com/github/neo4jrb/neo4j-core/badges/master.svg?)](https://www.pullreview.com/github/neo4jrb/neo4j-core/reviews/master)
+# Neo4j-core [![Code Climate](https://codeclimate.com/github/neo4jrb/neo4j-core.png)](https://codeclimate.com/github/neo4jrb/neo4j-core) [![Build Status](https://travis-ci.org/neo4jrb/neo4j-core.png)](https://travis-ci.org/neo4jrb/neo4j-core) [![Coverage Status](https://coveralls.io/repos/neo4jrb/neo4j-core/badge.png?branch=master)](https://coveralls.io/r/neo4jrb/neo4j-core?branch=master) [![PullReview stats](https://www.pullreview.com/github/neo4jrb/neo4j-core/badges/master.svg?)](https://www.pullreview.com/github/neo4jrb/neo4j-core/reviews/master)
 
 A simple Ruby wrapper around the Neo4j graph database that works with the server and embedded Neo4j API. This gem can be used both from JRuby and normal MRI.
 It can be used standalone without the neo4j gem.
 
 ## Documentation
 
-* [3.0 Documentation](https://github.com/neo4jrb/neo4j-core/wiki)
-* [2.x Documentation](https://github.com/neo4jrb/neo4j-core/tree/v2.x)
+### 3.0+ Documentation:
 
+ * http://neo4jrb.readthedocs.org/en/stable/
+ * https://github.com/neo4jrb/neo4j-core/wiki
+
+### 2.x Documentation
+
+https://github.com/neo4jrb/neo4j-core/tree/v2.x
 
 ## Support
 
-* [Neo4j.rb mailing list](https://groups.google.com/forum/#!forum/neo4jrb)
-* Consulting support ? ask any of the developers
+### Issues
+
+[![Next Release](https://badge.waffle.io/neo4jrb/neo4j-core.png?label=Next%20Release&title=Next%20Release) ![In Progress](https://badge.waffle.io/neo4jrb/neo4j-core.png?label=In%20Progress&title=In%20Progress) ![In Master](https://badge.waffle.io/neo4jrb/neo4j-core.png?label=In%20Master&title=In%20Master)](https://waffle.io/neo4jrb/neo4j-core)
+
+[![Post an issue](https://img.shields.io/badge/Bug%3F-Post%20an%20issue!-blue.svg)](https://waffle.io/neo4jrb/neo4j-core)
+
+
+### Get Support
+
+#### Documentation
+
+All new documentation will be done via our [readthedocs](http://neo4jrb.readthedocs.org) site, though some old documentation has yet to be moved from our [wiki](https://github.com/neo4jrb/neo4j/wiki) (also there is the [neo4j-core wiki](https://github.com/neo4jrb/neo4j-core/wiki))
+
+#### Contact Us
+
+[![StackOverflow](https://img.shields.io/badge/StackOverflow-Ask%20a%20question!-blue.svg)](http://stackoverflow.com/questions/ask?tags=neo4j.rb+neo4j+ruby)  [![Gitter](https://img.shields.io/badge/Gitter-Join%20our%20chat!-blue.svg)](https://gitter.im/neo4jrb/neo4j?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)  [![Twitter](https://img.shields.io/badge/Twitter-Tweet%20with%20us!-blue.svg)](https://twitter.com/neo4jrb)  [![Mailing list](https://img.shields.io/badge/Mailing%20list-Mail%20us!-blue.svg)](https://groups.google.com/forum/#!forum/neo4jrb)
+
 
 ## Developers
 
-* [Andreas Ronge](https://github.com/neo4jrb)
+### Original Author
+
+* [Andreas Ronge](https://github.com/andreasronge)
+
+### Current Maintainers
+
 * [Brian Underwood](https://github.com/cheerfulstoic)
 * [Chris Grigg](https://github.com/subvertallchris)
 
+Consulting support? Contact [Chris](http://subvertallmedia.com/) and/or [Brian](http://www.brian-underwood.codes/)
 
 ## Contributing
 

data/lib/neo4j/label.rb

@@ -60,7 +60,6 @@ module Neo4j
     end
 
     class << self
-      include Neo4j::Core::CypherTranslator
       INDEX_PATH = '/db/data/schema/index/'
       CONSTRAINT_PATH = '/db/data/schema/constraint/'
 

data/lib/neo4j/node.rb

@@ -168,7 +168,12 @@ module Neo4j
     class << self
       # Creates a node
       def create(props = nil, *labels_or_db)
-        session = Neo4j::Core::ArgumentHelper.session(labels_or_db)
+        session = if labels_or_db.last.is_a?(Neo4j::Session)
+                    labels_or_db.pop
+                  else
+                    Neo4j::Session.current!
+                  end
+
         session.create_node(props, labels_or_db)
       end
 

data/lib/neo4j-core/helpers.rb

@@ -1,18 +1,13 @@
 module Neo4j
   module Core
-    module ArgumentHelper
-      def self.session(args)
-        args.last.is_a?(Neo4j::Session) ? args.pop : Neo4j::Session.current!
-      end
-    end
-
     module TxMethods
       def tx_methods(*methods)
         methods.each do |method|
           tx_method = "#{method}_in_tx"
           send(:alias_method, tx_method, method)
           send(:define_method, method) do |*args, &block|
-            session = ArgumentHelper.session(args)
+            session = args.last.is_a?(Neo4j::Session) ? args.pop : Neo4j::Session.current!
+
             Neo4j::Transaction.run(session.auto_commit?) { send(tx_method, *args, &block) }
           end
         end

data/lib/neo4j-core/query.rb

@@ -18,6 +18,10 @@ module Neo4j
 
       attr_accessor :clauses
 
+      class << self
+        attr_accessor :pretty_cypher
+      end
+
       def initialize(options = {})
         @session = options[:session] || Neo4j::Session.current
 
@@ -26,6 +30,10 @@ module Neo4j
         @_params = {}
       end
 
+      def inspect
+        "#<Query CYPHER: #{ANSI::YELLOW}#{to_cypher.inspect}#{ANSI::CLEAR}>"
+      end
+
       # @method start *args
       # START clause
       # @return [Query]
@@ -133,6 +141,12 @@ module Neo4j
         query.order(*args)
       end
 
+      # Works the same as the #where method, but the clause is surrounded by a
+      # Cypher NOT() function
+      def where_not(*args)
+        build_deeper_query(WhereClause, args, not: true)
+      end
+
       # Works the same as the #set method, but when given a nested array it will set properties rather than setting entire objects
       # @example
       #    # Creates a query representing the cypher: MATCH (n:Person) SET n.age = 19
@@ -174,8 +188,9 @@ module Neo4j
       def response
         return @response if @response
         cypher = to_cypher
+        pretty_cypher = to_cypher(pretty: true) if self.class.pretty_cypher
 
-        @response = @session._query(cypher, merge_params, context: @options[:context])
+        @response = @session._query(cypher, merge_params, context: @options[:context], pretty_cypher: pretty_cypher)
 
         if !response.respond_to?(:error?) || !response.error?
           response
@@ -268,22 +283,27 @@ module Neo4j
       #
       # @return [String] Resulting cypher query string
       EMPTY = ' '
-      def to_cypher
+      NEWLINE = "\n"
+      def to_cypher(options = {})
         cypher_string = PartitionedClauses.new(@clauses).map do |clauses|
           clauses_by_class = clauses.group_by(&:class)
 
           cypher_parts = CLAUSES.map do |clause_class|
-            clause_class.to_cypher(clauses) if clauses = clauses_by_class[clause_class]
+            clause_class.to_cypher(clauses, options) if clauses = clauses_by_class[clause_class]
           end
 
           cypher_parts.compact!
-          cypher_parts.join(EMPTY).tap(&:strip!)
-        end.join EMPTY
+          cypher_parts.join(options[:pretty] ? NEWLINE : EMPTY).tap(&:strip!)
+        end.join(options[:pretty] ? NEWLINE : EMPTY)
 
         cypher_string = "CYPHER #{@options[:parser]} #{cypher_string}" if @options[:parser]
         cypher_string.tap(&:strip!)
       end
 
+      def print_cypher
+        puts to_cypher(pretty: true).gsub(/\e[^m]+m/, '')
+      end
+
       # Returns a CYPHER query specifying the union of the callee object's query and the argument's query
       #
       # @example

data/lib/neo4j-core/query_clauses.rb

@@ -11,12 +11,12 @@ module Neo4j
 
 
       class Clause
-        include CypherTranslator
         UNDERSCORE = '_'
         COMMA_SPACE = ', '
         AND = ' AND '
 
         attr_accessor :params, :arg
+        attr_reader :options
 
         def initialize(arg, options = {})
           @arg = arg
@@ -53,8 +53,10 @@ module Neo4j
         end
 
         def node_from_key_and_value(key, value, options = {})
-          var = var_from_key_and_value(key, value, options[:prefer] || :var)
-          label = label_from_key_and_value(key, value, options[:prefer] || :var)
+          prefer = options[:prefer] || :var
+          var = var_from_key_and_value(key, value, prefer)
+          label = label_from_key_and_value(key, value, prefer)
+
           attributes = attributes_from_key_and_value(key, value)
 
           prefix_value = value
@@ -131,13 +133,34 @@ module Neo4j
             new(arg, options) if !arg.respond_to?(:empty?) || !arg.empty?
           end
 
-          def to_cypher(clauses)
+          def to_cypher(clauses, options = {})
             @question_mark_param_index = 1
 
-            string = clause_string(clauses)
-            string.strip!
+            string = clause_string(clauses, options)
+
+            final_keyword = if options[:pretty]
+                              "#{clause_color}#{keyword}#{ANSI::CLEAR}"
+                            else
+                              keyword
+                            end
+
+            "#{final_keyword} #{string}" if string.size > 0
+          end
+
+          def clause_string(clauses, options = {})
+            join_string = clause_join + (options[:pretty] ? "\n  " : '')
+
+            strings = clause_strings(clauses)
+            string = ((options[:pretty] && strings.size > 1) ? "\n  " : '')
+            string + strings.join(join_string).strip
+          end
 
-            "#{keyword} #{string}" if string.size > 0
+          def clause_join
+            ''
+          end
+
+          def clause_color
+            ANSI::CYAN
           end
         end
 
@@ -228,8 +251,12 @@ module Neo4j
         end
 
         class << self
-          def clause_string(clauses)
-            clauses.map!(&:value).join(Clause::COMMA_SPACE)
+          def clause_strings(clauses)
+            clauses.map!(&:value)
+          end
+
+          def clause_join
+            Clause::COMMA_SPACE
           end
         end
       end
@@ -249,8 +276,16 @@ module Neo4j
         end
 
         class << self
-          def clause_string(clauses)
-            clauses.map!(&:value).tap(&:flatten!).map! { |value| "(#{value})" }.join(Clause::AND)
+          def clause_strings(clauses)
+            clauses.flat_map do |clause|
+              Array(clause.value).map do |v|
+                (clause.options[:not] ? 'NOT' : '') + "(#{v})"
+              end
+            end
+          end
+
+          def clause_join
+            Clause::AND
           end
         end
 
@@ -302,14 +337,18 @@ module Neo4j
           end
 
           def question_mark_params_param
-            result = "question_mark_param#{@question_mark_param_index}"
-            @question_mark_param_index += 1
-            result
+            "question_mark_param#{question_mark_param_index}"
+          end
+
+          def question_mark_param_index
+            @question_mark_param_index ||= 1
+            @question_mark_param_index.tap do
+              @question_mark_param_index += 1
+            end
           end
         end
       end
 
-
       class MatchClause < Clause
         KEYWORD = 'MATCH'
 
@@ -322,8 +361,12 @@ module Neo4j
         end
 
         class << self
-          def clause_string(clauses)
-            clauses.map!(&:value).join(Clause::COMMA_SPACE)
+          def clause_strings(clauses)
+            clauses.map!(&:value)
+          end
+
+          def clause_join
+            Clause::COMMA_SPACE
           end
         end
       end
@@ -344,8 +387,12 @@ module Neo4j
         end
 
         class << self
-          def clause_string(clauses)
-            clauses.map!(&:value).join(Clause::COMMA_SPACE)
+          def clause_strings(clauses)
+            clauses.map!(&:value)
+          end
+
+          def clause_join
+            Clause::COMMA_SPACE
           end
         end
       end
@@ -354,8 +401,12 @@ module Neo4j
         KEYWORD = 'USING'
 
         class << self
-          def clause_string(clauses)
-            clauses.map!(&:value).join(" #{keyword} ")
+          def clause_strings(clauses)
+            clauses.map!(&:value)
+          end
+
+          def clause_join
+            " #{keyword} "
           end
         end
       end
@@ -386,8 +437,16 @@ module Neo4j
         end
 
         class << self
-          def clause_string(clauses)
-            clauses.map!(&:value).join(', ')
+          def clause_strings(clauses)
+            clauses.map!(&:value)
+          end
+
+          def clause_join
+            ', '
+          end
+
+          def clause_color
+            ANSI::GREEN
           end
         end
       end
@@ -398,6 +457,12 @@ module Neo4j
 
       class MergeClause < CreateClause
         KEYWORD = 'MERGE'
+
+        class << self
+          def clause_color
+            ANSI::MAGENTA
+          end
+        end
       end
 
       class DeleteClause < Clause
@@ -408,8 +473,16 @@ module Neo4j
         end
 
         class << self
-          def clause_string(clauses)
-            clauses.map!(&:value).join(Clause::COMMA_SPACE)
+          def clause_strings(clauses)
+            clauses.map!(&:value)
+          end
+
+          def clause_join
+            Clause::COMMA_SPACE
+          end
+
+          def clause_color
+            ANSI::RED
           end
         end
       end
@@ -435,8 +508,12 @@ module Neo4j
         end
 
         class << self
-          def clause_string(clauses)
-            clauses.map!(&:value).join(Clause::COMMA_SPACE)
+          def clause_strings(clauses)
+            clauses.map!(&:value)
+          end
+
+          def clause_join
+            Clause::COMMA_SPACE
           end
         end
       end
@@ -461,8 +538,8 @@ module Neo4j
         end
 
         class << self
-          def clause_string(clauses)
-            clauses.last.value
+          def clause_strings(clauses)
+            [clauses.last.value]
           end
         end
       end
@@ -483,8 +560,8 @@ module Neo4j
         end
 
         class << self
-          def clause_string(clauses)
-            clauses.last.value
+          def clause_strings(clauses)
+            [clauses.last.value]
           end
         end
       end
@@ -510,8 +587,16 @@ module Neo4j
         end
 
         class << self
-          def clause_string(clauses)
-            clauses.map!(&:value).join(Clause::COMMA_SPACE)
+          def clause_strings(clauses)
+            clauses.map!(&:value)
+          end
+
+          def clause_join
+            Clause::COMMA_SPACE
+          end
+
+          def clause_color
+            ANSI::YELLOW
           end
         end
       end
@@ -550,8 +635,12 @@ module Neo4j
         end
 
         class << self
-          def clause_string(clauses)
-            clauses.map!(&:value).join(Clause::COMMA_SPACE)
+          def clause_strings(clauses)
+            clauses.map!(&:value)
+          end
+
+          def clause_join
+            Clause::COMMA_SPACE
           end
         end
       end
@@ -571,8 +660,12 @@ module Neo4j
         end
 
         class << self
-          def clause_string(clauses)
-            clauses.map!(&:value).join(' UNWIND ')
+          def clause_strings(clauses)
+            clauses.map!(&:value)
+          end
+
+          def clause_join
+            ' UNWIND '
           end
         end
       end
@@ -602,8 +695,12 @@ module Neo4j
         end
 
         class << self
-          def clause_string(clauses)
-            clauses.map!(&:value).join(Clause::COMMA_SPACE)
+          def clause_strings(clauses)
+            clauses.map!(&:value)
+          end
+
+          def clause_join
+            Clause::COMMA_SPACE
           end
         end
       end

data/lib/neo4j-core/version.rb

@@ -1,5 +1,5 @@
 module Neo4j
   module Core
-    VERSION = '5.0.10'
+    VERSION = '5.1.0'
   end
 end

data/lib/neo4j-core.rb

@@ -9,7 +9,6 @@ require 'neo4j/property_validator'
 require 'neo4j/property_container'
 require 'neo4j-core/active_entity'
 require 'neo4j-core/helpers'
-require 'neo4j-core/cypher_translator'
 require 'neo4j-core/query_find_in_batches'
 require 'neo4j-core/query'
 

data/lib/neo4j-embedded/embedded_session.rb

@@ -4,7 +4,6 @@ Neo4j::Session.register_db(:embedded_db) do |*args|
   Neo4j::Embedded::EmbeddedSession.new(*args)
 end
 
-
 module Neo4j
   module Embedded
     class EmbeddedSession < Neo4j::Session
@@ -17,16 +16,22 @@ module Neo4j
       def_delegator :@graph_db, :begin_tx
 
       def initialize(db_location, config = {})
+        @config          = config
         @db_location     = db_location
-        @auto_commit     = !!config[:auto_commit]
-        @properties_file = config[:properties_file]
-        if config[:properties_map]
-          props = config[:properties_map].each_with_object({}) { |(k, v), m| m[k.to_s.to_java] = v.to_s.to_java }
-          @properties_map = java.util.HashMap.new(props)
-        end
+        @auto_commit     = !!@config[:auto_commit]
+        @properties_file = @config[:properties_file]
         Neo4j::Session.register(self)
       end
 
+      def properties_map
+        return @properties_map if @properties_map
+
+        props = @config[:properties_map].each_with_object({}) do |(k, v), m|
+          m[k.to_s.to_java] = v.to_s.to_java
+        end
+        @properties_map = java.util.HashMap.new(props)
+      end
+
       def db_type
         :embedded_db
       end
@@ -138,9 +143,10 @@ module Neo4j
       # @param [String] q the cypher query as a String
       # @return (see #query)
       def _query(query, params = {}, options = {})
-        ActiveSupport::Notifications.instrument('neo4j.cypher_query', context: options[:context] || 'CYPHER', cypher: query, params: params) do
+        ActiveSupport::Notifications.instrument('neo4j.cypher_query', params: params, context: options[:context],
+                                                                      cypher: query, pretty_cypher: options[:pretty_cypher], params: params) do
           @engine ||= Java::OrgNeo4jCypherJavacompat::ExecutionEngine.new(@graph_db)
-          @engine.execute(query, Neo4j::Core::HashWithIndifferentAccess.new(params))
+          @engine.execute(query, HashWithIndifferentAccess.new(params))
         end
       rescue StandardError => e
         raise Neo4j::Session::CypherError.new(e.message, e.class, 'cypher error')

data/lib/neo4j-embedded.rb

@@ -13,4 +13,4 @@ require 'neo4j-embedded/embedded_transaction'
 require 'neo4j-embedded/cypher_response'
 
 # TODO: replace this with https://github.com/intridea/hashie gem
-require 'neo4j-core/hash_with_indifferent_access'
+require 'active_support/hash_with_indifferent_access'

data/lib/neo4j-server/cypher_node.rb

@@ -2,7 +2,6 @@ module Neo4j
   module Server
     class CypherNode < Neo4j::Node
       include Neo4j::Server::Resource
-      include Neo4j::Core::CypherTranslator
       include Neo4j::Core::ActiveEntity
 
       def initialize(session, value)
@@ -113,8 +112,6 @@ module Neo4j
       end
 
       def set_label(*label_names)
-        q = match_start_query
-
         labels_to_add = label_names.map(&:to_sym).uniq
         labels_to_remove = labels - label_names
 
@@ -122,10 +119,15 @@ module Neo4j
         labels_to_add -= common_labels
         labels_to_remove -= common_labels
 
-        q = q.remove(n: labels_to_remove) unless labels_to_remove.empty?
-        q = q.set(n: labels_to_add) unless labels_to_add.empty?
+        query = _set_label_query(labels_to_add, labels_to_remove)
+        @session._query_or_fail(query, false) unless (labels_to_add + labels_to_remove).empty?
+      end
 
-        @session._query_or_fail(q, false) unless (labels_to_add + labels_to_remove).empty?
+      def _set_label_query(labels_to_add, labels_to_remove)
+        query = match_start_query
+        query = query.remove(n: labels_to_remove) unless labels_to_remove.empty?
+        query = query.set(n: labels_to_add) unless labels_to_add.empty?
+        query
       end
 
       # (see Neo4j::Node#del)

data/lib/neo4j-server/cypher_relationship.rb

@@ -2,7 +2,6 @@ module Neo4j
   module Server
     class CypherRelationship < Neo4j::Relationship
       include Neo4j::Server::Resource
-      include Neo4j::Core::CypherTranslator
       include Neo4j::Core::ActiveEntity
 
       def initialize(session, value)
@@ -93,10 +92,17 @@ module Neo4j
       # (see Neo4j::Relationship#update_props)
       def update_props(properties)
         return if properties.empty?
-        q = "#{match_start} SET " + properties.keys.map do |k|
-          "n.`#{k}`= #{escape_value(properties[k])}"
+
+        params = {}
+        q = "#{match_start} SET " + properties.keys.each_with_index.map do |k, _i|
+          param = k.to_s.tr_s('^a-zA-Z0-9', '_').gsub(/^_+|_+$/, '')
+          params[param] = properties[k]
+
+          "n.`#{k}`= {#{param}}"
         end.join(',')
-        @session._query_or_fail(q, false, neo_id: neo_id)
+
+        @session._query_or_fail(q, false, params.merge(neo_id: neo_id))
+
         properties
       end
 
@@ -127,7 +133,7 @@ module Neo4j
       end
 
       def neo_id_integer(id_or_url)
-        id_or_url.is_a?(Integer) ? id_or_url : id_or_url.match(/\d+$/)[0].to_i
+        id_or_url.is_a?(Integer) ? id_or_url : id_or_url.split('/').last.to_i
       end
     end
   end