kettle-dev 1.0.9 → 1.0.10

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 32a4bff14544feed4dc60644fe0bb8d0ed1a76cb1f49c0144c8f9748e23ea993
-  data.tar.gz: d574fb5dc72da3caf7ee83f64fb064606930d33df23ff6f9a6a907692a21fbe8
+  metadata.gz: 6e64251f36de1db3a3f0c71d1436758db8a13223b3a5740062a04fa169ae9875
+  data.tar.gz: afb492c0d27d008b779e426f081c0be491dff7616120115668468f9ff2c1872c
 SHA512:
-  metadata.gz: f68fef35d7bd888e0132e68e27cfcf31f18ba6098ecbccebeadab0cb4154f1fd12ce32fdce828a5699a18362893059ea4302224084a7446fb90b7a12aaee00b5
-  data.tar.gz: ac0dea1fca1ea03add3375fa9f8b884f5b57394d45db39c1b00caebe8bcb33f79a66b9d88ef020a4edc3b19d4630086625fda371522953a48f1f38c5994307af
+  metadata.gz: 0cc6afa5e3543bab0de8682f0d9a2d45df99a442e2253fe8f028ef190c59cb44710969b9f22e63c4ef4a0e604f96243b616589683ec6ff5d68273cfd2fe0ac40
+  data.tar.gz: 9d5253d1aac3f87db2e76ae013c16a5a71ebfd649f8bbaf882b74f90af2e5bdfe2c99cb6fbb9f83cc4efa094117d26dfd7e898d902fc0eb60a74559dca6f9af7

data/.envrc

@@ -1,6 +1,7 @@
 # Run any command in this library's bin/ without the bin/ prefix!
-PATH_add bin
+# Prefer exe version over binstub
 PATH_add exe
+PATH_add bin
 
 # Only add things to this file that should be shared with the team.
 
@@ -20,8 +21,8 @@ export K_SOUP_COV_DO=true # Means you want code coverage
 export K_SOUP_COV_COMMAND_NAME="Test Coverage"
 # Available formats are html, xml, rcov, lcov, json, tty
 export K_SOUP_COV_FORMATTERS="html,xml,rcov,lcov,json,tty"
-export K_SOUP_COV_MIN_BRANCH=96 # Means you want to enforce X% branch coverage
-export K_SOUP_COV_MIN_LINE=100 # Means you want to enforce X% line coverage
+export K_SOUP_COV_MIN_BRANCH=77 # Means you want to enforce X% branch coverage
+export K_SOUP_COV_MIN_LINE=97 # Means you want to enforce X% line coverage
 export K_SOUP_COV_MIN_HARD=true # Means you want the build to fail if the coverage thresholds are not met
 export K_SOUP_COV_MULTI_FORMATTERS=true
 export K_SOUP_COV_OPEN_BIN= # Means don't try to open coverage results in browser

data/.github/workflows/coverage.yml

@@ -7,8 +7,8 @@ permissions:
 
 env:
   # Lower than local, which is at 100/100, because rubocop-lts isn't installed in the coverage workflow
-  K_SOUP_COV_MIN_BRANCH: 90
-  K_SOUP_COV_MIN_LINE: 95
+  K_SOUP_COV_MIN_BRANCH: 72
+  K_SOUP_COV_MIN_LINE: 94
   K_SOUP_COV_MIN_HARD: true
   K_SOUP_COV_FORMATTERS: "xml,rcov,lcov,tty"
   K_SOUP_COV_DO: true
@@ -116,7 +116,7 @@ jobs:
           hide_complexity: true
           indicators: true
           output: both
-          thresholds: '95 90'
+          thresholds: '94 72'
         continue-on-error: ${{ matrix.experimental != 'false' }}
 
       - name: Add Coverage PR Comment

data/.junie/guidelines.md

@@ -120,13 +120,14 @@ This document captures project-specific knowledge to streamline setup, testing,
 
 Quick start
 1) bundle install
