kettle-dev 1.1.55 → 1.1.56

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e4782eb3b39e080e427e189f57e3aed63e153847e42a1941ab5878bbd105c2fc
-  data.tar.gz: 4b2403df88b14c7bdab14a016eba9566412bf82df7e941d95802c6eb06148376
+  metadata.gz: 62e325c872a074389b37b26430debd850401b38e86d9e21beecde17565beb561
+  data.tar.gz: 9f2698e5f4fd28e0c97cef4c9ca6b41b313cca732bb7b1338ef333e87c2b7240
 SHA512:
-  metadata.gz: 85ea8797ad85aa8fdc7e81c87c5690ea51de9d11f72c2bc3d3a27d98592677ef7b3d4586d25d57faa08d2e75d578dd474962ca3f7393f4ba84546f307e08c33c
-  data.tar.gz: 6d1480c222f28119e4207b8b98083148c6633f94fe160f501622eff7628e06ba813cd0aa4cb756a494ec3e1751259841b0e09dd482153fae12786f767de43185
+  metadata.gz: 5799a7e73b2d365f1adedae8a00b66197547727937be9b88cabc16dc17755e8aa96e53ce34c379f88fb917fe7be9b22db7090095500140f592e1372f77006835
+  data.tar.gz: b7dcc7f75644618b7f5294bd94c4ba3157cc64306509ef66ff173a16f25ad7a123b66c0304df0633bbbc8fdfdd69d0db1ab01d0e9bec03e016eb9f830bdf6cac

data/.envrc.example

@@ -0,0 +1,50 @@
+# Run any command in this library's bin/ without the bin/ prefix!
+# Prefer exe version over binstub
+PATH_add exe
+PATH_add bin
+
+# Only add things to this file that should be shared with the team.
+
+# **dotenv** (See end of file for .env.local integration)
+# .env would override anything in this file, if enabled.
+# .env is a DOCKER standard, and if we use it, it would be in deployed, or DOCKER, environments.
+# Override and customize anything below in your own .env.local
+# If you are using dotenv and not direnv,
+#   copy the following `export` statements to your own .env file.
+
+### General Ruby ###
+# Turn off Ruby Warnings about deprecated code
+# export RUBYOPT="-W0"
+
+### External Testing Controls
+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=76 # Means you want to enforce X% branch coverage
+export K_SOUP_COV_MIN_LINE=92 # 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
+export MAX_ROWS=1 # Setting for simplecov-console gem for tty output, limits to the worst N rows of bad coverage
+export KETTLE_TEST_SILENT=true
+
+# Internal Debugging Controls
+export DEBUG=false # do not allow byebug statements (override in .env.local)
+export FLOSS_CFG_FUND_DEBUG=false # extra logging to help diagnose issues (override in .env.local)
+export FLOSS_CFG_FUND_LOGFILE=tmp/log/debug.log
+
+# Concurrently developing the rubocop-lts suite?
+export RUBOCOP_LTS_LOCAL=false
+
+# If {TARGET|GEM|NAME} does not have an open source collective set these to false.
+export OPENCOLLECTIVE_HANDLE={OPENCOLLECTIVE|ORG_NAME}
+export FUNDING_ORG={OPENCOLLECTIVE|ORG_NAME}
+
+# .env would override anything in this file, if `dotenv` is uncommented below.
+# .env is a DOCKER standard, and if we use it, it would be in deployed, or DOCKER, environments,
+#   and that is why we generally want to leave it commented out.
+# dotenv
+
+# .env.local will override anything in this file.
+dotenv_if_exists .env.local

data/.envrc.no-osc.example

@@ -0,0 +1,50 @@
+# Run any command in this library's bin/ without the bin/ prefix!
+# Prefer exe version over binstub
+PATH_add exe
+PATH_add bin
+
+# Only add things to this file that should be shared with the team.
+
+# **dotenv** (See end of file for .env.local integration)
+# .env would override anything in this file, if enabled.
+# .env is a DOCKER standard, and if we use it, it would be in deployed, or DOCKER, environments.
+# Override and customize anything below in your own .env.local
+# If you are using dotenv and not direnv,
+#   copy the following `export` statements to your own .env file.
+
+### General Ruby ###
+# Turn off Ruby Warnings about deprecated code
+# export RUBYOPT="-W0"
+
+### External Testing Controls
+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=76 # Means you want to enforce X% branch coverage
+export K_SOUP_COV_MIN_LINE=92 # 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
+export MAX_ROWS=1 # Setting for simplecov-console gem for tty output, limits to the worst N rows of bad coverage
+export KETTLE_TEST_SILENT=true
+
+# Internal Debugging Controls
+export DEBUG=false # do not allow byebug statements (override in .env.local)
+export FLOSS_CFG_FUND_DEBUG=false # extra logging to help diagnose issues (override in .env.local)
+export FLOSS_CFG_FUND_LOGFILE=tmp/log/debug.log
+
+# Concurrently developing the rubocop-lts suite?
+export RUBOCOP_LTS_LOCAL=false
+
+# {TARGET|GEM|NAME} has no open source collective.
+export OPENCOLLECTIVE_HANDLE=false
+export FUNDING_ORG=false
+
+# .env would override anything in this file, if `dotenv` is uncommented below.
+# .env is a DOCKER standard, and if we use it, it would be in deployed, or DOCKER, environments,
+#   and that is why we generally want to leave it commented out.
+# dotenv
+
+# .env.local will override anything in this file.
+dotenv_if_exists .env.local

