markly 0.13.1 → 0.14.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 27e214dc5a3adbf51c0f0a85b5d78aa6a416be484d19e2c8ccce0259bf12067a
-  data.tar.gz: 352e16ba56789faecdf09cfa684e74253272821e39ba3145ca4b31fcf83062a7
+  metadata.gz: 7eb58c81c8fca95217e5a1469baf3034785126d6ff42e9929a7d074e358b9508
+  data.tar.gz: f28760fe0280ce1ab132d7ec639584284dde3ba8077e68f2cd3617715d1211cb
 SHA512:
-  metadata.gz: 4716ba689aa82f3ca48132f89668b9af3103d6cf1d42310ac5227e7f45410d80afb3bf9bb4ba85c016d84eba0bef288a95ddbc7b3f3b3d43e755786d49932481
-  data.tar.gz: de38f35598e682c161b79dae319c08951815b66361cd29cfb0e15ee4349cce18816314fad2ad7a25cadde345f71e4970046272c647c78afe51235648d72ef080
+  metadata.gz: ded6fff6a6355a8e78b2daa19a1581d982a35ddbcbddc38efe25d1866e9ce6136ea6eea62c1638874ff9953546a176df11e6ce462c9131ab38648185dec50a7a
+  data.tar.gz: ccc6eb379235978b3a512dee8553a425ca456b01e9f60b10d16927ae1862cda069152fcc62a02a1a60d46b274a1c8aa760183a636c528b8cdc7fdf43a367abd8

data/ext/markly/extconf.rb

@@ -6,14 +6,14 @@
 # Copyright, 2015-2019, by Garen Torikian.
 # Copyright, 2016-2017, by Yuki Izumi.
 # Copyright, 2017, by Ashe Connor.
-# Copyright, 2020-2023, by Samuel Williams.
+# Copyright, 2020-2025, by Samuel Williams.
 
-require 'mkmf'
+require "mkmf"
 
 append_cflags(["-O3", "-Wall", "-Wno-unknown-pragmas", "-std=c99"])
 
 gem_name = File.basename(__dir__)
-extension_name = 'markly'
+extension_name = "markly"
 
 # The destination:
 dir_config(extension_name)

data/lib/markly/node/inspect.rb

@@ -4,24 +4,24 @@
 # Copyright, 2017, by Goro Fuji.
 # Copyright, 2017-2019, by Garen Torikian.
 # Copyright, 2020, by Olle Jonsson.
-# Copyright, 2020-2023, by Samuel Williams.
+# Copyright, 2020-2025, by Samuel Williams.
 
-require 'pp'
+require "pp"
 
 module Markly
 	class Node
 		module Inspect
 			PP_INDENT_SIZE = 2
-
+			
 			def inspect
-				PP.pp(self, +'', Float::INFINITY)
+				PP.pp(self, +"", Float::INFINITY)
 			end
-
+			
 			# @param printer [PrettyPrint] pp
 			def pretty_print(printer)
-				printer.group(PP_INDENT_SIZE, "#<#{self.class}(#{type}):", '>') do
+				printer.group(PP_INDENT_SIZE, "#<#{self.class}(#{type}):", ">") do
 					printer.breakable
