README.md 8.84 KB
Newer Older
M3156's avatar
M3156 committed
1
2
3
4
5
6
7
8
9
10
11
# TTOS0300 (Käyttöliittymäohjelmointi) Kurssin harjoitustyö - iTool

## Tekijä

* Samson Azizyan
* M3156 
* Versionumero 0.1


## Sisällysluettelo 

M3156's avatar
M3156 committed
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
* [Vaatimusmäärittely](#vaatimusmäärittely)
    * [Sovelluksen yleiskuvaus](#sovelluksen-yleiskuvaus)
    * [Kohdeyleisö](#kohdeyleisö)
    * [Käyttöympäristö ja käytetyt teknologiat](#käyttöympäristö-ja-käytetyt-teknologiat)
    * [Käyttäjäroolit](#käyttäjäroolit)
    * [Ominaisuudet](#ominaisuudet)
    * [Käyttötapaukset](#käyttötapaukset)
    * [Hyväksyntätestit](#hyväksyntätestit)
    * [Käsitemalli](#käsitemalli)
    * [Luokkakaavio](#luokkamalli)
    * [Työnjako](#työnjako)
    * [Työaikasuunnitelma](#työaika-suunnitelma)
* [Loppuraportti](#loppuraportti)
    * [Asennus](#asennus)
    * [Tetoa ohjelmasta](#tietoa-ohjelmasta)
    * [Kuvaruutukaappaukset](#kuvaruutukaappaukset)
    * [Mukana tulevat tiedostot](#)
    * [Tietokanta](#tietokanta)
    * [Ongelmat, jatkokehitysideat](#)
    * [Yhteenveto](#yhteenveto)
M3156's avatar
M3156 committed
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68

# Sovelluksen yleiskuvaus

Tarkoituksena on suunnitella ja toteuttaa työkaluvuokraussovelluksen prototyyppi,
joka aluksi toimisi vain paikallisesti. Vuokrausmenetelmä toimisi samalla periaatteella kun
Über-sovelluksen kyytipalvelu eli jokainen käyttäjä voi vuokrata jokaisen käyttäjän vuokralle
asettamat työkalut, työkalun omistajan hintapyynnön mukaan. Käyttäjät pystyy kommentoimaan työkaluja
ja antaa 1-5 arvion käyttäjistä, joiden kanssa on suorittanut transaction.

# Kohdeyleisö

Kohdeyleisö on kaikki henkilöt, joilla ei ole monipuolista työkalukokoelmaa. Eli todennäköisesti
kaupungeissa asuvat ihmiset.

# Käyttöympäristö ja käytetyt teknologiat

* Microsoft Windows (Käyttöympäristö)
* Visual Studio 2017
* WPF
* C#
* MySql

# Käyttäjäroolit

## Asiakas

Asiakas käyttää sovellusta vuoratakseen tai laittakseen vuokralle työkaluja.

## Ylläpitäjä

Ylläpitäjä ylläpitää palvelua ja pitää huolta siitä, että työkaluja myöhässä palauttaneiden käyttäjätilit
laitetaan joko jäähylle tai jäädytetään kokonaan.

# Ominaisuudet

| Tunnus | Ominaisuus | Prioriteetti | Muuta |
| :-: | :-: | :-: | :-: |
M3156's avatar
M3156 committed
69
| FT01 | [ Tunnusten luominen ja kirjautuminen](../liitteet/f1_login.md) | Pakollinen | |
M3156's avatar
M3156 committed
70
| FT02 | [ Lisää/poistaa työkalu ](../liitteet/f2_tools.md) | Pakollinen | |
M3156's avatar
M3156 committed
71
72
| FT03 | [ Tunnusten poistaminen](../liitteet/f3_delete_account.md) | Pakollinen | |
| FT04 | [ Mahdollisuus arvioida käyttäjiä ](../liitteet/f4_rating.md) | Nice to Have | |
M3156's avatar
M3156 committed
73
| FT05 | [ Työkalujen kommentoiminen ](../liitteet/f5_comment.md) | Nice to Have | |
M3156's avatar
M3156 committed
74
| FT06 | [ Työkalujen vuokraaminen ](../liitteet/f6_rentatool.md) | Pakollinen | |
M3156's avatar
M3156 committed
75
76
77
| FT07 | [ Työkalujen palautus ](../liitteet/f7_returntool.md) | Pakollinen | |
| FT08 | [ Työkalujen poistaminen ](../liitteet/f8_deletetool.md) | Pakollinen | |

M3156's avatar
M3156 committed
78
79
80
81
82
83
84
85
86
87
88

# Käyttötapaukset

## Tunnusten luominen ja kirjautuminen

```plantuml
@startuml
    Käyttäjä --> (Tunnusten luominen)
    Käyttäjä --> (Kirjautuminen)
@enduml
```
M3156's avatar
M3156 committed
89
90
**Käyttötapauksen kuvaus**

M3156's avatar
M3156 committed
91
92
93
1. Käyttäjä luo tunnukset
2. Käyttäjä kirjautuu palveluun

M3156's avatar
M3156 committed
94
95
96
97
98
99
100
101
102
**Poikkeukset**
 
* P1 Käyttäjä ei täyttänyt kaikki kentät oikein, saa virheilmoituksen
* P2 Käyttäjä ei muista salasanaa, ottaa yhteyttä ylläpitoon
	
**Lopputulos**	

* Asiakas on luonut tunnukset ja on päässyt kirjautumaan iTool sovellukseen

M3156's avatar
M3156 committed
103
104
105
106
**Käyttötiheys** 

* Tunnusten luominen: Kerran per sähköposti
* Kirjautuminen: rajaton
M3156's avatar
M3156 committed
107

M3156's avatar
M3156 committed
108
## Työkalujen selailu, vuokraus, palautus ja poistaminen
M3156's avatar
M3156 committed
109
110
111

```plantuml
@startuml
M3156's avatar
M3156 committed
112
    :Työkalun omistaja: as Omistaja
M3156's avatar
M3156 committed
113
    Käyttäjä --> (Työkalujen selailu) : Selaa
M3156's avatar
M3156 committed
114
    Käyttäjä --> Omistaja : Soittaa ja sopii tapaaminen
M3156's avatar
M3156 committed
115
116
    Käyttäjä --> (Työkalun vuokraus) : Vuokraa
    Käyttäjä --> (Työkalun palautus) : Palauttaa
M3156's avatar
M3156 committed
117
118
    Käyttäjä --> (Työkalun poistaminen) : Poistaa
    (Työkalun poistaminen) --> (iTool tietokanta) : Ylikirjoittaa
M3156's avatar
M3156 committed
119
@enduml
M3156's avatar
M3156 committed
120
121
122
123
124
125
126
127
```

**Käyttötapauksen kuvaus**

1. Käyttäjä selaa voukrattavissa olevia työkaluja
2. Käyttäjä ottaa yhteyttä työkalun omistajaan ja sopii tapaaminen
3. Käyttäjä vuokraa työkalun
4. Käyttäjä palauttaa työkalun
M3156's avatar
M3156 committed
128
129
5. Käyttäjä poistaa työkalun
6. Sovellus ylikirjoittaa poistetun työkalun
M3156's avatar
M3156 committed
130
131
132
133

	
**Lopputulos**	

M3156's avatar
M3156 committed
134
* Asiakas on vuokrannut, palautanut tai poistanut työkalun onnistuneesti
M3156's avatar
M3156 committed
135
136
137
138

**Käyttötiheys** 

* Vuokraus: rajaton
M3156's avatar
M3156 committed
139
* Palautus: kerran per transaction
M3156's avatar
M3156 committed
140
* Poistaminen: kerran per työkalu
M3156's avatar
M3156 committed
141
142
143
144
145
146
147
148
149
150
151

## Työkalujen kommentointi

```plantuml
@startuml
    :Käyttäjä 1: as k1
    :Käyttäjä 2: as k2
    k1 --> (Työkalun kommentti) : Jättää kommentin työkalusta
    k2 --> (Työkalun kommentin vastaus) : Vastaa kommenttiin
    (Työkalun kommentin vastaus) --> (Työkalun kommentti)
@enduml
M3156's avatar
M3156 committed
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
```

**Käyttötapauksen kuvaus**

1. Käyttäjä 1 jättää kommentin työkalusta
2. Käyttäjä 2 kommentoi Käyttäjä 1:n jättämä kommenttia

	
**Lopputulos**	

* Kommentointi sujuu onnistuneesti

**Käyttötiheys** 

* Kommenttointi: rajaton
M3156's avatar
M3156 committed
167
168
* Vastaaminen kommentteihin: rajaton

M3156's avatar
M3156 committed
169
# Hyväksyntätestit
M3156's avatar
M3156 committed
170
171
172

| TestiID | Kuvaus |								
|:-:|:-:|
M3156's avatar
M3156 committed
173
174
175
176
177
| AT01 | [Tunnusten luominen ja sovellukseen kirjautuminen](../liitteet/at1_tunnusten_luominen.md) |
| AT02 | [Työkalun lisäys/poisto](../liitteet/at3_addtool.md) |
| AT03 | [Työkalun vuokraaminen](../liitteet/at4_rentatool.md) |
| AT04 | [Tunnusten poistaminen](../liitteet/at5_delete.md) |
| AT05 | [Kommentointi](../liitteet/at6_comments.md) |
M3156's avatar
M3156 committed
178
179
180
181
| AT06 | [Työkalun palautus](../liitteet/at7_returnatool.md) |

# Käsitemalli

M3156's avatar
M3156 committed
182
183
184
185
186
187
188
189
190
### Käsitteet

1. User: iTool sovelluksen käyttäj
2. Tool: Työkalu
3. Tool Category: Työkalun kategoria
4. Transaction: Työkalun omistajan ja työkalun vuokraajan välinen kauppa
5. Comment: Työkalujen kommentit
6. Rating: Käyttäjän antama arvio(1-5) kaupan toiselle osapuolelle

M3156's avatar
M3156 committed
191
192
```plantuml
@startuml
M3156's avatar
M3156 committed
193
194
195
196
197
198
199
200
    User --|> Tool
    Transaction --|> User
    Transaction --|> Tool
    Tool --|> ToolCategory
    Comment --|> Tool
    Comment --|> User
    User --> Rating
    Rating --|> Transaction
M3156's avatar
M3156 committed
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
@enduml
```
# Luokkamalli

```plantuml
@startuml
    class User {
        +userID
        +userEmail
        #userPassword
        +userFirstName
        +userLastName
        +userMobile
        +userPicture
        +userLocation
        +userPaymentMethod
        +addTool()
        +deleteTool()
        +rentTool()
        +returnTool()
        +comment()
        #editEmail()
        #editPassword()
        +login()
        +logout()
    }
    
    class Tool {
        +toolID
        +toolName
        +toolCategory
        +toolDescription
        +toolImage
    }
    
M3156's avatar
M3156 committed
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
    class Comment {
        +commentID
        +commentDateTime
        +commentBody
        +toolID
        +userID
        +commentParentID
    }
    
    class Transaction {
        +transactionID
        +transactionStartDate
        +transactionPlannedEndDate
        +transactionActualEndDate
        +userOwnerID
        +userLesseeID
        +toolID
    }
    
    class ToolCategory {
        +toolCategoryID
        +toolCategoryName
        +toolCategoryDescription
    }
    
    class Rating {
        +ratingID
        +rating
        +ratingFeedback
        +raterID
        +ratedID
        +transactionID
    }
    
M3156's avatar
M3156 committed
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
    class MainWindow {
        Opne()
        Close()
        Show()
    }
    
    class RegisterWindow {
        Opne()
        Close()
        Show()
    }
    
    class MainPage {
        Opne()
        Close()
        Show()
    }
    
    class ProfileWindow {
        Opne()
        Close()
        Show()
    }
    
    class CommentWindow {
        Opne()
        Close()
        Show()
    }
M3156's avatar
M3156 committed
299
    
M3156's avatar
M3156 committed
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
    class DB {
        GetConnectionString()
        GetUsersFromMysql()
        GetToolOwnerFromMysql()
        EmailChecker()
        GetToolsFromMysql()
        GetOwnedToolsFromMysql()
        AddTransactionToMysql()
    }
    
    CommentWindow --|> MainPage
    RegisterWindow --|> MainWindow
    MainWindow --> MainPage
    MainPage --> ProfileWindow
    User --> MainPage
    User --> ProfileWindow
    Tool --|> User
    User --> DB
M3156's avatar
M3156 committed
318
319
320
321
322
323
324
325
    Tool --|> ToolCategory
    Transaction --|> Tool
    User --> Transaction
    User --> Comment
    Comment --|> Tool
    User --> Rating
    Rating --|> User
    Rating --|> Transaction
M3156's avatar
M3156 committed
326
    
M3156's avatar
M3156 committed
327
@enduml
M3156's avatar
M3156 committed
328
329
330
331
332
333
334
335
336
337
338
339
```

# Työnjako

Samson Azizyan
Suunnittelu, XAML toteutus, code in behind, testit, Mysql database (Tietokannat kurssi)

# Työaika suunnitelma

* Viikko 11: MainWindow ja RegisterWindow sekä XAML että code in behind. User, Tool luokat, Mysql tietokanta (15h)
* Viikko 12: DB, MainPage XAML ja code in behind, DB, Mysql (10h)
* Viikko 13: ProfileWindow, DB (5h)
M3156's avatar
M3156 committed
340
* Viikko 14: Kaikkien ikkunoiden toimintojen parantamista, DB, Harjoitustyön suunnitelmä xD (17h)
M3156's avatar
M3156 committed
341
342
* Viikko 15: Kaikkien ikkunoiden toimintojen parantamista, DB, CommentWindow XAML, Mysql näkymät (20h)
* Viikko 16: Rating Window, Testaaminen, debuggaaminen (10h)
M3156's avatar
M3156 committed
343
344

Pakko myöntää etää aloin koodaamaan jo viikolla 11 ja tein tämän suunnitelman vasta viikolla 14.