Deprecate existing newTemporaryFileReference in favour of `newTempo…

…raryFile` which returns a pathString consistent with other Grease file-handling methods
SeasideSt · Feb 4, 2024 · 4d9ea9f · 4d9ea9f
1 parent 788fa15
commit 4d9ea9f
Show file tree

Hide file tree

Showing 10 changed files with 52 additions and 11 deletions.
diff --git a/repository/Grease-Core.package/GRPlatform.class/instance/newTemporaryFile.st b/repository/Grease-Core.package/GRPlatform.class/instance/newTemporaryFile.st
@@ -0,0 +1,6 @@
+files
+newTemporaryFile
+	"Create a new temporary file in the systems temp directory and answer its pathString.
+	It is the users responsibility to delete or move the file, it will not be cleaned up automatically 
+	(unless the host system has a policy for it)."
+	^ self subclassResponsibility
diff --git a/repository/Grease-Core.package/GRPlatform.class/instance/newTemporaryFileNamed..st b/repository/Grease-Core.package/GRPlatform.class/instance/newTemporaryFileNamed..st
@@ -0,0 +1,6 @@
+files
+newTemporaryFileNamed: aName
+	"Create a new temporary file in the systems temp directory and answer its pathString.
+	It is the users responsibility to delete or move the file, it will not be cleaned up automatically 
+	(unless the host system has a policy for it)."
+	self subclassResponsibility
diff --git a/repository/Grease-Core.package/GRPlatform.class/instance/newTemporaryFileReference.st b/repository/Grease-Core.package/GRPlatform.class/instance/newTemporaryFileReference.st
diff --git a/repository/Grease-Core.package/GRPlatform.class/instance/newTemporaryFileReferenceNamed..st b/repository/Grease-Core.package/GRPlatform.class/instance/newTemporaryFileReferenceNamed..st
diff --git a/repository/Grease-Pharo100-Core.package/GRPharoPlatform.class/instance/newTemporaryFile.st b/repository/Grease-Pharo100-Core.package/GRPharoPlatform.class/instance/newTemporaryFile.st
@@ -0,0 +1,4 @@
+files
+newTemporaryFile
+
+	^ self newTemporaryFileNamed: UUID new greaseString
diff --git a/...ory/Grease-Pharo100-Core.package/GRPharoPlatform.class/instance/newTemporaryFileNamed..st b/...ory/Grease-Pharo100-Core.package/GRPharoPlatform.class/instance/newTemporaryFileNamed..st
@@ -0,0 +1,4 @@
+files
+newTemporaryFileNamed: aName
+
+	^ (FileLocator temp / aName) pathString
diff --git a/.../Grease-Pharo100-Core.package/GRPharoPlatform.class/instance/newTemporaryFileReference.st b/.../Grease-Pharo100-Core.package/GRPharoPlatform.class/instance/newTemporaryFileReference.st
@@ -5,4 +5,7 @@ newTemporaryFileReference
 	It is the users responsibility to delete or move the file,
 	it will not be cleaned up automatically (unless the host system
 	has a policy for it)."
+	self 
+		greaseDeprecatedApi: 'GRPlatform>>newTemporaryFileReference' 
+		details: 'Use newTemporaryFile'.
 	^ self newTemporaryFileReferenceNamed: UUID new asString
diff --git a/...e-Pharo100-Core.package/GRPharoPlatform.class/instance/newTemporaryFileReferenceNamed..st b/...e-Pharo100-Core.package/GRPharoPlatform.class/instance/newTemporaryFileReferenceNamed..st
@@ -5,4 +5,7 @@ newTemporaryFileReferenceNamed: aName
 	It is the users responsibility to delete or move the file,
 	it will not be cleaned up automatically (unless the host system
 	has a policy for it)."
+	self
+		greaseDeprecatedApi: 'GRPlatform>>newTemporaryFileReferenceNamed:'
+		details: 'Use newTemporaryFileNamed:'.
 	^ FileLocator temp / aName
diff --git a/repository/Grease-Tests-Core.package/GRPlatformTest.class/instance/testNewTemporaryFile.st b/repository/Grease-Tests-Core.package/GRPlatformTest.class/instance/testNewTemporaryFile.st
@@ -0,0 +1,13 @@
+tests-files
+testNewTemporaryFile
+
+	| temporaryFile |
+	[
+		temporaryFile := GRPlatform current newTemporaryFile.
+		GRPlatform current
+			writeFileStreamOn: temporaryFile
+			do: [ :str | str nextPutAll: 'test temporary' ]
+			binary: false.
+		self assert: (GRPlatform current fileExists: temporaryFile)
+	] ensure: [ GRPlatform current deleteFile: temporaryFile ].
+	self deny: (GRPlatform current fileExists: temporaryFile)
diff --git a/...tory/Grease-Tests-Core.package/GRPlatformTest.class/instance/testNewTemporaryFileNamed.st b/...tory/Grease-Tests-Core.package/GRPlatformTest.class/instance/testNewTemporaryFileNamed.st
@@ -0,0 +1,13 @@
+tests-files
+testNewTemporaryFileNamed
+
+	| temporaryFile |
+	[
+		temporaryFile := GRPlatform current newTemporaryFileNamed: 'test_temporary'.
+		GRPlatform current
+			writeFileStreamOn: temporaryFile
+			do: [ :str | str nextPutAll: 'test temporary' ]
+			binary: false.
+		self assert: (GRPlatform current fileExists: temporaryFile)
+	] ensure: [ GRPlatform current deleteFile: temporaryFile ].
+	self deny: (GRPlatform current fileExists: temporaryFile)