data/.github/workflows/unlocked_deps.yml

@@ -55,7 +55,7 @@ jobs:
         include:
           # Ruby <whichever version is current, e.g., 3.4 as of 2025-07-12>
           - ruby: "ruby"
-            appraisal_name: "unlocked_deps"
+            appraisal: "unlocked_deps"
             exec_cmd: "rake"
             gemfile: "Appraisal.root"
             rubygems: latest
@@ -78,7 +78,7 @@ jobs:
       # NOTE: This does not use the primary Gemfile at all.
       - name: Install Root Appraisal
         run: bundle
-      - name: Appraisal for ${{ matrix.ruby }}@${{ matrix.appraisal_name }}
-        run: bundle exec appraisal ${{ matrix.appraisal_name }} bundle
-      - name: Run ${{ matrix.exec_cmd }} on ${{ matrix.ruby }}@${{ matrix.appraisal_name }}
-        run: bundle exec appraisal ${{ matrix.appraisal_name }} bundle exec ${{ matrix.exec_cmd }}
+      - name: Appraisal for ${{ matrix.ruby }}@${{ matrix.appraisal }}
+        run: bundle exec appraisal ${{ matrix.appraisal }} bundle
+      - name: Run ${{ matrix.exec_cmd }} on ${{ matrix.ruby }}@${{ matrix.appraisal }}
+        run: bundle exec appraisal ${{ matrix.appraisal }} bundle exec ${{ matrix.exec_cmd }}

data/.gitlab-ci.yml.example

@@ -22,7 +22,6 @@ variables:
   K_SOUP_COV_DEBUG: true
   K_SOUP_COV_DO: true
   K_SOUP_COV_HARD: true
-  # Lower than local, which is at 100/100, because rubocop-lts isn't installed in the coverage workflow
   K_SOUP_COV_MIN_BRANCH: 74
   K_SOUP_COV_MIN_LINE: 90
   K_SOUP_COV_VERBOSE: true

data/CHANGELOG.md

@@ -30,6 +30,20 @@ Please file a bug if you notice a violation of semantic versioning.
 
 ### Security
 
+## [1.1.56] - 2025-11-11
+
+- TAG: [v1.1.56][1.1.56t]
+- COVERAGE: 94.38% -- 4066/4308 lines in 26 files
+- BRANCH COVERAGE: 78.77% -- 1673/2124 branches in 26 files
+- 79.89% documented
+
+### Fixed
+
+- Appraisals template merge with existing header
+- Don't set opencollective in FUNDING.yml when osc is disabled
+- handling of open source collective ENV variables in .envrc templates
+- Don't invent an open collective handle when open collective is not enabled
+
 ## [1.1.55] - 2025-11-11
 
 - TAG: [v1.1.55][1.1.55t]
@@ -1380,7 +1394,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.1.55...HEAD
+[Unreleased]: https://github.com/kettle-rb/kettle-dev/compare/v1.1.56...HEAD
+[1.1.56]: https://github.com/kettle-rb/kettle-dev/compare/v1.1.55...v1.1.56
+[1.1.56t]: https://github.com/kettle-rb/kettle-dev/releases/tag/v1.1.56
 [1.1.55]: https://github.com/kettle-rb/kettle-dev/compare/v1.1.54...v1.1.55
 [1.1.55t]: https://github.com/kettle-rb/kettle-dev/releases/tag/v1.1.55
 [1.1.54]: https://github.com/kettle-rb/kettle-dev/compare/v1.1.53...v1.1.54

data/README.md

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

