yard-markdown 0.7.1 → 0.7.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 20eaf2ccb5ab45418bcb82e961f472231fb5d705090e8650dd854a8cc0e1d92f
-  data.tar.gz: ec1a4f6d7f3afa2f7af44c44a72af9ba6a22148ffeb643dda1ffbb747a0cf1ee
+  metadata.gz: 6aa034296e039353941780b9556959dabbddad7874f52231b0dc69faed55b662
+  data.tar.gz: 379509fb60bb677e34f4ef90e3d6776462a6f9d0768fcf09c078866c78967476
 SHA512:
-  metadata.gz: ea0c103943a5b5361ecab753fa0d014835016a6a154bb77552e7c8d3c1f253eea2a8c62c2aafe2d7f72afd31dfe5cac763c864a7768cd0126bc229ba8f19ace4
-  data.tar.gz: 0f2ade24652236aef7cfb310cafe04f1f0dcc43a5bccba854ec9712d0a7edb752d91a6f85b723a8c5e19e66aff798ff2cbf669b4e5401f33f2f18c66875e8dd3
+  metadata.gz: 7a93025d200cc5711781fefced38b4e2a4e91ca6fb7228b744c28c1c8dfae8b18819b12bfcec1c7b9b6051c4f179342d55b8bd3bdf07ec083ea9e36ca60f59c7
+  data.tar.gz: f25532bd94b48553decf5b8c1a48c9bc92dcf639aadfc09b02a6c8ec77f8a9c568515d21991b891499d76643f4ab42c0e4df19d6e0588df887480734b756a7d9

data/CHANGELOG.md

@@ -5,6 +5,14 @@ This format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/)
 
 ## Unreleased
 
+## 0.7.2
+
+### Changed
+- Limit the packaged gem to documentation, runtime code, and templates.
+
+### Removed
+- Remove the generated RBS signature from the packaged gem.
+
 ## 0.7.1
 
 ### Fixed

data/README.md

@@ -66,12 +66,6 @@ Validate generated markdown in sample docs:
 bundle exec rake markdown:validate_examples
 ```
 
-Regenerate the checked-in RBS types derived from YARD docs:
-
-```bash
-bundle exec rake types:generate
-```
-
 There is also a real-world validation harness for repositories with substantial YARD documentation (`rspec-core`, `sidekiq`):
 
 ```bash
@@ -82,6 +76,4 @@ This task validates generated markdown against CommonMark + GFM rendering, and r
 
 GitHub Actions CI now runs this task on every push/PR, so `sidekiq` and other real-world fixture gems are verified continuously.
 
-CI also regenerates `sig/yard/markdown.rbs` with `sord` and fails if the checked-in RBS file is out of date.
-
 For reproducible checks, the task clones pinned tags (`rspec-core` `v3.13.2`, `sidekiq` `v7.3.10`) into `tmp/real-world/repos` before generating output.

data/lib/yard/markdown/aref_helper.rb

@@ -1,10 +1,20 @@
 # frozen_string_literal: true
 
+# Namespace for YARD extensions used by this gem.
 module YARD
+  # Shared helpers for rendering YARD objects as Markdown.
   module Markdown
     # Computes anchor ids that match the generated Markdown headings.
     module ArefHelper
-      include AnchorComponentHelper
+      # Encodes a value so it can be embedded safely in an HTML anchor id.
+      #
+      # @param value [Object] Raw anchor fragment to encode.
+      # @return [String] Anchor-safe identifier fragment.
+      def anchor_component(value)
+        value.to_s.each_char.map do |char|
+          char.match?(/[A-Za-z0-9_-]/) ? char : format("-%X", char.ord)
+        end.join
+      end
 
       # Returns the primary anchor id for a documented object.
       #

data/lib/yard/markdown/collection_rendering_helper.rb

@@ -10,27 +10,7 @@ module YARD
       # @param group_order [Array<String>, nil] Preferred ordering for group headings.
       # @return [String] Markdown for the constants section.
       def render_constants(constants, group_order)
-        lines = ["## Constants"]
-        grouped_constants = grouped_items(constants.sort_by { |item| item.name }, group_order)
-        uses_groups = grouped_constants.any? { |name, _items| !name.nil? }
-
-        grouped_constants.each do |group_name, items|
-          if uses_groups
-            lines << "### #{group_name || "General"}"
-            item_heading = "####"
-          else
-            item_heading = "###"
-          end
-
-          lines << items.map { |item|
-            item_lines = [heading_with_anchors("#{item_heading} `#{item.name}`", item)]
-            append_lines(item_lines, documented_text(item), separated: false)
-            append_lines(item_lines, render_tags(item), separated: false)
-            item_lines.join("\n")
-          }.join("\n\n")
-        end
-
-        lines.join("\n")
+        render_collection("Constants", constants.sort_by { |item| item.name }, group_order) { |item| "`#{item.name}`" }
       end
 
       # Renders the attributes section for an object page.
