reissue 0.4.1 → 0.4.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8c53bf3bbfdb9cb767ee2e1faf924fac9b46bd0e08a1d98488e4518b7927c44a
-  data.tar.gz: 2c76b7c27045c90cbeae7a638d493cd8d2f06a7a0471ae15ef4bcc9552681aea
+  metadata.gz: 58c406237f6e7ef96ad4a4e1ed1aa2ba3e4cb10145edd6d44bff791a8e37d5be
+  data.tar.gz: 26b103713df3d7de9c1f9af49df079a2e9954b9b7e96a58bc8e3e203607e531d
 SHA512:
-  metadata.gz: e459e8d268410a615181abde6c74e78180360e3b14854987603ccf38d2dda205e4f847ee36272d1b78e9e7f3c21d66d8434ea4fac77aa915f31ff978d3dddc27
-  data.tar.gz: c689c1b58e0bcd081f64c51af1c7f3b310909834f9c87026d648ea7a4f1d102d0ba45eb886e45c4bd8ada0096a8a2c8388c1020c77139f82308eee661ae20f87
+  metadata.gz: 01d186d7b5f87e5c3ef2be402eb758971ff4dec3626d2e2aed8d67d5fd6418d064687682176b509b038b39710e8c313279047e807e42d927c902e4b5bbee649e
+  data.tar.gz: 63d5c29928e104484ce0f1c5ce6ef101a8909ed8727ae441c3a5bb81c9aaf6ecbfb46b7f4af69540f6665fc71ea8e9f9a73d1ea928371d3f8fb7a84b7077198c

data/CHANGELOG.md

