EbookFoundation
/
readthedocs.org
mirror of https://github.com/EbookFoundation/readthedocs.org.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Adding rudimentary revisioning for files

rtd2
Charles Leifer 2010-08-14 11:57:58 -05:00
parent 232173bca7
commit 573b41ab6e
6 changed files with 2062 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

15
projects/forms.py
View File

@ -10,6 +10,21 @@ class ProjectForm(forms.ModelForm):
class FileForm(forms.ModelForm):
revision_comment = forms.CharField(max_length=255)
class Meta:
model = File
exclude = ('project', 'slug')
def save(self, *args, **kwargs):
# grab the old content before saving
old_content = self.initial.get('content', '')
# save the file object
file_obj = super(FileForm, self).save(*args, **kwargs)
# create a new revision from the old content -> new
file_obj.create_revision(
old_content,
self.cleaned_data.get('revision_comment', '')
)

0
projects/libs/__init__.py Normal file
View File

1845
projects/libs/diff_match_patch.py Normal file
View File

File diff suppressed because it is too large Load Diff

109
projects/migrations/0006_add_revision_model.py Normal file
View File

@ -0,0 +1,109 @@
# encoding: utf-8
import datetime
from south.db import db
from south.v2 import SchemaMigration
from django.db import models
class Migration(SchemaMigration):
def forwards(self, orm):
# Adding model 'FileRevision'
db.create_table('projects_filerevision', (
('id', self.gf('django.db.models.fields.AutoField')(primary_key=True)),
('file', self.gf('django.db.models.fields.related.ForeignKey')(related_name='revisions', to=orm['projects.File'])),
('comment', self.gf('django.db.models.fields.TextField')(blank=True)),
('diff', self.gf('django.db.models.fields.TextField')(blank=True)),
('revision_number', self.gf('django.db.models.fields.IntegerField')()),
('is_reverted', self.gf('django.db.models.fields.BooleanField')(default=False)),
))
db.send_create_signal('projects', ['FileRevision'])
def backwards(self, orm):
# Deleting model 'FileRevision'
db.delete_table('projects_filerevision')
models = {
'auth.group': {
'Meta': {'object_name': 'Group'},
'id': ('django.db.models.fields.AutoField', [], {'primary_key': 'True'}),
'name': ('django.db.models.fields.CharField', [], {'unique': 'True', 'max_length': '80'}),
'permissions': ('django.db.models.fields.related.ManyToManyField', [], {'to': "orm['auth.Permission']", 'symmetrical': 'False', 'blank': 'True'})
},
'auth.permission': {
'Meta': {'ordering': "('content_type__app_label', 'content_type__model', 'codename')", 'unique_together': "(('content_type', 'codename'),)", 'object_name': 'Permission'},
'codename': ('django.db.models.fields.CharField', [], {'max_length': '100'}),
'content_type': ('django.db.models.fields.related.ForeignKey', [], {'to': "orm['contenttypes.ContentType']"}),
'id': ('django.db.models.fields.AutoField', [], {'primary_key': 'True'}),
'name': ('django.db.models.fields.CharField', [], {'max_length': '50'})
},
'auth.user': {
'Meta': {'object_name': 'User'},
'date_joined': ('django.db.models.fields.DateTimeField', [], {'default': 'datetime.datetime.now'}),
'email': ('django.db.models.fields.EmailField', [], {'max_length': '75', 'blank': 'True'}),
'first_name': ('django.db.models.fields.CharField', [], {'max_length': '30', 'blank': 'True'}),
'groups': ('django.db.models.fields.related.ManyToManyField', [], {'to': "orm['auth.Group']", 'symmetrical': 'False', 'blank': 'True'}),
'id': ('django.db.models.fields.AutoField', [], {'primary_key': 'True'}),
'is_active': ('django.db.models.fields.BooleanField', [], {'default': 'True'}),
'is_staff': ('django.db.models.fields.BooleanField', [], {'default': 'False'}),
'is_superuser': ('django.db.models.fields.BooleanField', [], {'default': 'False'}),
'last_login': ('django.db.models.fields.DateTimeField', [], {'default': 'datetime.datetime.now'}),
'last_name': ('django.db.models.fields.CharField', [], {'max_length': '30', 'blank': 'True'}),
'password': ('django.db.models.fields.CharField', [], {'max_length': '128'}),
'user_permissions': ('django.db.models.fields.related.ManyToManyField', [], {'to': "orm['auth.Permission']", 'symmetrical': 'False', 'blank': 'True'}),
'username': ('django.db.models.fields.CharField', [], {'unique': 'True', 'max_length': '30'})
},
'contenttypes.contenttype': {
'Meta': {'ordering': "('name',)", 'unique_together': "(('app_label', 'model'),)", 'object_name': 'ContentType', 'db_table': "'django_content_type'"},
'app_label': ('django.db.models.fields.CharField', [], {'max_length': '100'}),
'id': ('django.db.models.fields.AutoField', [], {'primary_key': 'True'}),
'model': ('django.db.models.fields.CharField', [], {'max_length': '100'}),
'name': ('django.db.models.fields.CharField', [], {'max_length': '100'})
},
'projects.conf': {
'Meta': {'object_name': 'Conf'},
'copyright': ('django.db.models.fields.CharField', [], {'max_length': '255', 'blank': 'True'}),
'id': ('django.db.models.fields.AutoField', [], {'primary_key': 'True'}),
'path': ('django.db.models.fields.CharField', [], {'max_length': '255', 'null': 'True'}),
'project': ('django.db.models.fields.related.OneToOneField', [], {'related_name': "'conf'", 'unique': 'True', 'to': "orm['projects.Project']"}),
'theme': ('django.db.models.fields.CharField', [], {'default': "'default'", 'max_length': '20'})
},
'projects.file': {
'Meta': {'ordering': "('ordering', 'denormalized_path')", 'object_name': 'File'},
'content': ('django.db.models.fields.TextField', [], {}),
'denormalized_path': ('django.db.models.fields.CharField', [], {'max_length': '255'}),
'heading': ('django.db.models.fields.CharField', [], {'max_length': '255'}),
'id': ('django.db.models.fields.AutoField', [], {'primary_key': 'True'}),
'ordering': ('django.db.models.fields.PositiveSmallIntegerField', [], {'default': '1'}),
'parent': ('django.db.models.fields.related.ForeignKey', [], {'blank': 'True', 'related_name': "'children'", 'null': 'True', 'to': "orm['projects.File']"}),
'project': ('django.db.models.fields.related.ForeignKey', [], {'related_name': "'files'", 'to': "orm['projects.Project']"}),
'slug': ('django.db.models.fields.SlugField', [], {'max_length': '50', 'db_index': 'True'})
},
'projects.filerevision': {
'Meta': {'ordering': "('-revision_number',)", 'object_name': 'FileRevision'},
'comment': ('django.db.models.fields.TextField', [], {'blank': 'True'}),
'diff': ('django.db.models.fields.TextField', [], {'blank': 'True'}),
'file': ('django.db.models.fields.related.ForeignKey', [], {'related_name': "'revisions'", 'to': "orm['projects.File']"}),
'id': ('django.db.models.fields.AutoField', [], {'primary_key': 'True'}),
'is_reverted': ('django.db.models.fields.BooleanField', [], {'default': 'False'}),
'revision_number': ('django.db.models.fields.IntegerField', [], {})
},
'projects.project': {
'Meta': {'ordering': "('-modified_date', 'name')", 'object_name': 'Project'},
'description': ('django.db.models.fields.TextField', [], {'blank': 'True'}),
'docs_directory': ('django.db.models.fields.CharField', [], {'max_length': '255', 'blank': 'True'}),
'github_login': ('django.db.models.fields.CharField', [], {'max_length': '100', 'blank': 'True'}),
'github_repo': ('django.db.models.fields.CharField', [], {'max_length': '100', 'blank': 'True'}),
'id': ('django.db.models.fields.AutoField', [], {'primary_key': 'True'}),
'modified_date': ('django.db.models.fields.DateTimeField', [], {'auto_now': 'True', 'blank': 'True'}),
'name': ('django.db.models.fields.CharField', [], {'max_length': '255'}),
'pub_date': ('django.db.models.fields.DateTimeField', [], {'auto_now_add': 'True', 'blank': 'True'}),
'slug': ('django.db.models.fields.SlugField', [], {'max_length': '50', 'db_index': 'True'}),
'user': ('django.db.models.fields.related.ForeignKey', [], {'related_name': "'projects'", 'to': "orm['auth.User']"})
}
}
complete_apps = ['projects']

