kettle-dev 1.2.1 → 1.2.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: cf48cdba2c3cbe1c95eab4c61a4073f7849fda6b7dbc41ec2dedaca59b414242
-  data.tar.gz: 171598b7227ced01474c97a14a8167d3c6c64785b08daeb6996e64d1ed42973d
+  metadata.gz: cc18821059e69cb633ba8dbde14b8edf85b999738d86044c5df905f82a203bab
+  data.tar.gz: b534a2bf911e1a6ff8618209caebb93fbad634e647a454344ccc4221a5a58b1f
 SHA512:
-  metadata.gz: 224a2b34db6d14760ae6105eb67407baebb25a67d7ac1ccad37eaa01823278d3d6c68e6822430f47d986c756f232ce637df248184ec61ca7a4394df3c4ced4c8
-  data.tar.gz: f8d133803fdbcf798e05faf1749a3e03efc539d5513142bbe76da9b3954662cf043ae868b79151c0c1cb84129f15b4e3e3af7a9764e301d14134fa352ba38ff5
+  metadata.gz: 3978928d9ef6fda478251deda2c79818bc645bff3b6150e44e4b2a8ebbf13c49de8a676d76eb8ff0795d3c93c7a326c5fa153562f8ac9a93f95e083e2d077723
+  data.tar.gz: 3686018133d386691fefdab49fa10e7dea1c4a4ae65e2486cd161091a0d98e7e2b76721b9f45edc536763dfa8d2f1dbc97bcc83f90a39d1149f8c414873ed02a

checksums.yaml.gz.sig

