markly 0.7.0 → 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

@@ -1,131 +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
+	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