0.3.3: Add Twitter Bootstrap.

Summary: Also adds static files via `django.contrib.staticfiles` (preferred) or serving static media via `django.views.static.serve`. Test Plan: Visual. Reviewers: jeff, dcramer Reviewed By: jeff CC: vincelane Differential Revision: http://phabricator.local.disqus.net/D4329
disqus · Dec 10, 2012 · 849df95 · 849df95
1 parent f47477d
commit 849df95
Show file tree

Hide file tree

Showing 19 changed files with 202 additions and 50 deletions.
diff --git a/.arcconfig b/.arcconfig
@@ -5,7 +5,6 @@
   "copyright_holder": "Disqus, Inc.",
   "immutable_history": false,
   "differential.field-selector": "DisqusDifferentialFieldSelector",
-  "unit_engine": "DisqusUnitTestEngine",
   "lint_engine": "ComprehensiveLintEngine",
   "lint.pep8.options": "--ignore=W391,W292,W293,E501,E225",
   "lint.jshint.prefix": "node_modules/jshint/bin",

diff --git a/.gitignore b/.gitignore
@@ -4,3 +4,4 @@
 .tox/
 dist/
 docs/_build/
+node_modules/
diff --git a/.gitmodules b/.gitmodules
@@ -0,0 +1,3 @@
+[submodule "vendor/bootstrap"]
+	path = vendor/bootstrap
+	url = git://github.com/twitter/bootstrap.git
diff --git a/MANIFEST.in b/MANIFEST.in
@@ -1 +1,2 @@
+recursive-include mailviews/static *
 recursive-include mailviews/templates *
diff --git a/Makefile b/Makefile
@@ -1,4 +1,24 @@
-develop:
+STATIC_DIRECTORY = mailviews/static/mailviews
+
+LESSC = ./node_modules/.bin/lessc
+JQUERY = $(STATIC_DIRECTORY)/javascript/jquery.js
+
+
+$(LESSC):
+	npm install .
+
+bootstrap: $(LESSC)
+	git submodule update --init
+	$(LESSC) vendor/bootstrap/less/bootstrap.less > $(STATIC_DIRECTORY)/css/bootstrap.css
+	cp vendor/bootstrap/js/bootstrap-*.js $(STATIC_DIRECTORY)/javascript
+
+$(JQUERY):
+	curl http://code.jquery.com/jquery-1.8.3.js > $(JQUERY)
+
+static: bootstrap $(JQUERY)
+
+
+develop: static
 	python setup.py develop
 
 lint:
@@ -18,9 +38,13 @@ test-matrix: clean
 test-server: develop
 	python mailviews/tests/manage.py runserver
 
-publish: lint test-matrix
+sdist: static
+	python setup.py sdist
+
+publish: lint test-matrix sdist
 	git tag $$(python setup.py --version)
 	git push --tags
-	python setup.py sdist upload -r disqus
+	python setup.py upload -r disqus
+
 
-.PHONY: clean lint test test-matrix test-server publish
+.PHONY: bootstrap static develop lint clean test test-matrix test-server sdist publish
diff --git a/mailviews/__init__.py b/mailviews/__init__.py
@@ -1 +1 @@
-__version__ = (0, 3, 2)
+__version__ = (0, 3, 3)
diff --git a/mailviews/helpers.py b/mailviews/helpers.py
@@ -0,0 +1,5 @@
+from django.conf import settings
+
+
+def should_use_staticfiles():
+    return 'django.contrib.staticfiles' in settings.INSTALLED_APPS
diff --git a/mailviews/static/mailviews/css/.gitignore b/mailviews/static/mailviews/css/.gitignore
@@ -0,0 +1,3 @@
+*
+!.gitignore
+!mailviews.css
diff --git a/mailviews/static/mailviews/css/mailviews.css b/mailviews/static/mailviews/css/mailviews.css
@@ -0,0 +1,26 @@
+body {
+    padding-top: 60px;
+}
+
+#html iframe,
+#html textarea {
+    border: 0;
+    height: 700px;
+    width: 100%;
+}
+
+#html textarea {
+    font-family: monospace;
+    padding: 0;
+}
+
+section {
+    border-bottom: 1px solid #ddd;
+    padding-bottom: 20px;
+    margin-bottom: 20px;
+}
+
+section.last {
+    border-bottom: 0;
+    padding-bottom: 0;
+}
diff --git a/mailviews/static/mailviews/javascript/.gitignore b/mailviews/static/mailviews/javascript/.gitignore
@@ -0,0 +1,2 @@
+*
+!.gitignore
diff --git a/mailviews/templates/mailviews/message.html b/mailviews/templates/mailviews/message.html
@@ -2,77 +2,105 @@
 <html lang="en">
 <head>
 
