yard-fence 0.6.0 → 0.8.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: dedaaa231c20409b1d4aedb72ac7b12c0716076eedea5375ed2a232999b2ea7b
-  data.tar.gz: f6b65e208d3fc7c9a0b19939949309e6020ad1808cb5378372ac0a6ef2511715
+  metadata.gz: efcf6aabcf9abcf8dcf8e1878511c03251163a4badfd5b3bb70f14945586a60a
+  data.tar.gz: 3f2b3b47d984092fc321a8f20b93a0c61fb2df7a8693f00c1e321ddfd1378625
 SHA512:
-  metadata.gz: a5f0e3c15d75462209e1a717b762b137256aab58dfc44527008cf159458ed50fa47450ddb8355f0f2b006db3cff4f18ba9258ffc6f5542177c5921a2a2d42292
-  data.tar.gz: 81f406fdc8c3e399fa730ec7ab3790fa62981a96a02852abaaa8c0edca52cc8070cef89933407e142bc1e741a3f1e46cd933c369ade528cbf2f593c188d02b52
+  metadata.gz: e11299ec5ad361db6eeac761c165c4e46ec0d70b7fb176476a4a2a8236323a9dfe7df81a1bd3ea5ec94db3476caa24eb40f608bc19c76262c3eab25b52af1112
+  data.tar.gz: e0e1020769588c7f576b0c6d34e0effe4042803407b5ea5dd215fca1037ec114fe029ee8684608517011c8dfea5ce956f27c4288e3c03b757dbc85356eff23c6

data/CHANGELOG.md

@@ -30,6 +30,33 @@ Please file a bug if you notice a violation of semantic versioning.
 
 ### Security
 
