Merge lp:~coopebm1/sloecode/add-wiki-branch into lp:sloecode/wiki

[Brendan Cooper]

Creates a wiki folder and wiki page.

[Thomi Richards (thomir-deactivatedaccount)]

Hi,

Sorry for the delay here - I intended to do this last week, but I completely forgot about it.

I'd like you to make some changes to this branch. There are two main things that need fixing:

1) You have duplicated code. In your branch, factory.py lines 72 - 100 look like this:

    def create_shared_repository_for_project(self, project_name):
        """Create a repository for the project with a trunk branch."""
        dir_name = self.get_project_repo_dir(project_name)
        repo = create_shared_repo(dir_name)
        # Now to create the trunk.
        try:
            to_transport = repo.user_transport.clone('trunk')
        except AttributeError:
            # Fixes lp:948483 bzrlib version 2.1 (which is current in debian
            # squeeze) uses a different name for this:
            to_transport = repo._transport.clone('trunk')
        format = bzrdir.format_registry.make_bzrdir('default')
        branch = bzrdir.BzrDir.create_branch_convenience(
            to_transport.base, format=format,
            possible_transports=[to_transport])
        branch.set_append_revisions_only(True)

        # Trying to create a wiki branch (at this stage, identical to trunk)
        try:
            to_transport = repo.user_transport.clone('wiki')
        except AttributeError:
            # Fixes lp:948483 bzrlib version 2.1 (which is current in debian
            # squeeze) uses a different name for this:
            to_transport = repo._transport.clone('wiki')
        format = bzrdir.format_registry.make_bzrdir('default')
        branch = bzrdir.BzrDir.create_branch_convenience(
            to_transport.base, format=format,
            possible_transports=[to_transport])
        branch.set_append_revisions_only(True)

Repeated code is almost always a bad thing. The code to create the branch should be put into a method of it's own, something like this:

def create_branch_on_repository(self, repo, branch_name):
        try:
            to_transport = repo.user_transport.clone(branch_name)
        except AttributeError:
            # Fixes lp:948483 bzrlib version 2.1 (which is current in debian
            # squeeze) uses a different name for this:
            to_transport = repo._transport.clone('wiki')
        format = bzrdir.format_registry.make_bzrdir('default')
        branch = bzrdir.BzrDir.create_branch_convenience(
            to_transport.base, format=format,
            possible_transports=[to_transport])
        branch.set_append_revisions_only(True)

...which leads me to my next point: the name of the method is 'create_shared_repository_for_project'. However, what we're actually doing is creating a shared repository AND some branches. I'd be happier if the 'create_shared_repository_for_project' method only created a shared repository, and calling code then called the new "create_branch_on_repository" method as well, in order to create any branches that are needed. One advantage of this is that we can enable or disable the creation of the wiki branch in the web-app code, which is where it belongs. Finally, making methods (and classes, for that matter) as small as possible makes them much easier to test - which leads me nicely to...

review: Needs Fixing

[lp:~coopebm1/sloecode/add-wiki-branch]

152. By Brendan Cooper on 2012-04-19

Seperated Repo and branch creation

Unmerged revisions

152. By Brendan Cooper on 2012-04-19

Seperated Repo and branch creation

151. By Sam Bailey on 2012-03-29

Wiki branch is created with new project alongside trunk

150. By Sam Bailey on 2012-03-29

project information passed correctly

149. By Sam Bailey on 2012-03-28

forgot to add project-wiki.html

148. By Sam Bailey on 2012-03-28

Re-directing /p/<name>/wiki to project-wiki.html

=== modified file 'sloecode/bzr/factory.py'
--- sloecode/bzr/factory.py	2012-03-07 01:26:25 +0000
+++ sloecode/bzr/factory.py	2012-04-19 00:27:18 +0000
@@ -73,18 +73,22 @@
         """Create a repository for the project with a trunk branch."""
         dir_name = self.get_project_repo_dir(project_name)
         repo = create_shared_repo(dir_name)
-        # Now to create the trunk.
+        return repo
+       
+
+    def create_branch_on_repository (self,repo,branch_name):
+        """Create a branch for the project """
         try:
-            to_transport = repo.user_transport.clone('trunk')
+            to_transport = repo.user_transport.clone(branch_name)
         except AttributeError:
             # Fixes lp:948483 bzrlib version 2.1 (which is current in debian
             # squeeze) uses a different name for this:
-            to_transport = repo._transport.clone('trunk')
+            to_transport = repo._transport.clone(branch_name)
         format = bzrdir.format_registry.make_bzrdir('default')
         branch = bzrdir.BzrDir.create_branch_convenience(
             to_transport.base, format=format,
             possible_transports=[to_transport])
-        branch.set_append_revisions_only(True)
+        branch.set_append_revisions_only(True)    
 
     def get_repository_for_project(self, project_name):
         """Get a bzrlib.repository.Repository object for a given project

=== modified file 'sloecode/controllers/admin/project.py'
--- sloecode/controllers/admin/project.py	2011-10-23 20:23:56 +0000
+++ sloecode/controllers/admin/project.py	2012-04-19 00:27:18 +0000
@@ -59,8 +59,11 @@
         Session.commit()
         h.flash("Project Added Successfully")
         # Create a shared repo for the project.
-        config['bzr.factory'].create_shared_repository_for_project(
+        repo = config['bzr.factory'].create_shared_repository_for_project(
             new_project.name)
+        config['bzr.factory'].create_branch_on_repository (repo,'trunk')
+        config['bzr.factory'].create_branch_on_repository (repo,'wiki')
+
         return redirect(h.url(controller='admin/project', action='retrieve'))
 
     def retrieve(self):

=== modified file 'sloecode/controllers/project.py'
--- sloecode/controllers/project.py	2012-03-07 03:36:35 +0000
+++ sloecode/controllers/project.py	2012-04-19 00:27:18 +0000
@@ -141,3 +141,16 @@
 
         return redirect(h.url(controller='project', action='index',
                                 project_name=project_name))
+
+    @ActionProtector(Any(has_site_role(PROJECT_ADMIN), has_project_write_access()))
+    def wiki(self, project_name):
+    	"""
+    	Render the wiki for the project
+    	"""
+        projects = Project.get(name=project_name)
+        existing_project = projects[0] if projects else None
+
+        if existing_project is None:
+            abort(404)
+        else:
+            return self.render('/project-wiki.html', {'project': existing_project})

=== added file 'sloecode/templates/project-wiki.html'
--- sloecode/templates/project-wiki.html	1970-01-01 00:00:00 +0000
+++ sloecode/templates/project-wiki.html	2012-04-19 00:27:18 +0000
@@ -0,0 +1,10 @@
+{% extends "base.html" %}
+
+{% block title %} Wiki {% endblock %}
+
+{% block content %}
+This is a wiki<br>
+This is the project's name: {{project.name}}<br>
+This is the project's display name: {{project.displayname}}<br>
+This is the project's description: {{project.description}}<br>
+{% endblock %}