T3214 Wrote basic tutorial server without content. By Giles & Hansel

Resolver Systems Ltd · Resolver Systems Ltd · commit 3e1414249c72 · 2011-11-17T18:52:24.000Z
diff --git a/server/renderer/__init__.py b/server/renderer/__init__.py
diff --git a/server/renderer/models.py b/server/renderer/models.py
@@ -0,0 +1,3 @@
+from django.db import models
+
+# Create your models here.
diff --git a/server/renderer/templates/tutorial_base.html b/server/renderer/templates/tutorial_base.html
@@ -0,0 +1,39 @@
+﻿<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN" "http://www.w3.org/TR/html4/strict.dtd">
+<html>
+    <head>
+
+        <link rel="stylesheet" href="/static/anywhere/styles/common_base.css" type="text/css" media="screen" charset="utf-8" />
+        <link rel="stylesheet" href="/static/anywhere/styles/tutorial.css" type="text/css" media="screen" charset="utf-8" />
+        <link rel="stylesheet" href="/static/pygments/style.css" type="text/css" media="screen" charset="utf-8" />
+
+        <script type="text/javascript">
+            parent.setHash({{ pagenum }});
+
+            var _gaq = _gaq || [];
+            _gaq.push(['_setAccount', 'UA-18014859-6']);
+            _gaq.push(['_trackPageview']);
+
+            (function() {
+                var ga = document.createElement('script'); ga.type = 'text/javascript'; ga.async = true;
+                ga.src = ('https:' == document.location.protocol ? 'https://ssl' : 'http://www') + '.google-analytics.com/ga.js';
+                var s = document.getElementsByTagName('script')[0]; s.parentNode.insertBefore(ga, s);
+            })();
+
+        </script>
+
+        <title>{{ title }}</title>
+
+    </head>
+
+    <body>
+        {% autoescape off %}
+            <h3>{{ title }}</h3>
+
+            {{ body }}
+        {% endautoescape %}
+    </body>
+</html>
+
+
+
+
diff --git a/server/renderer/tests/__init__.py b/server/renderer/tests/__init__.py
@@ -0,0 +1 @@
+﻿from server.renderer.tests.test_views import *
diff --git a/server/renderer/tests/test_views.py b/server/renderer/tests/test_views.py
@@ -0,0 +1,81 @@
+# Copyright (c) 2011 Resolver Systems Ltd.
+# All Rights Reserved
+#
+
+
+from django.core.urlresolvers import reverse
+from django.http import Http404, HttpResponse, HttpResponsePermanentRedirect
+
+from mock import Mock, patch
+import os
+
+from resolver_test import ResolverViewTestCase
+
+from server.renderer.views import render_view
+
+
+class RenderViewTest(ResolverViewTestCase):
+    
+    @patch("server.renderer.views.os.path.exists")    
+    def test_render_view_404s_for_nonexistent_file(self, mock_exists):
+        mock_exists.return_value = False
+
+        with self.assertRaises(Http404):
+            render_view(self.request, '9')
+        
+        
+    def test_render_view_404s_for_existing_file_outside_of_content_directory(self):
+        
+        with self.assertRaises(Http404):
+            render_view(self.request, '../../README')
+        
+        
+    @patch("server.renderer.views.os.path.exists")          
+    @patch("server.renderer.views.publish_parts")
+    @patch("server.renderer.views.render_to_response")        
+    def test_render_view_renders_rst_sensibly(self, mock_render, mock_publish_parts, mock_exists):
+        mock_exists.return_value = True
+        mock_open = Mock()
+        read_results = "The rest contents"
+        mock_open.return_value.__enter__ = Mock()
+        mock_open.return_value.__enter__.return_value.read.return_value = read_results
+        mock_open.return_value.__exit__ = Mock()
+
+        mock_publish_parts.return_value = {
+            "title": "I am a dashing -- title",
+            "body": "<div>I am a processed rest body with double --s</div>"
+        }
+
+
+        orig_open = open
+        __builtins__['open'] = mock_open
+        try:
+            response = render_view(self.request, "foo")
+        finally:
+            __builtins__['open'] = orig_open
+
+        contents_dir = os.path.abspath(os.path.join(os.path.dirname(__file__), '..', '..', '..', 'content'))   
+        self.assertCalledOnce(mock_open, os.path.join(contents_dir, 'foo.txt'), "r")
+        self.assertCalledOnce(mock_publish_parts, source=read_results, writer_name="html4css1")
+
+        self.assert_render_template_was(mock_render, "tutorial_base.html")
+        self.assertRenderedWith(mock_render, "title", "I am a dashing &mdash; title")
+        self.assertRenderedWith(mock_render, "body", "<div>I am a processed rest body with double &mdash;s</div>")
+
+
+    def test_render_view_handles_root_request_sensibly(self):
+        self.request.META['QUERY_STRING'] = ''
+        
+        response = render_view(self.request, '')
+
+        self.assertIsInstance(response, HttpResponsePermanentRedirect)
+        self.assertEquals(
+            response['Location'],
+            reverse('render_view', args=['index'])
+        )
+
+
+
+
+
+
diff --git a/server/renderer/urls.py b/server/renderer/urls.py
@@ -0,0 +1,24 @@
+﻿# Copyright (c) 2011 Resolver Systems Ltd.
+# All Rights Reserved
+#
+
+from django.conf.urls.defaults import *
+from django.conf import settings
+
+from anywhere.tutorial.views import render_tutorial_page, tutorial_root
+
+
+urlpatterns = patterns('',
+
+    url(
+        '^tutorial/$',
+        tutorial_root,
+        name="tutorial_root"
+    ),
+
+    url(
+        '^tutorial/(\d+)/$',
+        render_tutorial_page,
+        name="tutorial_page"
+    ),
+)
diff --git a/server/renderer/views.py b/server/renderer/views.py
@@ -0,0 +1,51 @@
+# Copyright (c) 2011 Resolver Systems Ltd.
+# All Rights Reserved
+#
+
+from docutils.core import publish_parts
+import os
+
+from django.core.urlresolvers import reverse
+from django.http import Http404
+from django.shortcuts import render_to_response
+from django.views.generic.simple import redirect_to
+
+
+CONTENT_DIR = os.path.abspath(
+    os.path.join(
+        os.path.dirname(
+            os.path.abspath(__file__)
+        ), 
+        '..', '..',
+        "content",
+    )
+)
+
+
+
+def render_view(request, path):
+    if path == '':
+        return redirect_to(request, reverse("render_view", args=['index']))
+        
+    filename = os.path.abspath(os.path.join(CONTENT_DIR, path + '.txt'))
+    if not os.path.exists(filename) or not filename.startswith(CONTENT_DIR):
+        raise Http404()
+        
+    with open(filename, "r") as f:
+        contents = f.read()
+
+    parts = publish_parts(source=contents, writer_name="html4css1")
+    return render_to_response(
+        "tutorial_base.html",
+        {
+            "title": __tidy_html(parts["title"]),
+            "body": __tidy_html(parts["body"]),
+        }
+    )
+
+
+
+def __tidy_html(html):
+    return html.replace("--", "&mdash;")
+
+
diff --git a/server/settings.py b/server/settings.py
@@ -116,10 +116,7 @@
     'django.contrib.sites',
     'django.contrib.messages',
     'django.contrib.staticfiles',
