devcenter-parser 2.3.0 → 2.5.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2b85742cc924ff6d0f7e6fe0bcfa49a2eb43277806ea4c0519d0de22a063d0a1
-  data.tar.gz: 9fa98501c58e7e0de8f37362255310ef4bd69fc51474f286408b3de011c85d48
+  metadata.gz: c4c53f614ec9479adb0fb78be87cdd30515834c467d1451515ab13abe121f4ac
+  data.tar.gz: 055c8a01895dc7b4646feab0727e71506b3caa4a4b6a48ae61f8abf2bffdbd52
 SHA512:
-  metadata.gz: a77a54bbc08a84bd8564223f018be4a289dbc00430afec9af0c2b02fcd910d9ce7ed9dde8e90b41aba420352d3f4a405c996f1789d4f71ae7cc3add127860cdb
-  data.tar.gz: f9240f4cd342028a8ee388bae3ef4913623cbaf1c5e1c75ff27eb9fc0cb6e7e86ca9a01f62aaf9b69500caa7ccff867cb3088e172a9585d878853d62ca7cb97d
+  metadata.gz: 38d174aaf87c2b54b14b4b17ad9b4145a86b9eb276b1edcff4ab691aee8acb812adcf692c15365f6f6ca22997fb3807f016254c96191485bf780d3c6c62e3fe4
+  data.tar.gz: 6bf94117132dde0e04fa438cf1e0c9fb851ec89db9960b0ffb6db8e3dbd21d0d750cdb7713835c1c0df07657c23e2e1426d3facb892a5d7f10a60501f3cdd5a5

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/.gitignore

@@ -1 +1,2 @@
 pkg/
+.DS_Store

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,8 +1,8 @@
 PATH
   remote: .
   specs:
-    devcenter-parser (2.3.0)
-      nokogiri (>= 1.13.10)
+    devcenter-parser (2.5.1)
+      nokogiri (~> 1.16)
       redcarpet (= 3.6.0)
       sanitize (~> 6.0.2)
 
@@ -10,13 +10,13 @@ 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.16.2)
       mini_portile2 (~> 2.8.2)
       racc (~> 1.4)
-    racc (1.7.1)
-    rake (13.0.6)
+    racc (1.7.3)
+    rake (13.1.0)
     redcarpet (3.6.0)
     sanitize (6.0.2)
       crass (~> 1.0.2)
@@ -28,7 +28,7 @@ PLATFORMS
 DEPENDENCIES
   devcenter-parser!
   minitest (~> 5.19.0)
-  rake
+  rake (~> 13.1.0)
 
 BUNDLED WITH
-   2.1.4
+   2.5.6

data/README.md

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

data/devcenter-parser.gemspec

@@ -16,10 +16,10 @@ Gem::Specification.new do |gem|
 
   gem.required_ruby_version = '>= 3.0.0'
 
-  gem.add_runtime_dependency 'nokogiri', '>= 1.13.10'
+  gem.add_runtime_dependency 'nokogiri', '~> 1.16'
   gem.add_runtime_dependency 'redcarpet', '3.6.0'
   gem.add_runtime_dependency 'sanitize', '~> 6.0.2'
 
   gem.add_development_dependency 'minitest', '~> 5.19.0'
-  gem.add_development_dependency 'rake'
+  gem.add_development_dependency 'rake', '~>13.1.0'
 end

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.5.1'.freeze
 end

data/lib/devcenter-parser.rb

@@ -33,7 +33,7 @@ module DevcenterParser
     convert_to_article_links_all_relative_links_with_missing_initial_slashes(doc, options)
     html = doc.to_html(:encoding => 'utf-8')
     verify_raw_html(html)
-    html
+    html 
   end
 
   def self.normalize_markdown(markdown)
@@ -71,12 +71,12 @@ module DevcenterParser
     return @@sanitize_config if defined?(@@sanitize_config)
     frozen_config = Sanitize::Config::RELAXED
     config = Marshal.load(Marshal.dump(frozen_config))
-    config[:attributes][:all] += %w{ id class style name width height border align data-next-message data-step-title }
+    config[:attributes][:all] += %w{ id class style name width height border align data-next-message data-step-title data-uuid data-type data-v }
     config[:attributes]['a'] += %w{ target }
     config[:elements] += %w{ div span hr tt }
 
     # embedded videos
