Merge pull request #13 from PowerShellWeb/Initial-Vector

Vector 0.1

Author: StartAutomating

.github/FUNDING.yml

@@ -0,0 +1 @@
+github: [StartAutomating]

.github/workflows/BuildVector.yml

@@ -0,0 +1,18 @@
+@{
+    "runs-on" = "ubuntu-latest"    
+    if = '${{ success() }}'
+    steps = @(
+        @{
+            name = 'Check out repository'
+            uses = 'actions/checkout@main'
+        },                
+        'RunEZOut' #  ,
+        <#@{
+            name = 'Run Vector (on branch)'
+            if   = '${{github.ref_name != ''main''}}'
+            uses = './'
+            id = 'VectorAction'
+        }#>
+        # 'BuildAndPublishContainer'
+    )
+}

Build/GitHub/Jobs/BuildVector.psd1

@@ -0,0 +1,10 @@
+@{
+    name = 'PublishTestResults'
+    uses = 'actions/upload-artifact@main'
+    with = @{
+        name = 'PesterResults'
+        path = '**.TestResults.xml'
+    }
+    if = '${{always()}}'
+}
+

Build/GitHub/Steps/PublishTestResults.psd1

@@ -0,0 +1,15 @@
+#requires -Module PSDevOps
+Import-BuildStep -SourcePath (
+    Join-Path $PSScriptRoot 'GitHub'
+) -BuildSystem GitHubWorkflow
+
+Push-Location ($PSScriptRoot | Split-Path)
+New-GitHubWorkflow -Name "Build Vector Module" -On Push,
+    PullRequest, 
+    Demand -Job  TestPowerShellOnLinux, 
+    TagReleaseAndPublish, BuildVector -Environment ([Ordered]@{
+        REGISTRY = 'ghcr.io'
+        IMAGE_NAME = '${{ github.repository }}'
+    }) -OutputPath .\.github\workflows\BuildVector.yml
+
+Pop-Location

Build/Vector.GitHubWorkflow.PSDevOps.ps1

