protos-markdown 1.0.0 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d484c25c78ff88494568a3342fb83f0ccedbe30f2d1b6f29d92f9d9e56ba49d9
-  data.tar.gz: 8ad09da4197ecdcab8a260a6140a727742b65bde66f22c25796187d74dd8e11a
+  metadata.gz: 149154ed4ed5d1bff8bcf411e6e8cae01b35f2103586420154bd6180096299d0
+  data.tar.gz: 7ec3a0c2fa97be4d83d5adcea88726c59a94b136ee13b2601ef09e3d4f05ff2d
 SHA512:
-  metadata.gz: fb088a0c93b8ffccffa81e60e256d7028bc569993dd53f8329867a354e7f594901f3d6134e451335851b13d4f70436aaf03f552e6f6ba84ebd8df8d91ca82f60
-  data.tar.gz: 15989f1b3d75e06983af2be29f28ce92f07224f315c55ba87a310d04bf2da3f0c5618302235df1ac7670b0f83f66838d44e36bfbb8961cbeada93b5144a7e2dd
+  metadata.gz: 8c690286a4117d42ec8cc7e65406a16c2bb53a2b27a91a7b00526b6dc2adf13dc9fd26eaf001f1a652e159725cdf5bd6703f403e07fd9c4654fc5dc20272d4fd
+  data.tar.gz: a62bf4a662a89ed16e714b824df65e2f12874f62e73a3b7b09c29efdc7eac8afb89d9950d699795886bbe1bacd175cffd339ed7c3c93cde4893914e7bff8b644

data/CHANGELOG.md

@@ -1,5 +1,17 @@
 ## [Unreleased]
 
+## 1.2.0 - 2025-12-25
+
+- Adds handling inline html elements
+- Adds handling more nodes for markdown tables
+- Adds handling inline html blocks
+
+## [1.1.0] - 2024-05-28
+
+- Changes from `markly` to `commonmarker` which has better support
+- Adds IDs to headings by default
+- Adds ability to override common marker options with `markdown_options`
+
 ## [0.1.1] - 2024-08-14
 
 - Adds `rouge` to gem dependencies

data/README.md

@@ -22,8 +22,8 @@ using the standard protos conventions:
 
 ```ruby
 class Markdown < Protos::Markdown
-  def h1 = super(class: css[:title])
-  def ul = super(class: "ml-4 pt-2")
+  def h1(**) = super(class: css[:title], **)
+  def ul(**) = super(class: "ml-4 pt-2", **)
 
   private
 
@@ -52,7 +52,7 @@ output = Markdown.new(content).call
 Which outputs the following html:
 
 ```html
-<h1 class="font-bold text-xl">Hello World</h1>
+<h1 class="font-bold text-xl" id="hello-world">Hello World</h1>
 <ul class="ml-4 pt-2">
   <li>A</li>
   <li>B</li>

data/lib/protos/markdown/ast.rb

@@ -17,14 +17,15 @@ module Protos
         end
       end
 
-      def self.parse(content, **kwargs)
+      def self.parse(content, markdown_options: {})
         options = {
-          flags: Markly::GITHUB_PRE_LANG,
-          extensions: [:table]
-        }.merge(kwargs)
+          render: { gfm_quirks: true },
+          extension: { table: true },
+          **markdown_options
+        }
 
-        Markly
-          .parse(content, **options)
+        Commonmarker
+          .parse(content, options:)
           .then { |node| new(Node.new(node)) }
       end
 

data/lib/protos/markdown/table.rb

@@ -3,12 +3,17 @@
 module Protos
   class Markdown
     class Table < Protos::Table
-      option :inside_header, default: -> { false }, reader: false
+      option :inside_header, default: -> { true }, reader: false
+      option :sanitize, default: -> { true }
 
       def visit_table(node)
         visit_children(node)
       end
 
+      def visit_image(node)
+        img(src: node.url, alt: node.first&.string_content)
+      end
+
       def visit_table_header(node)
         @inside_header = true
 
@@ -30,11 +35,11 @@ module Protos
       end
 
       def visit_table_row(node)
-        @inside_header = false
-
         row do
           visit_children(node)
         end
+
+        @inside_header = false
       end
 
       def visit_code(node)
@@ -45,6 +50,20 @@ module Protos
         strong { visit_children(node) }
       end
 
+      def visit_emph(node)
+        em { visit_children(node) }
+      end
+
+      def visit_html_inline(node)
+        return if @sanitize
+
+        raw safe(node.to_html(options: { render: { unsafe: true } }))
+      end
+
+      def visit_link(node)
+        a(href: node.url, title: node.title) { visit_children(node) }
+      end
+
       private
 
       def visit_children(node)

data/lib/protos/markdown.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 require "protos"
-require "markly"
+require "commonmarker"
 require "rouge"
 require "delegate"
 
@@ -10,8 +10,29 @@ require_relative "markdown/table"
 
 module Protos
   class Markdown < ::Protos::Component # rubocop:disable Metrics/ClassLength
