Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Change temporary file creation api #169

Merged
merged 17 commits into from
Feb 4, 2024
Merged

Change temporary file creation api #169

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
17 commits
Select commit Hold shift + click to select a range
788fa15
Added support for newTemporaryFileReference in GemStone versions high…
jbrichau Feb 3, 2024
4d9ea9f
Deprecate existing `newTemporaryFileReference` in favour of `newTempo…
jbrichau Feb 4, 2024
0176ed2
added temporary file creation methods to older Pharo versions
jbrichau Feb 4, 2024
c83bb49
added new temporary file creation methods to GemStone
jbrichau Feb 4, 2024
acf5760
moved method to GemStone-Core package and implemented missing deleteF…
jbrichau Feb 4, 2024
602230d
added file methods for Squeak 6
jbrichau Feb 4, 2024
454b8de
Also add temporary file creation methods to Squeak 5
jbrichau Feb 4, 2024
34bd7c3
added deleteFile: to Squeak
jbrichau Feb 4, 2024
f7d355f
fix missing method in Squeak 6
jbrichau Feb 4, 2024
f20c01f
Test unique name of two generated temporary files
jbrichau Feb 4, 2024
e628eef
Fix writeFileStreamOn:do:binary: in Squeak
jbrichau Feb 4, 2024
17da932
Refactor test for write:toFile:inFolder:
jbrichau Feb 4, 2024
22b0950
Merge e628eef8cf0b2226cdddf2148a430efba02c3aa6
jbrichau Feb 4, 2024
2816e8e
throw error when creating a duplicate temporary file
jbrichau Feb 4, 2024
e1a14c9
error when creating a duplicate temporary file name on GemStone, olde…
jbrichau Feb 4, 2024
14e6afb
use GRPlatform current pathSeparator in the filename generation for t…
jbrichau Feb 4, 2024
5ae43f8
revert changes for categories in Squeak packages
jbrichau Feb 4, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 6 additions & 0 deletions repository/Grease-Core.package/GRPlatform.class/instance/newTemporaryFile.st
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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
6 changes: 6 additions & 0 deletions repository/Grease-Core.package/GRPlatform.class/instance/newTemporaryFileNamed..st
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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
8 changes: 0 additions & 8 deletions repository/Grease-Core.package/GRPlatform.class/instance/newTemporaryFileReference.st
View file
Open in desktop

This file was deleted.

3 changes: 0 additions & 3 deletions repository/Grease-Core.package/GRPlatform.class/instance/newTemporaryFileReferenceNamed..st
View file
Open in desktop

This file was deleted.

4 changes: 4 additions & 0 deletions repository/Grease-GemStone-Core.package/GRGemStonePlatform.class/instance/deleteFile..st
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
files
deleteFile: aPathString

GsFile removeServerFile: aPathString
4 changes: 4 additions & 0 deletions ...sitory/Grease-GemStone-Core.package/GRGemStonePlatform.class/instance/newTemporaryFile.st
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
files
newTemporaryFile

^ self newTemporaryFileNamed: UUID new greaseString
7 changes: 7 additions & 0 deletions .../Grease-GemStone-Core.package/GRGemStonePlatform.class/instance/newTemporaryFileNamed..st
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
files
newTemporaryFileNamed: aName

| fileName |
fileName := GRPlatform current pathSeparator,'tmp', GRPlatform current pathSeparator, aName.
(self fileExists: fileName) ifTrue: [ GRError new signal: 'A (temporary) file with name ', aName, ' already exists.' ].
^ (GsFile openWriteOnServer: fileName) pathName
4 changes: 4 additions & 0 deletions repository/Grease-Pharo100-Core.package/GRPharoPlatform.class/instance/newTemporaryFile.st
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
files
newTemporaryFile

^ self newTemporaryFileNamed: UUID new greaseString
7 changes: 7 additions & 0 deletions ...ory/Grease-Pharo100-Core.package/GRPharoPlatform.class/instance/newTemporaryFileNamed..st
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
files
newTemporaryFileNamed: aName

| newFile |
newFile := FileLocator temp / aName.
newFile exists ifTrue: [ GRError new signal: 'A (temporary) file with name ', aName, ' already exists.' ].
^ newFile pathString
3 changes: 3 additions & 0 deletions .../Grease-Pharo100-Core.package/GRPharoPlatform.class/instance/newTemporaryFileReference.st
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,4 +5,7 @@
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'.

Check warning on line 10 in repository/Grease-Pharo100-Core.package/GRPharoPlatform.class/instance/newTemporaryFileReference.st

View check run for this annotation

Codecov / codecov/patch

repository/Grease-Pharo100-Core.package/GRPharoPlatform.class/instance/newTemporaryFileReference.st#L8-L10 

Added lines #L8 - L10 were not covered by tests
^ self newTemporaryFileReferenceNamed: UUID new asString
3 changes: 3 additions & 0 deletions ...e-Pharo100-Core.package/GRPharoPlatform.class/instance/newTemporaryFileReferenceNamed..st
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,4 +5,7 @@
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:'.

Check warning on line 10 in repository/Grease-Pharo100-Core.package/GRPharoPlatform.class/instance/newTemporaryFileReferenceNamed..st

View check run for this annotation

Codecov / codecov/patch

repository/Grease-Pharo100-Core.package/GRPharoPlatform.class/instance/newTemporaryFileReferenceNamed..st#L8-L10 

Added lines #L8 - L10 were not covered by tests
^ FileLocator temp / aName
2 changes: 1 addition & 1 deletion repository/Grease-Pharo100-Core.package/monticello.meta/categories.st
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1 +1 @@
SystemOrganization addCategory: #'Grease-Pharo100-Core'!
self packageOrganizer ensurePackage: #'Grease-Pharo100-Core' withTags: #()!
4 changes: 4 additions & 0 deletions repository/Grease-Pharo70-Core.package/GRPharoPlatform.class/instance/newTemporaryFile.st
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
files
newTemporaryFile

^ self newTemporaryFileNamed: UUID new greaseString
7 changes: 7 additions & 0 deletions ...tory/Grease-Pharo70-Core.package/GRPharoPlatform.class/instance/newTemporaryFileNamed..st
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
files
newTemporaryFileNamed: aName

| newFile |
newFile := FileLocator temp / aName.
newFile exists ifTrue: [ GRError new signal: 'A (temporary) file with name ', aName, ' already exists.' ].
^ newFile pathString
3 changes: 3 additions & 0 deletions ...y/Grease-Pharo70-Core.package/GRPharoPlatform.class/instance/newTemporaryFileReference.st
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,4 +5,7 @@
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'.

Check warning on line 10 in repository/Grease-Pharo70-Core.package/GRPharoPlatform.class/instance/newTemporaryFileReference.st

View check run for this annotation

Codecov / codecov/patch

repository/Grease-Pharo70-Core.package/GRPharoPlatform.class/instance/newTemporaryFileReference.st#L8-L10 

Added lines #L8 - L10 were not covered by tests
^ self newTemporaryFileReferenceNamed: UUID new asString
3 changes: 3 additions & 0 deletions ...se-Pharo70-Core.package/GRPharoPlatform.class/instance/newTemporaryFileReferenceNamed..st
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,4 +5,7 @@
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:'.

Check warning on line 10 in repository/Grease-Pharo70-Core.package/GRPharoPlatform.class/instance/newTemporaryFileReferenceNamed..st

View check run for this annotation

Codecov / codecov/patch

repository/Grease-Pharo70-Core.package/GRPharoPlatform.class/instance/newTemporaryFileReferenceNamed..st#L8-L10 

Added lines #L8 - L10 were not covered by tests
^ FileLocator temp / aName
4 changes: 4 additions & 0 deletions repository/Grease-Pharo90-Core.package/GRPharoPlatform.class/instance/newTemporaryFile.st
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
files
newTemporaryFile

^ self newTemporaryFileNamed: UUID new greaseString
7 changes: 7 additions & 0 deletions ...tory/Grease-Pharo90-Core.package/GRPharoPlatform.class/instance/newTemporaryFileNamed..st
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
files
newTemporaryFileNamed: aName

| newFile |
newFile := FileLocator temp / aName.
newFile exists ifTrue: [ GRError new signal: 'A (temporary) file with name ', aName, ' already exists.' ].
^ newFile pathString
3 changes: 3 additions & 0 deletions ...y/Grease-Pharo90-Core.package/GRPharoPlatform.class/instance/newTemporaryFileReference.st
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,4 +5,7 @@
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'.

Check warning on line 10 in repository/Grease-Pharo90-Core.package/GRPharoPlatform.class/instance/newTemporaryFileReference.st

View check run for this annotation

Codecov / codecov/patch

repository/Grease-Pharo90-Core.package/GRPharoPlatform.class/instance/newTemporaryFileReference.st#L8-L10 

Added lines #L8 - L10 were not covered by tests
^ self newTemporaryFileReferenceNamed: UUID new asString
3 changes: 3 additions & 0 deletions ...se-Pharo90-Core.package/GRPharoPlatform.class/instance/newTemporaryFileReferenceNamed..st
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,4 +5,7 @@
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:'.

Check warning on line 10 in repository/Grease-Pharo90-Core.package/GRPharoPlatform.class/instance/newTemporaryFileReferenceNamed..st

View check run for this annotation

Codecov / codecov/patch

repository/Grease-Pharo90-Core.package/GRPharoPlatform.class/instance/newTemporaryFileReferenceNamed..st#L8-L10 

Added lines #L8 - L10 were not covered by tests
^ FileLocator temp / aName
3 changes: 3 additions & 0 deletions repository/Grease-Squeak5-Core.package/GRSqueakPlatform.class/instance/deleteFile..st
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
files
deleteFile: aPathString
FileDirectory deleteFilePath: aPathString
4 changes: 4 additions & 0 deletions repository/Grease-Squeak5-Core.package/GRSqueakPlatform.class/instance/newTemporaryFile.st
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
files
newTemporaryFile

^ self newTemporaryFileNamed: UUID new greaseString
7 changes: 7 additions & 0 deletions ...ory/Grease-Squeak5-Core.package/GRSqueakPlatform.class/instance/newTemporaryFileNamed..st
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
files
newTemporaryFileNamed: aName

| file |
file := FileDirectory default / aName.
file exists ifTrue: [ GRError new signal: 'A (temporary) file with name ', aName, ' already exists.' ].
^ file pathName
6 changes: 3 additions & 3 deletions ...ease-Squeak5-Core.package/GRSqueakPlatform.class/instance/writeFileStreamOn.do.binary..st
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
as yet unclassified
files
writeFileStreamOn: aString do: aBlock binary: aBoolean
| stream |
stream := aBoolean
ifTrue: [ (MultiByteFileStream fileNamed: aString) ascii; wantsLineEndConversion: true; yourself ]
ifFalse: [ (FileStream fileNamed: aString) binary ].
ifTrue: [ (FileStream fileNamed: aString) binary ]
ifFalse: [ (MultiByteFileStream fileNamed: aString) ascii; wantsLineEndConversion: true; yourself ].
[ aBlock value: stream ]
ensure: [ stream close ]
3 changes: 3 additions & 0 deletions repository/Grease-Squeak6-Core.package/GRSqueakPlatform.class/instance/deleteFile..st
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
files
deleteFile: aPathString
FileDirectory deleteFilePath: aPathString
4 changes: 4 additions & 0 deletions repository/Grease-Squeak6-Core.package/GRSqueakPlatform.class/instance/newTemporaryFile.st
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
files
newTemporaryFile

^ self newTemporaryFileNamed: UUID new greaseString
7 changes: 7 additions & 0 deletions ...ory/Grease-Squeak6-Core.package/GRSqueakPlatform.class/instance/newTemporaryFileNamed..st
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
files
newTemporaryFileNamed: aName

| file |
file := FileDirectory default / aName.
file exists ifTrue: [ GRError new signal: 'A (temporary) file with name ', aName, ' already exists.' ].
^ file pathName
8 changes: 8 additions & 0 deletions ...ease-Squeak6-Core.package/GRSqueakPlatform.class/instance/writeFileStreamOn.do.binary..st
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
files
writeFileStreamOn: aString do: aBlock binary: aBoolean
| stream |
stream := aBoolean
ifTrue: [ (FileStream fileNamed: aString) binary ]
ifFalse: [ (MultiByteFileStream fileNamed: aString) ascii; wantsLineEndConversion: true; yourself ].
[ aBlock value: stream ]
ensure: [ stream close ]
20 changes: 20 additions & 0 deletions repository/Grease-Tests-Core.package/GRPlatformTest.class/instance/testNewTemporaryFile.st
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
tests-files
testNewTemporaryFile

| temporaryFile1 temporaryFile2 |
[
temporaryFile1 := GRPlatform current newTemporaryFile.
temporaryFile2 := GRPlatform current newTemporaryFile.
GRPlatform current
writeFileStreamOn: temporaryFile1
do: [ :str | str nextPutAll: 'test temporary' ]
binary: false.
GRPlatform current
writeFileStreamOn: temporaryFile2
do: [ :str | str nextPutAll: #[116 101 115 116 32 116 101 109 112 111 114 97 114 121] ]
binary: true.
self assert: (GRPlatform current fileExists: temporaryFile1).
self deny: (GRPlatform current localNameOf: temporaryFile1) equals: (GRPlatform current localNameOf: temporaryFile2)
] ensure: [ GRPlatform current deleteFile: temporaryFile1. GRPlatform current deleteFile: temporaryFile2 ].
self deny: (GRPlatform current fileExists: temporaryFile1).
self deny: (GRPlatform current fileExists: temporaryFile2)
16 changes: 16 additions & 0 deletions ...tory/Grease-Tests-Core.package/GRPlatformTest.class/instance/testNewTemporaryFileNamed.st
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
tests-files
testNewTemporaryFileNamed

| temporaryFile fileName |
fileName := 'GRPlatformTestTemporaryFile'.
[
temporaryFile := GRPlatform current newTemporaryFileNamed: fileName.
GRPlatform current
writeFileStreamOn: temporaryFile
do: [ :str | str nextPutAll: 'test temporary' ]
binary: false.
self assert: (GRPlatform current fileExists: temporaryFile).
self should: [ GRPlatform current newTemporaryFileNamed: fileName ] raise: GRError.
] ensure: [ GRPlatform current deleteFile: temporaryFile ].
self deny: (GRPlatform current fileExists: temporaryFile).

8 changes: 0 additions & 8 deletions ...-Tests-Core.package/GRPlatformTest.class/instance/testReadWriteEmptyFileInFolderBinary.st
View file
Open in desktop

This file was deleted.

8 changes: 0 additions & 8 deletions ...se-Tests-Core.package/GRPlatformTest.class/instance/testReadWriteEmptyFileInFolderText.st
View file
Open in desktop

This file was deleted.

8 changes: 0 additions & 8 deletions ...ase-Tests-Core.package/GRPlatformTest.class/instance/testReadWriteToFileInFolderBinary.st
View file
Open in desktop

This file was deleted.

8 changes: 0 additions & 8 deletions ...rease-Tests-Core.package/GRPlatformTest.class/instance/testReadWriteToFileInFolderText.st
View file
Open in desktop

This file was deleted.

27 changes: 27 additions & 0 deletions ...sitory/Grease-Tests-Core.package/GRPlatformTest.class/instance/testWriteToFileInFolder.st
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
tests-files
testWriteToFileInFolder

| bytes text |
bytes := ByteArray new.
self
writeToFile: bytes
withFileNameDo:[ :fileName |
self assert: (GRPlatform current contentsOfFile: fileName binary: true) equals: bytes ].

bytes := #[80 104 39 110 103 108 117 105 32 109 103 108 119 39 110 97 102 104 32 67 116 104 117 108 104 117 32 82 39 108 121 101 104 32 119 103 97 104 39 110 97 103 108 32 102 104 116 97 103 110].
self
writeToFile: bytes
withFileNameDo:[ :fileName |
self assert:(GRPlatform current contentsOfFile: fileName binary: true) equals: bytes ].

text := String new.
self
writeToFile: text
withFileNameDo:[ :fileName |
self assert: (GRPlatform current contentsOfFile: fileName binary: false) equals: text ].

text := 'Ph''nglui mglw''nafh Cthulhu R''lyeh wgah''nagl fhtagn'.
self
writeToFile: text
withFileNameDo:[ :fileName |
self assert: (GRPlatform current contentsOfFile: fileName binary: false) equals: text ]
2 changes: 1 addition & 1 deletion repository/Grease-Tests-Core.package/monticello.meta/categories.st
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1 +1 @@
SystemOrganization addCategory: #'Grease-Tests-Core'!
self packageOrganizer ensurePackage: #'Grease-Tests-Core' withTags: #()!
Loading