style
[redakcja.git] / apps / dvcs / models.py
index eba2c38..662a645 100644 (file)
@@ -1,9 +1,9 @@
+# -*- coding: utf-8 -*-
 from datetime import datetime
 import os.path
 
 from django.contrib.auth.models import User
 from django.core.files.base import ContentFile
-from django.core.files.storage import FileSystemStorage
 from django.db import models, transaction
 from django.db.models.base import ModelBase
 from django.utils.translation import ugettext_lazy as _
@@ -17,8 +17,7 @@ from dvcs.storage import GzipFileSystemStorage
 class Tag(models.Model):
     """A tag (e.g. document stage) which can be applied to a Change."""
     name = models.CharField(_('name'), max_length=64)
-    slug = models.SlugField(_('slug'), unique=True, max_length=64, 
-            null=True, blank=True)
+    slug = models.SlugField(_('slug'), unique=True, max_length=64, null=True, blank=True)
     ordering = models.IntegerField(_('ordering'))
 
     _object_cache = {}
@@ -61,38 +60,39 @@ models.signals.pre_save.connect(Tag.listener_changed, sender=Tag)
 def data_upload_to(instance, filename):
     return "%d/%d" % (instance.tree.pk, instance.pk)
 
+
 class Change(models.Model):
     """
         Single document change related to previous change. The "parent"
-        argument points to the version against which this change has been 
+        argument points to the version against which this change has been
         recorded. Initial text will have a null parent.
-        
+
         Data file contains a gzipped text of the document.
     """
     author = models.ForeignKey(User, null=True, blank=True, verbose_name=_('author'))
-    author_name = models.CharField(_('author name'), max_length=128,
-                        null=True, blank=True,
-                        help_text=_("Used if author is not set.")
-                        )
-    author_email = models.CharField(_('author email'), max_length=128,
-                        null=True, blank=True,
-                        help_text=_("Used if author is not set.")
-                        )
+    author_name = models.CharField(
+        _('author name'), max_length=128,
+        null=True, blank=True,
+        help_text=_("Used if author is not set."))
+    author_email = models.CharField(
+        _('author email'), max_length=128,
+        null=True, blank=True,
+        help_text=_("Used if author is not set."))
     revision = models.IntegerField(_('revision'), db_index=True)
 
-    parent = models.ForeignKey('self',
-                        null=True, blank=True, default=None,
-                        verbose_name=_('parent'),
-                        related_name="children")
+    parent = models.ForeignKey(
+        'self',
+        null=True, blank=True, default=None,
+        verbose_name=_('parent'), related_name="children")
 
-    merge_parent = models.ForeignKey('self',
-                        null=True, blank=True, default=None,
-                        verbose_name=_('merge parent'),
-                        related_name="merge_children")
+    merge_parent = models.ForeignKey(
+        'self',
+        null=True, blank=True, default=None,
+        verbose_name=_('merge parent'),
+        related_name="merge_children")
 
     description = models.TextField(_('description'), blank=True, default='')
-    created_at = models.DateTimeField(editable=False, db_index=True, 
-                        default=datetime.now)
+    created_at = models.DateTimeField(editable=False, db_index=True, default=datetime.now)
     publishable = models.BooleanField(_('publishable'), default=False)
 
     class Meta:
@@ -109,7 +109,7 @@ class Change(models.Model):
         if self.author:
             return "%s %s <%s>" % (
                 self.author.first_name,
-                self.author.last_name, 
+                self.author.last_name,
                 self.author.email)
         else:
             return "%s <%s>" % (
@@ -117,7 +117,6 @@ class Change(models.Model):
                 self.author_email
                 )
 
