Changeset 591

Timestamp:

08/25/10 16:03:10 (3 years ago)

Author:

jose.brandao

Message:

Doctests on application polyglot

Location:

trunk/opentrials/polyglot

Files:

• multilingual_forms.py (modified) (9 diffs)
• tests/01-models.txt (modified) (3 diffs)
• tests/02-forms.txt (modified) (4 diffs)
• tests/test_models.py (modified) (3 diffs)

trunk/opentrials/polyglot/multilingual_forms.py

@@ -107 +107 @@
     display_language = 'en' # FIXME: shouldn't be settings.LANGUAGE_CODE?
     instance = None
-    model = None
+    queryset = None
     label_field = None
 
@@ -114 +114 @@
 
         # Loops in the model choice objects
-        for item in self.model.objects.all():
+        for item in self.queryset.all():
             # If there is a translation...
             try:
@@ -127 +127 @@
 
 class MultilingualSelect(forms.Select, BaseMultilingualSelect):
-    def __init__(self, display_language=None, model=None, label_field=None, attrs=None):
+    def __init__(self, display_language=None, queryset=None, label_field=None, attrs=None):
         self.display_language = display_language or self.display_language
-        self.model = model
+        self.queryset = queryset
         self.label_field = label_field
 
@@ -140 +140 @@
 
 class MultilingualSelectMultiple(forms.SelectMultiple, BaseMultilingualSelect):
-    def __init__(self, display_language=None, model=None, label_field=None, attrs=None):
+    def __init__(self, display_language=None, queryset=None, label_field=None, attrs=None):
         self.display_language = display_language or self.display_language
-        self.model = model
+        self.queryset = queryset
         self.label_field = label_field
 
@@ -174 +174 @@
 class MultilingualModelChoiceField(MultilingualField):
     widget = MultilingualSelect
-    model = None
+    queryset = None
     label_field = None
 
     def __init__(self, *args, **kwargs):
-        self.model = kwargs.pop('model')
+        self.queryset = kwargs.pop('queryset')
         self.label_field = kwargs.pop('label_field')
 
@@ -187 +187 @@
             return None
         try:
-            value = self.model.objects.get(pk=value)
+            value = self.queryset.get(pk=value)
         except ObjectDoesNotExist:
             raise ValidationError(self.error_messages['invalid_choice'])
@@ -199 +199 @@
             return None
 
-        return self.model.objects.filter(pk__in=value)
+        return self.queryset.filter(pk__in=value)
 
 # ---------- FORMS -----------
@@ -212 +212 @@
         self.multilingual_fields = get_multilingual_fields(self._meta.model)
 
+        # Gets default second language from arguments, if informed. Default value is None
+        self.default_second_language = kwargs.pop('default_second_language', self.default_second_language) # Optional
+        self.available_languages = kwargs.pop('available_languages', [code.lower() for code in settings.MANAGED_LANGUAGES]) # Mandatory (FIXME, to remove default tuple)
+        self.display_language = kwargs.pop('display_language', self.display_language)
+
         if self.multilingual_fields:
-            # Gets default second language from arguments, if informed. Default value is None
-            self.default_second_language = kwargs.pop('default_second_language', self.default_second_language) # Optional
-            self.available_languages = kwargs.pop('available_languages', [code.lower() for code in settings.MANAGED_LANGUAGES]) # Mandatory (FIXME, to remove default tuple)
-            self.display_language = kwargs.pop('display_language', self.display_language)
-
             # Change field widgets replacing common TextInput and Textarea to Multilingual respective ones
             for field_name in self.multilingual_fields:
@@ -263 +263 @@
             if isinstance(self.fields[field_name], (MultilingualModelChoiceField,)):
                 self.fields[field_name].widget.display_language = self.display_language
-                self.fields[field_name].widget.model = self.fields[field_name].model
+                self.fields[field_name].widget.queryset = self.fields[field_name].queryset
                 self.fields[field_name].widget.label_field = self.fields[field_name].label_field
 

trunk/opentrials/polyglot/tests/01-models.txt

@@ -45 +45 @@
 
     >>> from django.contrib.flatpages.models import FlatPage
-    >>> from polyglot.tests.test_models import FlatPageTranslation, create_flatpage_translation_table
+    >>> from polyglot.tests.test_models import FlatPageTranslation, create_tables
 
 The related class has an attribute 'translations' with a generic relation to our translation subclass
 
-    >>> isinstance(FlatPage.translations, generic.GenericRelation)
+    >>> isinstance(FlatPage.translations, generic.ReverseGenericRelatedObjectsDescriptor)
     True
 
 Create the table in database
 