-    # Uncomment the next line to enable the admin:
-    # 'django.contrib.admin',
-    # Uncomment the next line to enable admin documentation:
-    # 'django.contrib.admindocs',
+    'server.renderer'
 )
 
 # A sample logging configuration. The only tangible logging
diff --git a/server/urls.py b/server/urls.py
@@ -1,17 +1,8 @@
 from django.conf.urls.defaults import patterns, include, url
 
-# Uncomment the next two lines to enable the admin:
-# from django.contrib import admin
-# admin.autodiscover()
+from server.renderer.views import render_view
 
-urlpatterns = patterns('',
-    # Examples:
-    # url(r'^$', 'server.views.home', name='home'),
-    # url(r'^server/', include('server.foo.urls')),
-
-    # Uncomment the admin/doc line below to enable admin documentation:
-    # url(r'^admin/doc/', include('django.contrib.admindocs.urls')),
 
-    # Uncomment the next line to enable the admin:
-    # url(r'^admin/', include(admin.site.urls)),
+urlpatterns = patterns('',
+    url(r'^(.*)$', render_view, name='render_view')
 )

Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,3 @@`
	`1`	`+from django.db import models`
	`2`	`+`
	`3`	`+# Create your models here.`
Original file line number	Diff line number	Diff line change
`@@ -0,0 +1 @@`
	`1`	`+from server.renderer.tests.test_views import *`