yard-markdown 0.5.0 → 0.7.0

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

@@ -0,0 +1,125 @@
+# frozen_string_literal: true
+
+require 'pathname'
+require 'rdoc'
+
+include Helpers::ModuleHelper
+include YARD::Markdown::AnchorComponentHelper
+include YARD::Markdown::ArefHelper
+include YARD::Markdown::CollectionRenderingHelper
+include YARD::Markdown::DocumentationHelper
+include YARD::Markdown::HeadingHelper
+include YARD::Markdown::LinkNormalizationHelper
+include YARD::Markdown::MethodPresentationHelper
+include YARD::Markdown::ObjectListingHelper
+include YARD::Markdown::RelationshipSectionHelper
+include YARD::Markdown::SectionAssemblyHelper
+include YARD::Markdown::TagFormattingHelper
+
+# Registers the sections rendered for a namespace markdown page.
+#
+# @return [void]
+def init
+  sections :header,
+           :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.
+#
+# @param opts [Hash, nil] Template options passed through to the base template.
+# @option opts [YARD::CodeObjects::NamespaceObject] :object Object being rendered.
+# @param sects [Array<Symbol>] Section names to render.
+# @param start_at [Integer] Starting index within `sects`.
+# @param break_first [Boolean] Whether rendering stops after the first section.
+# @yield Optional block forwarded to the base template renderer.
+# @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)
+
+  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.
+def header
+  render_section_content(heading_with_anchors("# #{object.type.to_s.capitalize} #{object.path}", object))
+end
+
+# Renders inheritance and mixin relationships for the current object.
+#
+# @return [String] Markdown relationships section.
+def relationships
+  render_section_content(object_relationships(object))
+end
+
+# Renders the object's docstring as markdown.
+#
+# @return [String] Markdown docstring section.
+def docstring_section
+  render_section_content(rdoc_to_md(object.docstring))
+end
+
+# Renders the object's YARD tags.
+#
+# @return [String] Markdown tags section.
+def tags_section
+  render_section_content(render_tags(object))
+end
+
+# Renders the constants section when visible constants are present.
+#
+# @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?
+
+  render_section_content(render_constants(constants, Array(object.groups)))
+end
+
+# Renders the attributes section when visible attributes are present.
+#
+# @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?
+
+  render_section_content(render_attributes(attrs, Array(object.groups)))
+end
+
+# Renders the public class methods section when methods are present.
+#
+# @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?
+
+  render_section_content(render_methods('Public Class Methods', methods, Array(object.groups)))
+end
+
+# Renders the public instance methods section when methods are present.
+#
+# @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?
+
+  render_section_content(render_methods('Public Instance Methods', methods, Array(object.groups)))
+end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: yard-markdown
 version: !ruby/object:Gem::Version
-  version: 0.5.0
+  version: 0.7.0
 platform: ruby
 authors:
 - Stanislav (Stas) Katkov
 bindir: exe
 cert_chain: []
-date: 2024-12-28 00:00:00.000000000 Z
+date: 1980-01-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: yard
@@ -37,6 +37,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: rdoc
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 description: yard plugin to generate markdown documentation for gems
 email:
 - yard-markdown@skatkov.com
@@ -46,10 +60,14 @@ 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
@@ -61,8 +79,20 @@ files:
 - 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
+- lib/yard/markdown/heading_helper.rb
+- lib/yard/markdown/link_normalization_helper.rb
+- lib/yard/markdown/method_presentation_helper.rb
+- lib/yard/markdown/object_listing_helper.rb
+- 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
 licenses:
 - MIT
@@ -83,7 +113,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.6.2
+rubygems_version: 4.0.10
 specification_version: 4
 summary: yard plugin to generate markdown documentation
 test_files: []