From f24d2a6be20eaa23e36a40224d7e0659f67644e0 Mon Sep 17 00:00:00 2001
From: Severyn Kozak <severyn.kozak@gmail.com>
Date: Thu, 27 Mar 2014 21:32:55 -0400
Subject: [PATCH] Add assets/config module, SASS files, templates.

Add:
	bitshift/assets.py
		-add module that contains functions to be called from inside the
		templates/ Jinja HTML files -- currently contains tag(), which generates
		an HTML asset tag based on a filename.

	bitshift/config.py
		-add Flask configuration module.

	static/(sass/main.sass, css/main.css)
		-create isolated directory for SASS files; compiled CSS files will be
		stored in static/css.

	static/css/_mixins.sass
		-add SASS partial to contain mixins (globally relevant to the project's
		styling).

	templates/layout.html
		-add various metadata.
---
 app.py                   | 14 +++++++++++---
 bitshift/__init__.py     |  1 +
 bitshift/assets.py       | 22 ++++++++++++++++++++++
 bitshift/config.py       |  6 ++++++
 static/css/main.css      |  2 ++
 static/css/main.sass     |  2 --
 static/sass/_mixins.sass | 11 +++++++++++
 static/sass/main.sass    |  7 +++++++
 templates/layout.html    | 13 +++++++++++--
 9 files changed, 71 insertions(+), 7 deletions(-)
 create mode 100644 bitshift/assets.py
 create mode 100644 bitshift/config.py
 delete mode 100644 static/css/main.sass
 create mode 100644 static/sass/_mixins.sass
 create mode 100644 static/sass/main.sass

diff --git a/app.py b/app.py
index 2e97560..a7508c4 100644
--- a/app.py
+++ b/app.py
@@ -1,10 +1,18 @@
+"""
+Module to contain all the project's Flask server plumbing.
+"""
+
 from flask import Flask
-from flask import render_template
+from flask import render_template, session
+
+from bitshift import *
 
 app = Flask(__name__)
+app.config.from_object("bitshift.config")
 
-env = app.jinja_env
-app.jinja_env.line_statement_prefix = "="
+app_env = app.jinja_env
+app_env.line_statement_prefix = "="
+app_env.globals.update(assets = assets)
 
 @app.route("/")
 def index():
diff --git a/bitshift/__init__.py b/bitshift/__init__.py
index e69de29..d51957e 100644
--- a/bitshift/__init__.py
+++ b/bitshift/__init__.py
@@ -0,0 +1 @@
+__all__ = ["config", "assets"]
diff --git a/bitshift/assets.py b/bitshift/assets.py
new file mode 100644
index 0000000..4754036
--- /dev/null
+++ b/bitshift/assets.py
@@ -0,0 +1,22 @@
+"""
+Module contains helper functions to be used inside the project's Jinja
+templates.
+"""
+
+from flask import Markup
+
+ASSET_HTML_TEMPLATES = {
+    'css': "<link rel='stylesheet' type='text/css' href='/static/css/%s'>",
+    'js': "<script src='/static/js/%s'></script>"
+}
+
+def tag(filename):
+    """
+    Return HTML tag for asset named filename.
+
+    Return either a <script> or <link> tag to the file named filename,
+    based on its extension.
+    """
+
+    file_ext = filename.split(".")[-1]
+    return Markup(ASSET_HTML_TEMPLATES[file_ext] % filename)
diff --git a/bitshift/config.py b/bitshift/config.py
new file mode 100644
index 0000000..6c7be42
--- /dev/null
+++ b/bitshift/config.py
@@ -0,0 +1,6 @@
+"""
+Module to contain definitions of all Flask variables required by the app module.
+"""
+
+DEBUG = True
+SECRET_KEY = "\x89\x87\x9a9\xab{\xda\xfe.28\xb4\x18\x01\x95]]\xd2\xeaen\xe0Ot"
diff --git a/static/css/main.css b/static/css/main.css
index 11dbe5a..40bba29 100644
--- a/static/css/main.css
+++ b/static/css/main.css
@@ -1,2 +1,4 @@
+/* Global project stylesheet.
+ */
 p {
   font-size: 1.5em; }
diff --git a/static/css/main.sass b/static/css/main.sass
deleted file mode 100644
index e0b1994..0000000
--- a/static/css/main.sass
+++ /dev/null
@@ -1,2 +0,0 @@
-p
-	font-size: 1.5em
diff --git a/static/sass/_mixins.sass b/static/sass/_mixins.sass
new file mode 100644
index 0000000..3d04e5f
--- /dev/null
+++ b/static/sass/_mixins.sass
@@ -0,0 +1,11 @@
+/*
+ Partial to contain all globally-applicable mixins
+ */
+
+// add vendor prefixes for the property $property with value $value
+@mixin vendor($property, $value)
+    -webkit-#{$property}: $value
+    -moz-#{$property}: $value
+    -ms-#{$property}: $value
+    -o-#{$property}: $value
+    #{$property}: $value
diff --git a/static/sass/main.sass b/static/sass/main.sass
new file mode 100644
index 0000000..5c8ce5d
--- /dev/null
+++ b/static/sass/main.sass
@@ -0,0 +1,7 @@
+/*
+ Global project stylesheet.
+ */
+
+// placeholder
+p
+    font-size: 1.5em
diff --git a/templates/layout.html b/templates/layout.html
index 77be6ee..9ab3eac 100644
--- a/templates/layout.html
+++ b/templates/layout.html
@@ -1,4 +1,6 @@
 <!DOCTYPE html>
+<!-- Global layout template, to be inherited by other project HTML files. -->
+
 <html>
   <head>
     <title>
@@ -6,9 +8,16 @@
       = endblock
     </title>
 
+    <meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1"/>
+    <meta name="description" content="bitshift is an online code snippet
+      exchange."/>
+    <meta name="keywords" content="code snippet exchange golf programming
+      software community"/>
+    <meta name="author" content="Benjamin Attal Ben Kurtovic Severyn Kozak"/>
+
+    {{ assets.tag("main.css") }}
+
     = block head
-      <link rel="stylesheet" type="text/css"
-        href={{ url_for('static', filename='css/main.css') }}>
     = endblock
   </head>
   <body>