@@ -544,7 +544,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.278-FFDD67.svg?style=for-the-badge&logo=YouTube&logoColor=blue
+[🧮kloc-img]: https://img.shields.io/badge/KLOC-4.308-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.1.55 - 2025-11-11
+# kettle-dev Rakefile v1.1.56 - 2025-11-11
 # Ruby 2.3 (Safe Navigation) or higher required
 #
 # MIT License (see License.txt)

data/lib/kettle/dev/tasks/template_task.rb

@@ -66,7 +66,7 @@ module Kettle
           gem_name = meta[:gem_name]
           min_ruby = meta[:min_ruby]
           forge_org = meta[:forge_org] || meta[:gh_org]
-          funding_org = meta[:funding_org] || forge_org
+          funding_org = helpers.opencollective_disabled? ? nil : meta[:funding_org] || forge_org
           entrypoint_require = meta[:entrypoint_require]
           namespace = meta[:namespace]
           namespace_shield = meta[:namespace_shield]
@@ -143,15 +143,22 @@ module Kettle
               if File.basename(rel) == "FUNDING.yml"
                 helpers.copy_file_with_prompt(src, dest, allow_create: true, allow_replace: true) do |content|
                   c = content.dup
-                  c = c.gsub(/^open_collective:\s+.*$/i) { |line| funding_org ? "open_collective: #{funding_org}" : line }
+                  # Effective funding handle should fall back to forge_org when funding_org is nil.
+                  # This allows tests to stub FUNDING_ORG=false to bypass explicit funding detection
+                  # while still templating the line with the derived organization (e.g., from homepage URL).
+                  effective_funding = funding_org || forge_org
+                  c = if helpers.opencollective_disabled?
+                    c.gsub(/^open_collective:\s+.*$/i) { |line| "open_collective: # Replace with a single Open Collective username" }
+                  else
+                    c.gsub(/^open_collective:\s+.*$/i) { |line| effective_funding ? "open_collective: #{effective_funding}" : line }
+                  end
                   if gem_name && !gem_name.empty?
                     c = c.gsub(/^tidelift:\s+.*$/i, "tidelift: rubygems/#{gem_name}")
                   end
