Refactor/252 ICAccount info (#254)

* Literally just merged ICAuthenticationInfo with ICServerInfo. Had to change constructors of course * Reworked the endpoint login and connection system to work with the new AccountInfo Class. This caused a lot of change in the test code * Fixed renaming issue * Removed unused method * Removed unused method * Renamed ICAccountInfo contructor (legacy artifact) * Review Requests on #254 * Recategorization and little code beautification * name-attribut artifact replacement * Made everything use anAccountINfo instead of Dictionary Made everything use 'accountName' instead of 'name' * Fixed "Account edit" * Fixed Test Defaults
hpi-swa-teaching · Jul 19, 2019 · dbba65e · dbba65e
1 parent cd402f3
commit dbba65e
Show file tree

Hide file tree

Showing 162 changed files with 429 additions and 386 deletions.
diff --git a/packages/IMAPClient-Core.package/ICAccountInfo.class/README.md b/packages/IMAPClient-Core.package/ICAccountInfo.class/README.md
@@ -0,0 +1 @@
+An ICAccountInfo is a dataobject holding information needed to connect to a server such as server address and user credentials. It also ensures basic IMAP datatype validity.
diff --git a/packages/IMAPClient-Core.package/ICAccountInfo.class/class/initialAccountName.st b/packages/IMAPClient-Core.package/ICAccountInfo.class/class/initialAccountName.st
@@ -0,0 +1,4 @@
+constants
+initialAccountName
+
+	^ String empty
diff --git a/packages/IMAPClient-Core.package/ICAccountInfo.class/class/initialSsl.st b/packages/IMAPClient-Core.package/ICAccountInfo.class/class/initialSsl.st
@@ -0,0 +1,4 @@
+constants
+initialSsl
+
+	^ true
diff --git a/...cationInfo.class/class/initialPassword.st → .../ICAccountInfo.class/class/invalidHost.st b/...cationInfo.class/class/initialPassword.st → .../ICAccountInfo.class/class/invalidHost.st
@@ -1,4 +1,4 @@
 constants
-initialPassword
+invalidHost
 
 	^ String empty
diff --git a/...cationInfo.class/class/initialUsername.st → ...ccountInfo.class/class/invalidPassword.st b/...cationInfo.class/class/initialUsername.st → ...ccountInfo.class/class/invalidPassword.st
@@ -1,4 +1,4 @@
 constants
-initialUsername
+invalidPassword
 
 	^ String empty
diff --git a/...e/ICServerInfo.class/class/defaultPort.st → .../ICAccountInfo.class/class/invalidPort.st b/...e/ICServerInfo.class/class/defaultPort.st → .../ICAccountInfo.class/class/invalidPort.st
@@ -1,4 +1,4 @@
 constants
-defaultPort
+invalidPort
 
 	^ -1
diff --git a/packages/IMAPClient-Core.package/ICAccountInfo.class/class/invalidUsername.st b/packages/IMAPClient-Core.package/ICAccountInfo.class/class/invalidUsername.st
@@ -0,0 +1,4 @@
+constants
+invalidUsername
+
+	^ String empty
diff --git a/packages/IMAPClient-Core.package/ICAccountInfo.class/class/newWith..st b/packages/IMAPClient-Core.package/ICAccountInfo.class/class/newWith..st
@@ -0,0 +1,9 @@
+instance creation
+newWith: aDataDictionary
+
+	^ self newWithAccountName: (aDataDictionary at: 'accountName') 
+		host: (aDataDictionary at: 'address')
+		port: ((aDataDictionary at: 'port') asNumber)
+		username: (aDataDictionary at: 'username')
+		password: (aDataDictionary at: 'password')
+		ssl: (aDataDictionary at: 'ssl')
diff --git a/....package/ICAccountInfo.class/class/newWithAccountName.host.port.username.password.ssl..st b/....package/ICAccountInfo.class/class/newWithAccountName.host.port.username.password.ssl..st
@@ -0,0 +1,10 @@
+instance creation
+newWithAccountName: aNameString host: aHostString port: aPortNumber username: aUsernameString password: aPasswordString ssl: aSSLBool
+
+	^ self new
+			accountName: aNameString;
+			host: aHostString;
+			port: aPortNumber;
+			username: aUsernameString;
+			password: aPasswordString;
+			ssl: aSSLBool
diff --git a/packages/IMAPClient-Core.package/ICAccountInfo.class/instance/accountName..st b/packages/IMAPClient-Core.package/ICAccountInfo.class/instance/accountName..st
@@ -0,0 +1,4 @@
+accessing
+accountName: aString
+
+	accountName := aString
diff --git a/packages/IMAPClient-Core.package/ICAccountInfo.class/instance/accountName.st b/packages/IMAPClient-Core.package/ICAccountInfo.class/instance/accountName.st
@@ -0,0 +1,4 @@
+accessing
+accountName
+
+	^ accountName ifNil: [accountName := self class initialAccountName]
diff --git a/packages/IMAPClient-Core.package/ICAccountInfo.class/instance/asDictionary.st b/packages/IMAPClient-Core.package/ICAccountInfo.class/instance/asDictionary.st
@@ -0,0 +1,14 @@
+accessing
+asDictionary
+
+	| dict |
+	dict := Dictionary new.
+	dict at: 'ssl' put: self ssl;
+		at: 'accountName' put: self accountName;
+		at: 'address' put: self host;
+		at: 'port' put: self port;
+		at: 'username' put: self username;
+		at: 'password' put: self password.
+
+	^ dict
+
diff --git a/...icationInfo.class/instance/canConvert..st → ...AccountInfo.class/instance/canConvert..st b/...icationInfo.class/instance/canConvert..st → ...AccountInfo.class/instance/canConvert..st
diff --git a/packages/IMAPClient-Core.package/ICAccountInfo.class/instance/hasValidServerInfo.st b/packages/IMAPClient-Core.package/ICAccountInfo.class/instance/hasValidServerInfo.st
@@ -0,0 +1,5 @@
+validation
+hasValidServerInfo
+
+	^ self host ~= self class invalidHost
+		and: [self port ~= self class invalidPort]
diff --git a/packages/IMAPClient-Core.package/ICAccountInfo.class/instance/hasValidUserInfo.st b/packages/IMAPClient-Core.package/ICAccountInfo.class/instance/hasValidUserInfo.st
@@ -0,0 +1,5 @@
+validation
+hasValidUserInfo
+
+	^ self username ~= self class invalidUsername
+		and: [self password ~= self class invalidPassword]
diff --git a/...kage/ICServerInfo.class/instance/host..st → ...age/ICAccountInfo.class/instance/host..st b/...kage/ICServerInfo.class/instance/host..st → ...age/ICAccountInfo.class/instance/host..st
diff --git a/packages/IMAPClient-Core.package/ICAccountInfo.class/instance/host.st b/packages/IMAPClient-Core.package/ICAccountInfo.class/instance/host.st
@@ -0,0 +1,4 @@
+accessing
+host
+
+	^ host ifNil: [host := self class invalidHost]
diff --git a/packages/IMAPClient-Core.package/ICAccountInfo.class/instance/isValid.st b/packages/IMAPClient-Core.package/ICAccountInfo.class/instance/isValid.st
@@ -0,0 +1,4 @@
+validation
+isValid
+
+	^ self hasValidServerInfo and: self hasValidUserInfo
diff --git a/...nticationInfo.class/instance/password..st → ...ICAccountInfo.class/instance/password..st b/...nticationInfo.class/instance/password..st → ...ICAccountInfo.class/instance/password..st
diff --git a/packages/IMAPClient-Core.package/ICAccountInfo.class/instance/password.st b/packages/IMAPClient-Core.package/ICAccountInfo.class/instance/password.st
@@ -0,0 +1,4 @@
+accessing
+password
+
+	^ password ifNil: [password := self class invalidPassword]
diff --git a/...fo.class/instance/passwordAsIMAPString.st → ...fo.class/instance/passwordAsIMAPString.st b/...fo.class/instance/passwordAsIMAPString.st → ...fo.class/instance/passwordAsIMAPString.st
diff --git a/...kage/ICServerInfo.class/instance/port..st → ...age/ICAccountInfo.class/instance/port..st b/...kage/ICServerInfo.class/instance/port..st → ...age/ICAccountInfo.class/instance/port..st
diff --git a/packages/IMAPClient-Core.package/ICAccountInfo.class/instance/port.st b/packages/IMAPClient-Core.package/ICAccountInfo.class/instance/port.st
@@ -0,0 +1,4 @@
+accessing
+port
+
+	^ port ifNil: [port := self class invalidPort]
diff --git a/packages/IMAPClient-Core.package/ICAccountInfo.class/instance/printOn..st b/packages/IMAPClient-Core.package/ICAccountInfo.class/instance/printOn..st
@@ -0,0 +1,4 @@
+printing
+printOn: aStream
+
+	aStream nextPutAll: self accountName, ' ', self host, ' ', self port, ' ', self username, ' ', self password, ' ', self ssl
diff --git a/...package/ICEndPoint.class/instance/ssl..st → ...kage/ICAccountInfo.class/instance/ssl..st b/...package/ICEndPoint.class/instance/ssl..st → ...kage/ICAccountInfo.class/instance/ssl..st
diff --git a/packages/IMAPClient-Core.package/ICAccountInfo.class/instance/ssl.st b/packages/IMAPClient-Core.package/ICAccountInfo.class/instance/ssl.st
@@ -0,0 +1,4 @@
+accessing
+ssl
+
+	^ ssl ifNil: [ssl := self class initialSsl]
diff --git a/...nticationInfo.class/instance/username..st → ...ICAccountInfo.class/instance/username..st b/...nticationInfo.class/instance/username..st → ...ICAccountInfo.class/instance/username..st
diff --git a/packages/IMAPClient-Core.package/ICAccountInfo.class/instance/username.st b/packages/IMAPClient-Core.package/ICAccountInfo.class/instance/username.st
@@ -0,0 +1,4 @@
+accessing
+username
+
+	^ username ifNil: [username := self class invalidUsername].
diff --git a/...fo.class/instance/usernameAsIMAPString.st → ...fo.class/instance/usernameAsIMAPString.st b/...fo.class/instance/usernameAsIMAPString.st → ...fo.class/instance/usernameAsIMAPString.st
diff --git a/packages/IMAPClient-Core.package/ICAccountInfo.class/methodProperties.json b/packages/IMAPClient-Core.package/ICAccountInfo.class/methodProperties.json
@@ -0,0 +1,31 @@
+{
+	"class" : {
+		"initialAccountName" : "tg 7/10/2019 17:43",
+		"initialSsl" : "tg 7/10/2019 17:43",
+		"invalidHost" : "tg 7/10/2019 20:08",
+		"invalidPassword" : "tg 7/10/2019 20:10",
+		"invalidPort" : "tg 7/10/2019 20:09",
+		"invalidUsername" : "tg 7/10/2019 20:10",
+		"newWith:" : "tg 7/18/2019 23:08",
+		"newWithAccountName:host:port:username:password:ssl:" : "tg 7/18/2019 23:01" },
+	"instance" : {
+		"accountName" : "tg 7/10/2019 20:20",
+		"accountName:" : "tg 7/10/2019 17:35",
+		"asDictionary" : "tg 7/18/2019 23:07",
+		"canConvert:" : "tg 7/10/2019 17:18",
+		"hasValidServerInfo" : "tg 7/15/2019 12:08",
+		"hasValidUserInfo" : "tg 7/15/2019 12:08",
+		"host" : "tg 7/10/2019 20:06",
+		"host:" : "tg 7/10/2019 17:11",
+		"isValid" : "tg 7/15/2019 12:08",
+		"password" : "tg 7/15/2019 12:11",
+		"password:" : "tg 7/10/2019 17:18",
+		"passwordAsIMAPString" : "tg 7/10/2019 17:18",
+		"port" : "tg 7/10/2019 20:09",
+		"port:" : "tg 7/10/2019 17:11",
+		"printOn:" : "tg 7/10/2019 18:06",
+		"ssl" : "tg 7/10/2019 20:21",
+		"ssl:" : "tg 7/10/2019 17:34",
+		"username" : "tg 7/15/2019 12:11",
+		"username:" : "tg 7/10/2019 17:18",
+		"usernameAsIMAPString" : "tg 7/10/2019 17:18" } }
diff --git a/...CAuthenticationInfo.class/properties.json → ...ckage/ICAccountInfo.class/properties.json b/...CAuthenticationInfo.class/properties.json → ...ckage/ICAccountInfo.class/properties.json
@@ -4,11 +4,15 @@
 		 ],
 	"classvars" : [
 		 ],
