yard-fence 0.5.0 → 0.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: '0909353a8e193134a57cf571979c154be5c08adb0ce6c53855282996ea8d96de'
-  data.tar.gz: 69400f31490fb97d56aa19a79519c7f15c160b689b48ca6d0228df640410655b
+  metadata.gz: ab9b554560a42067263a056274659da9b71ab9d384a255dfda0e9e8f0ef86db9
+  data.tar.gz: 540eaf18d29756c303e7e4cba3ffcdddd29db9bc4f73a9507448509aac84efd1
 SHA512:
-  metadata.gz: e7e3af604e115d051dac3bb1763df43aeacdd693c947504ace79f8864f12e343ea54e065be3b3b13e55b4b29bc8d193fcb939c44fbcad3a6f0307df5c55dd06e
-  data.tar.gz: 28c385b149403931cf456ad76223a33b12df2272fa47bcde51cfff31344e43b699227a7a10902f27e910beced70db24fd674b0831e2652ef7dc487669139ca78
+  metadata.gz: 7724c35b7df1307d0220cfdf5610f3f7a0495e9ab6a8c325f709fbcfadbc3857f755f71879e859a62aa82c03a599bfebddfd164d62ec6ea30b1948315e077bfb
+  data.tar.gz: e57d9c374b51e94874be71f261c6d02cf689f3722245fd374daffa48f48022218321ade826453a33e16523d984eb74c71743c7012d8f49aedc7b09f4d784073c

data/CHANGELOG.md

@@ -30,6 +30,28 @@ Please file a bug if you notice a violation of semantic versioning.
 
 ### Security
 
+## [0.7.0] - 2025-11-08
+
+- TAG: [v0.7.0][0.7.0t]
+- COVERAGE: 99.19% -- 123/124 lines in 4 files
+- BRANCH COVERAGE: 90.00% -- 36/40 branches in 4 files
+- 37.93% documented
+
+### Changed
+
+- Actually use custom KramdownGFM
+
+## [0.6.0] - 2025-11-07
+
+- TAG: [v0.6.0][0.6.0t]
+- COVERAGE: 100.00% -- 119/119 lines in 4 files
+- BRANCH COVERAGE: 100.00% -- 34/34 branches in 4 files
+- 37.93% documented
+
+### Added
+
+- Catch unrendered code blocks and attempt to convert to HTML
+
 ## [0.5.0] - 2025-11-07
 
 - TAG: [v0.5.0][0.5.0t]
@@ -94,7 +116,11 @@ Please file a bug if you notice a violation of semantic versioning.
 
 - Initial release
 
-[Unreleased]: https://github.com/galtzo-floss/yard-fence/compare/v0.5.0...HEAD
+[Unreleased]: https://github.com/galtzo-floss/yard-fence/compare/v0.7.0...HEAD
+[0.7.0]: https://github.com/galtzo-floss/yard-fence/compare/v0.6.0...v0.7.0
+[0.7.0t]: https://github.com/galtzo-floss/yard-fence/releases/tag/v0.7.0
+[0.6.0]: https://github.com/galtzo-floss/yard-fence/compare/v0.5.0...v0.6.0
+[0.6.0t]: https://github.com/galtzo-floss/yard-fence/releases/tag/v0.6.0
 [0.5.0]: https://github.com/galtzo-floss/yard-fence/compare/v0.4.0...v0.5.0
 [0.5.0t]: https://github.com/galtzo-floss/yard-fence/releases/tag/v0.5.0
 [0.4.0]: https://github.com/galtzo-floss/yard-fence/compare/v0.3.0...v0.4.0

data/README.md

@@ -586,7 +586,7 @@ Thanks for RTFM. ☺️
 [📌gitmoji]: https://gitmoji.dev
 [📌gitmoji-img]: https://img.shields.io/badge/gitmoji_commits-%20%F0%9F%98%9C%20%F0%9F%98%8D-34495e.svg?style=flat-square
 [🧮kloc]: https://www.youtube.com/watch?v=dQw4w9WgXcQ
-[🧮kloc-img]: https://img.shields.io/badge/KLOC-0.098-FFDD67.svg?style=for-the-badge&logo=YouTube&logoColor=blue
+[🧮kloc-img]: https://img.shields.io/badge/KLOC-0.124-FFDD67.svg?style=for-the-badge&logo=YouTube&logoColor=blue
 [🔐security]: SECURITY.md
 [🔐security-img]: https://img.shields.io/badge/security-policy-259D6C.svg?style=flat
 [📄copyright-notice-explainer]: https://opensource.stackexchange.com/questions/5778/why-do-licenses-such-as-the-mit-license-specify-a-single-year

data/lib/yard/fence/kramdown_gfm_document.rb