@@ -0,0 +1,17 @@
+## Vector 0.1:
+
+* Initial Release of Vector module
+* Commands:
+  * Get-Vector (#1)
+  * Get-Vector2 (#2)
+  * Get-Vector3 (#3)
+  * Get-Vector4 (#4)
+* Vector Workflow (#5)
+* Vector Tests (#6)
+* Vector Docs
+  * Demo (#7)
+  * README (#8)
+  * FUNDING (#9)
+  * CODE_OF_CONDUCT (#10)
+  * CONTRIBUTING (#11)
+  * SECURITY (#12)

CHANGELOG.md

@@ -0,0 +1,9 @@
+# Code of Conduct
+
+We have a simple subjective code of conduct:
+
+1. Be Respectful
+2. Be Helpful
+3. Do No Harm
+
+Failure to follow the code of conduct may result in blocks or banishment.

CODE_OF_CONDUCT.md

@@ -0,0 +1,11 @@
+# Contibuting
+
+We welcome suggestions and careful contributions.
+
+To suggest something, please [open an issue](https://github.com/PowerShellWeb/Vector/issues) or start a [discussion](https://github.com/PowerShellWeb/Vector/discussion)
+
+To add a feature, please open an issue and create a pull request.
+
+## Contributing Examples
+
+Examples are more than welcome!  To contribute an example, please open an issue describing your example and create a pull request.

CONTRIBUTING.md

@@ -0,0 +1,119 @@
+function Get-Vector
+{
+    <#
+    .SYNOPSIS
+        Gets a one dimensional vector
+    .DESCRIPTION
+        Gets a one dimensional vector (or, more simply, a list of numbers)
+
+        This will convert a variety of types into numbers.
+    .NOTES
+        This attempts to convert any type into a number.
+
+        Some types are special:
+        
+        * Primitive types will be casted to float
+        * `[Numerics.Vector2]`,`[Numerics.Vector3]`,`[Numerics.Vector4]` output each component
+        * `[string]`s that match a range (`$start..$end`) will output that range
+        * `[Version]`s will output each numeric component
+        * `[semver]`s will output each numeric component, followed by the bytes of a release type
+        * `[DateTime]` and `[DateTimeOffset]` will become a series of 12 numbers
+          * `year`,`month`,`day`
+          * `hour`, `minute`, `second`
+          * `millisecond`, `microsecond`, `nanosecond`
+          * `offset.hours`, `offset.minutes`, `offset.seconds`
+        * `[string]s` will return their bytes in the current `$outputEncoding`
+        * Anything unknown will be stringified and the bytes will be returned
+    #>
+    [Alias('Vector','Vector1','V1')]
+    param()
+
+    filter toVector { 
+        $arg = $_
+        # Return primitive types
+        if ($arg.GetType -and $arg.GetType().IsPrimitive) {
+            # casted to float
+            return ($arg -as [float])
+        }
+        # Return vector components
+        if ($arg -is [ValueType]) {        
+            if ($arg -is [Numerics.Vector2]) {
+                return $arg.X,$arg.Y
+            }
+            elseif ($arg -is [Numerics.Vector3]) {
+                return $arg.X,$arg.Y,$arg.Z
+            }
+            elseif ($arg -is [Numerics.Vector4]) {
+                return $arg.X,$arg.Y,$arg.Z, $arg.W
+            }
+        }
+        # Look for inline ranges.
+        if ($arg -is [string]) {
+            if ($arg -match '^\d..\d') {
+                $start, $end = $arg -split '\..', 2
+                $startInt = ($start -as [int])
+                $endInt   = ($end -as [int])            
+                if ($null -ne $startInt -and $null -ne $endInt) {
+                    # If found, return them expanded.
+                    return ($startInt..$endInt)
+                }
+            }
+            if ($arg -as [float]) {
+                return $arg -as [float]
+            }
+        }
+        
+
+        # If the arg is a version, get each number of the version
+        if ($arg -is [version]) {return $arg.Major,$arg.Minor,$arg.Build,$arg.Revision}
+
+        # If we support semver and the arg is semver
+        if (('semver' -as [type]) -and $arg -is [semver]) {
+            # Return the numeric parts of the semver
+            $arg.Major,$arg.Minor,$arg.Patch
+            # and turn any string portions to bytes            
+            if ($arg.PreReleaseLabel) {
+                # make sure to include a leading dash for pre-releases
+                $OutputEncoding.GetBytes("-$($arg.PreReleaseLabel)")
+            }
+            
+            if ($arg.BuildLabel) {
+                # make sure to include a leading plus for build labels
+                $OutputEncoding.GetBytes("+$($arg.BuildLabel)")
+            }
+            return
+        }
+
+        # If the arg is a datetime or datetimeoffset 
+        if ($arg -is [DateTime] -or $arg -is [DateTimeOffset]) {
+            # make it an offset, and then output 12 values
+            $dateArg = $arg -as [DateTimeOffset]
+            # * `year` `month` `day`
+            $dateArg.Year, $dateArg.Month, $dateArg.Day, 
+            # * `hour` `minute` `second`
+            $dateArg.Hour, $dateArg.Minute, $dateArg.Second,
+            # * `millisecond`, `microsecond`, `nanosecond`
+            $dateArg.Millisecond, $dateArg.Microsecond, $dateArg.Nanosecond,
+            # * `offset hours`, `offset minutes`, `offset seconds`
+            $dateArg.Offset.Hours,$dateArg.Offset.Minutes,$dateArg.Offset.Seconds
+            return
+        }
+        # If the arg is a string
+        if ($arg -is [string]) {
+            # return its bytes
+            return $OutputEncoding.GetBytes($arg)
+        }
+        # any input we have not caught, stringify and turn to bytes
+        return $OutputEncoding.GetBytes("$arg")        
+    }
+
+    
+    # Collect all of our input and arguments
+    $allIn = @($input) + @(
+        foreach ($arg in $args) {
+            $arg            
+        }
+    )
+
+    return $allIn | toVector
+}

Commands/Get-Vector.ps1

@@ -0,0 +1,46 @@
+function Get-Vector2 {
+    <#
+    .SYNOPSIS
+        Gets a Vector2
+    .DESCRIPTION
+        Gets any input and arguments as a Vector2
+    .LINK
+        https://learn.microsoft.com/en-us/dotnet/api/system.numerics.vector2?wt.mc_id=MVP_321542
+    .EXAMPLE
+        # Create a vector out of two numbers
+        Vector2 1 2
+    .EXAMPLE
+        (Vector2 1 2) + (Vector2 2 1)
+    .EXAMPLE
+        (Vector2 1 2) - (Vector2 2 1)
+    .EXAMPLE
+        # Create a thousand vectors
+        $vectors = Vector2 1..2kb
+    .EXAMPLE
+        # Create a thousand vectors in random order, using the pipeline
+        $vectors = 1..2kb | Get-Random -Count 2kb | Vector2
+    .EXAMPLE
+        # Create a vector from a string
+        $vector = Vector2 "hi"
+    #>
+    [Alias('V2','Vector2')]
+    param()
+    # Collect all of our input and arguments
+    $allIn = @($input) + @(
+        foreach ($arg in $args) {
+            $arg            
+        }
+    )
+
+    # and expand them
+    $expandAllIn = @($allIn | Vector)    
+
+    For ($n = 0; $n -lt $expandAllIn.Length; $n+=2) {
+        $argSet = $expandAllIn[$n..($n+1)] -as [float[]]
+        if ($argSet.Length -eq 1) {
+            [Numerics.Vector2]::new($argSet[0])
+        } else {
+            [Numerics.Vector2]::new($argSet)
+        }        
+    }    
+}