Submitter:	Christian Hammond	Reviewers
Branch:	trunk	Groups:	reviewboard
Bugs:		People:
Change Number:	None	Repository:	Navi

Description:

Moved all of reviewboard.utils and reviewboard.reviews.templatetags.emailtags into djblets.util.

The template tags have been split into sections: djblets_utils (which has most of the old htmlutils), djblets_email (which has the old emailtags), djblets_deco (which contains the box tags), and djblets_js (which for now contains only the JavaScript dialog serialization code).

The Review Board side of this change will be in a separate review request.

Testing Done:

Made sure Review Board's unit tests test Djblets and that everything works fine. Went to all the main Review Board pages without problems.

Diff revision 2 (Latest)

Jump to revision:	1 2
Changes between r2 and:	1 2

Files Changed:

/trunk/djblets/djblets/util/fields.py: 1 change [ new content ]
/trunk/djblets/djblets/util/tests.py: 1 change [ new content ]
/trunk/djblets/djblets/util/templatetags/djblets_deco.py: 1 change [ new content ]
/trunk/djblets/djblets/util/templatetags/djblets_email.py: 1 change [ new content ]
/trunk/djblets/djblets/util/templatetags/djblets_images.py: 1 change [ new content ]
/trunk/djblets/djblets/util/templatetags/djblets_js.py: 1 change [ new content ]
/trunk/djblets/djblets/util/templatetags/djblets_utils.py: 1 change [ new content ]

Expand changes

+#
 # fields.py -- Model fields.
+#
 # Copyright (c) 2007-2008  Christian Hammond
 # Copyright (c) 2007-2008  David Trowbridge
+#
 # Permission is hereby granted, free of charge, to any person obtaining
 # a copy of this software and associated documentation files (the
 # "Software"), to deal in the Software without restriction, including
 # without limitation the rights to use, copy, modify, merge, publish,
 # distribute, sublicense, and/or sell copies of the Software, and to
 # permit persons to whom the Software is furnished to do so, subject to
 # the following conditions:
+#
 # The above copyright notice and this permission notice shall be included
 # in all copies or substantial portions of the Software.
+#
 # THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
 # EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
 # MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
 # IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
 # CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
 # TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
 # SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
 from datetime import datetime
 from django.db import models
 class ModificationTimestampField(models.DateTimeField):
     """
     A subclass of DateTimeField that only auto-updates the timestamp when
     updating an existing object or when the value of the field is None. This
     specialized field is equivalent to DateTimeField's auto_now=True, except
     it allows for custom timestamp values (needed for
     serialization/deserialization).
     """
     def __init__(self, verbose_name=None, name=None, **kwargs):
         kwargs.update({
             'editable': False,
             'blank': True,
         })
         models.DateTimeField.__init__(self, verbose_name, name, **kwargs)
     def pre_save(self, model, add):
         if not add or getattr(model, self.attname) is None:
             value = datetime.now()
             setattr(model, self.attname, value)
             return value
         return super(ModificationTimestampField, self).pre_save(model, add)
     def get_internal_type(self):
         return "DateTimeField"

+#
 # tests.py -- Unit tests for classes in djblets.util
+#
 # Copyright (c) 2007-2008  Christian Hammond
 # Copyright (c) 2007-2008  David Trowbridge
+#
 # Permission is hereby granted, free of charge, to any person obtaining
 # a copy of this software and associated documentation files (the
 # "Software"), to deal in the Software without restriction, including
 # without limitation the rights to use, copy, modify, merge, publish,
 # distribute, sublicense, and/or sell copies of the Software, and to
 # permit persons to whom the Software is furnished to do so, subject to
 # the following conditions:
+#
 # The above copyright notice and this permission notice shall be included
 # in all copies or substantial portions of the Software.
