yard-fence 0.8.1 → 0.8.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: bc262c091f78581d3821583ece2da12cd358b65c7d0acf746d4d6707716e954e
-  data.tar.gz: '0942c781301e6bd8797d6f2469536f7fb78f9ec94c0925f392dfc3ea4b85291f'
+  metadata.gz: 90ced668922aea260b30e6505493afb8bd6b457ad67e598edf5c0a3ca8fec331
+  data.tar.gz: 3f177b2d225ca2a737e257b445449206f5d71ca6d307eb90506928bae8e1c0e2
 SHA512:
-  metadata.gz: 55f59d786ae901ffce17587bd780277dfad50937d2a4e3ebb3d1c7bd7c20f0509c1ca24ee2de9dd614aa206179bae4919257399d398e5c4b997e2d5874669e72
-  data.tar.gz: 974da0442ee2e4f4cbb42a7c0cf9100226d05a0ffe58b53a86ee6436bc198dc9807261b44daa9ad5d708a4ee1fbff16ab93c9ed413747e2e7f65340d7cac6ce9
+  metadata.gz: eb125c673df6de4eac631cb1678a09a084ec082229dfbd1045975636191823ad2c2ecfb68302ac339885db25294b54e7503ed4ffe980266b222283ca6f836145
+  data.tar.gz: cbc8e3b9db77e6267db67b8bb4d266c322382f09667260c0e1cba71fb4ffb39bb309f9ac96ee61d61d1f41d9fed53bae9adbd7ef49cab4343d9a2a2d13016112

data/CHANGELOG.md

@@ -30,6 +30,38 @@ Please file a bug if you notice a violation of semantic versioning.
 
 ### Security
 
+## [0.8.2] - 2025-12-30
+
+- TAG: [v0.8.2][0.8.2t]
+- COVERAGE: 100.00% -- 130/130 lines in 4 files
+- BRANCH COVERAGE: 100.00% -- 40/40 branches in 4 files
+- 50.00% documented
+
+### Added
+
+- `Yard::Fence::RakeTask` - New rake task class that provides `yard:fence:prepare` and `yard:fence:clean` tasks
+  - Automatically enhances the `:yard` task when defined
+  - Auto-registers when Rake is available at gem load time
+- `Yard::Fence.prepare_for_yard` - New method to prepare for YARD documentation generation
+  - Combines `clean_docs_directory` and `prepare_tmp_files` into a single call
+  - Intended to be called from rake tasks, not at load time
+
+### Deprecated
+
+- `Yard::Fence.at_load_hook` - Now does nothing; use `prepare_for_yard` via rake task instead
+
+### Removed
+
+- **BREAKING**: Removed load-time execution of `clean_docs_directory` and `prepare_tmp_files`
+  - Previously, these ran when yard-fence was loaded, causing `docs/` to be cleared during unrelated rake tasks like `build` and `release`
+  - Now all preparation happens via the `yard:fence:prepare` rake task, which runs as a prerequisite to the `:yard` task
+
+### Fixed
+
+- Fixed `docs/` directory being cleared during `rake build` and `rake release` commands
+  - The root cause was `at_load_hook` running at gem load time instead of only when generating documentation
+  - Now docs cleanup and tmp file preparation only occur when the `yard` task actually runs
+
 ## [0.8.1] - 2025-12-29
 
 - TAG: [v0.8.1][0.8.1t]
@@ -150,7 +182,9 @@ Please file a bug if you notice a violation of semantic versioning.
 
 - Initial release
 
-[Unreleased]: https://github.com/galtzo-floss/yard-fence/compare/v0.8.1...HEAD
+[Unreleased]: https://github.com/galtzo-floss/yard-fence/compare/v0.8.2...HEAD
+[0.8.2]: https://github.com/galtzo-floss/yard-fence/compare/v0.8.1...v0.8.2
+[0.8.2t]: https://github.com/galtzo-floss/yard-fence/releases/tag/v0.8.2
 [0.8.1]: https://github.com/galtzo-floss/yard-fence/compare/v0.8.0...v0.8.1
 [0.8.1t]: https://github.com/galtzo-floss/yard-fence/releases/tag/v0.8.1
 [0.8.0]: https://github.com/galtzo-floss/yard-fence/compare/v0.7.0...v0.8.0

data/README.md

@@ -617,7 +617,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.129-FFDD67.svg?style=for-the-badge&logo=YouTube&logoColor=blue
+[🧮kloc-img]: https://img.shields.io/badge/KLOC-0.130-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/rake_task.rb

@@ -0,0 +1,67 @@
+# frozen_string_literal: true
+
+require "rake"
+require "rake/tasklib"
+
+module Yard
+  module Fence
+    # Rake task to prepare for YARD documentation generation.
+    # This handles both cleaning the docs directory (if YARD_FENCE_CLEAN_DOCS=true)
+    # and preparing the tmp/yard-fence files with sanitized markdown.
+    #
+    # This is separated from the gem's load-time to ensure these operations only
+    # happen when explicitly running documentation tasks, not during other
+    # rake tasks like `build` or `release`.
+    #
+    # @example Usage in Rakefile
+    #   require "yard/fence/rake_task"
+    #   Yard::Fence::RakeTask.new
+    #
+    #   # This creates a `yard:fence:prepare` task that is automatically added
+    #   # as a prerequisite to the yard task.
+    #
+    class RakeTask < ::Rake::TaskLib
+      # @return [String] the name of the prepare task (default: "yard:fence:prepare")
+      attr_accessor :name
+
+      # Initialize the rake task.
+      #
+      # @param name [String, Symbol] the task name (default: "yard:fence:prepare")
+      # @yield [task] optional block to configure the task
+      def initialize(name = "yard:fence:prepare")
+        super()
+        @name = name.to_s
+
+        yield self if block_given?
+
+        define_tasks
+      end
+
+      private
+
+      def define_tasks
+        namespace(:yard) do
+          namespace(:fence) do
+            desc("Prepare for YARD documentation (clean docs/, prepare tmp/yard-fence/)")
+            task(:prepare) do
+              require "yard/fence"
+              Yard::Fence.prepare_for_yard
+            end
+
+            # Keep a separate clean task for those who want to clean without preparing
+            desc("Clean docs/ directory only (yard-fence)")
+            task(:clean) do
+              require "yard/fence"
+              Yard::Fence.clean_docs_directory
+            end
+          end
+        end
+
+        # Auto-enhance the yard task if it exists
+        if ::Rake::Task.task_defined?(:yard)
+          ::Rake::Task[:yard].enhance(["yard:fence:prepare"])
+        end
+      end
+    end
+  end
+end

