rdoc-markdown 0.18.0 → 0.19.0

data/lib/rdoc/markdown/version.rb

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

metadata

@@ -1,11 +1,11 @@
 --- !ruby/object:Gem::Specification
 name: rdoc-markdown
 version: !ruby/object:Gem::Version
-  version: 0.18.0
+  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
-```

data/CODE_OF_CONDUCT.md

@@ -1,84 +0,0 @@
-# Contributor Covenant Code of Conduct
-
-## Our Pledge
-
-We as members, contributors, and leaders pledge to make participation in our community a harassment-free experience for everyone, regardless of age, body size, visible or invisible disability, ethnicity, sex characteristics, gender identity and expression, level of experience, education, socio-economic status, nationality, personal appearance, race, religion, or sexual identity and orientation.
-
-We pledge to act and interact in ways that contribute to an open, welcoming, diverse, inclusive, and healthy community.
-
-## Our Standards
-
-Examples of behavior that contributes to a positive environment for our community include:
-
-* Demonstrating empathy and kindness toward other people
-* Being respectful of differing opinions, viewpoints, and experiences
-* Giving and gracefully accepting constructive feedback
-* Accepting responsibility and apologizing to those affected by our mistakes, and learning from the experience
-* Focusing on what is best not just for us as individuals, but for the overall community
-
-Examples of unacceptable behavior include:
-
-* The use of sexualized language or imagery, and sexual attention or
-  advances of any kind
-* Trolling, insulting or derogatory comments, and personal or political attacks
-* Public or private harassment
-* Publishing others' private information, such as a physical or email
-  address, without their explicit permission
-* Other conduct which could reasonably be considered inappropriate in a
-  professional setting
-
-## Enforcement Responsibilities
-
-Community leaders are responsible for clarifying and enforcing our standards of acceptable behavior and will take appropriate and fair corrective action in response to any behavior that they deem inappropriate, threatening, offensive, or harmful.
-
-Community leaders have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, and will communicate reasons for moderation decisions when appropriate.
-
-## Scope
-
-This Code of Conduct applies within all community spaces, and also applies when an individual is officially representing the community in public spaces. Examples of representing our community include using an official e-mail address, posting via an official social media account, or acting as an appointed representative at an online or offline event.
-
-## Enforcement
-
-Instances of abusive, harassing, or otherwise unacceptable behavior may be reported to the community leaders responsible for enforcement at skatkov@newstore.com. All complaints will be reviewed and investigated promptly and fairly.
-
-All community leaders are obligated to respect the privacy and security of the reporter of any incident.
-
-## Enforcement Guidelines
-
-Community leaders will follow these Community Impact Guidelines in determining the consequences for any action they deem in violation of this Code of Conduct:
-
-### 1. Correction
-
-**Community Impact**: Use of inappropriate language or other behavior deemed unprofessional or unwelcome in the community.
-
-**Consequence**: A private, written warning from community leaders, providing clarity around the nature of the violation and an explanation of why the behavior was inappropriate. A public apology may be requested.
-
-### 2. Warning
-
-**Community Impact**: A violation through a single incident or series of actions.
-
-**Consequence**: A warning with consequences for continued behavior. No interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, for a specified period of time. This includes avoiding interactions in community spaces as well as external channels like social media. Violating these terms may lead to a temporary or permanent ban.
-
-### 3. Temporary Ban
-
-**Community Impact**: A serious violation of community standards, including sustained inappropriate behavior.
-
-**Consequence**: A temporary ban from any sort of interaction or public communication with the community for a specified period of time. No public or private interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, is allowed during this period. Violating these terms may lead to a permanent ban.
-
-### 4. Permanent Ban
-
-**Community Impact**: Demonstrating a pattern of violation of community standards, including sustained inappropriate behavior,  harassment of an individual, or aggression toward or disparagement of classes of individuals.
-
-**Consequence**: A permanent ban from any sort of public interaction within the community.
-
-## Attribution
-
-This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 2.0,
-available at https://www.contributor-covenant.org/version/2/0/code_of_conduct.html.
-
-Community Impact Guidelines were inspired by [Mozilla's code of conduct enforcement ladder](https://github.com/mozilla/diversity).
-
-[homepage]: https://www.contributor-covenant.org
-
-For answers to common questions about this code of conduct, see the FAQ at
-https://www.contributor-covenant.org/faq. Translations are available at https://www.contributor-covenant.org/translations.

data/Gemfile

@@ -1,13 +0,0 @@
-# frozen_string_literal: true
-
-source "https://rubygems.org"
-
-# Specify your gem's dependencies in rdoc-markdown.gemspec
-gemspec
-
-gem "erb_lint", require: false
-gem "standard"
-gem "yard-lint"
-
-gem "mutant"
-gem "mutant-minitest"