devcenter-parser 2.3.0 → 2.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2b85742cc924ff6d0f7e6fe0bcfa49a2eb43277806ea4c0519d0de22a063d0a1
-  data.tar.gz: 9fa98501c58e7e0de8f37362255310ef4bd69fc51474f286408b3de011c85d48
+  metadata.gz: a6be89b82bc3dd6e4a40c3b7f1e3871fca55e301c4ff09f934457d84f01dc00b
+  data.tar.gz: 686278e2a9a08bacd5f17124adaaa0d6a3e728a5701814dc9ef15cedecd8a430
 SHA512:
-  metadata.gz: a77a54bbc08a84bd8564223f018be4a289dbc00430afec9af0c2b02fcd910d9ce7ed9dde8e90b41aba420352d3f4a405c996f1789d4f71ae7cc3add127860cdb
-  data.tar.gz: f9240f4cd342028a8ee388bae3ef4913623cbaf1c5e1c75ff27eb9fc0cb6e7e86ca9a01f62aaf9b69500caa7ccff867cb3088e172a9585d878853d62ca7cb97d
+  metadata.gz: 1d2cb1e536549ba20c82e76cee60a42d5394872232a815d4ecb0b10fcb29b3d726ec19cc76862e68df78fbd5763173ed6feaa7a3dc4804883f67d78c486b3e32
+  data.tar.gz: c3d69be0dedf80b7db4d70c5a0a188e82717207f65d2bd799ba1264a009b2d9c0e25c3ba73d993331927f43b7f64fb35decc85ab33ea65fbb6bb1f46f0108841

data/.github/dependabot.yml

@@ -0,0 +1,11 @@
+# To get started with Dependabot version updates, you'll need to specify which
+# package ecosystems to update and where the package manifests are located.
+# Please see the documentation for all configuration options:
+# https://docs.github.com/github/administering-a-repository/configuration-options-for-dependency-updates
+
+version: 2
+updates:
+  - package-ecosystem: "bundler"
+    directory: "/"
+    schedule:
+      interval: "weekly"

data/.github/workflows/sync_component_metadata.yml

@@ -0,0 +1,25 @@
+name: "Send data to Components Inventory"
+on:
+  workflow_dispatch:
+  push:
+    branches:
+      - "main"
+    paths:
+      - ".heroku/components-inventory/*.json"
+  pull_request:
+    types:
+      - opened
+      - synchronize
+    paths:
+      - ".heroku/components-inventory/*.json"
+jobs:
+  action:
+    runs-on: sfdc-hk-ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+      - name: Send data to Components Inventory
+        uses: heroku/components-action@main
+        with:
+          COMPONENTS_GHA_APP_ID: ${{ secrets.COMPONENTS_GHA_APP_ID}}
+          COMPONENTS_GHA_APP_PRIVATE_KEY: ${{ secrets.COMPONENTS_GHA_APP_PRIVATE_KEY}}
+          COMPONENTS_GHA_JSON_TOKEN: ${{ secrets.COMPONENTS_GHA_JSON_TOKEN}}

data/.heroku/components-inventory/devcenter-parser.json

@@ -0,0 +1,32 @@
+{
+  "slug": "devcenter-parser",
+  "name": "DevCenter Parser",
+  "description": "Markdown parser used on Heroku Dev Center",
+  "language": "Ruby",
+  "lifecycle_status": "Production",
+  "pipeline_uuid": null,
+  "repository_url": "https://github.com/heroku/devcenter-parser",
+  "stack": "Platform",
+  "stack_type": "Service",
+  "documentation_url": "https://github.com/heroku/devcenter-parser",
+  "metrics_url": null,
+  "sox": false,
+  "soc2": false,
+  "customer_facing": false,
+  "pager_duty_service_code": null,
+  "component_tier": "4",
+  "github_actions": true,
+  "github_release": false,
+  "github_actions_ci_workflow": null,
+  "authentication": null,
+  "platform": null,
+  "team_name": "Marketing Web Ops",
+  "planned_maintenance_severity": null,
+  "gus_team": "https://gus.lightning.force.com/lightning/r/ADM_Scrum_Team__c/a00B000000Bbl1zIAB/view",
+  "pci_tier": "TBD",
+  "consumer_type": "N/A",
+  "content_cacheable": "N/A",
+  "blast_radius": "Internal",
+  "audit_findings_url": null,
+  "last_audit": null
+}