@@ -39,27 +19,7 @@ module YARD
       # @param group_order [Array<String>, nil] Preferred ordering for group headings.
       # @return [String] Markdown for the attributes section.
       def render_attributes(attrs, group_order)
-        lines = ["## Attributes"]
-        grouped_attrs = grouped_items(attrs, group_order)
-        uses_groups = grouped_attrs.any? { |name, _items| !name.nil? }
-
-        grouped_attrs.each do |group_name, items|
-          if uses_groups
-            lines << "### #{group_name || "General"}"
-            item_heading = "####"
-          else
-            item_heading = "###"
-          end
-
-          lines << items.map { |item|
-            item_lines = [heading_with_anchors("#{item_heading} `#{item.name}` [#{attribute_access(item)}]", item)]
-            append_lines(item_lines, documented_text(item), separated: false)
-            append_lines(item_lines, render_tags(item), separated: false)
-            item_lines.join("\n")
-          }.join("\n\n")
-        end
-
-        lines.join("\n")
+        render_collection("Attributes", attrs, group_order) { |item| "`#{item.name}` [#{attribute_access(item)}]" }
       end
 
       # Renders a method section for an object page.
@@ -69,20 +29,26 @@ module YARD
       # @param group_order [Array<String>, nil] Preferred ordering for group headings.
       # @return [String] Markdown for the method section.
       def render_methods(section_title, methods, group_order)
+        render_collection(section_title, methods, group_order) { |item| "`#{formatted_method_heading(item)}`" }
+      end
+
+      # Renders a grouped collection with a caller-provided item label.
+      #
+      # @param section_title [String] Section title to render.
+      # @param items [Array<YARD::CodeObjects::Base>] Objects to group and render.
+      # @param group_order [Array<String>, nil] Preferred ordering for group headings.
+      # @return [String] Markdown for the collection section.
+      def render_collection(section_title, items, group_order)
         lines = ["## #{section_title}"]
-        grouped_methods = grouped_items(methods, group_order)
-        uses_groups = grouped_methods.any? { |name, _items| !name.nil? }
+        groups = grouped_items(items, group_order)
+        uses_groups = groups.any? { |name, _items| !name.nil? }
+        item_heading = uses_groups ? "####" : "###"
 
-        grouped_methods.each do |group_name, items|
-          if uses_groups
-            lines << "### #{group_name || "General"}"
-            item_heading = "####"
-          else
-            item_heading = "###"
-          end
+        groups.each do |group_name, group_items|
+          lines << "### #{group_name || "General"}" if uses_groups
 
