reissue 0.2.2 → 0.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d7a30f436a8c3bdf476c8ef3a7547536e292b3b81cf207ff8efe92404eacf2e9
-  data.tar.gz: 20d5e0d023af7778e0de3d71859088b5baa216bc00c7ef09a46732e1dcc0712a
+  metadata.gz: c6ac7b4c6d82f57ed9e9733bfa072344ea79c3b5075aaf4789f40815be528ebd
+  data.tar.gz: a6eb54ae8e1037521b227f21869853292339c1b189e5ad8f060e62e044fdeaa4
 SHA512:
-  metadata.gz: fea5c4c4d7c7c4d7abcd43d038e9566de875892ee2cda0e95730f69c4108fd3a0304f99ec5ab3bcdd17b104719280b7610061973217eb9fc1277d265cb017238
-  data.tar.gz: 24a0fcfb969d6ba3640e3594a268cd192aa5b7316b49e88aa7059f918bfdb9fb0728aaf81df11cd3a61950ffea47af6c30d07725c12c6bdeac5ff742f08991e9
+  metadata.gz: 2481e4f823168b94f3374e97a3e2c55b7e394e4110c5fdd9cf8b4635b2919049e22de219f07d9efac7ec62168a97bc50a83227b30cad7fe5b8830268d95a43ca
+  data.tar.gz: 9ca6fa4a75c7c9037f4289febae72552b777fb31fe5576a349fcd8f608c350d89e9f6beb4a66662e298afb67c2ee2bef44cc81a5a86be57ef04486f5a8a4d2ed

data/CHANGELOG.md

@@ -5,24 +5,24 @@ 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.2.2] - 2024-09-06
+## [0.3.1] - 2025-01-16
 
 ### Added
 
-- Add a `reissue:branch` task to create a new branch for the next version
-- Add a `reissue:push` task to push the new branch to the remote repository
+- Add `retain_changelogs` option to control how to retain the changelog files for the previous versions.
 
-### Fixed
+### Changed
 
-- Require the 'date' library in tests to ensure the Date constant is present
-- Ensure that `updated_paths` are always enumerable
+- Set the name of the `reissue:branch` argument to `branch_name` to be clearer.
+- Inject the constants in the `create` method.
+- Updated the tested Ruby version to 3.4.
 
-## [0.2.1] - 2024-07-29
+## [0.3.0] - 2024-09-06
 
 ### Added
 
-- Release notes and the checksum for the 0.2.0 version
+- Add `push_reissue` option to control pushing changes to the remote repository.
 
 ### Changed
 
-- Return the new version from the reissue task
+- Default behavior of _this_ gem's release is to push finalize without a branch.

data/README.md

@@ -104,6 +104,16 @@ Reissue::Task.create :your_name_and_namespace do |task|
   # Optional: The file to update with the new version number. Defaults to "CHANGELOG.md".
   task.changelog_file = "path/to/CHANGELOG.md"
 
+  # Optional: A Boolean, String, or Proc to retain the changelog files for the previous versions. Defaults to false.
+  # Setting to true will retain the changelog files in the "changelogs" directory.
+  # Setting to a String will use that path as the directory to retain the changelog files.
+  # The Proc receives a version hash and the changelog content.
+  task.retain_changelogs = ->(version, content) do
+    # your special retention logic
+  end
+  # or task.retain_changelogs = "path/to/changelogs"
+  # or task.retain_changelogs = true
+
   # Optional: Whether to commit the changes automatically. Defaults to true.
   task.commit = false
 

data/Rakefile

@@ -16,5 +16,5 @@ require_relative "lib/reissue/gem"
 
 Reissue::Task.create :reissue do |task|
   task.version_file = "lib/reissue/version.rb"
-  task.push_finalize = :branch
+  task.push_finalize = true
 end

data/lib/reissue/changelog_updater.rb

@@ -18,23 +18,24 @@ 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).
-    def call(version, date: "Unreleased", changes: {}, changelog_file: @changelog_file, version_limit: 2)
+    def call(version, date: "Unreleased", changes: {}, changelog_file: @changelog_file, version_limit: 2, retain_changelogs: false)
       update(version, date:, changes:, version_limit:)
-      write(changelog_file)
+      write(changelog_file, retain_changelogs:)
       changelog
     end
 
