forked from StartAutomating/PipeScript
-
Notifications
You must be signed in to change notification settings - Fork 1
/
New-PipeScript.ps1.ps1
429 lines (385 loc) · 15.8 KB
/
New-PipeScript.ps1.ps1
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
function New-PipeScript
{
<#
.Synopsis
Creates new PipeScript.
.Description
Creates new PipeScript and PowerShell ScriptBlocks.
.EXAMPLE
New-PipeScript -Parameter @{a='b'}
.EXAMPLE
New-PipeScript -Parameter ([Net.HttpWebRequest].GetProperties()) -ParameterHelp @{
Accept='
HTTP Accept.
HTTP Accept indicates what content types the web request will accept as a response.
'
}
#>
[Alias('New-ScriptBlock')]
param(
# Defines one or more parameters for a ScriptBlock.
# Parameters can be defined in a few ways:
# * As a ```[Collections.Dictionary]``` of Parameters
# * As the ```[string]``` name of an untyped parameter.
# * As a ```[ScriptBlock]``` containing only parameters.
[Parameter(ValueFromPipelineByPropertyName)]
[ValidateScriptBlock(ParameterOnly)]
[ValidateTypes(TypeName={
[Collections.IDictionary],
[string],
[Object[]],
[Scriptblock],
[Reflection.PropertyInfo],
[Reflection.PropertyInfo[]],
[Reflection.ParameterInfo],
[Reflection.ParameterInfo[]],
[Reflection.MethodInfo],
[Reflection.MethodInfo[]]
})]
$Parameter,
# The dynamic parameter block.
[Parameter(ValueFromPipelineByPropertyName)]
[ValidateScriptBlock(NoBlocks, NoParameters)]
[Alias('DynamicParameterBlock')]
[ScriptBlock]
$DynamicParameter,
# The begin block.
[Parameter(ValueFromPipelineByPropertyName)]
[ValidateScriptBlock(NoBlocks, NoParameters)]
[Alias('BeginBlock')]
[ScriptBlock]
$Begin,
# The process block.
[Parameter(ValueFromPipelineByPropertyName)]
[ValidateScriptBlock(NoBlocks, NoParameters)]
[Alias('ProcessBlock')]
[ScriptBlock]
$Process,
# The end block.
[Parameter(ValueFromPipelineByPropertyName)]
[ValidateScriptBlock(NoBlocks, NoParameters)]
[Alias('EndBlock')]
[ScriptBlock]
$End,
# The script header.
[Parameter(ValueFromPipelineByPropertyName)]
[string]
$Header,
# If provided, will automatically create parameters.
# Parameters will be automatically created for any unassigned variables.
[Alias('AutoParameterize','AutoParameters')]
[switch]
$AutoParameter,
# The type used for automatically generated parameters.
# By default, ```[PSObject]```.
[type]
$AutoParameterType = [PSObject],
# If provided, will add inline help to parameters.
[Collections.IDictionary]
$ParameterHelp,
<#
If set, will weakly type parameters generated by reflection.
1. Any parameter type implements IList should be made a [PSObject[]]
2. Any parameter that implements IDictionary should be made an [Collections.IDictionary]
3. Booleans should be made into [switch]es
4. All other parameter types should be [PSObject]
#>
[Alias('WeakType', 'WeakParameters', 'WeaklyTypedParameters', 'WeakProperties', 'WeaklyTypedProperties')]
[switch]
$WeaklyTyped,
# The name of the function to create.
[string]
$FunctionName,
# The type of the function to create. This will be ignored if -FunctionName is not passed.
[string]
$FunctionType = 'function',
# A description of the script's functionality. If provided with -Synopsis, will generate help.
[string]
$Description,
# A short synopsis of the script's functionality. If provided with -Description, will generate help.
[string]
$Synopsis,
# A list of examples to use in help. Will be ignored if -Synopsis and -Description are not passed.
[Alias('Examples')]
[string[]]
$Example,
# A list of links to use in help. Will be ignored if -Synopsis and -Description are not passed.
[Alias('Links')]
[string[]]
$Link,
# A list of attributes to declare on the scriptblock.
[string[]]
$Attribute
)
begin {
$ParametersToCreate = [Ordered]@{}
$parameterScriptBlocks = @()
$allDynamicParameters = @()
$allBeginBlocks = @()
$allEndBlocks = @()
$allProcessBlocks = @()
$allHeaders = @()
filter embedParameterHelp {
if ($_ -notmatch '^\s\<\#' -and $_ -notmatch '^\s\#') {
$commentLines = @($_ -split '(?>\r\n|\n)')
if ($commentLines.Count -gt 1) {
'<#' + [Environment]::NewLine + "$_".Trim() + [Environment]::newLine + '#>'
} else {
"# $_"
}
} else {
$_
}
}
}
process {
if ($Synopsis -and $Description) {
function indentHelpLine {
foreach ($line in $args -split '(?>\r\n|\n)') {
(' ' * 4) + $line.TrimEnd()
}
}
$helpHeader = @(
"<#"
".Synopsis"
indentHelpLine $Synopsis
".Description"
indentHelpLine $Description
foreach ($helpExample in $Example) {
".Example"
indentHelpLine $helpExample
}
foreach ($helplink in $Link) {
".Link"
indentHelpLine $helplink
}
"#>"
) -join [Environment]::Newline
$allHeaders += $helpHeader
}
if ($Attribute) {
$allHeaders += $Attribute
}
if ($parameter) {
# The -Parameter can be a dictionary of parameters.
if ($Parameter -is [Collections.IDictionary]) {
$parameterType = ''
# If it is, walk thur each parameter in the dictionary
foreach ($EachParameter in $Parameter.GetEnumerator()) {
# Continue past any parameters we already have
if ($ParametersToCreate.Contains($EachParameter.Key)) {
continue
}
# If the parameter is a string and the value is not a variable
if ($EachParameter.Value -is [string] -and $EachParameter.Value -notlike '*$*') {
$parameterName = $EachParameter.Key
$ParametersToCreate[$EachParameter.Key] =
@(
if ($parameterHelp -and $parameterHelp[$eachParameter.Key]) {
$parameterHelp[$eachParameter.Key] | embedParameterHelp
}
$parameterAttribute = "[Parameter(ValueFromPipelineByPropertyName)]"
$parameterType
'$' + $parameterName
) -ne ''
}
# If the value is a string and the value contains variables
elseif ($EachParameter.Value -is [string]) {
# embed it directly.
$ParametersToCreate[$EachParameter.Key] = $EachParameter.Value
}
# If the value is a ScriptBlock
elseif ($EachParameter.Value -is [ScriptBlock]) {
# Embed it
$ParametersToCreate[$EachParameter.Key] =
# If there was a param block on the script block
if ($EachParameter.Value.Ast.ParamBlock) {
# embed the parameter block (except for the param keyword)
$EachParameter.Value.Ast.ParamBlock.Extent.ToString() -replace
'^[\s\r\n]{0,}param\(' -replace '\)[\s\r\n]{0,}$'
} else {
# Otherwise
'[Parameter(ValueFromPipelineByPropertyName)]' + (
$EachParameter.Value.ToString() -replace
"\`$$($eachParameter.Key)[\s\r\n]$" -replace # Replace any trailing variables
'param\(\)[\s\r\n]{0,}$' # then replace any empty param blocks.
)
}
}
# If the value was an array
elseif ($EachParameter.Value -is [Object[]]) {
$ParametersToCreate[$EachParameter.Key] = # join it's elements by newlines
$EachParameter.Value -join [Environment]::Newline
}
}
}
# If the parameter was a string
elseif ($Parameter -is [string])
{
# treat it as parameter name
$ParametersToCreate[$Parameter] =
@(
if ($parameterHelp -and $parameterHelp[$Parameter]) {
$parameterHelp[$Parameter] | embedParameterHelp
}
"[Parameter(ValueFromPipelineByPropertyName)]"
"`$$Parameter"
) -join [Environment]::NewLine
}
# If the parameter is a [ScriptBlock]
elseif ($parameter -is [scriptblock])
{
# add it to a list of parameter script blocks.
$parameterScriptBlocks +=
if ($parameter.Ast.ParamBlock) {
$parameter
}
}
# If the -Parameter was provided via reflection
elseif ($parameter -is [Reflection.PropertyInfo] -or
$parameter -as [Reflection.PropertyInfo[]] -or
$parameter -is [Reflection.ParameterInfo] -or
$parameter -as [Reflection.ParameterInfo[]] -or
$parameter -is [Reflection.MethodInfo] -or
$parameter -as [Reflection.MethodInfo[]]
) {
# check to see if it's a method
if ($parameter -is [Reflection.MethodInfo] -or
$parameter -as [Reflection.MethodInfo[]]) {
$parameter = @(foreach ($methodInfo in $parameter) {
$methodInfo.GetParameters() # if so, reflect the method's parameters
})
}
# Walk over each parameter
foreach ($prop in $Parameter) {
# If it is a property info that cannot be written, skip.
if ($prop -is [Reflection.PropertyInfo] -and -not $prop.CanWrite) { continue }
# Determine the reflected parameter type.
$paramType =
if ($prop.ParameterType) {
$prop.ParameterType
} elseif ($prop.PropertyType) {
$prop.PropertyType
} else {
[PSObject]
}
$ParametersToCreate[$prop.Name] =
@(
if ($parameterHelp -and $parameterHelp[$prop.Name]) {
$parameterHelp[$prop.Name] | embedParameterHelp
}
$parameterAttribute = "[Parameter(ValueFromPipelineByPropertyName)]"
$parameterAttribute
if ($paramType -eq [boolean]) {
"[switch]"
} elseif ($WeaklyTyped) {
if ($paramType.GetInterface([Collections.IDictionary])) {
"[Collections.IDictionary]"
}
elseif ($paramType.GetInterface([Collections.IList])) {
"[PSObject[]]"
}
else {
"[PSObject]"
}
}
else {
"[$($paramType -replace '^System\.')]"
}
'$' + $prop.Name
) -ne ''
}
}
}
# If there is header content,
if ($header) {
$allHeaders += $Header
}
# dynamic parameters,
if ($DynamicParameter) {
$allDynamicParameters += $DynamicParameter
}
# begin,
if ($Begin) {
$allBeginBlocks += $begin
}
# process,
if ($process) {
$allProcessBlocks += $process
}
# or end blocks.
if ($end) {
# accumulate them.
$allEndBlocks += $end
}
# If -AutoParameter was passed
if ($AutoParameter) {
# Find all of the variable expressions within -Begin, -Process, and -End
$variableDefinitions = $Begin, $Process, $End |
Where-Object { $_ } |
Search-PipeScript -AstType VariableExpressionAST |
Select-Object -ExpandProperty Result
foreach ($var in $variableDefinitions) {
# Then, see where those variables were assigned
$assigned = $var.GetAssignments()
# (if they were assigned, keep moving)
if ($assigned) { continue }
# If there were not assigned
$varName = $var.VariablePath.userPath.ToString()
# add it to the list of parameters to create.
$ParametersToCreate[$varName] = @(
@(
"[Parameter(ValueFromPipelineByPropertyName)]"
"[$($AutoParameterType.FullName -replace '^System\.')]"
"$var"
) -join [Environment]::NewLine
)
}
}
}
end {
# Take all of the accumulated parameters and create a parameter block
$newParamBlock =
"param(" + [Environment]::newLine +
$(@(foreach ($toCreate in $ParametersToCreate.GetEnumerator()) {
$toCreate.Value -join [Environment]::NewLine
}) -join (',' + [Environment]::NewLine)) +
[Environment]::NewLine +
')'
# If any parameters were passed in as ```[ScriptBlock]```s,
if ($parameterScriptBlocks) {
$parameterScriptBlocks += [ScriptBlock]::Create($newParamBlock)
# join them with the new parameter block.
$newParamBlock = $parameterScriptBlocks | Join-PipeScript
}
# Create the script block by combining together the provided parts.
$createdScriptBlock = [scriptblock]::Create("$(if ($functionName) { "$functionType $FunctionName {"})
$($allHeaders -join [Environment]::Newline)
$newParamBlock
$(if ($allDynamicParameters) {
@(@("dynamicParam {") + $allDynamicParameters + '}') -join [Environment]::Newline
})
$(if ($allBeginBlocks) {
@(@("begin {") + $allBeginBlocks + '}') -join [Environment]::Newline
})
$(if ($allProcessBlocks) {
@(@("process {") + $allProcessBlocks + '}') -join [Environment]::Newline
})
$(if ($allEndBlocks -and -not $allBeginBlocks -and -not $allProcessBlocks) {
$allEndBlocks -join [Environment]::Newline
} elseif ($allEndBlocks) {
@(@("end {") + $allEndBlocks + '}') -join [Environment]::Newline
})
$(if ($FunctionName) { '}'})
")
# If we have a -FunctionName and the -FunctionType is not a built-in function type
if ($CreatedScriptBlock -and
$functionName -and $FunctionType -notin 'function', 'filter') {
# return the transpiled script.
return $createdScriptBlock.Transpile()
} else {
# otherwise, return the created script.
return $createdScriptBlock
}
}
}