-2) K_SOUP_COV_FORMATTERS="xml,rcov,lcov,json" bin/rspec (generates coverage reports in coverage/ in the specified formats, only choose the formats you need)
-3) Optional local HTML coverage report: K_SOUP_COV_FORMATTERS="html" bin/rspec (generates HTML coverage report in coverage/ - but this is too verbose for AI, so Junie should use one of the more terse formats, like rcov, lcov, or json)
-4) Static analysis: bundle exec rake rubocop_gradual:check && bundle exec rake reek
+2) K_SOUP_COV_FORMATTERS="json" bin/rspec (generates a JSON coverage report with both line and branch data in coverage/. Use this single format.)
+3) Static analysis: bundle exec rake rubocop_gradual:check && bundle exec rake reek
 
 Notes
 - ALWAYS Run bundle exec rake rubocop_gradual:autocorrect as the final step before completing a task, to lint and autocorrect any remaining issues. Then if there are new lint failures, attempt to correct them manually.
 - NEVER run vanilla rubocop, as it won't handle the linting config properly. Always run rubocop_gradual:autocorrect or rubocop_gradual.
 - Running only a subset of specs is supported but in order to bypass the hard failure due to coverage thresholds, you need to run with K_SOUP_COV_MIN_HARD=false.
 - When adding code that writes to STDOUT, remember most specs silence output unless tagged with :check_output or DEBUG=true.
+- Coverage reports: NEVER review the HTML report. Use JSON (preferred), XML, LCOV, or RCOV. For this project, always run tests with K_SOUP_COV_FORMATTERS set to "json".
+- Do NOT modify .envrc in tasks; when running tests locally or in scripts, manually prefix each run, e.g.: K_SOUP_COV_FORMATTERS="json" bin/rspec
 - For all the kettle-soup-cover options, see .envrc and find the K_SOUP_COV_* env vars.

data/.simplecov

@@ -4,4 +4,8 @@ require "kettle/soup/cover/config"
 # It is controlled by ENV variables, which are set in .envrc and loaded via `direnv allow`
 # If the values for minimum coverage need to change, they should be changed both there,
 #   and in 2 places in .github/workflows/coverage.yml.
-SimpleCov.start
+SimpleCov.start do
+  track_files "lib/**/*.rb"
+  track_files "lib/**/*.rake"
+  track_files "exe/*.rb"
+end

data/Appraisals

@@ -79,12 +79,15 @@ appraise "ruby-3-0" do
 end
 
 appraise "ruby-3-1" do
+  # all versions of git gem are incompatible with truffleruby v23.0, syntactically.
   gem "erb"
   gem "mutex_m", "~> 0.2"
   gem "stringio", "~> 3.0"
 end
 
 appraise "ruby-3-2" do
+  # all versions of git gem are incompatible with truffleruby v23.1, syntactically.
+  gem "git", "< 3"
   gem "erb"
   gem "mutex_m", "~> 0.2"
   gem "stringio", "~> 3.0"

data/CHANGELOG.md

@@ -24,6 +24,25 @@ Please file a bug if you notice a violation of semantic versioning.
 ### Fixed
 ### Security
 
