Include labels in markdown (#21)

* Get-BloggerPost markdown includes labels

* Publish-MarkdownBloggerPosts now supports -ExcludeLabels

* add ExcludeLabels to user preferences and use as default

* include empty tags in frontmatter when labels are not present

Author: bryanbcook

src/private/Get-BloggerSession.ps1

@@ -11,6 +11,7 @@ Function Get-BloggerSession
       PandocTemplate = "$($env:USERPROFILE)\\.PSBlogger\\template.html"
       PandocAdditionalArgs = "--html-q-tags --ascii"
       BlogId = $null
+      ExcludeLabels = @()
     }
 
   if (Test-Path $session.UserPreferences)

src/public/Get-BloggerConfig.ps1

@@ -11,5 +11,6 @@ Function Get-BloggerConfig
     PandocHtmlFormat = $BloggerSession.PandocHtmlFormat
     PandocAdditionalArgs = $BloggerSession.PandocAdditionalArgs
     BlogId = $BloggerSession.BlogId
+    ExcludeLabels = $BloggerSession.ExcludeLabels
   }
 }

src/public/Get-BloggerPost.ps1

@@ -116,6 +116,11 @@ Function Get-BloggerPost {
           $frontMatter = [ordered]@{
             postId = $result.id
           }
+          if ($result['labels']) {
+            $frontMatter['tags'] = $result.labels
+          } else {
+            $frontMatter['tags'] = @()
+          }
           $file = "$title.md"
           $filePath = Join-Path -Path $OutDirectory -ChildPath $file
           ConvertTo-MarkdownFromHtml -Content $result.content -OutFile $filePath > $null

src/public/Publish-MarkdownBloggerPost.ps1

@@ -42,8 +42,12 @@ Function Publish-MarkdownBloggerPost
     [Parameter(Mandatory=$false)]
     [switch]$Draft,
 
+    [Parameter(Mandatory=$false)]
+    [array]$ExcludeLabels = @(),
+
     [Parameter(Mandatory=$false)]
     [switch]$Force
+
   )
 
   if (!$PSBoundParameters.ContainsKey("BlogId"))
@@ -54,6 +58,10 @@ Function Publish-MarkdownBloggerPost
     }
   }
 
+  if (!$PSBoundParameters.ContainsKey("ExcludeLabels")) {
+    $ExcludeLabels = $BloggerSession.ExcludeLabels
+  }
+
   # grab the front matter
   $postInfo = Get-MarkdownFrontMatter -File $File
 
@@ -79,7 +87,7 @@ Function Publish-MarkdownBloggerPost
   }
 
   if ($postInfo["tags"]) {
-    $postArgs.Labels = [array]$postInfo.tags
+    $postArgs.Labels = [array]$postInfo.tags | Where-Object { $_ -notin $ExcludeLabels }
   }
 
   $post = Publish-BloggerPost @postArgs

src/public/Set-BloggerConfig.ps1

@@ -3,12 +3,12 @@ Function Set-BloggerConfig
   [CmdletBinding()]
   Param(
     [Parameter(Mandatory=$true)]
-    [ValidateSet("BlogId","PandocAdditionalArgs","PandocHtmlFormat","PandocMarkdownFormat")]
+    [ValidateSet("BlogId","PandocAdditionalArgs","PandocHtmlFormat","PandocMarkdownFormat","ExcludeLabels")]
     [string]$Name,
 
     [Parameter(Mandatory=$true)]
     [AllowEmptyString()]
-    [string]$Value
+    $Value
   )
   $userPreferences = [pscustomobject]@{}
 

src/tests/Get-BloggerPost.Tests.ps1

@@ -184,6 +184,7 @@ Describe "Get-BloggerPost" {
             title = "Test Post"
             published = [datetime]"2023-10-01T17:30:00-04:00"
             content = "<h1>Hello World</h1><p>This is a post.</p>" 
+            labels = @("Azure DevOps", "Azure Pipelines")
           }
         }
       }
@@ -200,7 +201,7 @@ Describe "Get-BloggerPost" {
       }
     }
 
