document_library.models: 55 total statements, 97.7% covered

Generated: Sat 2013-02-23 20:08 SGT

Source file: /Users/martin/Repos/django-document-library/document_library/models.py

Stats: 43 executed, 1 missed, 11 excluded, 137 ignored

1. """Models for the ``document_library`` app."""
2. from django.conf import settings
3. from django.db import models
4. from django.utils.translation import get_language
5. from django.utils.translation import ugettext_lazy as _
7. from filer.fields.file import FilerFileField
8. from simple_translation.middleware import filter_queryset_language
9. from simple_translation.utils import get_preferred_translation_from_lang
12. class DocumentCategory(models.Model):
13. """
14. Documents can be grouped in categories.
16. See ``DocumentCategoryTitle`` for translateable fields.
18. :creation_date: The DateTime when this category was created.
20. """
21. creation_date = models.DateTimeField(
22. auto_now_add=True,
23. verbose_name=_('Creation date'),
24. )
26. slug = models.SlugField(
27. max_length=32,
28. verbose_name=_('Slug'),
29. )
31. def __unicode__(self):
32. return self.get_title()
34. def get_title(self):
35. lang = get_language()
36. return get_preferred_translation_from_lang(self, lang).title
39. class DocumentCategoryTitle(models.Model):
40. """
41. Translateable fields for the ``DocumentCategory`` model.
43. :title: The title of this category.
45. """
46. title = models.CharField(
47. max_length=256,
48. verbose_name=_('Title'),
49. )
51. # Needed by simple-translation
52. category = models.ForeignKey(
53. DocumentCategory, verbose_name=_('Category'))
55. language = models.CharField(
56. max_length=2, verbose_name=_('Language'), choices=settings.LANGUAGES)
59. class DocumentManager(models.Manager):
60. """Custom manager for the ``Document`` model."""
61. def published(self, request):
62. """
63. Returns the published documents in the current language.
65. :param request: A Request instance.
67. """
68. qs = self.get_query_set()
69. qs = qs.filter(is_published=True)
70. qs = filter_queryset_language(request, qs)
71. return qs
74. class Document(models.Model):
75. """
76. A document consists of a title and description and a number of filer-files.
78. See ``DocumentTitle`` for the translateable fields of this model.
80. :creation_date: DateTime when this document was created.
81. :user: Optional FK to the User who created this document.
82. :position: If you want to order the documents other than by creation date,
83. enter numbers for positioning here.
84. :is_published: If ``False`` the object will be excluded from the library
85. views.
86. :is_on_front_page: If ``True`` the object will be returned by the
87. ``get_frontpage_documents`` templatetag.
89. """
90. category = models.ForeignKey(
91. DocumentCategory,
92. verbose_name=_('Category'),
93. null=True, blank=True,
94. )
96. creation_date = models.DateTimeField(
97. auto_now_add=True,
98. verbose_name=_('Creation date'),
99. )
101. user = models.ForeignKey(
102. 'auth.User',
103. verbose_name=_('User'),
104. null=True, blank=True,
105. )
107. position = models.PositiveIntegerField(
108. verbose_name=_('Position'),
109. null=True, blank=True,
110. )
112. is_published = models.BooleanField(
113. default=False,
114. verbose_name=_('Is published'),
115. )
117. is_on_front_page = models.BooleanField(
118. default=False,
119. verbose_name=('Is on front page'),
120. )
122. source_url = models.URLField(
123. verbose_name=_('Source URL'),
124. help_text=_(
125. 'Use this if you want to give credit for a downloadable file.'),
126. blank=True,
127. )
129. download_url = models.URLField(
130. verbose_name=_('Download URL'),
131. help_text=_(
132. 'Use this if you want to link to a file instead of self-hosting'
133. ' it'),
134. blank=True,
135. )
137. objects = DocumentManager()
139. class Meta:
140. ordering = ('position', '-creation_date', )
142. def __unicode__(self):
143. return self.get_title()
145. def get_filetype(self):
146. lang = get_language()
147. title = get_preferred_translation_from_lang(self, lang)
148. if title.filer_file:
149. return title.filer_file.extension.upper()
150. return None
152. def get_title(self):
153. lang = get_language()
154. return get_preferred_translation_from_lang(self, lang).title
157. class DocumentTitle(models.Model):
158. """
159. The translateable fields of the ``Document`` model.
161. :title: The title of the document.
162. :description: A short description of the document.
163. :filer_file: FK to the File of the document version for this language.
165. """
166. title = models.CharField(
167. max_length=512,
168. verbose_name=_('Title'),
169. )
171. description = models.TextField(
172. verbose_name=_('Description'),
173. blank=True,
174. )
176. filer_file = FilerFileField(
177. verbose_name=_('File'),
178. null=True, blank=True,
179. )
181. copyright_notice = models.CharField(
182. max_length=1024,
183. verbose_name=_('Copyright notice'),
184. blank=True,
185. )
187. # Needed by simple-translation
188. document = models.ForeignKey(
189. Document, verbose_name=_('Document'))
191. language = models.CharField(
192. max_length=5, verbose_name=('Language'), choices=settings.LANGUAGES)