data/lib/yard/fence/version.rb

@@ -3,7 +3,7 @@
 module Yard
   module Fence
     module Version
-      VERSION = "0.8.1"
+      VERSION = "0.8.2"
     end
     VERSION = Version::VERSION
   end

data/lib/yard/fence.rb

@@ -228,22 +228,36 @@ module Yard
       puts "[yard/fence] Cleared docs/ directory (YARD_FENCE_CLEAN_DOCS=true)"
     end
 
-    def at_load_hook
+    # Prepare for YARD documentation generation.
+    # This method should be called from a rake task BEFORE yard runs, not at load time.
+    # It cleans the docs directory (if YARD_FENCE_CLEAN_DOCS=true) and prepares tmp files.
+    def prepare_for_yard
       if ENV.fetch("YARD_FENCE_DISABLE", "false").casecmp?("true")
         # :nocov:
-        warn("[yard/fence] at_load_hook disabled via YARD_FENCE_DISABLE")
+        warn("[yard/fence] prepare_for_yard disabled via YARD_FENCE_DISABLE")
         # :nocov:
       else
         Yard::Fence.clean_docs_directory
         Yard::Fence.prepare_tmp_files
       end
     rescue => e
-      warn("Yard::Fence: failed to prepare tmp/yard-fence files: #{e.class}: #{e.message}")
+      warn("Yard::Fence: failed to prepare for YARD: #{e.class}: #{e.message}")
+    end
+
+    # @deprecated Use prepare_for_yard instead. This method is kept for backward compatibility
+    #   but does nothing at load time. Call prepare_for_yard from a rake task.
+    def at_load_hook
+      # INTENTIONALLY EMPTY
+      # Previously this ran at load time, but that caused docs/ to be cleared
+      # during unrelated rake tasks like `build` and `release`.
+      # All preparation now happens via the yard:fence:prepare rake task.
+      nil
     end
   end
 
-  # Execute at load-time so files exist before YARD scans tmp/yard-fence/*.md
-  Yard::Fence.at_load_hook
+  # NOTE: at_load_hook is intentionally NOT called at load time.
+  # Use the yard:fence:prepare rake task instead.
+  # Yard::Fence.at_load_hook  # REMOVED - was causing docs/ to be cleared during `rake build`
 end
 
 # Extend the Version with VersionGem::Basic to provide semantic version helpers.
@@ -251,6 +265,20 @@ Yard::Fence::Version.class_eval do
   extend VersionGem::Basic
 end
 
+# Auto-register rake tasks when Rake is available.
+# This allows upgrading yard-fence to get the fix without also upgrading kettle-dev.
+# The rake task defines yard:fence:prepare which enhances the :yard task if it exists.
+# :nocov:
+if defined?(Rake::Task)
+  begin
+    require_relative "fence/rake_task"
+    Yard::Fence::RakeTask.new unless Rake::Task.task_defined?("yard:fence:prepare")
+  rescue LoadError
+    # Rake::TaskLib may not be available in all contexts
+  end
+end
+# :nocov:
+
 # :nocov:
 # Not checking coverage of the at_exit hook, because it would require a forked process.
 unless ENV["YARD_FENCE_SKIP_AT_EXIT"] == "1"

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: yard-fence
 version: !ruby/object:Gem::Version
-  version: 0.8.1
+  version: 0.8.2
 platform: ruby
 authors:
 - Peter H. Boling
@@ -328,6 +328,7 @@ files:
 - lib/yard/fence.rb
 - lib/yard/fence/hoist.rb
 - lib/yard/fence/kramdown_gfm_document.rb
+- lib/yard/fence/rake_task.rb
 - lib/yard/fence/version.rb
 - sig/kramdown.rbs
 - sig/yard/fence.rbs
@@ -336,10 +337,10 @@ licenses:
 - MIT
 metadata:
   homepage_uri: https://yard-fence.galtzo.com/
-  source_code_uri: https://github.com/galtzo-floss/yard-fence/tree/v0.8.1
-  changelog_uri: https://github.com/galtzo-floss/yard-fence/blob/v0.8.1/CHANGELOG.md
+  source_code_uri: https://github.com/galtzo-floss/yard-fence/tree/v0.8.2
+  changelog_uri: https://github.com/galtzo-floss/yard-fence/blob/v0.8.2/CHANGELOG.md
   bug_tracker_uri: https://github.com/galtzo-floss/yard-fence/issues
-  documentation_uri: https://www.rubydoc.info/gems/yard-fence/0.8.1
+  documentation_uri: https://www.rubydoc.info/gems/yard-fence/0.8.2
   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