+#
 # THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
 # EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
 # MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
 # IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
 # CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
 # TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
 # SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
 import datetime
 import unittest
 from django.conf import settings
 from django.template import Token, TOKEN_TEXT, TemplateSyntaxError
 from django.utils.html import strip_spaces_between_tags
 from djblets.util.testing import TestCase, TagTest
 from djblets.util.templatetags import djblets_deco
 from djblets.util.templatetags import djblets_email
 from djblets.util.templatetags import djblets_utils
 def normalize_html(s):
     return strip_spaces_between_tags(s).strip()
 class BoxTest(TagTest):
     def testPlain(self):
         """Testing box tag"""
         node = djblets_deco.box(self.parser, Token(TOKEN_TEXT, 'box'))
         context = {}
         self.assertEqual(normalize_html(node.render(context)),
                          '<div class="box-container"><div class="box">' +
                          '<div class="box-inner">\ncontent\n  ' +
                          '</div></div></div>')
     def testClass(self):
         """Testing box tag (with extra class)"""
         node = djblets_deco.box(self.parser, Token(TOKEN_TEXT, 'box "class"'))
         context = {}
         self.assertEqual(normalize_html(node.render(context)),
                          '<div class="box-container"><div class="box class">' +
                          '<div class="box-inner">\ncontent\n  ' +
                          '</div></div></div>')
     def testError(self):
         """Testing box tag (invalid usage)"""
         self.assertRaises(TemplateSyntaxError,
                           lambda: djblets_deco.box(self.parser,
                                                    Token(TOKEN_TEXT,
                                                          'box "class" "foo"')))
 class ErrorBoxTest(TagTest):
     def testPlain(self):
         """Testing errorbox tag"""
         node = djblets_deco.errorbox(self.parser,
                                      Token(TOKEN_TEXT, 'errorbox'))
         context = {}
         self.assertEqual(normalize_html(node.render(context)),
                          '<div class="errorbox">\ncontent\n</div>')
     def testId(self):
         """Testing errorbox tag (with id)"""
         node = djblets_deco.errorbox(self.parser,
                                      Token(TOKEN_TEXT, 'errorbox "id"'))
         context = {}
         self.assertEqual(normalize_html(node.render(context)),
                          '<div class="errorbox" id="id">\ncontent\n</div>')
     def testError(self):
         """Testing errorbox tag (invalid usage)"""
         self.assertRaises(TemplateSyntaxError,
                           lambda: djblets_deco.errorbox(self.parser,
                                                         Token(TOKEN_TEXT,
                                                               'errorbox "id" ' +
                                                               '"foo"')))
 class AgeIdTest(TagTest):
     def setUp(self):
         TagTest.setUp(self)
         self.now = datetime.datetime.now()
         self.context = {
             'now':    self.now,
             'minus1': self.now - datetime.timedelta(1),
             'minus2': self.now - datetime.timedelta(2),
             'minus3': self.now - datetime.timedelta(3),
             'minus4': self.now - datetime.timedelta(4),
+        }
     def testNow(self):
         """Testing ageid tag (now)"""
         self.assertEqual(djblets_utils.ageid(self.now), 'age1')
     def testMinus1(self):
         """Testing ageid tag (yesterday)"""
         self.assertEqual(djblets_utils.ageid(self.now - datetime.timedelta(1)),
                          'age2')
     def testMinus2(self):
         """Testing ageid tag (two days ago)"""
         self.assertEqual(djblets_utils.ageid(self.now - datetime.timedelta(2)),
                          'age3')
     def testMinus3(self):
         """Testing ageid tag (three days ago)"""
         self.assertEqual(djblets_utils.ageid(self.now - datetime.timedelta(3)),
                          'age4')
     def testMinus4(self):
         """Testing ageid tag (four days ago)"""
         self.assertEqual(djblets_utils.ageid(self.now - datetime.timedelta(4)),
                          'age5')
     def testNotDateTime(self):
         """Testing ageid tag (non-datetime object)"""
         class Foo:
             def __init__(self, now):
                 self.day   = now.day
                 self.month = now.month
                 self.year  = now.year
         self.assertEqual(djblets_utils.ageid(Foo(self.now)), 'age1')
 class TestEscapeSpaces(unittest.TestCase):
     def test(self):
         """Testing escapespaces filter"""
         self.assertEqual(djblets_utils.escapespaces('Hi there'),
                          'Hi there')
         self.assertEqual(djblets_utils.escapespaces('Hi  there'),
                          'Hi&nbsp; there')
         self.assertEqual(djblets_utils.escapespaces('Hi  there\n'),
                          'Hi&nbsp; there<br />')
 class TestHumanizeList(unittest.TestCase):
     def test0(self):
         """Testing humanize_list filter (length 0)"""
         self.assertEqual(djblets_utils.humanize_list([]), '')
     def test1(self):
         """Testing humanize_list filter (length 1)"""
         self.assertEqual(djblets_utils.humanize_list(['a']), 'a')
     def test2(self):
         """Testing humanize_list filter (length 2)"""
         self.assertEqual(djblets_utils.humanize_list(['a', 'b']), 'a and b')
     def test3(self):
         """Testing humanize_list filter (length 3)"""
         self.assertEqual(djblets_utils.humanize_list(['a', 'b', 'c']),
                          'a, b and c')
     def test4(self):
         """Testing humanize_list filter (length 4)"""
         self.assertEqual(djblets_utils.humanize_list(['a', 'b', 'c', 'd']),
                          'a, b, c, and d')
 class TestIndent(unittest.TestCase):
     def test(self):
         """Testing indent filter"""
         self.assertEqual(djblets_utils.indent('foo'), '    foo')
         self.assertEqual(djblets_utils.indent('foo', 3), '   foo')
         self.assertEqual(djblets_utils.indent('foo\nbar'), '    foo\n    bar')
 class QuotedEmailTagTest(TagTest):
     def testInvalid(self):
         """Testing quoted_email tag (invalid usage)"""
         self.assertRaises(TemplateSyntaxError,
                           lambda: djblets_email.quoted_email(self.parser,
                               Token(TOKEN_TEXT, 'quoted_email')))
 class CondenseTagTest(TagTest):
     def getContentText(self):
         return "foo\nbar\n\n\n\n\n\n\nfoobar!"
     def testPlain(self):
         """Testing condense tag"""
         node = djblets_email.condense(self.parser,
                                       Token(TOKEN_TEXT, 'condense'))
         self.assertEqual(node.render({}), "foo\nbar\n\n\nfoobar!")
 class QuoteTextFilterTest(unittest.TestCase):
     def testPlain(self):
         """Testing quote_text filter (default level)"""
         self.assertEqual(djblets_email.quote_text("foo\nbar"),
                          "> foo\n> bar")
     def testLevel2(self):
         """Testing quote_text filter (level 2)"""
         self.assertEqual(djblets_email.quote_text("foo\nbar", 2),
                          "> > foo\n> > bar")

