yard-markdown 0.7.0 → 0.7.2

data/templates/default/fulldoc/markdown/setup.rb

@@ -1,9 +1,8 @@
 # frozen_string_literal: true
 
-require 'csv'
-
-include Helpers::ModuleHelper
+require "csv"
 
+include YARD::Templates::Helpers::ModuleHelper
 include YARD::Markdown::ArefHelper
 include YARD::Markdown::ObjectListingHelper
 
@@ -16,11 +15,11 @@ def init
   options.delete(:objects)
   options.delete(:files)
 
-  options.serializer.extension = 'md'
+  options.serializer.extension = "md"
 
   objects.each do |object|
     Templates::Engine.with_serializer(object, options.serializer) { serialize(object) }
-  rescue StandardError => e
+  rescue => e
     path = options.serializer.serialized_path(object)
     log.error "Exception occurred while generating '#{path}'"
     log.backtrace(e)
@@ -34,7 +33,7 @@ end
 # @param object [YARD::CodeObjects::NamespaceObject] Object whose page will be serialized.
 # @return [String] Rendered markdown for the object.
 def serialize(object)
-  T('module').run(options.merge(object: object))
+  T("module").run(options.merge(object: object))
 end
 
 # Writes the CSV search index for all rendered objects.
@@ -44,58 +43,32 @@ end
 def serialize_index(objects)
   filepath = "#{options.serializer.basepath}/index.csv"
 
-  CSV.open(filepath, 'wb') do |csv|
+  CSV.open(filepath, "wb") do |csv|
     csv << %w[name type path]
 
     objects.each do |object|
       next if object.name == :root
 
       if object.type == :class
-        csv << [object.path, 'Class', options.serializer.serialized_path(object)]
+        csv << [object.path, "Class", options.serializer.serialized_path(object)]
       elsif object.type == :module
-        csv << [object.path, 'Module', options.serializer.serialized_path(object)]
-      end
-
-      constants = constant_listing(object)
-      if constants.size.positive?
-        constants.each do |cnst|
-          csv << [
-            "#{object.path}.#{cnst.name(false)}",
-            'Constant',
-            (options.serializer.serialized_path(object) + '#' + aref(cnst))
-          ]
-        end
+        csv << [object.path, "Module", options.serializer.serialized_path(object)]
       end
 
-      if (insmeths = public_instance_methods(object)).size > 0
-        insmeths.each do |item|
+      [
+        ["Constant", constant_listing(object)],
+        ["Method", public_instance_methods(object)],
+        ["Method", public_class_methods(object)],
+        ["Attribute", attr_listing(object)]
+      ].each do |type, items|
+        items.each do |item|
           csv << [
             "#{object.path}.#{item.name(false)}",
-            'Method',
-            options.serializer.serialized_path(object) + '#' + aref(item)
+            type,
+            options.serializer.serialized_path(object) + "#" + aref(item)
           ]
         end
       end
-
-      if (pubmeths = public_class_methods(object)).size > 0
-        pubmeths.each do |item|
-          csv << [
-            "#{object.path}.#{item.name(false)}",
-            'Method',
-            options.serializer.serialized_path(object) + '#' + aref(item)
-          ]
-        end
-      end
-
-      next unless (attrs = attr_listing(object)).size > 0
-
-      attrs.each do |item|
-        csv << [
-          "#{object.path}.#{item.name(false)}",
-          'Attribute',
-          options.serializer.serialized_path(object) + '#' + aref(item)
-        ]
-      end
     end
   end
 end

data/templates/default/module/markdown/setup.rb

@@ -1,11 +1,6 @@
 # frozen_string_literal: true
 
-require 'pathname'
-require 'rdoc'
-
-include Helpers::ModuleHelper
-include YARD::Markdown::AnchorComponentHelper
-include YARD::Markdown::ArefHelper
+include YARD::Templates::Helpers::ModuleHelper
 include YARD::Markdown::CollectionRenderingHelper
 include YARD::Markdown::DocumentationHelper
 include YARD::Markdown::HeadingHelper
@@ -21,13 +16,13 @@ include YARD::Markdown::TagFormattingHelper
 # @return [void]
 def init
   sections :header,
