diff options
author | Christopher Allan Webber <cwebber@dustycloud.org> | 2011-06-28 20:09:35 -0500 |
---|---|---|
committer | Christopher Allan Webber <cwebber@dustycloud.org> | 2011-06-28 20:09:35 -0500 |
commit | 86e3e90080835557cd3734b47506fce0a2352405 (patch) | |
tree | e37060110f759ed392d6ebbf7ab87558f54f1257 | |
parent | 2527754202ea9530c9046270e63d71581923dc77 (diff) | |
parent | 9f094beaafa2b5cefcd1812b692421cb0e1718e6 (diff) | |
download | mediagoblin-86e3e90080835557cd3734b47506fce0a2352405.tar.lz mediagoblin-86e3e90080835557cd3734b47506fce0a2352405.tar.xz mediagoblin-86e3e90080835557cd3734b47506fce0a2352405.zip |
Merge remote branch 'remotes/gullydwarf-cfdv/f368_msg_framework'
-rw-r--r-- | mediagoblin/messages.py | 34 | ||||
-rw-r--r-- | mediagoblin/templates/mediagoblin/base.html | 2 | ||||
-rw-r--r-- | mediagoblin/templates/mediagoblin/utils/messages.html | 28 | ||||
-rw-r--r-- | mediagoblin/tests/test_messages.py | 44 | ||||
-rw-r--r-- | mediagoblin/util.py | 5 |
5 files changed, 113 insertions, 0 deletions
diff --git a/mediagoblin/messages.py b/mediagoblin/messages.py new file mode 100644 index 00000000..afe6ee7e --- /dev/null +++ b/mediagoblin/messages.py @@ -0,0 +1,34 @@ +# GNU MediaGoblin -- federated, autonomous media hosting +# Copyright (C) 2011 Free Software Foundation, Inc +# +# This program is free software: you can redistribute it and/or modify +# it under the terms of the GNU Affero General Public License as published by +# the Free Software Foundation, either version 3 of the License, or +# (at your option) any later version. +# +# This program is distributed in the hope that it will be useful, +# but WITHOUT ANY WARRANTY; without even the implied warranty of +# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +# GNU Affero General Public License for more details. +# +# You should have received a copy of the GNU Affero General Public License +# along with this program. If not, see <http://www.gnu.org/licenses/>. + +DEBUG = 'debug' +INFO = 'info' +SUCCESS = 'success' +WARNING = 'warning' +ERROR = 'error' + +def add_message(request, level, text): + messages = request.session.setdefault('messages', []) + messages.append({'level': level, 'text': text}) + request.session.save() + +def fetch_messages(request, clear_from_session=True): + messages = request.session.get('messages') + if messages and clear_from_session: + # Save that we removed the messages from the session + request.session['messages'] = [] + request.session.save() + return messages diff --git a/mediagoblin/templates/mediagoblin/base.html b/mediagoblin/templates/mediagoblin/base.html index 2b47a14c..58de7325 100644 --- a/mediagoblin/templates/mediagoblin/base.html +++ b/mediagoblin/templates/mediagoblin/base.html @@ -51,6 +51,8 @@ </div> </div> {% endblock %} + + {% include "mediagoblin/utils/messages.html" %} <div class="container_12 mediagoblin_content"> <div class="grid_12"> diff --git a/mediagoblin/templates/mediagoblin/utils/messages.html b/mediagoblin/templates/mediagoblin/utils/messages.html new file mode 100644 index 00000000..a8d9c37e --- /dev/null +++ b/mediagoblin/templates/mediagoblin/utils/messages.html @@ -0,0 +1,28 @@ +{# +# GNU MediaGoblin -- federated, autonomous media hosting +# Copyright (C) 2011 Free Software Foundation, Inc +# +# This program is free software: you can redistribute it and/or modify +# it under the terms of the GNU Affero General Public License as published by +# the Free Software Foundation, either version 3 of the License, or +# (at your option) any later version. +# +# This program is distributed in the hope that it will be useful, +# but WITHOUT ANY WARRANTY; without even the implied warranty of +# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +# GNU Affero General Public License for more details. +# +# You should have received a copy of the GNU Affero General Public License +# along with this program. If not, see <http://www.gnu.org/licenses/>. +#} + +{# Display any queued messages #} +{% set messages = fetch_messages(request) %} +{% if messages %} + <ul class="mediagoblin_messages"> + {% for msg in messages %} + <li class="message_{{ msg.level }}">{{ msg.text }}</li> + {% endfor %} + </ul> +{% endif %} + diff --git a/mediagoblin/tests/test_messages.py b/mediagoblin/tests/test_messages.py new file mode 100644 index 00000000..4cd9381a --- /dev/null +++ b/mediagoblin/tests/test_messages.py @@ -0,0 +1,44 @@ +# GNU MediaGoblin -- federated, autonomous media hosting +# Copyright (C) 2011 Free Software Foundation, Inc +# +# This program is free software: you can redistribute it and/or modify +# it under the terms of the GNU Affero General Public License as published by +# the Free Software Foundation, either version 3 of the License, or +# (at your option) any later version. +# +# This program is distributed in the hope that it will be useful, +# but WITHOUT ANY WARRANTY; without even the implied warranty of +# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +# GNU Affero General Public License for more details. +# +# You should have received a copy of the GNU Affero General Public License +# along with this program. If not, see <http://www.gnu.org/licenses/>. + +from mediagoblin.messages import fetch_messages, add_message +from mediagoblin.tests.tools import setup_fresh_app +from mediagoblin import util + + +@setup_fresh_app +def test_messages(test_app): + """ + Added messages should show up in the request.session, + fetched messages should be the same as the added ones, + and fetching should clear the message list. + """ + # Aquire a request object + test_app.get('/') + context = util.TEMPLATE_TEST_CONTEXT['mediagoblin/root.html'] + request = context['request'] + + # The message queue should be empty + assert request.session.get('messages', []) == [] + + # Adding a message should modify the session accordingly + add_message(request, 'herp_derp', 'First!') + test_msg_queue = [{'text': 'First!', 'level': 'herp_derp'}] + assert request.session['messages'] == test_msg_queue + + # fetch_messages should return and empty the queue + assert fetch_messages(request) == test_msg_queue + assert request.session.get('messages') == [] diff --git a/mediagoblin/util.py b/mediagoblin/util.py index 91fbee0a..a20e87c4 100644 --- a/mediagoblin/util.py +++ b/mediagoblin/util.py @@ -32,6 +32,7 @@ from lxml.html.clean import Cleaner import markdown from mediagoblin import mg_globals +from mediagoblin import messages from mediagoblin.db.util import ObjectId TESTS_ENABLED = False @@ -104,6 +105,10 @@ def get_jinja_env(template_loader, locale): mg_globals.translations.gettext, mg_globals.translations.ngettext) + # All templates will know how to ... + # ... fetch all waiting messages and remove them from the queue + template_env.globals['fetch_messages'] = messages.fetch_messages + if exists(locale): SETUP_JINJA_ENVS[locale] = template_env |