Merge pull request #429 from pgiraud/cache_busting

Using the new cache busting from pyramid 1.6-dev
hotosm · Nov 3, 2014 · 5bb8880 · 5bb8880
2 parents b501337 + ed425ac
commit 5bb8880
Show file tree

Hide file tree

Showing 13 changed files with 62 additions and 37 deletions.
diff --git a/.travis.yml b/.travis.yml
@@ -12,7 +12,7 @@ before_install:
 install:
 - virtualenv env
 - source env/bin/activate
-- python setup.py develop
+- pip install -r requirements.txt
 - sudo service postgresql restart
 - sudo -u postgres createuser www-data --no-superuser --no-createdb --no-createrole
 - sudo -u postgres createdb -O www-data osmtm

diff --git a/README.md b/README.md
@@ -25,7 +25,7 @@ To create a virtual Python environment:
     cd osm-tasking-manager2
     sudo easy_install virtualenv
     virtualenv --no-site-packages env
-    ./env/bin/python setup.py develop
+    ./env/bin/pip install -r requirements.txt
 
 *Tip: if you encounter problems installing `psycopg2` especially on Mac, it is recommended to follow advice proposed [here](http://stackoverflow.com/questions/22313407/clang-error-unknown-argument-mno-fused-madd-python-package-installation-fa).*
 

diff --git a/RELEASING.md b/RELEASING.md
@@ -12,7 +12,6 @@
 - [ ] Draft a new release https://github.com/hotosm/osm-tasking-manager2/releases/new
 - [ ] Update CHANGELOG.md
 - [ ] Update version number in setup.py
-- [ ] Update version number in mako templates (resources)
 - [ ] git ci -m "Bumping version A.B.C"
 - [ ] git tag A.B.C (for example 2.3.0)
 - [ ] git push upstream --tags

diff --git a/osmtm/__init__.py b/osmtm/__init__.py
@@ -20,6 +20,10 @@
     group_membership,
 )
 