@@ -1,2 +1,2 @@
-YGZ�ܧ*٫e�.ڴ��C��G�7���QMhz�G��o����7v��<^�x��g�|2��������I@ -N�9pG}��D�^��ӓU���F�nA�|3oރ���苊E�
-Z�ff�^v���hP�xvD���ޓ���HV�~60-6���h��UM��/q�o0}�dy+���k��3����񿡤�tr:��t��$�u����%`���{�`z!XBG+�$[��z��_�Y</l�3���)�X�;	�c����U=��l$��a��<O0��q��۠�U�nr�f�1y����J޸ �V� ���T񾹈7�T���=�O��
+-����g*�y��aʨ��n]}�
+���3�#���U4f�����ٖ�Q{�m߇��E�v����J�������9&4m��n��Q>t���ȋ�������5��G�����C��3��9�iS�ð��:;����!<�e)�H��۲=˄4q2�P��E���+���^��w�W�Z�ų�$m�I[��%��2�5lZL!�o߹�Z����v�{�T�]�K����Mw�Č�۠j�r�%�'����hr���8��p��;޴��VG{Se��6�,p޲gx���S�u݋�U�?�^�t3S��*PN[>��qb��y�<���$�����de�N�L
y��CQh_�������D�n2	!0�J����^�IL(Z

data/CHANGELOG.md

@@ -20,13 +20,6 @@ Please file a bug if you notice a violation of semantic versioning.
 
 ### Added
 
-- Prism AST-based manipulation of ruby during templating
-  - Gemfiles
-  - gemspecs
-  - .simplecov
-- Stop rescuing Exception in certain scenarios (just StandardError)
-- Refactored logging logic and documentation
-
 ### Changed
 
 ### Deprecated
@@ -37,6 +30,27 @@ Please file a bug if you notice a violation of semantic versioning.
 
 ### Security
 
+## [1.2.2] - 2025-11-27
+
+- TAG: [v1.2.2][1.2.2t]
+- COVERAGE: 93.28% -- 4596/4927 lines in 31 files
+- BRANCH COVERAGE: 76.45% -- 1883/2463 branches in 31 files
+- 70.00% documented
+
+### Added
+
+- Prism AST-based manipulation of ruby during templating
+  - Gemfiles
+  - gemspecs
+  - .simplecov
+- Stop rescuing Exception in certain scenarios (just StandardError)
+- Refactored logging logic and documentation
+- Prevent self-referential gemfile injection
+  - in Gemfiles, gemspecs, and Appraisals
+- Improve reliability of coverage and documentation stats
+  - in the changelog version heading
+  - fails hard when unable to generate stats, unless `--no-strict` provided
+
 ## [1.2.1] - 2025-11-25
 
 - TAG: [v1.2.0][1.2.0t]
@@ -1477,7 +1491,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://github.com/kettle-rb/kettle-dev/compare/v1.2.0...HEAD
+[Unreleased]: https://github.com/kettle-rb/kettle-dev/compare/v1.2.2...HEAD
+[1.2.2]: https://github.com/kettle-rb/kettle-dev/compare/v1.2.1...v1.2.2
+[1.2.2t]: https://github.com/kettle-rb/kettle-dev/releases/tag/v1.2.2
 [1.2.0]: https://github.com/kettle-rb/kettle-dev/compare/v1.1.60...v1.2.0
 [1.2.0t]: https://github.com/kettle-rb/kettle-dev/releases/tag/v1.2.0
 [1.1.60]: https://github.com/kettle-rb/kettle-dev/compare/v1.1.59...v1.1.60

data/README.md

@@ -1026,7 +1026,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-4.308-FFDD67.svg?style=for-the-badge&logo=YouTube&logoColor=blue
+[🧮kloc-img]: https://img.shields.io/badge/KLOC-4.927-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/README.md.example

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

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-# kettle-dev Rakefile v1.2.1 - 2025-11-26
+# kettle-dev Rakefile v1.2.2 - 2025-11-27
 # Ruby 2.3 (Safe Navigation) or higher required
 #
 # MIT License (see License.txt)

data/exe/kettle-changelog

@@ -50,22 +50,37 @@ end
 begin
   if ARGV.include?("-h") || ARGV.include?("--help")
     puts <<~USAGE
-      Usage: kettle-changelog
+      Usage: kettle-changelog [--no-strict]
 
       Generates a new CHANGELOG.md entry for the current version detected from lib/**/version.rb.
       Moves entries from [Unreleased] into the new section, adds coverage and documentation stats,
       and updates bottom link references to GitHub style, adding new compare/tag links.
 
+      Options:
+        --no-strict               Allow missing coverage and yard data (warnings only, no errors)
+
+      Environment:
+        K_CHANGELOG_STRICT=false  Disable strict mode (equivalent to --no-strict flag)
+
       Prerequisites:
-        - coverage/coverage.json present (run: K_SOUP_COV_FORMATTERS="json" bin/rspec)
+        - coverage/coverage.json present (run: bin/rake coverage to generate)
         - yard installed and available via bin/yard
+
+      By default (strict mode), if coverage.json or yard stats are missing, the script will:
+        1. Attempt to generate them by running bin/rake coverage and bin/rake yard
+        2. Fail with an error if generation fails or data is still unavailable
+
+      Use --no-strict or K_CHANGELOG_STRICT=false to allow missing data (backward compatible behavior).
     USAGE
     exit(0)
   end
 end
 
 begin
-  Kettle::Dev::ChangelogCLI.new.run
+  # Determine if strict mode is enabled (default: true)
+  strict_mode = !ARGV.include?("--no-strict") && ENV.fetch("K_CHANGELOG_STRICT", "true").downcase != "false"
+
+  Kettle::Dev::ChangelogCLI.new(strict: strict_mode).run
 rescue LoadError => e
   warn("#{script_basename}: could not load dependency: #{e.class}: #{e.message}")
   warn(e.backtrace.join("\n")) if ENV["DEBUG"]

data/lib/kettle/dev/changelog_cli.rb

@@ -1,5 +1,7 @@
 # frozen_string_literal: true
 
+require "open3"
+
 module Kettle
   module Dev
     # CLI for updating CHANGELOG.md with new version sections
@@ -11,10 +13,12 @@ module Kettle
 
       # Initialize the changelog CLI
       # Sets up paths for CHANGELOG.md and coverage.json
-      def initialize
+      # @param strict [Boolean] when true (default), require coverage and yard data; raise errors if unavailable
+      def initialize(strict: true)
         @root = Kettle::Dev::CIHelpers.project_root
         @changelog_path = File.join(@root, "CHANGELOG.md")
         @coverage_path = File.join(@root, "coverage", "coverage.json")
+        @strict = strict
       end
 
       # Main entry point to update CHANGELOG.md
@@ -215,11 +219,49 @@ module Kettle
       end
 
       def coverage_lines
-        unless File.file?(@coverage_path)
-          warn("Coverage JSON not found at #{@coverage_path}.")
-          warn("Run: K_SOUP_COV_FORMATTERS=\"json\" bin/rspec")
-          return [nil, nil]
+        if @strict
+          # Always generate fresh coverage data in strict mode
+          # Delete old coverage files to ensure we get current data
+          coverage_dir = File.dirname(@coverage_path)
+          if Dir.exist?(coverage_dir)
+            puts "Cleaning old coverage data from #{coverage_dir}..."
+            Dir.glob(File.join(coverage_dir, "*")).each do |file|
+              File.delete(file) if File.file?(file)
+            end
+          end
+
+          puts "Generating fresh coverage data by running: bin/rake coverage"
+
+          # Run bin/rake coverage to generate coverage.json
+          rake_cmd = File.join(@root, "bin", "rake")
+          unless File.executable?(rake_cmd)
+            raise "bin/rake not found or not executable; cannot generate coverage data"
+          end
+
+          # Run the command exactly as the user would run it manually
+          # The coverage task knows how to configure itself properly
+          success = system(rake_cmd, "coverage", chdir: @root)
+
+          unless success
+            raise "bin/rake coverage failed with exit status #{$?.exitstatus || "unknown"}"
+          end
+
+          puts "Coverage generation complete."
+
+          # Check if coverage.json was generated
+          unless File.file?(@coverage_path)
+            raise "Coverage JSON not found at #{@coverage_path} after running bin/rake coverage"
+          end
+        else
+          # Non-strict mode: check if coverage.json exists, warn if not
+          unless File.file?(@coverage_path)
+            warn("Coverage JSON not found at #{@coverage_path}.")
+            warn("Run: bin/rake coverage to generate it")
+            return [nil, nil]
+          end
         end
+
+        # Parse the coverage data
         data = JSON.parse(File.read(@coverage_path))
         files = data["coverage"] || {}
         file_count = 0
@@ -252,31 +294,55 @@ module Kettle
         line_str = format("COVERAGE: %.2f%% -- %d/%d lines in %d files", line_pct, covered_lines, total_lines, file_count)
         branch_str = format("BRANCH COVERAGE: %.2f%% -- %d/%d branches in %d files", branch_pct, covered_branches, total_branches, file_count)
         [line_str, branch_str]
+      rescue JSON::ParserError => e
+        if @strict
+          raise "Failed to parse coverage JSON at #{@coverage_path}: #{e.class}: #{e.message}"
+        else
+          warn("Failed to parse coverage: #{e.class}: #{e.message}")
+          [nil, nil]
+        end
       rescue StandardError => e
-        warn("Failed to parse coverage: #{e.class}: #{e.message}")
-        [nil, nil]
+        if @strict
+          raise "Failed to get coverage data: #{e.class}: #{e.message}"
+        else
+          warn("Failed to get coverage data: #{e.class}: #{e.message}")
+          [nil, nil]
+        end
       end
 
       def yard_percent_documented
         cmd = File.join(@root, "bin", "yard")
         unless File.executable?(cmd)
-          warn("bin/yard not found or not executable; ensure yard is installed via bundler")
-          return
+          if @strict
+            raise "bin/yard not found or not executable; ensure yard is installed via bundler"
+          else
+            warn("bin/yard not found or not executable; ensure yard is installed via bundler")
+            return
+          end
         end
-        out, _ = Open3.capture2(cmd)
-        # Look for a line containing e.g., "95.35% documented"
-        line = out.lines.find { |l| l =~ /\d+(?:\.\d+)?%\s+documented/ }
-        if line
-          line = line.strip
-          # Return exactly as requested: e.g. "95.35% documented"
-          line
-        else
-          warn("Could not find documented percentage in bin/yard output.")
-          nil
+
+        begin
+          # Run bin/yard to get documentation percentage
+          out, _ = Open3.capture2(cmd, {chdir: @root})
+          # Look for a line containing e.g., "95.35% documented"
+          line = out.lines.find { |l| l =~ /\d+(?:\.\d+)?%\s+documented/ }
+
+          if line
+            line.strip
+          elsif @strict
+            raise "Could not find documented percentage in bin/yard output"
+          else
+            warn("Could not find documented percentage in bin/yard output.")
+            nil
+          end
+        rescue StandardError => e
+          if @strict
+            raise "Failed to run bin/yard: #{e.class}: #{e.message}"
+          else
+            warn("Failed to run bin/yard: #{e.class}: #{e.message}")
+            nil
+          end
         end
-      rescue StandardError => e
-        warn("Failed to run bin/yard: #{e.class}: #{e.message}")
-        nil
       end
 
       # Transform legacy release headings that include a tag suffix, e.g.:

data/lib/kettle/dev/prism_appraisals.rb

@@ -301,6 +301,51 @@ module Kettle
         statements = body.is_a?(Prism::StatementsNode) ? body.body : [body]
         statements.compact.map { |stmt| {node: stmt, inline_comments: [], leading_comments: []} }
       end
+
+      # Remove gem calls that reference the given gem name (to prevent self-dependency).
+      # Works by locating gem() call nodes within appraise blocks where the first argument matches gem_name.
+      # @param content [String] Appraisals content
+      # @param gem_name [String] the gem name to remove
+      # @return [String] modified content with self-referential gem calls removed
+      def remove_gem_dependency(content, gem_name)
+        return content if gem_name.to_s.strip.empty?
+
+        result = PrismUtils.parse_with_comments(content)
+        root = result.value
+        return content unless root&.statements&.body
+
+        out = content.dup
+
+        # Iterate through all appraise blocks
+        root.statements.body.each do |node|
+          next unless appraise_call?(node)
+          next unless node.block&.body
+
+          body_stmts = PrismUtils.extract_statements(node.block.body)
+
+          # Find gem call nodes within this appraise block where first argument matches gem_name
+          body_stmts.each do |stmt|
+            next unless stmt.is_a?(Prism::CallNode) && stmt.name == :gem
+
+            first_arg = stmt.arguments&.arguments&.first
+            arg_val = begin
+              PrismUtils.extract_literal_value(first_arg)
+            rescue StandardError
+              nil
+            end
+
+            if arg_val && arg_val.to_s == gem_name.to_s
+              # Remove this gem call from content
+              out = out.sub(stmt.slice, "")
+            end
+          end
+        end
+
+        out
+      rescue StandardError => e
+        Kettle::Dev.debug_error(e, __method__) if defined?(Kettle::Dev.debug_error)
+        content
+      end
     end
   end
 end

data/lib/kettle/dev/prism_gemfile.rb

@@ -131,6 +131,47 @@ module Kettle
         end
         dest_content
       end
+
+      # Remove gem calls that reference the given gem name (to prevent self-dependency).
+      # Works by locating gem() call nodes where the first argument matches gem_name.
+      # @param content [String] Gemfile-like content
+      # @param gem_name [String] the gem name to remove
+      # @return [String] modified content with self-referential gem calls removed
+      def remove_gem_dependency(content, gem_name)
+        return content if gem_name.to_s.strip.empty?
+
+        result = PrismUtils.parse_with_comments(content)
+        stmts = PrismUtils.extract_statements(result.value.statements)
+
+        # Find gem call nodes where first argument matches gem_name
+        gem_nodes = stmts.select do |n|
+          next false unless n.is_a?(Prism::CallNode) && n.name == :gem
+
+          first_arg = n.arguments&.arguments&.first
+          arg_val = begin
+            PrismUtils.extract_literal_value(first_arg)
+          rescue StandardError
+            nil
+          end
+          arg_val && arg_val.to_s == gem_name.to_s
+        end
+
+        # Remove each matching gem call from content
+        out = content.dup
+        gem_nodes.each do |gn|
+          # Remove the entire line(s) containing this node
+          out = out.sub(gn.slice, "")
+        end
+
+        out
+      rescue StandardError => e
+        if defined?(Kettle::Dev) && Kettle::Dev.respond_to?(:debug_error)
+          Kettle::Dev.debug_error(e, __method__)
+        else
+          Kernel.warn("[#{__method__}] #{e.class}: #{e.message}")
+        end
+        content
+      end
     end
   end
 end

data/lib/kettle/dev/template_helpers.rb

@@ -298,6 +298,19 @@ module Kettle
           end
         end
 
+        # Apply self-dependency removal for all gem-related files
+        # This ensures we don't introduce a self-dependency when templating
+        begin
+          meta = gemspec_metadata
+          gem_name = meta[:gem_name]
+          if gem_name && !gem_name.to_s.empty?
+            content = remove_self_dependency(content, gem_name, dest_path)
+          end
+        rescue StandardError => e
+          Kettle::Dev.debug_error(e, __method__)
+          # If metadata extraction or removal fails, proceed with content as-is
+        end
+
         write_file(dest_path, content)
         begin
           # Ensure executable bit for git hook scripts when writing under .git-hooks
@@ -342,6 +355,38 @@ module Kettle
         content
       end
 
+      # Remove self-referential gem dependencies from content based on file type.
+      # Applies to gemspec, Gemfile, modular gemfiles, Appraisal.root.gemfile, and Appraisals.
+      # @param content [String] file content
+      # @param gem_name [String] the gem name to remove
+      # @param file_path [String] path to the file (used to determine type)
+      # @return [String] content with self-dependencies removed
+      def remove_self_dependency(content, gem_name, file_path)
+        return content if gem_name.to_s.strip.empty?
+
+        basename = File.basename(file_path.to_s)
+
+        begin
+          case basename
+          when /\.gemspec$/
+            # Use PrismGemspec for gemspec files
+            Kettle::Dev::PrismGemspec.remove_spec_dependency(content, gem_name)
+          when "Gemfile", "Appraisal.root.gemfile", /\.gemfile$/
+            # Use PrismGemfile for Gemfile-like files
+            Kettle::Dev::PrismGemfile.remove_gem_dependency(content, gem_name)
+          when "Appraisals"
+            # Use PrismAppraisals for Appraisals files
+            Kettle::Dev::PrismAppraisals.remove_gem_dependency(content, gem_name)
+          else
+            # Return content unchanged for unknown file types
+            content
+          end
+        rescue StandardError => e
+          Kettle::Dev.debug_error(e, __method__)
+          content
+        end
+      end
+
       # Copy a directory tree, prompting before creating or overwriting.
       # @return [void]
       def copy_dir_with_prompt(src_dir, dest_dir)

data/lib/kettle/dev/version.rb

@@ -6,7 +6,7 @@ module Kettle
     module Version
       # The gem version.
       # @return [String]
-      VERSION = "1.2.1"
+      VERSION = "1.2.2"
 
       module_function
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: kettle-dev
 version: !ruby/object:Gem::Version
-  version: 1.2.1
+  version: 1.2.2
 platform: ruby
 authors:
 - Peter H. Boling
@@ -414,10 +414,10 @@ licenses:
 - MIT
 metadata:
   homepage_uri: https://kettle-dev.galtzo.com/
-  source_code_uri: https://github.com/kettle-rb/kettle-dev/tree/v1.2.1
-  changelog_uri: https://github.com/kettle-rb/kettle-dev/blob/v1.2.1/CHANGELOG.md
+  source_code_uri: https://github.com/kettle-rb/kettle-dev/tree/v1.2.2
+  changelog_uri: https://github.com/kettle-rb/kettle-dev/blob/v1.2.2/CHANGELOG.md
   bug_tracker_uri: https://github.com/kettle-rb/kettle-dev/issues
-  documentation_uri: https://www.rubydoc.info/gems/kettle-dev/1.2.1
+  documentation_uri: https://www.rubydoc.info/gems/kettle-dev/1.2.2
   funding_uri: https://github.com/sponsors/pboling
   wiki_uri: https://github.com/kettle-rb/kettle-dev/wiki
   news_uri: https://www.railsbling.com/tags/kettle-dev