publishing_platform_markdown 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 0bb1a117a2a6388ec14973e1cba25a4cf6e1f1199d2668dd21c0268e862d364f
+  data.tar.gz: 3bef4c6285959e89dffd519a6eb8e5aa6234277003aee5808ea3cf6873d32da0
+SHA512:
+  metadata.gz: bb080a093077d16a38aee94cbd0e23f38482d32eff955ce11fd7eb0f647888200e9c87ece5fdf43ca110bcacdcae899a39ffabf97b7db0612d9610ac06618eec
+  data.tar.gz: e72f0a10ae62916c5df2ec63cab35adb917de86cca0fc4c1cd058ee2a9fca596b21370f0e34b15d8889aa7b2f9077b4d4c7991dd8394fbaab6fb07a9df19065c

data/Gemfile

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in publishing_platform_markdown.gemspec
+gemspec
+
+gem "rake", "~> 13.0"
+
+gem "rspec", "~> 3.0"

data/README.md

@@ -0,0 +1,2 @@
+# Publishing Platform Markdown
+Markdown extension library for the Publishing Platform.

data/Rakefile

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/lib/publishing_platform_markdown/html_sanitizer.rb

@@ -0,0 +1,35 @@
+class PublishingPlatformMarkdown::HtmlSanitizer
+  def initialize(dirty_html, options = {})
+    @dirty_html = dirty_html
+  end
+
+  def sanitize(allowed_elements: [])
+    Sanitize.fragment(@dirty_html, sanitize_config(allowed_elements:))
+  end  
+
+  def sanitize_config(allowed_elements: [])
+    # We purposefully disable style elements which Sanitize::Config::RELAXED allows
+    elements = Sanitize::Config::RELAXED[:elements] - %w[style] +
+      %w[svg path].concat(allowed_elements)
+
+    Sanitize::Config.merge(
+      Sanitize::Config::RELAXED,
+      elements:,
+      attributes: {
+        # We purposefully disable style attributes which Sanitize::Config::RELAXED allows
+        :all => Sanitize::Config::RELAXED[:attributes][:all] + %w[role aria-label] - %w[style],
+        "a" => Sanitize::Config::RELAXED[:attributes]["a"] + [:data] + %w[draggable],
+        "svg" => %w[xmlns width height viewbox focusable],
+        "path" => %w[fill d],
+        "div" => [:data],
+        # The style attributes are permitted here just for the ones Kramdown for table alignment
+        # we replace them in a post processor.
+        "th" => Sanitize::Config::RELAXED[:attributes]["th"] + %w[style],
+        "td" => Sanitize::Config::RELAXED[:attributes]["td"] + %w[style],
+      },
+      # The only styling we permit is text-align on table cells (which is the CSS kramdown
+      # generates), we can therefore only allow this one CSS property
+      css: { properties: %w[text-align] },
+    )
+  end
+end

data/lib/publishing_platform_markdown/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module PublishingPlatformMarkdown
+  VERSION = "0.1.0"
+end

data/lib/publishing_platform_markdown.rb

@@ -0,0 +1,42 @@
+# frozen_string_literal: true
+
+require "active_support"
+require "active_support/core_ext/hash"
+require "active_support/core_ext/array"
+require "kramdown"
+require "sanitize"
+
+require_relative "publishing_platform_markdown/version"
+require_relative "publishing_platform_markdown/html_sanitizer"
+
+module PublishingPlatformMarkdown
+  class Document
+    def self.to_html(source, options = {})
+      new(source, options).to_html
+    end
+
+    def initialize(source, options = {})
+      options = options.dup.deep_symbolize_keys
+      @source = source ? source.dup : ""
+
+      @allowed_elements = options.delete(:allowed_elements) || []
+      @options = { sanitize: true,
+                   syntax_highlighter: nil }.merge(options)
+    end
+
+    def to_html
+      @to_html ||= if @options[:sanitize]
+                     HtmlSanitizer.new(kramdown_doc.to_html)
+                                  .sanitize(allowed_elements: @allowed_elements)
+                   else
+                     kramdown_doc.to_html
+                   end
+    end
+
+  private
+
+    def kramdown_doc
+      @kramdown_doc ||= Kramdown::Document.new(@source, @options)
+    end
+  end
+end

metadata

@@ -0,0 +1,96 @@
+--- !ruby/object:Gem::Specification
+name: publishing_platform_markdown
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Publishing Platform
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2024-08-09 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: kramdown
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.3.1
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: 2.4.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.3.1
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: 2.4.1
+- !ruby/object:Gem::Dependency
+  name: sanitize
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '6'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '6'
+- !ruby/object:Gem::Dependency
+  name: publishing_platform_rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Markup language for the Publishing Platform
+email: 
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- Gemfile
+- README.md
+- Rakefile
+- lib/publishing_platform_markdown.rb
+- lib/publishing_platform_markdown/html_sanitizer.rb
+- lib/publishing_platform_markdown/version.rb
+homepage: 
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '3.0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.3.7
+signing_key: 
+specification_version: 4
+summary: Markup language for the Publishing Platform
+test_files: []