kettle-dev 1.1.19 → 1.1.20

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f7d3c953377dfc1858b5a8469bf30105b01ef83dc7eadabf909dfa0d64160b04
-  data.tar.gz: a2fe2a9480a1f6a8b8ee80228c4d37dd9f3eae46d7a925c8ecc3af6e5b569587
+  metadata.gz: 898754550e179a5b5757c58d45a2dd50a61de0334051ab4947769cc4a33c6624
+  data.tar.gz: f2b3cb209b23f9074086cb22e52e674e2b0ba84788241b2222bdca9bf26d5699
 SHA512:
-  metadata.gz: 414144368ee1dfb6afc667d6c52b87093211647e136ac2f1e3bbe621980d278b987275d8ffa8885531400935a715c7b6eed4ea6eb4a4aaea9890f9c8d1d49b4b
-  data.tar.gz: '049b44a4e3d2add7cac3b44ad29ddfc268ed3b1a7ec2c3e423bb5ea3c06088b74a175805cbe473702cb5c7d94905b233854462f8de2e4936c19c6e5ac8d8501e'
+  metadata.gz: 73108e8b6bc65bd2b11e04b0a0cb20ac2fa0f7c5f3b83533c469ece206af419e1c1033bb61253815e1c98b84f21122176825e16abbb2121478c6154647812d33
+  data.tar.gz: 53cf04abaea992d6a6c4047e7be8292c4eb8d452614755aeb368b37d7d8f950bc42271556a39b873cf683950f49db3325b5a2245cb4687f07776044f4f562a78

data/.licenserc.yaml

@@ -0,0 +1,7 @@
+header:
+  license:
+    spdx-id: MIT
+
+dependency:
+  files:
+    - Gemfile.lock

data/CHANGELOG.md

@@ -24,6 +24,21 @@ Please file a bug if you notice a violation of semantic versioning.
 ### Fixed
 ### Security
 
+## [1.1.20] - 2025-09-15
+- TAG: [v1.1.20][1.1.20t]
+- COVERAGE: 96.80% -- 3660/3781 lines in 25 files
+- BRANCH COVERAGE: 81.65% -- 1504/1842 branches in 25 files
+- 77.01% documented
+### Added
+- Allow reformating of CHANGELOG.md without version bump
+- `--include=GLOB` includes files not otherwise included in default template
+- more test coverage
+### Fixed
+- Add .licenserc.yaml to gem package
+- Handling of GFM fenced code blocks in CHANGELOG.md
+- Handling of nested list items in CHANGELOG.md
+- Handling of blank lines around all headings in CHANGELOG.md
+
 ## [1.1.19] - 2025-09-14
 - TAG: [v1.1.19][1.1.19t]
 - COVERAGE: 96.58% -- 3531/3656 lines in 25 files
@@ -660,7 +675,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.19...HEAD
+[Unreleased]: https://github.com/kettle-rb/kettle-dev/compare/v1.1.20...HEAD
+[1.1.20]: https://github.com/kettle-rb/kettle-dev/compare/v1.1.19...v1.1.20
+[1.1.20t]: https://github.com/kettle-rb/kettle-dev/releases/tag/v1.1.20
 [1.1.19]: https://github.com/kettle-rb/kettle-dev/compare/v1.1.18...v1.1.19
 [1.1.19t]: https://github.com/kettle-rb/kettle-dev/releases/tag/v1.1.19
 [1.1.18]: https://github.com/kettle-rb/kettle-dev/compare/v1.1.17...v1.1.18

data/README.md

@@ -241,10 +241,12 @@ That’s it. Once installed, kettle-dev:
     - option: force: When truthy (1, true, y, yes), treat all y/N prompts as Yes. Useful for non-interactive runs or to accept defaults quickly. Example: `bundle exec rake kettle:dev:template force=true`
     - option: allowed: When truthy (1, true, y, yes), resume task after you have reviewed `.envrc`/`.env.local` and run `direnv allow`. If either file is created or updated, the task will abort with instructions unless `allowed=true` is present. Example: `bundle exec rake kettle:dev:install allowed=true`
     - option: only: A comma-separated list of glob patterns to include in templating. Any destination file whose path+filename does not match one of the patterns is excluded. Patterns are matched relative to your project root. Examples: `only="README.md,.github/**"`, `only="docs/**,lib/**/*.rb"`.