@@ -5,22 +5,14 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](http://keepachangelog.com/)
 and this project adheres to [Semantic Versioning](http://semver.org/).
 
-## [0.4.1] - 2025-08-18
-
-### Added
-
-- Add GitHub Actions workflow to release gems with Reissue
-- Add `reissue:clear_fragments` task to clear fragments after release
+## [0.4.2] - 2025-09-16
 
 ### Changed
 
-- Update README to clarify information about typical usage
-- Updated the shared gem release workflow to work with hyphenated gem names.
-- Rely on `rubygems/configure-rubygems-credentials` action.
+- New version was never created after the last release.
 
-## [0.4.0] - 2025-05-08
+## [0.4.2] - 2025-09-16
 
 ### Changed
 
-- Update reformat task to create a new changelog if it doesn't exist
-- Update the `reissue:branch` task to force create a new branch if it already exists.
+- New version was never created after the last release.

data/README.md

@@ -57,6 +57,7 @@ Additional tasks (usually run automatically):
 - `rake reissue[segment]` - Bump version (major, minor, patch)
 - `rake reissue:finalize[date]` - Add release date to changelog
 - `rake reissue:reformat[version_limit]` - Clean up changelog formatting
+- `rake reissue:preview` - Preview changelog entries from fragments or git trailers
 - `rake reissue:clear_fragments` - Clear changelog fragments after release
 
 ### Non-Gem Projects
@@ -104,13 +105,22 @@ Reissue::Task.create :reissue do |task|
   # Options: false, true (push working branch), :branch (create and push new branch)
   task.push_finalize = :branch
   
-  # Optional: Directory containing fragment files for changelog entries. Defaults to nil (disabled)
-  task.fragment_directory = "changelog_fragments"
+  # Optional: Configure fragment handling for changelog entries. Defaults to nil (disabled)
+  # Options:
+  #   - nil or false: Fragments disabled
+  #   - String path: Use directory-based fragments (e.g., "changelog_fragments")
+  #   - :git: Extract changelog entries from git commit trailers
+  task.fragment = "changelog_fragments"
+  # task.fragment = :git  # Use git trailers for changelog entries
   
   # Optional: Whether to clear fragment files after releasing. Defaults to false
-  # When true, fragments are cleared after a release
+  # When true, fragments are cleared after a release (only applies when using directory fragments)
+  # Note: Has no effect when using :git fragments
   task.clear_fragments = true
   
+  # Deprecated: Use `fragment` instead of `fragment_directory`
+  # task.fragment_directory = "changelog_fragments"  # DEPRECATED: Use task.fragment instead
+
   # Optional: Retain changelog files for previous versions. Defaults to false
   # Options: true (retain in "changelogs" directory), "path/to/archive", or a Proc
   task.retain_changelogs = true
@@ -125,6 +135,67 @@ Reissue::Task.create :reissue do |task|
 end
 ```
 
+## Using Git Trailers for Changelog Entries
+
+Reissue can extract changelog entries directly from git commit messages using trailers. This keeps your changelog data close to the code changes.
+
+### Configuration
+
+```ruby
+Reissue::Task.create :reissue do |task|
+  task.version_file = "lib/my_gem/version.rb"
+  task.fragment = :git  # Enable git trailer extraction
+end
+```
+
+### Adding Trailers to Commits
+
+Use changelog section names as trailer keys in your commit messages:
+
+```bash
+git commit -m "Implement user authentication
+
+Added: User login and logout functionality
+Added: Password reset via email
+Fixed: Session timeout not working correctly
+Security: Rate limiting on login attempts"
+```
+
+### Supported Sections
+
+Git trailers use the standard Keep a Changelog sections:
+- `Added:` for new features
+- `Changed:` for changes in existing functionality
+- `Deprecated:` for soon-to-be removed features
+- `Removed:` for now removed features
+- `Fixed:` for any bug fixes
+- `Security:` for vulnerability fixes
+
+### How It Works
+
+1. When you run `rake reissue`, it finds all commits since the last version tag
+2. Extracts trailers matching changelog sections from commit messages
+3. Adds them to the appropriate sections in your CHANGELOG.md
+4. Trailers are case-insensitive (e.g., `fixed:`, `Fixed:`, `FIXED:` all work)
+
+### Example Workflow
+
+```bash
+# Make your changes
+git add .
+git commit -m "Add export functionality
+
+Added: CSV export for user data
+Added: PDF report generation
+Fixed: Date formatting in exports"
+
+# Release (trailers are automatically extracted)
+rake build:checksum
+rake release
+```
+
+The changelog will be updated with the entries from your commit trailers.
+
 ## Development
 
 After checking out the repo, run `bin/setup` to install dependencies. Then run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt.

data/Rakefile

@@ -16,6 +16,7 @@ require_relative "lib/reissue/gem"
 
 Reissue::Task.create :reissue do |task|
   task.version_file = "lib/reissue/version.rb"
+  task.fragment = :git  # Use git trailers for changelog entries
   task.push_finalize = :branch
-  task.clear_fragments = true
+  # Note: clear_fragments has no effect with :git
 end

data/lib/reissue/changelog_updater.rb

@@ -1,6 +1,6 @@
 require_relative "parser"
 require_relative "printer"
-require_relative "fragment_reader"
+require_relative "fragment_handler"
 
 module Reissue
   # Updates the changelog file with new versions and changes.
@@ -19,9 +19,16 @@ module Reissue
     # @param changes [Hash] The changes for the version (default: {}).
     # @param changelog_file [String] The path to the changelog file (default: @changelog_file).
     # @param version_limit [Integer] The number of versions to keep (default: 2).
-    # @param fragment_directory [String] The directory containing fragment files (default: nil).
-    def call(version, date: "Unreleased", changes: {}, changelog_file: @changelog_file, version_limit: 2, retain_changelogs: false, fragment_directory: nil)
-      update(version, date:, changes:, version_limit:, fragment_directory:)
+    # @param fragment [String] The fragment source configuration (default: nil).
+    # @param fragment_directory [String] @deprecated Use fragment instead
+    def call(version, date: "Unreleased", changes: {}, changelog_file: @changelog_file, version_limit: 2, retain_changelogs: false, fragment: nil, fragment_directory: nil)
+      # Handle deprecation
+      if fragment_directory && !fragment
+        warn "[DEPRECATION] `fragment_directory` parameter is deprecated. Please use `fragment` instead."
+        fragment = fragment_directory
+      end
+
+      update(version, date:, changes:, version_limit:, fragment:)
       write(changelog_file, retain_changelogs:)
 
       changelog
@@ -48,16 +55,16 @@ module Reissue
     # @param date [String] The release date (default: "Unreleased").
     # @param changes [Hash] The changes for the version (default: {}).
     # @param version_limit [Integer] The number of versions to keep (default: 2).
-    # @param fragment_directory [String] The directory containing fragment files (default: nil).
+    # @param fragment [String] The fragment source configuration (default: nil).
     # @return [Hash] The updated changelog.
-    def update(version, date: "Unreleased", changes: {}, version_limit: 2, fragment_directory: nil)
+    def update(version, date: "Unreleased", changes: {}, version_limit: 2, fragment: nil)
       @changelog = Parser.parse(File.read(@changelog_file))
 
-      # Merge fragment changes if directory is provided
+      # Merge fragment changes if source is provided
       merged_changes = changes.dup
-      if fragment_directory
-        fragment_reader = FragmentReader.new(fragment_directory)
-        fragment_changes = fragment_reader.read
+      if fragment
+        handler = FragmentHandler.for(fragment)
+        fragment_changes = handler.read
         fragment_changes.each do |section, entries|
           merged_changes[section] ||= []
           merged_changes[section].concat(entries)

data/lib/reissue/{fragment_reader.rb → fragment_handler/directory_fragment_handler.rb}

@@ -1,14 +1,27 @@
+# frozen_string_literal: true
+
 require "pathname"
 
 module Reissue
-  class FragmentReader
+  # Handler for reading fragments from a directory
+  class DirectoryFragmentHandler < FragmentHandler
     DEFAULT_VALID_SECTIONS = %w[added changed deprecated removed fixed security].freeze
 
-    def initialize(fragment_directory = "changelog.d", valid_sections: DEFAULT_VALID_SECTIONS)
-      @fragment_directory = Pathname.new(fragment_directory)
+    attr_reader :directory, :valid_sections
+
+    # Initialize the handler with a directory path
+    #
+    # @param directory [String] The path to the fragments directory
+    # @param valid_sections [Array<String>, nil] List of valid section names, or nil to allow all
+    def initialize(directory, valid_sections: DEFAULT_VALID_SECTIONS)
+      @directory = directory
+      @fragment_directory = Pathname.new(directory)
       @valid_sections = valid_sections
     end
 
+    # Read fragments from the directory
+    #
+    # @return [Hash] A hash of changelog entries organized by category
     def read
       return {} unless @fragment_directory.exist?
 
@@ -35,6 +48,9 @@ module Reissue
       fragments
     end
 
+    # Clear all fragment files from the directory
+    #
+    # @return [nil]
     def clear
       return unless @fragment_directory.exist?
 

data/lib/reissue/fragment_handler/git_fragment_handler.rb

@@ -0,0 +1,93 @@
+# frozen_string_literal: true
+
+module Reissue
+  class FragmentHandler
+    # Handles reading changelog entries from git commit trailers
+    class GitFragmentHandler < FragmentHandler
+      # Regex to match changelog section trailers in commit messages
+      TRAILER_REGEX = /^(Added|Changed|Deprecated|Removed|Fixed|Security):\s*(.+)$/i
+
+      # Valid changelog sections that can be used as trailers
+      VALID_SECTIONS = %w[Added Changed Deprecated Removed Fixed Security].freeze
+
+      # Read changelog entries from git commit trailers
+      #
+      # @return [Hash] A hash of changelog entries organized by section
+      def read
+        return {} unless git_available? && in_git_repo?
+
+        commits = commits_since_last_tag
+        parse_trailers_from_commits(commits)
+      end
+
+      # Clear operation is a no-op for git trailers
+      #
+      # @return [nil]
+      def clear
+        nil
+      end
+
+      private
+
+      def git_available?
+        system("git --version", out: File::NULL, err: File::NULL)
+      end
+
+      def in_git_repo?
+        system("git rev-parse --git-dir", out: File::NULL, err: File::NULL)
+      end
+
+      def commits_since_last_tag
+        last_tag = find_last_tag
+
+        commit_range = if last_tag
+          # Get commits since the last tag
+          "#{last_tag}..HEAD"
+        else
+          # No tags found, get all commits
+          "HEAD"
+        end
+
+        # Get commit messages with trailers, in reverse order (oldest first)
+        output = `git log #{commit_range} --reverse --format=%B 2>/dev/null`
+        return [] if output.empty?
+
+        # Split by double newline to separate commits
+        output.split(/\n\n+/)
+      end
+
+      def find_last_tag
+        # Try to find the most recent tag
+        tag = `git describe --tags --abbrev=0 2>/dev/null`.strip
+        tag.empty? ? nil : tag
+      end
+
+      def parse_trailers_from_commits(commits)
+        result = {}
+
+        commits.each do |commit|
+          # Split commit into lines and look for trailers
+          commit.lines.each do |line|
+            line = line.strip
+            next if line.empty?
+
+            if (match = line.match(TRAILER_REGEX))
+              section_name = normalize_section_name(match[1])
+              trailer_value = match[2].strip
+
+              result[section_name] ||= []
+              result[section_name] << trailer_value
+            end
+          end
+        end
+
+        result
+      end
+
+      def normalize_section_name(name)
+        # Normalize to proper case (e.g., "FIXED" -> "Fixed", "added" -> "Added")
+        name.capitalize
+      end
+    end
+  end
+end

data/lib/reissue/fragment_handler/null_fragment_handler.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+module Reissue
+  # Handler for when no fragment source is configured
+  class NullFragmentHandler < FragmentHandler
+    # Read fragments (returns empty hash since no source is configured)
+    #
+    # @return [Hash] An empty hash
+    def read
+      {}
+    end
+
+    # Clear fragments (no-op since no source is configured)
+    #
+    # @return [nil]
+    def clear
+      nil
+    end
+  end
+end

data/lib/reissue/fragment_handler.rb

@@ -0,0 +1,45 @@
+# frozen_string_literal: true
+
+module Reissue
+  # Base class for handling fragment reading from various sources
+  class FragmentHandler
+    # Read fragments from the configured source
+    #
+    # @return [Hash] A hash of changelog entries organized by category
+    # @raise [NotImplementedError] Must be implemented by subclasses
+    def read
+      raise NotImplementedError, "Subclasses must implement #read"
+    end
+
+    # Clear fragments from the configured source
+    #
+    # @raise [NotImplementedError] Must be implemented by subclasses
+    def clear
+      raise NotImplementedError, "Subclasses must implement #clear"
+    end
+
+    # Factory method to create the appropriate handler for the given option
+    #
+    # @param fragment_option [nil, String, Symbol] The fragment configuration
+    # @param valid_sections [Array<String>, nil] List of valid section names (for directory handler)
+    # @return [FragmentHandler] The appropriate handler instance
+    # @raise [ArgumentError] If the option is not supported
+    def self.for(fragment_option, valid_sections: nil)
+      case fragment_option
+      when nil
+        require_relative "fragment_handler/null_fragment_handler"
+        NullFragmentHandler.new
+      when String
+        require_relative "fragment_handler/directory_fragment_handler"
+        options = {}
+        options[:valid_sections] = valid_sections if valid_sections
+        DirectoryFragmentHandler.new(fragment_option, **options)
+      when :git
+        require_relative "fragment_handler/git_fragment_handler"
+        GitFragmentHandler.new
+      else
+        raise ArgumentError, "Invalid fragment option: #{fragment_option.inspect}"
+      end
+    end
+  end
+end

data/lib/reissue/rake.rb

@@ -36,9 +36,24 @@ module Reissue
     # Provide a callable to decide how to store the files.
     attr_accessor :retain_changelogs
 
-    # The directory containing fragment files for changelog entries.
-    # Default: nil (disabled).
-    attr_accessor :fragment_directory
+    # The fragment configuration for changelog entries.
+    # @return [String, nil] nil (disabled) or a directory path string for fragment files
+    # @example Using directory-based fragments
+    #   task.fragment = "changelog_fragments"
+    # @note Default: nil (disabled)
+    attr_accessor :fragment
+
+    # @deprecated Use {#fragment} instead
+    def fragment_directory=(value)
+      warn "[DEPRECATION] `fragment_directory` is deprecated. Please use `fragment` instead."
+      self.fragment = value
+    end
+
+    # @deprecated Use {#fragment} instead
+    def fragment_directory
+      warn "[DEPRECATION] `fragment_directory` is deprecated. Please use `fragment` instead."
+      @fragment
+    end
 
     # Whether to clear fragment files after processing.
     # Default: false.
@@ -85,7 +100,7 @@ module Reissue
       @updated_paths = []
       @changelog_file = "CHANGELOG.md"
       @retain_changelogs = false
-      @fragment_directory = nil
+      @fragment = nil
       @clear_fragments = false
       @commit = true
       @commit_finalize = true
@@ -132,7 +147,7 @@ module Reissue
           version_file:,
           version_limit:,
           version_redo_proc:,
-          fragment_directory:
+          fragment: fragment
         )
         bundle
 
@@ -177,7 +192,7 @@ module Reissue
           date,
           changelog_file:,
           retain_changelogs:,
-          fragment_directory:
+          fragment: fragment
         )
         finalize_message = "Finalize the changelog for version #{version} on #{date}"
         if commit_finalize
