kettle-dev 1.2.4 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 73ca5267629934af0b0f044598295a93c287cbace6c0ac2f5e2d1a701a72ca89
-  data.tar.gz: 1743ac37975a516f979d135d52c62b8a9fa28171d6df1a82fb58cce4d1676ea1
+  metadata.gz: 1c27526850f356cd31b634aa7a0ea70c4f96664c2979629ecfdabcf128f6b437
+  data.tar.gz: dca1af6fba35002062780e10688a42181eeb577804d48f3a367399fcf8da3262
 SHA512:
-  metadata.gz: afd0cdb05a6f08db4665b634cf38d4f959d08ea73ff526f1757d9168d3aab0a6a6d81ba90a5f20905f8888bd88bbbe55c1c53d15f0d1898202448dac0f204bd3
-  data.tar.gz: 92a005b6bb76771bffe3e0e3e3762bc6e11699286119dc009cb61e4c72278666552e07cf0a547c215c586caf7abeea7305767fce2d008342758b5d8fe80cc676
+  metadata.gz: 16221f6055e6d28aa959d11a8b57c047218565538b55b6066a0656b5b8c45273c78f7ee1521369c247b9c8b296a485da22e4fa99c92ed276a67e39997281a14e
+  data.tar.gz: 71f4a045813776fba247aa28b728aaef9b4bfcc9013a806fdd9f5b49d99551aae505b34e8278c591e3a9c1d65bfb9581718460c10cf9a2354f17839fe0e6e191

data/CHANGELOG.md

@@ -30,6 +30,158 @@ Please file a bug if you notice a violation of semantic versioning.
 
 ### Security
 
