markly 0.15.1 → 0.15.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 712a0a7ad856598eb83b20c370e7613896596af5c76cc2379a368382802f09db
-  data.tar.gz: f775598d6fc6e4d5e340bf68518816d3bd23bc44facd209fcd59bd4f0d429639
+  metadata.gz: 78c9ac76ac7421696ae270097bcf7e960f78b3ae8850232fa9d7c1d6a5e5d893
+  data.tar.gz: eb0e5d5ebcfb8cf4f128dc61ac3989eb789a31ae1f9ec7e99ecd6c9482859edc
 SHA512:
-  metadata.gz: f13cbaaba186b5716efb05567721ea024633f0c353f7296721406dd7d4f7918625e5518ae4836371a784808ae99de8d4831bf938df6595ed26da462398c6e39f
-  data.tar.gz: a92d4ee382baaf2bea98defccfd318142f0fdccf42ff5fca5293c17bf611e432d21e178f3d69a272f0c021309d3725454e93ea401d7473495ff4620490071d5d
+  metadata.gz: 2c68b3899e33d96fcfeb9ad0c2458f67dffd9b9f8d5a1e2f1b2cd8a158faf74d5b4e1246f59b7257606b8b2218175a3563ad048824878ae6b04f6a1f5b7bfc28
+  data.tar.gz: 27d4228f0c7f158d1397117ce744f4c00ed7a59fff8253756281dc3f87d01aa642759a71187e9ee137d051d91a9d059a739addaa8b9f8f3b23b544f7ebb3f18b

data/context/abstract-syntax-tree.md

@@ -39,7 +39,7 @@ You can use `walk` or `each` to iterate over nodes:
 <!-- end list -->
 
 ``` ruby
-require 'markly'
+require "markly"
 
 document = Markly.parse("# The site\n\n [GitHub](https://www.github.com)")
 
@@ -80,11 +80,10 @@ class MyHtmlRenderer < Markly::Renderer::HTML
 		super
 		@header_id = 1
 	end
-
+	
 	def header(node)
 		block do
-			out("<h", node.header_level, " id=\"", @header_id, "\">",
-							 :children, "</h", node.header_level, ">")
+			out("<h", node.header_level, " id=\"", @header_id, "\">", :children, "</h", node.header_level, ">")
 			@header_id += 1
 		end
 	end

data/context/headings.md

@@ -38,7 +38,7 @@ document = Markly.parse(markdown)
 headings = Markly::Renderer::Headings.extract(document, min_level: 2, max_level: 3)
 
 headings.each do |heading|
-  puts "#{heading.level}: #{heading.text} (#{heading.anchor})"
+	puts "#{heading.level}: #{heading.text} (#{heading.anchor})"
 end
 
 # Output:
@@ -90,25 +90,24 @@ Subclass `Headings` to implement alternative ID generation strategies:
 
 ``` ruby
 class HierarchicalHeadings < Markly::Renderer::Headings
-  def initialize
-    super
-    @parent_context = []
-  end
-  
-  def anchor_for(node)
-    base = base_anchor_for(node)
-    
-    # Custom logic: could incorporate parent heading context
-    # to generate IDs like "kubernetes-deployment" instead of "deployment-2"
-    
-    if @ids.key?(base)
-      @ids[base] += 1
-      "#{base}-#{@ids[base]}"
-    else
-      @ids[base] = 1
-      base
-    end
-  end
+	def initialize
+		super
+		@parent_context = []
+	end
+	
+	def anchor_for(node)
+		base = base_anchor_for(node)
+		
+		# Custom logic: could incorporate parent heading context to generate IDs like "kubernetes-deployment" instead of "deployment-2"
+		
+		if @ids.key?(base)
+			@ids[base] += 1
+			"#{base}-#{@ids[base]}"
+		else
+			@ids[base] = 1
+			base
+		end
+	end
 end
 
 renderer = Markly::Renderer::HTML.new(headings: HierarchicalHeadings.new)

data/ext/markly/blocks.c

