From 60b2e6f885fa37da0f0f47fec3bb5c5528ebcfee Mon Sep 17 00:00:00 2001
From: Joe Walker <jwalker@mozilla.com>
Date: Thu, 16 Feb 2017 15:16:04 +0000
Subject: [PATCH] Improve Debug output for ConjoiningClauses; r=rnewman

Fixes #317, and also removes the '::' exploration of rust style
---
 query-algebrizer/src/cc.rs | 49 +++++++++++++++++++++++++++++++-------
 query/src/lib.rs           |  9 ++++++-
 2 files changed, 49 insertions(+), 9 deletions(-)

diff --git a/query-algebrizer/src/cc.rs b/query-algebrizer/src/cc.rs
index 0c913045..fe9fefbb 100644
--- a/query-algebrizer/src/cc.rs
+++ b/query-algebrizer/src/cc.rs
@@ -13,8 +13,13 @@
 extern crate mentat_core;
 extern crate mentat_query;
 
-use ::std::collections::BTreeMap;
-use ::std::collections::btree_map::Entry;
+use std::fmt::{
+    Debug,
+    Formatter,
+    Result,
+};
+use std::collections::BTreeMap;
+use std::collections::btree_map::Entry;
 
 use self::mentat_core::{
     Attribute,
@@ -85,13 +90,25 @@ impl DatomsColumn {
 pub type TableAlias = String;
 
 /// The association between a table and its alias. E.g., AllDatoms, "all_datoms123".
-#[derive(PartialEq, Eq, Debug)]
+#[derive(PartialEq, Eq)]
 pub struct SourceAlias(pub DatomsTable, pub TableAlias);
 
+impl Debug for SourceAlias {
+    fn fmt(&self, f: &mut Formatter) -> Result {
+        write!(f, "SourceAlias({:?}, {})", self.0, self.1)
+    }
+}
+
 /// A particular column of a particular aliased table. E.g., "datoms123", Attribute.
-#[derive(PartialEq, Eq, Clone, Debug)]
+#[derive(PartialEq, Eq, Clone)]
 pub struct QualifiedAlias(pub TableAlias, pub DatomsColumn);
 
+impl Debug for QualifiedAlias {
+    fn fmt(&self, f: &mut Formatter) -> Result {
+        write!(f, "{}.{}", self.0, self.1.as_str())
+    }
+}
+
 impl QualifiedAlias {
     fn for_type_tag(&self) -> QualifiedAlias {
         QualifiedAlias(self.0.clone(), DatomsColumn::ValueTypeTag)
@@ -115,13 +132,30 @@ pub fn default_table_aliaser() -> TableAliaser {
     })
 }
 
-#[derive(PartialEq, Eq, Debug)]
+#[derive(PartialEq, Eq)]
 pub enum ColumnConstraint {
     EqualsEntity(QualifiedAlias, Entid),
     EqualsValue(QualifiedAlias, TypedValue),
     EqualsColumn(QualifiedAlias, QualifiedAlias),
 }
 
+impl Debug for ColumnConstraint {
+    fn fmt(&self, f: &mut Formatter) -> Result {
+        use self::ColumnConstraint::*;
+        match self {
+            &EqualsEntity(ref qa, ref entid) => {
+                write!(f, "{:?} = entity({:?})", qa, entid)
+            }
+            &EqualsValue(ref qa, ref typed_value) => {
+                write!(f, "{:?} = value({:?})", qa, typed_value)
+            }
+            &EqualsColumn(ref qa1, ref qa2) => {
+                write!(f, "{:?} = {:?}", qa1, qa2)
+            }
+        }
+    }
+}
+
 /// A `ConjoiningClauses` (CC) is a collection of clauses that are combined with `JOIN`.
 /// The topmost form in a query is a `ConjoiningClauses`.
 ///
@@ -171,9 +205,8 @@ pub struct ConjoiningClauses {
     extracted_types: BTreeMap<Variable, QualifiedAlias>,
 }
 
-impl ::std::fmt::Debug for ConjoiningClauses {
-    fn fmt(&self, fmt: &mut ::std::fmt::Formatter) -> ::std::fmt::Result {
-        // TODO: improve this representation.
+impl Debug for ConjoiningClauses {
+    fn fmt(&self, fmt: &mut Formatter) -> Result {
         fmt.debug_struct("ConjoiningClauses")
             .field("is_known_empty", &self.is_known_empty)
             .field("from", &self.from)
diff --git a/query/src/lib.rs b/query/src/lib.rs
index 78f7158a..fc98eceb 100644
--- a/query/src/lib.rs
+++ b/query/src/lib.rs
@@ -33,13 +33,14 @@
 extern crate edn;
 extern crate mentat_core;
 
+use std::fmt;
 use edn::{BigInt, OrderedFloat};
 pub use edn::{NamespacedKeyword, PlainSymbol};
 use mentat_core::TypedValue;
 
 pub type SrcVarName = String;          // Do not include the required syntactic '$'.
 
-#[derive(Clone, Debug, PartialEq, Eq, PartialOrd, Ord)]
+#[derive(Clone, PartialEq, Eq, PartialOrd, Ord)]
 pub struct Variable(pub PlainSymbol);
 
 pub trait FromValue<T> {
@@ -68,6 +69,12 @@ impl Variable {
     }
 }
 
+impl fmt::Debug for Variable {
+    fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
+        write!(f, "var({})", self.0)
+    }
+}
+
 #[derive(Clone, Debug, Eq, PartialEq)]
 pub enum SrcVar {
     DefaultSrc,