+## [1.0.10] - 2025-08-24
+- TAG: [v1.0.10][1.0.10t]
+- COVERAGE:  97.68% -- 1685/1725 lines in 17 files
+- BRANCH COVERAGE:  77.54% -- 618/797 branches in 17 files- 95.35% documented
+- 77.00% documented
+### Added
+- runs git add --all before git commit, to ensure all files are committed.
+### Changed
+- This gem is now loaded via Ruby's standard `autoload` feature.
+- Bundler is always expected, and most things probably won't work without it.
+- exe/ scripts and rake tasks logic is all now moved into classes for testability, and is nearly fully covered by tests.
+- New Kettle::Dev::GitAdapter class is an adapter pattern wrapper for git commands
+- New Kettle::Dev::ExitAdapter class is an adapter pattern wrapper for Kernel.exit and Kernel.abort within this codebase.
+### Removed
+- attempts to make exe/* scripts work without bundler. Bundler is required.
+### Fixed
+- `Kettle::Dev::ReleaseCLI#detect_version` handles gems with multiple VERSION constants
+- `kettle:dev:template` task was fixed to copy `.example` files with the destination filename lacking the `.example` extension, except for `.env.local.example`
+
 ## [1.0.9] - 2025-08-24
 - TAG: [v1.0.9][1.0.9t]
 - COVERAGE: 100.00% -- 130/130 lines in 7 files
@@ -140,7 +159,9 @@ Please file a bug if you notice a violation of semantic versioning.
   - Selecting will run the selected workflow via `act`
   - This may move to its own gem in the future.
 
-[Unreleased]: https://gitlab.com/kettle-rb/kettle-dev/-/compare/v1.0.9...HEAD
+[Unreleased]: https://gitlab.com/kettle-rb/kettle-dev/-/compare/v1.0.10...HEAD
+[1.0.10]: https://gitlab.com/kettle-rb/kettle-dev/-/compare/v1.0.9...v1.0.10
+[1.0.10t]: https://gitlab.com/kettle-rb/kettle-dev/-/tags/v1.0.10
 [1.0.9]: https://gitlab.com/kettle-rb/kettle-dev/-/compare/v1.0.8...v1.0.9
 [1.0.9t]: https://gitlab.com/kettle-rb/kettle-dev/-/tags/v1.0.9
 [1.0.8]: https://gitlab.com/kettle-rb/kettle-dev/-/compare/v1.0.7...v1.0.8

data/CONTRIBUTING.md

@@ -51,6 +51,12 @@ To run all tests
 bundle exec rake test
 ```
 
+### Spec organization (required)
+
+- For each class or module under `lib/`, keep all of its unit tests in a single spec file under `spec/` that mirrors the path and file name (e.g., specs for `lib/kettle/dev/release_cli.rb` live in `spec/kettle/dev/release_cli_spec.rb`).
+- Do not create ad-hoc "_more" or split spec files for the same class/module. Consolidate all unit tests into the main spec file for that class/module.
+- Only integration scenarios that intentionally span multiple classes belong in `spec/integration/`.
+
 ## Lint It
 
 Run all the default tasks, which includes running the gradually autocorrecting linter, `rubocop-gradual`.

data/README.md

@@ -21,11 +21,16 @@ OTOH, if `ci_badges.map(&:color).all? { it == "green"}` 👇️ send money so I
 
 ## 🌻 Synopsis
 
-Add to your `Rakefile`:
+This gem integrates tightly with [kettle-test](https://github.com/kettle-rb/kettle-test).
+
+```ruby
+require "kettle/test/rspec"
+```
+
+Then, add to your `Rakefile`:
 
 ```ruby
 require "kettle/dev"
-Kettle::Dev.install_tasks
 ```
 
 Now you have many powerful development and testing tools at your disposal, all fully [documented](#-configuration) and tested.
@@ -136,11 +141,20 @@ NOTE: Be prepared to track down certs for signed gems and add them the same way
 
 ## ⚙️ Configuration
 
+### RSpec
+
+This gem integrates tightly with [kettle-test](https://github.com/kettle-rb/kettle-test).
+
+```ruby
+require "kettle/test/rspec"
+```
+
+### Rakefile
+
 Add to your `Rakefile`:
 
 ```ruby
 require "kettle/dev"
-Kettle::Dev.install_tasks
 ```
 
 That’s it. When installed, kettle-dev:
@@ -288,7 +302,6 @@ Tip: The commit message helper `exe/kettle-commit-msg` prefers project-local `.g
     - Note: When used with the provided `.git-hooks`, the subject should start with a gitmoji character (see [gitmoji][📌gitmoji]).
 - Tip: Run this locally before committing to keep your README current, or schedule it in CI to refresh periodically.
 
-
 ## 🦷 FLOSS Funding
 
 While kettle-rb tools are free software and will always be, the project would benefit immensely from some funding.
@@ -646,7 +659,7 @@ Thanks for RTFM. ☺️
 [📌gitmoji]:https://gitmoji.dev
 [📌gitmoji-img]:https://img.shields.io/badge/gitmoji_commits-%20😜%20😍-34495e.svg?style=flat-square
 [🧮kloc]: https://www.youtube.com/watch?v=dQw4w9WgXcQ
-[🧮kloc-img]: https://img.shields.io/badge/KLOC-0.130-FFDD67.svg?style=for-the-badge&logo=YouTube&logoColor=blue
+[🧮kloc-img]: https://img.shields.io/badge/KLOC-1.725-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/Rakefile

@@ -50,6 +50,12 @@
 # External gems
 require "bundler/gem_tasks" if !Dir[File.join(__dir__, "*.gemspec")].empty?
 
+# Define a base default task early so other files can enhance it.
+desc "Default tasks aggregator"
+task :default do
+  puts "Default task complete."
+end
+
 # Detect if the invoked task is spec/test to avoid eagerly requiring the library,
 # which would load code before SimpleCov can start (when running `rake spec`).
 invoked_tasks = Rake.application.top_level_tasks
@@ -67,22 +73,12 @@ if running_specs
     # If rspec isn't available, let it fail when the task is invoked
   end
 else
-  require "kettle/dev"
-
-  # Define a base default task early so other files can enhance it.
-  desc "Default tasks aggregator"
-  task :default do
-    puts "Default task complete."
-  end
-
-  Kettle::Dev.install_tasks
+  require "kettle-dev"
 
   ### RELEASE TASKS
   # Setup stone_checksums
   begin
     require "stone_checksums"
-
-    GemChecksums.install_tasks
   rescue LoadError
     desc("(stub) build:generate_checksums is unavailable")
     task("build:generate_checksums") do

data/exe/kettle-commit-msg

@@ -1,16 +1,18 @@
 #!/usr/bin/env ruby
+# frozen_string_literal: true
+
 # vim: set syntax=ruby
 
-require "rubygems"
-begin
-  require "bundler/setup"
-rescue LoadError
-  # Allow running outside of Bundler; runtime deps should still be available via rubygems
-end
+# Immediate, unbuffered output
+$stdout.sync = true
+# Depending library or project must be using bundler
+require "bundler/setup"
 
 # Standard library
 require "erb"
 
+require "kettle/dev"
+
 # ENV variable control (set in .envrc, or .env.local)
 # BRANCH_RULE_TYPE = jira, or another type of branch rule validation, or false to disable
 # FOOTER_APPEND = true/false append commit message footer
@@ -48,140 +50,4 @@ else
   # puts "No branch rule configured (set GIT_HOOK_BRANCH_VALIDATE=jira to enforce rules for jira style branch names)"
 end
 
-class GitCommitFooter
-  # Prefer project-local .git-hooks (repo root), then fallback to global ~/.git-hooks
-  NAME_ASSIGNMENT_REGEX = /\bname\s*=\s*(["'])([^"']+)\1/.freeze
-  FOOTER_APPEND = ENV.fetch("GIT_HOOK_FOOTER_APPEND", "false").casecmp("true").zero?
-  SENTINEL = ENV["GIT_HOOK_FOOTER_SENTINEL"] # No default to avoid accidental duplicate commit of a footer via ammended commits
-  raise "Set GIT_HOOK_FOOTER_SENTINEL=<footer sentinel> in .env.local (e.g., '⚡️ A message from a fellow meat-based-AI ⚡️')" if FOOTER_APPEND && (SENTINEL.nil? || SENTINEL.to_s.empty?)
-
-  class << self
-    def git_toplevel
-      toplevel = nil
-      begin
-        # 'git rev-parse --show-toplevel' returns the repo root when run anywhere inside the repo
-        out = %x(git rev-parse --show-toplevel 2>/dev/null)
-        toplevel = out.strip unless out.nil? || out.empty?
-      rescue StandardError
-        # ignore
-      end
-      toplevel
-    end
-
-    def local_hooks_dir
-      top = git_toplevel
-      return unless top && !top.empty?
-      File.join(top, ".git-hooks")
-    end
-
-    def global_hooks_dir
-      File.join(ENV["HOME"], ".git-hooks")
-    end
-
-    def hooks_path_for(filename)
-      local_dir = local_hooks_dir
-      if local_dir
-        local_path = File.join(local_dir, filename)
-        return local_path if File.file?(local_path)
-      end
-      File.join(global_hooks_dir, filename)
-    end
-
-    def commit_goalie_path
-      hooks_path_for("commit-subjects-goalie.txt")
-    end
-
-    # Determine whether the commit subject allows footer append, based on optional goalie file
-    # ~/.git-hooks/commit-subjects-goalie.txt
-    # - If present, only allow appending when the first line of the commit message starts with one of the non-commented prefixes
-    # - If absent, disallow footer
-    def goalie_allows_footer?(subject_line)
-      goalie_path = commit_goalie_path
-      return false unless File.file?(goalie_path)
-
-      prefixes = File.read(goalie_path).lines.map { |l| l.strip }.reject { |l| l.empty? || l.start_with?("#") }
-      # If the file exists but has no usable lines, treat as deny-all per goalie intent
-      return false if prefixes.empty?
-
-      subj = subject_line.to_s.strip
-      prefixes.any? { |prefix| subj.start_with?(prefix) }
-    end
-
-    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)
-        if commit_msg.include?(GitCommitFooter::SENTINEL)
-          # This is a commit message that has already been appended
-          # This will happen if the commit message is edited and re-committed
-          # puts "FOOTER_APPEND is true, skipping footer append"
-          exit(0)
-        else
-          footer_binding = GitCommitFooter.new
-          # Append footer to the commit message
-          File.open(argv[0], "w") do |file|
-            file.print(commit_msg)
-            file.print("\n")
-            file.print(footer_binding.render)
-          end
-        end
-      else
-        # Skipping footer append (either FOOTER_APPEND is false, or goalie did not allow it)
-      end
-    end
-  end
-
-  def initialize
-    @pwd = Dir.pwd
-    @gemspecs = Dir["*.gemspec"]
-    @spec = @gemspecs.first
-    @gemspec_path = File.expand_path(@spec, @pwd)
-    @gem_name = parse_gemspec_name || derive_gem_name
-  end
-
-  # Render ERB with binding variables
-  def render
-    ERB.new(template).result(binding)
-  end
-
-  private
-
-  # Lightweight parse for gem name to avoid full Gem::Specification load
-  def parse_gemspec_name
-    begin
-      content = File.read(@gemspec_path)
-      # Look for name assignment patterns like:
-      #   spec.name = "my_gem" OR Gem::Specification.new do |spec|; spec.name = 'my_gem'
-      @name_index = content =~ NAME_ASSIGNMENT_REGEX
-      if @name_index
-        return $2
-      end
-    rescue StandardError
-      # fall through
-    end
-    nil
-  end
-
-  # No-parse derivation of gem name, when parsing gemspec fails
-  def derive_gem_name
-    File.basename(@gemspec_path, ".*") if @gemspec_path
-  end
-
-  # Example
-  #
-  #     ⚡️ A message from a fellow meat-based-AI ⚡️
-  #     I ❤️ working on <%= @gem_name %>.
-  #
-  # The first line is the footer sentinel (which does appear in the commit).
-  # The second line, and any additional, is the main body of the footer.
-  #
-  # The sentinel must be set in an ENV variable (e.g., in your .env.local file):
-  #
-  #   export GIT_HOOK_FOOTER_SENTINEL="⚡️ A message from a fellow meat-based-AI ⚡️"
-  #
-  def template
-    File.read(self.class.hooks_path_for("footer-template.erb.txt"))
-  end
-end
-
-GitCommitFooter.render(*ARGV)
+Kettle::Dev::GitCommitFooter.render(*ARGV)