+#
 # djblets_deco.py -- Decorational template tags
+#
 # Copyright (c) 2007-2008  Christian Hammond
 # Copyright (c) 2007-2008  David Trowbridge
+#
 # Permission is hereby granted, free of charge, to any person obtaining
 # a copy of this software and associated documentation files (the
 # "Software"), to deal in the Software without restriction, including
 # without limitation the rights to use, copy, modify, merge, publish,
 # distribute, sublicense, and/or sell copies of the Software, and to
 # permit persons to whom the Software is furnished to do so, subject to
 # the following conditions:
+#
 # The above copyright notice and this permission notice shall be included
 # in all copies or substantial portions of the Software.
+#
 # THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
 # EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
 # MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
 # IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
 # CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
 # TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
 # SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
 from django import template
 from django.template.loader import render_to_string
 from djblets.util.decorators import blocktag
 register = template.Library()
 @register.tag
 @blocktag
 def box(context, nodelist, classname=None):
     """
     Displays a box container around content, with an optional class name.
     """
     return render_to_string('box.html', {
         'classname': classname or "",
         'content': nodelist.render(context)
     })
 @register.tag
 @blocktag
 def errorbox(context, nodelist, box_id=None):
     """
     Displays an error box around content, with an optional ID.
     """
     return render_to_string('errorbox.html', {
         'box_id': box_id or "",
         'content': nodelist.render(context)
     })

+#
 # djblets_email.py -- E-mail formatting template tags
+#
 # Copyright (c) 2007-2008  Christian Hammond
 # Copyright (c) 2007-2008  David Trowbridge
+#
 # Permission is hereby granted, free of charge, to any person obtaining
 # a copy of this software and associated documentation files (the
 # "Software"), to deal in the Software without restriction, including
 # without limitation the rights to use, copy, modify, merge, publish,
 # distribute, sublicense, and/or sell copies of the Software, and to
 # permit persons to whom the Software is furnished to do so, subject to
 # the following conditions:
+#
 # The above copyright notice and this permission notice shall be included
 # in all copies or substantial portions of the Software.