+    - option: include: A comma-separated list of glob patterns that opt-in additional, non-default files. Currently, `.github/workflows/discord-notifier.yml` is not copied by default and will only be copied when `include` matches it (e.g., `include=".github/workflows/discord-notifier.yml"`).
   - `kettle:dev:template` — templates files from this gem into your project (e.g., .github workflows, .devcontainer, .qlty, modular Gemfiles, README/CONTRIBUTING stubs). You can run this independently to refresh templates without the extra install prompts.
     - option: force: When truthy (1, true, y, yes), treat all y/N prompts as Yes. Useful for non-interactive runs or to accept defaults quickly. Example: `bundle exec rake kettle:dev:template force=true`
     - option: allowed: When truthy (1, true, y, yes), resume task after you have reviewed `.envrc`/`.env.local` and run `direnv allow`. If either file is created or updated, the task will abort with instructions unless `allowed=true` is present. Example: `bundle exec rake kettle:dev:template allowed=true`
     - option: only: Same as for install; limits which destination files are written based on glob patterns relative to the project root.
+    - option: include: Same as for install; opts into optional files (e.g., `.github/workflows/discord-notifier.yml`).
 
 Recommended one-time setup in your project:
 - Install binstubs so kettle-dev executables are available under `./bin`:
@@ -506,6 +508,7 @@ What it does:
   - `--force` Pass `force=true` to accept prompts non-interactively.
   - `--hook_templates=VAL` Pass `hook_templates=VAL` to control git hook templating.
   - `--only=VAL` Pass `only=VAL` to restrict install scope.
+  - `--include=VAL` Pass `include=VAL` to include optional files by glob (see notes below).
   - `-h`, `--help` Show help.
 - Behavior:
   - Verifies a clean git working tree, presence of a Gemfile and a gemspec.
@@ -911,7 +914,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-3.656-FFDD67.svg?style=for-the-badge&logo=YouTube&logoColor=blue
+[🧮kloc-img]: https://img.shields.io/badge/KLOC-3.781-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

@@ -511,7 +511,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-3.656-FFDD67.svg?style=for-the-badge&logo=YouTube&logoColor=blue
+[🧮kloc-img]: https://img.shields.io/badge/KLOC-3.781-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.19 - 2025-09-14
+# kettle-dev Rakefile v1.1.20 - 2025-09-15
 # Ruby 2.3 (Safe Navigation) or higher required
 #
 # MIT License (see License.txt)

data/exe/kettle-dev-setup

@@ -44,6 +44,7 @@ if ARGV.include?("-h") || ARGV.include?("--help")
       --force
       --hook_templates=VAL
       --only=VAL
+      --include=VAL
 
     Environment:
       DEBUG=true                    # print backtraces on errors

data/lib/kettle/dev/changelog_cli.rb

@@ -24,9 +24,22 @@ module Kettle
 
         changelog = File.read(@changelog_path)
 
-        # If the detected version already exists in the changelog, abort to avoid duplicates
+        # If the detected version already exists in the changelog, offer reformat-only mode
         if changelog =~ /^## \[#{Regexp.escape(version)}\]/
-          abort("CHANGELOG.md already has a section for version #{version}. Bump version.rb or remove the duplicate.")
+          warn("CHANGELOG.md already has a section for version #{version}.")
+          warn("It appears the version has not been bumped. You can reformat CHANGELOG.md without adding a new release section.")
+          print("Proceed with reformat only? [y/N]: ")
+          ans = Kettle::Dev::InputAdapter.gets&.strip&.downcase
+          if ans == "y" || ans == "yes"
+            updated = normalize_heading_spacing(changelog)
+            updated = ensure_footer_spacing(updated)
+            updated = updated.rstrip + "\n"
+            File.write(@changelog_path, updated)
+            puts "CHANGELOG.md reformatted. No new version section added."
+            return
+          else
+            abort("Aborting: version not bumped. Re-run after bumping version or answer 'y' to reformat-only.")
+          end
         end
 
         unreleased_block, before, after = extract_unreleased(changelog)
@@ -86,6 +99,9 @@ module Kettle
 
         updated = update_link_refs(updated, owner, repo, prev_version, version)
 
