Merge branch 'develop' into feature/refactor_endpoint

.github/pull_request_template.md

@@ -0,0 +1,26 @@
+## What does this change?
+
+[Bug/Feature]*First, briefly describe what this merge request does.*
+
+*Then, describe the changes in more detail (tests added, summary of )*
+*Make sure potential reviewers have enough information to quickly dive in and understand the changes.*
+Fixes *#number*
+
+Co-authored-by: *name <name@example.com>*
+Co-authored-by: *another-name <another-name@example.com>*
+
+
+## Decisions / Choices I made
+
+*This text should provide background information on the changes you did (optional). A great merge request answers at least the following question:*
+*- Which architectural or implementation decisions did you make? And why?*
+
+*Remember: The more information you give other developers, the easier it is for them 
+to understand and review the code, and the more helpful their review will ultimately be.*
+
+
+## Checklist
+
+- [ ] Your branch has no merge conflicts with master
+- [ ] All related commits are squashed together
+- [ ] Singleton / Database changed*: if changed which Singleton*

README.md

@@ -1,7 +1,7 @@
-# IMAPClient [![Build Status](https://travis-ci.org/hpi-swa-teaching/IMAPClient.svg?branch=develop)](https://travis-ci.org/hpi-swa-teaching/IMAPClient) [![Coverage Status](https://coveralls.io/repos/github/hpi-swa-teaching/IMAPClient/badge.svg?branch=develop)](https://coveralls.io/github/hpi-swa-teaching/IMAPClient?branch=develop)
+# IMAPClient [![Coverage Status](https://coveralls.io/repos/github/hpi-swa-teaching/IMAPClient/badge.svg?branch=develop)](https://coveralls.io/github/hpi-swa-teaching/IMAPClient?branch=develop)
 
 Welcome to our IMAP Client project. We are a team of 4th semester IT-Systems Engineering students and are happy to take over this project for the sixth iteration.
-This project is part of a lecture in Softwareengineering techniques and will be contributing to our final grade, so we are giving it our best ;)
+This project is part of a lecture in Software Engineering techniques and will be contributing to our final grade, so we are giving it our best ;)
 As this is a student project, it will mostly be worked on during the summer terms. Therefore our time with this project is limited to the end of july.
 
 In case of any questions, feel free to contact us.
@@ -97,7 +97,7 @@ After closing the IMAP-Client and reopening it your are welcomed by a password p
 As this project has lived through many iterations, there are a couple of known issues that we could not resolve during the few months we spend with this project. 
 If you encounter any problem while using our IMAP client, have a look at the Issues of this GitHub Project. Most of them are probably already known to us.
 In case your problem has not been reported yet, feel free to post a new issue and describe what you did to get the problem, what the unexpected behaviour was and what behaviour you would have expected. 
-Thank you in anvance for contributing to making this project better by reporting any problems that we are not yet aware of!
+Thank you in advance for contributing to making this project better by reporting any problems that we are not yet aware of!
 
 ## Documentation
 
@@ -113,3 +113,5 @@ Hava a look at the GitHub Project Wiki to find more insights into the project.
 2019: Paul Methfessel, Martin Taraz, Otto Kissig, Tim Garrels, Felix Rindt
 
 2020: Henrik Guhl, Lorenz Woth, Niko Hastrich, Julia Joch
+
+2021: Smilla Fox, Elena Gensch, Jan Groeneveld, Christian Helms, Lukas Rost, Johann Schulze Tast

packages/IMAPClient-Core.package/ICAddressBook.class/instance/initialize.st

@@ -0,0 +1,2 @@
+initialize
+initialize

packages/IMAPClient-Core.package/ICContact.class/class/newWith.with..st

@@ -4,4 +4,4 @@ newWith: anEmail with: aName
 	^ ICContact new
 		email: anEmail;
 		name: aName;
-		yourself
+		yourself