-                  # Also apply common replacements for org/gem/namespace/shields
                   helpers.apply_common_replacements(
                     c,
                     org: forge_org,
-                    funding_org: funding_org,
+                    funding_org: effective_funding, # pass effective funding for downstream tokens
                     gem_name: gem_name,
                     namespace: namespace,
                     namespace_shield: namespace_shield,

data/lib/kettle/dev/template_helpers.rb

@@ -469,6 +469,21 @@ module Kettle
       #  - Preamble (content before first appraise) comes from template when present, else destination.
       def merge_appraisals(template_content, dest_content)
         begin
+          # Helper: extract contiguous leading header lines (comments and blank lines)
+          extract_leading_header = lambda do |text|
+            lines = text.lines
+            header_lines = []
+            idx = 0
+            while idx < lines.length
+              ln = lines[idx]
+              break unless ln.strip.empty? || ln.lstrip.start_with?("#")
+              header_lines << ln
+              idx += 1
+            end
+            body = (idx < lines.length) ? lines[idx..-1].join : ""
+            {header: header_lines.join, body: body}
+          end
+
           parse_blocks = lambda do |text|
             lines = text.lines
             blocks = []
@@ -526,8 +541,22 @@ module Kettle
             {blocks: blocks, preamble: preamble}
           end
 
-          tmpl = parse_blocks.call(template_content)
-          dest = parse_blocks.call(dest_content)
+          # Extract leading headers from template and destination and parse their bodies
+          tmpl_parts = extract_leading_header.call(template_content)
+          dest_parts = extract_leading_header.call(dest_content)
+
+          # If the template does not provide a leading header, preserve the destination as-is
+          # so that per-block adjacent header comments (including those at the top of file)
+          # are still parsed and preserved. Only strip the destination leading header when
+          # the template has a leading header to replace it.
+          dest_parse_source = if tmpl_parts[:header].to_s.strip.empty?
+            dest_content
+          else
+            dest_parts[:body]
+          end
+
+          tmpl = parse_blocks.call(tmpl_parts[:body])
+          dest = parse_blocks.call(dest_parse_source)
           tmpl_blocks = tmpl[:blocks]
           dest_blocks = dest[:blocks]
           dest_by_name = dest_blocks.map { |b| [b[:name], b] }.to_h
@@ -553,9 +582,17 @@ module Kettle
                 merged_body += additions
               end
               header = tb[:header].any? ? tb[:header] : db[:header]
+              # If the template provides no leading header and the destination preamble
+              # already ends with this header, skip emitting the header for this block
+              # to avoid duplicating it (it will already be present at the top of the file).
+              header_to_emit = if tmpl_parts[:header].to_s.strip.empty? && !dest[:preamble].to_s.strip.empty? && !header.empty? && dest[:preamble].to_s.end_with?(header.join)
+                []
+              else
+                header
+              end
               block_text = +""
               block_text << "\n" unless merged_blocks_strings.empty?
-              header.each { |hl| block_text << hl } if header.any?
+              header_to_emit.each { |hl| block_text << hl } if header_to_emit.any?
               block_text << "appraise \"#{tb[:name]}\" do\n"
               merged_body.each { |bl| block_text << bl }
               block_text << db[:end_line]
@@ -584,7 +621,21 @@ module Kettle
             merged_blocks_strings << block_text
           end
 
-          preamble = tmpl[:preamble].to_s.strip.empty? ? dest[:preamble] : tmpl[:preamble]
+          # Build final preamble:
+          # - If template provides a leading header, use that header and then prefer the
+          #   template's body preamble when present, otherwise fall back to the
+          #   destination's body preamble.
+          # - If template does NOT provide a leading header, leave the destination
+          #   preamble (including any leading header/comments) intact.
+          preamble = +""
+          if tmpl_parts[:header].to_s.strip.empty?
+            preamble << dest[:preamble].to_s
+          else
+            body_preamble = tmpl[:preamble].to_s.strip.empty? ? dest[:preamble].to_s : tmpl[:preamble].to_s
+            preamble << tmpl_parts[:header].to_s
+            preamble << body_preamble.to_s
+          end
+
           out = +""
           out << preamble unless preamble.nil? || preamble.empty?
           out << "\n" unless out.end_with?("\n")
@@ -792,7 +843,7 @@ module Kettle
 
         c = content.dup
         c = c.gsub("kettle-rb", org.to_s)
-        c = c.gsub("{OPENCOLLECTIVE|ORG_NAME}", funding_org)
+        c = c.gsub("{OPENCOLLECTIVE|ORG_NAME}", funding_org || "opencollective")
         # Replace min ruby token if present
         begin
           if min_ruby && !min_ruby.to_s.empty? && c.include?("{K_D_MIN_RUBY}")
@@ -813,6 +864,15 @@ module Kettle
           # ignore
         end
 
+        # Replace target gem name token if present
+        begin
+          token = "{TARGET|GEM|NAME}"
+          c = c.gsub(token, gem_name) if c.include?(token)
+        rescue StandardError => e
+          Kettle::Dev.debug_error(e, __method__)
+          # If replacement fails unexpectedly, proceed with content as-is
+        end
+
         # Special-case: yard-head link uses the gem name as a subdomain and must be dashes-only.
         # Apply this BEFORE other generic replacements so it isn't altered incorrectly.
         begin

data/lib/kettle/dev/version.rb

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: kettle-dev
 version: !ruby/object:Gem::Version
-  version: 1.1.55
+  version: 1.1.56
 platform: ruby
 authors:
 - Peter H. Boling
@@ -203,6 +203,8 @@ extra_rdoc_files:
 files:
 - "./.aiignore.example"
 - "./.env.local.example"
+- "./.envrc.example"
+- "./.envrc.no-osc.example"
 - "./.gitlab-ci.yml.example"
 - "./.opencollective.yml.example"
 - "./.simplecov.example"
@@ -219,6 +221,8 @@ files:
 - ".devcontainer/devcontainer.json"
 - ".env.local.example"
 - ".envrc"
+- ".envrc.example"
+- ".envrc.no-osc.example"
 - ".git-hooks/commit-msg"
 - ".git-hooks/commit-subjects-goalie.txt"
 - ".git-hooks/footer-template.erb.txt"
@@ -397,10 +401,10 @@ licenses:
 - MIT
 metadata:
   homepage_uri: https://kettle-dev.galtzo.com/
-  source_code_uri: https://github.com/kettle-rb/kettle-dev/tree/v1.1.55
-  changelog_uri: https://github.com/kettle-rb/kettle-dev/blob/v1.1.55/CHANGELOG.md
+  source_code_uri: https://github.com/kettle-rb/kettle-dev/tree/v1.1.56
+  changelog_uri: https://github.com/kettle-rb/kettle-dev/blob/v1.1.56/CHANGELOG.md
   bug_tracker_uri: https://github.com/kettle-rb/kettle-dev/issues
-  documentation_uri: https://www.rubydoc.info/gems/kettle-dev/1.1.55
+  documentation_uri: https://www.rubydoc.info/gems/kettle-dev/1.1.56
   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