Move destroy_workbench to Workbench class
authorElrond <elrond+mediagoblin.org@samba-tng.org>
Tue, 14 Jun 2011 18:39:14 +0000 (20:39 +0200)
committerElrond <elrond+mediagoblin.org@samba-tng.org>
Tue, 14 Jun 2011 18:39:14 +0000 (20:39 +0200)
And add a lot of warnings, as the checks for "being part of
the main Manager" are all gone.

mediagoblin/process_media/__init__.py
mediagoblin/tests/test_workbench.py
mediagoblin/workbench.py

index bd067e393157c74978f3e3d7222aec3b5fac94ad..f37bf08030bea5bea29e12f89aee91be322268c7 100644 (file)
@@ -75,4 +75,4 @@ def process_media_initial(media_id):
     entry.save()
 
     # clean up workbench
-    mgg.workbench_manager.destroy_workbench(workbench)
+    workbench.destroy_self()
index db27dfc6f735b3d58b52ad066897e4d085f815f9..953835a147d758b6a989fc9bfb430b951eb2458e 100644 (file)
@@ -37,7 +37,7 @@ class TestWorkbench(object):
         this_workbench = self.workbench_manager.create_workbench()
         tmpname = this_workbench.joinpath('temp.txt')
         assert tmpname == os.path.join(this_workbench.dir, 'temp.txt')
-        self.workbench_manager.destroy_workbench(this_workbench)
+        this_workbench.destroy_self()
 
     def test_destroy_workbench(self):
         # kill a workbench
@@ -49,17 +49,10 @@ class TestWorkbench(object):
 
         assert os.path.exists(tmpfile_name)
 
-        self.workbench_manager.destroy_workbench(this_workbench)
+        wb_dir = this_workbench.dir
+        this_workbench.destroy_self()
         assert not os.path.exists(tmpfile_name)
-        assert not os.path.exists(this_workbench.dir)
-
-        # make sure we can't kill other stuff though
-        dont_kill_this = workbench.Workbench(tempfile.mkdtemp())
-
-        assert_raises(
-            workbench.WorkbenchOutsideScope,
-            self.workbench_manager.destroy_workbench,
-            dont_kill_this)
+        assert not os.path.exists(wb_dir)
 
     def test_localized_file(self):
         tmpdir, this_storage = get_tmp_filestorage()
index 32229d2e3b9ae8d20f659e3236232533704e1a4f..f83c4fa05557c776802c569c533e2caed1525cd0 100644 (file)
@@ -23,24 +23,21 @@ DEFAULT_WORKBENCH_DIR = os.path.join(
     tempfile.gettempdir(), u'mgoblin_workbench')
 
 
-# Exception(s)
-# ------------
-
-class WorkbenchOutsideScope(Exception):
-    """
-    Raised when a workbench is outside a WorkbenchManager scope.
-    """
-    pass
-
-
 # Actual workbench stuff
 # ----------------------
 
 class Workbench(object):
     """
     Represent the directory for the workbench
+
+    WARNING: DO NOT create Workbench objects on your own,
+    let the WorkbenchManager do that for you!
     """
     def __init__(self, dir):
+        """
+        WARNING: DO NOT create Workbench objects on your own,
+        let the WorkbenchManager do that for you!
+        """
         self.dir = dir
 
     def __unicode__(self):
@@ -117,6 +114,19 @@ class Workbench(object):
 
             return full_dest_filename
 
+    def destroy_self(self):
+        """
+        Destroy this workbench!  Deletes the directory and all its contents!
+
+        WARNING: Does no checks for a sane value in self.dir!
+        """
+        # just in case
+        workbench = os.path.abspath(self.dir)
+
+        shutil.rmtree(workbench)
+
+        del self.dir
+
 
 class WorkbenchManager(object):
     """
@@ -136,18 +146,3 @@ class WorkbenchManager(object):
         Create and return the path to a new workbench (directory).
         """
         return Workbench(tempfile.mkdtemp(dir=self.base_workbench_dir))
-
-    def destroy_workbench(self, workbench):
-        """
-        Destroy this workbench!  Deletes the directory and all its contents!
-
-        Makes sure the workbench actually belongs to this manager though.
-        """
-        # just in case
-        workbench = os.path.abspath(workbench.dir)
-
-        if not workbench.startswith(self.base_workbench_dir):
-            raise WorkbenchOutsideScope(
-                "Can't destroy workbench outside the base workbench dir")
-
-        shutil.rmtree(workbench)