rdoc-markdown 0.17.2 → 0.19.0

data/lib/rdoc/markdown/version.rb

@@ -5,6 +5,6 @@ module Rdoc
   # @private
   module Markdown
     # @private
-    VERSION = "0.17.2"
+    VERSION = "0.19.0"
   end
 end

data/lib/templates/classfile.md.erb

@@ -25,30 +25,33 @@
 <%- end -%>
 <% klass.each_section do |section, constants, attributes| -%>
 <%- section_title = section.title.to_s.strip -%>
+<%- section_heading_level = section_title.empty? ? 1 : 2 -%>
+<%- group_heading_level = section_heading_level + 1 -%>
+<%- member_heading_level = group_heading_level + 1 -%>
 <%- unless section_title.empty? -%>
-## <%= section_title %>
+<%= "#" * section_heading_level %> <%= section_title %>
 <%- end -%>
-<%- section_description = section_description(section, heading_level_offset: 2) -%>
+<%- section_description = section_description(section, heading_level_offset: section_heading_level) -%>
 <%- unless section_description.empty? -%>
 
 <%= section_description %>
 <%- end -%>
 <%- unless constants.empty? -%>
 
-### Constants
+<%= "#" * group_heading_level %> Constants
 <% constants.sort_by(&:name).each do |const| -%>
 
-#### `<%= const.name %>`<%= anchor(const.name) %>
-<%= describe(const, fallback: "Not documented.", heading_level_offset: 4) %>
+<%= "#" * member_heading_level %> `<%= const.name %>`<%= anchor(const.name) %>
+<%= describe(const, fallback: "Not documented.", heading_level_offset: member_heading_level) %>
 <% end -%>
 <%- end -%>
 <%- unless attributes.empty? -%>
 
-### Attributes
+<%= "#" * group_heading_level %> Attributes
 <% attributes.sort_by(&:name).each do |attr| -%>
 
-#### `<%= attr.name %>` [<%= attr.rw %>]<%= anchor(attr.aref.strip) %>
-<%= describe(attr, fallback: "Not documented.", heading_level_offset: 4) %>
+<%= "#" * member_heading_level %> `<%= attr.name %>` [<%= attr.rw %>]<%= anchor(attr.aref.strip) %>
+<%= describe(attr, fallback: "Not documented.", heading_level_offset: member_heading_level) %>
 <% end -%>
 <%- end -%>
 <% klass.methods_by_type(section).each do |type, visibilities| -%>
@@ -56,10 +59,10 @@
 <% methods = methods.select(&:display?) -%>
 <% next if methods.empty? -%>
 
-### <%= visibility.capitalize %> <%= type.capitalize %> Methods
+<%= "#" * group_heading_level %> <%= visibility.capitalize %> <%= type.capitalize %> Methods
 <% methods.each do |method| -%>
-#### `<%= method.name %><%= method_signature(method) %>`<%= anchor(method.aref) %>
-<%= method_description(method, current_class: klass) %>
+<%= "#" * member_heading_level %> `<%= method.name %><%= method_signature(method) %>`<%= anchor(method.aref) %>
+<%= method_description(method, current_class: klass, heading_level_offset: member_heading_level) %>
 <% end -%>
 <% end -%>
 <% end -%>

metadata

@@ -1,11 +1,11 @@
 --- !ruby/object:Gem::Specification
 name: rdoc-markdown
 version: !ruby/object:Gem::Version
-  version: 0.17.2
+  version: 0.19.0
 platform: ruby
 authors:
 - Stanislav (Stas) Katkov
-bindir: exe
+bindir: bin
 cert_chain: []
 date: 1980-01-02 00:00:00.000000000 Z
 dependencies:
@@ -136,33 +136,33 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '13.0'
 - !ruby/object:Gem::Dependency
-  name: rdiscount
+  name: simplecov
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '2.0'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '2.0'
+        version: '0'
 - !ruby/object:Gem::Dependency