-	"commentStamp" : "tg 7/9/2019 14:40",
+	"commentStamp" : "tg 7/15/2019 12:14",
 	"instvars" : [
+		"accountName",
+		"host",
+		"port",
 		"username",
-		"password" ],
-	"name" : "ICAuthenticationInfo",
+		"password",
+		"ssl" ],
+	"name" : "ICAccountInfo",
 	"pools" : [
 		 ],
 	"super" : "Object",

diff --git a/packages/IMAPClient-Core.package/ICAuthenticationInfo.class/README.md b/packages/IMAPClient-Core.package/ICAuthenticationInfo.class/README.md
diff --git a/packages/IMAPClient-Core.package/ICAuthenticationInfo.class/class/for.using..st b/packages/IMAPClient-Core.package/ICAuthenticationInfo.class/class/for.using..st
diff --git a/packages/IMAPClient-Core.package/ICAuthenticationInfo.class/instance/isValid.st b/packages/IMAPClient-Core.package/ICAuthenticationInfo.class/instance/isValid.st
diff --git a/packages/IMAPClient-Core.package/ICAuthenticationInfo.class/instance/password.st b/packages/IMAPClient-Core.package/ICAuthenticationInfo.class/instance/password.st
diff --git a/packages/IMAPClient-Core.package/ICAuthenticationInfo.class/instance/username.st b/packages/IMAPClient-Core.package/ICAuthenticationInfo.class/instance/username.st
diff --git a/packages/IMAPClient-Core.package/ICAuthenticationInfo.class/methodProperties.json b/packages/IMAPClient-Core.package/ICAuthenticationInfo.class/methodProperties.json
diff --git a/packages/IMAPClient-Core.package/ICEndPoint.class/class/checkValidConfiguration..st b/packages/IMAPClient-Core.package/ICEndPoint.class/class/checkValidConfiguration..st
@@ -4,5 +4,5 @@ checkValidConfiguration: aDataDictionary
 	^ (aDataDictionary includesKey: 'username') and:
 	(aDataDictionary includesKey: 'port') and:
 	(aDataDictionary includesKey: 'address') and:
