Skip to content

Commit f29fbb5

Browse files
committed
refactor(ProjectDatabase): rename Save-ProjectDatabase to Save-ProjectDatabaseSafe for clarity and safety
1 parent 2cee305 commit f29fbb5

7 files changed

Lines changed: 22 additions & 14 deletions

File tree

Notes.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
Notes used during the development of the module
44

5-
## Save-ProjectDatabase
5+
## Save-ProjectDatabaseSafe
66

77
```mermaid
88
graph TD;
@@ -11,7 +11,7 @@ graph TD;
1111
1212
subgraph Module
1313
0([Sync-ProjectItemStaged])
14-
1[Save-ProjectDatabase]
14+
1[Save-ProjectDatabaseSafe]
1515
2[Get-Project]
1616
3[Get-Project]
1717
4[Set-ProjectV2Item]

Test/public/projectDatabase/project_database.test..ps1

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@ function Test_SaveProjectDatabase_SafeId_Flag_PrivateCall{
2222

2323
# Update project and the safeId should be updated
2424
$oldSafeId = $prj.safeId
25-
Save-ProjectDatabase -Database $prj
25+
Save-ProjectDatabaseSafe -Database $prj
2626
$prj2 = Get-ProjectFromDatabase -Owner $Owner -ProjectNumber $ProjectNumber
2727

2828
Assert-IsNotNull -Object $prj2.safeId
@@ -50,7 +50,7 @@ function Test_SaveProjectDatabase_Safe_PrivateCall{
5050
$prj1 = Get-Project -Owner $Owner -ProjectNumber $ProjectNumber
5151

5252
# modify the project
53-
$db = Get-Project -Owner $Owner -ProjectNumber $ProjectNumber ; Save-ProjectDatabase -Database $db
53+
$db = Get-Project -Owner $Owner -ProjectNumber $ProjectNumber ; Save-ProjectDatabaseSafe -Database $db
5454

5555
# Check that safeId has changed
5656
$prj2 = Get-Project -Owner $Owner -ProjectNumber $ProjectNumber
@@ -59,7 +59,7 @@ function Test_SaveProjectDatabase_Safe_PrivateCall{
5959
## When saving again as prj1 that has been saved before it will throw
6060
$hasThrow = $false
6161
try{
62-
Save-ProjectDatabase -Database $prj1 -Safe
62+
Save-ProjectDatabaseSafe -Database $prj1
6363
} catch {
6464
$hasThrow = $true
6565
}

private/projectDatabase/project_database.ps1

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -99,6 +99,14 @@ function Save-ProjectV2toDatabase{
9999
Save-ProjectDatabase -Database $db
100100
}
101101

102+
function Save-ProjectDatabaseSafe{
103+
[CmdletBinding()]
104+
param(
105+
[Parameter(Mandatory,Position = 0)][hashtable]$Database
106+
)
107+
Save-ProjectDatabase -Database $Database -Safe
108+
}
109+
102110
function Save-ProjectDatabase{
103111
[CmdletBinding()]
104112
param(

private/projectDatabase/project_database_Async.ps1

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@ function Sync-ProjectDatabaseAsync {
2222
$db = Sync-ProjectAsync -Database $db -SyncBatchSize $SyncBatchSize
2323

2424
# Saved changes to database
25-
Save-ProjectDatabase -Database $db -Safe
25+
Save-ProjectDatabaseSafe -Database $db
2626

2727
if (Test-ProjectDatabaseStaged -Owner $Owner -ProjectNumber $ProjectNumber) {
2828
"Still pending staged values" | Write-MyError

private/projectDatabase/project_database_Sync.ps1

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ function Sync-ProjectDatabase{
2020
# Send update to project
2121
$db = Sync-Project -Database $db
2222

23-
Save-ProjectDatabase -Database $db -Safe
23+
Save-ProjectDatabaseSafe -Database $db
2424

2525
if (Test-ProjectDatabaseStaged -Owner $Owner -ProjectNumber $ProjectNumber) {
2626
"Still pending staged values" | Write-MyError

public/project_item.ps1

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -42,7 +42,7 @@ function Get-ProjectItem {
4242
end {
4343
if ($dirty) {
4444
"Saving dirty database" | Write-Verbose
45-
Save-ProjectDatabase -Database $db -Safe
45+
Save-ProjectDatabaseSafe -Database $db
4646
}
4747
}
4848

@@ -62,7 +62,7 @@ function Get-ProjectItem {
6262
#
6363
# Set-Item $db $item
6464
#
65-
# Save-ProjectDatabase -Database $db -Safe
65+
# Save-ProjectDatabaseSafe -Database $db
6666
# }
6767

6868
function Remove-ProjectItem {
@@ -85,7 +85,7 @@ function Remove-ProjectItem {
8585
}
8686

8787
end {
88-
Save-ProjectDatabase -Database $db -Safe
88+
Save-ProjectDatabaseSafe -Database $db
8989
}
9090

9191
}
@@ -255,7 +255,7 @@ function Edit-ProjectItem {
255255
Save-ItemFieldValue $db $itemId $FieldName $Value
256256

257257
# Commit changes to the database
258-
Save-ProjectDatabase -Database $db -Safe
258+
Save-ProjectDatabaseSafe -Database $db
259259

260260
} Export-ModuleMember -Function Edit-ProjectItem
261261

@@ -310,7 +310,7 @@ function Add-ProjectItemDirect {
310310

311311
Set-Item $db $item
312312

313-
Save-ProjectDatabase -Database $db -Safe
313+
Save-ProjectDatabaseSafe -Database $db
314314

315315
}
316316

@@ -374,7 +374,7 @@ function Remove-ProjectItemDirect {
374374
# Remove item from cache
375375
"Removing item [$ItemId] from cache" | Write-Verbose
376376
Remove-Item $db $ItemId
377-
Save-ProjectDatabase -Database $db -Safe
377+
Save-ProjectDatabaseSafe -Database $db
378378

379379
return $ret
380380
}

public/project_item_staged.ps1

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -108,7 +108,7 @@ function Reset-ProjectItemStaged{
108108

109109
$db.Staged = $null
110110

111-
Save-ProjectDatabase -Database $db -Safe
111+
Save-ProjectDatabaseSafe -Database $db
112112

113113
} Export-ModuleMember -Function Reset-ProjectItemStaged
114114

0 commit comments

Comments
 (0)