-    It "Should write post details to frontmatter" {
+    It "Should write postid to frontmatter" {
 
       # act
       Get-BloggerPost -PostId $postId -Format Markdown -OutDirectory "TestDrive:\"
@@ -209,6 +210,44 @@ Describe "Get-BloggerPost" {
       $frontMatter = Get-MarkdownFrontMatter -File $outFile
       $frontMatter.postId | Should -Be "123"
     }
+
+    It "Should write labels to frontmatter" {
+      # act
+      Get-BloggerPost -PostId $postId -Format Markdown -OutDirectory "TestDrive:\"
+
+      # assert
+      $frontMatter = Get-MarkdownFrontMatter -File $outFile
+      $frontMatter.tags.Count | Should -Be 2
+      $frontMatter.tags[0] | Should -Be "Azure DevOps"
+      $frontMatter.tags[1] | Should -Be "Azure Pipelines"
+    }
+
+    It "Should include empty tags in frontmatter if labels are not present" {
+      # arrange
+      InModuleScope PSBlogger {
+        # Mock the session to return a test blog ID
+        $BloggerSession.BlogId = "test-blog-id"
+
+        $postId = "123"
+
+        # mock post retrieval
+        Mock Invoke-GApi {
+          return @{ 
+            id = $postId
+            title = "Test Post"
+            published = [datetime]"2023-10-01T17:30:00-04:00"
+            content = "<h1>Hello World</h1><p>This is a post.</p>"
+          }
+        }
+      }
+      # act
+      Get-BloggerPost -PostId $postId -Format Markdown -OutDirectory "TestDrive:\"
+
+      # assert
+      $frontMatter = Get-MarkdownFrontMatter -File $outFile
+      $frontMatter['tags'] -eq $null | Should -BeFalse
+      $frontMatter['tags'] | Should -Be @()
+    }
   }
 
   Context "As Json" {
@@ -280,6 +319,7 @@ Describe "Get-BloggerPost" {
     It "Should write file to specified formatted directory - <dateformat> - <format>" -TestCases @(
       @{ DateFormat = "yyyy\\MM"; ExpectedPath = "TestDrive:\2023\10\Test Post.md"; Format = "Markdown" }
       @{ DateFormat = "yyyy\\MM\\dd"; ExpectedPath = "TestDrive:\2023\10\01\123.html"; Format = "HTML" }
+      @{ DateFormat = "yyyy"; ExpectedPath = "TestDrive:\2023\123.json"; Format = "JSON"}
     ) {
       # arrange
       $invokeArgs = @{

src/tests/Publish-MarkdownBloggerPost.Tests.ps1

@@ -146,6 +146,45 @@ postId: "123456"
     Should -InvokeVerifiable 
   }
 
+  It "Should exclude certain tags from post labels when publishing " {
+    # arrange
+
+    # add our tags to the file
+    $postInfo = Get-MarkdownFrontMatter -File $validFile
+    $postInfo.tags = @("PowerShell","Pester", "personal/blog-post")
+    Set-MarkdownFrontMatter -File $validFile -Replace $postInfo
+
+    InModuleScope PSBlogger {
+      Mock Publish-BloggerPost -Verifiable -ParameterFilter { 
+        $Labels -ne $null -and (-not (Compare-Object $Labels @("PowerShell","Pester")))} { return @{ id="123"} }
+    }
+
+    # act
+    Publish-MarkdownBloggerPost -File $validFile -BlogId "123" -ExcludeLabels "personal/blog-post"
+
+    # assert
+    Should -InvokeVerifiable 
+  }
+
+  It "Should use excludelabels user preference when not specified" {
+    # arrange
+    InModuleScope PSBlogger {
+      $BloggerSession.ExcludeLabels = @("personal/blog-post")
+      Mock Publish-BloggerPost -Verifiable -ParameterFilter { 
+        $Labels -ne $null -and (-not (Compare-Object $Labels @("PowerShell","Pester")))} { return @{ id="123"} }
+    }
+
+    # add our tags to the file
+    $postInfo = Get-MarkdownFrontMatter -File $validFile
+    $postInfo.tags = @("PowerShell","Pester", "personal/blog-post")
+    Set-MarkdownFrontMatter -File $validFile -Replace $postInfo
+
+    # act
+    Publish-MarkdownBloggerPost -File $validFile -BlogId "123"
+
+    # assert
+    Should -InvokeVerifiable 
+  }
 
   It "Should update front matter with postid after publishing" {
     # arrange

src/tests/Set-BloggerConfig.Tests.ps1

@@ -13,6 +13,7 @@ Describe "Set-BloggerConfig" {
       # Create a new test-specific BloggerSession
       $BloggerSession = [pscustomobject]@{
         BlogId = $null
+        ExcludeLabels = @()
         UserPreferences = "TestDrive:\UserPreferences.json"
       }
 
@@ -23,6 +24,7 @@ Describe "Set-BloggerConfig" {
 
   It "Should persist new value to <UserPreference> to BloggerSession.UserPreferences" -TestCases @(
     @{ UserPreference="BlogId"; UserPreferenceValue="12345" }
+    @{ UserPreference="ExcludeLabels"; UserPreferenceValue=@("personal/blog-post") }
   ) {
 
     # act
@@ -37,6 +39,7 @@ Describe "Set-BloggerConfig" {
 
   It "Should persist new value to <UserPreference> to empty BloggerSession.UserPreferences file" -TestCases @(
     @{ UserPreference="BlogId"; UserPreferenceValue="12345" }
+    @{ UserPreference="ExcludeLabels"; UserPreferenceValue=@("personal/blog-post") }
   ) {
     # arrange: empty file
     Set-Content TestDrive:\UserPreferences.json -Value "{}"