-  name: simplecov
+  name: ruby-lsp
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '0.22'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '0.22'
+        version: '0'
 description: RDoc plugin to generate markdown documentation and search index as sqlite
   database for entire content.
 email:
@@ -171,45 +171,21 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- ".editorconfig"
-- ".erb_lint.yml"
-- ".erb_linters/no_embedded_assets.rb"
-- ".erb_linters/non_raw_html.rb"
-- ".standard.yml"
-- ".yard-lint.yml"
-- AGENTS.md
 - CHANGELOG.md
-- CODE_OF_CONDUCT.md
-- Gemfile
-- Gemfile.lock
 - LICENSE
 - README.md
-- Rakefile
-- example/Bird.md
-- example/Duck.md
-- example/Object.md
-- example/Waterfowl.md
-- example/index.csv
-- example/jekyll-seo-tag/Jekyll.md
-- example/jekyll-seo-tag/Jekyll/SeoTag.md
-- example/jekyll-seo-tag/Jekyll/SeoTag/AuthorDrop.md
-- example/jekyll-seo-tag/Jekyll/SeoTag/Drop.md
-- example/jekyll-seo-tag/Jekyll/SeoTag/Filters.md
-- example/jekyll-seo-tag/Jekyll/SeoTag/ImageDrop.md
-- example/jekyll-seo-tag/Jekyll/SeoTag/JSONLD.md
-- example/jekyll-seo-tag/Jekyll/SeoTag/JSONLDDrop.md
-- example/jekyll-seo-tag/Jekyll/SeoTag/UrlHelper.md
-- example/jekyll-seo-tag/Liquid.md
-- example/jekyll-seo-tag/Liquid/Tag.md
-- example/jekyll-seo-tag/index.csv
 - lib/markdown.rb
 - lib/rdoc/discover.rb
 - lib/rdoc/generator/markdown.rb
+- lib/rdoc/generator/markdown/conversion.rb
 - lib/rdoc/generator/markdown/crossref.rb
+- lib/rdoc/generator/markdown/descriptions.rb
+- lib/rdoc/generator/markdown/index.rb
+- lib/rdoc/generator/markdown/paths.rb
+- lib/rdoc/generator/markdown/selection.rb
+- lib/rdoc/generator/markdown/signatures.rb
 - lib/rdoc/markdown/version.rb
 - lib/templates/classfile.md.erb
-- mutant.yml
-- rdoc-markdown.gemspec
 - sig/rdoc/markdown.rbs
 homepage: https://poshtui.com
 licenses:
@@ -232,7 +208,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 4.0.10
+rubygems_version: 4.0.16
 specification_version: 4
 summary: RDoc plugin to generate markdown documentation
 test_files: []

data/.editorconfig

@@ -1,13 +0,0 @@
-# top-most EditorConfig file
-root = true
-
-# Unix-style newlines with a newline ending every file
-# Two spaces for indenting
-[*]
-end_of_line = lf
-insert_final_newline = true
-indent_style = space
-indent_size = 2
-charset = utf-8
-trim_trailing_whitespace = true
-max_line_length = 120

data/.erb_lint.yml

@@ -1,36 +0,0 @@
----
-glob: "**/*.{md,markdown}.erb"
-EnableDefaultLinters: false
-linters:
-  ClosingErbTagIndent:
-    enabled: true
-  CommentSyntax:
-    enabled: true
-  ExtraNewline:
-    enabled: true
-  FinalNewline:
-    enabled: true
-  NoEmbeddedAssets:
-    enabled: true
-  NonRawHtml:
-    enabled: true
-  NoUnusedDisable:
-    enabled: true
-  ParserErrors:
-    enabled: true
-  RightTrim:
-    enabled: true
-    enforced_style: "-"
-  Rubocop:
-    enabled: true
-    only:
-      - Lint/Debugger
-      - Lint/DuplicateBranch
-      - Lint/DuplicateHashKey
-      - Lint/EmptyExpression
-      - Lint/SelfAssignment
-      - Security/Eval
-  SpaceAroundErbTag:
-    enabled: true
-  TrailingWhitespace:
-    enabled: true

