Merge pull request #878 from neo4jrb/pretty_cypher

Support outputting pretty cypher queries

.rubocop_todo.yml

@@ -16,7 +16,7 @@ Metrics/AbcSize:
 # Offense count: 2
 # Configuration parameters: CountComments.
 Metrics/ClassLength:
-  Max: 208
+  Max: 211
 
 # Offense count: 768
 # Configuration parameters: AllowURI, URISchemes.

CHANGELOG.md

@@ -14,6 +14,7 @@ This project adheres to [Semantic Versioning](http://semver.org/).
 - Added ability to view `model_class` from `Association` class for `rails_admin` Neo4j adapter
 - QueryProxy `where` will now look for declared properties matching hash keys. When found, it will send the value through that property's type converter if the type matches the property's unconverted state.
 - Improved handling of unpersisted nodes with associations. You can now use `<<` to create associations between unpersisted nodes. A `save` will cascade through unpersisted objects, creating nodes and rels along the way. See https://github.com/neo4jrb/neo4j/pull/871
+- Support formatted cypher queries for easy reading by humans via the `pretty_logged_cypher_queries` configuration variable
 - On `QueryProxy` objects you can now use an `:id` key in `where` and `find_by` methods to refer to the property from `id_property` (`uuid` by default)
 
 ## [5.0.8] - 2015-07-26

docs/Configuration.rst

@@ -54,3 +54,8 @@ Configuration
     **Default:** ``nil`` (or ``Rails.logger`` in Rails)
 
     A Ruby ``Logger`` object which is used to log Cypher queries (`info` level is used)
+
+  **pretty_logged_cypher_queries**
+    **Default:** ``nil``
+
+    If true, format outputted queries with newlines and colors to be more easily readable by humans

lib/neo4j/active_node/query/query_proxy.rb

@@ -151,8 +151,12 @@ def scoping
         alias_method :order_by, :order
 
         # Cypher string for the QueryProxy's query. This will not include params. For the full output, see <tt>to_cypher_with_params</tt>.
-        def to_cypher
-          query.to_cypher
+        def to_cypher(*args)
+          query.to_cypher(*args)
+        end
+
+        def print_cypher
+          query.print_cypher
         end
 
         # Returns a string of the cypher query with return objects and params

lib/neo4j/railtie.rb

@@ -71,6 +71,8 @@ def open_neo4j_session(options)
     def register_neo4j_cypher_logging
       return if @neo4j_cypher_logging_registered
 
+      Neo4j::Core::Query.pretty_cypher = Neo4j::Config[:pretty_logged_cypher_queries]
+
       Neo4j::Server::CypherSession.log_with do |message|
         (Neo4j::Config[:logger] || Rails.logger).info message
       end