+from .git_cache_buster import (
+    GitCacheBuster,
+)
+
 
 def main(global_config, **settings):
     """ This function returns a Pyramid WSGI application.
@@ -53,7 +57,8 @@ def main(global_config, **settings):
     session_factory = UnencryptedCookieSessionFactoryConfig('itsasecret')
     config.set_session_factory(session_factory)
 
-    config.add_static_view('static', 'static', cache_max_age=3600)
+    config.add_static_view('static', 'static', cache_max_age=3600,
+                           cachebust=GitCacheBuster())
     config.add_route('home', '/')
     config.add_route('about', '/about')
     config.add_route('login', '/login')

diff --git a/osmtm/git_cache_buster.py b/osmtm/git_cache_buster.py
@@ -0,0 +1,19 @@
+import os
+import subprocess
+from pyramid.static import PathSegmentMd5CacheBuster
+
+
+class GitCacheBuster(PathSegmentMd5CacheBuster):
+    """
+    Assuming your code is installed as a Git checkout, as opposed to as an
+    egg from an egg repository like PYPI, you can use this cachebuster to
+    get the current commit's SHA1 to use as the cache bust token.
+    """
+    def __init__(self):
+        here = os.path.dirname(os.path.abspath(__file__))
+        self.sha1 = subprocess.check_output(
+            ['git', 'rev-parse', 'HEAD'],
+            cwd=here).strip()
+
+    def token(self, pathspec):
+        return self.sha1
diff --git a/osmtm/templates/base.mako b/osmtm/templates/base.mako
@@ -6,15 +6,15 @@
   <head>
   <title>${custom.instance_name()} - ${self.title()}</title>
     <link rel="shortcut icon" href="${request.static_url('osmtm:static/img/favicon.ico')}">
-    <link rel="stylesheet" href="${request.static_url('osmtm:static/css/main.css', _query={'v':'2.7-dev'})}">
-    <link rel="stylesheet" href="${request.static_url('osmtm:static/js/lib/leaflet.css', _query={'v':'2.7-dev'})}">
-    <script src="${request.static_url('osmtm:static/js/lib/jquery-1.7.2.min.js', _query={'v':'2.7-dev'})}"></script>
-    <script src="${request.static_url('osmtm:static/js/lib/showdown.js', _query={'v':'2.7-dev'})}"></script>
-    <script src="${request.static_url('osmtm:static/js/lib/jquery-timeago/jquery.timeago.js', _query={'v':'2.7-dev'})}"></script>
-    <script src="${request.static_url('osmtm:static/js/lib/jquery-timeago/locales/jquery.timeago.%s.js' % request.locale_name, _query={'v':'2.7-dev'})}"></script>
-    <script src="${request.static_url('osmtm:static/js/lib/sammy-latest.min.js', _query={'v':'2.7-dev'})}"></script>
-    <script src="${request.static_url('osmtm:static/js/shared.js', _query={'v':'2.7-dev'})}"></script>
-    <script src="${request.static_url('osmtm:static/bootstrap/dist/js/bootstrap.min.js', _query={'v':'2.7-dev'})}"></script>
+    <link rel="stylesheet" href="${request.static_url('osmtm:static/css/main.css')}">
+    <link rel="stylesheet" href="${request.static_url('osmtm:static/js/lib/leaflet.css')}">
+    <script src="${request.static_url('osmtm:static/js/lib/jquery-1.7.2.min.js')}"></script>
+    <script src="${request.static_url('osmtm:static/js/lib/showdown.js')}"></script>
+    <script src="${request.static_url('osmtm:static/js/lib/jquery-timeago/jquery.timeago.js')}"></script>
+    <script src="${request.static_url('osmtm:static/js/lib/jquery-timeago/locales/jquery.timeago.%s.js' % request.locale_name)}"></script>
+    <script src="${request.static_url('osmtm:static/js/lib/sammy-latest.min.js')}"></script>
+    <script src="${request.static_url('osmtm:static/js/shared.js')}"></script>
+    <script src="${request.static_url('osmtm:static/bootstrap/dist/js/bootstrap.min.js')}"></script>
 <%
 from osmtm.models import DBSession, TaskComment
 login_url= request.route_path('login', _query=[('came_from', request.url)])

diff --git a/osmtm/templates/project.edit.mako b/osmtm/templates/project.edit.mako
@@ -4,12 +4,12 @@
 <h1>${project.id} - ${project.name} - Edit</h1>
 </%block>
 <%block name="content">
-<link rel="stylesheet" href="${request.static_url('osmtm:static/js/lib/datepicker3.css', _query={'v':'2.7-dev'})}">
-<script type="text/javascript" src="${request.static_url('osmtm:static/js/lib/angular.min.js', _query={'v':'2.7-dev'})}"></script>
-<script type="text/javascript" src="${request.static_url('osmtm:static/js/lib/bootstrap-datepicker.js', _query={'v':'2.7-dev'})}"></script>
-<link rel="stylesheet" href="${request.static_url('osmtm:static/js/lib/Leaflet.draw/dist/leaflet.draw.css', _query={'v':'2.7-dev'})}"/>
-<script src="${request.static_url('osmtm:static/js/lib/leaflet.js', _query={'v':'2.7-dev'})}"></script>
-<script src="${request.static_url('osmtm:static/js/lib/Leaflet.draw/dist/leaflet.draw.js', _query={'v':'2.7-dev'})}"></script>
+<link rel="stylesheet" href="${request.static_url('osmtm:static/js/lib/datepicker3.css')}">
+<script type="text/javascript" src="${request.static_url('osmtm:static/js/lib/angular.min.js')}"></script>
+<script type="text/javascript" src="${request.static_url('osmtm:static/js/lib/bootstrap-datepicker.js')}"></script>
+<link rel="stylesheet" href="${request.static_url('osmtm:static/js/lib/Leaflet.draw/dist/leaflet.draw.css')}"/>
+<script src="${request.static_url('osmtm:static/js/lib/leaflet.js')}"></script>
+<script src="${request.static_url('osmtm:static/js/lib/Leaflet.draw/dist/leaflet.draw.js')}"></script>
 <div id="markdown_cheat_sheet" class="modal fade">
   <div class="modal-dialog">
   <div class="modal-content">
@@ -78,8 +78,8 @@ geometry = loads(str(project.area.geometry.data))
       </div>
     </div>
   </form>
-  <script type="text/javascript" src="${request.static_url('osmtm:static/js/project.edit.js', _query={'v':'2.7-dev'})}"></script>
-  <script src="${request.static_url('osmtm:static/js/lib/typeahead.bundle.js', _query={'v':'2.7-dev'})}"></script>
+  <script type="text/javascript" src="${request.static_url('osmtm:static/js/project.edit.js')}"></script>
+  <script src="${request.static_url('osmtm:static/js/lib/typeahead.bundle.js')}"></script>
 </div>
 </%block>
 <%block name="description">

diff --git a/osmtm/templates/project.mako b/osmtm/templates/project.mako
@@ -84,7 +84,7 @@ else:
     </div>
   </div>
 </div>
-<script src="${request.static_url('osmtm:static/js/lib/leaflet.js', _query={'v':'2.7-dev'})}"></script>
+<script src="${request.static_url('osmtm:static/js/lib/leaflet.js')}"></script>
 <script>
 <%
 from shapely.wkb import loads
@@ -102,9 +102,9 @@ var statesI18n = ["${_('Ready')}", "${_('Invalidated')}", "${_('Done')}", "${_('
 var commentRequiredMsg = "${_('You must leave a comment.')}";
 var highPriorityI18n = "${_('High priority')}";
 </script>
-  <script src="${request.static_url('osmtm:static/js/lib/d3.v3.js', _query={'v':'2.7-dev'})}"></script>
-  <script type="text/javascript" src="${request.static_url('osmtm:static/js/project.js', _query={'v':'2.7-dev'})}"></script>
-  <script type="text/javascript" src="${request.static_url('osmtm:static/js/task.difficulty.js', _query={'v':'2.7-dev'})}"></script>
-  <script src="${request.static_url('osmtm:static/js/lib/At.js/js/jquery.caret.js', _query={'v':'2.7-dev'})}"></script>
-  <script src="${request.static_url('osmtm:static/js/lib/At.js/js/jquery.atwho.js', _query={'v':'2.7-dev'})}"></script>
+  <script src="${request.static_url('osmtm:static/js/lib/d3.v3.js')}"></script>
+  <script type="text/javascript" src="${request.static_url('osmtm:static/js/project.js')}"></script>
+  <script type="text/javascript" src="${request.static_url('osmtm:static/js/task.difficulty.js')}"></script>
+  <script src="${request.static_url('osmtm:static/js/lib/At.js/js/jquery.caret.js')}"></script>
+  <script src="${request.static_url('osmtm:static/js/lib/At.js/js/jquery.atwho.js')}"></script>
 </%block>
diff --git a/osmtm/templates/project.new.import.mako b/osmtm/templates/project.new.import.mako
@@ -15,5 +15,5 @@
     </p>
   </form>
 </div>
-<script src="${request.static_url('osmtm:static/js/project.new.import.js', _query={'v':'2.7-dev'})}"></script>
+<script src="${request.static_url('osmtm:static/js/project.new.import.js')}"></script>
 </%block>
diff --git a/osmtm/templates/project.new.mako b/osmtm/templates/project.new.mako
@@ -17,11 +17,11 @@
       </div>
     </div>
 </div>
-<link rel="stylesheet" href="${request.static_url('osmtm:static/js/lib/Leaflet.draw/dist/leaflet.draw.css', _query={'v':'2.7-dev'})}"/>
-<script src="${request.static_url('osmtm:static/js/lib/leaflet.js', _query={'v':'2.7-dev'})}"></script>
-<script src="${request.static_url('osmtm:static/js/lib/Leaflet.draw/dist/leaflet.draw.js', _query={'v':'2.7-dev'})}"></script>
-<script src="${request.static_url('osmtm:static/js/lib/leaflet-omnivore.min.js', _query={'v':'2.7-dev'})}"></script>
-<script src="${request.static_url('osmtm:static/js/project.new.js', _query={'v':'2.7-dev'})}"></script>
+<link rel="stylesheet" href="${request.static_url('osmtm:static/js/lib/Leaflet.draw/dist/leaflet.draw.css')}"/>
+<script src="${request.static_url('osmtm:static/js/lib/leaflet.js')}"></script>
+<script src="${request.static_url('osmtm:static/js/lib/Leaflet.draw/dist/leaflet.draw.js')}"></script>
+<script src="${request.static_url('osmtm:static/js/lib/leaflet-omnivore.min.js')}"></script>
+<script src="${request.static_url('osmtm:static/js/project.new.js')}"></script>
 
 </%block>
 
@@ -64,7 +64,7 @@
         <input type="radio" name="type" value="grid" checked/>
         Square Grid
         <br>
-        <img src="${request.static_url('osmtm:static/img/project_creation_grid.png', _query={'v':'2.7-dev'})}" width="150">
+        <img src="${request.static_url('osmtm:static/img/project_creation_grid.png')}" width="150">
         <p class="help-block">
         Area of interest is automatically split into grid cells. Each one is a task.<br>
         </p>
@@ -78,7 +78,7 @@
         <input type="radio" name="type" value="arbitrary" disabled />
         Arbitrary Geometries
         <br>
-        <img src="${request.static_url('osmtm:static/img/project_creation_arbitrary.png', _query={'v':'2.7-dev'})}" width="150">
+        <img src="${request.static_url('osmtm:static/img/project_creation_arbitrary.png')}" width="150">
         <p class="help-block">
         Each polygon represents a task.<br>
         </p>

diff --git a/osmtm/templates/task.assigned.mako b/osmtm/templates/task.assigned.mako
@@ -11,7 +11,7 @@
     </a>
     % endif
   </div>
-  <script type="text/javascript" src="${request.static_url('osmtm:static/js/task.assign.js', _query={'v':'2.7-dev'})}"></script>
+  <script type="text/javascript" src="${request.static_url('osmtm:static/js/task.assign.js')}"></script>
   <div id="assign_to_selector" class="panel panel-default hide">
     <div class="panel-heading small">
       <strong>

diff --git a/requirements.txt b/requirements.txt
@@ -0,0 +1,2 @@
+-e git+https://github.com/Pylons/pyramid.git#egg=pyramid
+-e .
diff --git a/setup.py b/setup.py
@@ -7,7 +7,7 @@
 CHANGES = open(os.path.join(here, 'CHANGELOG.md')).read()
 
 requires = [
-    'pyramid==1.5',
+    'pyramid==1.6-dev',
     'pyramid_mako==1.0.2',
     'SQLAlchemy==0.9.3',
     'transaction',