-    <style type="text/css">
+    {% load mailviews %}
 
-        iframe {
-            height: 700px;
-            width: 100%;
-        }
+    <link rel="stylesheet" type="text/css" href="{% mailviews_static 'mailviews/css/bootstrap.css' %}" />
+    <link rel="stylesheet" type="text/css" href="{% mailviews_static 'mailviews/css/mailviews.css' %}" />
 
-        textarea {
-            min-height: 250px;
-            width: 100%;
-        }
-
-    </style>
+    <script type="text/javascript" src="{% mailviews_static 'mailviews/javascript/jquery.js' %}"></script>
+    <script type="text/javascript" src="{% mailviews_static 'mailviews/javascript/bootstrap-tab.js' %}"></script>
 
 </head>
 <body>
 
-    <header>
+    <div class="navbar navbar-inverse navbar-fixed-top">
+      <div class="navbar-inner">
+        <div class="container">
+          <a class="brand" href="#">Preview</a>
+          <div class="nav-collapse collapse">
+            <ul class="nav">
+              {% if html %}
+                <li><a href="#html">HTML</a></li>
+              {% endif %}
+              <li><a href="#body-plain">Text</a></li>
+              <li><a href="#raw">Raw</a></li>
+            </ul>
+          </div><!--/.nav-collapse -->
+        </div>
+      </div>
+    </div>
 
-        <h1>{{ subject }}</h1>
+    <div class="container">
 
-        <div id="headers">
+        <div class="page-header">
+            <h1>{{ subject }}</h1>
+        </div>
 
-            <h2>Headers</h2>
+        <header>
 
-            <dl>
-                {% for name, value in headers %}
-                    <dt>{{ name }}</dt>
-                    <dd>{{ value }}</dd>
-                {% endfor %}
-            </dl>
+            <div id="headers">
 
-        </div>
+                <table class="table table-striped table-condensed">
+                    {% for name, value in headers %}
+                        <tr>
+                            <th>{{ name }}</th>
+                            <td>{{ value }}</td>
+                        </tr>
+                    {% endfor %}
+                </table>
 
-    </header>
+            </div>
 
-    {% if html %}
+        </header>
 
-        <section id="body-html">
+        {% if html %}
 
-            <h2>HTML Body (Preview)</h2>
+        <div id="html">
 
-            <iframe src="data:text/html;base64,{{ escaped_html }}"></iframe>
+            <h2>HTML</h2>
 
-        </section>
+            <ul class="nav nav-tabs">
+                <li class="active"><a href="#body-html" data-toggle="tab">Preview</a></li>
+                <li><a href="#html-raw" data-toggle="tab">Source</a></li>
+            </ul>
 
-        <section id="html-raw">
+            <div class="tab-content">
 
-            <h2>HTML Body (Raw)</h2>
+                <section id="body-html" class="tab-pane active">
+                    <iframe src="data:text/html;base64,{{ escaped_html }}" frameborder="0" allowtransparency="true"></iframe>
+                </section>
 
-            <textarea>{{ html|escape }}</textarea>
+                <section id="html-raw" class="tab-pane">
+                    <textarea>{{ html|escape }}</textarea>
+                </section>
 
-        </section>
+            </div>
 
-    {% endif %}
+        </div>
+
+        {% endif %}
 
-    <section id="body-plain">
+        <section id="body-plain">
 
-        <h2>Body (Text)</h2>
+            <h2>Text</h2>
 
-        {{ body|linebreaks }}
+            {% if body %}
+                {{ body|linebreaks }}
+            {% else %}
+                <p class="alert">This message doesn't contain any text content.</p>
+            {% endif %}
 
