Skip to content

Commit

Permalink
Update v0.1.2 report
Browse files Browse the repository at this point in the history
  • Loading branch information
jultty committed Jan 30, 2024
1 parent 013b247 commit 2563906
Show file tree
Hide file tree
Showing 10 changed files with 461 additions and 0 deletions.
131 changes: 131 additions & 0 deletions docs/v0.1.2/img/class-account.puml
Original file line number Diff line number Diff line change
@@ -0,0 +1,131 @@
@startuml
skinparam style strictuml
skinparam classAttributeIconSize 0

package mirante.api.account {
class Account {
- username: String
- name: String
- email: String
- password: String
}
}

package mirante.api.event {
class EventController {
- repository: EventRepository
+ all(): List<Event>
+ newEvent(newEvent: Event): Event
+ one(id: String): Event
}

class Event {
- id: long
- timestamp: Timestamp
- description: String
- content: String
}

class EventRepository {
+ save(event: Event): Event
+ findById(id: String): Optional<Event>
+ findAll(): List<Event>
+ deleteById(id: String): void
}
}

EventRepository --> Event
EventController --> Event

package mirante.api.exercise {

class ExerciseController {
- repository: ExerciseRepository
+ all(): List<Exercise>
+ newExercise(newExercise: Exercise): Exercise
+ one(id: String): Exercise
+ deleteExercise(id: String): void
}

class Exercise {
- id: String
- instruction: String
- options: Set<Option>
- set: ExerciseSet
+ addOption(option: Option): void
}

class ExerciseSet {
- id: String
- name: String
- exercises: Set<Exercise>
}

class ExerciseRepository {
+ save(exercise: Exercise): Exercise
+ findById(id: String): Optional<Exercise>
+ findAll(): List<Exercise>
+ deleteById(id: String): void
}

class ExerciseSetController {
- repository: ExerciseSetRepository
+ all(): List<ExerciseSet>
+ newExerciseSet(newExerciseSet: ExerciseSet): ExerciseSet
+ one(id: String): ExerciseSet
+ deleteExerciseSet(id: String): void
}

class ExerciseSetRepository {
+ save(exerciseSet: ExerciseSet): ExerciseSet
+ findById(id: String): Optional<ExerciseSet>
+ findAll(): List<ExerciseSet>
+ deleteById(id: String): void
}
package mirante.api.exercise.option {

class OptionController {
- repository: OptionRepository
+ all(): List<Option>
+ newOption(newOption: Option): Option
+ one(id: String): Option
+ deleteOption(id: String): void
}

class Option {
- id: String
- content: String
- place: Integer
- correct: Boolean
- exercise: Exercise
}

class OptionRepository {
+ save(option: Option): Option
+ findById(id: String): Optional<Option>
+ findAll(): List<Option>
+ deleteById(id: String): void
}

}
}

ExerciseSet --o Exercise
Exercise --o Option

OptionController o-- Option
OptionRepository o-- Option
OptionController o-- OptionRepository

ExerciseController o-- Exercise
ExerciseRepository o-- Exercise
ExerciseController --> ExerciseRepository

ExerciseSetRepository o-- ExerciseSet
ExerciseSetController o-- ExerciseSet
ExerciseSetController --> ExerciseSetRepository


@enduml


30 changes: 30 additions & 0 deletions docs/v0.1.2/img/class-event.puml
Original file line number Diff line number Diff line change
@@ -0,0 +1,30 @@
@startuml
skinparam style strictuml
skinparam classAttributeIconSize 0

package event {
class EventController {
- repository: EventRepository
+ all(): List<Event>
+ newEvent(newEvent: Event): Event
+ one(id: String): Event
}

class Event {
- id: long
- timestamp: Timestamp
- description: String
- content: String
}

interface EventRepository {
+ save(event: Event): Event
+ findById(id: String): Optional<Event>
+ findAll(): List<Event>
}
}

EventRepository --o Event
EventController --o Event

@enduml
93 changes: 93 additions & 0 deletions docs/v0.1.2/img/class-exercise.puml
Original file line number Diff line number Diff line change
@@ -0,0 +1,93 @@
@startuml
skinparam style strictuml
skinparam classAttributeIconSize 0