@@ -72,6 +72,20 @@ static CMARK_INLINE bool S_is_space_or_tab(char c) {
   return (c == ' ' || c == '\t');
 }
 
+// Returns true if block is being finalized on the same line it ends.
+// This happens for:
+// - Document node (special case)
+// - Fenced code blocks (end on the closing fence line)
+// - Setext headings (end on the underline)
+// - Any block finalized on the same line it started (e.g., single-line HTML blocks)
+static CMARK_INLINE bool S_ends_on_current_line(cmark_parser *parser, cmark_node *b) {
+  return S_type(b) == CMARK_NODE_DOCUMENT ||
+         (S_type(b) == CMARK_NODE_CODE_BLOCK && b->as.code.fenced) ||
+         (S_type(b) == CMARK_NODE_HEADING && b->as.heading.setext) ||
+         // Single-line blocks: finalized on same line they started
+         b->start_line == parser->line_number;
+}
+
 static void S_parser_feed(cmark_parser *parser, const unsigned char *buffer,
                           size_t len, bool eof);
 
@@ -288,17 +302,15 @@ static cmark_node *finalize(cmark_parser *parser, cmark_node *b) {
   bool has_content;
 
   parent = b->parent;
-  assert(b->flags &
-         CMARK_NODE__OPEN); // shouldn't call finalize on closed blocks
+  assert(b->flags & CMARK_NODE__OPEN); // shouldn't call finalize on closed blocks
   b->flags &= ~CMARK_NODE__OPEN;
 
   if (parser->curline.size == 0) {
-    // end of input - line number has not been incremented
+    // end of input - line number has not been incremented:
     b->end_line = parser->line_number;
     b->end_column = parser->last_line_length;
-  } else if (S_type(b) == CMARK_NODE_DOCUMENT ||
-             (S_type(b) == CMARK_NODE_CODE_BLOCK && b->as.code.fenced) ||
-             (S_type(b) == CMARK_NODE_HEADING && b->as.heading.setext)) {
+  } else if (S_ends_on_current_line(parser, b)) {
+    // Block ends on current line (line_number already incremented):
     b->end_line = parser->line_number;
     b->end_column = parser->curline.size;
     if (b->end_column && parser->curline.ptr[b->end_column - 1] == '\n')
@@ -306,6 +318,7 @@ static cmark_node *finalize(cmark_parser *parser, cmark_node *b) {
     if (b->end_column && parser->curline.ptr[b->end_column - 1] == '\r')
       b->end_column -= 1;
   } else {
+    // Block ended on a previous line:
     b->end_line = parser->line_number - 1;
     b->end_column = parser->last_line_length;
   }

data/lib/markly/node.rb

@@ -6,6 +6,7 @@
 # Copyright, 2017, by Goro Fuji.
 # Copyright, 2018, by Jerry van Leeuwen.
 # Copyright, 2020-2025, by Samuel Williams.
+# Copyright, 2025, by Olle Jonsson.
 
 require_relative "node/inspect"
 

data/lib/markly/renderer/generic.rb

@@ -26,9 +26,9 @@ module Markly
 			def out(*args)
 				args.each do |arg|
 					if arg == :children
-						@node.each {|child| out(child)}
+						@node.each{|child| out(child)}
 					elsif arg.is_a?(Array)
-						arg.each {|x| render(x)}
+						arg.each{|x| render(x)}
 					elsif arg.is_a?(Node)
 						render(arg)
 					else
@@ -43,7 +43,7 @@ module Markly
 					document(node)
 					@stream.string
 				elsif @in_plain && node.type != :text && node.type != :softbreak
-					node.each {|child| render(child)}
+					node.each{|child| render(child)}
 				else
 					send(node.type, node)
 				end

data/lib/markly/renderer/html.rb

@@ -10,7 +10,13 @@
 
 require_relative "generic"
 require_relative "headings"
-require "cgi"
+
+require "cgi/escape"
+
+# Compatibility for older Ruby versions where escape_html alias doesn't exist:
+unless CGI.respond_to?(:escape_html)
+	require "cgi"
+end
 
 module Markly
 	module Renderer
@@ -256,10 +262,10 @@ module Markly
 			end
 			
 			TABLE_CELL_ALIGNMENT = {
-						left: ' align="left"',
-						right: ' align="right"',
-						center: ' align="center"'
-					}.freeze
+				left: ' align="left"',
+				right: ' align="right"',
+				center: ' align="center"'
+			}.freeze
 			
 			def table_cell(node)
 				align = TABLE_CELL_ALIGNMENT.fetch(@alignments[@column_index], "")

data/lib/markly/version.rb

@@ -7,5 +7,5 @@
 # Copyright, 2020-2025, by Samuel Williams.
 
 module Markly
-	VERSION = "0.15.1"
+	VERSION = "0.15.2"
 end

data/license.md

@@ -17,9 +17,11 @@ Copyright, 2018, by Akira Matsuda.
 Copyright, 2018, by Danny Iachini.  
 Copyright, 2019-2020, by Tomoya Chiba.  
 Copyright, 2019, by Brett Walker.  
-Copyright, 2020, by Olle Jonsson.  
+Copyright, 2020-2025, by Olle Jonsson.  
 Copyright, 2020-2025, by Samuel Williams.  
 Copyright, 2024, by Ross Kaffenberger.  
+Copyright, 2025, by Henrik Nyh.  
+Copyright, 2025, by Peter H. Boling.  
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

data/readme.md

@@ -1,18 +1,14 @@
 # Markly
 
-A parser and abstract syntax tree for Markdown documents (CommonMark compatible) in Ruby. Originally forked from
-[CommonMarker](https://github.com/gjtorikian/commonmarker). It also includes extensions to the CommonMark spec as
-documented in the [GitHub Flavored Markdown spec](http://github.github.com/gfm/), such as support for tables,
-strikethroughs, and autolinking.
+A parser and abstract syntax tree for Markdown documents (CommonMark compatible) in Ruby. Originally forked from [CommonMarker](https://github.com/gjtorikian/commonmarker). It also includes extensions to the CommonMark spec as documented in the [GitHub Flavored Markdown spec](http://github.github.com/gfm/), such as support for tables, strikethroughs, and autolinking.
 
 [![Development Status](https://github.com/ioquatix/markly/workflows/Test/badge.svg)](https://github.com/ioquatix/markly/actions?workflow=Test)
 
 ## Motivation
 
-This code base was originally forked from [Commonmarker](https://github.com/gjtorikian/commonmarker) before they
-switched from `cmark-gfm` (C) to `comrak` (Rust). The original implementation provided access to the abstract syntax
-tree (AST), which is useful for building tools on top of Markdown. The Rust implementation does not provide this
-functionality, and so this fork was created to continue to provide these (and more) features.
+This code base was originally forked from [Commonmarker](https://github.com/gjtorikian/commonmarker) before theyswitched from `cmark-gfm` (C) to `comrak` (Rust). The original implementation provided access to the abstract syntaxtree (AST), which is useful for building tools on top of Markdown. The Rust implementation did not provide thisfunctionality, and so this fork was created to continue to provide these (and more) features.
+
+It should be noted that `commonmarker` re-introduced AST access, but the original C implementation in this fork is [3-4x faster at processing Markdown into HTML](https://github.com/gjtorikian/commonmarker?tab=readme-ov-file#benchmarks) and has a more advanced HTML generation and AST processing features.
 
 ## Usage
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: markly
 version: !ruby/object:Gem::Version
-  version: 0.15.1
+  version: 0.15.2
 platform: ruby
 authors:
 - Garen Torikian
@@ -14,13 +14,15 @@ authors:
 - Andrew Anderson
 - Ben Woosley
 - Goro Fuji
+- Olle Jonsson
 - Tomoya Chiba
 - Akira Matsuda
 - Danny Iachini
+- Henrik Nyh
 - Jerry van Leeuwen
 - Michael Camilleri
 - Mu-An Chiou
-- Olle Jonsson
+- Peter H. Boling
 - Roberto Hidalgo
 - Ross Kaffenberger
 - Vitaliy Klachkov