README.md 13.6 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

M3156's avatar
M3156 committed
33
34
35
# Vaatimusmäärittely

## Sovelluksen yleiskuvaus
M3156's avatar
M3156 committed
36
37
38
39
40
41
42

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.

M3156's avatar
M3156 committed
43
## Kohdeyleisö
M3156's avatar
M3156 committed
44
45
46
47

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

M3156's avatar
M3156 committed
48
## Käyttöympäristö ja käytetyt teknologiat
M3156's avatar
M3156 committed
49
50
51
52
53
54
55

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

M3156's avatar
M3156 committed
56
## Käyttäjäroolit
M3156's avatar
M3156 committed
57

M3156's avatar
M3156 committed
58
### Asiakas
M3156's avatar
M3156 committed
59
60
61

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

M3156's avatar
M3156 committed
62
### Ylläpitäjä
M3156's avatar
M3156 committed
63
64
65
66

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.

M3156's avatar
M3156 committed
67
## Ominaisuudet
M3156's avatar
M3156 committed
68
69
70

| Tunnus | Ominaisuus | Prioriteetti | Muuta |
| :-: | :-: | :-: | :-: |
M3156's avatar
M3156 committed
71
| FT01 | [ Tunnusten luominen ja kirjautuminen](../liitteet/f1_login.md) | Pakollinen | |
M3156's avatar
M3156 committed
72
| FT02 | [ Lisää/poistaa työkalu ](../liitteet/f2_tools.md) | Pakollinen | |
M3156's avatar
M3156 committed
73
74
| 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
75
| FT05 | [ Työkalujen kommentoiminen ](../liitteet/f5_comment.md) | Nice to Have | |
M3156's avatar
M3156 committed
76
| FT06 | [ Työkalujen vuokraaminen ](../liitteet/f6_rentatool.md) | Pakollinen | |
M3156's avatar
M3156 committed
77
78
| FT07 | [ Työkalujen palautus ](../liitteet/f7_returntool.md) | Pakollinen | |

M3156's avatar
M3156 committed
79

M3156's avatar
M3156 committed
80
## Käyttötapaukset
M3156's avatar
M3156 committed
81

M3156's avatar
M3156 committed
82
### Tunnusten luominen ja kirjautuminen
M3156's avatar
M3156 committed
83
84
85
86
87
88
89

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

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

M3156's avatar
M3156 committed
95
96
97
98
99
100
101
102
103
**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
104
105
106
107
**Käyttötiheys** 

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

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

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

**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
129
5. Käyttäjä poistaa työkalun
M3156's avatar
M3156 committed
130
6. Sovellus ylikirjoittaa poistetun työkalun [(CODE002)](liitteet/code002.md)
M3156's avatar
M3156 committed
131
132
133
134

	
**Lopputulos**	

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

**Käyttötiheys** 

* Vuokraus: rajaton
M3156's avatar
M3156 committed
140
* Palautus: kerran per transaction
M3156's avatar
M3156 committed
141
* Poistaminen: kerran per työkalu
M3156's avatar
M3156 committed
142

M3156's avatar
M3156 committed
143
### Työkalujen kommentointi
M3156's avatar
M3156 committed
144
145
146
147
148
149
150
151
152

```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
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
```

**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
168
169
* Vastaaminen kommentteihin: rajaton

M3156's avatar
M3156 committed
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
### Tunnusten poistaminen

```plantuml
@startuml
    Käyttäjä --> (Tunnusten poistaminen)
    (Tunnusten poistaminen) --> (iTool tietokanta) : Ylikirjoittaa
@enduml
```
**Käyttötapauksen kuvaus**

1. Käyttäjä poista tunnukset
2. Tunnukset ylikirjoitetaan tietokannassa  [(CODE001)](liitteet/code001.md)

**Lopputulos**	

* Käyttäjän tunnukset on ylikirjoitettu tietokkannassa

**Käyttötiheys** 

* Kerran per sähköposti

M3156's avatar
M3156 committed
191
## Hyväksyntätestit
M3156's avatar
M3156 committed
192
193
194

| TestiID | Kuvaus |								
|:-:|:-:|
M3156's avatar
M3156 committed
195
196
197
198
199
| 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
200
201
| AT06 | [Työkalun palautus](../liitteet/at7_returnatool.md) |

M3156's avatar
M3156 committed
202
## Käsitemalli
M3156's avatar
M3156 committed
203

