From db5818b97cb1544dd5cbda968636f0eea82ec40e Mon Sep 17 00:00:00 2001 From: Stan Lo Date: Sat, 29 Aug 2026 18:03:20 +0100 Subject: [PATCH] Add Darkfish deprecation warning Assisted-By: devx/0d67a386-6fea-4c9d-96ef-064c1cc8810c --- lib/rdoc/generator/darkfish.rb | 4 ++++ test/rdoc/generator/aliki_test.rb | 8 ++++++++ test/rdoc/generator/darkfish_test.rb | 8 ++++++++ 3 files changed, 20 insertions(+) diff --git a/lib/rdoc/generator/darkfish.rb b/lib/rdoc/generator/darkfish.rb index b728a3f973..27ad32ef4e 100644 --- a/lib/rdoc/generator/darkfish.rb +++ b/lib/rdoc/generator/darkfish.rb @@ -212,6 +212,10 @@ def write_style_sheet # objects containing the extracted information. def generate + if self.class == RDoc::Generator::Darkfish + warn "The Darkfish template is deprecated and will be removed in version 9.0." + end + setup write_style_sheet diff --git a/test/rdoc/generator/aliki_test.rb b/test/rdoc/generator/aliki_test.rb index 00054a5a90..f38f27d1dd 100644 --- a/test/rdoc/generator/aliki_test.rb +++ b/test/rdoc/generator/aliki_test.rb @@ -59,6 +59,14 @@ def teardown FileUtils.rm_rf @tmpdir end + def test_generate_does_not_warn_about_darkfish_deprecation + _, err = capture_output do + @g.generate + end + + assert_empty err + end + def test_inheritance_and_template_dir assert_kind_of RDoc::Generator::Darkfish, @g assert_match %r{/template/aliki\z}, @g.template_dir.to_s diff --git a/test/rdoc/generator/darkfish_test.rb b/test/rdoc/generator/darkfish_test.rb index 966a8f2d2e..9dbc64042c 100644 --- a/test/rdoc/generator/darkfish_test.rb +++ b/test/rdoc/generator/darkfish_test.rb @@ -69,6 +69,14 @@ def teardown FileUtils.rm_rf @tmpdir end + def test_generate_warns_about_deprecation + _, err = capture_output do + @g.generate + end + + assert_equal "The Darkfish template is deprecated and will be removed in version 9.0.\n", err + end + def test_generate top_level = @store.add_file 'file.rb' top_level.add_class @klass.class, @klass.name