+## [2.0.0] - 2026-02-25
+
+- TAG: [v2.0.0][2.0.0t]
+- COVERAGE: 96.06% -- 2683/2793 lines in 20 files
+- BRANCH COVERAGE: 79.16% -- 1113/1406 branches in 20 files
+- 80.25% documented
+
+### Added
+
+- New `kettle-gh-release` executable for standalone GitHub release creation
+  - Extracted from `kettle-release` step 18
+  - Useful when RubyGems release succeeded but GitHub release failed
+  - Supports explicit version via `version=<VERSION>` argument
+  - Auto-detects version from `lib/**/version.rb` if not specified
+  - Requires `GITHUB_TOKEN` with `repo:public_repo` (classic) or `contents:write` scope
+- Added `.kettle-dev.yml` configuration file for per-file merge options
+  - Hybrid format: `defaults` for shared merge options, `patterns` for glob fallbacks, `files` for per-file config
+  - Nested directory structure under `files` allows individual file configuration
+  - Supports all `Prism::Merge::SmartMerger` options: `preference`, `add_template_only_nodes`, `freeze_token`, `max_recursion_depth`
+  - Added `TemplateHelpers.kettle_config`, `.config_for`, `.find_file_config` methods
+  - Added spec coverage in `template_helpers_config_spec.rb`
+
+### Changed
+
+- Updated documentation on hostile takeover of RubyGems
+  - https://dev.to/galtzo/hostile-takeover-of-rubygems-my-thoughts-5hlo
+- **BREAKING**: Replaced `template_manifest.yml` with `.kettle-dev.yml`
+  - New hybrid format supports both glob patterns and per-file configuration
+  - `TemplateHelpers.load_manifest` now reads from `.kettle-dev.yml` patterns section
+  - `TemplateHelpers.strategy_for` checks explicit file configs before falling back to patterns
+- **BREAKING**: Simplified `SourceMerger` to fully rely on prism-merge for AST merging
+  - Reduced from ~610 lines to ~175 lines (71% reduction)
+  - Removed custom newline normalization - prism-merge preserves original formatting
+  - Removed custom comment deduplication logic - prism-merge handles this natively
+  - All strategies (`:skip`, `:replace`, `:append`, `:merge`) now use prism-merge consistently
+  - Freeze blocks (`kettle-dev:freeze` / `kettle-dev:unfreeze`) handled by prism-merge's `freeze_token` option
+
+### Removed
+
+- Removed all `.example` template files from the kettle-dev root and subdirectories
+  (27 files). Template files now live exclusively in kettle-jem's `template/` directory.
+  Only `.env.local.example` is retained as a dev resource for all destination gems.
+- Removed unused methods from `SourceMerger`:
+  - `normalize_source` - replaced by prism-merge
+  - `normalize_newlines` - prism-merge preserves original formatting
+  - `shebang?`, `magic_comment?`, `ruby_magic_comment_key?` - no longer needed
+  - Comment extraction/deduplication: `extract_magic_comments`, `extract_file_leading_comments`,
+    `create_comment_tuples`, `deduplicate_comment_sequences`, `deduplicate_sequences_pass1`,
+    `deduplicate_singles_pass2`, `extract_nodes_with_comments`, `count_blank_lines_before`,
+    `build_source_from_nodes`
+  - Unused comment restoration: `restore_custom_leading_comments`, `deduplicate_leading_comment_block`,
+    `extract_comment_lines`, `normalize_comment`, `leading_comment_block`
+- Removed unused constants: `RUBY_MAGIC_COMMENT_KEYS`, `MAGIC_COMMENT_REGEXES`
+
+### Fixed
+
+- Fixed `PrismAppraisals` various comment chunk spacing
+  - extract_block_header:
+    - skips the blank spacer immediately above an `appraise` block
+    - treats any following blank line as the stop boundary once comment lines have been collected
+    - prevents preamble comments from being pulled into the first block’s header
+  - restores expected ordering:
+    - magic comments and their blank line stay at the top
+    - block headers remain adjacent to their blocks
+    - preserves blank lines between comment chunks
+- Fixed `SourceMerger` freeze block location preservation
+  - Freeze blocks now stay in their original location in the file structure
+  - Skip normalization for files with existing freeze blocks to prevent movement
+  - Only include contiguous comments immediately before freeze markers (no arbitrary 3-line lookback)
+  - Don't add freeze reminder to files that already have freeze/unfreeze blocks
+  - Prevents unrelated comments from being incorrectly captured in freeze block ranges
+  - Added comprehensive test coverage for multiple freeze blocks at different nesting levels
+- Fixed `TemplateTask` to not override template summary/description with empty strings from destination gemspec
+  - Only carries over summary/description when they contain actual content (non-empty)
+  - Allows token replacements to work correctly (e.g., `kettle-dev summary` → `my-gem summary`)
+  - Prevents empty destination fields from erasing meaningful template values
+- Fixed `SourceMerger` magic comment ordering and freeze block protection
+  - Magic comments now preserve original order
+  - No blank lines inserted between consecutive magic comments
+  - Freeze reminder block properly separated from magic comments (not merged)
+  - Leverages Prism's built-in `parse_result.magic_comments` API for accurate detection
+  - Detects `kettle-dev:freeze/unfreeze` pairs using Prism, then reclassifies as file-level comments to keep blocks intact
+  - Removed obsolete `is_magic_comment?` method in favor of Prism's native detection
+- Fixed `PrismGemspec` and `PrismGemfile` to use pure Prism AST traversal instead of regex fallbacks
+  - Removed regex-based `extract_gemspec_emoji` that parsed `spec.summary =` and `spec.description =` with regex
+  - Now traverses Prism AST to find Gem::Specification block, extracts summary/description nodes, and gets literal values
+  - Removed regex-based source line detection in `PrismGemfile.merge_gem_calls`
+  - Now uses `PrismUtils.statement_key` to find source statements via AST instead of `ln =~ /^\s*source\s+/`
+  - Aligns with project goal: move away from regex parsing toward proper AST manipulation with Prism
+  - All functionality preserved, tested, and working correctly
+- Fixed `PrismGemspec.replace_gemspec_fields` block parameter extraction to use Prism AST
+  - **CRITICAL**: Was using regex fallback that incorrectly captured entire block body as parameter name
+  - Removed buggy regex fallback in favor of pure Prism AST traversal
+  - Now properly extracts block parameter from Prism::BlockParametersNode → Prism::ParametersNode → Prism::RequiredParameterNode
+- Fixed `PrismGemspec.replace_gemspec_fields` insert offset calculation for emoji-containing gemspecs
+  - **CRITICAL**: Was using character length (`String#length`) instead of byte length (`String#bytesize`) to calculate insert offset
+  - When gemspecs contain multi-byte UTF-8 characters (emojis like 🍲), character length != byte length
+  - This caused fields to be inserted at wrong byte positions, resulting in truncated strings and massive corruption
+  - Changed `body_src.rstrip.length` to `body_src.rstrip.bytesize` for correct byte-offset calculations
+  - Prevents gemspec templating from producing corrupted output with truncated dependency lines
+  - Added comprehensive debug logging to trace byte offset calculations and edit operations
+- Fixed `SourceMerger` variable assignment duplication during merge operations
+  - `node_signature` now identifies variable/constant assignments by name only, not full source
+  - Previously used full source text as signature, causing duplicates when assignment bodies differed
+  - Added specific handlers for: LocalVariableWriteNode, InstanceVariableWriteNode, ClassVariableWriteNode, ConstantWriteNode, GlobalVariableWriteNode
+  - Also added handlers for ClassNode and ModuleNode to match by name
+  - Example: `gem_version = ...` assignments with different bodies now correctly merge instead of duplicating
+  - Prevents `bin/kettle-dev-setup` from creating duplicate variable assignments in gemspecs and other files
+  - Added comprehensive specs for variable assignment deduplication and idempotency
+- Fixed `SourceMerger` conditional block duplication during merge operations
+  - `node_signature` now identifies conditional nodes (if/unless/case) by their predicate only
+  - Previously used full source text, causing duplicate blocks when template updates conditional bodies
+  - Example: if ENV["FOO"] blocks with different bodies now correctly merge instead of duplicating
+  - Prevents `bin/kettle-dev-setup` from creating duplicate if/else blocks in gemfiles
+  - Added comprehensive specs for conditional merging behavior and idempotency
+- Fixed `PrismGemspec.replace_gemspec_fields` to use byte-aware string operations
+  - **CRITICAL**: Was using character-based `String#[]=` with Prism's byte offsets
+  - This caused catastrophic corruption when emojis or multi-byte UTF-8 characters were present
+  - Symptoms: gemspec blocks duplicated/fragmented, statements escaped outside blocks
+  - Now uses `byteslice` and byte-aware concatenation for all edit operations
+  - Prevents gemspec templating from producing mangled output with duplicated Gem::Specification blocks
+- Fixed `PrismGemspec.replace_gemspec_fields` to correctly handle multi-byte UTF-8 characters (e.g., emojis)
+  - Prism uses byte offsets, not character offsets, when parsing Ruby code
+  - Changed string slicing from `String#[]` to `String#byteslice` for all offset-based operations
+  - Added validation to use `String#bytesize` instead of `String#length` for offset bounds checking
+  - Prevents `TypeError: no implicit conversion of nil into String` when gemspecs contain emojis
+  - Ensures gemspec field carryover works correctly with emoji in summary/description fields
+  - Enhanced error reporting to show backtraces when debug mode is enabled
+
+## [1.2.5] - 2025-11-28
+
+- TAG: [v1.2.5][1.2.5t]
+- COVERAGE: 93.53% -- 4726/5053 lines in 31 files
+- BRANCH COVERAGE: 76.62% -- 1924/2511 branches in 31 files
+- 69.89% documented
+
+### Added
+
+- Comprehensive newline normalization in templated Ruby files:
+  - Magic comments (frozen_string_literal, encoding, etc.) always followed by single blank line
+  - No more than one consecutive blank line anywhere in file
+  - Single newline at end of file (no trailing blank lines)
+  - Freeze reminder block now includes blank line before and empty comment line after for better visual separation
+
+### Changed
+
+- Updated `FREEZE_REMINDER` constant to include blank line before and empty comment line after
+
+### Fixed
+
+- Fixed `reminder_present?` to correctly detect freeze reminder when it has leading blank line
+
 ## [1.2.4] - 2025-11-28
 
 - TAG: [v1.2.4][1.2.4t]
