Some refactor

Author: hirunatan

validatedfile/models.py

@@ -34,29 +34,66 @@ def clean(self, *args, **kwargs):
 
 
 class FileQuota(object):
-    def __init__(self, items = [], file_attr_name = None):
-        self.items = items
-        self.file_attr_name = file_attr_name
-
-    def current_usage(self):
-        usage = 0
-        for item in self.items:
-            the_file = getattr(item, self.file_attr_name, None)
+
+    def __init__(self, max_usage = -1):
+        self.current_usage = 0
+        self.max_usage = max_usage
+
+    def update(self, items, attr_name):
+        self.current_usage = 0
+        for item in items:
+            the_file = getattr(item, attr_name, None)
             if the_file:
-                usage += the_file.size
-        return usage
+                self.current_usage += the_file.size
+
+    def exceeds(self, size = 0):
+        if self.max_usage >= 0:
+            return (self.current_usage + size > self.max_usage)
+        else:
+            return False
+
 
 class QuotaValidator(object):
+
     def __init__(self, max_usage):
-        self.quota = FileQuota()
-        self.max_usage = max_usage
+        self.quota = FileQuota(max_usage)
 
-    def set_quota(self, quota):
-        self.quota = quota
+    def update_quota(self, items, attr_name):
+        self.quota.update(items, attr_name)
 
     def __call__(self, file):
-        tried_usage = self.quota.current_usage() + file.size
-        if tried_usage > self.max_usage:
+        file_size = file.size
+        if self.quota.exceeds(file_size):
             raise forms.ValidationError(_('Please keep the total uploaded files under %s. With this file, the total would be %s' %
-                                   (filesizeformat(self.max_usage), filesizeformat(tried_usage))))
-        
+                                   (filesizeformat(self.quota.max_usage),
+                                    filesizeformat(self.quota.current_usage + file_size))))
+ 
+
+#
+#
+#    def __init__(self, items = [], file_attr_name = None):
+#        self.items = items
+#        self.file_attr_name = file_attr_name
+#
+#    def current_usage(self):
+#        usage = 0
+#        for item in self.items:
+#            the_file = getattr(item, self.file_attr_name, None)
+#            if the_file:
+#                usage += the_file.size
+#        return usage
+#
+#class QuotaValidator(object):
+#    def __init__(self, max_usage):
+#        self.quota = FileQuota()
+#        self.max_usage = max_usage
+#
+#    def set_quota(self, quota):
+#        self.quota = quota
+#
+#    def __call__(self, file):
+#        tried_usage = self.quota.current_usage() + file.size
+#        if tried_usage > self.max_usage:
+#            raise forms.ValidationError(_('Please keep the total uploaded files under %s. With this file, the total would be %s' %
+#                                   (filesizeformat(self.max_usage), filesizeformat(tried_usage))))
+#        

validatedfile/tests/__init__.py

@@ -123,8 +123,10 @@ def test_form_null_file(self):
     def test_quota_empty(self):
         container = TestContainer.objects.create(name = 'container1')
 
-        quota = FileQuota(container.test_elements.all(), 'the_file')
-        self.assertEqual(quota.current_usage(), 0)
+        quota = FileQuota()
+        quota.update(container.test_elements.all(), 'the_file')
+        self.assertEqual(quota.current_usage, 0)
+        self.assertFalse(quota.exceeds())
 
         container.delete()
 
@@ -136,8 +138,10 @@ def test_quota_one_file(self):
                 the_file = File(self._get_sample_file('image2k.png'), 'the_file.png')
             )
 
-        quota = FileQuota(container.test_elements.all(), 'the_file')
-        self.assertEqual(quota.current_usage(), 2120)
+        quota = FileQuota()
+        quota.update(container.test_elements.all(), 'the_file')
+        self.assertEqual(quota.current_usage, 2120)
+        self.assertFalse(quota.exceeds())
 
         element.the_file.delete()
         element.delete()