@@ -218,14 +233,49 @@ module Reissue
         system("git push origin HEAD")
       end
 
+      desc "Preview changelog entries that will be added from fragments or git trailers"
+      task "#{name}:preview" do
+        if fragment
+          require_relative "fragment_handler"
+          handler = Reissue::FragmentHandler.for(fragment)
+          entries = handler.read
+
+          if entries.empty?
+            puts "No changelog entries found."
+            if fragment == :git
+              puts "  (No git trailers found since last version tag)"
+            else
+              puts "  (No fragment files found in '#{fragment}')"
+            end
+          else
+            puts "Changelog entries that will be added:\n\n"
+            # Sort sections in Keep a Changelog order
+            section_order = %w[Added Changed Deprecated Removed Fixed Security]
+            sorted_sections = entries.keys.sort_by { |k| section_order.index(k) || 999 }
+
+            sorted_sections.each do |section|
+              items = entries[section]
+              puts "### #{section}\n"
+              items.each { |item| puts "- #{item}" }
+              puts
+            end
+
+            puts "Total: #{entries.values.flatten.count} entries across #{entries.keys.count} sections"
+          end
+        else
+          puts "Fragment handling is not configured."
+          puts "Set task.fragment to a directory path or :git to enable changelog fragments."
+        end
+      end
+
       desc "Clear fragments"
       task "#{name}:clear_fragments" do
         # Clear fragments after release if configured