M3156's avatar
M3156 committed
204
205
206
207
208
209
210
211
212
### 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
213
214
```plantuml
@startuml
M3156's avatar
M3156 committed
215
216
217
218
219
220
221
222
    User --|> Tool
    Transaction --|> User
    Transaction --|> Tool
    Tool --|> ToolCategory
    Comment --|> Tool
    Comment --|> User
    User --> Rating
    Rating --|> Transaction
M3156's avatar
M3156 committed
223
224
@enduml
```
M3156's avatar
M3156 committed
225
## Luokkamalli
M3156's avatar
M3156 committed
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257

```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
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
    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
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
    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
321
    
M3156's avatar
M3156 committed
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
    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
340
341
342
343
344
345
346
347
    Tool --|> ToolCategory
    Transaction --|> Tool
    User --> Transaction
    User --> Comment
    Comment --|> Tool
    User --> Rating
    Rating --|> User
    Rating --|> Transaction
M3156's avatar
M3156 committed
348
    
M3156's avatar
M3156 committed
349
@enduml
M3156's avatar
M3156 committed
350
351
```

M3156's avatar
M3156 committed
352
## Työnjako
M3156's avatar
M3156 committed
353
354
355
356

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

M3156's avatar
M3156 committed
357
## Työaika suunnitelma
M3156's avatar
M3156 committed
358
359
360
361

* 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
362
* Viikko 14: Kaikkien ikkunoiden toimintojen parantamista, DB, Harjoitustyön suunnitelmä xD (17h)
M3156's avatar
M3156 committed
363
364
* 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
365

M3156's avatar
M3156 committed
366
367
368
369
370
Pakko myöntää etää aloin koodaamaan jo viikolla 11 ja tein tämän suunnitelman vasta viikolla 14.

# Loppuraportti

## Asennus
M3156's avatar
M3156 committed
371
372
Sovellus on pakattu zip-pakkaukseen, pakkaus pitää purkkaa sellaisenaan. Hakemistorakenteen pitää olla tasan tarkkaan sellainen kun pakkauksessa, koska sovellus käyttää 'images' - kansiotta
kuvien tallentaamiseen ja esittämiseen.
M3156's avatar
M3156 committed
373
374
375

## Tietoa ohjelmasta

M3156's avatar
M3156 committed
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
Sovellus on toteutettu suunnitelman mukaan, ei poikennut vaatimusmäärittelystä.

### Toteutetut toiminnalliset vaatimukset

| Tunnus | Ominaisuus | Prioriteetti | Toteuttumisprosentti | Muuta |
| :-: | :-: | :-: | :-: | :-: |
| FT01 | [ Tunnusten luominen ja kirjautuminen](../liitteet/f1_login.md) | Pakollinen | 100% ||
| FT02 | [ Lisää/poistaa työkalu ](../liitteet/f2_tools.md) | Pakollinen | 100% ||
| FT03 | [ Tunnusten poistaminen](../liitteet/f3_delete_account.md) | Pakollinen | 100% ||
| FT04 | [ Mahdollisuus arvioida käyttäjiä ](../liitteet/f4_rating.md) | Nice to Have | 100% ||
| FT05 | [ Työkalujen kommentoiminen ](../liitteet/f5_comment.md) | Nice to Have | 70% | Kommentit ei esinny oikeassa järjestyksessä |
| FT06 | [ Työkalujen vuokraaminen ](../liitteet/f6_rentatool.md) | Pakollinen | 100% ||
| FT07 | [ Työkalujen palautus ](../liitteet/f7_returntool.md) | Pakollinen | 100% ||

### Toteuttamatta jääneet toiminnalliset vaatimukset

Ei jäänyt yhtään toiminnallista ominaisuutta/vaatimusta toteuttamatta, ainoa missä on ongelma on 'kommentit' - ei esinny oikeassa järjestyksessä käyttöliittymässä, muuten toimii.

### Yli alkuperäisten vaatimusten toteutetut toiminnallisuudet

Toteutin piilotetun ikkunan, jossa on toiminnallisuus, joka lisää käyttäjän asettaman määrän satunnaisia työkaluja testaamista varten. Käsiksi siihen ikkunaan pääsee painamalla F1
'AddATool' ikkunan auki ollessa. Sitä ennen 'Register'-ikkunalle tein samantyylisen toiminnallisuuden, joka ei ole niinkään piilotettu. Sieltä löytyy 'Fill'-button, jota klikkamalla
pystyy täyttämään kaikki rekiströintikentät satunnaisilla arvoilla, tämäkin ominaisuus on tehty testaamista varten.