package exercise {

class ExerciseController {
- repository: ExerciseRepository
+ all(): List<Exercise>
+ newExercise(newExercise: Exercise): Exercise
+ one(id: String): Exercise
+ deleteExercise(id: String): void
}

class Exercise {
- id: String
- instruction: String
- options: Set<Option>
- set: ExerciseSet
+ addOption(option: Option): void
}

class ExerciseSet {
- id: String
- name: String
- exercises: Set<Exercise>
}

interface ExerciseRepository {
+ save(exercise: Exercise): Exercise
+ findById(id: String): Optional<Exercise>
+ findAll(): List<Exercise>
+ deleteById(id: String): void
}

class ExerciseSetController {
- repository: ExerciseSetRepository
+ all(): List<ExerciseSet>
+ newExerciseSet(newExerciseSet: ExerciseSet): ExerciseSet
+ one(id: String): ExerciseSet
+ deleteExerciseSet(id: String): void
}

interface ExerciseSetRepository {
+ save(exerciseSet: ExerciseSet): ExerciseSet
+ findById(id: String): Optional<ExerciseSet>
+ findAll(): List<ExerciseSet>
+ deleteById(id: String): void
}
package option {

class OptionController {
- repository: OptionRepository
+ all(): List<Option>
+ newOption(newOption: Option): Option
+ one(id: String): Option
+ deleteOption(id: String): void
}

class Option {
- id: String
- content: String
- place: Integer
- correct: Boolean
- exercise: Exercise
}

interface OptionRepository {
+ save(option: Option): Option
+ findById(id: String): Optional<Option>
+ findAll(): List<Option>
+ deleteById(id: String): void
}

}
}

ExerciseSet --o Exercise
Exercise --o Option

OptionController --o Option
OptionRepository --o Option
OptionController --> OptionRepository

ExerciseController --o Exercise
ExerciseRepository --o Exercise
ExerciseController --> ExerciseRepository

ExerciseSetRepository --o ExerciseSet
ExerciseSetController --o ExerciseSet
ExerciseSetController --> ExerciseSetRepository

@enduml
131 changes: 131 additions & 0 deletions docs/v0.1.2/img/class.puml
Original file line number Diff line number Diff line change
@@ -0,0 +1,131 @@
@startuml
skinparam style strictuml
skinparam classAttributeIconSize 0

package mirante.api.account {
class Account {
- username: String
- name: String
- email: String
- password: String
}
}

package mirante.api.event {
class EventController {
- repository: EventRepository
+ all(): List<Event>
+ newEvent(newEvent: Event): Event
+ one(id: String): Event
}

class Event {
- id: long
- timestamp: Timestamp
- description: String
- content: String
}

class EventRepository {
+ save(event: Event): Event
+ findById(id: String): Optional<Event>
+ findAll(): List<Event>
+ deleteById(id: String): void
}
}

EventRepository --> Event
EventController --> Event

package mirante.api.exercise {

class ExerciseController {
- repository: ExerciseRepository
+ all(): List<Exercise>
+ newExercise(newExercise: Exercise): Exercise
+ one(id: String): Exercise
+ deleteExercise(id: String): void
}

class Exercise {
- id: String
- instruction: String
- options: Set<Option>
- set: ExerciseSet
+ addOption(option: Option): void
}

class ExerciseSet {
- id: String
- name: String
- exercises: Set<Exercise>
}

class ExerciseRepository {
+ save(exercise: Exercise): Exercise
+ findById(id: String): Optional<Exercise>
+ findAll(): List<Exercise>
+ deleteById(id: String): void
}

class ExerciseSetController {
- repository: ExerciseSetRepository
+ all(): List<ExerciseSet>
+ newExerciseSet(newExerciseSet: ExerciseSet): ExerciseSet
+ one(id: String): ExerciseSet
+ deleteExerciseSet(id: String): void
}

class ExerciseSetRepository {
+ save(exerciseSet: ExerciseSet): ExerciseSet
+ findById(id: String): Optional<ExerciseSet>
+ findAll(): List<ExerciseSet>
+ deleteById(id: String): void
}
package mirante.api.exercise.option {

class OptionController {
- repository: OptionRepository
+ all(): List<Option>
+ newOption(newOption: Option): Option
+ one(id: String): Option
+ deleteOption(id: String): void
}

class Option {
- id: String
- content: String
- place: Integer
- correct: Boolean
- exercise: Exercise
}

class OptionRepository {
+ save(option: Option): Option
+ findById(id: String): Optional<Option>
+ findAll(): List<Option>
+ deleteById(id: String): void
}

}
}

ExerciseSet --o Exercise
Exercise --o Option

OptionController o-- Option
OptionRepository o-- Option
OptionController o-- OptionRepository

ExerciseController o-- Exercise
ExerciseRepository o-- Exercise
ExerciseController --> ExerciseRepository

ExerciseSetRepository o-- ExerciseSet
ExerciseSetController o-- ExerciseSet
ExerciseSetController --> ExerciseSetRepository


@enduml


Loading

0 comments on commit 2563906

Please sign in to comment.