data/CODEOWNERS

@@ -0,0 +1,6 @@
+# Lines starting with '#' are comments.
+# Each line is a file pattern followed by one or more owners.
+
+# These owners will be the default owners for everything in the repo.
+* @heroku/marketing-web-ops
+* @heroku/front-end

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    devcenter-parser (2.3.0)
+    devcenter-parser (2.4.0)
       nokogiri (>= 1.13.10)
       redcarpet (= 3.6.0)
       sanitize (~> 6.0.2)
@@ -10,12 +10,12 @@ GEM
   remote: http://rubygems.org/
   specs:
     crass (1.0.6)
-    mini_portile2 (2.8.4)
+    mini_portile2 (2.8.5)
     minitest (5.19.0)
-    nokogiri (1.15.4)
+    nokogiri (1.15.5)
       mini_portile2 (~> 2.8.2)
       racc (~> 1.4)
-    racc (1.7.1)
+    racc (1.7.3)
     rake (13.0.6)
     redcarpet (3.6.0)
     sanitize (6.0.2)
@@ -31,4 +31,4 @@ DEPENDENCIES
   rake
 
 BUNDLED WITH
-   2.1.4
+   2.2.33

data/README.md

@@ -1,4 +1,4 @@
-# devcenter-parser
+# DevCenter Parser
 
 Markdown parser used by [Heroku Dev Center](https://devcenter.heroku.com).
 

data/lib/devcenter-parser/github_parser.rb

@@ -47,11 +47,13 @@ module GitHubParser
 
   def self.special_blocks(doc)
     doc.css('blockquote>p:first').each do |node|
-      if match = node.inner_html.match(/\A\W*(callout|warning|note)\W/)
+      if match = node.inner_html.match(/\A\W*(callout|warning|note)\W|\[\!(callout|warning|note)\]\W/i)
         node.parent.name = 'div'
-        node.parent['class'] = match[1]
+        node.parent['class'] = match[1].downcase
 
-        new_html = node.inner_html.gsub(/\A\W*(callout|warning|note)\W/, '')
+        # This expression is slightly different because we want to remove the newline (\n) in this swap, compared to the
+        # match above that doesn't care about the newline.
+        new_html = node.inner_html.gsub(/\A\s*(callout|warning|note)\s*|\[\!(callout|warning|note)\]\s*/i, '')
 
         # Assigning inner_html directly causes encoding issues in old libxml versions,
         # workaround from https://github.com/sparklemotion/nokogiri/issues/458#issuecomment-3136620

data/lib/devcenter-parser/version.rb

@@ -1,3 +1,3 @@
 module DevcenterParser
-  VERSION = '2.3.0'.freeze
+  VERSION = '2.4.0'.freeze
 end

data/test/devcenter-parser_test.rb

@@ -408,6 +408,35 @@ HTML
       assert_parsing_result md, html
     end
 
+    it 'generates blockquotes for GitHub-style callouts in uppercase format' do
+      md = <<-MARKDOWN
+> [!WARNING]
+> This is a warning
+      MARKDOWN
+
+      expected = <<-HTML
+<div class="warning">
+<p>This is a warning</p>
+</div>
+      HTML
+
+      assert_parsing_result md, expected
+    end
+
+    it 'generates blockquotes for GitHub-style callouts in lowercase format' do
+      md = <<-MARKDOWN
+> [!warning]
+> This is a warning
+      MARKDOWN
+
+      expected = <<-HTML
+<div class="warning">
+<p>This is a warning</p>
+</div>
+      HTML
+
+      assert_parsing_result md, expected
+    end
 
     it 'generates separate blockquotes from blockquotes separated by empty lines' do
       md = <<-MARKDOWN

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: devcenter-parser
 version: !ruby/object:Gem::Version
-  version: 2.3.0
+  version: 2.4.0
 platform: ruby
 authors:
 - Heroku
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-08-16 00:00:00.000000000 Z
+date: 2024-02-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: nokogiri
@@ -87,7 +87,11 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/dependabot.yml"
+- ".github/workflows/sync_component_metadata.yml"
 - ".gitignore"
+- ".heroku/components-inventory/devcenter-parser.json"
+- CODEOWNERS
 - Gemfile
 - Gemfile.lock
 - LICENSE
@@ -118,7 +122,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.18
+rubygems_version: 3.4.10
 signing_key:
 specification_version: 4
 summary: Parser for Heroku Dev Center's content