+## [0.8.0] - 2025-11-08
+
+- TAG: [v0.8.0][0.8.0t]
+- COVERAGE: 100.00% -- 121/121 lines in 4 files
+- BRANCH COVERAGE: 100.00% -- 36/36 branches in 4 files
+- 37.93% documented
+
+### Added
+
+- Allow disabling of yard-fence via YARD_FENCE_DISABLE=true (default false)
+
+### Fixed
+
+- Usage instructions in README.md
+  - Include `--markup-provider kramdown`
+
+## [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]
@@ -105,7 +132,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.6.0...HEAD
+[Unreleased]: https://github.com/galtzo-floss/yard-fence/compare/v0.8.0...HEAD
+[0.8.0]: https://github.com/galtzo-floss/yard-fence/compare/v0.7.0...v0.8.0
+[0.8.0t]: https://github.com/galtzo-floss/yard-fence/releases/tag/v0.8.0
+[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

data/README.md

@@ -63,7 +63,9 @@ Create a `.yardopts` file like this:
 --plugin fence
 -e yard/fence/hoist.rb
 --readme tmp/yard-fence/README.md
+--charset utf-8
 --markup markdown
+--markup-provider kramdown
 --output docs
 'lib/**/*.rb'
 -
@@ -205,7 +207,9 @@ Recommended .yardopts (noise‑free):
 --plugin fence
 -e yard/fence/hoist.rb
 --readme tmp/yard-fence/README.md
+--charset utf-8
 --markup markdown
+--markup-provider kramdown
 --output docs
 'lib/**/*.rb'
 -
@@ -226,6 +230,10 @@ yard doc \
   --plugin fence \
   -e yard/fence/hoist.rb \
   --readme tmp/yard-fence/README.md \
+  --charset utf-8 \
+  --markup markdown \
+  --markup-provider kramdown \
+  --output docs \
   lib/**/*.rb - tmp/yard-fence/*.md tmp/yard-fence/*.txt
 ```
 
@@ -586,7 +594,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.119-FFDD67.svg?style=for-the-badge&logo=YouTube&logoColor=blue
+[🧮kloc-img]: https://img.shields.io/badge/KLOC-0.121-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/hoist.rb

@@ -1,9 +1,21 @@
-if defined?(Yard::Fence) && Yard::Fence.respond_to?(:use_kramdown_gfm!)
-  if Yard::Fence.use_kramdown_gfm!
-    puts "[yard/fence/hoist] Kramdown GFM provider registered"
+if ENV.fetch("YARD_FENCE_DISABLE", "false").casecmp?("true")
+  warn("[yard/fence/hoist] Hoist disabled via YARD_FENCE_DISABLE")
+else
+  unless defined?(KramdownGfmDocument)
+    # 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.
+    KramdownGfmDocument = Yard::Fence::KramdownGfmDocument
+    puts "[yard/fence/hoist] KramdownGfmDocument hoisted to top-level"
+  end
+  if defined?(Yard::Fence) && Yard::Fence.respond_to?(:use_kramdown_gfm!)
+    if Yard::Fence.use_kramdown_gfm!
+      puts "[yard/fence/hoist] Kramdown GFM provider registered"
+    else
+      warn "[yard/fence/hoist] Kramdown GFM provider registration failed"
+    end
   else
-    warn "[yard/fence/hoist] Kramdown GFM provider registration failed"
+    warn("[yard/fence/hoist] Yard::Fence.use_kramdown_gfm! not available; skipping")
   end
-else
-  warn("[yard/fence/hoist] Yard::Fence.use_kramdown_gfm! not available; skipping")
 end

data/lib/yard/fence/version.rb

@@ -3,7 +3,7 @@
 module Yard
   module Fence
     module Version
-      VERSION = "0.6.0"
+      VERSION = "0.8.0"
     end
     VERSION = Version::VERSION
   end

data/lib/yard/fence.rb

@@ -167,10 +167,16 @@ module Yard
     end
 
     def postprocess_html_docs
-      docs = File.join(Dir.pwd, "docs")
-      return unless Dir.exist?(docs)
-      Dir.glob(File.join(docs, "**", "*.html")).each do |html|
-        restore_ascii_braces_in_html_file(html)
+      if ENV.fetch("YARD_FENCE_DISABLE", "false").casecmp?("true")
+        # :nocov:
+        warn("[yard/fence] postprocess_html_docs disabled via YARD_FENCE_DISABLE")
+        # :nocov:
+      else
+        docs = File.join(Dir.pwd, "docs")
+        return unless Dir.exist?(docs)
+        Dir.glob(File.join(docs, "**", "*.html")).each do |html|
+          restore_ascii_braces_in_html_file(html)
+        end
       end
     rescue => e
       warn("Yard::Fence.postprocess_html_docs failed: #{e.class}: #{e.message}")
@@ -203,7 +209,13 @@ module Yard
     end
 
     def at_load_hook
-      Yard::Fence.prepare_tmp_files
+      if ENV.fetch("YARD_FENCE_DISABLE", "false").casecmp?("true")
+        # :nocov:
+        warn("[yard/fence] at_load_hook disabled via YARD_FENCE_DISABLE")
+        # :nocov:
+      else
+        Yard::Fence.prepare_tmp_files
+      end
     rescue => e
       warn("Yard::Fence: failed to prepare tmp/yard-fence files: #{e.class}: #{e.message}")
     end

data/sig/yard/fence.rbs

@@ -48,7 +48,22 @@ module Yard
     end
 
     class KramdownGfmDocument < ::Kramdown::Document
+      # From implementation: stores original source and forces GFM input by default
+      UNRENDERED_FENCE_PARAGRAPH: ::Regexp
+      DETAILS_MARKDOWN_1: ::Regexp
+
       def initialize: (String source, ?Hash[Symbol, untyped] options) -> void
+
+      # Public API
+      def to_html: () -> String
+
+      private
+
+      def needs_fallback?: (String html) -> bool
+      def fallback_improved?: (String fb_html) -> bool
     end
   end
 end
+
+# Top-level alias used by YARD's constant resolution (see ruby implementation)
+KramdownGfmDocument: Yard::Fence::KramdownGfmDocument

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: yard-fence
 version: !ruby/object:Gem::Version
-  version: 0.6.0
+  version: 0.8.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.6.0
-  changelog_uri: https://github.com/galtzo-floss/yard-fence/blob/v0.6.0/CHANGELOG.md
+  source_code_uri: https://github.com/galtzo-floss/yard-fence/tree/v0.8.0
+  changelog_uri: https://github.com/galtzo-floss/yard-fence/blob/v0.8.0/CHANGELOG.md
   bug_tracker_uri: https://github.com/galtzo-floss/yard-fence/issues
-  documentation_uri: https://www.rubydoc.info/gems/yard-fence/0.6.0
+  documentation_uri: https://www.rubydoc.info/gems/yard-fence/0.8.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