-    def finalize(date: Date.today, changelog_file: @changelog_file)
+    def finalize(date: Date.today, changelog_file: @changelog_file, retain_changelogs: false)
       @changelog = Parser.parse(File.read(changelog_file))
+
       # find the highest version number and if it is unreleased, update the date
-      version = changelog["versions"].max_by { |v| ::Gem::Version.new(v["version"]) }
+      version = latest_version
       version_date = version["date"]
       if version_date.nil? || version_date == "Unreleased"
         changelog["versions"].find do |v|
           v["version"] == version["version"]
         end["date"] = date
       end
-      write
+      write(changelog_file, retain_changelogs:)
       changelog
     end
 
@@ -57,10 +58,10 @@ module Reissue
     #
     # @param changelog_file [String] The path to the changelog file (default: @changelog_file).
     # @return [Hash] The parsed changelog.
-    def reformat(result_file = @changelog_file, version_limit: 2)
+    def reformat(result_file = @changelog_file, version_limit: 2, retain_changelogs: false)
       @changelog = Parser.parse(File.read(@changelog_file))
       changelog["versions"] = changelog["versions"].first(version_limit)
-      write(result_file)
+      write(result_file, retain_changelogs:)
       changelog
     end
 
@@ -74,8 +75,34 @@ module Reissue
     # Writes the changelog to the specified file.
     #
     # @param changelog_file [String] The path to the changelog file (default: @changelog_file).
-    def write(changelog_file = @changelog_file)
+    def write(changelog_file = @changelog_file, retain_changelogs: false)
+      if retain_changelogs
+        store_current_changelog(latest_version, retain_changelogs)
+      end
       File.write(changelog_file, to_s)
     end
+
+    # Stores the current changelog in a file.
+    #
+    # @param version [Hash] The version information.
+    # @param path [String, Proc] The path to store the changelog or a callable that receives the version and the changelog.
+    def store_current_changelog(version, path)
+      if path
+        if path.respond_to?(:call)
+          path.call(version, to_s)
+        else
+          require "fileutils"
+          path = path.is_a?(String) ? path : "changelogs"
+          FileUtils.mkdir_p(path)
+          File.write("#{path}/#{version["version"]}.md", to_s)
+        end
+      end
+    end
+
+    private
+
+    def latest_version
+      changelog["versions"].max_by { |v| ::Gem::Version.new(v["version"]) }
+    end
   end
 end

data/lib/reissue/rake.rb

@@ -31,6 +31,11 @@ module Reissue
     # The path to the changelog file.
     attr_accessor :changelog_file
 
+    # Set to true to retain the changelog files for the previous versions.
+    # Default: false.
+    # Provide a callable to decide how to store the files.
+    attr_accessor :retain_changelogs
+
     # Additional paths to add to the commit.
     attr_writer :updated_paths
 
@@ -52,19 +57,34 @@ module Reissue
     # Set this to :branch to push to a new branch.
     attr_accessor :push_finalize
 
-    def initialize(name = :reissue)
+    # Whether to push the changes when a new version is created. Default: :branch.
+    # Requires commit to be true.
+    #
+    # Set this to false to disable pushing.
+    # Set this to true to push to the current branch.
+    # Set this to :branch to push to a new branch.
+    attr_accessor :push_reissue
+
+    def initialize(name = :reissue, formatter: Reissue, tasker: Rake::Task)
       @name = name
+      @formatter = formatter
+      @tasker = tasker
       @description = "Prepare the code for work on a new version."
       @version_file = nil
       @updated_paths = []
       @changelog_file = "CHANGELOG.md"
+      @retain_changelogs = false
       @commit = true
       @commit_finalize = true
       @push_finalize = false
       @version_limit = 2
       @version_redo_proc = nil
+      @push_reissue = :branch
     end
 
+    attr_reader :formatter, :tasker
+    private :formatter, :tasker
+
     def finalize_with_branch?
       push_finalize == :branch
     end
@@ -73,25 +93,41 @@ module Reissue
       !!push_finalize
     end
 
+    def reissue_version_with_branch?
+      push_reissue == :branch
+    end
+
+    def push_reissue?
+      !!push_reissue
+    end
+
+    def bundle
+      if defined?(Bundler)
+        Bundler.with_unbundled_env do
+          system("bundle install")
+        end
+      end
+    end
+
     def define
       desc description
       task name, [:segment] do |task, args|
         segment = args[:segment] || "patch"
