PomoShell.psm1

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
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
#
# Script module for module 'PomoShell'
#

#Requires -PSEdition Core
#Requires -Version 7.0
#Requires -Module BurntToast

enum PhaseStatus {
    New
    Running
    Paused
    Skipped
    Aborted
}

class Phase {
    [string] $Name
    [uint] $Duration  # In minute
    [uint] $Turn
    hidden [PhaseStatus] $Status
    hidden [datetime] $StartDate
    hidden [datetime] $EndDate
    hidden [datetime] $PauseDate
    hidden [uint] $SecondsRemainingAtPause

    Phase(
        [string] $Name,
        [uint] $Duration,
        [uint] $Turn
    ) {
        $this.Name = $Name
        $this.Duration = $Duration
        $this.Turn = $Turn
        $this.Status = [PhaseStatus]::"New"
    }

    [bool] IsNew() {
        return $this.Status -eq [PhaseStatus]::"New"
    }

    [bool] IsRunning() {
        return $this.Status -eq [PhaseStatus]::"Running"
    }

    [bool] IsPaused() {
        return $this.Status -eq [PhaseStatus]::"Paused"
    }

    [bool] IsSkippedOrAborted() {
        return $this.Status -in ([PhaseStatus]::"Skipped", [PhaseStatus]::"Aborted")
    }

    [bool] IsCompleted() {
        if ($this.IsRunning()) {
            return (Get-Date) -gt $this.EndDate
        }
        elseif ($this.IsPaused()) {
            return $this.SecondsRemainingAtPause -eq 0
        }
        return $this.IsSkippedOrAborted()
    }

    [void] Start() {
        if ($this.IsNew()) {
            $this.StartDate = Get-Date
            $this.EndDate = $this.StartDate.AddMinutes($this.Duration)
            $this.Status = [PhaseStatus]::"Running"
            Write-Debug -Message ("[Phase] {0} started (Turn {1})." -f $this.Name, $this.Turn)
        }
    }

    [void] Pause() {
        if ($this.IsRunning()) {
            $this.PauseDate = Get-Date
            $this.SecondsRemainingAtPause = $this.GetSecondsRemaining()
            $this.Status = [PhaseStatus]::"Paused"
            Write-Debug -Message ("[Phase] {0} paused." -f $this.Name)
        }
    }

    [void] Resume() {
        if ($this.IsPaused()) {
            $this.EndDate = (Get-Date).AddSeconds($this.SecondsRemainingAtPause)
            $this.Status = [PhaseStatus]::"Running"
            Write-Debug -Message ("[Phase] {0} resumed." -f $this.Name)
        }
    }

    [void] Skip() {
        if (-not $this.IsSkippedOrAborted()) {
            $this.EndDate = Get-Date
            $this.Status = [PhaseStatus]::"Skipped"
            Write-Debug -Message ("[Phase] {0} skipped." -f $this.Name)
        }
    }

    [void] Abort() {
        if (-not $this.IsSkippedOrAborted()) {
            $this.EndDate = Get-Date
            $this.Status = [PhaseStatus]::"Aborted"
            Write-Debug -Message ("[Phase] {0} aborted." -f $this.Name)
        }
    }

    [double] GetSecondsRemaining() {
        if ($this.IsPaused()) {
            return $this.SecondsRemainingAtPause
        }
        return ($this.EndDate - (Get-Date)).TotalSeconds
    }

    [int] GetPercentComplete() {
        return 100 - (($this.GetSecondsRemaining() / ($this.Duration * 60)) * 100)
    }

    [string] GetActivityName() {
        return "{0} - Turn {1}" -f $this.Name, $this.Turn
    }

    [string] GetStatusDescription() {
        if ($this.IsRunning()) {
            return "{0} (ends at {1})" -f $this.Status, $this.EndDate.ToShortTimeString()
        }
        elseif ($this.IsPaused()) {
            return "{0} (at {1})" -f $this.Status, $this.PauseDate.ToShortTimeString()
        }
        elseif ($this.IsSkippedOrAborted()) {
            return "{0} (at {1})" -f $this.Status, $this.EndDate.ToShortTimeString()
        }
        return $this.Status
    }

    [hashtable] GetEndStats() {
        if ($this.IsCompleted()) {
            return @{
                StartDate    = $this.StartDate
                EndDate      = $this.EndDate
                TotalMinutes = [Math]::Floor(($this.EndDate - $this.StartDate).TotalMinutes)
            }
        }
        return $null
    }

    [string] ToString() {
        return "{0}, {1} minutes, turn {2}" -f $this.Name, $this.Duration, $this.Turn
    }
}