-	(aDataDictionary includesKey: 'name') and:
+	(aDataDictionary includesKey: 'accountName') and:
 	(aDataDictionary includesKey: 'ssl')
diff --git a/packages/IMAPClient-Core.package/ICEndPoint.class/class/defaultStreamClass.st b/packages/IMAPClient-Core.package/ICEndPoint.class/class/defaultStreamClass.st
@@ -0,0 +1,4 @@
+constants
+defaultStreamClass
+
+	^ SocketStream
diff --git a/...Point.class/instance/folderNameOfTrash.st → ...EndPoint.class/class/folderNameOfTrash.st b/...Point.class/instance/folderNameOfTrash.st → ...EndPoint.class/class/folderNameOfTrash.st
@@ -1,4 +1,4 @@
-accessing
+constants
 folderNameOfTrash
 
 	^ 'Trash'
diff --git a/packages/IMAPClient-Core.package/ICEndPoint.class/instance/accountInfo..st b/packages/IMAPClient-Core.package/ICEndPoint.class/instance/accountInfo..st
@@ -0,0 +1,4 @@
+accessing
+accountInfo: anICAccountInfo
+
+	accountInfo := anICAccountInfo
diff --git a/packages/IMAPClient-Core.package/ICEndPoint.class/instance/accountInfo.st b/packages/IMAPClient-Core.package/ICEndPoint.class/instance/accountInfo.st
@@ -0,0 +1,4 @@
+accessing
+accountInfo
+
+	^ accountInfo ifNil: [accountInfo := ICAccountInfo new]
diff --git a/packages/IMAPClient-Core.package/ICEndPoint.class/instance/asAccountInfoDictionary.st b/packages/IMAPClient-Core.package/ICEndPoint.class/instance/asAccountInfoDictionary.st
@@ -0,0 +1,4 @@
+accessing
+asAccountInfoDictionary
+
+	^ self accountInfo asDictionary
diff --git a/packages/IMAPClient-Core.package/ICEndPoint.class/instance/asDictionary.st b/packages/IMAPClient-Core.package/ICEndPoint.class/instance/asDictionary.st
diff --git a/packages/IMAPClient-Core.package/ICEndPoint.class/instance/authenticationInfo..st b/packages/IMAPClient-Core.package/ICEndPoint.class/instance/authenticationInfo..st
diff --git a/packages/IMAPClient-Core.package/ICEndPoint.class/instance/authenticationInfo.st b/packages/IMAPClient-Core.package/ICEndPoint.class/instance/authenticationInfo.st
diff --git a/packages/IMAPClient-Core.package/ICEndPoint.class/instance/checkConnected.st b/packages/IMAPClient-Core.package/ICEndPoint.class/instance/checkConnected.st
@@ -1,6 +1,6 @@
 error handling
 checkConnected
