[all][m]: begin major upgrade to bring things up to date (all tests p…

…assing again).

  * Remove sqlobject in favour of sqlalchemy.
  * Remove use of formencode.
    * Have disabled all code using this -- basically the crude model browser (which should be replaced anyway with formalchemy+pylons)
  * Move to paste.fixture for testing of wsgi app part
  * demo is probably broken atm
  * Disable marginalia wsgiapp tests -- this should probably be removed in any case and replaced with something simpler

.hgignore

@@ -0,0 +1,5 @@
+syntax: glob
+*.pyc
+*.egg-info/*
+sandbox/*
+

annotater/__init__.py

@@ -4,4 +4,4 @@
 @author: Rufus Pollock (Open Knowledge Foundation)
 @license: MIT License <http://www.opensource.org/licenses/mit-license.php>
 """
-__version__ = '0.1'
+__version__ = '0.2a'

annotater/marginalia/marginalia_test.py

@@ -1,9 +1,6 @@
 import os
 from StringIO import StringIO
 
-import twill
-from twill import commands as web
-
 import annotater.marginalia
 
 
@@ -82,42 +79,42 @@ def test_format(self):
         assert out == self.exp
 
 
-class TestMarginaliaFiles:
-
-    def setup_method(self, name=''):
-        # set without trailing slash
-        self.base_url = '/marginalia'
-        wsgi_app = annotater.marginalia.MarginaliaMedia(self.base_url)
-        self.base_url = '/marginalia' + '/'
-        twill.add_wsgi_intercept('localhost', 8080, lambda : wsgi_app)
-        twill.set_output(StringIO())
-        self.siteurl = 'http://localhost:8080'
-
-    def teardown_method(self, name=''):
-        twill.remove_wsgi_intercept('localhost', 8080)
-
-    def test_js(self):
-        filename = 'domutil.js'
-        url = self.siteurl + self.base_url + filename
-        print url
-        web.go(url)
-        web.code(200)
-        web.find('ELEMENT_NODE = 1;')
-
-    def test_js_2(self):
-        filename = 'lang/en.js'
-        url = self.siteurl + self.base_url + filename
-        web.go(url)
-        web.code(200)
-
-
-class TestMarginaliaFiles2(TestMarginaliaFiles):
-    # a different base name
-
-    def setup_method(self, name=''):
-        self.base_url = '/'
-        wsgi_app = annotater.marginalia.MarginaliaMedia(self.base_url)
-        twill.add_wsgi_intercept('localhost', 8080, lambda : wsgi_app)
-        twill.set_output(StringIO())
-        self.siteurl = 'http://localhost:8080'
+# class TestMarginaliaFiles:
+# 
+#     def setup_method(self, name=''):
+#         # set without trailing slash
+#         self.base_url = '/marginalia'
+#         wsgi_app = annotater.marginalia.MarginaliaMedia(self.base_url)
+#         self.base_url = '/marginalia' + '/'
+#         twill.add_wsgi_intercept('localhost', 8080, lambda : wsgi_app)
+#         twill.set_output(StringIO())
+#         self.siteurl = 'http://localhost:8080'
+# 
+#     def teardown_method(self, name=''):
+#         twill.remove_wsgi_intercept('localhost', 8080)
+# 
+#     def test_js(self):
+#         filename = 'domutil.js'
+#         url = self.siteurl + self.base_url + filename
+#         print url
+#         web.go(url)
+#         web.code(200)
+#         web.find('ELEMENT_NODE = 1;')
+# 
+#     def test_js_2(self):
+#         filename = 'lang/en.js'
+#         url = self.siteurl + self.base_url + filename
+#         web.go(url)
+#         web.code(200)
+# 
+# 
+# class TestMarginaliaFiles2(TestMarginaliaFiles):
+#     # a different base name
+# 
+#     def setup_method(self, name=''):
+#         self.base_url = '/'
+#         wsgi_app = annotater.marginalia.MarginaliaMedia(self.base_url)
+#         twill.add_wsgi_intercept('localhost', 8080, lambda : wsgi_app)
+#         twill.set_output(StringIO())
+#         self.siteurl = 'http://localhost:8080'
 

annotater/model.py

@@ -1,52 +1,81 @@
 import os
+import uuid
 from datetime import datetime
 import cgi
 
-import sqlobject
+from sqlalchemy import create_engine
+from sqlalchemy import Table, Column, Integer, String, MetaData, ForeignKey
+# TODO: restrict imports ...
+from sqlalchemy import *
+
+metadata = MetaData()
+
+from sqlalchemy.orm import scoped_session, sessionmaker, create_session
+from sqlalchemy.orm import relation, backref
+# both options now work
+# Session = scoped_session(sessionmaker(autoflush=False, transactional=True))
+# this is the more testing one ...
+Session = scoped_session(sessionmaker(
+    autoflush=True,
+    autocommit=False,
+    ))
+
+mapper = Session.mapper
 
 def set_default_connection():
     cwd = os.getcwd()
     uri = 'sqlite://%s/sqlite.db' % cwd
     # uri = 'sqlite:///:memory:'
-    connection = sqlobject.connectionForURI(uri)
-    sqlobject.sqlhub.processConnection = connection
-    createdb()
-
-# must not set this here as annotater and its model will be reused in other
-# applications that will set up there own database connections
-# set_default_connection()
+    engine = create_engine('sqlite:///:memory:', echo=False)
+    metadata.bind = engine
+    Session.bind = engine
 
-# note we run this at bottom of module to auto create db tables on import
 def createdb():
-    Annotation.createTable(ifNotExists=True)
+    metadata.create_all()
 
 def cleandb():
-    Annotation.dropTable(ifExists=True)
+    metadata.drop_all()
 
 def rebuilddb():
     cleandb()
     createdb()
 
-class Annotation(sqlobject.SQLObject):
+annotation_table = Table('annotation', metadata,
+    Column('id', String(36), primary_key=True, default=lambda:
+        str(uuid.uuid4())),
+    Column('url', UnicodeText),
+    Column('range', UnicodeText),
+    Column('note', UnicodeText),
+    Column('quote', UnicodeText),
+    Column('created', DateTime, default=datetime.now),
+    )
 
-    url = sqlobject.UnicodeCol()
-    range = sqlobject.StringCol()
-    note = sqlobject.UnicodeCol()
-    quote = sqlobject.UnicodeCol(default=None)
-    created = sqlobject.DateTimeCol(default=datetime.now) 
+
+class Annotation(object):
 
     @classmethod
-    def list_annotations_html(cls, url='', userid='', exlude=''):
+    def delete(self, id):
+        anno = self.query.get(id)
+        if anno:
+            Session.delete(anno)
+        Session.commit()
+
+    def __str__(self):
+        out = u'%s %s %s' % (self.__class__.__name__, self.id, self.url)
+        return out.encode('utf8', 'ignore')
+
+    @classmethod
+    def list_annotations_html(cls, url=u''):
         import cgi
-        query_results = cls.select(cls.q.url.startswith(url))
+        query_results = cls.query.filter(cls.url.startswith(url))
         out = ''
         for item in query_results:
             out += '<pre>%s</pre>' % cgi.escape(str(item)) + '\n\n'
         return out
 
     @classmethod
-    def list_annotations_atom(cls, url='', userid='', exlude=''):
-        query_results = cls.select(cls.q.url.startswith(url))
+    def list_annotations_atom(cls, url=u''):
+        query_results = cls.query.filter(cls.url.startswith(url))
         # create the Atom by hand -- maybe in future we can use a library
         ns_xhtml = '' 
         annotation_service = 'http://localhost:8080/annotation'
@@ -86,9 +115,10 @@ def make_entries(results):
     )
         return atom.encode('utf8')
 
+mapper(Annotation, annotation_table)
 
-from formencode import sqlschema
-class AnnotationSchema(sqlschema.SQLSchema):
-
-    wrap = Annotation
+# from formencode import sqlschema
+# class AnnotationSchema(sqlschema.SQLSchema):
+#
+#    wrap = Annotation
 

annotater/model_test.py

@@ -1,45 +1,45 @@
-import annotater.model
-annotater.model.set_default_connection()
-annotater.model.rebuilddb()
+import annotater.model as model
+model.set_default_connection()
+model.rebuilddb()
 
 class TestAnnotation:
 
+    @classmethod
     def setup_class(self):
-        self.url = 'http://xyz.com'
-        self.anno = annotater.model.Annotation(
+        self.url = u'http://xyz.com'
+        anno = model.Annotation(
                 url=self.url,
-                range='31.0 32.5',
-                note='It is a truth universally acknowledged',
+                range=u'31.0 32.5',
+                note=u'It is a truth universally acknowledged',
                 )
-
-    def teardown_class(cls):
-        annotater.model.Annotation.delete(cls.anno.id)
-
-    def test_1(self):
-        out = annotater.model.Annotation.get(self.anno.id)
+        model.Session.commit()
+        self.anno_id = anno.id
+
+    @classmethod
+    def teardown_class(self):
+        anno = model.Annotation.query.get(self.anno_id)
+        model.Session.delete(anno)
+        model.Session.commit()
+        model.Session.remove()
+
+    def test_0(self):
+        out = model.Annotation.query.get(self.anno_id)
         assert out.url == self.url
 
-    def test_list_annotations_html(self):
-        out = annotater.model.Annotation.list_annotations_html()
-        exp1 = "<Annotation 1 url=u'http://xyz.com'"
-        assert exp1 in out
-
-    def test_list_annotations_atom(self):
-        out = annotater.model.Annotation.list_annotations_atom(self.url)
+    def test_1_list_annotations_html(self):
+        out = model.Annotation.list_annotations_html()
+        exp1 = "Annotation %s http://xyz.com" % self.anno_id
+        assert exp1 in out, out
+
+    def test_2_list_annotations_atom(self):
+        anno = model.Annotation.query.get(self.anno_id)
+        out = model.Annotation.list_annotations_atom(self.url)
         exp1 = '<feed xmlns:ptr="http://www.geof.net/code/annotation/"'
         assert exp1 in out
-        exp2 = '<title>%s</title>' % self.anno.note
+        exp2 = '<title>%s</title>' % anno.note
         assert exp2 in out
-        exp3 = '<link rel="related" type="text/html" title="quote_title_not_available_yet" href="%s"/>' % self.anno.url
+        exp3 = '<link rel="related" type="text/html" title="quote_title_not_available_yet" href="%s"/>' % anno.url
         print out
         assert exp3 in out
 
 
-class TestAnnotationSchema:
-
-    schema = annotater.model.AnnotationSchema()
-
-    def test_default(self):
-        out = self.schema.from_python(None) 
-        assert out == {}
-

annotater/store.py

@@ -11,8 +11,7 @@
 
 from routes import *
 
-# annotater stuff
-import annotater.model
+import annotater.model as model
 
 
 class AnnotaterStore(object):
@@ -74,7 +73,8 @@ def __call__(self, environ, start_response):
         self.path = environ['PATH_INFO']
         self.mapdict = self.map.match(self.path)
         action = self.mapdict['action']
-        self.anno_schema = annotater.model.AnnotationSchema()
+        # TODO: reinstate
+        # self.anno_schema = model.AnnotationSchema()
         if action != 'delete':
             self.query_vals = paste.request.parse_formvars(self.environ)
         else: 
@@ -142,7 +142,7 @@ def index(self):
         response_headers = [ ('Content-type', 'text/html') ]
         result = ''
         if format == 'html':
-            result = annotater.model.Annotation.list_annotations_html()
+            result = model.Annotation.list_annotations_html()
             result = \
 '''<html>
 <head>
@@ -154,7 +154,7 @@ def index(self):
 </html>''' % (result)
         elif format == 'atom':
             response_headers = [ ('Content-type', 'application/xml') ]
-            result = annotater.model.Annotation.list_annotations_atom()
+            result = model.Annotation.list_annotations_atom()
         else:
             status = '500 Internal server error'
             result = 'Unknown format: %s' % format
@@ -186,7 +186,7 @@ def create(self):
         url = self.query_vals.get('url')
         range = self.query_vals.get('range', 'NO RANGE')
         note = self.query_vals.get('note', 'NO NOTE')
-        anno = annotater.model.Annotation(
+        anno = model.Annotation(
                 url=url,
                 range=range,
                 note=note)
@@ -211,7 +211,7 @@ def edit(self):
             self.start_response(status, response_headers)
             msg = '<h1>400 Bad Request</h1><p>No such annotation #%s</p>' % id
             return [msg]
-        anno = annotater.model.Annotation.get(id)
+        anno = model.Annotation.get(id)
         posturl = self.map.generate(controller='annotation',
                 action='update', id=anno.id, method='POST')
         print 'Post url:', posturl
@@ -245,7 +245,7 @@ def update(self):
             # as comes from js need to add in the existing values for to_python
             # this is a bit of a hack but it the easiest way i can think of to
             # merge the values
-            current = annotater.model.Annotation.get(id)
+            current = model.Annotation.get(id)
             current_defaults = self.anno_schema.from_python(current)
             for key in current_defaults.keys():
                 if not new_values.has_key(key):
@@ -269,12 +269,13 @@ def delete(self):
         else:
             status = '204 Deleted'
             try:
-                id = int(id)
-                annotater.model.Annotation.delete(id)
+                model.Annotation.delete(id)
+                response_headers = [ ]
                 self.start_response(status, response_headers)
                 return []
-            except:
+            except Exception, inst:
                 status = '500 Internal server error'
                 self.start_response(status, response_headers)
-                return ['<h1>500 Internal Server Error</h1>Delete failed']
+                return ['<h1>500 Internal Server Error</h1>Delete failed\n %s'%
+                        inst]