+        # Normalize spacing around headings to aid Markdown renderers
+        updated = normalize_heading_spacing(updated)
+
         # Ensure exactly one trailing newline at EOF
         updated = updated.rstrip + "\n"
 
@@ -340,10 +356,71 @@ module Kettle
           new_ref_block << tags[v] if tags[v]
         end
         # Replace the old block
-        rebuilt = lines[0...first_ref] + new_ref_block + ["\n"]
+        head = lines[0...first_ref]
+        # Ensure exactly one blank line separating body content from the reference block
+        if head.any? && head.last.to_s.strip != ""
+          head << "\n"
+        end
+        rebuilt = head + new_ref_block + ["\n"]
         rebuilt.join
       end
 
+      # Ensure every Markdown atx-style heading line (e.g., "# ", "## ") has exactly one blank line
+      # before and after it, skipping content inside fenced code blocks.
+      def normalize_heading_spacing(text)
+        lines = text.split("\n", -1)
+        out = []
+        in_fence = false
+        fence_re = /^\s*```/
+        heading_re = /^\s*#+\s+.+/
+        lines.each_with_index do |ln, idx|
+          if ln =~ fence_re
+            in_fence = !in_fence
+            out << ln
+            next
+          end
+          if !in_fence && ln =~ heading_re
+            # Ensure previous line is blank (unless start of file or already blank)
+            prev_blank = out.empty? ? false : out.last.to_s.strip == ""
+            out << "" unless out.empty? || prev_blank
+            out << ln
+            # Peek at next line in source to decide if we need to inject a blank now.
+            nxt = lines[idx + 1]
+            out << "" unless nxt.to_s.strip == ""
+          else
+            out << ln
+          end
+        end
+        # Collapse multiple consecutive blank lines down to a single between regions that our logic might have doubled
+        collapsed = []
+        lines_enum = out
+        lines_enum.each do |l|
+          if l.strip == "" && collapsed.last.to_s.strip == ""
+            next
+          end
+          collapsed << l
+        end
+        collapsed.join("\n")
+      end
+
+      def ensure_footer_spacing(text)
+        lines = text.split("\n", -1)
+        # Find the Unreleased link-ref which denotes start of footer refs
+        idx = lines.index { |l| l.start_with?(UNRELEASED_SECTION_HEADING) }
+        return text unless idx
+        head = lines[0...idx]
+        tail = lines[idx..-1]
+        # Ensure exactly one blank line between body and refs
+        if head.any? && head.last.to_s.strip != ""
+          head << ""
+        elsif head.any? && head.last.to_s.strip == "" && head[-2].to_s.strip == ""
+          # Collapse multiple blanks before footer to a single
+          head.pop while head.any? && head.last.to_s.strip == ""
+          head << ""
+        end
+        (head + tail).join("\n")
+      end
+
       def detect_initial_compare_base(lines)
         # Fallback when prev_version is unknown: try to find the first compare base used historically
         # e.g., for 1.0.0 it may be a commit SHA instead of a tag

data/lib/kettle/dev/gem_spec_reader.rb

@@ -106,16 +106,22 @@ module Kettle
             if funding_org_env && funding_org_env.to_s.strip.casecmp("false").zero?
               funding_org = nil
             else
-              funding_org = ENV["OPENCOLLECTIVE_HANDLE"].to_s.strip if funding_org.empty?
-              if funding_org.to_s.empty?
-                oc_path = File.join(root.to_s, ".opencollective.yml")
-                if File.file?(oc_path)
-                  txt = File.read(oc_path)
-                  if (m = txt.match(/\borg:\s*([\w\-]+)/i))
-                    funding_org = m[1].to_s
-                  end
+              # Prefer .opencollective.yml when present so that specs forcing the file path are stable
+              oc_path = File.join(root.to_s, ".opencollective.yml")
+              if File.file?(oc_path)
+                txt = File.read(oc_path)
+                funding_org = if (m = txt.match(/\borg:\s*([\w\-]+)/i))
+                  m[1].to_s
+                else
+                  ""
                 end
               end
+
+              # Fallback to ENV when file not present or did not contain an org
+              if funding_org.to_s.strip.empty?
+                funding_org = ENV["OPENCOLLECTIVE_HANDLE"].to_s.strip if funding_org.empty?
+              end
+
               # Be lenient: if funding_org cannot be determined, do not raise — leave it nil and warn.
               if funding_org.to_s.empty?
                 Kernel.warn("kettle-dev: Could not determine funding org.\n  - Options:\n    * Set ENV['FUNDING_ORG'] to your funding handle (e.g., 'opencollective-handle').\n    * Or set ENV['OPENCOLLECTIVE_HANDLE'].\n    * Or add .opencollective.yml with: org: <handle>\n    * Or bypass by setting ENV['FUNDING_ORG']=false for gems without funding.")

data/lib/kettle/dev/setup_cli.rb

@@ -114,6 +114,7 @@ module Kettle
           end
           opts.on("--hook_templates=VAL", "Pass through to kettle:dev:install") { |v| @passthrough << "hook_templates=#{v}" }
           opts.on("--only=VAL", "Pass through to kettle:dev:install") { |v| @passthrough << "only=#{v}" }
+          opts.on("--include=VAL", "Pass through to kettle:dev:install") { |v| @passthrough << "include=#{v}" }
           opts.on("-h", "--help", "Show help") do
             puts opts
             Kettle::Dev::ExitAdapter.exit(0)

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

@@ -10,6 +10,41 @@ module Kettle
 
         module_function
 
+        # Ensure every Markdown atx-style heading line has exactly one blank line
+        # before and after, skipping content inside fenced code blocks.
+        def normalize_heading_spacing(text)
+          lines = text.split("\n", -1)
+          out = []
+          in_fence = false
+          fence_re = /^\s*```/
+          heading_re = /^\s*#+\s+.+/
+          lines.each_with_index do |ln, idx|
+            if ln =~ fence_re
+              in_fence = !in_fence
+              out << ln
+              next
+            end
+            if !in_fence && ln =~ heading_re
+              prev_blank = out.empty? ? false : out.last.to_s.strip == ""
+              out << "" unless out.empty? || prev_blank
+              out << ln
+              nxt = lines[idx + 1]
+              out << "" unless nxt.to_s.strip == ""
+            else
+              out << ln
+            end
+          end
+          # Collapse accidental multiple blanks
+          collapsed = []
+          out.each do |l|
+            if l.strip == "" && collapsed.last.to_s.strip == ""
+              next
+            end
+            collapsed << l
+          end
+          collapsed.join("\n")
+        end
+
         # Abort wrapper that avoids terminating the entire process during specs
         def task_abort(msg)
           raise Kettle::Dev::Error, msg
