{"id":1259,"date":"2010-04-30T19:25:04","date_gmt":"2010-05-01T00:25:04","guid":{"rendered":"http:\/\/mikeconley.ca\/blog\/?p=1259"},"modified":"2023-12-20T16:25:17","modified_gmt":"2023-12-20T21:25:17","slug":"code-spelunking-review-board-extensions-2","status":"publish","type":"post","link":"https:\/\/mikeconley.ca\/blog\/2010\/04\/30\/code-spelunking-review-board-extensions-2\/","title":{"rendered":"Code Spelunking: Review Board Extensions"},"content":{"rendered":"

So this summer, I’m working on Review Board for the Google Summer of Code.<\/a><\/p>\n

Until my GSoC acceptance, my romps into the code had been relatively shallow. \u00a0But with my proposal being given the green light, I’ve started doing more extensive explorations.<\/p>\n

Review Board is built using the Django web framework<\/a>. \u00a0I haven’t worked with Django before, but I have quite a bit of experience with Rails, so that should be an asset. \u00a0Using a web framework means having (relatively) predictable source code layout, and Review Board is no exception.<\/p>\n

Djblets<\/h4>\n

At one point or another, the Review Board developers realized that a lot of their code wasn’t Review Board specific, and could be abstracted out into an external library.<\/p>\n

That library is called Djblets<\/a>.<\/p>\n

Among other things, Djblets adds a DataGrid component for easy record sorting and pagination. \u00a0There are improvements to Django’s Authentication system. \u00a0Functions for easily displaying a user’s Gravatar<\/a>.<\/p>\n

And, low and behold, there is a branch of Djblets that provides classes and functions for giving a Django application an extension framework. \u00a0The classes are abstract enough so that, in your Django application, you can specify different types and behaviours for your Hooks.<\/p>\n

Djblets -> Review Board<\/h4>\n

The Review Board extension branch takes these Djblets extension classes, and extends them into DashboardHooks, NavigationBarHooks, ReviewRequestDetailHooks…lots of different hooks.<\/p>\n

So, Djblets creates the foundation abstractions. \u00a0Review Board makes these abstractions a little more specific. \u00a0And then an extension writer needs to instantiate and use these classes to design their extensions. \u00a0It sounds complicated, I know.<\/p>\n

So Let’s Map It Out<\/h4>\n

When I start learning a new code base, I do a lot of drawing. \u00a0To me, getting to now a code base is like getting to know a city, and that means walking around it, and mapping it out.<\/p>\n

So I’ve taken the liberty of mapping out the extension classes that I’ve found, and how they relate to one another. \u00a0Note that at the bottom of my map, a simple extension (RB Reports) is using some of those classes to hook itself into Review Board. \u00a0You can find this, and other extensions,here<\/a>.<\/p>\n

\"My<\/a>

Click here to check out my map of the current state of the extension framework<\/p><\/div>\n

Now, before someone in the department starts complaining about my misuse of UML: \u00a0I’m not a UML guy. \u00a0I just wanted an easy piece of diagramming software, and the one that I found (Dia<\/a>), did UML. \u00a0I just wanted something to draw boxes and lines. So please don’t freak out if you think I’m using the wrong symbols.<\/p>\n

One symbol you might be wondering about is the blue quantum-flux-capacitor-implosion.<\/p>\n

I’ll save that for a future post.<\/p>\n","protected":false},"excerpt":{"rendered":"

So this summer, I’m working on Review Board for the Google Summer of Code. Until my GSoC acceptance, my romps into the code had been relatively shallow. \u00a0But with my proposal being given the green light, I’ve started doing more extensive explorations. Review Board is built using the Django web framework. \u00a0I haven’t worked with […]<\/p>\n","protected":false},"author":4,"featured_media":0,"comment_status":"open","ping_status":"open","sticky":false,"template":"","format":"standard","meta":{"jetpack_post_was_ever_published":false,"_jetpack_newsletter_access":"","_jetpack_dont_email_post_to_subs":false,"_jetpack_newsletter_tier_id":0,"_jetpack_memberships_contains_paywalled_content":false,"_jetpack_memberships_contains_paid_content":false,"footnotes":"","jetpack_publicize_message":"","jetpack_publicize_feature_enabled":true,"jetpack_social_post_already_shared":false,"jetpack_social_options":{"image_generator_settings":{"template":"highway","default_image_id":0,"font":"","enabled":false},"version":2}},"categories":[657,773,1],"tags":[558,663,131,1219],"class_list":["post-1259","post","type-post","status-publish","format-standard","hentry","category-extensions-review-board-code-reviews-computer-science-technology","category-gsoc-computer-science","category-uncategorized","tag-code-spelunking","tag-djblets","tag-extensions","tag-review-board"],"jetpack_publicize_connections":[],"jetpack_featured_media_url":"","jetpack_shortlink":"https:\/\/wp.me\/prmTy-kj","jetpack_sharing_enabled":true,"_links":{"self":[{"href":"https:\/\/mikeconley.ca\/blog\/wp-json\/wp\/v2\/posts\/1259","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/mikeconley.ca\/blog\/wp-json\/wp\/v2\/posts"}],"about":[{"href":"https:\/\/mikeconley.ca\/blog\/wp-json\/wp\/v2\/types\/post"}],"author":[{"embeddable":true,"href":"https:\/\/mikeconley.ca\/blog\/wp-json\/wp\/v2\/users\/4"}],"replies":[{"embeddable":true,"href":"https:\/\/mikeconley.ca\/blog\/wp-json\/wp\/v2\/comments?post=1259"}],"version-history":[{"count":7,"href":"https:\/\/mikeconley.ca\/blog\/wp-json\/wp\/v2\/posts\/1259\/revisions"}],"predecessor-version":[{"id":1284,"href":"https:\/\/mikeconley.ca\/blog\/wp-json\/wp\/v2\/posts\/1259\/revisions\/1284"}],"wp:attachment":[{"href":"https:\/\/mikeconley.ca\/blog\/wp-json\/wp\/v2\/media?parent=1259"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/mikeconley.ca\/blog\/wp-json\/wp\/v2\/categories?post=1259"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/mikeconley.ca\/blog\/wp-json\/wp\/v2\/tags?post=1259"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}