rdoc-markdown 0.6.0 → 0.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 87cca03aa4d398385640d41bb6373d6607885593855cc7753253ce3453b92cbd
-  data.tar.gz: 230d405d4b7feca88a1b5fd3baab2ab707d3cd24628a8a9cd6706cbe8b7b45dd
+  metadata.gz: b8e35102f73fbebb99a831ca7e2210b41c065177ae7c637e86cffb61094560b7
+  data.tar.gz: 44d35c36100b1488c2d5c5c689239b0d4ce6ae5f151fcc0ba3dec64f17cb97ac
 SHA512:
-  metadata.gz: 3a5829cb97da49560f0aebd62f4e405a59ba7ad9a8ca4a9d1ac43aa4c6cc13189230630828b962d12124bc4a7544cb314f82cf9baeae73f25ba0700639802249
-  data.tar.gz: 8a47baf609af1888fd049294cfe4c3f97a0e65f1f80d19f013acf42a482db57c89f5a38b854eb6cf2e4b594fa9c9fc515e7e428144827856b236d9d25699da60
+  metadata.gz: c54de4099d5966da00719ef1fd7fafe9a9a15823d4e55e6b38489d32bacb366a9ee9b2ea1a8a85500bb8da29bd466bc00853cde0ad65c4f984e052652c35b52a
+  data.tar.gz: c08fbcf88edcd97e665def817f22d56113885a37b77ad471f26dfd72e6485912641018c3ab46261e0d019a58d24f007a2c8a480e166c8533432bf9a642500e8a

data/.erb_lint.yml

@@ -0,0 +1,40 @@
+---
+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
+    rubocop_config:
+      AllCops:
+        TargetRubyVersion: 3.2
+        NewCops: enable
+  SpaceAroundErbTag:
+    enabled: true
+  TrailingWhitespace:
+    enabled: true

data/.erb_linters/no_embedded_assets.rb

@@ -0,0 +1,29 @@
+# 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

@@ -0,0 +1,29 @@
+# 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

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

data/.yard-lint.yml

@@ -0,0 +1,283 @@
+# YARD-Lint Configuration (Strict Mode)
+# See https://github.com/mensfeld/yard-lint for documentation
+
+AllValidators:
+  YardOptions:
+    - --private
+    - --protected
+
+  Exclude:
+    - '\.git'
+    - "vendor/**/*"
+    - "node_modules/**/*"
+    - "spec/**/*"
+    - "test/**/*"
+    - "tmp/**/*"
+
+  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

@@ -0,0 +1,48 @@
+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:
+
+```
+bundle exec rake test
+bundle exec mutant run
+bundle exec rake markdown:validate
+bundle exec yard-lint
+bundle exec erb:lint
+```

data/CHANGELOG.md

@@ -0,0 +1,14 @@
+# Changelog
+
+## Unreleased
+
+## 0.7.0
+
+### Changed
+- Relax the development Bundler constraint to allow Bundler 4, and refresh the dependency lockfile with the newer toolchain.
+- Huge refactoring done to template, powered by mutant testing mostly.
+
+### Added
+- SimpleCov test coverage reporting.
+- Mutation testing coverage
+- StandardRB was added

data/Gemfile

@@ -7,4 +7,13 @@ gemspec
 
 gem "rake", "~> 13.0"
 
+gem "erb_lint", require: false
 gem "minitest", "~> 5.0"
+gem "standard"
+gem "yard-lint"
+
+if Gem::Version.new(RUBY_VERSION) >= Gem::Version.new("3.3")
+  gem "mutant"
+  gem "mutant-minitest"
+  gem "mutex_m"
+end