#471

pending completion

Build # #471

Build Type

push

github-actions

Committed by

web-flow

Commit Message

<a href="https://github.com/Badgerati/Pode/commit/<a class=hub.com/Badgerati/Pode/commit/7a2e1ba5217d5fab2af1a3a047ef03cc015449ce">7a2e1ba52<a href="https://github.com/Badgerati/Pode/commit/7a2e1ba5217d5fab2af1a3a047ef03cc015449ce">">Merge </a><a class="double-link" href="https://github.com/Badgerati/Pode/commit/<a class="double-link" href="https://github.com/Badgerati/Pode/commit/0fda8e055743cd5bf757ee0b384a9dee4297c827">0fda8e055</a>">0fda8e055</a><a href="https://github.com/Badgerati/Pode/commit/7a2e1ba5217d5fab2af1a3a047ef03cc015449ce"> into 7c2e22b8f">7c2e22b8f</a>

Run Details

367 of 367 new or added lines in 18 files covered. (100.0%)

2268 of 4592 relevant lines covered (49.39%)

1.26 hits per line

Source File
Press 'n' to go to next uncovered line, 'b' for previous

93.33

/src/Public/State.ps1

<#
.SYNOPSIS
Sets an object within the shared state.

.DESCRIPTION
Sets an object within the shared state.

.PARAMETER Name
The name of the state object.

.PARAMETER Value
The value to set in the state.

.EXAMPLE
Set-PodeState -Name 'Data' -Value @{ 'Name' = 'Rick Sanchez' }
#>
function Set-PodeState
{
    [CmdletBinding()]
    [OutputType([object])]
    param (
        [Parameter(Mandatory=$true)]
        [string]
        $Name,

        [Parameter(ValueFromPipeline=$true)]
        [object]
        $Value
    )

    if ($null -eq $PodeContext.Server.State) {
        throw "Pode has not been initialised"
    }

    $PodeContext.Server.State[$Name] = $Value
    return $Value
}

<#
.SYNOPSIS
Retrieves some state object from the shared state.

.DESCRIPTION
Retrieves some state object from the shared state.

.PARAMETER Name
The name of the state object.

.EXAMPLE
Get-PodeState -Name 'Data'
#>
function Get-PodeState
{
    [CmdletBinding()]
    [OutputType([object])]
    param (
        [Parameter(Mandatory=$true)]
        [string]
        $Name
    )

    if ($null -eq $PodeContext.Server.State) {
        throw "Pode has not been initialised"
    }

    return $PodeContext.Server.State[$Name]
}

<#
.SYNOPSIS
Removes some state object from the shared state.

.DESCRIPTION
Removes some state object from the shared state. After removal, the original object being stored is returned.

.PARAMETER Name
The name of the state object.

.EXAMPLE
Remove-PodeState -Name 'Data'
#>
function Remove-PodeState
{
    [CmdletBinding()]
    [OutputType([object])]
    param (
        [Parameter(Mandatory=$true)]
        [string]
        $Name
    )

    if ($null -eq $PodeContext.Server.State) {
        throw "Pode has not been initialised"
    }

    $value = $PodeContext.Server.State[$Name]
    $PodeContext.Server.State.Remove($Name) | Out-Null
    return $value
}

<#
.SYNOPSIS
Saves the current shared state to a supplied JSON file.

.DESCRIPTION
Saves the current shared state to a supplied JSON file. When using this function, it's recommended to wrap it in a Lock-PodeObject block.

.PARAMETER Path
The path to a JSON file which the current state will be saved to.

.EXAMPLE
Save-PodeState -Path './state.json'
#>
function Save-PodeState
{
    [CmdletBinding()]
    param(
        [Parameter(Mandatory=$true)]
        [string]
        $Path
    )

    if ($null -eq $PodeContext.Server.State) {
        throw "Pode has not been initialised"
    }

    $Path = Get-PodeRelativePath -Path $Path -JoinRoot
    $PodeContext.Server.State |
        ConvertTo-Json -Depth 10 |
        Out-File -FilePath $Path -Force |
        Out-Null
}

<#
.SYNOPSIS
Restores the shared state from some JSON file.

.DESCRIPTION
Restores the shared state from some JSON file.

.PARAMETER Path
The path to a JSON file that contains the state information.

.EXAMPLE
Restore-PodeState -Path './state.json'
#>
function Restore-PodeState
{
    [CmdletBinding()]
    param(
        [Parameter(Mandatory=$true)]
        [string]
        $Path
    )

    if ($null -eq $PodeContext.Server.State) {
        throw "Pode has not been initialised"
    }

    $Path = Get-PodeRelativePath -Path $Path -JoinRoot
    if (!(Test-Path $Path)) {
        return
    }

    if (Test-IsPSCore) {
        $PodeContext.Server.State = (Get-Content $Path -Force | ConvertFrom-Json -AsHashtable -Depth 10)
    }
    else {
        (Get-Content $Path -Force | ConvertFrom-Json).psobject.properties | ForEach-Object {
            $PodeContext.Server.State[$_.Name] = $_.Value
        }
    }
}

<#
.SYNOPSIS
Tests if the shared state contains some state object.

.DESCRIPTION
Tests if the shared state contains some state object.

.PARAMETER Name
The name of the state object.

.EXAMPLE
Test-PodeState -Name 'Data'
#>
function Test-PodeState
{
    [CmdletBinding()]
    [OutputType([bool])]
    param (
        [Parameter(Mandatory=$true)]
        [string]
        $Name
    )

    if ($null -eq $PodeContext.Server.State) {
        throw "Pode has not been initialised"
    }

    return $PodeContext.Server.State.ContainsKey($Name)
}