function Invoke-Toast {
    param(
        [Parameter(Mandatory = $true)]
        [string] $Text
    )

    begin {
        $BurntToastNotification = @{
            Text    = "PomoShell", $Text
            AppLogo = Join-Path -Path $PSScriptRoot -ChildPath "PomoShell.png"
            Silent  = $true
            Confirm = $false
        }
    }

    process {
        try {
            New-BurntToastNotification @BurntToastNotification
            Write-Debug -Message ("[Toast] Shows `"{0}`"." -f $Text)
        }
        catch {
            Write-Error -Message ("[Toast] Cannot show `"{0}`": {1}" -f $Text, $_.Exception.Message)
        }
    }
}

function Invoke-Speech {
    param(
        [Parameter(Mandatory = $true)]
        [string] $Text
    )

    begin {
        <#
        SpeechVoiceSpeakFlags
            o SVSFDefault = 0 # Sync
            o SVSFlagsAsync = 1 # Async (buggy)
        #>

        $SPVoiceFlag = 0
    }

    process {
        try {
            $SPVoice = New-Object -ComObject SAPI.SPVoice
            $EnglishVoice = $SPVoice.GetVoices() | Where-Object -Property Id -Match ".*\\TTS_MS_EN-.*" | Select-Object -First 1
            if ($EnglishVoice) {
                $SPVoice.Voice = $EnglishVoice
            }
            else {
                Write-Warning -Message ("[Speech] No English voice found.")
            }
            $SPVoice.Speak($Text, $SPVoiceFlag) | Out-Null
            Write-Debug -Message ("[Speech] Says `"{0}`" with `"{1}`"." -f $Text, $SPVoice.Voice.GetDescription())
        }
        catch {
            Write-Error -Message ("[Speech] Cannot say `"{0}`": {1}" -f $Text, $_.Exception.Message)
        }
    }
}

function Push-Notification {
    param(
        [Parameter(Mandatory = $true)]
        [string] $Text,

        [Parameter()]
        [bool] $NoToast = $false,

        [Parameter()]
        [bool] $NoSpeech = $false
    )
    process {
        Write-Information -MessageData $Text
        if (-not $NoToast) {
            Invoke-Toast -Text $Text
        }
        if (-not $NoSpeech) {
            Invoke-Speech -Text $Text
        }
    }
}

function Invoke-Pomodoro {
    <#
 
    .SYNOPSIS
    Invokes pomodoro.
 
    .DESCRIPTION
    Invokes a pomodoro in your Powershell console.
 
    .PARAMETER FocusDuration
    Duration of a focus time in minute.
 
    .PARAMETER ShortBreakDuration
    Duration of a short break time in minute.
 
    .PARAMETER LongBreakDuration
    Duration of a long break time in minute.
 
    .PARAMETER LongBreakInterval
    Interval when a long break is triggered.
 
    .PARAMETER NoToastNotification
    Interval when a long break is triggered.
 
    .PARAMETER NoVoiceNotification
    Interval when a long break is triggered.
 
    .INPUTS
    None. You cannot pipe objects to Invoke-Pomodoro.
 
    .OUTPUTS
    PSCustomObject. The detailed phases that were done during the execution of the pomodoro.
 
    .EXAMPLE
    PS> Invoke-Pomodoro
 
    Start pomodoro with the default durations.
 
    .EXAMPLE
    PS> Invoke-Pomodoro -Focus 15 -ShortBreak 3 -LongBreak 10 -Interval 3
 
    Start pomodoro with custom durations.
 
    .EXAMPLE
    PS> Invoke-Pomodoro -NoToast -NoVoice
 
    Start pomodoro with all notifications turned off.
 
    .LINK
    GitHub repository: https://github.com/VouDoo/PomoShell
 
    .NOTES
    Key bindings:
        o <Space>: Pause or resume the current phase.
        o <S>: Skip the current phase.
        o <Q>: Stop the pomodoro.
 
    #>


    [CmdletBinding()]
    param(
        [Parameter(HelpMessage = "Duration of a focus time in minute")]
        [Alias("Focus")]
        [uint] $FocusDuration = 25,

        [Parameter(HelpMessage = "Duration of a short break time in minute")]
        [Alias("ShortBreak")]
        [uint] $ShortBreakDuration = 5,

        [Parameter(HelpMessage = "Duration of a long break time in minute")]
        [Alias("LongBreak")]
        [uint] $LongBreakDuration = 15,

        [Parameter(HelpMessage = "Interval when a long break is triggered")]
        [Alias("Interval")]
        [uint] $LongBreakInterval = 4,

        [Parameter(HelpMessage = "No Windows Toast notification will be shown")]
        [Alias("NoToast")]
        [switch] $NoToastNotification,

        [Parameter(HelpMessage = "No voice notification will be triggered")]
        [Alias("NoVoice")]
        [switch] $NoVoiceNotification
    )

    begin {
        $Continue = $true
        $Turn = 1
        $BreakPhase = $false
        $CompletedPhases = @()
        $NotificationOptions = @{
            NoToast  = $NoToastNotification.IsPresent
            NoSpeech = $NoVoiceNotification.IsPresent
        }
    }

    process {
        Write-Debug -Message "[Pomo] STARTED."

        #region Main loop
        while ($Continue) {
            # Create Phase object
            if ($BreakPhase) {
                if (($Turn % $LongBreakInterval) -eq 0) {
                    $Phase = New-Object -TypeName Phase -ArgumentList "Long Break", $LongBreakDuration, $Turn
                }
                else {
                    $Phase = New-Object -TypeName Phase -ArgumentList "Short Break", $ShortBreakDuration, $Turn
                }
                $BreakPhase = $false
                $Turn++
            }
            else {
                $Phase = New-Object -TypeName Phase -ArgumentList "Focus", $FocusDuration, $Turn
                $BreakPhase = $true
            }
            Write-Debug -Message ("[Pomo] Phase initiated: {0}." -f $Phase.ToString())

            $Phase.Start()

            Push-Notification @NotificationOptions -Text ("{0} has started." -f $Phase.Name)

            $Host.UI.RawUI.FlushInputBuffer()
            #region Phase Loop
            while (-not $Phase.IsCompleted() -and $Continue) {
                # Key actions
                if ($Host.UI.RawUI.KeyAvailable) {
                    $Key = $Host.UI.RawUI.ReadKey("NoEcho, IncludeKeyDown")
                    Write-Debug -Message "[ReadKey] $Key."
                    switch ($Key.VirtualKeyCode) {
                        # [Space] Pause/Resume the current phase
                        32 {
                            if ($Phase.IsRunning()) {
                                $Phase.Pause()
                            }
                            elseif ($Phase.IsPaused()) {
                                $Phase.Resume()
                            }
                        }
                        # [S] Skip the current phase
                        83 {
                            $Phase.Skip()
                        }
                        # [Q] Stop the pomodoro
                        81 {
                            $Phase.Pause()
                            $IsAnswered = $false
                            while (-not $IsAnswered) {
                                switch ((Read-Host -Prompt "Do you want to stop the pomodoro? [Y/N]").Trim().ToLower()) {
                                    "y" {
                                        $IsAnswered = $true
                                        $Continue = $false
                                        $Phase.Abort()
                                        Write-Debug -Message "[Pomo] Stopping..."
                                    }
                                    "n" {
                                        $IsAnswered = $true
                                        $Phase.Resume()
                                    }
                                }
                            }
                        }
                    }
                    $Host.UI.RawUI.FlushInputBuffer()
                }

                $Progress = @{
                    Activity         = $Phase.GetActivityName()
                    Status           = $Phase.GetStatusDescription()
                    PercentComplete  = $Phase.GetPercentComplete()
                    SecondsRemaining = $Phase.GetSecondsRemaining()
                }
                Write-Progress @Progress

                Start-Sleep -Milliseconds 666
            }
            #endregion Phase Loop

            Write-Progress -Activity $Phase.GetActivityName() -Completed

            Push-Notification @NotificationOptions -Text ("{0} has ended." -f $Phase.Name)

            $PhaseEndStats = $Phase.GetEndStats()
            $CompletedPhases += [PSCustomObject] @{
                Phase        = $Phase.Name
                Turn         = $Phase.Turn
                Start        = $PhaseEndStats.StartDate
                End          = $PhaseEndStats.EndDate
                TotalMinutes = $PhaseEndStats.TotalMinutes
            }

            Write-Debug -Message ("[Pomo] Phase completed: {0}." -f $Phase.ToString())

            Start-Sleep -Seconds 1
        }
        #endregion Main loop

        Write-Debug -Message "[Pomo] STOPPED."
    }

    end {
        Write-Debug -Message "[Pomo] Returns completed phases."
        $CompletedPhases
    }
}

# Create alias(es)
New-Alias -Name Pomo -Value "Invoke-Pomodoro"

# export member(s)
Export-ModuleMember -Function Invoke-Pomodoro -Alias Pomo