-        new_version = Reissue.call(segment:, version_file:, version_limit:, version_redo_proc:)
-        if defined?(Bundler)
-          Bundler.with_unbundled_env do
-            system("bundle install")
-          end
-        end
+        new_version = formatter.call(segment:, version_file:, version_limit:, version_redo_proc:)
+        bundle
 
         system("git add -u")
-        if updated_paths.any?
+        if updated_paths&.any?
           system("git add #{updated_paths.join(" ")}")
         end
 
         bump_message = "Bump version to #{new_version}"
         if commit
+          if reissue_version_with_branch?
+            tasker["#{name}:branch"].invoke("reissue/#{new_version}")
+          end
           system("git commit -m '#{bump_message}'")
+          tasker["#{name}:push"].invoke if push_reissue?
         else
           system("echo '#{bump_message}'")
         end
@@ -106,28 +142,28 @@ module Reissue
         else
           args[:version_limit].to_i
         end
-        Reissue.reformat(changelog_file, version_limit:)
+        formatter.reformat(changelog_file, version_limit:, retain_changelogs:)
       end
 
       desc "Finalize the changelog for an unreleased version to set the release date."
       task "#{name}:finalize", [:date] do |task, args|
         date = args[:date] || Time.now.strftime("%Y-%m-%d")
-        version, date = Reissue.finalize(date, changelog_file:)
+        version, date = formatter.finalize(date, changelog_file:)
         finalize_message = "Finalize the changelog for version #{version} on #{date}"
         if commit_finalize
-          Rake::Task["#{name}:branch"].invoke("reissue/#{version}") if finalize_with_branch?
+          tasker["#{name}:branch"].invoke("reissue/#{version}") if finalize_with_branch?
           system("git add -u")
           system("git commit -m '#{finalize_message}'")
-          Rake::Task["#{name}:push"].invoke if push_finalize?
+          tasker["#{name}:push"].invoke if push_finalize?
         else
           system("echo '#{finalize_message}'")
         end
       end
 
       desc "Create a new branch for the next version."
-      task "#{name}:branch", [:branch] do |task, args|
-        raise "No branch name specified" unless args[:branch]
-        system("git checkout -b #{args[:branch]}")
+      task "#{name}:branch", [:branch_name] do |task, args|
+        raise "No branch name specified" unless args[:branch_name]
+        system("git checkout -b #{args[:branch_name]}")
       end
 
       desc "Push the current branch to the remote repository."

data/lib/reissue/version.rb

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

data/lib/reissue.rb

@@ -19,6 +19,7 @@ module Reissue
   def self.call(
     version_file:,
     changelog_file: "CHANGELOG.md",
+    retain_changelogs: false,
     segment: "patch",
     date: "Unreleased",
     changes: {},
@@ -29,7 +30,7 @@ module Reissue
     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:)
+      changelog_updater.call(new_version, date:, changes:, changelog_file:, version_limit:, retain_changelogs:)
     end
     new_version
   end
@@ -50,8 +51,9 @@ module Reissue
   #
   # @param file [String] The path to the changelog file.
   # @param version_limit [Integer] The number of versions to retain in the changelog. Default: 2
-  def self.reformat(file, version_limit: 2)
+  # @param retain_changelogs [Boolean, String, Proc] Whether to retain the changelog files for the previous versions.
+  def self.reformat(file, version_limit: 2, retain_changelogs: false)
     changelog_updater = ChangelogUpdater.new(file)
-    changelog_updater.reformat(version_limit:)
+    changelog_updater.reformat(version_limit:, retain_changelogs:)
   end
 end

metadata

@@ -1,14 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: reissue
 version: !ruby/object:Gem::Version
-  version: 0.2.2
+  version: 0.3.1
 platform: ruby
 authors:
 - Jim Gay
-autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-09-06 00:00:00.000000000 Z
+date: 2025-01-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -50,7 +49,6 @@ metadata:
   homepage_uri: https://github.com/SOFware/reissue
   source_code_uri: https://github.com/SOFware/reissue
   changelog_uri: https://github.com/SOFware/reissue/blob/main/CHANGELOG.md
-post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -65,8 +63,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.9
-signing_key:
+rubygems_version: 3.6.2
 specification_version: 4
 summary: Keep your versions and changelogs up to date and prepared for release.
 test_files: []