1	<#
2	.SYNOPSIS
3	Sets an object within the shared state.
4
5	.DESCRIPTION
6	Sets an object within the shared state.
7
8	.PARAMETER Name
9	The name of the state object.
10
11	.PARAMETER Value
12	The value to set in the state.
13
14	.EXAMPLE
15	Set-PodeState -Name 'Data' -Value @{ 'Name' = 'Rick Sanchez' }
16	#>
17	function Set-PodeState
18	{
19	[CmdletBinding()]
20	[OutputType([object])]
21	param (
22	[Parameter(Mandatory=$true)]
23	[string]
24	$Name,
25
26	[Parameter(ValueFromPipeline=$true)]
27	[object]
28	$Value
29	)
30
31	if ($null -eq $PodeContext.Server.State) {	2✔
32	throw "Pode has not been initialised"	2✔
33	}
34
35	$PodeContext.Server.State[$Name] = $Value	2✔
36	return $Value	2✔
37	}
38
39	<#
40	.SYNOPSIS
41	Retrieves some state object from the shared state.
42
43	.DESCRIPTION
44	Retrieves some state object from the shared state.
45
46	.PARAMETER Name
47	The name of the state object.
48
49	.EXAMPLE
50	Get-PodeState -Name 'Data'
51	#>
52	function Get-PodeState
53	{
54	[CmdletBinding()]
55	[OutputType([object])]
56	param (
57	[Parameter(Mandatory=$true)]
58	[string]
59	$Name
60	)
61
62	if ($null -eq $PodeContext.Server.State) {	2✔
63	throw "Pode has not been initialised"	2✔
64	}
65
66	return $PodeContext.Server.State[$Name]	2✔
67	}
68
69	<#
70	.SYNOPSIS
71	Removes some state object from the shared state.
72
73	.DESCRIPTION
74	Removes some state object from the shared state. After removal, the original object being stored is returned.
75
76	.PARAMETER Name
77	The name of the state object.
78
79	.EXAMPLE
80	Remove-PodeState -Name 'Data'
81	#>
82	function Remove-PodeState
83	{
84	[CmdletBinding()]
85	[OutputType([object])]
86	param (
87	[Parameter(Mandatory=$true)]
88	[string]
89	$Name
90	)
91
92	if ($null -eq $PodeContext.Server.State) {	2✔
93	throw "Pode has not been initialised"	2✔
94	}
95
96	$value = $PodeContext.Server.State[$Name]	2✔
97	$PodeContext.Server.State.Remove($Name) \| Out-Null	4✔
98	return $value	2✔
99	}
100
101	<#
102	.SYNOPSIS
103	Saves the current shared state to a supplied JSON file.
104
105	.DESCRIPTION
106	Saves the current shared state to a supplied JSON file. When using this function, it's recommended to wrap it in a Lock-PodeObject block.
107
108	.PARAMETER Path
109	The path to a JSON file which the current state will be saved to.
110
111	.EXAMPLE
112	Save-PodeState -Path './state.json'
113	#>
114	function Save-PodeState
115	{
116	[CmdletBinding()]
117	param(
118	[Parameter(Mandatory=$true)]
119	[string]
120	$Path
121	)
122
123	if ($null -eq $PodeContext.Server.State) {	2✔
124	throw "Pode has not been initialised"	2✔
125	}
126
127	$Path = Get-PodeRelativePath -Path $Path -JoinRoot	2✔
128	$PodeContext.Server.State \|	2✔
129	ConvertTo-Json -Depth 10 \|	2✔
130	Out-File -FilePath $Path -Force \|	2✔
131	Out-Null	2✔
132	}
133
134	<#
135	.SYNOPSIS
136	Restores the shared state from some JSON file.
137
138	.DESCRIPTION
139	Restores the shared state from some JSON file.
140
141	.PARAMETER Path
142	The path to a JSON file that contains the state information.
143
144	.EXAMPLE
145	Restore-PodeState -Path './state.json'
146	#>
147	function Restore-PodeState
148	{
149	[CmdletBinding()]
150	param(
151	[Parameter(Mandatory=$true)]
152	[string]
153	$Path
154	)
155
156	if ($null -eq $PodeContext.Server.State) {	2✔
157	throw "Pode has not been initialised"	2✔
158	}
159
160	$Path = Get-PodeRelativePath -Path $Path -JoinRoot	2✔
161	if (!(Test-Path $Path)) {	4✔
162	return
163	}
164
165	if (Test-IsPSCore) {	2✔
166	$PodeContext.Server.State = (Get-Content $Path -Force \| ConvertFrom-Json -AsHashtable -Depth 10)	6✔
167	}
168	else {
169	(Get-Content $Path -Force \| ConvertFrom-Json).psobject.properties \| ForEach-Object {	×
170	$PodeContext.Server.State[$_.Name] = $_.Value	×
171	}
172	}
173	}
174
175	<#
176	.SYNOPSIS
177	Tests if the shared state contains some state object.
178
179	.DESCRIPTION
180	Tests if the shared state contains some state object.
181
182	.PARAMETER Name
183	The name of the state object.
184
185	.EXAMPLE
186	Test-PodeState -Name 'Data'
187	#>
188	function Test-PodeState
189	{
190	[CmdletBinding()]
191	[OutputType([bool])]
192	param (
193	[Parameter(Mandatory=$true)]
194	[string]
195	$Name
196	)
197
198	if ($null -eq $PodeContext.Server.State) {	2✔
199	throw "Pode has not been initialised"	2✔
200	}
201
202	return $PodeContext.Server.State.ContainsKey($Name)	2✔
203	}

Badgerati / Pode / #471

Source File Press 'n' to go to next uncovered line, 'b' for previous

Source File
Press 'n' to go to next uncovered line, 'b' for previous