rdoc-markdown 0.12.1 → 0.13.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c69484c517e3582906e6847cbb162a7847ad29446856197a5f65972071c21d24
-  data.tar.gz: f646046107985a70925df0794921c5451c514be069827762a296b9763a27bd81
+  metadata.gz: f6f72f8c6fb2ba87242d9cfbcba6c38ae5587ce16b2769c71be2777ad0bdf5db
+  data.tar.gz: cb6f5ec0b90f430abbc90ab2cd379907fd044f64be52fc0243987e7287b05858
 SHA512:
-  metadata.gz: 79dce45ea46f3c5baa04488ea729e280196cb1b73cf48d1857c8227d67cf9d8ec2eb2d5d3dd69ced241d06c0b91ba91d817fcf4cbd0d7d6de22f05e709f3e0a0
-  data.tar.gz: 44cd9cf4996a79fee5c56b19fa3779aed7e19a165a0576f350399560259b89f82e615c0911f7a1ce00087b860f1494499c7c00230dc486da11724502bc9a58fb
+  metadata.gz: 3c18290f2f21c4a5bab355288688e7893c7f7922e944cc3ffbddfa71e063e76d5bbb8f0a05cb66052359e921eb0b81ac6aae89b21f47715e453f48f1bc05e84f
+  data.tar.gz: 57849ac7cfa778224373c3444f38e2d0f205f9442726636218a6894f7da51e842b056105e9c90dfdd3c7715ec0990029138a699d8d4b5fc62972a32ec18479ca

data/CHANGELOG.md

@@ -2,6 +2,26 @@
 
 ## Unreleased
 
+## 0.13.1
+
+- reduce metadata escape characters only to absolutely necessary (|, \)
+
+## 0.13.0
+
+- Adding metadata to classes/modules
+- Fixed: cross-linking between markdown files
+
+## 0.12.1
+
+- simplification: automatic root-page inclusion hook.
+- Explicit RDoc file lists are authoritative again; unlisted README, CHANGELOG, and similar files are not silently added.
+
+## 0.12.0
+
+- Indexing: Classifies root-level README and GUIDE pages as Readme.
+- Indexing: Classifies root-level CHANGELOG and HISTORY pages as Changelog.
+- Recognizes .rdoc, .md, and .markdown, case-insensitively by basename.
+
 ## 0.11.1
 
 - Changed headings from standalone anchors to adjacent inline anchors:

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    rdoc-markdown (0.12.1)
+    rdoc-markdown (0.13.1)
       csv
       erb
       rdoc

data/lib/rdoc/generator/markdown.rb

@@ -75,7 +75,6 @@ class RDoc::Generator::Markdown
       super
       @markdown_unknown_tags = map.fetch("markdown_unknown_tags") if map.key?("markdown_unknown_tags")
     end
-
   end
 
   # Registers markdown generator-specific RDoc options.
@@ -253,16 +252,17 @@ class RDoc::Generator::Markdown
     template = ERB.new(template_content, trim_mode: "-")
 
     @classes.each do |klass|
-      result = finalize_markdown(template.result(binding), current_output_path: output_path_for(klass))
-
-      out_file = Pathname.new("#{output_dir}/#{output_path_for(klass)}")
-      out_file.dirname.mkpath
-      File.write(out_file, result)
-
-      legacy_paths_for(klass).each do |legacy_path|
-        legacy_file = Pathname.new("#{output_dir}/#{legacy_path}")
-        legacy_file.dirname.mkpath
-        File.write(legacy_file, result)
+      content = template.result(binding)
+      output_path = output_path_for(klass)
+
+      ([output_path] | legacy_paths_for(klass)).each do |destination_path|
+        out_file = Pathname.new("#{output_dir}/#{destination_path}")
+        out_file.dirname.mkpath
+        File.write(out_file, finalize_markdown(
+          content,
+          canonical_output_path: output_path,
+          current_output_path: destination_path
+        ))
       end
     end
   end
@@ -276,7 +276,11 @@ class RDoc::Generator::Markdown
       out_file.dirname.mkpath
 
       content = markdownify(page.description)
-      File.write(out_file, finalize_markdown(content, current_output_path: page_output_path(page)))
+      File.write(out_file, finalize_markdown(
+        content,
+        canonical_output_path: page_output_path(page),
+        current_output_path: page_output_path(page)
+      ))
     end
   end
 
@@ -351,6 +355,30 @@ class RDoc::Generator::Markdown
     class_doc_for(code_object).fetch(:legacy_paths)
   end
 
