Make compatible with Trac 1.2

Author: rjollos

HACKING

@@ -4,7 +4,7 @@ YOU WANT TO CONTRIBUTE BUT YOU DON'T KNOW HOW? NO MORE SUCH EXCUSES
 
 In most cases this can be done via easy_install:
 
-	 # easy_install Trac==0.12
+	 # easy_install Trac==1.2
 
 If you run into problems, see Trac documentation [1][2].
 
@@ -42,7 +42,7 @@ repository_type = svn
 Remember the file location.
 
 6. Add yourself as admin:
- 
+
 	$ trac-admin <trac-name> permission add <username> TRAC_ADMIN
 
 6. Run trac server:
@@ -67,7 +67,7 @@ You should now have a working vanilla Trac at http://localhost:8000/, where you
 
 # Footnotes
 
-[1] http://trac.edgewall.org/wiki/0.12/TracInstall
+[1] http://trac.edgewall.org/wiki/1.2/TracInstall
 [2] http://trac.edgewall.org/wiki/TracDev/DevelopmentEnvironmentSetup
 [3] http://trac.edgewall.org/wiki/TracSubversion#GettingSubversion
-[4] http://stackoverflow.com/questions/14538468/how-to-install-python-subversion-bindings-needed-by-hg-convert-on-mac-os-x-10-8/16950786#16950786
+[4] http://stackoverflow.com/questions/14538468/how-to-install-python-subversion-bindings-needed-by-hg-convert-on-mac-os-x-10-8/16950786#16950786

README.md

@@ -28,7 +28,7 @@ Alternatively build your own egg by checking out the repository and running
 `python setup.py bdist_egg` in your working copy. Copy the resultant .egg to
 your `plugins` directory.
 
-Trac Code Comments plugin requres at least python 2.4 and runs on Trac 0.12.
+Trac Code Comments plugin requires at least Trac 1.2.
 
 Enable all the modules through the admin web UI or by editing `trac.ini`.
 

code_comments/comment.py

@@ -21,7 +21,7 @@ def md5_hexdigest(s):
 VERSION = 1
 
 
-class Comment:
+class Comment(object):
     columns = [column.name for column in db.schema['code_comments'].columns]
 
     required = 'text', 'author'
@@ -101,7 +101,7 @@ def link_text(self):
 
     def changeset_link_text(self):
         if 0 != self.line:
