WikiUtil moved to WikiService and applied cake pattern to

WikiController.

src/main/scala/app/WikiController.scala

@@ -1,10 +1,14 @@
 package app
 
-import util.{WikiUtil, JGitUtil}
+import service._
+import util.JGitUtil
+import util.Directory._
 import jp.sf.amateras.scalatra.forms._
 import org.eclipse.jgit.api.Git
 
-class WikiController extends ControllerBase {
+class WikiController extends WikiControllerBase with WikiService
+
+trait WikiControllerBase extends ControllerBase { self: WikiService =>
 
   case class WikiPageEditForm(pageName: String, content: String, message: Option[String], currentPageName: String)
   
@@ -26,7 +30,7 @@ class WikiController extends ControllerBase {
     val owner      = params("owner")
     val repository = params("repository")
     
-    WikiUtil.getPage(owner, repository, "Home") match {
+    getWikiPage(owner, repository, "Home") match {
       case Some(page) => wiki.html.wiki("Home", page, 
         JGitUtil.getRepositoryInfo(owner, repository, servletContext))
       case None => wiki.html.wikiedit("Home", None, 
@@ -39,7 +43,7 @@ class WikiController extends ControllerBase {
     val repository = params("repository")
     val pageName   = params("page")
     
-    WikiUtil.getPage(owner, repository, pageName) match {
+    getWikiPage(owner, repository, pageName) match {
       case Some(page) => wiki.html.wiki(pageName, page, 
         JGitUtil.getRepositoryInfo(owner, repository, servletContext))
       case None => wiki.html.wikiedit(pageName, None, 
@@ -52,7 +56,7 @@ class WikiController extends ControllerBase {
     val repository = params("repository")
     val page       = params("page")
     
-    JGitUtil.withGit(WikiUtil.getWikiRepositoryDir(owner, repository)){ git =>
+    JGitUtil.withGit(getWikiRepositoryDir(owner, repository)){ git =>
       wiki.html.wikihistory(Some(page),
         JGitUtil.getCommitLog(git, "master", path = page + ".md")._1,
         JGitUtil.getRepositoryInfo(owner, repository, servletContext))
@@ -65,9 +69,9 @@ class WikiController extends ControllerBase {
     val page       = params("page")
     val commitId   = params("commitId").split("\\.\\.\\.")
     
-    JGitUtil.withGit(WikiUtil.getWikiRepositoryDir(owner, repository)){ git =>
+    JGitUtil.withGit(getWikiRepositoryDir(owner, repository)){ git =>
       wiki.html.wikicompare(Some(page),
-        WikiUtil.getDiffs(git, commitId(0), commitId(1)),
+        getWikiDiffs(git, commitId(0), commitId(1)),
         JGitUtil.getRepositoryInfo(owner, repository, servletContext))
     }
   }
@@ -77,9 +81,9 @@ class WikiController extends ControllerBase {
     val repository = params("repository")
     val commitId   = params("commitId").split("\\.\\.\\.")
     
-    JGitUtil.withGit(WikiUtil.getWikiRepositoryDir(owner, repository)){ git =>
+    JGitUtil.withGit(getWikiRepositoryDir(owner, repository)){ git =>
       wiki.html.wikicompare(None,
-        WikiUtil.getDiffs(git, commitId(0), commitId(1)),
+        getWikiDiffs(git, commitId(0), commitId(1)),
         JGitUtil.getRepositoryInfo(owner, repository, servletContext))
     }
   }
@@ -90,7 +94,7 @@ class WikiController extends ControllerBase {
     val page       = params("page")
     
     wiki.html.wikiedit(page, 
-        WikiUtil.getPage(owner, repository, page), 
+        getWikiPage(owner, repository, page), 
         JGitUtil.getRepositoryInfo(owner, repository, servletContext))
   }
   
@@ -98,7 +102,7 @@ class WikiController extends ControllerBase {
     val owner      = params("owner")
     val repository = params("repository")
     
-    WikiUtil.savePage(owner, repository, form.currentPageName, form.pageName, 
+    saveWikiPage(owner, repository, form.currentPageName, form.pageName, 
         form.content, context.loginUser, form.message.getOrElse(""))
     
     redirect("%s/%s/wiki/%s".format(owner, repository, form.pageName))
@@ -116,7 +120,7 @@ class WikiController extends ControllerBase {
     val owner      = params("owner")
     val repository = params("repository")
     
-    WikiUtil.savePage(owner, repository, form.currentPageName, form.pageName, 
+    saveWikiPage(owner, repository, form.currentPageName, form.pageName, 
         form.content, context.loginUser, form.message.getOrElse(""))
     
     redirect("%s/%s/wiki/%s".format(owner, repository, form.pageName))
@@ -127,7 +131,7 @@ class WikiController extends ControllerBase {
     val repository = params("repository")
     val page       = params("page")
     
-    WikiUtil.deletePage(owner, repository, page, context.loginUser, "Delete %s".format(page))
+    deleteWikiPage(owner, repository, page, context.loginUser, "Delete %s".format(page))
     
     redirect("%s/%s/wiki".format(owner, repository))
   }
@@ -136,7 +140,7 @@ class WikiController extends ControllerBase {
     val owner      = params("owner")
     val repository = params("repository")
     
-    wiki.html.wikipages(WikiUtil.getPageList(owner, repository), 
+    wiki.html.wikipages(getWikiPageList(owner, repository), 
         JGitUtil.getRepositoryInfo(owner, repository, servletContext))
   }
   
@@ -144,7 +148,7 @@ class WikiController extends ControllerBase {
     val owner      = params("owner")
     val repository = params("repository")
     
-    JGitUtil.withGit(WikiUtil.getWikiRepositoryDir(owner, repository)){ git =>
+    JGitUtil.withGit(getWikiRepositoryDir(owner, repository)){ git =>
       wiki.html.wikihistory(None,
         JGitUtil.getCommitLog(git, "master")._1, 
         JGitUtil.getRepositoryInfo(owner, repository, servletContext))
@@ -174,7 +178,7 @@ class WikiController extends ControllerBase {
   
   def unique: Constraint = new Constraint(){
     def validate(name: String, value: String): Option[String] = {
-      if(WikiUtil.getPageList(params("owner"), params("repository")).contains(value)){
+      if(getWikiPageList(params("owner"), params("repository")).contains(value)){
         Some("Page already exists.")
       } else {
         None

src/main/scala/service/WikiService.scala

@@ -1,18 +1,19 @@
-package util
+package service
 
 import java.io.File
 import java.util.Date
 import org.eclipse.jgit.api.Git
 import org.apache.commons.io.FileUtils
-import org.eclipse.jgit.lib.RepositoryBuilder
 import app.DiffInfo
+import util.{Directory, JGitUtil}
+import org.eclipse.jgit.lib.RepositoryBuilder
 import org.eclipse.jgit.treewalk.CanonicalTreeParser
-import org.eclipse.jgit.revwalk.RevCommit
 import org.eclipse.jgit.treewalk.TreeWalk
+import org.eclipse.jgit.revwalk.RevCommit
 import org.eclipse.jgit.revwalk.RevWalk
 import org.eclipse.jgit.diff.DiffEntry.ChangeType
 
-object WikiUtil {
+object WikiService {
   
   /**
    * The model for wiki page.
@@ -34,26 +35,32 @@ object WikiUtil {
    */
   case class WikiPageHistoryInfo(name: String, committer: String, message: String, date: Date)
   
-  /**
+}
-   * Returns the directory of the wiki repository.
-   */
-  def getWikiRepositoryDir(owner: String, repository: String): File =
-    new File("%s/%s/%s.wiki.git".format(Directory.RepositoryHome, owner, repository))
 
-  /**
+trait WikiService {
-   * Returns the directory of the wiki working directory which is cloned from the wiki repository.
+  
-   */
+  import WikiService._
-  def getWikiWorkDir(owner: String, repository: String): File = 
+  
-    new File("%s/tmp/%s/%s.wiki".format(Directory.GitBucketHome, owner, repository))
+//  /**
+//   * Returns the directory of the wiki repository.
+//   */
+//  def getWikiRepositoryDir(owner: String, repository: String): File =
+//    new File("%s/%s/%s.wiki.git".format(Directory.RepositoryHome, owner, repository))
+//  
+//  /**
+//   * Returns the directory of the wiki working directory which is cloned from the wiki repository.
+//   */
+//  def getWikiWorkDir(owner: String, repository: String): File = 
+//    new File("%s/tmp/%s/%s.wiki".format(Directory.GitBucketHome, owner, repository))
 
   // TODO synchronized?
   def createWikiRepository(owner: String, repository: String): Unit = {
-    val dir = getWikiRepositoryDir(owner, repository)
+    val dir = Directory.getWikiRepositoryDir(owner, repository)
     if(!dir.exists){
       val repo = new RepositoryBuilder().setGitDir(dir).setBare.build
       try {
         repo.create
-        savePage(owner, repository, "Home", "Home", "Welcome to the %s wiki!!".format(repository), owner, "Initial Commit")
+        saveWikiPage(owner, repository, "Home", "Home", "Welcome to the %s wiki!!".format(repository), owner, "Initial Commit")
       } finally {
         repo.close
       }
@@ -63,11 +70,11 @@ object WikiUtil {
   /**
    * Returns the wiki page.
    */
-  def getPage(owner: String, repository: String, pageName: String): Option[WikiPageInfo] = {
+  def getWikiPage(owner: String, repository: String, pageName: String): Option[WikiPageInfo] = {
     // TODO create wiki repository in the repository setting changing.
     createWikiRepository(owner, repository)
     
-    JGitUtil.withGit(getWikiRepositoryDir(owner, repository)){ git =>
+    JGitUtil.withGit(Directory.getWikiRepositoryDir(owner, repository)){ git =>
       try {
         JGitUtil.getFileList(git, "master", ".").find(_.name == pageName + ".md").map { file =>
           WikiPageInfo(file.name, new String(git.getRepository.open(file.id).getBytes, "UTF-8"), file.committer, file.time)
@@ -79,8 +86,8 @@ object WikiUtil {
     }
   }
   
-  def getPageList(owner: String, repository: String): List[String] = {
+  def getWikiPageList(owner: String, repository: String): List[String] = {
-    JGitUtil.getFileList(Git.open(getWikiRepositoryDir(owner, repository)), "master", ".")
+    JGitUtil.getFileList(Git.open(Directory.getWikiRepositoryDir(owner, repository)), "master", ".")
       .filter(_.name.endsWith(".md"))
       .map(_.name.replaceFirst("\\.md$", ""))
       .sortBy(x => x)
@@ -90,17 +97,20 @@ object WikiUtil {
   /**
    * Save the wiki page.
    */
-  def savePage(owner: String, repository: String, currentPageName: String, newPageName: String,
+  def saveWikiPage(owner: String, repository: String, currentPageName: String, newPageName: String,
       content: String, committer: String, message: String): Unit = {
     
     // TODO create wiki repository in the repository setting changing.
     createWikiRepository(owner, repository)
     
-    val workDir = getWikiWorkDir(owner, repository)
+    val workDir = Directory.getWikiWorkDir(owner, repository)
     
     // clone
     if(!workDir.exists){
-      Git.cloneRepository.setURI(getWikiRepositoryDir(owner, repository).toURI.toString).setDirectory(workDir).call
+      Git.cloneRepository
+        .setURI(Directory.getWikiRepositoryDir(owner, repository).toURI.toString)
+        .setDirectory(workDir)
+        .call
     }
     
     // write as file
@@ -134,15 +144,18 @@ object WikiUtil {
   /**
    * Delete the wiki page.
    */
-  def deletePage(owner: String, repository: String, pageName: String, committer: String, message: String): Unit = {
+  def deleteWikiPage(owner: String, repository: String, pageName: String, committer: String, message: String): Unit = {
     // TODO create wiki repository in the repository setting changing.
     createWikiRepository(owner, repository)
     
-    val workDir = getWikiWorkDir(owner, repository)
+    val workDir = Directory.getWikiWorkDir(owner, repository)
     
     // clone
     if(!workDir.exists){
-      Git.cloneRepository.setURI(getWikiRepositoryDir(owner, repository).toURI.toString).setDirectory(workDir).call
+      Git.cloneRepository
+        .setURI(Directory.getWikiRepositoryDir(owner, repository).toURI.toString)
+        .setDirectory(workDir)
+        .call
     }
     
     // delete file
@@ -158,7 +171,7 @@ object WikiUtil {
     }
   }
   
-  def getDiffs(git: Git, commitId1: String, commitId2: String): List[DiffInfo] = {
+  def getWikiDiffs(git: Git, commitId1: String, commitId2: String): List[DiffInfo] = {
       // get diff between specified commit and its previous commit
       val reader = git.getRepository.newObjectReader
       
@@ -175,5 +188,4 @@ object WikiUtil {
             JGitUtil.getContent(git, diff.getNewId.toObjectId, false).map(new String(_, "UTF-8")))
       }.toList
   }   
-  
 }

src/main/scala/util/Directory.scala

@@ -47,4 +47,16 @@ object Directory {
   def getInitRepositoryDir(owner: String, repository: String): File =
     new File("%s/tmp/%s/init-%s".format(GitBucketHome, owner, repository))
   
+  /**
+   * Substance directory of the wiki repository.
+   */
+  def getWikiRepositoryDir(owner: String, repository: String): File =
+    new File("%s/%s/%s.wiki.git".format(Directory.RepositoryHome, owner, repository))
+  
+  /**
+   * Wiki working directory which is cloned from the wiki repository.
+   */
+  def getWikiWorkDir(owner: String, repository: String): File = 
+    new File("%s/tmp/%s/%s.wiki".format(Directory.GitBucketHome, owner, repository))
+  
 }

src/main/twirl/wiki/wiki.scala.html

@@ -1,4 +1,4 @@
-@(pageName: String, page: util.WikiUtil.WikiPageInfo, repository: app.RepositoryInfo)(implicit context: app.Context)
+@(pageName: String, page: service.WikiService.WikiPageInfo, repository: app.RepositoryInfo)(implicit context: app.Context)
 @import view.helpers
 @import context._
 @html.main(pageName + " - " + repository.owner + "/" + repository.name){

src/main/twirl/wiki/wikiedit.scala.html

@@ -1,4 +1,4 @@
-@(pageName: String, page: Option[util.WikiUtil.WikiPageInfo], repository: app.RepositoryInfo)(implicit context: app.Context)
+@(pageName: String, page: Option[service.WikiService.WikiPageInfo], repository: app.RepositoryInfo)(implicit context: app.Context)
 @import view.helpers
 @import context._
 @html.main((if(pageName == "") "New Page" else pageName) + " - " + repository.owner + "/" + repository.name){