-    >>> create_flatpage_translation_table()
+    >>> create_tables()
 
 Test table created with successful
@@ -63 +63 @@
 Creating a flat page as the original object to be translated
 
-    >>> page1 = FlatPage.objects.create(title='About', content='This is a page about our institute.')
+    >>> page1 = FlatPage.objects.create(title='About Test', content='This is a page about our institute.')
 
 Now translating the object "page1"
@@ -70 +70 @@
     >>> trans1.language = 'pt-br'
     >>> trans1.content_object = page1
-    >>> trans1.title = 'Sobre'
+    >>> trans1.title = 'Sobre o Teste'
     >>> trans1.content = u'Esta é uma página sobre nosso instituto.'
     >>> trans1.save()

trunk/opentrials/polyglot/tests/02-forms.txt

@@ -12 +12 @@
     ...     class Meta:
     ...         model = FlatPage
+    ...         fields = ('title','content','url','sites')
 
 You must inform what languages are available, what is the default second language and what
@@ -24 +25 @@
     ... )
 
-    >>> form.fields.keys()
-    ['url', 'title', 'content', 'enable_comments', 'template_name', 'registration_required', 'sites']
+    >>> set(form.fields.keys()) == set(['title','content','url','sites'])
+    True
 
-    >>> form.multilingual_fields
-    ['title', 'content']
+    >>> set(form.multilingual_fields) == set(['title', 'content'])
+    True
 
 The multilingual fields are collected from model class using a function...
@@ -34 +35 @@
     >>> from polyglot.models import get_multilingual_fields
 
-    >>> get_multilingual_fields(FlatPage)
-    ['title', 'content']
+    >>> set(get_multilingual_fields(FlatPage)) == set(['title', 'content'])
+    True
 
 A multilingual field is associated to a multilingual widget.
@@ -45 +46 @@
     True
 
+Test of form saving
+
+    >>> data = {
+    ...     'title': 'This is the original title',
+    ...     'content': 'This is the original content',
+    ...     'url': '/url/',
+    ...     'sites': ['1'],
+    ... }
+
+    >>> form = FlatPageForm(
+    ...     data=data,
+    ...     default_second_language='pt-br',
+    ...     available_languages=('en','pt-br','es'),
+    ...     display_language='pt-br',
+    ... )
+
+    >>> form.is_valid()
+    True
+
+    >>> print form.errors
+    <BLANKLINE>
+
+    >>> page = form.save()
+
+    >>> isinstance(page, FlatPage)
+    True
+
+    >>> page.translations.values('title','content')
+    [{'content': u'', 'title': u''}, {'content': u'', 'title': u''}]
+
+    >>> form = FlatPageForm(
+    ...     instance=page,
+    ...     default_second_language='pt-br',
+    ...     available_languages=('en','pt-br','es'),
+    ...     display_language='pt-br',
+    ... )
+
+    >>> form.fields['title'].widget.render('title', page.title)
+    u'<div class="multilingual"><div class="multilingual-value en"><b>English</b><input type="text" name="title" value="This is the original title" /></div>\n<div class="multilingual-value es"><b>Espa\xf1ol</b><input type="text" name="title|es" /></div>\n<div class="multilingual-value pt-br default-second-language"><b>Portuguese</b><input type="text" name="title|pt-br" /></div></div>'
+
+    >>> form.fields['content'].widget.render('content', page.content)
+    u'<div class="multilingual"><div class="multilingual-value en"><b>English</b><textarea rows="10" cols="40" name="content">This is the original content</textarea></div>\n<div class="multilingual-value es"><b>Espa\xf1ol</b><textarea rows="10" cols="40" name="content|es"></textarea></div>\n<div class="multilingual-value pt-br default-second-language"><b>Portuguese</b><textarea rows="10" cols="40" name="content|pt-br"></textarea></div></div>'
+
 There are multilingual fields you can inform the same value for many available languages.
+
+    >>> data = form.initial
+    >>> data['title|es'] = 'Titulo en español'
+    >>> data['title|pt-br'] = u'Título em português brasileiro'
+    >>> data['content|es'] = u'Conteúdo en español'
+    >>> data['content|pt-br'] = u'Conteúdo em português brasileiro'
+
+    >>> form = FlatPageForm(
+    ...     data=data,
+    ...     instance=page,
+    ...     default_second_language='pt-br',
+    ...     available_languages=('en','pt-br','es'),
+    ...     display_language='pt-br',
+    ... )
+
+    >>> form.is_valid()
+    True
+
+    >>> print form.errors
+    <BLANKLINE>
+
+    >>> page = form.save()
+
+    >>> page.translations.values('title','content')
+    [{'content': u'Conte\xc3\xbado en espa\xc3\xb1ol', 'title': u'Titulo en espa\xf1ol'}, {'content': u'Conte\xc3\xbado em portugu\xc3\xaas brasileiro', 'title': u'T\xc3\xadtulo em portugu\xc3\xaas brasileiro'}]
 
 There are multilingual fields you can show a select with choices.
 
