Changeset 193:bb9d4763dba9

Timestamp:

07/25/09 13:55:18 (13 months ago)

Author:

rgrp

Branch:

default

convert_revision:

svn:0ead1229-0713-0410-96cd-f668dbfad531/trunk@279

Message:

[model][m]: create new Resource object related to Material and remove Resource-related attributes (src_pkg, src_locator) from Material.

• Create associated migrate scripts (though do not do data migration)
• cli.py: support for downgrade as well as upgrade (and upgrade to a version)
• Update all Material/Resource related code (I hope)

Location:

shakespeare

Files:

• cli.py (modified) (2 diffs)
• controllers/text.py (modified) (1 diff)
• migration/util.py (added)
• migration/versions/002_create_resource_object.py (added)
• model/__init__.py (modified) (1 diff)
• model/dm.py (modified) (4 diffs)
• templates/text/info.html (modified) (1 diff)
• tests/test_model.py (modified) (4 diffs)

shakespeare/cli.py

@@ -78 +78 @@
     # Commands
 
-    db_actions = [ 'create', 'upgrade', 'clean', 'rebuild', 'init_shksprdata', 'init_miltondata' ]
-    def do_db(self, line=None):
-        if line is None or line not in self.db_actions:
+    db_actions = [ 'create', 'upgrade', 'downgrade', 'clean', 'rebuild', 'init_shksprdata', 'init_miltondata' ]
+    def do_db(self, line=''):
+        args = line.split()
+        action = args[0]
+        if not action in self.db_actions:
             self.help_db()
             return 1
@@ -87 +89 @@
         import shakespeare
         migrate_repository = 'shakespeare/migration/'
-        if line == 'create':
+        if action == 'create':
             model.repo.create_db()
-        elif line == 'clean':
+        elif action == 'clean':
             model.repo.clean_db()
-        elif line == 'rebuild':
+        elif action == 'rebuild':
             model.repo.rebuild_db()
-        elif line == 'upgrade':
+        elif action == 'upgrade':
+            version = None
+            if len(args) > 1:
+                version = args[1]
+            import migrate.versioning.exceptions
             import migrate.versioning.api
             import migrate.versioning.api as mig
+            try:
+                mig.version_control(model.meta.engine.url, migrate_repository)
+            except migrate.versioning.exceptions.DatabaseAlreadyControlledError:
+                pass
             mig.upgrade(model.meta.engine.url, migrate_repository,
-                    version=None)
-        elif line == 'downgrade':
-            # TODO (need a version argument ...)
-            raise NotImplementedError()
-        elif line.startswith('init_'):
-            modname = line.strip()[5:]
+                    version=version)
+        elif action == 'downgrade':
+            if len(args) < 2:
+                print 'You need to supply a version to downgrade to'
+                return 1
+            version = args[1]
+            import migrate.versioning.api
+            import migrate.versioning.api as mig
+            mig.downgrade(model.meta.engine.url, migrate_repository,
+                    version=version)
+        elif action.startswith('init_'):
+            modname = action.strip()[5:]
             mod = __import__(modname+'.cli', fromlist='cli')
             mod.LoadTexts.load_texts()

shakespeare/controllers/text.py

@@ -51 +51 @@
             tfileobj = item.get_text()
             # hack for time being ...
-            if item.format == 'mkd':
+            if item.resources and item.resources[0].format == 'mkd':
                 ttext = h.markdown(tfileobj.read())
             else:

shakespeare/model/__init__.py

@@ -37 +37 @@
             version_table = Table('migrate_version', self.metadata, autoload=True) 
             version_table.drop()
-        except sqlalchemy.exceptions.NoSuchTableError:
+        except: # seem to occasionally get other sqlalchemy errors ...
+        # except sqlalchemy.exceptions.NoSuchTableError:
             pass
 

shakespeare/model/dm.py

@@ -25 +25 @@
     Column('creator', Unicode(255)),
     Column('notes', UnicodeText),
+    )
+
+resource_table = Table('resource', metadata,
+    Column('id', Integer, primary_key=True),
+    Column('material_id', Integer, ForeignKey('material.id')),
     Column('format', UnicodeText),
-    # python package it lives in, if any
-    Column('src_pkg', UnicodeText),
-    # url (file or web) or standard (unix) file path
-    Column('src_locator', UnicodeText),
+    # url or path
+    Column('locator', UnicodeText),
+    # types: url, cache, package, disk
+    Column('locator_type', UnicodeText, default=u'url'),
     )
 
@@ -72 +77 @@
         # ignore format for time being
         '''
-        import pkg_resources
-        # default to plain txt format (TODO: generalise this)
-        fileobj = pkg_resources.resource_stream(self.src_pkg, self.src_locator)
-        return fileobj
+        if self.resources:
+            return self.resources[0].get_stream()
 
     def get_ftitle(self):
@@ -81 +84 @@
 
     ftitle = property(get_ftitle)
+
+
+class Resource(object):
+    def get_stream(self):
+        '''Get text (if any) associated with this material.
+
+        # ignore format for time being
+        '''
+        if self.locator_type == u'package':
+            package, path = self.locator.split('::')
+            import pkg_resources
+            fileobj = pkg_resources.resource_stream(package, path)
+            return fileobj
+        else:
+            raise NotImplementedError
 
 
@@ -99 +117 @@
     )
 
+mapper(Resource, resource_table, properties={
+    'material':relation(Material, backref='resources')
+    },
+    order_by=resource_table.c.id
+    )
+
 mapper(Statistic, statistic_table, properties={
     'text':relation(Material, backref='statistics')

shakespeare/templates/text/info.html

@@ -22 +22 @@
     <h3>Metadata</h3>
     <ul>
-      <li py:for="attr in ['creator', 'name', 'format', 'notes']">
+      <li py:for="attr in ['creator', 'name', 'notes']">
         <strong>${attr.capitalize()}:</strong>
         ${getattr(c.material, attr)}

shakespeare/tests/test_model.py

@@ -13 +13 @@
             title=self.title,
             work=work,
-            src_pkg=u'shksprdata',
-            src_locator=u'/gutenberg/phoenix_and_the_turtle_gut.txt'
+            )
+        resource = model.Resource(
+            material=text,
+            locator_type=u'package',
+            locator=u'shksprdata::/gutenberg/phoenix_and_the_turtle_gut.txt',
+            format=u'txt',
             )
 
@@ -20 +24 @@
         self.workid = work.id
         self.textid = text.id
+        self.resourceid = resource.id
         model.Session.clear()
 
     @classmethod
     def teardown_class(self):
-        text = model.Material.query.get(self.textid)
-        work = model.Material.query.get(self.workid)
-        model.Session.delete(text)
-        if work:
-            model.Session.delete(work)
-        model.Session.flush()
+        model.repo.rebuild_db()
     
     def test_work(self):
@@ -42 +42 @@
         assert txt2.title == self.title
         assert txt2.work.id == self.workid
+        assert txt2.resources
     
     def test_get_text(self):
@@ -49 +50 @@
         assert len(out) > 0
         assert out[:26] == 'THE PHOENIX AND THE TURTLE'
+
+    def test_resource(self):
+        res = model.Resource.query.get(self.resourceid)
+        assert res.format == u'txt'