Tweaks and fixes

folk_rnn_site/archiver/dataset.py

@@ -3,7 +3,11 @@
 
 from archiver.models import Tune, Setting
 
-Datum = namedtuple('SettingDatum', [
+"""
+Datum is a superset of (what we want out of) a tune and setting
+e.g. the columns in a CSV of tunes and settings
+"""
+Datum = namedtuple('Datum', [
                             'tune_id',
                             'setting_id', 
                             'name', 
@@ -17,6 +21,9 @@
                             ])
 
 def tune_dataset():
+    """
+    Return a generator of Tune Data
+    """
     return (Datum(tune_id=x.id,
                 setting_id='',
                 name=x.title,
@@ -30,6 +37,9 @@ def tune_dataset():
             ) for x in Tune.objects.all())
 
 def setting_dataset():
+    """
+    Return a generator Setting Data
+    """
     return (Datum(tune_id=x.tune.id,
                         setting_id=x.id,
                         name=x.title,
@@ -43,6 +53,9 @@ def setting_dataset():
                     ) for x in Setting.objects.all())
 
 def dataset_as_csv(f):
+    """
+    Write tune and setting data in comma separated value format to the supplied file handle
+    """
     setting_writer = csv.writer(f)
     setting_writer.writerow(Datum._fields)
     setting_writer.writerows(tune_dataset())

folk_rnn_site/archiver/forms.py

@@ -6,58 +6,87 @@
 
 from folk_rnn_site.models import conform_abc
 from archiver import YEAR_CHOICES
-from archiver.models import User
+from archiver.models import User, Tune, TuneAttribution, Setting
 
-class AttributionForm(forms.Form):
-    text = forms.CharField(required=False)
-    url = forms.URLField(required=False)
-
-class SettingForm(forms.Form):
-    abc = forms.CharField(label='', widget=forms.Textarea(attrs={'id': 'abc'}))
+class SettingForm(forms.ModelForm):
+    """
+    User input to create a Setting
+    """
+    class Meta:
+        model = Setting
+        fields = ['abc', 'check_valid_abc']
 
 class CommentForm(forms.Form):
+    """
+    User input to create a Comment
+    """
     text = forms.CharField(label='Comment:', widget=forms.Textarea(attrs={'id': 'new_comment'}))
 
 class ContactForm(forms.Form):
+    """
+    For sending a message to site admins
+    """
     text = forms.CharField(widget=forms.Textarea())
     email = forms.EmailField(required=False)
 
-class TuneForm(forms.Form):
-    abc = forms.CharField(widget=forms.Textarea())
-    text = forms.CharField(widget=forms.Textarea())
-    url = forms.URLField(required=False)
-
-    def clean_abc(self):
-        try:
-            abc = conform_abc(self.cleaned_data['abc'])
-        except AttributeError as e:
-            raise forms.ValidationError(e)
-        return abc
+class TuneForm(forms.ModelForm):
+    """
+    User input to create a Tune
+    """
+    class Meta:
+        model = Tune
+        fields = ['abc', 'check_valid_abc']        
+
+class TuneAttributionForm(forms.ModelForm):
+    """
+    User input to create a TuneAttribution
+    """
+    class Meta:
+        model = TuneAttribution
+        fields = ['text', 'url']
 
 class RecordingForm(forms.Form):
+    """
+    User input to create a Recording
+    """
     title = forms.CharField()
     body = forms.CharField(widget=forms.Textarea())
     date = forms.DateField(widget=SelectDateWidget(years=YEAR_CHOICES))
     url = EmbedVideoFormField()
 
 class EventForm(forms.Form):
+    """
+    User input to create an Event
+    """
     title = forms.CharField()
     body = forms.CharField(widget=forms.Textarea())
     date = forms.DateField(widget=SelectDateWidget(years=YEAR_CHOICES))
 
 class TunebookForm(forms.Form):
+    """
+    User input for 'In your tunebook:'
+    """
     add = forms.BooleanField(required=False)
 
 class SearchForm(forms.Form):
+    """
+    User input for search field
+    """
     search = forms.CharField(required=False)
 
-# As per registration docs, this should subclass registration.forms.RegistrationFormUniqueEmail.
-# That wasn't working, so here instead is an equivalent, based on some of that code.
 def validate_duplicate_email(value):
+    """
+    Raise if value is an existing email address
+    """
     if User.objects.filter(email__iexact=value):
         raise forms.ValidationError(validators.DUPLICATE_EMAIL, code='invalid')
 
 class RegistrationForm(UserCreationForm):
+    """
+    User input for sign-up
+    As per registration docs, this should be a minimal subclass of registration.forms.RegistrationFormUniqueEmail.
+    However that wasn't working, so this instead is an equivalent, based on some of that code.
+    """
     class Meta:
         model = User
         fields = [

folk_rnn_site/archiver/migrations/0010_auto_20180629_0944.py

@@ -0,0 +1,25 @@
+# -*- coding: utf-8 -*-
+# Generated by Django 1.11.11 on 2018-06-29 09:44
+from __future__ import unicode_literals
+
+from django.db import migrations, models
+
+
+class Migration(migrations.Migration):
+
+    dependencies = [
+        ('archiver', '0009_tunebookentry'),
+    ]
+
+    operations = [
+        migrations.AddField(
+            model_name='setting',
+            name='check_valid_abc',
+            field=models.BooleanField(default=True),
+        ),
+        migrations.AddField(
+            model_name='tune',
+            name='check_valid_abc',
+            field=models.BooleanField(default=True),
+        ),
+    ]