-    param :content, reader: false
-    option :sanitize, default: -> { true }, reader: false
+    param :content
+    option :sanitize, default: -> { true }
+    option :markdown_options, default: -> { {} }
+
+    Heading = Data.define(:node) do
+      def id
+        text.downcase.gsub(/[^a-z0-9]+/, "-").chomp("-")
+      end
+
+      def text
+        buffer = +""
+        node.walk do |node|
+          buffer << node.string_content
+        rescue TypeError
+          # Ignore non-text nodes
+        end
+        buffer
+      end
+
+      def header_level
+        node.header_level
+      end
+    end
 
     def view_template
       return unless root
@@ -23,8 +44,12 @@ module Protos
       # Do nothing
     end
 
+    def visit_linebreak(_node)
+      br
+    end
+
     def visit_table(node)
-      render Markdown::Table.new do |table|
+      render Markdown::Table.new(sanitize:) do |table|
         node.accept(table)
       end
     end
@@ -37,14 +62,16 @@ module Protos
       plain(node.string_content)
     end
 
-    def visit_header(node)
-      case node.header_level
-      in 1 then h1 { visit_children(node) }
-      in 2 then h2 { visit_children(node) }
-      in 3 then h3 { visit_children(node) }
-      in 4 then h4 { visit_children(node) }
-      in 5 then h5 { visit_children(node) }
-      in 6 then h6 { visit_children(node) }
+    def visit_heading(node)
+      heading = Heading.new(node)
+
+      case heading.header_level
+      in 1 then h1(id: heading.id) { visit_children(node) }
+      in 2 then h2(id: heading.id) { visit_children(node) }
+      in 3 then h3(id: heading.id) { visit_children(node) }
+      in 4 then h4(id: heading.id) { visit_children(node) }
+      in 5 then h5(id: heading.id) { visit_children(node) }
+      in 6 then h6(id: heading.id) { visit_children(node) }
       end
     end
 
@@ -80,12 +107,13 @@ module Protos
 
     def visit_list(node)
       case node.list_type
-      when :ordered_list then ol { visit_children(node) }
-      when :bullet_list then ul { visit_children(node) }
+      when :ordered then ol { visit_children(node) }
+      when :bullet then ul { visit_children(node) }
+      else raise ArgumentError, "Unknown list type: #{node.list_type}"
       end
     end
 
-    def visit_list_item(node)
+    def visit_item(node)
       li { visit_children(node) }
     end
 
@@ -105,11 +133,11 @@ module Protos
       end
     end
 
-    def visit_hrule(_node)
+    def visit_thematic_break(_node)
       hr
     end
 
-    def visit_blockquote(node)
+    def visit_block_quote(node)
       blockquote { visit_children(node) }
     end
 
@@ -119,16 +147,26 @@ module Protos
       raw safe(node.string_content)
     end
 
-    def visit_inline_html(node)
+    def visit_html_inline(node)
       return if @sanitize
 
-      raw safe(node.string_content)
+      raw safe(node.to_html(options: { render: { unsafe: true } }))
+    end
+
+    def visit_html_block(node)
+      return if @sanitize
+
+      raw safe(node.to_html(options: { render: { unsafe: true } }))
+    end
+
+    def visit_escaped(node)
+      plain(node.first_child&.string_content)
     end
 
     private
 
     def root
-      AST.parse(@content)
+      AST.parse(@content, markdown_options: @markdown_options)
     end
 
     def formatter

data/protos-markdown.gemspec

@@ -2,7 +2,7 @@
 
 Gem::Specification.new do |spec|
   spec.name = "protos-markdown"
-  spec.version = "1.0.0"
+  spec.version = "1.2.0"
   spec.authors = ["Nolan Tait"]
   spec.email = ["nolanjtait@gmail.com"]
 
@@ -30,7 +30,7 @@ Gem::Specification.new do |spec|
   spec.executables = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]
 
-  spec.add_dependency "markly", "~> 0.9"
+  spec.add_dependency "commonmarker", "~> 2.3"
   spec.add_dependency "protos", "~> 1"
   spec.add_dependency "rouge", "~> 4"
 

metadata

@@ -1,28 +1,28 @@
 --- !ruby/object:Gem::Specification
 name: protos-markdown
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.2.0
 platform: ruby
 authors:
 - Nolan Tait
 bindir: exe
 cert_chain: []
-date: 2025-03-02 00:00:00.000000000 Z
+date: 1980-01-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: markly
+  name: commonmarker
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.9'
+        version: '2.3'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.9'
+        version: '2.3'
 - !ruby/object:Gem::Dependency
   name: protos
   requirement: !ruby/object:Gem::Requirement
@@ -92,7 +92,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.6.2
+rubygems_version: 4.0.3
 specification_version: 4
 summary: A markdown renderer with Phlex and Protos
 test_files: []