84
projects/models.py
View File

@ -7,6 +7,7 @@ from django.template.loader import render_to_string
from django.utils.functional import memoize
from projects.constants import DEFAULT_THEME_CHOICES, THEME_DEFAULT
from projects.utils import diff, dmp
from taggit.managers import TaggableManager
@ -56,14 +57,16 @@ class Project(models.Model):
matches.append(os.path.join(root, filename))
print "finding %s" % file
return matches
find = memoize(find, {}, 2)
find = memoize(find, {}, 2)
def save(self, *args, **kwargs):
if not self.slug:
self.slug = slugify(self.name)
super(Project, self).save(*args, **kwargs)
if not self.conf:
try:
conf = self.conf
except Conf.DoesNotExist:
Conf.objects.create(project=self)
@property
@ -129,3 +132,80 @@ class File(models.Model):
child.save()
update_children(child.children.all())
update_children(self.children.all())
def create_revision(self, old_content, comment):
FileRevision.objects.create(
file=self,
comment=comment,
diff=diff(self.content, old_content)
)
@property
def current_revision(self):
return self.revisions.filter(is_reverted=False)[0]
def get_html_diff(self, rev_from, rev_to):
rev_from = self.revisions.get(revision_number=rev_from)
rev_to = self.revisions.get(revision_number=rev_to)
diffs = dmp.diff_main(rev_from.diff, rev_to.diff)
return dmp.diff_prettyHtml(diffs)
def revert_to(self, revision_number):
revision = self.revisions.get(revision_number=revision_number)
revision.apply()
class FileRevision(models.Model):
file = models.ForeignKey(File, related_name='revisions')
comment = models.TextField(blank=True)
diff = models.TextField(blank=True)
revision_number = models.IntegerField()
is_reverted = models.BooleanField(default=False)
class Meta:
ordering = ('-revision_number',)
def __unicode__(self):
return '%s #%s' % (self.file.heading, self.revision_number)
def get_file_content(self):
"""
Apply the series of diffs after this revision in reverse order,
bringing the content back to the state it was in this revision
"""
after = self.file.revisions.filter(revision__gt=self.revision_number)
content = self.file.content
for revision in after:
patch = dmp.patch_fromText(revision.diff)
content = dmp.patch_apply(patch, content)[0]
return content
def apply(self):
original_content = self.file.content
# store the old content on the file
self.file.content = self.get_file_content()
self.file.save()
# mark reverted changesets
reverted_qs = self.file.revisions.filter(revision__gt=self.revision)
reverted_qs.update(is_reverted=True)
# create a new revision
FileRevision.objects.create(
file=self.file,
comment='Reverted to #%s' % self.revision,
diff=diff(self.file.content, original_content)
)
def save(self, *args, **kwargs):
if not self.pk:
try:
self.revision_number = self.file.current_revision.revision_number + 1
except IndexError:
self.revision_number = 1
super(FileRevision, self).save(*args, **kwargs)

12
projects/utils.py
View File

@ -1,7 +1,10 @@
import commands
import os
import fnmatch
from django.conf import settings
import commands
from projects.libs.diff_match_patch import diff_match_patch
def find_file(file):
matches = []
@ -19,3 +22,10 @@ def run(command):
ret = p.returncode
return (ret, out, err)
"""
dmp = diff_match_patch()
def diff(txt1, txt2):
"""Create a 'diff' from txt1 to txt2."""
patch = dmp.patch_make(txt1, txt2)
return dmp.patch_toText(patch)