+  # Renders a class or module reference, linking it when its documentation is emitted.
+  #
+  # @param target [RDoc::ClassModule, String] Resolved RDoc object or unresolved name.
+  # @param label [String] Visible reference text.
+  #
+  # @return [String] Markdown text or link.
+  def metadata_reference(target, label)
+    class_doc = @class_docs_by_name[normalized_full_name(target.full_name)] if target.respond_to?(:full_name)
+    cell = metadata_table_cell(label)
+    return cell unless class_doc
+
+    "[#{cell}](#{class_doc.fetch(:output_path)})"
+  end
+
+  # Escapes text for a Markdown table cell.
+  #
+  # @param value [String] Metadata text.
+  #
+  # @return [String] GFM table-safe Markdown text.
+  def metadata_table_cell(value)
+    value.gsub(/[[:blank:]]*\R[[:blank:]]*/, " ")
+      .gsub(/[\\|]/) { |character| "\\#{character}" }
+  end
+
   # Converts RDoc HTML into GitHub-flavored Markdown.
   #
   # @param input [String] RDoc HTML fragment.
@@ -589,12 +617,17 @@ class RDoc::Generator::Markdown
   # Applies final whitespace and link normalization before writing Markdown.
   #
   # @param content [String] Markdown content.
+  # @param canonical_output_path [String] Canonical output path used to resolve links.
   # @param current_output_path [String] Output path for the file being written.
   #
   # @return [String] Final Markdown ending with one newline.
-  def finalize_markdown(content, current_output_path:)
+  def finalize_markdown(content, canonical_output_path:, current_output_path:)
     output = content.lines.map(&:rstrip).join("\n")
-    output = normalize_internal_links(output, current_output_path: current_output_path)
+    output = normalize_internal_links(
+      output,
+      canonical_output_path: canonical_output_path,
+      current_output_path: current_output_path
+    )
     output = output.sub(/\n{3,}/, "\n\n")
     "#{output}\n"
   end
@@ -671,10 +704,12 @@ class RDoc::Generator::Markdown
   # Rewrites local Markdown links relative to the current output file.
   #
   # @param markdown [String] Markdown content.
+  # @param canonical_output_path [String] Canonical output path used to resolve links.
   # @param current_output_path [String] Output path for the file being written.
   #
   # @return [String] Markdown with normalized internal links.
-  def normalize_internal_links(markdown, current_output_path:)
+  def normalize_internal_links(markdown, canonical_output_path:, current_output_path:)
+    canonical_dir = Pathname.new(canonical_output_path).dirname
     current_dir = Pathname.new(current_output_path).dirname
 
     markdown.gsub(%r{\]\(([^)]+)\)}) do
@@ -682,7 +717,7 @@ class RDoc::Generator::Markdown
       path = target.sub(/[?#].*\z/, "")
       suffix = target[path.length..]
 
-      resolved = resolve_output_path(path, current_dir)
+      resolved = resolve_output_path(path, canonical_dir)
       rewritten = resolved ? Pathname.new(resolved).relative_path_from(current_dir) : path
       "](#{rewritten}#{suffix})"
     end
@@ -854,6 +889,7 @@ class RDoc::Generator::Markdown
 
     @class_docs = build_class_docs(@store.all_classes_and_modules.sort)
     @class_docs_by_object_id = @class_docs.to_h { |doc| [doc.fetch(:klass).object_id, doc] }
+    @class_docs_by_name = @class_docs.to_h { |doc| [doc.fetch(:display_name), doc] }
     @classes = @class_docs.map { |doc| doc.fetch(:klass) }
     @pages = @store.all_files.select(&:text?).select(&:display?).sort_by(&:base_name)
     @rbs_method_signatures = RbsSignatureIndex.build(Array(@options.files), @base_dir, @store)

data/lib/rdoc/markdown/version.rb

@@ -5,6 +5,6 @@ module Rdoc
   # @private
   module Markdown
     # @private
-    VERSION = "0.12.1"
+    VERSION = "0.13.1"
   end
 end

data/lib/templates/classfile.md.erb

@@ -1,4 +1,22 @@
 # <%= klass.type.capitalize %> <%= display_name(klass) %><%= anchor(klass.aref.strip) %>
+<%- superclass = klass.superclass if klass.type == "class" -%>
+<%- includes = klass.includes -%>
+<%- source_files = klass.in_files -%>
+<%- if superclass || !includes.empty? || !source_files.empty? -%>
+
+|  |  |
+| --- | --- |
+<%- if superclass -%>
+| **Inherits** | <%= metadata_reference(superclass, superclass.respond_to?(:full_name) ? superclass.full_name : superclass) %> |
+<%- end -%>
+<%- unless includes.empty? -%>
+| **Includes** | <%= includes.map { |mixin| metadata_reference(mixin.module, mixin.name) }.join(", ") %> |
+<%- end -%>
+<%- unless source_files.empty? -%>
+| **Defined in** | <%= source_files.map { |file| metadata_table_cell(file.relative_name) }.join(", ") %> |
+<%- end -%>
+<%- end -%>
+
 <%- class_description = describe(klass) -%>
 <%- unless class_description.empty? -%>
 <%= class_description %>

metadata

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