Skip to content

🔖 Prepare release v1.0.0 #1

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
pboling merged 2 commits into from
Aug 22, 2025
Merged

🔖 Prepare release v1.0.0 #1

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
fd7da83
🔖 Prepare release v1.0.0
pboling Aug 22, 2025
8684cf3
🚨 Linting for Ruby 2.3
pboling Aug 22, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 0 additions & 15 deletions .rubocop_gradual.lock
View file
Open in desktop

This file was deleted.

2 changes: 1 addition & 1 deletion .yard_gfm_support.rb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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"},
)
9 changes: 7 additions & 2 deletions CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
12 changes: 6 additions & 6 deletions Gemfile.lock
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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)
Expand Down Expand Up @@ -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)
Expand All @@ -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)
Expand Down Expand Up @@ -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)
Expand All @@ -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)
Expand Down
8 changes: 4 additions & 4 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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)
Expand All @@ -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
Expand All @@ -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
Expand Down
58 changes: 29 additions & 29 deletions Rakefile
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down Expand Up @@ -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
Expand All @@ -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}"
Expand Down Expand Up @@ -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

Expand Down
14 changes: 7 additions & 7 deletions bin/prepare-commit-msg
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down Expand Up @@ -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)
Expand All @@ -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)
Expand Down Expand Up @@ -152,4 +152,4 @@ class GitCommitFooter
end
end

GitCommitFooter.render(ARGV)
GitCommitFooter.render(*ARGV)
2 changes: 1 addition & 1 deletion docs/Kettle.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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>
Expand Down
2 changes: 1 addition & 1 deletion docs/Kettle/Test.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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>
Expand Down
2 changes: 1 addition & 1 deletion docs/Kettle/Test/Error.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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>
Expand Down
4 changes: 2 additions & 2 deletions docs/Kettle/Test/Version.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -128,7 +128,7 @@ <h2>

</div>
</dt>
<dd><pre class="code"><span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>0.1.0</span><span class='tstring_end'>&quot;</span></span></pre></dd>
<dd><pre class="code"><span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>1.0.0</span><span class='tstring_end'>&quot;</span></span></pre></dd>

</dl>

Expand All @@ -144,7 +144,7 @@ <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>
Expand Down
2 changes: 1 addition & 1 deletion docs/_index.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -169,7 +169,7 @@ <h2>Namespace Listing A-Z</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>
Expand Down
14 changes: 11 additions & 3 deletions docs/file.CHANGELOG.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -78,16 +78,24 @@ <h2 id="100---2025-08-20">
</li>
<li>COVERAGE: 100.00% – 69/69 lines in 13 files</li>
<li>BRANCH COVERAGE: 100.00% – 2/2 branches in 13 files</li>
<li>23.53% documented
<li>94.44% documented
<h3 id="added-1">Added</h3>
</li>
<li>initial release</li>
<li>initial release, with auto-config support for:
<ul>
<li>rspec</li>
<li>rspec-block_is_expected</li>
<li>rspec-stubbed_env</li>
<li>silent_stream</li>
<li>timecop-rspec</li>
</ul>
</li>
</ul>

</div></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>
Expand Down
2 changes: 1 addition & 1 deletion docs/file.CITATION.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -82,7 +82,7 @@
</div></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>
Expand Down
2 changes: 1 addition & 1 deletion docs/file.CODE_OF_CONDUCT.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -191,7 +191,7 @@ <h2 id="attribution">Attribution</h2>
</div></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>
Expand Down
2 changes: 1 addition & 1 deletion docs/file.CONTRIBUTING.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -208,7 +208,7 @@ <h3 id="to-release-a-new-version">To release a new version:</h3>
</div></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>
Expand Down
2 changes: 1 addition & 1 deletion docs/file.LICENSE.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -60,7 +60,7 @@
<div id="content"><div id='filecontents'>The MIT License (MIT)<br><br>Copyright (c) 2023, 2025 Peter Boling<br><br>Permission is hereby granted, free of charge, to any person obtaining a copy<br>of this software and associated documentation files (the "Software"), to deal<br>in the Software without restriction, including without limitation the rights<br>to use, copy, modify, merge, publish, distribute, sublicense, and/or sell<br>copies of the Software, and to permit persons to whom the Software is<br>furnished to do so, subject to the following conditions:<br><br>The above copyright notice and this permission notice shall be included in<br>all copies or substantial portions of the Software.<br><br>THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR<br>IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,<br>FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE<br>AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER<br>LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,<br>OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN<br>THE SOFTWARE.</div></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>
Expand Down
2 changes: 1 addition & 1 deletion docs/file.README.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -655,7 +655,7 @@ <h2 id="-a-request-for-help">🤑 A request for help</h2>
</div></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>
Expand Down
2 changes: 1 addition & 1 deletion docs/file.REEK.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -61,7 +61,7 @@
</div></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>
Expand Down
2 changes: 1 addition & 1 deletion docs/file.RUBOCOP.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -161,7 +161,7 @@ <h2 id="benefits-of-rubocop_gradual">Benefits of rubocop_gradual</h2>
</div></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>
Expand Down
Loading
Loading