@@ -12,14 +12,67 @@ require "kramdown-parser-gfm"
 module Yard
   module Fence
     class KramdownGfmDocument < Kramdown::Document
+      # Detects an unrendered fenced code block that slipped through HTML generation.
+      # Note on <details markdown="1">:
+      # - The classic kramdown parser honors the markdown="1" attribute on block HTML like <details>,
+      #   and will parse contained markdown as block-level content.
+      # - The GFM parser generally handles many cases well, and markdown="1" may appear to work in
+      #   most sections; however, we've observed edge cases where fenced code blocks inside a
+      #   <details markdown="1"> are left as literal backticks (rendered as <p>``` …</p>).
+      #   This fallback detects that situation and re-renders with the classic parser.
+      UNRENDERED_FENCE_PARAGRAPH = /<p>```/
+      DETAILS_MARKDOWN_1 = /<details[^>]*markdown=["']1["'][^>]*>/i
+
       def initialize(source, options = {})
         options[:input] = "GFM" unless options.key?(:input)
+        @__yard_fence_source = source # Keep original for potential fallback.
         super(source, options)
       end
+
+      # Override to_html to provide a smart fallback: if the GFM parse leaves literal
+      # fenced code markers (```), re-run the render with the classic 'kramdown' input which
+      # correctly evaluates markdown inside <details markdown="1"> blocks.
+      # Opt-out via ENV["YARD_FENCE_DISABLE_FALLBACK"] == "1".
+      def to_html
+        html = super
+        return html if ENV["YARD_FENCE_DISABLE_FALLBACK"] == "1"
+        return html unless @__yard_fence_source.include?("```")
+
+        if needs_fallback?(html)
+          fallback_options = @options.merge(input: "kramdown")
+          fb_html = Kramdown::Document.new(@__yard_fence_source, fallback_options).to_html
+          return fb_html if fallback_improved?(fb_html)
+        end
+        html
+      end
+
+      private
+
+      def needs_fallback?(html)
+        # Obvious failure: raw fenced code rendered as a paragraph
+        return true if html.match?(UNRENDERED_FENCE_PARAGRAPH)
+        # Edge case: details wrapper present in source but output lacks any code block
+        if @__yard_fence_source.match?(DETAILS_MARKDOWN_1)
+          has_code_block = html.include?("<pre") && html.include?("<code")
+          return !has_code_block
+        end
+        false
+      end
+
+      def fallback_improved?(fb_html)
+        fb_html.match?(UNRENDERED_FENCE_PARAGRAPH) == false &&
+          fb_html.include?("<pre") && fb_html.include?("<code")
+      end
     end
   end
 end
 
-# Note:
-# We intentionally do NOT auto-register here to avoid circular require warnings when
-# YARD is loading. Prefer calling Yard::Fence.use_kramdown_gfm! from your .yardopts.
+# Ensure YARD can resolve the provider constant at the top-level
+# YARD does something akin to Object.const_get("::" + const), so it expects
+# a top-level ::KramdownGfmDocument when const == "KramdownGfmDocument".
+# Provide an alias to our namespaced implementation.
+# :nocov:
+unless defined?(KramdownGfmDocument)
+  KramdownGfmDocument = Yard::Fence::KramdownGfmDocument
+end
+# :nocov:

data/lib/yard/fence/version.rb

@@ -3,7 +3,7 @@
 module Yard
   module Fence
     module Version
-      VERSION = "0.5.0"
+      VERSION = "0.7.0"
     end
     VERSION = Version::VERSION
   end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: yard-fence
 version: !ruby/object:Gem::Version
-  version: 0.5.0
+  version: 0.7.0
 platform: ruby
 authors:
 - Peter H. Boling
@@ -316,10 +316,10 @@ licenses:
 - MIT
 metadata:
   homepage_uri: https://yard-fence.galtzo.com/
-  source_code_uri: https://github.com/galtzo-floss/yard-fence/tree/v0.5.0
-  changelog_uri: https://github.com/galtzo-floss/yard-fence/blob/v0.5.0/CHANGELOG.md
+  source_code_uri: https://github.com/galtzo-floss/yard-fence/tree/v0.7.0
+  changelog_uri: https://github.com/galtzo-floss/yard-fence/blob/v0.7.0/CHANGELOG.md
   bug_tracker_uri: https://github.com/galtzo-floss/yard-fence/issues
-  documentation_uri: https://www.rubydoc.info/gems/yard-fence/0.5.0
+  documentation_uri: https://www.rubydoc.info/gems/yard-fence/0.7.0
   funding_uri: https://github.com/sponsors/pboling
   wiki_uri: https://github.com/galtzo-floss/yard-fence/wiki
   news_uri: https://www.railsbling.com/tags/yard-fence