-    config[:attributes][:all] += %w{ value src type allowscriptaccess allowfullscreen webkitallowfullscreen mozallowfullscreen frameborder }
+    config[:attributes][:all] += %w{ value src type allowscriptaccess allowfullscreen webkitallowfullscreen mozallowfullscreen frameborder allow }
     config[:elements] += %w{ object param embed iframe }
     config[:add_attributes] = {
       'object' => {'allowscriptaccess' => 'never'},
@@ -121,9 +121,11 @@ module DevcenterParser
   def self.sanitize_node_with_invalid_src
     lambda do |env|
       return unless env[:node].attributes['src']
+      # convert youtube.com to youtube-nocookies.com
+      env[:node].attributes['src'].value = env[:node].attributes['src'].value.sub('youtube.com', 'youtube-nocookie.com')
       # disallow javascript in src for all attributes
       env[:node].unlink if env[:node].attributes['src'].value =~ /\Ajavascript:/i
-      # allow iframes if they have src that is from vimeo
+      # allow iframes only if they have src that is from vimeo, YouTube (no-cookies version)
       env[:node].unlink if iframe?(env[:node]) && iframe_has_invalid_src?(env[:node])
     end
   end

data/test/devcenter-parser_test.rb

@@ -60,9 +60,15 @@ describe 'DevcenterParser' do
       assert_parsing_result src, src
     end
 
-    it 'removes youtube videos embedded from the with-cookies domain' do
-      src = '<iframe width="560" height="315" src="https://www.youtube.com/embed/123456ABCDEF" frameborder="0" allowfullscreen=""></iframe>'
-      assert_parsing_result src, ''
+    it 'allows embedding youtube videos from its no-cookies domain with allow attribute' do
+      src = '<iframe width="560" height="315" src="https://www.youtube-nocookie.com/embed/123456ABCDEF" frameborder="0" allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture; web-share" allowfullscreen=""></iframe>'
+      assert_parsing_result src, src
+    end
+
+    it 'converts youtube videos embedded from the with-cookies domain to the no-cookies domain' do
+      src = '<iframe width="560" height="315" src="https://www.youtube.com/embed/123456ABCDEF" title="YouTube video player" frameborder="0" allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture; web-share" allowfullscreen=""></iframe>'
+      src_result = '<iframe width="560" height="315" src="https://www.youtube-nocookie.com/embed/123456ABCDEF" title="YouTube video player" frameborder="0" allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture; web-share" allowfullscreen=""></iframe>'
+      assert_parsing_result src, src_result
     end
       
     it 'does not allow embedding vimeo videos when their do-no-track param is set to something different than true' do
@@ -75,6 +81,11 @@ describe 'DevcenterParser' do
       assert_parsing_result src, ''
     end
 
+    it 'allows embedding vidyard videos with data attributes' do
+      src = '<p><img style="width: 100%; margin: auto; display: block;" class="vidyard-player-embed" src="https://play.vidyard.com/123456ABCDEFG.jpg" data-uuid="123456ABCDEFG" data-v="4" data-type="inline"></p>'
+      assert_parsing_result src, src
+    end
+
     it 'allows images' do
       src = '<p><img src="http://nav.heroku.com/images/logos/logo.png" alt="image"></p>'
       assert_parsing_result src, src
@@ -408,6 +419,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
@@ -488,4 +528,8 @@ HTML
     assert DevcenterParser.to_html(md).include?("<#{header} id=\"#{id}\">"), "GitHub does not generate a #{header} with id #{id}"
   end
 
+  def assert_contains(md, contains)
+    assert DevcenterParser.to_html(md).include?(contains), "Failed when parsing #{md}\n.\n\nDid not contain: #{contains}\n\n"
+  end
+
 end

metadata

@@ -1,29 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: devcenter-parser
 version: !ruby/object:Gem::Version
-  version: 2.3.0
+  version: 2.5.1
 platform: ruby
 authors:
 - Heroku
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-08-16 00:00:00.000000000 Z
+date: 2024-03-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: nokogiri
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.13.10
+        version: '1.16'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.13.10
+        version: '1.16'
 - !ruby/object:Gem::Dependency
   name: redcarpet
   requirement: !ruby/object:Gem::Requirement
@@ -70,16 +70,16 @@ dependencies:
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 13.1.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 13.1.0
 description: Parser for Heroku Dev Center's content
 email:
 - heroku-front-end@salesforce.com
@@ -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.3.7
 signing_key:
 specification_version: 4
 summary: Parser for Heroku Dev Center's content