-           :relationships,
-           :docstring_section,
-           :tags_section,
-           :constants_section,
-           :attributes_section,
-           :public_class_methods_section,
-           :public_instance_methods_section
+    :relationships,
+    :docstring_section,
+    :tags_section,
+    :constants_section,
+    :attributes_section,
+    :public_class_methods_section,
+    :public_instance_methods_section
 end
 
 # Renders the template and normalizes markdown for top-level page output.
@@ -41,21 +36,11 @@ end
 # @return [String] Rendered markdown output.
 def run(opts = nil, sects = sections, start_at = 0, break_first = false, &block)
   output = super
-  return output unless top_level_render?(sects, start_at, break_first)
+  return output unless !break_first && start_at.zero? && sects == sections
 
   finalize_markdown(output, options.serializer.serialized_path(object))
 end
 
-# Returns whether this invocation is rendering the full top-level page.
-#
-# @param sects [Array<Symbol>] Section names requested for rendering.
-# @param start_at [Integer] Starting index within `sects`.
-# @param break_first [Boolean] Whether rendering stops after the first section.
-# @return [Boolean] True when the whole page is being rendered in one pass.
-def top_level_render?(sects, start_at, break_first)
-  !break_first && start_at.zero? && sects == sections
-end
-
 # Renders the page heading for the current object.
 #
 # @return [String] Markdown heading section.
@@ -89,7 +74,7 @@ end
 # @return [String] Markdown constants section, or an empty string.
 def constants_section
   constants = constant_listing(object).reject { |item| hidden_object?(item) }
-  return '' unless constants.any?
+  return "" unless constants.any?
 
   render_section_content(render_constants(constants, Array(object.groups)))
 end
@@ -99,7 +84,7 @@ end
 # @return [String] Markdown attributes section, or an empty string.
 def attributes_section
   attrs = attr_listing(object).reject { |item| hidden_object?(item) }
-  return '' unless attrs.any?
+  return "" unless attrs.any?
 
   render_section_content(render_attributes(attrs, Array(object.groups)))
 end
@@ -109,9 +94,9 @@ end
 # @return [String] Markdown public class methods section, or an empty string.
 def public_class_methods_section
   methods = public_class_methods(object)
-  return '' unless methods.any?
+  return "" unless methods.any?
 
-  render_section_content(render_methods('Public Class Methods', methods, Array(object.groups)))
+  render_section_content(render_methods("Public Class Methods", methods, Array(object.groups)))
 end
 
 # Renders the public instance methods section when methods are present.
@@ -119,7 +104,7 @@ end
 # @return [String] Markdown public instance methods section, or an empty string.
 def public_instance_methods_section
   methods = public_instance_methods(object)
-  return '' unless methods.any?
+  return "" unless methods.any?
 
-  render_section_content(render_methods('Public Instance Methods', methods, Array(object.groups)))
+  render_section_content(render_methods("Public Instance Methods", methods, Array(object.groups)))
 end

metadata

@@ -1,11 +1,11 @@
 --- !ruby/object:Gem::Specification
 name: yard-markdown
 version: !ruby/object:Gem::Version
-  version: 0.7.0
+  version: 0.7.2
 platform: ruby
 authors:
 - Stanislav (Stas) Katkov
-bindir: exe
+bindir: bin
 cert_chain: []
 date: 1980-01-02 00:00:00.000000000 Z
 dependencies:
@@ -58,28 +58,10 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- ".editorconfig"
-- ".streerc"
-- ".yard-lint.yml"
-- ".yardopts"
-- AGENTS.md
 - CHANGELOG.md
 - LICENSE.txt
 - README.md
-- Rakefile
-- config/mutant.yml
-- example/rdoc/Bird.md
-- example/rdoc/Duck.md
-- example/rdoc/Waterfowl.md
-- example/rdoc/index.csv
-- example/yard/Aquatic.md
-- example/yard/Fish.md
-- example/yard/Salmon.md
-- example/yard/index.csv
-- example_rdoc.rb
-- example_yard.rb
 - lib/yard-markdown.rb
-- lib/yard/markdown/anchor_component_helper.rb
 - lib/yard/markdown/aref_helper.rb
 - lib/yard/markdown/collection_rendering_helper.rb
 - lib/yard/markdown/documentation_helper.rb