@@ -45,7 +197,7 @@ Please file a bug if you notice a violation of semantic versioning.
   - Ensures truly idempotent behavior when running templating multiple times on the same file
   - Example: `frozen_string_literal` comments no longer multiply from 1→4→5→6 on repeated runs
 
-## [1.2.3] - 2025-11-28
+## [1.2.3] - 2025-11-28vari
 
 - TAG: [v1.2.3][1.2.3t]
 - COVERAGE: 93.43% -- 4681/5010 lines in 31 files
@@ -1138,7 +1290,7 @@ Please file a bug if you notice a violation of semantic versioning.
   - <!-- RELEASE-NOTES-FOOTER-END -->
 - truffle workflow: Repeat attempts for bundle install and appraisal bundle before failure
 - global token replacement during kettle:dev:install
-  - {KETTLE|DEV|GEM} => kettle-dev
+  - kettle-dev => kettle-dev
   - {RUBOCOP|LTS|CONSTRAINT} => dynamic
   - {RUBOCOP|RUBY|GEM} => dynamic
   - default to rubocop-ruby1_8 if no minimum ruby specified
@@ -1522,7 +1674,11 @@ 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.4...HEAD
+[Unreleased]: https://github.com/kettle-rb/kettle-dev/compare/v2.0.0...HEAD
+[2.0.0]: https://github.com/kettle-rb/kettle-dev/compare/v1.2.5...v2.0.0
+[2.0.0t]: https://github.com/kettle-rb/kettle-dev/releases/tag/v2.0.0
+[1.2.5]: https://github.com/kettle-rb/kettle-dev/compare/v1.2.4...v1.2.5
+[1.2.5t]: https://github.com/kettle-rb/kettle-dev/releases/tag/v1.2.5
 [1.2.4]: https://github.com/kettle-rb/kettle-dev/compare/v1.2.3...v1.2.4
 [1.2.4t]: https://github.com/kettle-rb/kettle-dev/releases/tag/v1.2.4
 [1.2.3]: https://github.com/kettle-rb/kettle-dev/compare/v1.2.2...v1.2.3