@@ -57,11 +92,48 @@ module Kettle
                 selected[key] ||= path
               end
             end
+            # Parse optional include patterns (comma-separated globs relative to project root)
+            include_raw = ENV["include"].to_s
+            include_patterns = include_raw.split(",").map { |s| s.strip }.reject(&:empty?)
+            matches_include = lambda do |abs_dest|
+              return false if include_patterns.empty?
+              begin
+                rel_dest = abs_dest.to_s
+                proj = project_root.to_s
+                if rel_dest.start_with?(proj + "/")
+                  rel_dest = rel_dest[(proj.length + 1)..-1]
+                elsif rel_dest == proj
+                  rel_dest = ""
+                end
+                include_patterns.any? do |pat|
+                  if pat.end_with?("/**")
+                    base = pat[0..-4]
+                    rel_dest == base || rel_dest.start_with?(base + "/")
+                  else
+                    File.fnmatch?(pat, rel_dest, File::FNM_PATHNAME | File::FNM_EXTGLOB | File::FNM_DOTMATCH)
+                  end
+                end
+              rescue StandardError => e
+                Kettle::Dev.debug_error(e, __method__)
+                false
+              end
+            end
+
             selected.values.each do |orig_src|
               src = helpers.prefer_example(orig_src)
               # Destination path should never include the .example suffix.
               rel = orig_src.sub(/^#{Regexp.escape(gem_checkout_root)}\/?/, "").sub(/\.example\z/, "")
               dest = File.join(project_root, rel)
+
+              # Optional file: .github/workflows/discord-notifier.yml should NOT be copied by default.
+              # Only copy when --include matches it.
+              if rel == ".github/workflows/discord-notifier.yml"
+                unless matches_include.call(dest)
+                  # Explicitly skip without prompting
+                  next
+                end
+              end
+
               if File.basename(rel) == "FUNDING.yml"
                 helpers.copy_file_with_prompt(src, dest, allow_create: true, allow_replace: true) do |content|
                   c = content.dup
@@ -599,14 +671,63 @@ module Kettle
                       parse_items = lambda do |body_lines|
                         result = {}
                         cur = nil
-                        body_lines.each do |ln|
+                        i = 0
+                        while i < body_lines.length
+                          ln = body_lines[i]
                           if ln.start_with?("### ")
                             cur = ln.strip
                             result[cur] ||= []
-                          elsif ln.start_with?("- ")
+                            i += 1
+                            next
+                          end
+
+                          # Detect a list item bullet (allow optional indentation)
+                          if (m = ln.match(/^(\s*)[-*]\s/))
                             result[cur] ||= []
+                            base_indent = m[1].length
+                            # Start a new item: include the bullet line
                             result[cur] << ln.rstrip
+                            i += 1
+
+                            # Include subsequent lines that belong to this list item:
+                            # - blank lines
+                            # - lines with indentation greater than the bullet's indentation
+                            # - any lines inside fenced code blocks (```), regardless of indentation until fence closes
+                            in_fence = false
+                            fence_re = /^\s*```/
+                            while i < body_lines.length
+                              l2 = body_lines[i]
+                              # Stop if next sibling/top-level bullet of same or smaller indent and not inside a fence
+                              if !in_fence && l2 =~ /^(\s*)[-*]\s/
+                                ind = Regexp.last_match(1).length
+                                break if ind <= base_indent
+                              end
+                              # Break if a new section heading appears and we're not in a fence
+                              break if !in_fence && l2.start_with?("### ")
+
+                              if l2 =~ fence_re
+                                in_fence = !in_fence
+                                result[cur] << l2.rstrip
+                                i += 1
+                                next
+                              end
+
+                              # Include blanks and lines indented more than base indent, or anything while in fence
+                              if in_fence || l2.strip.empty? || (l2[/^\s*/].length > base_indent)
+                                result[cur] << l2.rstrip
+                                i += 1
+                                next
+                              end
+
+                              # Otherwise, this line does not belong to the current list item
+                              break
+                            end
+
+                            next
                           end
+
+                          # Non-bullet, non-heading line: just advance
+                          i += 1
                         end
                         result
                       end
@@ -664,6 +785,8 @@ module Kettle
                     c = lines.join("\n")
                   end
                 end
+                # Normalize spacing around Markdown headings for broad renderer compatibility
+                c = normalize_heading_spacing(c)
                 c
               end
             else

data/lib/kettle/dev/version.rb

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: kettle-dev
 version: !ruby/object:Gem::Version
-  version: 1.1.19
+  version: 1.1.20
 platform: ruby
 authors:
 - Peter H. Boling
@@ -235,7 +235,7 @@ files:
 - ".github/workflows/current.yml"
 - ".github/workflows/dep-heads.yml"
 - ".github/workflows/dependency-review.yml"
-- ".github/workflows/discord-notifier.yml"
+- ".github/workflows/discord-notifier.yml.example"
 - ".github/workflows/heads.yml"
 - ".github/workflows/heads.yml.example"
 - ".github/workflows/jruby.yml"
@@ -253,6 +253,7 @@ files:
 - ".gitlab-ci.yml.example"
 - ".junie/guidelines-rbs.md"
 - ".junie/guidelines.md"
+- ".licenserc.yaml"
 - ".opencollective.yml"
 - ".opencollective.yml.example"
 - ".qlty/qlty.toml"
@@ -387,10 +388,10 @@ licenses:
 - MIT
 metadata:
   homepage_uri: https://kettle-dev.galtzo.com/
-  source_code_uri: https://github.com/kettle-rb/kettle-dev/tree/v1.1.19
-  changelog_uri: https://github.com/kettle-rb/kettle-dev/blob/v1.1.19/CHANGELOG.md
+  source_code_uri: https://github.com/kettle-rb/kettle-dev/tree/v1.1.20
+  changelog_uri: https://github.com/kettle-rb/kettle-dev/blob/v1.1.20/CHANGELOG.md
   bug_tracker_uri: https://github.com/kettle-rb/kettle-dev/issues
-  documentation_uri: https://www.rubydoc.info/gems/kettle-dev/1.1.19
+  documentation_uri: https://www.rubydoc.info/gems/kettle-dev/1.1.20
   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