totask2 Entwickler Dokumentation

/**
 * a working task of a {@link Project} that needs to be worked on.
 *
 * @author man-at-home
 */
@Entity                                                     (1)
@Audited
@Table(name = "TT_TASK")
@AuditTable("TT_TASK_HISTORY")
public class Task {

    @Id                                                     (2)
    @GeneratedValue(strategy = GenerationType.AUTO)
    @Column(name = "ID")
    private long     id;

    @Size(min = 2, max = 250)
    @NotNull
    @Column(name = "NAME", nullable = false, length = 250)  (3)
    private String  name;

/** show all tasks for given project.
 *
 * @param id project.id to show tasks for.
 * */
@RequestMapping(value = "/project/{id}/tasks", method = RequestMethod.GET)          (1)
public String tasksForProject(@PathVariable final long id, final Model model) {

    LOG.trace("tasks for project " + id);

    Project project  = projectRepository.findOne(id);
    List<Task> tasks = taskRepository.findByProjectId(id);                          (2)

    model.addAttribute("tasks", tasks);                                             (3)
    model.addAttribute("projectId", id);
    model.addAttribute("isEditAllowed", project.isEditAllowed(getUser()));


    LOG.debug("serving " + tasks.size() + " tasks for project " + id);
    return "tasks";
}

-->
<tr th:each="task : ${tasks}">    <!-- (1)
                                  -->
    <td th:text="${task.id}">17</td>
    <td th:text="${task.name}">task name</td>        <!-- (2)
                                                     -->
    <td class="dt-left">

        <a th:href="@{/task/{id}(id=${task.id})}" class="btn btn-default" th:if="${isEditAllowed}">
            <span class="glyphicon glyphicon-pencil"></span>
            <span th:text="#{totask2.task.action.edit}">edit..</span>            <!-- (3)
                                                                                  -->
        </a>
        <button class="btn btn-default" name="id" th:value="${task.id}" th:if="${isEditAllowed}">
            <span class="glyphicon glyphicon-remove"></span>
            <span th:text="#{totask2.task.action.delete}">delete</span>
        </button>

    </td>
</tr>
<!--

@Table(name = "TT_PROJECT")
@Audited                                    (1)
@AuditTable("TT_PROJECT_HISTORY")           (2)
@ApiModel(value = "Project", description = "project to log work on tasks, containing *task*s and being administered by project leads")
public class Project {

    private static final Logger LOG = LoggerFactory.getLogger(Project.class);

    @Id
    @GeneratedValue(strategy = GenerationType.AUTO)
    @Column(name = "ID")
    private long     id;

LOG.debug("flash back query for project" + projectId);

AuditReader ar = AuditReaderFactory.get(entityManager);
AuditQuery query = ar.createQuery().forRevisionsOfEntity(
        Project.class, true, true);
query.add(new IdentifierEqAuditExpression(projectId, true));

@SuppressWarnings("unchecked")
List<Project> result = query.getResultList();

result.stream().forEach(
        p -> LOG.debug("historic project entry: " + p));

package org.manathome.totask2.model;

/*
*
@startuml doc-files/totask2.design.datamodel.png

Project         "1" *-- "n" Task : contains
Project         "n"  -- "n" User            : leads
Task            "1" *-- "n" TaskAssignment
TaskAssignment  "1" -- "n"  User : assigned to
WorkEntry       "n" -- "1"  User
WorkEntry       "n" -- "1"  Task : worked on

Project   : name
Task      : name

User      : username
User      : displayName
User      : password
User      : isAdmin : boolean

WorkEntry  : at       : Date
WorkEntry  : duration : Hours

TaskAssignment : from  : Date
TaskAssignment : until : Date


@enduml
*/

    == Überblick                                                           (1)

    Das Dokument beschreibt *aus Entwicklersicht* das...                   (2)
    ...
	include::{resourcedir}/templates/weekEnty.html[tags=developer-manual-chart]

	:testClasses
	:flywayInfo
	+----------------+----------------------------+---------------------+---------+
	| Version        | Description                | Installed on        | State   |
	+----------------+----------------------------+---------------------+---------+
	| 1              | init totask2 db            | 2014-10-26 02:17:37 | Success |    (1)
	| 2              | createTestUsersProject.db  | 2014-10-26 02:17:37 | Success |
	| 3              | alterTableUsers.db         | 2014-10-26 02:17:37 | Success |
	| 4              | alterTablesVarious.db      |                     | Pending |    (2)
	| 5              | createHistoryTables.db     |                     | Pending |
	+----------------+----------------------------+---------------------+---------+

	BUILD SUCCESSFUL

    >gradle flywayMigrate                                                              (3)

\data\projects\toTask2>gradle --daemon allDocs

	:asciidoctor
	Converting C:\data\projects\toTask2\src\docs\totask2.article.asciidoc
	Converting C:\data\projects\toTask2\src\docs\totask2.developer-manual.asciidoc
	Converting C:\data\projects\toTask2\src\docs\totask2.slides.asciidoc
	:compileJava UP-TO-DATE
	:processResources UP-TO-DATE
	:classes UP-TO-DATE
	:plantuml
	:javadoc UP-TO-DATE
	:copyPlantUMLImages UP-TO-DATE
	:allDocs

	BUILD SUCCESSFUL

	Total time: 31.077 secs
\data\projects\toTask2>

C:\dev\wildfly\bin>standalone
	Calling "C:\dev\wildfly\bin\standalone.conf.bat"
	..
	Feb 21, 2015 21:33:43 +0100 [6592 1] com.newrelic INFO: Agent is using Logback
	Feb 21, 2015 21:33:43 +0100 [6592 1] com.newrelic INFO: Loading configuration file "C:\dev\wildfly\newrelic\.\newrelic.yml"
	..