-        if fragment_directory && clear_fragments
-          formatter.clear_fragments(fragment_directory)
+        if fragment && clear_fragments
+          formatter.clear_fragments(fragment)
           clear_message = "Clear changelog fragments"
           if commit_clear_fragments
-            system("git add #{fragment_directory}")
+            system("git add #{fragment}")
             system("git commit -m '#{clear_message}'")
           else
             system("echo '#{clear_message}'")

data/lib/reissue/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Reissue
-  VERSION = "0.4.1"
+  VERSION = "0.4.2"
 end

data/lib/reissue.rb

@@ -3,7 +3,7 @@
 require_relative "reissue/version"
 require_relative "reissue/version_updater"
 require_relative "reissue/changelog_updater"
-require_relative "reissue/fragment_reader"
+require_relative "reissue/fragment_handler"
 
 # Reissue is a module that provides functionality for updating version numbers and changelogs.
 module Reissue
@@ -15,7 +15,8 @@ module Reissue
   # @param date [String] The release date. Default: Unreleased
   # @param changes [Hash] The changes made in this release. Default: {}
   # @param version_limit [Integer] The number of versions to retain in the changes. Default: 2
-  # @param fragment_directory [String] The directory containing fragment files. Default: nil
+  # @param fragment [String, nil] The fragment source configuration (directory path or nil to disable). Default: nil
+  # @param fragment_directory [String] @deprecated Use fragment parameter instead
   #
   # @return [String] The new version number.
   def self.call(
@@ -27,13 +28,20 @@ module Reissue
     changes: {},
     version_limit: 2,
     version_redo_proc: nil,
+    fragment: nil,
     fragment_directory: nil
   )