+#
 # THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
 # EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
 # MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
 # IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
 # CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
 # TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
 # SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
 import re
 from django import template
 from django.template.loader import render_to_string
 from djblets.util.decorators import basictag, blocktag
 from djblets.util.templatetags.djblets_utils import humanize_list
 register = template.Library()
 @register.tag
 @basictag(takes_context=True)
 def quoted_email(context, template_name):
     """
     Renders a specified template as a quoted reply, using the current context.
     """
     return quote_text(render_to_string(template_name, context))
 @register.tag
 @blocktag
 def condense(context, nodelist):
     """
     Condenses a block of text so that there are never more than three
     consecutive newlines.
     """
     text = nodelist.render(context).strip()
     text = re.sub("\n{4,}", "\n\n\n", text)
     return text
 @register.filter
 def quote_text(text, level=1):
     """
     Quotes a block of text the specified number of times.
     """
     lines = text.split("\n")
     quoted = ""
     for line in lines:
         quoted += "%s%s\n" % ("> " * level, line)
     return quoted.rstrip()

+#
 # djblets_images.py -- Image-related template tags
+#
 # Copyright (c) 2007-2008  Christian Hammond
 # Copyright (c) 2007-2008  David Trowbridge
+#
 # Permission is hereby granted, free of charge, to any person obtaining
 # a copy of this software and associated documentation files (the
 # "Software"), to deal in the Software without restriction, including
 # without limitation the rights to use, copy, modify, merge, publish,
 # distribute, sublicense, and/or sell copies of the Software, and to
 # permit persons to whom the Software is furnished to do so, subject to
 # the following conditions:
+#
 # The above copyright notice and this permission notice shall be included
 # in all copies or substantial portions of the Software.
+#
 # THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
 # EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
 # MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
 # IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
 # CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
 # TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
 # SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
 import Image
 import os
 from django import template
 from django.conf import settings
 register = template.Library()
 @register.simple_tag
 def crop_image(file, x, y, width, height):
     """
     Crops an image at the specified coordinates and dimensions, returning the
     resulting URL of the cropped image.
     """
     if file.find(".") != -1:
         basename, format = file.rsplit('.', 1)
         new_name = '%s_%s_%s_%s_%s.%s' % (basename, x, y, width, height, format)
     else:
         basename = file
         new_name = '%s_%s_%s_%s_%s' % (basename, x, y, width, height)
     new_path = os.path.join(settings.MEDIA_ROOT, new_name)
     new_url = os.path.join(settings.MEDIA_URL, new_name)
     if not os.path.exists(new_path):
         try:
             image = Image.open(os.path.join(settings.MEDIA_ROOT, file))
             image = image.crop((x, y, x + width, y + height))
             image.save(new_path, image.format)
         except (IOError, KeyError):
             return ""
     return new_url
 # From http://www.djangosnippets.org/snippets/192
 @register.filter
 def thumbnail(file, size='400x100'):
     """
     Creates a thumbnail of an image with the specified size, returning
     the URL of the thumbnail.
     """
     x, y = [int(x) for x in size.split('x')]
     if file.find(".") != -1:
         basename, format = file.rsplit('.', 1)
         miniature = '%s_%s.%s' % (basename, size, format)
     else:
         basename = file
         miniature = '%s_%s' % (basename, size)
     miniature_filename = os.path.join(settings.MEDIA_ROOT, miniature)
     miniature_url = os.path.join(settings.MEDIA_URL, miniature)
     if not os.path.exists(miniature_filename):
         try:
             image = Image.open(os.path.join(settings.MEDIA_ROOT, file))
             image.thumbnail([x, y], Image.ANTIALIAS)
             image.save(miniature_filename, image.format)
         except IOError:
             return ""
         except KeyError:
             return ""
     return miniature_url

+#
 # djblets_js.py -- JavaScript-related template tags
+#
 # Copyright (c) 2007-2008  Christian Hammond
 # Copyright (c) 2007-2008  David Trowbridge
+#
 # Permission is hereby granted, free of charge, to any person obtaining
 # a copy of this software and associated documentation files (the
 # "Software"), to deal in the Software without restriction, including
 # without limitation the rights to use, copy, modify, merge, publish,
 # distribute, sublicense, and/or sell copies of the Software, and to
 # permit persons to whom the Software is furnished to do so, subject to
 # the following conditions:
+#
 # The above copyright notice and this permission notice shall be included
 # in all copies or substantial portions of the Software.
+#
 # THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,

Review Board

beta

This change has been marked as submitted.

Move reviewboard.utils and emailtags into Djblets

Diff revision 2 (Latest)