markly 0.6.1 → 0.8.0

data/lib/markly/node.rb

@@ -1,72 +1,139 @@
 # frozen_string_literal: true
 
+# Released under the MIT License.
+# Copyright, 2016-2019, by Garen Torikian.
+# Copyright, 2016-2017, by Yuki Izumi.
+# Copyright, 2017, by Goro Fuji.
+# Copyright, 2018, by Jerry van Leeuwen.
+# Copyright, 2020-2023, by Samuel Williams.
+
 require_relative 'node/inspect'
 
 module Markly
-  class Node
-    include Enumerable
-    include Inspect
-
-    # Public: An iterator that "walks the tree," descending into children recursively.
-    #
-    # blk - A {Proc} representing the action to take for each child
-    def walk(&block)
-      return enum_for(:walk) unless block_given?
+	class Node
+		include Enumerable
+		include Inspect
 
-      yield self
-      each do |child|
-        child.walk(&block)
-      end
-    end
+		# Public: An iterator that "walks the tree," descending into children recursively.
+		#
+		# blk - A {Proc} representing the action to take for each child
+		def walk(&block)
+			return enum_for(:walk) unless block_given?
 
-    # Public: Convert the node to an HTML string.
-    #
-    # options - A {Symbol} or {Array of Symbol}s indicating the render options
-    # extensions - An {Array of Symbol}s indicating the extensions to use
-    #
-    # Returns a {String}.
-    def to_html(flags: DEFAULT, extensions: [])
-      _render_html(flags, extensions).force_encoding('utf-8')
-    end
+			yield self
+			each do |child|
+				child.walk(&block)
+			end
+		end
 
-    # Public: Convert the node to a CommonMark string.
-    #
-    # options - A {Symbol} or {Array of Symbol}s indicating the render options
-    # width - Column to wrap the output at
-    #
-    # Returns a {String}.
-    def to_commonmark(flags: DEFAULT, width: 120)
-      _render_commonmark(flags, width).force_encoding('utf-8')
-    end
+		# Public: Convert the node to an HTML string.
+		#
+		# options - A {Symbol} or {Array of Symbol}s indicating the render options
+		# extensions - An {Array of Symbol}s indicating the extensions to use
+		#
+		# Returns a {String}.
+		def to_html(flags: DEFAULT, extensions: [])
+			_render_html(flags, extensions).force_encoding('utf-8')
+		end
 
-    alias to_markdown to_commonmark
+		# Public: Convert the node to a CommonMark string.
+		#
+		# options - A {Symbol} or {Array of Symbol}s indicating the render options
+		# width - Column to wrap the output at
+		#
+		# Returns a {String}.
+		def to_commonmark(flags: DEFAULT, width: 120)
+			_render_commonmark(flags, width).force_encoding('utf-8')
+		end
 
-    # Public: Convert the node to a plain text string.
-    #
-    # options - A {Symbol} or {Array of Symbol}s indicating the render options
-    # width - Column to wrap the output at
-    #
-    # Returns a {String}.
-    def to_plaintext(flags: DEFAULT, width: 120)
-      _render_plaintext(flags, width).force_encoding('utf-8')
-    end
+		alias to_markdown to_commonmark
 
-    # Public: Iterate over the children (if any) of the current pointer.
-    def each
-      return enum_for(:each) unless block_given?
+		# Public: Convert the node to a plain text string.
+		#
+		# options - A {Symbol} or {Array of Symbol}s indicating the render options
+		# width - Column to wrap the output at
+		#
+		# Returns a {String}.
+		def to_plaintext(flags: DEFAULT, width: 120)
+			_render_plaintext(flags, width).force_encoding('utf-8')
+		end
 
-      child = first_child
-      while child
-        nextchild = child.next
-        yield child
-        child = nextchild
-      end
-    end
+		# Public: Iterate over the children (if any) of the current pointer.
+		def each
+			return enum_for(:each) unless block_given?
 
-    # Deprecated: Please use `each` instead
-    def each_child(&block)
-      warn '[DEPRECATION] `each_child` is deprecated.  Please use `each` instead.'
-      each(&block)
-    end
-  end
+			child = first_child
+			while child
+				next_child = child.next
+				yield child
+				child = next_child
+			end
+		end
+		
+		def find_header(title)
+			each do |child|
+				if child.type == :header && child.first_child.string_content == title
+					return child
+				end
+			end
+		end
+		
+		# Delete all nodes until the block returns true.
+		#
+		# @returns [Markly::Node] the node that returned true.
+		def delete_until
+			current = self
+			while current
+				return current if yield(current)
+				next_node = current.next
+				current.delete
+				current = next_node
+			end
+		end
+		
+		# Replace a section (header + content) with a new node.
+		#
+		# @parameter title [String] the title of the section to replace.
+		# @parameter new_node [Markly::Node] the node to replace the section with.
+		# @parameter replace_header [Boolean] whether to replace the header itself or not.
+		# @parameter remove_subsections [Boolean] whether to remove subsections or not.
+		def replace_section(new_node, replace_header: true, remove_subsections: true)
+			# Delete until the next heading:
+			self.next&.delete_until do |node|
+				node.type == :heading && (!remove_subsections || node.header_level <= self.header_level)
+			end
+			
+			self.append_after(new_node) if new_node
+			self.delete if replace_header
+		end
+		
+		def next_heading
+			current = self.next
+			while current
+				if current.type == :heading
+					return current
+				end
+				current = current.next
+			end
+		end
+		
+		# Append the given node after the current node.
+		#
+		# It's okay to provide a document node, it's children will be appended.
+		#
+		# @parameter node [Markly::Node] the node to append.
+		def append_after(node)
+			if node.type == :document
+				node = node.first_child
+			end
+			
+			current = self
+			while node
+				next_node = node.next
+				current.insert_after(node)
+				current = node
+				node = next_node
+			end
+		end
+	end
 end

