From 61d1fc26786511c5142c55e5ccacfafe21cc666e Mon Sep 17 00:00:00 2001
From: Matt Good <matt@matt-good.net>
Date: Fri, 17 Apr 2015 13:47:22 -0700
Subject: [PATCH] Display steps needed to display SQL queries

In the SQLAlchemy panel, detect if Flask-SQLAlchemy is not set up to record
queries for the current app, and display the necessary steps to set it up.

The following steps will be detected and displayed if needed:

* install Flask-SQLAlchemy package
* add the extension to this app
* set SQLALCHEMY_RECORD_QUERIES if DEBUG is False
---
 flask_debugtoolbar/panels/sqlalchemy.py   | 49 +++++++++++++++--------
 flask_debugtoolbar/static/css/toolbar.css | 20 ++++++++-
 2 files changed, 51 insertions(+), 18 deletions(-)

diff --git a/flask_debugtoolbar/panels/sqlalchemy.py b/flask_debugtoolbar/panels/sqlalchemy.py
index bf421c8..b39d35b 100644
--- a/flask_debugtoolbar/panels/sqlalchemy.py
+++ b/flask_debugtoolbar/panels/sqlalchemy.py
@@ -49,6 +49,25 @@ def load_query(data):
     return statement, params
 
 
+def extension_used():
+    return 'sqlalchemy' in current_app.extensions
+
+
+def recording_enabled():
+    return current_app.debug or current_app.config.get('SQLALCHEMY_RECORD_QUERIES')
+
+
+def is_available():
+    return json_available and sqlalchemy_available and extension_used() and recording_enabled()
+
+
+def get_queries():
+    if get_debug_queries:
+        return get_debug_queries()
+    else:
+        return []
+
+
 class SQLAlchemyDebugPanel(DebugPanel):
     """
     Panel that displays the time a response took in milliseconds.
@@ -57,9 +76,7 @@ class SQLAlchemyDebugPanel(DebugPanel):
 
     @property
     def has_content(self):
-        if not json_available or not sqlalchemy_available:
-            return True  # will display an error message
-        return bool(get_debug_queries())
+        return bool(get_queries()) or not is_available()
 
     def process_request(self, request):
         pass
@@ -71,12 +88,12 @@ class SQLAlchemyDebugPanel(DebugPanel):
         return _('SQLAlchemy')
 
     def nav_subtitle(self):
-        if not json_available or not sqlalchemy_available:
+        count = len(get_queries())
+
+        if not count and not is_available():
             return 'Unavailable'
 
-        if get_debug_queries:
-            count = len(get_debug_queries())
-            return "%d %s" % (count, "query" if count == 1 else "queries")
+        return '%d %s' % (count, 'query' if count == 1 else 'queries')
 
     def title(self):
         return _('SQLAlchemy queries')
@@ -85,16 +102,16 @@ class SQLAlchemyDebugPanel(DebugPanel):
         return ''
 
     def content(self):
-        if not json_available or not sqlalchemy_available:
-            msg = ['Missing required libraries:', '<ul>']
-            if not json_available:
-                msg.append('<li>simplejson</li>')
-            if not sqlalchemy_available:
-                msg.append('<li>Flask-SQLAlchemy</li>')
-            msg.append('</ul>')
-            return '\n'.join(msg)
+        queries = get_queries()
+
+        if not queries and not is_available():
+            return self.render('panels/sqlalchemy_error.html', {
+                'json_available': json_available,
+                'sqlalchemy_available': sqlalchemy_available,
+                'extension_used': extension_used(),
+                'recording_enabled': recording_enabled(),
+            })
 
-        queries = get_debug_queries()
         data = []
         for query in queries:
             data.append({
diff --git a/flask_debugtoolbar/static/css/toolbar.css b/flask_debugtoolbar/static/css/toolbar.css
index 822b662..d93270c 100644
--- a/flask_debugtoolbar/static/css/toolbar.css
+++ b/flask_debugtoolbar/static/css/toolbar.css
@@ -15,7 +15,7 @@
 
 #flDebug { font-family: sans-serif; color: #000; background: #fff; }
 
-#flDebug tbody, #flDebug code {
+#flDebug tbody, #flDebug code, #flDebug pre {
   font-family: Consolas, Monaco, "Bitstream Vera Sans Mono", "Lucida Console", monospace;
 }
 
@@ -148,7 +148,7 @@
 }
 
 #flDebug code {
-  display:block;
+  display:inline;
   white-space:pre;
   overflow:auto;
 }
@@ -219,6 +219,10 @@
   margin-top:0.8em;
 }
 
+#flDebug h5 {
+  font-size: 14px;
+}
+
 #flDebug .panelContent table {
   border:1px solid #ccc;
   border-collapse:collapse;
@@ -246,6 +250,18 @@
   padding-right:.5em;
 }
 
+#flDebug .panelContent ol li {
+  margin: 0 0 1em 2em;
+}
+
+#flDebug .panelContent pre {
+  border:1px solid #ccc;
+  background-color:#fff;
+  display:block;
+  margin:0.8em 0;
+  padding: 0.2em 0.5em;
+}
+
 #flDebug .flTemplateHideContextDiv {
   background-color:#fff;
 }