rdoc-markdown 0.19.1 → 0.20.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5d9e8dcc9378d9424beb37d2e482b881ca5b536af4150a6caed14e872a9b4a5d
-  data.tar.gz: 378ce21e41ab926bdf056d67445aa49ad412873c37ac89a4840907acac097522
+  metadata.gz: 5ae68a40db5d99f60034820bab835a6a6d17c9db00dd3d38d3d47bd7da73743b
+  data.tar.gz: 65a59f988b16411b5914dc5d7de8496efac2a12a67b835ac50b9fa478c1492fd
 SHA512:
-  metadata.gz: 23d9c7b35a7bbf4366c49f192adb0061ca190331d024bc37d9ed24554cce44a2892bc7b21b86fd0c7678597c9fa1105d2ba2705e63e811bd0cf75286cd839537
-  data.tar.gz: b484ca5aeda4fcc59f6d029190bc15c1915fbf71e91c9a4c1db5fe80467661ffe428291c6068788d3bfec6fe69800a89f6124886e49a910fdc44f97b4914e106
+  metadata.gz: c8c080f1704dff5d1a4ca256676fbf5f1a69d51a9ec0223e952cceb37837f840274a2bb39e44c70801379ef72d7a70d3811e96810de1d5a568341f6ec2a74875
+  data.tar.gz: 10a07e634578b0ac0290d91e4b1f52f6af36e0cb30349fa8d519970020b55246e719dec427f64c8ad59f6505def782e8709e98b6ff4be01f5494637af5cb265c

data/CHANGELOG.md

@@ -2,6 +2,15 @@
 
 ## Unreleased
 
+## 0.20.1
+
+- Don't offset headings for commets 
+
+## 0.20.0
+
+- Restore legacy anchors in a single Markdown substitution pass.
+- Reduce internal-link candidate construction and deduplication work.
+
 ## 0.19.1
 
 - Store fullpath for files, instead of just file names.

data/lib/rdoc/generator/markdown/conversion.rb

@@ -14,7 +14,7 @@ class RDoc::Generator::Markdown::Conversion
     document = fragment.document
     fragment.css("a").each { |link| normalize_link(link, document) }
     markdown = ReverseMarkdown.convert(fragment, github_flavored: true).dup
-    anchor_aliases.each { |token, id| markdown.gsub!(token, %(<a id="#{id}"></a>)) }
+    markdown.gsub!(Regexp.union(anchor_aliases.keys), anchor_aliases)
     normalize_definition_list_code_blocks(markdown).rstrip.gsub(/^(#+)(\s)/) do
       "#{"#" * [Regexp.last_match(1).length + heading_level_offset, 6].min}#{Regexp.last_match(2)}"
     end
@@ -101,13 +101,13 @@ class RDoc::Generator::Markdown::Conversion
     #
     # @param anchors [Nokogiri::XML::NodeSet] Legacy anchor spans.
     #
-    # @return [Array<Array<String>>] Token and anchor ID pairs.
+    # @return [Hash{String => String}] Token-to-anchor HTML lookup.
     def tokenize_legacy_anchors(anchors)
-      anchors.map.with_index do |span, index|
+      anchors.each.with_index.to_h do |span, index|
         token = "RDocMarkdownAnchor#{index}End"
-        id = span["id"]
+        anchor = %(<a id="#{span["id"]}"></a>)
         span.replace(token)
-        [token, id]
+        [token, anchor]
       end
     end
 

data/lib/rdoc/generator/markdown/descriptions.rb

@@ -96,6 +96,8 @@ module RDoc::Generator::Markdown::Descriptions
     description = render_description(code_object)
     return fallback.to_s if description.empty?
 
+    comment = code_object.comment
+    heading_level_offset = 0 if RDoc::Comment === comment && comment.format == "markdown"
     RDoc::Generator::Markdown::Conversion.markdownify(description, heading_level_offset: heading_level_offset)
   end
 

data/lib/rdoc/generator/markdown/paths.rb

@@ -83,11 +83,16 @@ module RDoc::Generator::Markdown::Paths
   #
   # @return [String, nil] Resolved output path, or nil when unresolved.
   def self.resolve_output_path_from(path, current_dir, state)
+    return if path.empty? || path.match?(%r{\A(?:[a-z][a-z0-9+.-]*:|//)}i)
+
     candidates = [path, path.delete_prefix("#{state.root_path_segment}/")]
     candidates += candidates.map { |candidate| candidate.sub(/_(md|markdown)\.md\z/i, '.\1') }
-    expanded_candidates = candidates.map { |candidate| current_dir.join(candidate).cleanpath.to_s }
+    candidates.uniq!
 
-    (candidates + expanded_candidates).find { |candidate| state.known_output_paths.include?(candidate) }
+    candidates.find { |candidate| state.known_output_paths.include?(candidate) } ||
+      candidates.lazy
+        .map { |candidate| current_dir.join(candidate).cleanpath.to_s }
+        .find { |candidate| state.known_output_paths.include?(candidate) }
   end
 
   # Normalizes an input filename into an output-relative source path.

data/lib/rdoc/generator/markdown.rb

@@ -1,6 +1,9 @@
 # frozen_string_literal: true
 
 require "erb"
+# standard:disable Lint/RedundantRequireStatement
+require "set"
+# standard:enable Lint/RedundantRequireStatement
 require "reverse_markdown"
 require "csv"
 require "fileutils"
@@ -173,8 +176,8 @@ class RDoc::Generator::Markdown
       classes: classes,
       pages: pages,
       class_output_paths: class_output_paths,
-      markdown_output_object_ids: (classes + pages).map(&:object_id),
-      known_output_paths: class_output_paths.values + pages.map { |page| page_output_path(page) },
+      markdown_output_object_ids: (classes + pages).to_set(&:object_id),
+      known_output_paths: class_output_paths.values.to_set.merge(pages.map { |page| page_output_path(page) }),
       root_path_segment: Pathname.new(options.root || ".").basename
     )
   end

data/lib/rdoc/markdown/version.rb

@@ -5,6 +5,6 @@ module Rdoc
   # @private
   module Markdown
     # @private
-    VERSION = "0.19.1"
+    VERSION = "0.20.1"
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rdoc-markdown
 version: !ruby/object:Gem::Version
-  version: 0.19.1
+  version: 0.20.1
 platform: ruby
 authors:
 - Stanislav (Stas) Katkov