-            return 'Changeset @%d#L%d (in %s)' % (self.revision, self.line,
+            return 'Changeset @%s#L%d (in %s)' % (self.revision, self.line,
                                                   self.path)
         else:
             return 'Changeset @%s' % self.revision
@@ -142,25 +142,17 @@ def get_ticket_relations(self):
               VALUE LIKE '%%,%(comment_id)d' OR
               VALUE LIKE '%%,%(comment_id)d,%%')
             """ % {'comment_id': self.id}
-        result = {}
-
-        @self.env.with_transaction()
-        def get_ticket_ids(db):
-            cursor = db.cursor()
-            cursor.execute(query)
-            result['tickets'] = cursor.fetchall()
-        return set([int(row[0]) for row in result['tickets']])
+        return set([int(row[0]) for row in self.env.db_query(query)])
 
     def get_ticket_links(self):
         relations = self.get_ticket_relations()
         links = ['[[ticket:%s]]' % relation for relation in relations]
         return format_to_html(self.req, self.env, ', '.join(links))
 
     def delete(self):
-        @self.env.with_transaction()
-        def delete_comment(db):
-            cursor = db.cursor()
-            cursor.execute("DELETE FROM code_comments WHERE id=%s", [self.id])
+        self.env.db_transaction("""
+            DELETE FROM code_comments WHERE id=%s
+            """, (self.id,))
 
 
 class CommentJSONEncoder(json.JSONEncoder):

code_comments/comments.py

@@ -7,7 +7,7 @@
 from code_comments.comment import Comment
 
 
-class Comments:
+class Comments(object):
 
     FILTER_MAX_PATH_DEPTH = 2
 
@@ -39,14 +39,8 @@ def get_all_comment_authors(self, comments):
         return sorted(list(set([comment.author for comment in comments])))
 
     def select(self, *query):
-        result = {}
-
-        @self.env.with_transaction()
-        def get_comments(db):
-            cursor = db.cursor()
-            cursor.execute(*query)
-            result['comments'] = cursor.fetchall()
-        return [self.comment_from_row(row) for row in result['comments']]
+        return [self.comment_from_row(row)
+                for row in self.env.db_query(*query)]
 
     def count(self, args={}):
         conditions_str, values = \
@@ -57,11 +51,9 @@ def count(self, args={}):
         query = 'SELECT COUNT(*) FROM code_comments ' + where
         result = {}
 
-        @self.env.with_transaction()
-        def get_comment_count(db):
-            cursor = db.cursor()
-            cursor.execute(query, values)
-            result['count'] = cursor.fetchone()[0]
+        for count, in self.env.db_query(query, values):
+            result['count'] = count
+
         return result['count']
 
     def all(self):
@@ -131,14 +123,12 @@ def create(self, args):
         values = [getattr(comment, n) for n in column_names_to_insert]
         comment_id = [None]
 
-        @self.env.with_transaction()
-        def insert_comment(db):
+        with self.env.db_transaction as db:
             cursor = db.cursor()
-            sql = """
+            cursor.execute("""
                 INSERT INTO code_comments (%s) VALUES(%s)
                 """ % (', '.join(column_names_to_insert),
-                       ', '.join(['%s'] * len(values)))
-            cursor.execute(sql, values)
+                       ', '.join(['%s'] * len(values))), values)
             comment_id[0] = db.get_last_id(cursor, 'code_comments')
 
         CodeCommentSystem(self.env).comment_created(

code_comments/db.py

@@ -7,6 +7,7 @@
 
 # Database version identifier for upgrades.
 db_version = 3
+db_version_key = 'code_comments_schema_version'
 
 # Database schema
 schema = {
@@ -30,7 +31,6 @@
         Column('user'),
         Column('type'),
         Column('path'),
-        Column('repos'),
         Column('rev'),
         Column('notify', type='bool'),
         Index(['user']),
@@ -39,48 +39,24 @@
 }
 
 
-def to_sql(env, table):
-    """ Convenience function to get the to_sql for the active connector."""
-    dc = DatabaseManager(env)._get_connector()[0]
-    return dc.to_sql(table)
-
-
-def create_tables(env, db):
-    cursor = db.cursor()
-    for table_name in schema:
-        for stmt in to_sql(env, schema[table_name]):
-            cursor.execute(stmt)
-    cursor.execute(
-        "INSERT INTO system VALUES ('code_comments_schema_version', %s)",
-        str(db_version))
-
-
 # Upgrades
 
-def upgrade_from_1_to_2(env, db):
-    # Add the new column "type"
-    @env.with_transaction()
-    def add_type_column(db):
-        cursor = db.cursor()
-        cursor.execute('ALTER TABLE code_comments ADD COLUMN type TEXT')
-
-    # Convert all the current comments to the new schema
-    @env.with_transaction()
-    def convert_comments(db):
-        comments = {}
-        cursor = db.cursor()
-        cursor.execute('SELECT id, path FROM code_comments')
-        comments = cursor.fetchall()
+def upgrade_from_1_to_2(env):
+    with env.db_transaction as db:
+        # Add the new column "type"
+        db('ALTER TABLE code_comments ADD COLUMN type TEXT')
+        # Convert all the current comments to the new schema
         # options:
         # 1: comment on file (path != "" && path != "attachment")
         # 2: comment on changeset (path == "")
         # 3: comment on attachment (path == "attachment")
-        for comment in comments:
+        for comment in db("""
+                SELECT id, path FROM code_comments
+                """):
             path = comment[1]
             is_comment_to_attachment = path.startswith('attachment')
             is_comment_to_file = not is_comment_to_attachment and '' != path
             is_comment_to_changeset = '' == path
-            cursor = db.cursor()
             update = 'UPDATE code_comments SET type={0} WHERE id={1}'
             sql = ''
 
@@ -91,16 +67,13 @@ def convert_comments(db):
             elif is_comment_to_file:
                 sql = update.format("'browser'", str(comment[0]))
 
-            cursor.execute(sql)
+            db(sql)
 
 
-def upgrade_from_2_to_3(env, db):
+def upgrade_from_2_to_3(env):
     # Add the new table
-    @env.with_transaction()
-    def add_subscriptions_table(db):
-        cursor = db.cursor()
-        for stmt in to_sql(env, schema['code_comments_subscriptions']):
-            cursor.execute(stmt)
+    dbm = DatabaseManager(env)
+    dbm.create_tables((schema['code_comments_subscriptions'],))
 
 
 upgrade_map = {
@@ -118,40 +91,25 @@ def environment_created(self):
         """Called when a new Trac environment is created."""
         pass
 
-    def environment_needs_upgrade(self, db):
+    def environment_needs_upgrade(self):
         """
         Called when Trac checks whether the environment needs to be upgraded.
         Returns `True` if upgrade is needed, `False` otherwise.
         """
-        return self._get_version(db) != db_version
+        dbm = DatabaseManager(self.env)
+        return dbm.get_database_version(db_version_key) != db_version
 
-    def upgrade_environment(self, db):
+    def upgrade_environment(self):
         """
         Actually perform an environment upgrade, but don't commit as
         that is done by the common upgrade procedure when all plugins are done.
         """
-        current_ver = self._get_version(db)
+        dbm = DatabaseManager(self.env)
+        current_ver = dbm.get_database_version(db_version_key)
         if current_ver == 0:
-            create_tables(self.env, db)
+            dbm.create_tables(schema.values())
         else:
             while current_ver + 1 <= db_version:
-                upgrade_map[current_ver + 1](self.env, db)
+                upgrade_map[current_ver + 1](self.env)
                 current_ver += 1
-            cursor = db.cursor()
-            cursor.execute("""
-                UPDATE system SET value=%s
-                WHERE name='code_comments_schema_version'
-                """, str(db_version))
-
-    def _get_version(self, db):
-        cursor = db.cursor()
-        try:
-            cursor.execute("""
-                SELECT value FROM system
-                WHERE name='code_comments_schema_version'
-                """)
-            for row in cursor:
-                return int(row[0])
-            return 0
-        except:
-            return 0
+        dbm.set_database_version(db_version, db_version_key)

code_comments/htdocs/code-comments.js

@@ -29,7 +29,7 @@ var underscore = _.noConflict();
 		defaultFetchParams: {
 			path: CodeComments.path || undefined,
 			revision: CodeComments.revision,
-			type: CodeComments.page
+			type: CodeComments.page,
 		},
 		fetchPageComments: function() {
 			return this.fetch( { data: _.extend( { line: 0 }, this.defaultFetchParams ) } );
@@ -213,7 +213,14 @@ var underscore = _.noConflict();
 				},
 				wait: true
 			};
-			this.collection.create({text: text, author: CodeComments.username, path: this.path, revision: CodeComments.revision, line: line, type: CodeComments.page}, options);
+			this.collection.create({
+				text: text,
+				author: CodeComments.username,
+				path: this.path,
+				revision: CodeComments.revision,
+				line: line,
+				type: CodeComments.page
+			}, options);
 		},
 		previewThrottled: $.throttle(1500, function(e) { return this.preview(e); }),
 		preview: function(e) {
@@ -326,7 +333,9 @@ var underscore = _.noConflict();
 		initialize: function(){
 			_.bindAll(this, "render");
 			this.model.listenTo(this.model, 'change', this.render);
-			this.model.url = $(this.$el).data('baseUrl') + '/subscription' + $(this.$el).data('path');
+			var rev = $(this.$el).data('rev');
+			this.model.url = $(this.$el).data('baseUrl') + '/subscription' +
+				$(this.$el).data('path') + (rev ? '?rev=' + rev : '');
 			this.render();
 		},
 
@@ -341,7 +350,7 @@ var underscore = _.noConflict();
 					label: 'Unsubscribe',
 					icons: {primary: 'ui-icon-check'}
 				};
-			    var title = 'You receive notifications for comments';
+				var title = 'You receive notifications for comments';
 			} else {
 				var options = {
 					disabled: false,
@@ -364,7 +373,7 @@ var underscore = _.noConflict();
 
 	window.subscription = new Subscription();
 	window.subscriptionView = new SubscriptionView({model: subscription});
-    if (subscriptionView.el) {
-        subscription.fetch();
-    }
+	if (subscriptionView.el) {
+		subscription.fetch();
+	}
 }); }( jQuery.noConflict( true ) ) );