+    # Handle deprecation
+    if fragment_directory && !fragment
+      warn "[DEPRECATION] `fragment_directory` parameter is deprecated. Please use `fragment` instead."
+      fragment = fragment_directory
+    end
+
     version_updater = VersionUpdater.new(version_file, version_redo_proc:)
     new_version = version_updater.call(segment, version_file:)
     if changelog_file
       changelog_updater = ChangelogUpdater.new(changelog_file)
-      changelog_updater.call(new_version, date:, changes:, changelog_file:, version_limit:, retain_changelogs:, fragment_directory:)
+      changelog_updater.call(new_version, date:, changes:, changelog_file:, version_limit:, retain_changelogs:, fragment:)
     end
     new_version
   end
@@ -42,14 +50,21 @@ module Reissue
   #
   # @param date [String] The release date.
   # @param changelog_file [String] The path to the changelog file.
-  # @param fragment_directory [String] The directory containing fragment files. Default: nil
+  # @param fragment [String, nil] The fragment source configuration (directory path or nil to disable). Default: nil
+  # @param fragment_directory [String] @deprecated Use fragment parameter instead
   #
   # @return [Array] The version number and release date.
-  def self.finalize(date = Date.today, changelog_file: "CHANGELOG.md", retain_changelogs: false, fragment_directory: nil)
+  def self.finalize(date = Date.today, changelog_file: "CHANGELOG.md", retain_changelogs: false, fragment: nil, fragment_directory: nil)
+    # Handle deprecation
+    if fragment_directory && !fragment
+      warn "[DEPRECATION] `fragment_directory` parameter is deprecated. Please use `fragment` instead."
+      fragment = fragment_directory
+    end
+
     changelog_updater = ChangelogUpdater.new(changelog_file)
 
     # If fragments are present, we need to update the unreleased version with them first