-          lines << items.map { |item|
-            item_lines = [heading_with_anchors("#{item_heading} `#{formatted_method_heading(item)}`", item)]
+          lines << group_items.map { |item|
+            item_lines = [heading_with_anchors("#{item_heading} #{yield(item)}", item)]
             append_lines(item_lines, documented_text(item), separated: false)
             append_lines(item_lines, render_tags(item), separated: false)
             item_lines.join("\n")

data/lib/yard/markdown/method_presentation_helper.rb

@@ -34,13 +34,9 @@ module YARD
       # @param attribute [YARD::CodeObjects::MethodObject] Attribute reader or writer.
       # @return [String] Access mode marker such as `R`, `W`, or `RW`.
       def attribute_access(attribute)
-        info = attribute.attr_info || {}
-        return "RW" if info[:read] && info[:write]
-        return "R" if info[:read]
-        return "W" if info[:write]
-
-        return "RW" if attribute.reader? && attribute.writer?
-        return "R" if attribute.reader?
+        read, write = attribute.attr_info.fetch_values(:read, :write)
+        return "RW" if read && write
+        return "R" if read
 
         "W"
       end

data/lib/yard/markdown/section_assembly_helper.rb

@@ -10,23 +10,12 @@ module YARD
       # @param group_order [Array<String>, nil] Preferred ordering for named groups.
       # @return [Array<Array>] Ordered pairs of group names and grouped items.
       def grouped_items(items, group_order)
-        grouped = Hash.new { |hash, key| hash[key] = [] }
-        items.each { |item| grouped[item.group] << item }
+        groups = items.group_by(&:group)
+        names = groups.keys
+        order = Array(group_order)
+        ordered_names = (order & names) + (names.compact - order).sort + ([nil] & names)
 
-        ordered = []
-
-        Array(group_order).each do |name|
-          next unless grouped.key?(name)
-
-          ordered << [name, grouped.delete(name)]
-        end
-
-        grouped.keys.compact.sort.each do |name|
-          ordered << [name, grouped.delete(name)]
-        end
-
-        ordered << [nil, grouped.delete(nil)] if grouped.key?(nil)
-        ordered
+        ordered_names.map { |name| [name, groups.fetch(name)] }
       end
 
       # Appends non-empty content to a mutable list of lines.

data/lib/yard/markdown/tag_formatting_helper.rb

@@ -9,13 +9,8 @@ module YARD
       # @param object [YARD::CodeObjects::Base] Object whose tags are being rendered.
       # @return [String] Markdown representation of the object's tags.
       def render_tags(object)
-        lines = []
-        regular_tags = object.tags.reject { |tag| tag.tag_name == "example" }
-        example_tags = object.tags.select { |tag| tag.tag_name == "example" }
-
-        regular_tags.each do |tag|
-          lines << "- #{format_tag(tag)}"
-        end
+        example_tags, regular_tags = object.tags.partition { |tag| tag.tag_name == "example" }
+        lines = regular_tags.map { |tag| "- #{format_tag(tag)}" }
 
         example_tags.each do |tag|
           lines << nil unless lines.empty?
@@ -46,29 +41,10 @@ module YARD
 
       # Normalizes tag type declarations into printable strings.
       #
-      # @param types [Array<Object>, Hash, nil] Raw tag types from YARD.
+      # @param types [Array<Object>, nil] Raw tag types from YARD.
       # @return [Array<String>] Cleaned type strings.
       def normalized_tag_types(types)
-        values = if types.instance_of?(Hash)
-          types.map { |name, value| format_hash_tag_type(name, value) }
-        else
-          Array(types)
-        end
-
-        values.map(&:to_s).map(&:strip).reject(&:empty?)
-      end
-
-      # Formats a hash-style tag type entry.
-      #
-      # @param name [String] Type name to format.
-      # @param value [Object] Associated type detail.
-      # @return [String, nil] Formatted type entry, or nil when blank.
-      def format_hash_tag_type(name, value)
-        key = name.rstrip
-        return nil if key.empty?
-        return key if value.nil? || value == true || (value.respond_to?(:empty?) && value.empty?)
-
-        "#{key}: #{value}"
+        Array(types).map(&:to_s).map(&:strip).reject(&:empty?)
       end
     end
   end

data/lib/yard-markdown.rb

@@ -1,7 +1,6 @@
 # frozen_string_literal: true
 
 require "yard"
-require_relative "yard/markdown/anchor_component_helper"
 require_relative "yard/markdown/aref_helper"
 require_relative "yard/markdown/collection_rendering_helper"
 require_relative "yard/markdown/documentation_helper"

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

@@ -2,11 +2,9 @@
 
 require "csv"
 
-class_eval do
-  include YARD::Templates::Helpers::ModuleHelper
-  include YARD::Markdown::ArefHelper
-  include YARD::Markdown::ObjectListingHelper
-end
+include YARD::Templates::Helpers::ModuleHelper
+include YARD::Markdown::ArefHelper
+include YARD::Markdown::ObjectListingHelper
 
 # Prepares the markdown serializer and renders each object page.
 #
@@ -57,46 +55,20 @@ def serialize_index(objects)
         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
-      end
-
-      if (insmeths = public_instance_methods(object)).size > 0
-        insmeths.each do |item|
-          csv << [
-            "#{object.path}.#{item.name(false)}",
-            "Method",
-            options.serializer.serialized_path(object) + "#" + aref(item)
-          ]
-        end
-      end
-
-      if (pubmeths = public_class_methods(object)).size > 0
-        pubmeths.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",
+            type,
             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,21 +1,15 @@
 # frozen_string_literal: true
 
-require "rdoc"
-
-class_eval do
-  include YARD::Templates::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
-end
+include YARD::Templates::Helpers::ModuleHelper
+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.
 #
@@ -42,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.

metadata

@@ -1,11 +1,11 @@
 --- !ruby/object:Gem::Specification
 name: yard-markdown
 version: !ruby/object:Gem::Version
-  version: 0.7.1
+  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,29 +58,10 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- ".editorconfig"
-- ".standard.yml"
-- ".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
@@ -91,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/.standard.yml

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

data/.streerc

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