-
     def save(self, *args, **kwargs):
         """
             take the next available revision number if none yet
@@ -136,9 +135,7 @@ class Change(models.Model):
         f.close()
         return unicode(text, 'utf-8')
 
-    def merge_with(self, other, author=None, 
-            author_name=None, author_email=None, 
-            description=u"Automatic merge."):
+    def merge_with(self, other, author=None, author_name=None, author_email=None, description=u"Automatic merge."):
         """Performs an automatic merge after straying commits."""
         assert self.tree_id == other.tree_id  # same tree
         if other.parent_id == self.pk:
@@ -205,26 +202,29 @@ def create_change_model(model):
 
 
 class DocumentMeta(ModelBase):
-    "Metaclass for Document models."
-    def __new__(cls, name, bases, attrs):
+    """Metaclass for Document models."""
+    def __new__(mcs, name, bases, attrs):
 
-        model = super(DocumentMeta, cls).__new__(cls, name, bases, attrs)
+        model = super(DocumentMeta, mcs).__new__(mcs, name, bases, attrs)
         if not model._meta.abstract:
             # create a real Tag object and `stage' fk
             model.tag_model = create_tag_model(model)
-            models.ForeignKey(model.tag_model, verbose_name=_('stage'),
+            models.ForeignKey(
+                model.tag_model, verbose_name=_('stage'),
                 null=True, blank=True).contribute_to_class(model, 'stage')
 
             # create real Change model and `head' fk
             model.change_model = create_change_model(model)
 
-            models.ForeignKey(model.change_model,
-                    null=True, blank=True, default=None,
-                    verbose_name=_('head'), 
-                    help_text=_("This document's current head."),
-                    editable=False).contribute_to_class(model, 'head')
+            models.ForeignKey(
+                model.change_model,
+                null=True, blank=True, default=None,
+                verbose_name=_('head'),
+                help_text=_("This document's current head."),
+                editable=False).contribute_to_class(model, 'head')
 
-            models.ForeignKey(User, null=True, blank=True, editable=False,
+            models.ForeignKey(
+                User, null=True, blank=True, editable=False,
                 verbose_name=_('creator'), related_name="created_%s" % name.lower()
                 ).contribute_to_class(model, 'creator')
 
@@ -239,7 +239,8 @@ class Document(models.Model):
     # default repository path
     REPO_PATH = os.path.join(settings.MEDIA_ROOT, 'dvcs')
 
-    user = models.ForeignKey(User, null=True, blank=True,
+    user = models.ForeignKey(
+        User, null=True, blank=True,
         verbose_name=_('user'), help_text=_('Work assignment.'))
 
     class Meta:
@@ -257,8 +258,7 @@ class Document(models.Model):
             change = self.change_set.get(pk=change)
         return change.materialize()
 
-    def commit(self, text, author=None, author_name=None, author_email=None,
-            publishable=False, **kwargs):
+    def commit(self, text, author=None, author_name=None, author_email=None, publishable=False, **kwargs):
         """Commits a new revision.
 
         This will automatically merge the commit into the main branch,
@@ -286,12 +286,13 @@ class Document(models.Model):
             # set stage to next tag after the commited one
             self.stage = max(tags, key=lambda t: t.ordering).get_next()
 
-        change = self.change_set.create(author=author,
-                    author_name=author_name,
-                    author_email=author_email,
-                    description=kwargs.get('description', ''),
-                    publishable=publishable,
-                    parent=parent)
+        change = self.change_set.create(
+            author=author,
+            author_name=author_name,
+            author_email=author_email,
+            description=kwargs.get('description', ''),
+            publishable=publishable,
+            parent=parent)
 
         change.tags = tags
         change.data.save('', ContentFile(text.encode('utf-8')))
@@ -299,9 +300,10 @@ class Document(models.Model):
 
         if self.head:
             # merge new change as new head
-            self.head = self.head.merge_with(change, author=author,
-                    author_name=author_name,
-                    author_email=author_email)
+            self.head = self.head.merge_with(
+                change, author=author,
+                author_name=author_name,
+                author_email=author_email)
         else:
             self.head = change
         self.save()