cms.toolbar.base: 60 total statements, 0.0% covered

Generated: Wed 2013-03-13 10:33 CET

Source file: /media/Envs/Envs/filer-gallery/lib/python2.7/site-packages/cms/toolbar/base.py

Stats: 0 executed, 54 missed, 6 excluded, 64 ignored

1. # -*- coding: utf-8 -*-
2. from cms.toolbar.constants import ALIGNMENTS
3. from django.conf import settings
4. from django.core.exceptions import ImproperlyConfigured
5. from django.utils import simplejson
6. from django.utils.encoding import force_unicode
7. from django.utils.functional import Promise
10. class Serializable(object):
11. """
12. Base class for objects used in the toolbar. Abstracts the serialization and
13. conversion to JSON.
14. """
15. # attributes that this type and all subclasses of this type should serialize
16. base_attributes = []
17. # additional attributes to serialize only on this type
18. extra_attributes = []
20. def as_json(self, context, **kwargs):
21. """
22. Converts the (serialized) data to JSON
23. """
24. data = self.serialize(context, **kwargs)
25. return simplejson.dumps(data)
27. def serialize(self, context, **kwargs):
28. """
29. Serializes it's data. Uses self.base_attributes, self.extra_attributes
30. and self.get_extra_data to
31. """
32. data = {}
33. for python, javascript in self.base_attributes:
34. self._populate(data, python, javascript, context, **kwargs)
35. for python, javascript in self.extra_attributes:
36. self._populate(data, python, javascript, context, **kwargs)
37. data.update(self.get_extra_data(context, **kwargs))
38. return data
40. def _populate(self, container, python, javascript, context, **kwargs):
41. """
42. Populates the *container* using the key *javascript* by accessing the
43. attribute *python* on *self* (or serialize_*python* if that's a callable
44. on *self*).
45. """
46. if hasattr(self, 'serialize_%s' % python):
47. meth = getattr(self, 'serialize_%s' % python)
48. value = meth(context, **kwargs)
49. else:
50. value = getattr(self, python)
51. if isinstance(value, Promise):
52. value = force_unicode(value)
53. container[javascript] = value
55. def get_extra_data(self, context, **kwargs):
56. """
57. Hook for subclasses to add more data.
58. """
59. return {}
62. class Toolbar(Serializable):
63. """
64. A base toolbar, implements the request_hook API and the get_items API.
65. """
66. def __init__(self, request):
67. self.request = request
69. def get_items(self, context, **kwargs):
70. return []
72. def get_extra_data(self, context, **kwargs):
73. raw_items = self.get_items(context, **kwargs)
74. items = []
75. for item in raw_items:
76. items.append(item.serialize(context, toolbar=self, **kwargs))
77. return {
78. 'debug': settings.TEMPLATE_DEBUG,
79. 'items': items,
80. }
82. def request_hook(self):
83. """
84. May return a HttpResponse instance
85. """
86. return None
89. class BaseItem(Serializable):
90. """
91. Base class for toolbar items, has default attributes common to all items.
92. """
93. base_attributes = [
94. ('order', 'order'), # automatically set
95. ('alignment', 'dir'),
96. ('item_type', 'type'),
97. ('css_class', 'cls'),
98. ]
99. extra_attributes = []
100. alignment = 'left'
103. def __init__(self, alignment, css_class_suffix):
104. """
105. alignment: either cms.toolbar.constants.LEFT or
106. cms.toolbar.constants.RIGHT
107. css_class_suffix: suffix for the cms class to put on this item, prefix
108. is always 'cms_toolbar-item'
109. """
110. if alignment not in ALIGNMENTS:
111. raise ImproperlyConfigured("Item alignment %r is not valid, must "
112. "either cms.toolbar.base.LEFT or "
113. "cms.toolbar.base.RIGHT" % alignment)
114. self.alignment = alignment
115. self.css_class_suffix = css_class_suffix
116. self.css_class = 'cms_toolbar-item_%s' % self.css_class_suffix
118. def serialize(self, context, toolbar, **kwargs):
119. counter_attr = 'counter_%s' % self.alignment
120. current = getattr(toolbar, counter_attr, 0)
121. this = current + 1
122. self.order = this * 10
123. setattr(toolbar, counter_attr, this)
124. return super(BaseItem, self).serialize(context, toolbar=toolbar, **kwargs)