Merge pull request #111 from kitoranaoki/rename-trait

rename trait. Permission -> Role
t2v · Dec 5, 2014 · 04cff40 · 04cff40
2 parents 5b742e0 + fdaa66c
commit 04cff40
Show file tree

Hide file tree

Showing 12 changed files with 44 additions and 44 deletions.
diff --git a/README.ja.md b/README.ja.md
@@ -91,11 +91,11 @@ For example: `Build.scala`
        * 認可(権限チェック)を行う際に、アクション毎に設定するオブジェクトの型です。
        * このサンプルでは例として以下のような trait を使用しています。
        *
-       * sealed trait Permission
-       * case object Administrator extends Permission
-       * case object NormalUser extends Permission
+       * sealed trait Role
+       * case object Administrator extends Role
+       * case object NormalUser extends Role
        */
-      type Authority = Permission
+      type Authority = Role
 
       /**
        * CacheからユーザIDを取り出すための ClassTag です。
@@ -143,7 +143,7 @@ For example: `Build.scala`
        * 任意の処理を記述してください。
        */
       def authorize(user: User, authority: Authority)(implicit ctx: ExecutionContext): Future[Boolean] = Future.successful {
-        (user.permission, authority) match {
+        (user.role, authority) match {
           case (Administrator, _) => true
           case (NormalUser, NormalUser) => true
           case _ => false
@@ -733,7 +733,7 @@ Play2 の現在の仕組みではできません。
 
         アカウントは以下の3アカウントが登録されています。
 
-            Email             | Password | Permission
+            Email             | Password | Role
             [email protected] | secret   | Administrator
             [email protected]   | secret   | NormalUser
             [email protected] | secret   | NormalUser

diff --git a/README.md b/README.md
@@ -98,11 +98,11 @@ Usage
        * A type that is defined by every action for authorization.
        * This sample uses the following trait:
        *
-       * sealed trait Permission
-       * case object Administrator extends Permission
-       * case object NormalUser extends Permission
+       * sealed trait Role
+       * case object Administrator extends Role
+       * case object NormalUser extends Role
        */
-      type Authority = Permission
+      type Authority = Role
 
       /**
        * A `ClassTag` is used to retrieve an id from the Cache API.
@@ -150,7 +150,7 @@ Usage
        * You should alter this procedure to suit your application.
        */
       def authorize(user: User, authority: Authority)(implicit ctx: ExecutionContext): Future[Boolean] = Future.successful {
-        (user.permission, authority) match {
+        (user.role, authority) match {
           case (Administrator, _)       => true
           case (NormalUser, NormalUser) => true
           case _                        => false
@@ -532,7 +532,7 @@ Running The Sample Application
 
         defined accounts
 
-            Email             | Password | Permission
+            Email             | Password | Role
             [email protected] | secret   | Administrator
             [email protected]   | secret   | NormalUser
             [email protected] | secret   | NormalUser

diff --git a/sample/app/Global.scala b/sample/app/Global.scala
@@ -1,7 +1,7 @@
 import play.api._
 
 import jp.t2v.lab.play2.auth.sample._
-import jp.t2v.lab.play2.auth.sample.Permission._
+import jp.t2v.lab.play2.auth.sample.Role._
 import scalikejdbc._
 
 object Global extends GlobalSettings {
@@ -17,4 +17,4 @@ object Global extends GlobalSettings {
 
   }
 
-}
+}
diff --git a/sample/app/controllers/BaseAuthConfig.scala b/sample/app/controllers/BaseAuthConfig.scala
@@ -1,8 +1,8 @@
 package controllers
 
 import jp.t2v.lab.play2.auth.AuthConfig
-import jp.t2v.lab.play2.auth.sample.{Permission, Account}
-import jp.t2v.lab.play2.auth.sample.Permission._
+import jp.t2v.lab.play2.auth.sample.{Role, Account}
+import jp.t2v.lab.play2.auth.sample.Role._
 import play.api.mvc.RequestHeader
 import play.api.mvc.Results._
 
@@ -13,14 +13,14 @@ trait BaseAuthConfig  extends AuthConfig {
 
   type Id = Int
   type User = Account
-  type Authority = Permission
+  type Authority = Role
 
   val idTag: ClassTag[Id] = classTag[Id]
   val sessionTimeoutInSeconds = 3600
 
   def resolveUser(id: Id)(implicit ctx: ExecutionContext) = Future.successful(Account.findById(id))
   def authorizationFailed(request: RequestHeader)(implicit ctx: ExecutionContext) = Future.successful(Forbidden("no permission"))
-  def authorize(user: User, authority: Authority)(implicit ctx: ExecutionContext) = Future.successful((user.permission, authority) match {
+  def authorize(user: User, authority: Authority)(implicit ctx: ExecutionContext) = Future.successful((user.role, authority) match {
     case (Administrator, _) => true
     case (NormalUser, NormalUser) => true
     case _ => false

diff --git a/sample/app/controllers/basic/Messages.scala b/sample/app/controllers/basic/Messages.scala
@@ -4,7 +4,7 @@ import controllers.stack.Pjax
 import jp.t2v.lab.play2.auth.AuthElement
 import play.api.mvc.Controller
 import views.html
-import jp.t2v.lab.play2.auth.sample.Permission._
+import jp.t2v.lab.play2.auth.sample.Role._
 
 trait Messages extends Controller with Pjax with AuthElement with AuthConfigImpl {
 
@@ -31,4 +31,4 @@ trait Messages extends Controller with Pjax with AuthElement with AuthConfigImpl
   protected val fullTemplate: User => Template = html.basic.fullTemplate.apply
 
 }
-object Messages extends Messages
+object Messages extends Messages
diff --git a/sample/app/controllers/builder/Messages.scala b/sample/app/controllers/builder/Messages.scala
@@ -2,7 +2,7 @@ package controllers.builder
 
 import jp.t2v.lab.play2.auth.AuthActionBuilders
 import jp.t2v.lab.play2.auth.sample.Account
-import jp.t2v.lab.play2.auth.sample.Permission._
+import jp.t2v.lab.play2.auth.sample.Role._
 import play.api.mvc._
 import play.twirl.api.Html
 import scalikejdbc.{DB, DBSession}

diff --git a/sample/app/controllers/csrf/PreventingCsrfSample.scala b/sample/app/controllers/csrf/PreventingCsrfSample.scala
@@ -2,7 +2,7 @@ package controllers.csrf
 
 import controllers.stack.TokenValidateElement
 import jp.t2v.lab.play2.auth.AuthElement
-import jp.t2v.lab.play2.auth.sample.Permission._
+import jp.t2v.lab.play2.auth.sample.Role._
 import play.api.data.Form
 import play.api.data.Forms._
 import play.api.mvc.Controller

diff --git a/sample/app/controllers/ephemeral/Messages.scala b/sample/app/controllers/ephemeral/Messages.scala
@@ -4,7 +4,7 @@ import controllers.stack.Pjax
 import jp.t2v.lab.play2.auth.AuthElement
 import play.api.mvc.Controller
 import views.html
-import jp.t2v.lab.play2.auth.sample.Permission._
+import jp.t2v.lab.play2.auth.sample.Role._
 
 trait Messages extends Controller with Pjax with AuthElement with AuthConfigImpl {
 
@@ -31,4 +31,4 @@ trait Messages extends Controller with Pjax with AuthElement with AuthConfigImpl
   protected val fullTemplate: User => Template = html.ephemeral.fullTemplate.apply
 
 }
-object Messages extends Messages
+object Messages extends Messages
diff --git a/sample/app/jp/t2v/lab/play2/auth/sample/Account.scala b/sample/app/jp/t2v/lab/play2/auth/sample/Account.scala
@@ -3,7 +3,7 @@ package jp.t2v.lab.play2.auth.sample
 import org.mindrot.jbcrypt.BCrypt
 import scalikejdbc._
 
-case class Account(id: Int, email: String, password: String, name: String, permission: Permission)
+case class Account(id: Int, email: String, password: String, name: String, role: Role)
 
 object Account extends SQLSyntaxSupport[Account] {
 
@@ -15,7 +15,7 @@ object Account extends SQLSyntaxSupport[Account] {
     email      = rs.string(a.email),
     password   = rs.string(a.password),
     name       = rs.string(a.name),
-    permission = Permission.valueOf(rs.string(a.permission))
+    role       = Role.valueOf(rs.string(a.role))
   )
 
   private val auto = AutoSession
@@ -40,7 +40,7 @@ object Account extends SQLSyntaxSupport[Account] {
     withSQL { 
       import account._
       val pass = BCrypt.hashpw(account.password, BCrypt.gensalt())
-      insert.into(Account).values(id, email, pass, name, permission.toString) 
+      insert.into(Account).values(id, email, pass, name, role.toString) 
     }.update.apply()
   }
 

diff --git a/sample/app/jp/t2v/lab/play2/auth/sample/Permission.scala b/sample/app/jp/t2v/lab/play2/auth/sample/Permission.scala
diff --git a/sample/app/jp/t2v/lab/play2/auth/sample/Role.scala b/sample/app/jp/t2v/lab/play2/auth/sample/Role.scala
@@ -0,0 +1,16 @@
+package jp.t2v.lab.play2.auth.sample
+
+sealed trait Role
+
+object Role {
+
+  case object Administrator extends Role
+  case object NormalUser extends Role
+
+  def valueOf(value: String): Role = value match {
+    case "Administrator" => Administrator
+    case "NormalUser"    => NormalUser
+    case _ => throw new IllegalArgumentException()
+  }
+
+}
diff --git a/sample/conf/db/migration/default/V1__create_tables.sql b/sample/conf/db/migration/default/V1__create_tables.sql
@@ -3,5 +3,5 @@ CREATE TABLE account (
     email      varchar NOT NULL UNIQUE,
     password   varchar NOT NULL,
     name       varchar NOT NULL,
-    permission varchar NOT NULL
+    role       varchar NOT NULL
 );