data/CITATION.cff

@@ -7,8 +7,8 @@ type: software
 authors:
   - given-names: Peter Hurn
     family-names: Boling
-    email: peter@railsbling.com
-    affiliation: railsbling.com
+    email: floss@galtzo.com
+    affiliation: galtzo.com
     orcid: 'https://orcid.org/0009-0008-8519-441X'
 identifiers:
   - type: url

data/CONTRIBUTING.md

@@ -24,9 +24,10 @@ Follow these instructions:
 
 ## Executables vs Rake tasks
 
-Executables shipped by kettle-dev can be used with or without generating the binstubs.
-They will work when kettle-dev is installed globally (i.e., `gem install kettle-dev`) and do not require that kettle-dev be in your bundle.
+Executables shipped by dependencies, such as kettle-dev, and stone_checksums, are available
+after running `bin/setup`. These include:
 
+- gem_checksums
 - kettle-changelog
 - kettle-commit-msg
 - kettle-dev-setup
@@ -35,20 +36,10 @@ They will work when kettle-dev is installed globally (i.e., `gem install kettle-
 - kettle-readme-backers
 - kettle-release
 
-However, the rake tasks provided by kettle-dev do require kettle-dev to be added as a development dependency and loaded in your Rakefile.
-See the full list of rake tasks in head of Rakefile
+There are many Rake tasks available as well. You can see them by running:
 
-**Gemfile**
-```ruby
-group :development do
-  gem "kettle-dev", require: false
-end
-```
-
-**Rakefile**
-```ruby
-# Rakefile
-require "kettle/dev"
+```shell
+bin/rake -T
 ```
 
 ## Environment Variables for Local Development
@@ -77,7 +68,9 @@ GitHub API and CI helpers
 Releasing and signing
 - SKIP_GEM_SIGNING: If set, skip gem signing during build/release
 - GEM_CERT_USER: Username for selecting your public cert in `certs/<USER>.pem` (defaults to $USER)
-- SOURCE_DATE_EPOCH: Reproducible build timestamp. `kettle-release` will set this automatically for the session.
+- SOURCE_DATE_EPOCH: Reproducible build timestamp.
+  - `kettle-release` will set this automatically for the session.
+  - Not needed on bundler >= 2.7.0, as reproducible builds have become the default.
 
 Git hooks and commit message helpers (exe/kettle-commit-msg)
 - GIT_HOOK_BRANCH_VALIDATE: Branch name validation mode (e.g., `jira`) or `false` to disable
@@ -148,7 +141,7 @@ For more detailed information about using RuboCop in this project, please see th
 Never add `# rubocop:disable ...` / `# rubocop:enable ...` comments to code or specs (except when following the few existing `rubocop:disable` patterns for a rule already being disabled elsewhere in the code). Instead:
 
 - Prefer configuration-based exclusions when a rule should not apply to certain paths or files (e.g., via `.rubocop.yml`).
-- When a violation is temporary and you plan to fix it later, record it in `.rubocop_gradual.lock` using the gradual workflow:
+- When a violation is temporary, and you plan to fix it later, record it in `.rubocop_gradual.lock` using the gradual workflow:
   - `bundle exec rake rubocop_gradual:autocorrect` (preferred)
   - `bundle exec rake rubocop_gradual:force_update` (only when you cannot fix the violations immediately)
 
@@ -183,6 +176,7 @@ NOTE: To build without signing the gem set `SKIP_GEM_SIGNING` to any value in th
 1. Update version.rb to contain the correct version-to-be-released.
 2. Run `bundle exec kettle-changelog`.
 3. Run `bundle exec kettle-release`.
+4. Stay awake and monitor the release process for any errors, and answer any prompts.
 
 #### Manual process