rdoc-markdown 0.11.1 → 0.12.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a9e7c9de1a47770ad5a481a5908b247c1baf4bc5d65db6afa1bc130f61308768
-  data.tar.gz: 2263b102aaf74238b723e292348c98da4f99b75e6bfd62399f73f6d336667ea7
+  metadata.gz: 575534e13c6e1b37284625867c6d57661f8af184308ce3a926b482025d964248
+  data.tar.gz: 68165f940dd78b6da93cea34cf0ed52b85c25d9616226326959e1dd66dcbbe8e
 SHA512:
-  metadata.gz: 970c61173dbdc3fa191becf7f5f6ba6dd0116e2ff03a69617488ec30d356b663cb071deb4786c2fed900abc064b53f76d26994c2fcfb39c742ce614d55fbb781
-  data.tar.gz: 40bb22da2e8a70a115c30f5d530860c41780129ec472c9e591704fc54ca09ccf84b677bac0d16c8d82f1b5ab95ddef9c3e0d4eb34a7d59945bbc41dddc573c5c
+  metadata.gz: 1e9cd00c3f59f79153e01fb666801615d9a30c486c3c3bdf10c0e73e7118b2badda559e661f2f73cb9741fc6b2e6a8d44946a4ff3210f4ee1e74acf44a82c5b6
+  data.tar.gz: faef36b7139ea5ffd5f2b959aaf522e47cc254f54bf3a1622ccb56c64936bb4e22b5c17cb8f2d323ad6b5691b32c63d8586cf71c756cabb4136568d5a78663b2

data/Gemfile.lock

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

data/lib/rdoc/generator/markdown.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+# shareable_constant_value: literal
 
 gem "rdoc"
 
@@ -14,12 +15,37 @@ class RDoc::Generator::Markdown
 
   require_relative "markdown/rbs_signature_index"
 
+  # Supported reverse_markdown unknown-tag modes.
+  MARKDOWN_UNKNOWN_TAGS = %i[pass_through drop bypass raise]
+
+  # Root source page basenames and their search-index types.
+  ROOT_PAGES = {
+    "readme" => "Readme",
+    "guide" => "Readme",
+    "changelog" => "Changelog",
+    "history" => "Changelog"
+  }
+
+  # Source page extensions RDoc should auto-include from the root directory.
+  ROOT_PAGE_EXTENSIONS = %w[.rdoc .md .markdown]
+
+  # Returns the configured search-index type for an eligible root text page path.
+  #
+  # @param source_path [String] Normalized source path relative to the root.
+  #
+  # @return [String, nil]
+  def self.root_page_type_for(source_path)
+    return unless File.dirname(source_path) == "."
+    return unless ROOT_PAGE_EXTENSIONS.include?(File.extname(source_path))
+
+    ROOT_PAGES[File.basename(source_path, ".*").downcase]
+  end
+
+  # shareable_constant_value: none
+
   # Directory containing ERB templates.
   TEMPLATE_DIR = File.expand_path(File.join(File.dirname(__FILE__), "..", "..", "templates"))
 
-  # Supported reverse_markdown unknown-tag modes.
-  MARKDOWN_UNKNOWN_TAGS = %i[pass_through drop bypass raise].freeze
-
   # Adds rdoc-markdown generator configuration to RDoc's option object.
   module OptionsExtension
     # Initializes markdown generator options alongside RDoc's built-in options.
@@ -49,6 +75,30 @@ class RDoc::Generator::Markdown
       super
       @markdown_unknown_tags = map.fetch("markdown_unknown_tags") if map.key?("markdown_unknown_tags")
     end
+
+    # Adds markdown root entry pages to explicit source files.
+    #
+    # @return [void]
+    def check_files
+      return super unless @generator == RDoc::Generator::Markdown
+      super
+      return if @files.empty?
+
+      root = Pathname(@root)
+      expanded_root = root.expand_path
+      expanded_files = @files.map { |file| Pathname(file).expand_path.to_s }
+      @files.concat(
+        Dir.children(expanded_root).filter_map do |name|
+          path = expanded_root.join(name)
+          next unless path.file?
+          next unless File.readable?(path)
+          next unless RDoc::Generator::Markdown.root_page_type_for(name)
+          next if expanded_files.include?(path.to_s)
+
+          root.join(name).to_s
+        end
+      )
+    end
   end
 
   # Registers markdown generator-specific RDoc options.
@@ -117,6 +167,7 @@ class RDoc::Generator::Markdown
     @markdown_unknown_tags = self.class.validate_markdown_unknown_tags(rdoc_options.markdown_unknown_tags)
 
     @base_dir = Pathname.pwd
+    @expanded_root = Pathname(@options.root.to_s).expand_path
   end
 
   # Writes class files, page files, and the search index.
@@ -210,7 +261,7 @@ class RDoc::Generator::Markdown
       @pages.each do |page|
         csv << [
           page.page_name,
-          "Page",
+          page_type(page),
           page_output_path(page)
         ]
       end
@@ -276,6 +327,26 @@ class RDoc::Generator::Markdown
     "#{dirname}/#{basename}"
   end
 
+  # Checks whether a text page is the configured main page.
+  #
+  # @param page [RDoc::TopLevel] Page object to index.
+  #
+  # @return [Boolean]
+  def main_page?(page)
+    normalize_input_path_for_output(page.full_name) == normalize_input_path_for_output(@options.main_page.to_s)
+  end
+
+  # Returns the search-index type for a text page.
+  #
+  # @param page [RDoc::TopLevel] Page object to index.
+  #
+  # @return [String]
+  def page_type(page)
+    return "Readme" if main_page?(page)
+
+    self.class.root_page_type_for(normalize_input_path_for_output(page.relative_name)) || "Page"
+  end
+
   # Returns the normalized display name for a class or module.
   #
   # @param code_object [RDoc::Context] Class or module object.
@@ -669,7 +740,7 @@ class RDoc::Generator::Markdown
   def normalize_input_path_for_output(path)
     normalized = path.tr("\\", "/").sub(%r{\A\./}, "")
 
-    root = File.expand_path(@options.root.to_s)
+    root = @expanded_root.to_s
     normalized = normalized.sub(%r{\A#{Regexp.escape(root)}/}, "")
     normalized = normalized.sub(%r{\A/}, "")
 

data/lib/rdoc/markdown/version.rb

@@ -5,6 +5,6 @@ module Rdoc
   # @private
   module Markdown
     # @private
-    VERSION = "0.11.1"
+    VERSION = "0.12.0"
   end
 end

metadata

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