-
+	
 	(self fatalErrorOccured)
 		ifTrue: [^ false].
 

diff --git a/packages/IMAPClient-Core.package/ICEndPoint.class/instance/checkForParameterError.st b/packages/IMAPClient-Core.package/ICEndPoint.class/instance/checkForParameterError.st
@@ -1,4 +1,4 @@
-connection
+error handling
 checkForParameterError
 
 	(self fatalErrorOccured)

diff --git a/packages/IMAPClient-Core.package/ICEndPoint.class/instance/checkLoggedIn.st b/packages/IMAPClient-Core.package/ICEndPoint.class/instance/checkLoggedIn.st
@@ -4,7 +4,7 @@ checkLoggedIn
 	(self fatalErrorOccured)
 		ifTrue: [^ false].
 
-	self isLoggedIn ifFalse: [
+	self loggedIn ifFalse: [
 		self fatalErrorOccured: true.
 		^ false].
 

diff --git a/packages/IMAPClient-Core.package/ICEndPoint.class/instance/close.st b/packages/IMAPClient-Core.package/ICEndPoint.class/instance/close.st
@@ -1,4 +1,4 @@
-login
+connection
 close
 
 	self stream close.

diff --git a/packages/IMAPClient-Core.package/ICEndPoint.class/instance/connect.st b/packages/IMAPClient-Core.package/ICEndPoint.class/instance/connect.st
@@ -0,0 +1,4 @@
+connection
+connect
+
+	self connectWith: self class defaultStreamClass
diff --git a/packages/IMAPClient-Core.package/ICEndPoint.class/instance/connectAndLoginWith..st b/packages/IMAPClient-Core.package/ICEndPoint.class/instance/connectAndLoginWith..st
@@ -0,0 +1,14 @@
+connection
+connectAndLoginWith: anICAccountInfo
+
+	self accountInfo: anICAccountInfo.
+
+	[self
+		connect;
+		login]
+	valueWithin: 2 seconds 
+	onTimeout: [
+		(self fatalErrorOccured)
+			ifFalse: [
+				UIManager default inform: 'Connection could not be established'.
+				self fatalErrorOccured: true]]
diff --git a/packages/IMAPClient-Core.package/ICEndPoint.class/instance/connectTo.on..st b/packages/IMAPClient-Core.package/ICEndPoint.class/instance/connectTo.on..st
diff --git a/packages/IMAPClient-Core.package/ICEndPoint.class/instance/connectTo.on.with..st b/packages/IMAPClient-Core.package/ICEndPoint.class/instance/connectTo.on.with..st
diff --git a/packages/IMAPClient-Core.package/ICEndPoint.class/instance/connectTo.with..st b/packages/IMAPClient-Core.package/ICEndPoint.class/instance/connectTo.with..st
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1 @@
		An ICAccountInfo is a dataobject holding information needed to connect to a server such as server address and user credentials. It also ensures basic IMAP datatype validity.