data/.erb_linters/no_embedded_assets.rb

@@ -1,29 +0,0 @@
-# frozen_string_literal: true
-
-module ERBLint
-  module Linters
-    class NoEmbeddedAssets < Linter
-      include LinterRegistry
-
-      PATTERNS = [
-        [/(?:javascript_tag|javascript_include_tag|javascript_pack_tag|stylesheet_link_tag|stylesheet_pack_tag)\b/i,
-          "Avoid Rails JavaScript and stylesheet helpers in markdown ERB templates."],
-        [/\bcontent_tag\s*\(?\s*[:"'](?:script|style)\b/i,
-          "Avoid helper-generated `<script>` and `<style>` tags in markdown ERB templates."],
-        [/\btag\.(?:link|script|style)\b/i,
-          "Avoid helper-generated asset tags in markdown ERB templates."]
-      ].freeze
-
-      def run(processed_source)
-        content = processed_source.file_content
-
-        PATTERNS.each do |pattern, message|
-          content.scan(pattern) do
-            match = Regexp.last_match
-            add_offense(processed_source.to_source_range(match.begin(0)...match.end(0)), message)
-          end
-        end
-      end
-    end
-  end
-end

data/.erb_linters/non_raw_html.rb

@@ -1,29 +0,0 @@
-# frozen_string_literal: true
-
-module ERBLint
-  module Linters
-    class NonRawHtml < Linter
-      include LinterRegistry
-
-      HTML_PATTERN = /<!--.*?-->|<!DOCTYPE\b[^>]*>|<\/?[A-Za-z][A-Za-z0-9-]*(?=[\s>\/])[^<>]*\/?>/im
-
-      def run(processed_source)
-        content = processed_source.file_content
-        reported_lines = {}
-
-        content.scan(HTML_PATTERN) do
-          match = Regexp.last_match
-          source_range = processed_source.to_source_range(match.begin(0)...match.end(0))
-          line = source_range.line_range.first
-          next if reported_lines[line]
-
-          reported_lines[line] = true
-          add_offense(
-            source_range,
-            "Avoid raw HTML in markdown ERB templates. Generate markdown instead."
-          )
-        end
-      end
-    end
-  end
-end

data/.standard.yml

@@ -1,3 +0,0 @@
-ignore:
-  - "test/data/example.rb"
-

data/.yard-lint.yml

@@ -1,290 +0,0 @@
-# YARD-Lint Configuration (Strict Mode)
-# See https://github.com/mensfeld/yard-lint for documentation
-
-AllValidators:
-  YardOptions:
-    - --private
-    - --protected
-
-  Exclude:
-    - '\.git'
-    - ".erb_linters"
-    - ".erb_linters/**/*"
-    - "coverage"
-    - "coverage/**/*"
-    - "tmp"
-    - "vendor/**/*"
-    - "vendor"
-    - "node_modules/**/*"
-    - "spec/**/*"
-    - "test/**/*"
-    - "tmp/**/*"
-    - "lib/rdoc/markdown/version.rb"
-
-  FailOnSeverity: error
-  MinCoverage: 100.0
-
-  DiffMode:
-    DefaultBaseRef: ~
-
-Documentation/UndocumentedObjects:
-  Description: "Checks for classes, modules, and methods without documentation."
-  Enabled: true
-  Severity: error
-  ExcludedMethods:
-    - "initialize/0"
-    - "/^_/"
-
-Documentation/UndocumentedMethodArguments:
-  Description: "Checks for method parameters without @param tags."
-  Enabled: true
-  Severity: error
-
-Documentation/UndocumentedBooleanMethods:
-  Description: "Checks that question mark methods document their boolean return."
-  Enabled: true
-  Severity: error
-
-Documentation/UndocumentedOptions:
-  Description: "Detects methods with options hash parameters but no @option tags."
-  Enabled: true
-  Severity: error
-
-Documentation/MissingReturn:
-  Description: "Requires @return tags on all methods."
-  Enabled: true
-  Severity: error
-  ExcludedMethods:
-    - "initialize"
-
-Documentation/MarkdownSyntax:
-  Description: "Detects common markdown syntax errors in documentation."
-  Enabled: true
-  Severity: error
-
-Documentation/EmptyCommentLine:
-  Description: "Detects empty comment lines at the start or end of documentation blocks."
-  Enabled: true
-  Severity: error
-  EnabledPatterns:
-    Leading: true
-    Trailing: true
-
-Documentation/BlankLineBeforeDefinition:
-  Description: "Detects blank lines between YARD documentation and method definition."
-  Enabled: true
-  Severity: error
-  OrphanedSeverity: error
-  EnabledPatterns:
-    SingleBlankLine: true
-    OrphanedDocs: true
-
-Tags/Order:
-  Description: "Enforces consistent ordering of YARD tags."
-  Enabled: true
-  Severity: error
-  EnforcedOrder:
-    - param
-    - option
-    - yield
-    - yieldparam
-    - yieldreturn
-    - return
-    - raise
-    - see
-    - example
-    - note
-    - todo
-
-Tags/InvalidTypes:
-  Description: "Validates type definitions in @param, @return, @option tags."
-  Enabled: true
-  Severity: error
-  ValidatedTags:
-    - param
-    - option
-    - return
-
-Tags/TypeSyntax:
-  Description: "Validates YARD type syntax using YARD parser."
-  Enabled: true
-  Severity: error
-  ValidatedTags:
-    - param
-    - option
-    - return
-    - yieldreturn
-
-Tags/MeaninglessTag:
-  Description: "Detects @param/@option tags on classes, modules, or constants."
-  Enabled: true
-  Severity: error
-  CheckedTags:
-    - param
-    - option
-  InvalidObjectTypes:
-    - class
-    - module
-    - constant
-
-Tags/CollectionType:
-  Description: "Validates Hash collection syntax consistency."
-  Enabled: true
-  Severity: error
-  EnforcedStyle: long
-  ValidatedTags:
-    - param
-    - option
-    - return
-    - yieldreturn
-
-Tags/TagTypePosition:
-  Description: "Validates type annotation position in tags."
-  Enabled: true
-  Severity: error
-  CheckedTags:
-    - param
-    - option
-  EnforcedStyle: type_after_name
-
-Tags/ApiTags:
-  Description: "Enforces @api tags on public objects."
-  Enabled: false
-  Severity: error
-  AllowedApis:
-    - public
-    - private
-    - internal
-
-Tags/OptionTags:
-  Description: "Requires @option tags for methods with options parameters."
-  Enabled: true
-  Severity: error
-
-Tags/ExampleSyntax:
-  Description: "Validates Ruby syntax in @example tags."
-  Enabled: true
-  Severity: error
-
-Tags/ExampleStyle:
-  Description: "Validates code style in @example tags using RuboCop/StandardRB."
-  Enabled: false
-  Severity: convention
-
-Tags/RedundantParamDescription:
-  Description: "Detects meaningless parameter descriptions that add no value."
-  Enabled: true
-  Severity: error
-  CheckedTags:
-    - param
-    - option
-  Articles:
-    - The
-    - the
-    - A
-    - a
-    - An
-    - an
-  MaxRedundantWords: 6
-  GenericTerms:
-    - object
-    - instance
-    - value
-    - data
-    - item
-    - element
-  EnabledPatterns:
-    ArticleParam: true
-    PossessiveParam: true
-    TypeRestatement: true
-    ParamToVerb: true
-    IdPattern: true
-    DirectionalDate: true
-    TypeGeneric: true
-
-Tags/InformalNotation:
-  Description: 'Detects informal tag notation patterns like "Note:" instead of @note.'
-  Enabled: true
-  Severity: error
-  CaseSensitive: false
-  RequireStartOfLine: true
-  Patterns:
-    Note: "@note"
-    Todo: "@todo"
-    TODO: "@todo"
-    FIXME: "@todo"
-    See: "@see"
-    See also: "@see"
-    Warning: "@deprecated"
-    Deprecated: "@deprecated"
-    Author: "@author"
-    Version: "@version"
-    Since: "@since"
-    Returns: "@return"
-    Raises: "@raise"
-    Example: "@example"
-
-Tags/NonAsciiType:
-  Description: "Detects non-ASCII characters in type annotations."
-  Enabled: true
-  Severity: error
-  ValidatedTags:
-    - param
-    - option
-    - return
-    - yieldreturn
-    - yieldparam
-
-Tags/TagGroupSeparator:
-  Description: "Enforces blank line separators between different YARD tag groups."
-  Enabled: false
-  Severity: error
-  TagGroups:
-    param: [param, option]
-    return: [return]
-    error: [raise, throws]
-    example: [example]
-    meta: [see, note, todo, deprecated, since, version, api]
-    yield: [yield, yieldparam, yieldreturn]
-  RequireAfterDescription: false
-
-Tags/ForbiddenTags:
-  Description: "Detects forbidden tag and type combinations."
-  Enabled: false
-  Severity: error
-  ForbiddenPatterns: []
-
-Warnings/UnknownTag:
-  Description: "Detects unknown YARD tags."
-  Enabled: true
-  Severity: error
-
-Warnings/UnknownDirective:
-  Description: "Detects unknown YARD directives."
-  Enabled: true
-  Severity: error
-
-Warnings/InvalidTagFormat:
-  Description: "Detects malformed tag syntax."
-  Enabled: true
-  Severity: error
-
-Warnings/InvalidDirectiveFormat:
-  Description: "Detects malformed directive syntax."
-  Enabled: true
-  Severity: error
-
-Warnings/DuplicatedParameterName:
-  Description: "Detects duplicate @param tags."
-  Enabled: true
-  Severity: error
-
-Warnings/UnknownParameterName:
-  Description: "Detects @param tags for non-existent parameters."
-  Enabled: true
-  Severity: error
-
-Semantic/AbstractMethods:
-  Description: "Ensures @abstract methods do not have real implementations."
-  Enabled: true
-  Severity: error

data/AGENTS.md

@@ -1,50 +0,0 @@
-You are working in a Ruby project that uses mutation testing.
-
-## Goal
-
-Achieve 100% mutation coverage. Verify with:
-
-```
-bundle exec mutant run
-```
-
-When iterating, prefer `--fail-fast` so you address one surviving
-mutant at a time:
-
-```
-bundle exec mutant run --fail-fast
-```
-
-## When you find an alive mutation
-
-Decide which bucket it falls into:
-
-- **A) The code does too much** for what the tests ask for. The
-  surviving mutation reveals behavior that no test requires. The
-  fix is to simplify the implementation.
-- **B) A test is missing.** The behavior is intentional but no test
-  observes it. The fix is to add a test.
-
-Decide between A) and B) before changing anything. If unsure, ask
-the user.
-
-## Constraints
-
-- You may not skip mutants by configuring mutant to ignore them.
-  No `expressions:` filters, no `coverage_criteria:` tweaks.
-- You may not use `send` or `__send__` to invoke private methods
-  in tests just to satisfy mutant.
-
-## Done
-
-You are done when all of these are green and not reporting any issues:
-
-```bash
-bundle exec rake test
-# don't run again if fail-fast has already passed
-bundle exec mutant run --fail-fast --since origin/main
-bundle exec standardrb --fix
-bundle exec rake markdown:validate
-bundle exec yard-lint
-bundle exec rake erb:lint
-```