+    >>> from polyglot.multilingual_forms import MultilingualModelChoiceField, MultilingualModelMultipleChoiceField
+    >>> from polyglot.tests.test_models import FlatPageRelative
+
+    >>> page2 = FlatPage.objects.get(title='About Test')
+
+    >>> class FormFlatPageRelative(MultilingualBaseForm):
+    ...     class Meta:
+    ...         model = FlatPageRelative
+    ... 
+    ...     subpages = MultilingualModelMultipleChoiceField(
+    ...         queryset=FlatPage.objects.filter(title__in=(page.title, page2.title)),
+    ...         label_field='title',
+    ...         required=False,
+    ...     )
+    ... 
+    ...     def __init__(self, *args, **kwargs):
+    ...         self.base_fields['page'] = MultilingualModelChoiceField(
+    ...             queryset=FlatPage.objects.filter(title__in=(page.title, page2.title)),
+    ...             label_field='title',
+    ...             required=False,
+    ...         )
+    ... 
+    ...         super(FormFlatPageRelative, self).__init__(*args, **kwargs)
+
+    >>> set(FormFlatPageRelative.base_fields.keys()) == set(['page','subpages','information'])
+    True
+
+When a form is instantiated, the choices of a multilingual choice field are shown depending
+on the display language informed.
+
+    >>> data = {
+    ...     'page': unicode(page.pk),
+    ...     'information': 'Nothing important here.',
+    ... }
+
+    >>> form = FormFlatPageRelative(
+    ...     data=data,
+    ...     default_second_language='pt-br',
+    ...     available_languages=('en','pt-br','es'),
+    ...     display_language='pt-br',
+    ... )
+
+    >>> form.fields['page'].widget.render('page', unicode(page.pk))
+    u'<select name="page">\n<option value="3">Sobre o Teste</option>\n<option value="4" selected="selected">T\xc3\xadtulo em portugu\xc3\xaas brasileiro</option>\n</select>'
+
+    >>> form.fields['subpages'].widget.render('subpages', None)
+    u'<select multiple="multiple" name="subpages">\n<option value="3">Sobre o Teste</option>\n<option value="4">T\xc3\xadtulo em portugu\xc3\xaas brasileiro</option>\n</select>'
+
+    >>> form.is_valid()
+    True
+
+    >>> print form.errors
+    <BLANKLINE>
+
+    >>> relative = form.save()
+
 Multilingual formset is a formset with many multilingual forms.
 

trunk/opentrials/polyglot/tests/test_models.py

@@ -3 +3 @@
 from django.contrib.flatpages.models import FlatPage
 from django.contrib.contenttypes import generic
+from django.db.models.sql.query import setup_join_cache
 
 from polyglot.models import Translation
@@ -13 +14 @@
     content = models.TextField(max_length=2000, blank=True)
 
+FlatPage.translations = generic.GenericRelation(FlatPageTranslation)
+FlatPage.translations.contribute_to_class(FlatPage, 'translations')
 
-FlatPage.translations = generic.GenericRelation(FlatPageTranslation)
+class FlatPageRelative(models.Model):
+    page = models.ForeignKey(FlatPage, related_name='page_relatives')
+    information = models.TextField(blank=True)
 
-from django.db.models.sql.query import setup_join_cache
 setup_join_cache(FlatPageTranslation)
+setup_join_cache(FlatPageRelative)
 
-def create_flatpage_translation_table():
+def create_tables():
     cursor = connection.cursor()
     style = no_style()
     tables = connection.introspection.table_names()
     seen_models = connection.introspection.installed_models(tables)
+
     sql, references = connection.creation.sql_create_model(FlatPageTranslation, style, seen_models)
+    new_sql, new_ref = connection.creation.sql_create_model(FlatPageRelative, style, seen_models)
+    sql.extend(new_sql); references.update(new_ref)
 
     pending_references = {}
@@ -32 +40 @@
             sql.extend(connection.creation.sql_for_pending_references(refto, style, pending_references))
     sql.extend(connection.creation.sql_for_pending_references(FlatPageTranslation, style, pending_references))
+    sql.extend(connection.creation.sql_for_pending_references(FlatPageRelative, style, pending_references))
     for statement in sql:
         cursor.execute(statement)