data/lib/markly/renderer/generic.rb

@@ -0,0 +1,136 @@
+# frozen_string_literal: true
+
+# Released under the MIT License.
+# Copyright, 2015-2019, by Garen Torikian.
+# Copyright, 2016-2017, by Yuki Izumi.
+# Copyright, 2020-2023, by Samuel Williams.
+
+require 'set'
+require 'stringio'
+
+module Markly
+	module Renderer
+		class Generic
+			def initialize(flags: DEFAULT, extensions: [])
+				@flags = flags
+				@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) }
+					elsif arg.is_a?(Array)
+						arg.each { |x| render(x) }
+					elsif arg.is_a?(Node)
+						render(arg)
+					else
+						@stream.write(arg)
+					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) }
+				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(
+						%r{
+							<
+							(
+							title|textarea|style|xmp|iframe|
+							noembed|noframes|script|plaintext
+							)
+							(?=\s|>|/>)
+						}xi,
+						'&lt;\1'
+					)
+				else
+					str
+				end
+			end
+
+			def source_position(node)
+				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
+		end
+	end
+end

data/lib/markly/renderer/html.rb

@@ -0,0 +1,301 @@
+# frozen_string_literal: true
+
+# Released under the MIT License.
+# Copyright, 2015-2020, by Garen Torikian.
+# Copyright, 2015, by Nick Wellnhofer.
+# Copyright, 2017, by Yuki Izumi.
+# Copyright, 2017-2019, by Ashe Connor.
+# Copyright, 2018, by Michael Camilleri.
+# Copyright, 2020-2023, by Samuel Williams.
+
+require_relative 'generic'
+require 'cgi'
+
+module Markly
+	module Renderer
+		class HTML < Generic
+			def initialize(ids: false, tight: false, **options)
+				super(**options)
+				
+				@ids = ids
+				@section = nil
+				@tight = tight
+				
+				@footnotes = {}
+			end
+			
+			def document(_)
+				@section = false
+				super
+				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}\""
+				end
+			end
+
+			def header(node)
+				block do
+					if @ids
+						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, '>')
+				end
+			end
+
+			def paragraph(node)
+				if @tight && node.parent.type != :blockquote
+					out(:children)
+				else
+					block do
+						container("<p#{source_position(node)}>", '</p>') do
+							out(:children)
+							if node.parent.type == :footnote_definition && node.next.nil?
+								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
+							out(:children)
+						end
+					else
+						start = if node.list_start == 1
+											"<ol#{source_position(node)}>\n"
+										else
+											"<ol start=\"#{node.list_start}\"#{source_position(node)}>\n"
+										end
+						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
+						out(:children)
+					end
+				end
+			end
+
+			def tasklist(node)
+				return '' unless tasklist?(node)
+
+				state = if checked?(node)
+									'checked="" disabled=""'
+								else
+									'disabled=""'
+				end
+				"><input type=\"checkbox\" #{state} /"
+			end
+
+			def blockquote(node)
+				block 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>')
+					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('>')
+						end
+					end
+					out(escape_html(node.string_content))
+					out('</code></pre>')
+				end
+			end
+
+			def html(node)
+				block do
+					if flag_enabled?(UNSAFE)
+						out(tagfilter(node.string_content))
+					else
+						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 -->')
+				end
+			end
+
+			def emph(node)
+				out('<em>', :children, '</em>')
+			end
+
+			def strong(node)
+				if node.parent.nil? || node.parent.type == node.type
+					out(:children)
+				else
+					out('<strong>', :children, '</strong>')
+				end
+			end
+
+			def link(node)
+				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>')
+			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(' />')
+			end
+
+			def text(node)
+				out(escape_html(node.string_content))
+			end
+
+			def code(node)
+				out('<code>')
+				out(escape_html(node.string_content))
+				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(' ')
+				else
+					out("\n")
+				end
+			end
+
+			def table(node)
+				@alignments = node.table_alignments
+				@needs_close_tbody = false
+				out("<table#{source_position(node)}>\n", :children)
+				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
+					@needs_close_tbody = true
+					out("<tbody>\n")
+				end
+				out("<tr#{source_position(node)}>\n", :children, "</tr>\n")
+			end
+
+			def table_cell(node)
+				align = case @alignments[@column_index]
+								when :left then ' align="left"'
+								when :right then ' align="right"'
+								when :center then ' align="center"'
+								else; ''
+								end
+				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>')
+			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
+				
+				out("<li id=\"fn-#{label}\">\n", :children)
+				out("\n") if out_footnote_backref
+				out("</li>\n")
+				# </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'
+			end
+
+			def checked?(node)
+				node.tasklist_item_checked?
+			end
+		end
+	end
+end

data/lib/markly/version.rb

@@ -1,5 +1,11 @@
 # frozen_string_literal: true
 
+# Released under the MIT License.
+# Copyright, 2015-2020, by Garen Torikian.
+# Copyright, 2016-2017, by Yuki Izumi.
+# Copyright, 2017-2018, by Ashe Connor.
+# Copyright, 2020-2023, by Samuel Williams.
+
 module Markly
-	VERSION = '0.6.1'
+	VERSION = '0.8.0'
 end