packages/IMAPClient-Core.package/ICContact.class/instance/asString.st

@@ -1,4 +1,4 @@
 accessing
 asString
 
-	^ (self name truncateTo: 30), Character tab, self email
+	^ (self name truncateTo: 40), Character tab, self email

packages/IMAPClient-Core.package/ICContact.class/methodProperties.json

@@ -2,7 +2,7 @@
 	"class" : {
 		"newWith:with:" : "EG 5/29/2021 23:20" },
 	"instance" : {
-		"asString" : "c.h. 5/25/2021 09:30",
+		"asString" : "lro 6/3/2021 11:48",
 		"email" : "EG 5/21/2021 00:03",
 		"email:" : "EG 5/21/2021 00:03",
 		"name" : "EG 5/21/2021 00:03",

packages/IMAPClient-Core.package/ICEmail.class/instance/senderName.st

@@ -3,4 +3,4 @@ senderName
 
 	| fromCollection |
 	fromCollection := self from findBetweenSubStrs: self class senderAddressDelimeters.
-	^ (fromCollection at: 1 ifAbsent: [ '' ])
+	^ ((fromCollection at: 1 ifAbsent: [ '' ]) subStrings: '"') at: 1

packages/IMAPClient-Core.package/ICEmail.class/methodProperties.json

@@ -39,7 +39,7 @@
 		"seen:" : "C.G. 7/25/2018 13:49",
 		"sender" : "EG 5/30/2021 12:20",
 		"senderAddressFromHeader" : "LW 8/2/2020 13:58",
-		"senderName" : "EG 5/30/2021 12:20",
+		"senderName" : "lro 6/3/2021 11:47",
 		"serializeToJson" : "hg 7/29/2020 15:25",
 		"subject" : "tg 7/19/2019 11:45",
 		"subject:" : "C.G. 7/25/2018 13:49",

packages/IMAPClient-Core.package/ICFolder.class/instance/startUpdateProcess..st

@@ -1,8 +1,10 @@
 action - update emails
 startUpdateProcess: anUID
 
-	(self folderName = 'root') ifTrue: [^self].
+	(self folderName = 'root') ifTrue: [^true].
 
-	anUID
+	[anUID
 		ifNil: [self fetchNumberOfLatestEmails: self class numberOfHeadersToFetchAtTheBeginning]
-		ifNotNil: [self fetchEmailsFrom: anUID]
+		ifNotNil: [self fetchEmailsFrom: anUID]. ^true]
+	on: Error
+	do: [:e | self inform: e asString. ^false]

packages/IMAPClient-Core.package/ICFolder.class/instance/updateAndShowProgressWith..st

@@ -1,9 +1,11 @@
 action - update emails
 updateAndShowProgressWith: aBlock
 
+	|successful|
 	ProgressNotification 
 		signal: (aBlock value) 
 		extra: (self accountName, ' Mailbox. Folder: ', self folderName).
 
-	self startUpdateProcess: self highestUniqueID.
-	self childFolders do: [:anICFolder | anICFolder updateAndShowProgressWith: aBlock]
+	successful := self startUpdateProcess: self highestUniqueID.
+	self childFolders do: [:anICFolder | successful := successful and: (anICFolder updateAndShowProgressWith: aBlock)].
+	^ successful

packages/IMAPClient-Tests.package/ICAddressBookDialogTest.class/README.md

@@ -0,0 +1 @@
+This class tests the ICAddressBookDialog (especially the sorting feature).

packages/IMAPClient-Tests.package/ICAddressBookDialogTest.class/instance/addressBook..st

@@ -0,0 +1,3 @@
+accessing
+addressBook: anObject
+	addressBook := anObject

packages/IMAPClient-Tests.package/ICAddressBookDialogTest.class/instance/addressBook.st

@@ -0,0 +1,3 @@
+accessing
+addressBook
+	^ addressBook

packages/IMAPClient-Tests.package/ICAddressBookDialogTest.class/instance/addressBookDialog..st

@@ -0,0 +1,3 @@
+accessing
+addressBookDialog: anObject
+	addressBookDialog := anObject

packages/IMAPClient-Tests.package/ICAddressBookDialogTest.class/instance/addressBookDialog.st

@@ -0,0 +1,3 @@
+accessing
+addressBookDialog
+	^ addressBookDialog

packages/IMAPClient-Tests.package/ICAddressBookDialogTest.class/instance/contactList..st

@@ -0,0 +1,3 @@
+accessing
+contactList: anObject
+	contactList := anObject

packages/IMAPClient-Tests.package/ICAddressBookDialogTest.class/instance/contactList.st

@@ -0,0 +1,3 @@
+accessing
+contactList
+	^ contactList

packages/IMAPClient-Tests.package/ICAddressBookDialogTest.class/instance/emailAccounts..st

@@ -0,0 +1,3 @@
+accessing
+emailAccounts: anObject
+	emailAccounts := anObject

packages/IMAPClient-Tests.package/ICAddressBookDialogTest.class/instance/emailAccounts.st

@@ -0,0 +1,3 @@
+accessing
+emailAccounts
+	^ emailAccounts

packages/IMAPClient-Tests.package/ICAddressBookDialogTest.class/instance/expectedSortedByMail.st

@@ -0,0 +1,7 @@
+constants
+expectedSortedByMail
+
+	  ^ {'Erika Musterfrau', Character tab, 'erika.musterfrau@rocks.de'.
+		  'Musterfirma GmbH', Character tab, 'info@musterfirma.de'.
+		  'Max Mustermann', Character tab, 'max.mustermann@rocks.de'.} 
+		asOrderedCollection.

packages/IMAPClient-Tests.package/ICAddressBookDialogTest.class/instance/expectedSortedByName.st

@@ -0,0 +1,7 @@
+constants
+expectedSortedByName
+
+	  ^ {'Erika Musterfrau', Character tab, 'erika.musterfrau@rocks.de'.
+		  'Max Mustermann', Character tab, 'max.mustermann@rocks.de'.
+		  'Musterfirma GmbH', Character tab, 'info@musterfirma.de'.} 
+		asOrderedCollection.

packages/IMAPClient-Tests.package/ICAddressBookDialogTest.class/instance/setUp.st

@@ -0,0 +1,15 @@
+running
+setUp
+
+	self contactList: 
+		{(ICContact newWith: 'erika.musterfrau@rocks.de' with: 'Erika Musterfrau') asString.
+		  (ICContact newWith: 'max.mustermann@rocks.de' with: 'Max Mustermann') asString.
+		  (ICContact newWith: 'info@musterfirma.de' with: 'Musterfirma GmbH') asString.} 
+		asOrderedCollection.
+
+	self addressBook: ICAddressBook new.
+	self addressBook removeAll.
+	self addressBook addAll: contactList.
+
+	self addressBookDialog: ICAddressBookDialog basicNew.
+

packages/IMAPClient-Tests.package/ICAddressBookDialogTest.class/instance/tearDown.st

@@ -0,0 +1,4 @@
+running
+tearDown
+
+	self addressBook removeAll

packages/IMAPClient-Tests.package/ICAddressBookDialogTest.class/instance/testSortByMail.st

@@ -0,0 +1,5 @@
+sorting entries
+testSortByMail
+
+	self addressBookDialog sortByMail.
+	self assert: self addressBook asOrderedCollection equals: self expectedSortedByMail.

packages/IMAPClient-Tests.package/ICAddressBookDialogTest.class/instance/testSortByMailReversed.st

@@ -0,0 +1,6 @@
+sorting entries
+testSortByMailReversed
+
+	self addressBookDialog sortByMail.
+	self addressBookDialog sortByMail.
+	self assert: self addressBook asOrderedCollection equals: self expectedSortedByMail reversed

packages/IMAPClient-Tests.package/ICAddressBookDialogTest.class/instance/testSortByName.st

@@ -0,0 +1,5 @@
+sorting entries
+testSortByName
+
+	self addressBookDialog sortByName.
+	self assert: self addressBook asOrderedCollection equals: self expectedSortedByName

packages/IMAPClient-Tests.package/ICAddressBookDialogTest.class/instance/testSortByNameReversed.st

@@ -0,0 +1,6 @@
+sorting entries
+testSortByNameReversed
+
+	self addressBookDialog sortByName.
+	self addressBookDialog sortByName.
+	self assert: self addressBook asOrderedCollection equals: self expectedSortedByName reversed

packages/IMAPClient-Tests.package/ICAddressBookDialogTest.class/methodProperties.json

@@ -0,0 +1,20 @@
+{
+	"class" : {
+		 },
+	"instance" : {
+		"addressBook" : "lro 6/10/2021 09:58",
+		"addressBook:" : "lro 6/10/2021 09:58",
+		"addressBookDialog" : "lro 6/10/2021 09:59",
+		"addressBookDialog:" : "lro 6/10/2021 09:59",
+		"contactList" : "lro 6/10/2021 09:59",
+		"contactList:" : "lro 6/10/2021 09:59",
+		"emailAccounts" : "lro 6/10/2021 10:09",
+		"emailAccounts:" : "lro 6/10/2021 10:09",
+		"expectedSortedByMail" : "lro 6/10/2021 11:08",
+		"expectedSortedByName" : "lro 6/10/2021 11:08",
+		"setUp" : "lro 6/10/2021 11:26",
+		"tearDown" : "lro 6/10/2021 11:25",
+		"testSortByMail" : "lro 6/10/2021 11:23",
+		"testSortByMailReversed" : "lro 6/10/2021 11:23",
+		"testSortByName" : "lro 6/10/2021 11:23",
+		"testSortByNameReversed" : "lro 6/10/2021 11:23" } }

packages/IMAPClient-Tests.package/ICAddressBookDialogTest.class/properties.json

@@ -0,0 +1,17 @@
+{
+	"category" : "IMAPClient-Tests",
+	"classinstvars" : [
+		 ],
+	"classvars" : [
+		 ],
+	"commentStamp" : "lro 6/10/2021 09:56",
+	"instvars" : [
+		"addressBook",
+		"addressBookDialog",
+		"contactList",
+		"emailAccounts" ],
+	"name" : "ICAddressBookDialogTest",
+	"pools" : [
+		 ],
+	"super" : "TestCase",
+	"type" : "normal" }

packages/IMAPClient-Tests.package/ICAddressBookTest.class/instance/setUp.st

@@ -2,7 +2,7 @@ running
 setUp
 	self addressBook: (ICAddressBook new: 10).
 
-	self emailContact: 
+	self emailContact:
 		(ICContact newWith: 'erika.musterfrau@rocks.de' with: 'Erika Musterfrau') asString.
 
-	self emailAccounts: ICMockEndpoint new asOrderedCollection
+	self emailAccounts: ICMockEndpoint new asOrderedCollection

packages/IMAPClient-Tests.package/ICAddressBookTest.class/instance/testFindEntry.st

@@ -3,4 +3,4 @@ testFindEntry
 
 	self addressBook addEmail: self emailContact.
 
-	self assert: (self addressBook find: self emailContact) equals: self emailContact
+	self assert: (self addressBook find: self emailContact) equals: self emailContact

packages/IMAPClient-Tests.package/ICContactTest.class/instance/setUp.st

@@ -1,4 +1,4 @@
 running
 setUp
 
-	self contact: (ICContact newWith: 'erika.musterfrau@rocks.de' with: 'Erika Musterfrau')
+	self contact: (ICContact newWith: 'erika.musterfrau@rocks.de' with: 'Erika Musterfrau')

packages/IMAPClient-Tests.package/ICContactTest.class/instance/testAsString.st

@@ -1,4 +1,4 @@
 test - converting
 testAsString
 
-	self assert: self contact asString equals: self class expectedStringRepresentation
+	self assert: self contact asString equals: self class expectedStringRepresentation

packages/IMAPClient-UI.package/ICAddressBookDialog.class/instance/buildAddressBookPanel..st

@@ -6,4 +6,7 @@ buildAddressBookPanel: builder
 		model: self;
 		frame: (0.0 @ 0.0 extent: 1 @ self buttonOffset);
 		children: {
-			self buildButton: (0 @ 0 extent: 1 @ 1) with: self class addContactIcon with: #addContact with: builder.}
+			self buildButton: (0 @ 0 extent: 0.2 @ 1) with: self class addContactIcon with: #addContact with: builder.
+			self buildButton: (0.2 @ 0 extent: 0.4 @ 1) with: 'Sort by name' with: #sortByName with: builder.
+			self buildButton: (0.6 @ 0 extent: 0.4 @ 1) with: 'Sort by mail' with: #sortByMail with: builder.
+			}

packages/IMAPClient-UI.package/ICAddressBookDialog.class/instance/initializeMailEmailAddresses.st

@@ -2,4 +2,5 @@ action
 initializeMailEmailAddresses
 
 	self addressBook feedMeWithEntries: self emailAccounts.
+	self sortByName.
 	self	changed: #addressBook

packages/IMAPClient-UI.package/ICAddressBookDialog.class/instance/invalidateSorting.st

@@ -0,0 +1,4 @@
+action
+invalidateSorting
+
+	self sortMethod: #invalid

packages/IMAPClient-UI.package/ICAddressBookDialog.class/instance/reverseContacts.st

@@ -0,0 +1,4 @@
+action
+reverseContacts
+
+	self addressBook reverseInPlace.

packages/IMAPClient-UI.package/ICAddressBookDialog.class/instance/sortBlocks.st

@@ -0,0 +1,10 @@
+accessing
+sortBlocks
+
+	^ Dictionary withAll: {
+			#mail
+				-> [:aContactString :anotherContactString | ((aContactString splitBy: Character tab asString) at: 2)
+					caseInsensitiveLessOrEqual: ((anotherContactString splitBy: Character tab asString) at: 2)]. 
+			#name
+				-> [:aContactString :anotherContactString | ((aContactString splitBy: Character tab asString) at: 1)
+					caseInsensitiveLessOrEqual: ((anotherContactString splitBy: Character tab asString) at: 1)]}

packages/IMAPClient-UI.package/ICAddressBookDialog.class/instance/sortByMail.st

@@ -0,0 +1,4 @@
+action
+sortByMail
+
+	self sortContactsBy: #mail

packages/IMAPClient-UI.package/ICAddressBookDialog.class/instance/sortByName.st

@@ -0,0 +1,4 @@
+action
+sortByName
+
+	self sortContactsBy: #name

packages/IMAPClient-UI.package/ICAddressBookDialog.class/instance/sortContactsBy..st

@@ -0,0 +1,9 @@
+action
+sortContactsBy: aMethod
+
+	self sortMethod = aMethod ifTrue: [self reverseContacts] 
+		ifFalse: [
+			self sortMethod: aMethod.
+			self addressBook sort: (self sortBlocks at: aMethod)
+		].
+	self changed: #addressBook

packages/IMAPClient-UI.package/ICAddressBookDialog.class/instance/sortMethod..st

@@ -0,0 +1,4 @@
+accessing
+sortMethod: anObject
+
+	sortMethod := anObject

packages/IMAPClient-UI.package/ICAddressBookDialog.class/instance/sortMethod.st

@@ -0,0 +1,4 @@
+accessing
+sortMethod
+
+	^ sortMethod