-    if fragment_directory
+    if fragment
       # Get the current changelog to find the unreleased version
       changelog = Parser.parse(File.read(changelog_file))
       unreleased_version = changelog["versions"].find { |v| v["date"] == "Unreleased" }
@@ -60,7 +75,7 @@ module Reissue
           unreleased_version["version"],
           date: "Unreleased",
           changes: unreleased_version["changes"] || {},
-          fragment_directory: fragment_directory,
+          fragment: fragment,
           version_limit: changelog["versions"].size
         )
         changelog_updater.write(changelog_file, retain_changelogs: false)
@@ -113,13 +128,13 @@ module Reissue
     )
   end
 
-  # Clears all fragment files in the specified directory.
+  # Clears all fragment files in the specified source.
   #
-  # @param fragment_directory [String] The directory containing fragment files.
-  def self.clear_fragments(fragment_directory)
-    return unless fragment_directory && Dir.exist?(fragment_directory)
+  # @param fragment [String] The fragment source configuration.
+  def self.clear_fragments(fragment)
+    return unless fragment
 
-    fragment_reader = FragmentReader.new(fragment_directory)
-    fragment_reader.clear
+    handler = FragmentHandler.for(fragment)
+    handler.clear
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: reissue
 version: !ruby/object:Gem::Version
-  version: 0.4.1
+  version: 0.4.2
 platform: ruby
 authors:
 - Jim Gay
@@ -36,7 +36,10 @@ files:
 - Rakefile
 - lib/reissue.rb
 - lib/reissue/changelog_updater.rb
-- lib/reissue/fragment_reader.rb
+- lib/reissue/fragment_handler.rb
+- lib/reissue/fragment_handler/directory_fragment_handler.rb
+- lib/reissue/fragment_handler/git_fragment_handler.rb
+- lib/reissue/fragment_handler/null_fragment_handler.rb
 - lib/reissue/gem.rb
 - lib/reissue/markdown.rb
 - lib/reissue/parser.rb