@@ -90,7 +72,6 @@ files:
 - lib/yard/markdown/relationship_section_helper.rb
 - lib/yard/markdown/section_assembly_helper.rb
 - lib/yard/markdown/tag_formatting_helper.rb
-- sig/yard/markdown.rbs
 - templates/default/fulldoc/markdown/setup.rb
 - templates/default/module/markdown/setup.rb
 homepage: https://poshtui.com

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/.streerc

@@ -1,2 +0,0 @@
---print-width=100
---plugins=plugin/trailing_comma,disable_ternary

data/.yard-lint.yml

@@ -1,317 +0,0 @@
-# YARD-Lint Configuration (Strict Mode)
-# See https://github.com/mensfeld/yard-lint for documentation
-#
-# This is a strict configuration suitable for new projects with high documentation standards.
-# All validators are set to 'error' severity (no warnings or conventions).
-# Minimum coverage is set to 100%.
-
-# Global settings for all validators
-AllValidators:
-  # YARD command-line options (applied to all validators by default)
-  YardOptions:
-    - --private
-    - --protected
-
-  # Global file exclusion patterns
-  Exclude:
-    - '\.git'
-    - "vendor/**/*"
-    - "node_modules/**/*"
-    - "spec/**/*"
-    - "test/**/*"
-    - "tmp/**/*"
-    - "example_rdoc.rb"
-    - "example_yard.rb"
-
-  # Exit code behavior (error, warning, convention, never)
-  FailOnSeverity: error
-
-  # Minimum documentation coverage percentage (0-100)
-  # Fails if coverage is below this threshold
-  MinCoverage: 100.0
-
-  # Diff mode settings
-  DiffMode:
-    # Default base ref for --diff (auto-detects main/master if not specified)
-    DefaultBaseRef: ~
-
-# Documentation validators
-Documentation/UndocumentedObjects:
-  Description: "Checks for classes, modules, and methods without documentation."
-  Enabled: true
-  Severity: error
-  ExcludedMethods:
-    - "initialize/0" # Exclude parameter-less initialize
-    - "/^_/" # Exclude private methods (by convention)
-
-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 (opt-in for strict documentation)."
-  Enabled: true # Enabled in strict mode
-  Severity: error
-  ExcludedMethods:
-    - "initialize" # Exclude all initialize methods
-    # - '/^_/'        # Uncomment to exclude private methods (by convention)
-
-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 validators
-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 # 'long' for Hash{K => V} (YARD standard), 'short' for {K => V}
-  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' (YARD standard: @param name [Type])
-  #                or 'type_first' (@param [Type] name)
-  EnforcedStyle: type_after_name
-
-Tags/ApiTags:
-  Description: "Enforces @api tags on public objects."
-  Enabled: false # Opt-in validator
-  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 # Opt-in validator (requires RuboCop or StandardRB)
-  Severity: convention
-  # Linter: auto  # Uncomment to explicitly configure: 'auto', 'rubocop', 'standard', 'none'
-  # SkipPatterns:  # Uncomment to skip examples matching patterns
-  #   - '/skip-lint/i'
-  #   - '/bad code/i'
-
-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 # Opt-in validator
-  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 # Opt-in validator
-  Severity: error
-  ForbiddenPatterns: []
-  # Example patterns:
-  # - Tag: return
-  #   Types:
-  #     - void
-  # - Tag: param
-  #   Types:
-  #     - Object
-  # - Tag: api  # Forbids @api tag entirely (no Types = any occurrence)
-
-# Warnings validators - catches YARD parser errors
-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 validators
-Semantic/AbstractMethods:
-  Description: "Ensures @abstract methods do not have real implementations."
-  Enabled: true
-  Severity: error

data/.yardopts

@@ -1 +0,0 @@
---load ./lib/yard-markdown.rb

data/AGENTS.md

@@ -1,54 +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
-
-- Line coverage must stay at 100%. Verify with:
-
-  ```
-  SIMPLECOV=1 bundle exec rake test
-  ```
-
-- 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.
-- You may not stub or mock the system under test (`Age`).
-
-## Done
-
-You are done when both of these are green and don't return any offenses:
-
-```
-SIMPLECOV=1 bundle exec rake test
-bundle exec mutant run
-bundle exec rake markdown:validate_real_world
-yard-lint lib/
-```