-
+					
 					attrs = %i[
 						source_position
 						string_content
@@ -39,12 +39,12 @@ module Markly
 							nil
 						end
 					end.compact
-
+					
 					printer.seplist(attrs) do |name, value|
 						printer.text "#{name}="
 						printer.pp value
 					end
-
+					
 					if first_child
 						printer.breakable
 						printer.group(PP_INDENT_SIZE) do
@@ -54,7 +54,7 @@ module Markly
 								children << node
 								node = node.next
 							end
-							printer.text 'children='
+							printer.text "children="
 							printer.pp children
 						end
 					end

data/lib/markly/node.rb

@@ -5,9 +5,9 @@
 # Copyright, 2016-2017, by Yuki Izumi.
 # Copyright, 2017, by Goro Fuji.
 # Copyright, 2018, by Jerry van Leeuwen.
-# Copyright, 2020-2024, by Samuel Williams.
+# Copyright, 2020-2025, by Samuel Williams.
 
-require_relative 'node/inspect'
+require_relative "node/inspect"
 
 module Markly
 	class Node
@@ -32,13 +32,13 @@ module Markly
 		# blk - A {Proc} representing the action to take for each child
 		def walk(&block)
 			return enum_for(:walk) unless block_given?
-
+			
 			yield self
 			each do |child|
 				child.walk(&block)
 			end
 		end
-
+		
 		# Public: Convert the node to an HTML string.
 		#
 		# options - A {Symbol} or {Array of Symbol}s indicating the render options
@@ -46,9 +46,9 @@ module Markly
 		#
 		# Returns a {String}.
 		def to_html(flags: DEFAULT, extensions: [])
-			_render_html(flags, extensions).force_encoding('utf-8')
+			_render_html(flags, extensions).force_encoding("utf-8")
 		end
-
+		
 		# Public: Convert the node to a CommonMark string.
 		#
 		# options - A {Symbol} or {Array of Symbol}s indicating the render options
@@ -56,11 +56,11 @@ module Markly
 		#
 		# Returns a {String}.
 		def to_commonmark(flags: DEFAULT, width: 0)
-			_render_commonmark(flags, width).force_encoding('utf-8')
+			_render_commonmark(flags, width).force_encoding("utf-8")
 		end
-
+		
 		alias to_markdown to_commonmark
-
+		
 		# Public: Convert the node to a plain text string.
 		#
 		# options - A {Symbol} or {Array of Symbol}s indicating the render options
@@ -68,13 +68,13 @@ module Markly
 		#
 		# Returns a {String}.
 		def to_plaintext(flags: DEFAULT, width: 0)
-			_render_plaintext(flags, width).force_encoding('utf-8')
+			_render_plaintext(flags, width).force_encoding("utf-8")
 		end
-
+		
 		# Public: Iterate over the children (if any) of the current pointer.
 		def each
 			return enum_for(:each) unless block_given?
-
+			
 			child = first_child
 			while child
 				next_child = child.next
@@ -179,6 +179,6 @@ module Markly
 			
 			fragment
 		end
-			
+		
 	end
 end

data/lib/markly/renderer/generic.rb

@@ -3,32 +3,32 @@
 # Released under the MIT License.
 # Copyright, 2015-2019, by Garen Torikian.
 # Copyright, 2016-2017, by Yuki Izumi.
-# Copyright, 2020-2023, by Samuel Williams.
+# Copyright, 2020-2025, by Samuel Williams.
 
-require 'set'
-require 'stringio'
+require "set"
+require "stringio"
 
 module Markly
 	module Renderer
 		class Generic
 			def initialize(flags: DEFAULT, extensions: [])
 				@flags = flags
-				@stream = StringIO.new(+'')
+				@stream = StringIO.new(+"")
 				@need_blocksep = false
 				@in_tight = false
 				@in_plain = false
 				@tagfilter = extensions.include?(:tagfilter)
 			end
-
+			
 			attr_accessor :in_tight
 			attr_accessor :in_plain
-
+			
 			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
@@ -36,72 +36,72 @@ module Markly
 					end
 				end
 			end
-
+			
 			def render(node)
 				@node = node
 				if node.type == :document
 					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
 			end
-
+			
 			def document(_node)
 				out(:children)
 			end
-
+			
 			def code_block(node)
 				code_block(node)
 			end
-
+			
 			def reference_def(_node); end
-
+			
 			def cr
 				return if @stream.string.empty? || @stream.string[-1] == "\n"
-
+				
 				out("\n")
 			end
-
+			
 			def blocksep
 				out("\n")
 			end
-
+			
 			def containersep
 				cr unless @in_tight
 			end
-
+			
 			def block
 				cr
 				yield
 				cr
 			end
-
+			
 			def container(starter, ender)
 				out(starter)
 				yield
 				out(ender)
 			end
-
+			
 			def plain
 				old_in_plain = @in_plain
 				@in_plain = true
 				yield
 				@in_plain = old_in_plain
 			end
-
+			
 			private
-
+			
 			def escape_href(str)
 				@node.html_escape_href(str)
 			end
-
+			
 			def escape_html(str)
 				@node.html_escape_html(str)
 			end
-
+			
 			def tagfilter(str)
 				if @tagfilter
 					str.gsub(
@@ -119,15 +119,15 @@ module Markly
 					str
 				end
 			end
-
+			
 			def source_position(node)
-				return '' unless flag_enabled?(SOURCE_POSITION)
-
+				return "" unless flag_enabled?(SOURCE_POSITION)
+				
 				s = node.source_position
 				" data-sourcepos=\"#{s[:start_line]}:#{s[:start_column]}-" \
 					"#{s[:end_line]}:#{s[:end_column]}\""
 			end
-
+			
 			def flag_enabled?(flag)
 				(@flags & flag) != 0
 			end

data/lib/markly/renderer/html.rb

@@ -6,10 +6,10 @@
 # Copyright, 2017, by Yuki Izumi.
 # Copyright, 2017-2019, by Ashe Connor.
 # Copyright, 2018, by Michael Camilleri.
-# Copyright, 2020-2023, by Samuel Williams.
+# Copyright, 2020-2025, by Samuel Williams.
 
-require_relative 'generic'
-require 'cgi'
+require_relative "generic"
+require "cgi"
 
 module Markly
 	module Renderer
@@ -30,51 +30,64 @@ module Markly
 				out("</ol>\n</section>\n") if @written_footnote_ix
 				out("</section>") if @section
 			end
-
+			
 			def id_for(node)
 				if @ids
-					id = node.to_plaintext.chomp.downcase.gsub(/\s+/, '-')
-					
-					return " id=\"#{CGI.escape_html id}\""
+					anchor = self.class.anchor_for(node)
+					return " id=\"#{CGI.escape_html anchor}\""
 				end
 			end
-
+			
+			def self.anchor_for(node)
+				# Convert to plaintext, strip trailing whitespace, convert to lowercase:
+				text = node.to_plaintext.chomp.downcase
+				
+				# Replace sequences of whitespace with hyphens:
+				text.gsub!(/\s+/, "-")
+				
+				return text
+			end
+			
+			def anchor_for(node)
+				self.class.anchor_for(node)
+			end
+			
 			def header(node)
 				block do
 					if @ids
-						out('</section>') if @section
+						out("</section>") if @section
 						@section = true
 						out("<section#{id_for(node)}>")
 					end
 					
-					out('<h', node.header_level, "#{source_position(node)}>", :children,
-							'</h', node.header_level, '>')
+					out("<h", node.header_level, "#{source_position(node)}>", :children,
+							"</h", node.header_level, ">")
 				end
 			end
-
+			
 			def paragraph(node)
 				if @tight && node.parent.type != :blockquote
 					out(:children)
 				else
 					block do
-						container("<p#{source_position(node)}>", '</p>') do
+						container("<p#{source_position(node)}>", "</p>") do
 							out(:children)
 							if node.parent.type == :footnote_definition && node.next.nil?
-								out(' ')
+								out(" ")
 								out_footnote_backref
 							end
 						end
 					end
 				end
 			end
-
+			
 			def list(node)
 				old_tight = @tight
 				@tight = node.list_tight
-
+				
 				block do
 					if node.list_type == :bullet_list
-						container("<ul#{source_position(node)}>\n", '</ul>') do
+						container("<ul#{source_position(node)}>\n", "</ul>") do
 							out(:children)
 						end
 					else
@@ -83,27 +96,27 @@ module Markly
 						else
 							"<ol start=\"#{node.list_start}\"#{source_position(node)}>\n"
 						end
-						container(start, '</ol>') do
+						container(start, "</ol>") do
 							out(:children)
 						end
 					end
 				end
-
+				
 				@tight = old_tight
 			end
-
+			
 			def list_item(node)
 				block do
 					tasklist_data = tasklist(node)
-					container("<li#{source_position(node)}#{tasklist_data}>#{' ' if tasklist?(node)}", '</li>') do
+					container("<li#{source_position(node)}#{tasklist_data}>#{' ' if tasklist?(node)}", "</li>") do
 						out(:children)
 					end
 				end
 			end
-
+			
 			def tasklist(node)
-				return '' unless tasklist?(node)
-
+				return "" unless tasklist?(node)
+				
 				state = if checked?(node)
 					'checked="" disabled=""'
 				else
@@ -111,109 +124,109 @@ module Markly
 				end
 				"><input type=\"checkbox\" #{state} /"
 			end
-
+			
 			def blockquote(node)
 				block do
-					container("<blockquote#{source_position(node)}>\n", '</blockquote>') do
+					container("<blockquote#{source_position(node)}>\n", "</blockquote>") do
 						out(:children)
 					end
 				end
 			end
-
+			
 			def hrule(node)
 				block do
 					out("<hr#{source_position(node)} />")
 				end
 			end
-
+			
 			def code_block(node)
 				block do
 					if flag_enabled?(GITHUB_PRE_LANG)
 						out("<pre#{source_position(node)}")
 						out(' lang="', node.fence_info.split(/\s+/)[0], '"') if node.fence_info && !node.fence_info.empty?
-						out('><code>')
+						out("><code>")
 					else
 						out("<pre#{source_position(node)}><code")
 						if node.fence_info && !node.fence_info.empty?
 							out(' class="language-', node.fence_info.split(/\s+/)[0], '">')
 						else
-							out('>')
+							out(">")
 						end
 					end
 					out(escape_html(node.string_content))
-					out('</code></pre>')
+					out("</code></pre>")
 				end
 			end
-
+			
 			def html(node)
 				block do
 					if flag_enabled?(UNSAFE)
 						out(tagfilter(node.string_content))
 					else
-						out('<!-- raw HTML omitted -->')
+						out("<!-- raw HTML omitted -->")
 					end
 				end
 			end
-
+			
 			def inline_html(node)
 				if flag_enabled?(UNSAFE)
 					out(tagfilter(node.string_content))
 				else
-					out('<!-- raw HTML omitted -->')
+					out("<!-- raw HTML omitted -->")
 				end
 			end
-
+			
 			def emph(node)
-				out('<em>', :children, '</em>')
+				out("<em>", :children, "</em>")
 			end
-
+			
 			def strong(node)
 				if node.parent.nil? || node.parent.type == node.type
 					out(:children)
 				else
-					out('<strong>', :children, '</strong>')
+					out("<strong>", :children, "</strong>")
 				end
 			end
-
+			
 			def link(node)
-				out('<a href="', node.url.nil? ? '' : escape_href(node.url), '"')
+				out('<a href="', node.url.nil? ? "" : escape_href(node.url), '"')
 				out(' title="', escape_html(node.title), '"') if node.title && !node.title.empty?
-				out('>', :children, '</a>')
+				out(">", :children, "</a>")
 			end
-
+			
 			def image(node)
 				out('<img src="', escape_href(node.url), '"')
 				plain do
 					out(' alt="', :children, '"')
 				end
 				out(' title="', escape_html(node.title), '"') if node.title && !node.title.empty?
-				out(' />')
+				out(" />")
 			end
-
+			
 			def text(node)
 				out(escape_html(node.string_content))
 			end
-
+			
 			def code(node)
-				out('<code>')
+				out("<code>")
 				out(escape_html(node.string_content))
-				out('</code>')
+				out("</code>")
 			end
-
+			
 			def linebreak(_node)
 				out("<br />\n")
 			end
-
+			
 			def softbreak(_)
 				if flag_enabled?(HARD_BREAKS)
 					out("<br />\n")
 				elsif flag_enabled?(NO_BREAKS)
-					out(' ')
+					out(" ")
 				else
 					out("\n")
 				end
 			end
-
+			
 			def table(node)
 				@alignments = node.table_alignments
 				@needs_close_tbody = false
@@ -221,15 +234,15 @@ module Markly
 				out("</tbody>\n") if @needs_close_tbody
 				out("</table>\n")
 			end
-
+			
 			def table_header(node)
 				@column_index = 0
-
+				
 				@in_header = true
 				out("<thead>\n<tr#{source_position(node)}>\n", :children, "</tr>\n</thead>\n")
 				@in_header = false
 			end
-
+			
 			def table_row(node)
 				@column_index = 0
 				if !@in_header && !@needs_close_tbody
@@ -238,36 +251,36 @@ module Markly
 				end
 				out("<tr#{source_position(node)}>\n", :children, "</tr>\n")
 			end
-
+			
 			TABLE_CELL_ALIGNMENT = {
 				left: ' align="left"',
 				right: ' align="right"',
 				center: ' align="center"'
 			}.freeze
-
+			
 			def table_cell(node)
-				align = TABLE_CELL_ALIGNMENT.fetch(@alignments[@column_index], '')
+				align = TABLE_CELL_ALIGNMENT.fetch(@alignments[@column_index], "")
 				out(@in_header ? "<th#{align}#{source_position(node)}>" : "<td#{align}#{source_position(node)}>", :children, @in_header ? "</th>\n" : "</td>\n")
 				@column_index += 1
 			end
-
+			
 			def strikethrough(_)
-				out('<del>', :children, '</del>')
+				out("<del>", :children, "</del>")
 			end
-
+			
 			def footnote_reference(node)
 				label = node.parent_footnote_def.string_content
 				
 				out("<sup class=\"footnote-ref\"><a href=\"#fn-#{label}\" id=\"fnref-#{label}\" data-footnote-ref>#{node.string_content}</a></sup>")
 				# out(node.to_html)
 			end
-
+			
 			def footnote_definition(node)
 				unless @footnote_ix
 					out("<section class=\"footnotes\" data-footnotes>\n<ol>\n")
 					@footnote_ix = 0
 				end
-
+				
 				@footnote_ix += 1
 				label = node.string_content
 				@footnotes[@footnote_ix] = label
@@ -278,22 +291,22 @@ module Markly
 				# </ol>
 				# </section>
 			end
-
+			
 			private
-
+			
 			def out_footnote_backref
 				return false if @written_footnote_ix == @footnote_ix
-
+				
 				@written_footnote_ix = @footnote_ix
-
+				
 				out("<a href=\"#fnref-#{@footnotes[@footnote_ix]}\" class=\"footnote-backref\" data-footnote-backref data-footnote-backref-idx=\"#{@footnote_ix}\" aria-label=\"Back to reference #{@footnote_ix}\">↩</a>")
 				true
 			end
-
+			
 			def tasklist?(node)
-				node.type_string == 'tasklist'
+				node.type_string == "tasklist"
 			end
-
+			
 			def checked?(node)
 				node.tasklist_item_checked?
 			end

data/lib/markly/version.rb

@@ -4,8 +4,8 @@
 # Copyright, 2015-2020, by Garen Torikian.
 # Copyright, 2016-2017, by Yuki Izumi.
 # Copyright, 2017-2018, by Ashe Connor.
-# Copyright, 2020-2023, by Samuel Williams.
+# Copyright, 2020-2025, by Samuel Williams.
 
 module Markly
-	VERSION = '0.13.1'
+	VERSION = "0.14.1"
 end

data/lib/markly.rb

@@ -6,15 +6,15 @@
 # Copyright, 2015-2019, by Garen Torikian.
 # Copyright, 2015, by Nick Wellnhofer.
 # Copyright, 2016-2017, by Yuki Izumi.
-# Copyright, 2020-2023, by Samuel Williams.
+# Copyright, 2020-2025, by Samuel Williams.
 
-require 'markly/markly'
+require "markly/markly"
 
-require_relative 'markly/flags'
-require_relative 'markly/node'
-require_relative 'markly/renderer/html'
+require_relative "markly/flags"
+require_relative "markly/node"
+require_relative "markly/renderer/html"
 
-require_relative 'markly/version'
+require_relative "markly/version"
 
 module Markly
 	# Public: Parses a Markdown string into a `document` node.

data/license.md

@@ -18,7 +18,7 @@ Copyright, 2018, by Danny Iachini.
 Copyright, 2019-2020, by Tomoya Chiba.  
 Copyright, 2019, by Brett Walker.  
 Copyright, 2020, by Olle Jonsson.  
-Copyright, 2020-2024, by Samuel Williams.  
+Copyright, 2020-2025, by Samuel Williams.  
 Copyright, 2024, by Ross Kaffenberger.  
 
 Permission is hereby granted, free of charge, to any person obtaining a copy

data/readme.md

@@ -18,11 +18,17 @@ functionality, and so this fork was created to continue to provide these (and mo
 
 Please see the [project documentation](https://ioquatix.github.io/markly/) for more details.
 
-  - [Getting Started](https://ioquatix.github.io/markly/guides/getting-started/index) - This guide explains now to
-    install and use Markly.
+  - [Getting Started](https://ioquatix.github.io/markly/guides/getting-started/index) - This guide explains now to install and use Markly.
 
-  - [Abstract Syntax Tree](https://ioquatix.github.io/markly/guides/abstract-syntax-tree/index) - This guide explains
-    how to use Markly's abstract syntax tree (AST) to parse and manipulate Markdown documents.
+  - [Abstract Syntax Tree](https://ioquatix.github.io/markly/guides/abstract-syntax-tree/index) - This guide explains how to use Markly's abstract syntax tree (AST) to parse and manipulate Markdown documents.
+
+## Releases
+
+Please see the [project releases](https://ioquatix.github.io/markly/releases/index) for all releases.
+
+### v0.14.0
+
+  - Expose `Markly::Renderer::HTML.anchor_for` method to generate URL-safe anchors from headers.
 
 ## Contributing
 

data/releases.md

@@ -0,0 +1,5 @@
+# Releases
+
+## v0.14.0
+
+  - Expose `Markly::Renderer::HTML.anchor_for` method to generate URL-safe anchors from headers.

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: markly
 version: !ruby/object:Gem::Version
-  version: 0.13.1
+  version: 0.14.1
 platform: ruby
 authors:
 - Garen Torikian
@@ -142,6 +142,7 @@ files:
 - lib/markly/version.rb
 - license.md
 - readme.md
+- releases.md
 homepage: https://github.com/ioquatix/markly
 licenses:
 - MIT
@@ -156,14 +157,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '3.1'
+      version: '3.2'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.6.7
+rubygems_version: 3.6.9
 specification_version: 4
 summary: CommonMark parser and renderer. Written in C, wrapped in Ruby.
 test_files: []