M3156's avatar
M3156 committed
400
401
## Kuvaruutukaappaukset

M3156's avatar
M3156 committed
402
### 'Login'-ikkuna
M3156's avatar
M3156 committed
403
<img src="images/itool_login.JPG" alt="iTool v1" width="400">
M3156's avatar
M3156 committed
404

M3156's avatar
M3156 committed
405
### 'Register'-ikkuna
M3156's avatar
M3156 committed
406
<img src="images/itool_register.JPG" alt="iTool v1" width="700">
M3156's avatar
M3156 committed
407

M3156's avatar
M3156 committed
408
### 'Main'-ikkuna
M3156's avatar
M3156 committed
409
<img src="images/itool_main.JPG" alt="iTool v1" width="900">
M3156's avatar
M3156 committed
410

M3156's avatar
M3156 committed
411
412
413
### 'Commment'-ikkuna
<img src="images/itool_comment.JPG" alt="iTool v1" width="500">

M3156's avatar
M3156 committed
414
### 'Profile'-ikkuna
M3156's avatar
M3156 committed
415
<img src="images/itool_profile.JPG" alt="iTool v1" width="800">
M3156's avatar
M3156 committed
416

M3156's avatar
M3156 committed
417
418
### 'Edit Profile'-ikkuna
<img src="images/itool_edit.JPG" alt="iTool v1" width="700">
M3156's avatar
M3156 committed
419

M3156's avatar
M3156 committed
420
### 'Add a Tool'-ikkuna
M3156's avatar
M3156 committed
421
<img src="images/itool_addtool.JPG" alt="iTool v1" width="700">
M3156's avatar
M3156 committed
422

M3156's avatar
M3156 committed
423
424
### Piilotettu 'Add random tools'-ikkuna
<img src="images/itool_addrandomtools.JPG" alt="iTool v1" width="300">
M3156's avatar
M3156 committed
425

M3156's avatar
M3156 committed
426
427
428
429
430
431
432
433
## Mukana tulevat tiedostot

## Tietokanta

Tietokannan suunnittelin tietokannat opintojakson harjoitustyönä. Tietokannasta on luotu 2 versitota prosessin aikana.

### iTool tietokanta versio 1

M3156's avatar
M3156 committed
434
<img src="images/iTool.JPG" alt="iTool v1" width="900">
M3156's avatar
M3156 committed
435

M3156's avatar
M3156 committed
436
437
438
439
Tässä versiossa tietokannassa oli tr_completion taulu, se taulu oli työkalun palautusta varten. Käyttäjä palauuttaa työkalun, samalla palautustapahtuma tallentuisi
tr_completion tauluun, johon kirjautuu palautus PVM, palautus kunto ja arvio kaupan toisesta osapuolesta. Transaction ja tr_completion taulujen välissä oli
yksi yhteen liitos, joten tr_completion on jätetty kokonaan pois ja transaction tauluun on lisätty palautusPVM (actualEndDate) kenttä, joka transaction käynnistyessä olisi null. 

M3156's avatar
M3156 committed
440
441
### iTool tietokanta lopullinen versio 2

M3156's avatar
M3156 committed
442
<img src="images/iTool_v3_no_captions.JPG" alt="iTool v2" width="900">
M3156's avatar
M3156 committed
443

M3156's avatar
M3156 committed
444
Tässä on lopullinen versio iTool tietokannasta, tr_completion taulu on jätetty pois ja tietokantaan on lisätty rating taulu arvioita varten. Rating taululle on tehty [trigger](liitteet/trigger.md),
M3156's avatar
M3156 committed
445
446
joka pitää huolta siitä, että käyttäjä joka jättää arvion voi vain ainoastaan arvioida kyseisen transaktion toista osapuolta yhden kerran. Comment taulussa on itseensä liitos,
koska vastaukset kommenteihin vaatii parentID.<br>
M3156's avatar
M3156 committed
447

M3156's avatar
M3156 committed
448
[Täältä löytyy tietokannan luontiskripti](liitteet/database_script.md)
M3156's avatar
M3156 committed
449

M3156's avatar
M3156 committed
450
451
452
[Queryhistoriasta](liitteet/queryhistory.md) löytyy näkymien luonti, testidatan lisäys ja erilaisia hakuja. Piti luoda 2 isoa näkymää (all_tools ja rented_tools) käyttöliittymän
toiminnallisuutta varten.

M3156's avatar
M3156 committed
453
454
455
## Ongelmat, jatkokehitysideat

## Yhteenveto