개요

 ---

 -------------

 * 프로젝트 이관 요청은 해당 프로젝트에 관리자 권한을 가지고 있는 사용자만 할 수 있다.

 * 요비는 프로젝트 이관 요청을 수락할 수 있는 사용자에게 프로젝트 이관 요청 이메일을 발송한다.

  * 프로젝트 이관 요청 이메일로 프로젝트 이관 요청을 수락할 수 있는 링크를 보낸다.

  * '프로젝트 이관 요청 수락 링크'는 프로젝트 이관 요청을 보낸 시점에서 하루 동안 유효하다.

  * 계정으로 보내진 프로젝트 이관 요청은 사이트 관리자와 해당 계정 사용자만 수락할 수 있다.

 * '프로젝트 이관 요청 수락 링크'를 클릭하면 프로젝트 이관을 완료할 수 있다.

 * 프로젝트 이관이 완료되면 다음과 같이 변경한다.

   * 계정으로 보낸 이관 요청을 수락했을 때는 해당 계정으로 프로젝트 소유자가 바뀐다.

   * 그룹으로 보낸 이관 요청을 수락했을 때는 해당 그룹으로 프로젝트 소유자가 바뀐다.

  * 프로젝트 소유자가 바뀌기 때문에 기존 프로젝트의 이슈, 게시물, 저장소 URL 등이 변경된다.

  * 보낸 프로젝트와 동일한 이름의 프로젝트가 이미 존재하는 경우에는 프로젝트 이름을 변경하여 받는다.

   * 동일한 이름의 프로젝트가 있는 경우에는 프로젝트 이름 뒤에 '-1'을 추가해서 찾아보고 그래도 있는 경우에는 '-2'를 추가하는 식으로 새 이름을 정한다.

 * 프로젝트 이관 요청을 수락할 수 없는 사용자가 해당 링크를 사용한 경우에는 403 Forbidden으로 응답한다.

     * 그룹 관리자(Group Manager) : 그룹 관리자로 등록된 사용자

     * 그룹 참여자(Group Participant)

 * 프로젝트 멤버 = 프로젝트 관리자 + 프로젝트 참여자

     * 프로젝트 관리자(Project Manager) : 프로젝트 관리자 권한을 부여 받은 사용자 + 프로젝트 소유자

     * 프로젝트 참여자(Project Participant)

 * 사용자(User) : Yobi에 접속한 모든 사람

 정의

 -----

 * 그룹 생성

 * 그룹 삭제

         * 그룹이 소유하고 있는 모든 프로젝트를 이관/삭제하여 그룹이 소유하고 있는 프로젝트가 전혀 없을 때 삭제 가능하다.

         * 그룹이 삭제되어도 그룹이 소유한 프로젝트의 멤버 구성에는 변함이 없다.

 * 사용자가 할 수 있는 일

     * 사용자는 그룹의 모든 멤버 리스트를 볼 수 있다.

     * 사용자는 자신이 멤버로 등록된 그룹의 리스트를 볼 수 있다.

 * 그룹 관리자가 할 수 있는 일

     * 그룹 관리자는 자신이 관리자인 그룹의 모든 프로젝트에서 프로젝트 관리자 역할을 수행할 수 있다.

     * 그룹 참여자는 자신이 참여자인 그룹의 모든 protected 프로젝트에서 프로젝트 참여자 역할을 수행할 수 있다.

     * 그룹 관리자는 자신이 그룹 관리자인 그룹에 자신 이외의 관리자를 추가할 수 있다.

         * 따라서 하나의 그룹은 그룹 관리자가 두 명 이상이 될 수 있다.

     * 그룹 관리자는 그룹에 멤버를 추가/삭제를 할 수 있다.

         * 멤버들을 특정 그룹으로 묶어서 편하게 보기 위해서.

         * 특정 프로젝트는 해당 그룹의 멤버들만 접근 가능 하게 만들기 위해서.

 * 그룹 멤버가 할 수 있는 일

 * 검색

 Project

 -------

 * 생성

 * 공개 설정

     * 프로젝트 관리자는 프로젝트의 공개 설정을 private, protected, public 중 하나로 설정 할 수 있다.

         * 각 설명은 Rule 참조.

 * 개인이 소유한 프로젝트 이관

 * 그룹이 소유한 프로젝트 이관

 Rule

 | Anonymous         | X               | X                 | O              |

 * 각 프로젝트에서 할 수 있는 일

     * 그룹 관리자는 그룹에 속한 프로젝트의 관리자로 등록되기 때문에 프로젝트 관리자 역할을 할 수 있다.

     * 그룹 참여자는 protected 프로젝트의 참여자와 동등한 권한을 갖기 때문에 프로젝트 참여자 역할을 할 수 있다.

 공통

 ----

 * 그룹 관리자 이외의 모든 사용자는 그룹 관리 권한을 갖지 않는다.

 session

 -------

 - userId(고유ID), logindId(로그인ID), userName(이름) 을 key 로 사용해서 `encoded data` 를 만들고 이를 하나의 cookie value 로 저장한다.

 - `encoded data` 는 각각의 key-value 쌍을 `key:value` 형태의 string 으로 만들고 이를 url encode 한 뒤, `%00` 으로 연결한 값이다.

     - ex) userId%3A1%00loginId%3Atest%00userName%3Atestname

 token

 -----

 - 로그인 유지를 위한 정보(로그인ID, hash 값)를 저장한다.

 - `yobi.token` 이란 이름을 사용하며 값을 `로그인ID:hash` 형태로 저장한다.

 - `hash` 는 [Sha256Hash#toBase64()](http://shiro.apache.org/static/1.2.1/apidocs/org/apache/shiro/crypto/hash/Sha256Hash.html) 을 이용해서 얻는다. `source` 로 plain password 를, `salt` 로 사용자별 random 생성된 값을, `hashIterations` 으로 1024 상수 값을 사용한다.

 -----

 - `UserApp#currentUser()` 에서 session 정보가 없을 경우 context, token 정보까지 활용하게 되는데 controller 에 action composition 이 적용되어 있을 경우 `UserApp#initTokenUser()` 보다 먼저 실행 될 수 있기 때문이다. (아래 action composition 실행 순서를 참고)

 action composition 실행 순서

 ---------------------------

 ## $yobi.loadModule 사용법

 * 만약 yobi.module.Name 이라는 이름의 모듈을 정의한 경우 아래와 같다

 >       $yobi.loadModule("module.Name", {

 >            "sOption": "Option Value"

     이미 페이지 내에 `<script>` 태그를 이용해 포함한 경우에는 동적 로딩은 시도되지 않는다.

     동적 로딩을 시도하는 파일 경로는 `javascripts/service/yobi.(module.Name).js` 이다.

 * 자바스크립트 파일 로딩이 완료되어 모듈 코드를 사용할 수 있을 때 자동으로 초기화를 시도하며 내부적으로 수행되는 코드는 아래와 같다.

 >        new yobi.module.Name(htOption)

 ## 기타

 * 최상위 객체에 대한 prototype 확장은 사용하지 않는다. 이는 모든 코드에 영향을 미칠 수 있으며 코드 유지보수를 어렵게 만든다

 * HTML 템플릿은 되도록 자바스크립트 파일 내에 포함하지 않는다

 * HTML 템플릿은 정적 페이지내에 `<script type="text/x-jquery-tmpl">` 형태로 위치시키고 자바스크립트는 그 내용을 활용하는 형태로 작성한다

 * HTML 템플릿 문법($.tmpl)은 https://github.com/BorisMoore/jquery-tmpl 참조

 ----

 ## 네임스페이스, 모듈, 함수, 변수 등의 이름을 작성할 때

 * 한글 발음을 로마자로 그대로 표기하지 않는다

 * 특수 문자는 가급적 사용하지 않는다. 단, 상수의 이름에서 단어를 구분하기 위한 용도와 Private 지시자 표시를 위하여 언더스코어(`_`)를 사용한다

 * 2글자 이상 대문자를 연속해서 사용하지 않는다. 단, 상수 이름이나 약어는 예외로 한다

 ## 파일 이름

 * 프레임워크를 포함한 라이브러리는 {SCRIPT_ROOT}/lib , 프로젝트 내 공통 모듈은 {SCRIPT_ROOT}/common , 페이지 단위의 개별 모듈은 {SCRIPT_ROOT}/service 에 위치하는 것을 권장한다.

 * JavaScript 파일은 네임스페이스를 포함하여 모듈 단위로 구성한다. 파일 이름 규칙은 각각 네임스페이스 + 모듈 이름 규칙을 따른다

 * 함수 선언 사이에는 빈 줄을 삽입한다 (함수와 함수 사이)

 * 변수를 선언한 경우에는 다음에 빈 줄을 삽입하지 않는다.

 * 명령문 간에는 빈 줄을 사용하지 않는다. 단, 소스 코드의 길이가 길어지는 경우 구분을 위해 삽입할 수 있다.

 >        // on request

 >        var requestDetailId;

 Type: Number

 #### options.hasPrev (default: options.current와 options.firstPage로 계산)

 다음 페이지 혹은 이전 페이지 링크를 클릭하거나, 이동할 페이지를 입력하고 엔터를 눌렀을 때 실행될 자바스크립트 함수. pagination.js는 이 함수에게 사용자가 이동하고자 하는 페이지의 번호를 pageNum 매개변수로 넘겨준다. 예를 들어, 사용자가 다음 페이지 링크를 클릭했다면 pageNum은 현재 페이지 번호에 1을 더한 것이 된다.

 Sync

 ----

     page-number       = 1*DIGIT

     DIGIT             = <any US-ASCII digit "0".."9">

     Range: pages=1

     complete-length   = 1*DIGIT

     SP                = <US-ASCII SP, space (32)>

     Content-Range: pages 1/2

 서버는 상황에 따라 클라이언트가 요청한 것과 다른 페이지를 돌려줄 수도 있다. 이러한 상황에 대한 예외처리의 책임은 클라이언트에게 있다.

 References

 ==========

 yobi.Files

 ----

 공통 페이지인 views/scripts.scala.html 에서 이미 yobi.Files.init() 을 아래와 같이 호출하고 있으므로

 개별 페이지에서는 별도로 호출하지 않아도 무방하다.

 사용 가능한 커스텀 이벤트는 아래와 같으며 .attach("이벤트명", function(){}); 로

 핸들러를 지정하고 같은 방식으로 .detach() 를 이용해 핸들러를 제거할 수 있다.

 - uploadProgress: 업로드 진행 상태 처리를 위한 이벤트

 - successUpload: 업로드 성공(완료) 시 발생하는 이벤트

 예: 기본 사용법

 ```

 yobi.Attachments

 ----

 파일 업로더와 함께 사용할 수도 있고, 단순히 resourceType 과 resourceId 만 지정해서 기존에 첨부된 파일 목록을 표현할 수도 있다.

 yobi.Files 와 달리 new yobi.Attachments 로 인스턴스를 생성하여 사용한다.

 개요

 ----

 URL에 해당하는 프로젝트가 없거나 현재 사용자가 읽기 권한이 없을 때 403 Forbidden으로 응답한다.

 다음 코드는 URL 패턴에 해당하는 프로젝트가 있는지 확인한다.

 컨트롤러 클래스에 이 애노테이션을 사용하면 해당 컨트롤러의 모든 메서드에 적용된다.

 다음 코드는 PullRequestApp 컨트롤러의 모든 메서드에 @IsOnlyGitAvailable을 적용하여 이 컨트롤러에서 처리하는 모든 요청은 GIT 저장소를 가진 프로젝트에 대해서만 동작한다고 설정한 것이다.

 * value: 생성 권한을 확인하려는 리소스 타입으로 `ResourceType`을 입력한다.

 위 코드는 현재 로그인한 사용자가 URL 패턴에 해당하는 프로젝트에 BOARD_POST 타입의 리소스를 생성할 수 있는 권한이 있는지 확인한다.

 이밖에 필요한 리소스 타입이 있다면 `Resource.getResourceObject` 메서드에 코드를 추가해야 한다.

 다음 코드는 resourceType을 명시하지 않았기 때문에 기본값인 PROJECT가 적용되어 현재 사용자가 PROJECT 리소스 타입에 READ 권한이 있는지 확인한다.

 현재 요청한 사용자가 익명 사용자일 경우에 alert 창을 보여주고 로그인 폼으로 이동시킨다.

 다음 코드는 로그인한 사용자가 있는지 확인한다.

 URL에 해당하는 프로젝트가 없을 때 403 Forbidden으로 응답한다.

 다음 코드는 URL 패턴에 해당하는 프로젝트가 있는지 확인한다.

   목록: list

   삭제: delete

 * 파일명은 카멜 표기법 ([CamelCase](http://en.wikipedia.org/wiki/CamelCase))을 준수한다

 요비 프로젝트 홈에 있는 build.sbt 파일에 다음 코드가 있다면 1.4.184 버전을 사용하는 중입니다.

 "com.h2database" % "h2" % "1.4.184",

 ```

 따라서 아래 가이드에 따라 데이터 이관 작업을 해주셔야 합니다.

 ```

 cp yobi.h2.db yobi.h2.db.bak

 ## 3. 이제 요비를 다시 실행합니다. (!주의! 아직은 다른 사용자가 접근하지 못하게 해주세요.)

 이때 오직 사이트 관리자만 요비에 접근해서 백업 작업을 해야 합니다.

 그렇지 않으면 데이터 무결성이 깨질 수 있습니다.

 기존에 사용하던 포트가 아닌 다른 포트로 요비를 실행하시기 바랍니다.

 ```

 git fetch origin

 git rebase origin/next

 ```

 ## 5. 데이터베이스 파일을 삭제하세요.

 the formats can be differ. See `conf/application-logger.xml`, the configuration

 for logging, for the difference between two formats.

 --------------------

 You can configure logging in `conf/application-logger.xml`. See LOGBack

 * Ident field is always filled with "-".

 * Processing time is filled with "-" if serving a request is failed.

 * For chunked encoding, the time taken to generate response body, e.g. the time

 References

 ----------

 Java Coding Guidelines

 ======================

 Yobi in Java.

 In this document, The words "MUST", "MUST NOT", "SHOULD", "SHOULD NOT" and

 Just copy existing file like yobi.h2.db to another name.

 And if there is something wrong, then just rename it to yobi.h2.db and run the Yobi with it.

 On the remote repository(mainstream), There is a branch named, export-import.

 It supports data backup and restore.

 1. Go to the group page.

 1. Click the sawlike `Group Setting` button.

 1. Click the `Setting` tab.

 ## Managing members

 ### Adding members

 1. Go to the group page.

 1. Click the sawlike `Group Setting` button.

 1. Click the `Group Member` tab.

 ## Authorizations

 You can choose an assignee on the issue.

 1. You will see project members.

 1. Click a member to which you want to assign the issue

 Issues are filtered by project member names on `Issues` page.

 See `docs/userManual/issue/issue-use-milestone.md` to get more information.

 You can label issues for categorizing and searching. One or more labels can be added to an issue.

 A label has name and color and is included in a category.

 Category

 To go to the `Issue Label` page, you should be a project manager.

 ---------------

 To create labels:

 You can manage project members if you are a project manager. You can delete and change authorizations of members.

 ------------------------------

 1. Go to a project.

 Unwatching

 ----------

 ### Unwatching projects

 To unwatch individual items:

 1. Click the `Unwatch` button to stop getting notifications.

 In order to create a project, click the `+` button and `Create new project` on the top right of the page.

 Fill out the form and click the `Create a project` button.

 1. Click the `Watch` button.

 1. Click the `Watch` button on popup.

 Notifications

 1. Click your avatar on the top of a page.

 1. Click `Account Settings`.

 1. Click `Notification Settings` tab.

 Project's logo, name, description, share option and member can be configured.

 * Click 'Project Setting Button' on top right of a project.

 * Click `Setting` tab and change project's logo, name, description and share option.

 This option is only shown when project repository type is GIT.

 ## Menu Setting

 Project's logo, name, description, share option and member can be configured.

 * Click the 'Project Settings' button.

 * Click `Settings` tab and change project's logo, name, description or share option.

 # Pull Request

 `Pull Request`, however, is only available for projects using a git repository.