-    </section>
+        </section>
 
-    <section id="raw">
+        <section id="raw" class="last">
 
-        <h2>Raw Message</h2>
+            <h2>Raw</h2>
 
-        <pre>{{ raw }}</pre>
+            <pre>{{ raw }}</pre>
+
+        </section>
 
-    </section>
+    </div>
 
 </body>
 </html>
diff --git a/mailviews/templatetags/__init__.py b/mailviews/templatetags/__init__.py
diff --git a/mailviews/templatetags/mailviews.py b/mailviews/templatetags/mailviews.py
@@ -0,0 +1,22 @@
+from __future__ import absolute_import
+
+from django import template
+
+from mailviews.helpers import should_use_staticfiles
+
+
+register = template.Library()
+
+
+def mailviews_static(path):
+    if should_use_staticfiles():
+        from django.contrib.staticfiles.templatetags import staticfiles
+        return staticfiles.static(path)
+    else:
+        from django.core.urlresolvers import reverse
+        return reverse('mailviews-static', kwargs={
+            'path': path,
+        })
+
+
+register.simple_tag(mailviews_static)
diff --git a/mailviews/tests/__init__.py b/mailviews/tests/__init__.py
@@ -13,6 +13,7 @@
             },
         },
         ROOT_URLCONF='mailviews.tests.urls',
+        STATIC_URL='/static/',
     )
 
 

diff --git a/mailviews/tests/urls.py b/mailviews/tests/urls.py
@@ -1,8 +1,9 @@
-from django.conf.urls.defaults import patterns, url
+from django.conf.urls.defaults import include, patterns, url
 
 from mailviews.tests.views import preview
 
 
 urlpatterns = patterns('',
     url(regex=r'^$', view=preview),
+    url(regex=r'^mailviews/', view=include('mailviews.urls')),
 )
diff --git a/mailviews/tests/views.py b/mailviews/tests/views.py
@@ -1,6 +1,6 @@
 import random
 
-from django.contrib.webdesign.lorem_ipsum import paragraphs, sentence
+from django.contrib.webdesign.lorem_ipsum import paragraphs, words
 from django.template import Template
 
 from mailviews.messages import (TemplatedEmailMessageView,
@@ -23,7 +23,7 @@ def preview(request):
         message_view.html_body_template = Template('{{ content|linebreaks }}')
 
     message = message_view.render_to_message(extra_context={
-        'subject': sentence(),
+        'subject': words(random.randint(5, 20), common=False),
         'content': '\n'.join(paragraphs(random.randint(3, 6))),
     })
     return render_message_to_response(request, message)
diff --git a/mailviews/urls.py b/mailviews/urls.py
@@ -0,0 +1,19 @@
+import os
+
+from django.conf.urls.defaults import patterns, url
+
+from mailviews.helpers import should_use_staticfiles
+
+
+urlpatterns = patterns('')
+
+
+if not should_use_staticfiles():
+    urlpatterns += patterns('',
+        url(regex=r'^static/(?P<path>.*)$',
+            view='django.views.static.serve',
+            kwargs={
+                'document_root': os.path.join(os.path.dirname(__file__), 'static'),
+            },
+            name='mailviews-static'),
+    )
diff --git a/package.json b/package.json
@@ -0,0 +1,16 @@
+{
+  "name": "django-mailviews",
+  "version": "0.0.0",
+  "description": "",
+  "repository": {
+    "type": "git",
+    "url": "git://github.com/disqus/django-mailviews.git"
+  },
+  "author": "disqus",
+  "license": "apache license 2.0",
+  "readmeFilename": "README.rst",
+  "dependencies": {
+    "less": "1.3.1",
+    "jshint": "0.8.0"
+  }
+}
diff --git a/vendor/bootstrap b/vendor/bootstrap
-Original file line number
+Diff line change
@@ Expand Up / @@ -4,3 +4,4 @@ @@
     .tox/
     dist/
     docs/_build/
+    node_modules/
Original file line number	Diff line number	Diff line change
		@@ -1 +1,2 @@
		recursive-include mailviews/static *
		recursive-include mailviews/templates *