Merge pull request #1 from kettle-rb/release-prep

Author: pboling

.rubocop_gradual.lock

@@ -18,5 +18,5 @@ def initialize(source, options = {})
 # - https://github.com/lsegal/yard/blob/main/lib/yard/templates/helpers/markup_helper.rb
 YARD::Templates::Helpers::MarkupHelper::MARKUP_PROVIDERS[:markdown].insert(
   0,
-  {:const => "KramdownGfmDocument"},
+  {const: "KramdownGfmDocument"},
 )

.yard_gfm_support.rb

@@ -16,9 +16,14 @@ and this project adheres to [Semantic Versioning v2](https://semver.org/spec/v2.
 - TAG: [v1.0.0][1.0.0t]
 - COVERAGE: 100.00% -- 69/69 lines in 13 files
 - BRANCH COVERAGE: 100.00% -- 2/2 branches in 13 files
-- 23.53% documented
+- 94.44% documented
 ### Added
-- initial release
+- initial release, with auto-config support for:
+  - rspec
+  - rspec-block_is_expected
+  - rspec-stubbed_env
+  - silent_stream
+  - timecop-rspec
 
 [Unreleased]: https://gitlab.com/kettle-rb/kettle-test/-/compare/v1.0.0...HEAD
 [1.0.0]: https://gitlab.com/kettle-rb/kettle-test/-/compare/baed02cf1ca1e0e8c75c11fd188edaf1a4f5f08b...v1.0.0

CHANGELOG.md

@@ -13,7 +13,7 @@ GIT
 PATH
   remote: .
   specs:
-    kettle-test (0.1.0)
+    kettle-test (1.0.0)
       appraisal2 (~> 3.0)
       rspec (~> 3.0)
       rspec-block_is_expected (~> 1.0, >= 1.0.6)
@@ -190,8 +190,8 @@ GEM
       parallel (~> 1.10)
       rainbow (>= 2.2.2, < 4.0)
       rubocop (~> 1.0)
-    rubocop-lts (0.1.1)
-      rubocop-ruby1_8 (>= 1.0.5, < 2)
+    rubocop-lts (10.1.1)
+      rubocop-ruby2_3 (>= 2.0.3, < 3)
       standard-rubocop-lts (>= 1.0.3, < 3)
       version_gem (>= 1.1.2, < 3)
     rubocop-md (1.2.4)
@@ -209,7 +209,7 @@ GEM
     rubocop-rspec (3.6.0)
       lint_roller (~> 1.1)
       rubocop (~> 1.72, >= 1.72.1)
-    rubocop-ruby1_8 (1.0.7)
+    rubocop-ruby2_3 (2.0.5)
       rubocop-gradual (~> 0.3, >= 0.3.1)
       rubocop-md (~> 1.2)
       rubocop-rake (~> 0.6)
@@ -297,7 +297,7 @@ DEPENDENCIES
   debug (>= 1.0.0)
   gem_bench (~> 2.0, >= 2.0.5)
   gitmoji-regex (~> 1.0, >= 1.0.3)
-  kettle-soup-cover (~> 1.0, >= 1.0.6)
+  kettle-soup-cover (~> 1.0, >= 1.0.10)
   kettle-test!
   kramdown (~> 2.5, >= 2.5.1)
   kramdown-parser-gfm (~> 1.1)
@@ -306,7 +306,7 @@ DEPENDENCIES
   rdoc (~> 6.11)
   reek (~> 6.4)
   rubocop (~> 1.73, >= 1.73.2)
-  rubocop-lts (~> 0.1, >= 0.1.1)
+  rubocop-lts (~> 10.1, >= 10.1.1)
   rubocop-packaging (~> 0.6, >= 0.6.0)
   rubocop-rspec (~> 3.2)
   standard (>= 1.50)

Gemfile.lock

@@ -247,14 +247,14 @@ Timecop.travel/freeze any RSpec (describe|context|example) with
 
 ```ruby
 # Timecop.travel
-it "some description", :travel => Time.new(2014, 11, 15) do
+it "some description", travel: Time.new(2014, 11, 15) do
   Time.now # 2014-11-15 00:00:00
   sleep 6
   Time.now # 2014-11-15 00:00:06 (6 seconds later)
 end
 
 # Timecop.freeze
-it "some description", :freeze => Time.new(2014, 11, 15) do
+it "some description", freeze: Time.new(2014, 11, 15) do
   Time.now # 2014-11-15 00:00:00
   sleep 6
   Time.now # 2014-11-15 00:00:00 (Ruby's time hasn't advanced)
@@ -265,7 +265,7 @@ Following spec's local travel will resume when specified time is the same as the
 previous examples specified time. If the time is different, it will
 start from the current examples specified time.
 ```ruby
-describe SomeUnit, :travel => Time.new(2014, 11, 15) do
+describe SomeUnit, travel: Time.new(2014, 11, 15) do
   it "example 1" do
     Time.now # => 2014-11-15 00:00:00
     sleep 6
@@ -275,7 +275,7 @@ describe SomeUnit, :travel => Time.new(2014, 11, 15) do
     Time.now # => 2014-11-15 00:00:06 (resumed from end of previous example)
   end
 
-  it "example 3", :travel => Time.new(1982, 6, 16) do
+  it "example 3", travel: Time.new(1982, 6, 16) do
     Time.now # => 1982-06-16 00:00:00
   end
 end

README.md

@@ -349,10 +349,10 @@ namespace :ci do
 
     # Determine actual workflow files present, and prepare dynamic additions excluding specified files.
     existing_files = if Dir.exist?(workflows_dir)
-                       Dir[File.join(workflows_dir, "*.yml")] + Dir[File.join(workflows_dir, "*.yaml")]
-                     else
-                       []
-                     end
+      Dir[File.join(workflows_dir, "*.yml")] + Dir[File.join(workflows_dir, "*.yaml")]
+    else
+      []
+    end
     existing_basenames = existing_files.map { |p| File.basename(p) }
 
     # Reduce mapping choices to only those with a corresponding workflow file
@@ -456,11 +456,11 @@ namespace :ci do
         st = run["status"]
         con = run["conclusion"]
         emoji = case st
-                when "queued" then "⏳️"
-                when "in_progress" then "👟"
-                when "completed" then ((con == "success") ? "✅" : "🍅")
-                else "⏳️"
-                end
+        when "queued" then "⏳️"
+        when "in_progress" then "👟"
+        when "completed" then ((con == "success") ? "✅" : "🍅")
+        else "⏳️"
+        end
         details = [st, con].compact.join("/")
         [c, f, "#{emoji} (#{details})#{append}"]
       else
@@ -471,22 +471,22 @@ namespace :ci do
     if choice && !choice.empty?
       # If user passed a filename directly (with or without extension), resolve it
       file = if mapping.key?(choice)
-               mapping.fetch(choice)
-             elsif !!(/\.(yml|yaml)\z/ =~ choice)
-               # Accept either full basename (without ext) or basename with .yml/.yaml
-               choice
-             else
-               cand_yml = File.join(workflows_dir, "#{choice}.yml")
-               cand_yaml = File.join(workflows_dir, "#{choice}.yaml")
-               if File.file?(cand_yml)
-                 "#{choice}.yml"
-               elsif File.file?(cand_yaml)
-                 "#{choice}.yaml"
-               else
-                 # Fall back to .yml for error messaging; will fail below
-                 "#{choice}.yml"
-               end
-             end
+        mapping.fetch(choice)
+      elsif !!(/\.(yml|yaml)\z/ =~ choice)
+        # Accept either full basename (without ext) or basename with .yml/.yaml
+        choice
+      else
+        cand_yml = File.join(workflows_dir, "#{choice}.yml")
+        cand_yaml = File.join(workflows_dir, "#{choice}.yaml")
+        if File.file?(cand_yml)
+          "#{choice}.yml"
+        elsif File.file?(cand_yaml)
+          "#{choice}.yaml"
+        else
+          # Fall back to .yml for error messaging; will fail below
+          "#{choice}.yml"
+        end
+      end
       file_path = File.join(workflows_dir, file)
       unless File.file?(file_path)
         puts "Unknown option or missing workflow file: #{choice} -> #{file}"
@@ -591,10 +591,10 @@ namespace :ci do
       # Check for user input first (non-blocking)
       unless input_q.empty?
         selected = begin
-                     input_q.pop(true)
-                   rescue
-                     nil
-                   end
+          input_q.pop(true)
+        rescue
+          nil
+        end
         break if selected
       end
 

Rakefile

@@ -33,10 +33,10 @@ if (branch_rule = BRANCH_RULES[BRANCH_RULE_TYPE])
   if !match_data.nil?
     commit_msg = File.read(ARGV[0])
     unless commit_msg.include?(match_data[:story_id])
-      commit_msg = <<EOS
-#{commit_msg.strip}
-[#{match_data[:story_type]}][#{match_data[:story_id]}]
-EOS
+      commit_msg = <<~EOS
+        #{commit_msg.strip}
+        [#{match_data[:story_type]}][#{match_data[:story_id]}]
+      EOS
       File.open(ARGV[0], "w") do |file|
         file.print(commit_msg)
       end
@@ -75,7 +75,7 @@ class GitCommitFooter
       prefixes.any? { |prefix| subj.start_with?(prefix) }
     end
 
-    def render(argv)
+    def render(*argv)
       commit_msg = File.read(argv[0])
       subject_line = commit_msg.lines.first.to_s
       if GitCommitFooter::FOOTER_APPEND && goalie_allows_footer?(subject_line)
@@ -85,7 +85,7 @@ class GitCommitFooter
           # puts "FOOTER_APPEND is true, skipping footer append"
           exit(0)
         else
-          footer_binding = GitCommitFooter.new(argv[0])
+          footer_binding = GitCommitFooter.new
           # Append footer to the commit message
           File.open(argv[0], "w") do |file|
             file.print(commit_msg)
@@ -152,4 +152,4 @@ class GitCommitFooter
   end
 end
 
-GitCommitFooter.render(ARGV)
+GitCommitFooter.render(*ARGV)

bin/prepare-commit-msg

@@ -107,7 +107,7 @@ <h2>Defined Under Namespace</h2>
 </div>
 
       <div id="footer">
-  Generated on Thu Aug 21 22:14:22 2025 by
+  Generated on Thu Aug 21 22:50:43 2025 by
   <a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
   0.9.37 (ruby-3.4.5).
 </div>

docs/Kettle.html

@@ -616,7 +616,7 @@ <h3 class="signature first" id="is_parallel_test?-class_method">
 </div>
 
       <div id="footer">
-  Generated on Thu Aug 21 22:14:22 2025 by
+  Generated on Thu Aug 21 22:50:43 2025 by
   <a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
   0.9.37 (ruby-3.4.5).
 </div>

docs/Kettle/Test.html

@@ -124,7 +124,7 @@ <h2>Overview</h2><div class="docstring">
 </div>
 
       <div id="footer">
-  Generated on Thu Aug 21 22:14:22 2025 by
+  Generated on Thu Aug 21 22:50:43 2025 by
   <a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
   0.9.37 (ruby-3.4.5).
 </div>