@@ -160,8 +164,10 @@ def test_quota_several_files_several_containers(self):
                 the_file = File(self._get_sample_file('document15k.pdf'), 'the_file3.pdf')
             )
 
-        quota = FileQuota(container1.test_elements.all(), 'the_file')
-        self.assertEqual(quota.current_usage(), 16706)
+        quota = FileQuota(max_usage = 20000)
+        quota.update(container1.test_elements.all(), 'the_file')
+        self.assertEqual(quota.current_usage, 16706)
+        self.assertFalse(quota.exceeds())
 
         element1.the_file.delete()
         element2.the_file.delete()
@@ -173,18 +179,57 @@ def test_quota_several_files_several_containers(self):
         container2.delete()
 
 
+    def test_quota_exceeds(self):
+        quota = FileQuota(max_usage = 1000)
+
+        container = TestContainer.objects.create(name = 'container1')
+        quota.update(container.test_elements.all(), 'the_file')
+        self.assertEqual(quota.current_usage, 0)
+        self.assertFalse(quota.exceeds())
+        self.assertTrue(quota.exceeds(2120))
+
+        element = TestElement.objects.create(
+                container = container,
+                the_file = File(self._get_sample_file('image2k.png'), 'the_file.png')
+            )
+        quota.update(container.test_elements.all(), 'the_file')
+        self.assertEqual(quota.current_usage, 2120)
+        self.assertTrue(quota.exceeds())
+
+        element.the_file.delete()
+        element.delete()
+        container.delete()
+
+
+    def test_form_quota_check(self):
+        container = TestContainer.objects.create(name = 'container1')
+
+        form1 = TestElementForm(container = container)
+        self.assertFalse(form1.exceeds_quota())
+
+        element = TestElement.objects.create(
+                container = container,
+                the_file = File(self._get_sample_file('image15k.png'), 'the_file.png')
+            )
+
+        form2 = TestElementForm(container = container)
+        self.assertTrue(form2.exceeds_quota())
+
+        element.the_file.delete()
+        element.delete()
+        container.delete()
+
+
     def test_form_quota_ok(self):
         container = TestContainer.objects.create(name = 'container1')
 
-        quota = FileQuota(container.test_elements.all(), 'the_file')
         uploaded_file = SimpleUploadedFile(
                 name = 'the_file.png',
                 content = self._get_sample_file('image2k.png').read(),
                 content_type = 'image/png',
             )
         form = TestElementForm(
                 container = container,
-                quota = quota,
                 data = {},
                 files = {'the_file': uploaded_file}
             )
@@ -201,15 +246,13 @@ def test_form_quota_exceeded(self):
                 the_file = File(self._get_sample_file('image2k.png'), 'the_file.png')
             )
 
-        quota = FileQuota(container.test_elements.all(), 'the_file')
         uploaded_file = SimpleUploadedFile(
                 name = 'the_file.png',
                 content = self._get_sample_file('image15k.png').read(),
                 content_type = 'image/png',
             )
         form = TestElementForm(
                 container = container,
-                quota = quota,
                 data = {},
                 files = {'the_file': uploaded_file}
             )

validatedfile/tests/forms.py

@@ -23,10 +23,16 @@ class Meta:
         model = TestElement
         fields = ['the_file']
 
-    def __init__(self, container, quota, *args, **kwargs):
+    def __init__(self, container, *args, **kwargs):
         super(TestElementForm, self).__init__(*args, **kwargs)
         self.container = container
-        self.fields['the_file'].validators[0].set_quota(quota)
+        self.fields['the_file'].validators[0].update_quota(
+                items = self.container.test_elements.all(),
+                attr_name = 'the_file',
+            )
+
+    def exceeds_quota(self):
+        return self.fields['the_file'].validators[0].quota.exceeds()
 
     def save(self, *args, **kwargs):
         element = super(TestElementForm, self).save(commit = False)