reissue 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: cea3fe8e5fffe1889e022f6acb6caf168c28e3af84c94639fbda06ce33dbf326
-  data.tar.gz: 68e0a7d97426359fdd708fbf147e62fc0904acaa93f245f3f1e4f39f7d1d940a
+  metadata.gz: a1a62997c7d2c3f990658a361c9db7e9c197b13acacf8ed25f600f862aca6eda
+  data.tar.gz: a427559b697af802e3048ac24e96fffb783bbbd8ee9e970e28075f39580f3ae0
 SHA512:
-  metadata.gz: 87626ce0220e19646aab027249f9555a5c201767db04ab146b2bb962aad302423a2f067a93c8c9993d62bafd208de0ff470c9b45376e7030efa4b2fa6c1f1d08
-  data.tar.gz: 159120e2c1656e1d30470f57bb9c7f2914747f1d8fd8ae88d2fa6f17a9bff8267f7c29be71d0c49c21d6898cff850532578ab1a2263c5cbcb5a4d0266e254966
+  metadata.gz: b83c26346790a184c193d577428eb5ed32419f9a68ed9c7e0a60e8a97bf5d4aad654cfdd591fe4e277cace7050bd3b77282967386df58a8e65e878b37fa2863e
+  data.tar.gz: bd7fdc98ce401fd1012bacb7d123a131163c666d8061f5996b2ef312371b807c87b81cab48c5e8ccbf9b49c2c656b21b1ce61745fac05c72a5e07ff24923e7ea

data/CHANGELOG.md

@@ -1,9 +1,35 @@
 # Change log
+
 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.1.0 - 2024-04-11
+## [0.1.1] - 2024-06-08
+
 ### Added:
+
+- bundle install when running reissue
+- handling of brackets in the changelog version numbers
+- Reissue::Parser class to parse the changelog file
+- Reissue::Printer class to print the changelog file
+- Reissue::Task class to handle the creation of reissue tasks
+- Return version and date from Reissue.finalize
+- Ability to limit the number of versions to maintain
+- Gem release support
+- Description of how to use and configure the gem in the README.md
+
+### Fixed:
+
+- bug in tests loading the changelog fixture
+- format of the changelog file
+
+### Removed:
+
+- dependency on the keepachangelog gem
+
+## [0.1.0] - 2024-04-11
+
+### Added:
+
 - Initial release

data/README.md

@@ -24,10 +24,75 @@ If bundler is not being used to manage dependencies, install the gem by executin
 
 ## Usage
 
-Build your own release with rake tasks provided by the gem. The following tasks are available:
+If you are working with a gem, you can add the following to the Rakefile:
 
-- `rake reissue[segment]` - Prepare a new version for future work for the given version segment.
-- `rake reissue:finalize` - Update the CHANGELOG.md file with a date for the latest version.
+```ruby
+require "reissue/gem"
+
+Reissue::Task.create :reissue do |task|
+  # Required: The file to update with the new version number.
+  task.version_file = "lib/my_gem/version.rb"
+end
+```
+
+This will add the following rake tasks:
+
+- `rake reissue[segment]` - Prepare a new version for future work for the given
+  version segment.
+- `rake reissue:finalize[date]` - Update the CHANGELOG.md file with a date for
+  the latest version.
+- `rake reissue:reformat[version_limit]` - Reformat the CHANGELOG.md file and
+  optionally limit the number of versions to maintain.
+
+This will also update the `build` task from rubygems to first run
+`reissue:finalize` and then build the gem, ensuring that your changelog is
+up-to-date before the gem is built.
+
+It updates the `release` task from rubygems to run `reissue` after the gem is
+pushed to rubygems.
+
+Build your own release with rake tasks provided by the gem.
+
+Add the following to the Rakefile:
+
+```ruby
+require "reissue/rake"
+
+Reissue::Task.create :reissue do |task|
+  # Required: The file to update with the new version number.
+  task.version_file = "path/to/version.rb"
+end
+```
+
+When creating your task, you have additional options to customize the behavior:
+
+```ruby
+require "reissue/rake"
+
+Reissue::Task.create :your_name_and_namespace do |task|
+
+  # Required: The file to update with the new version number.
+  task.version_file = "path/to/version.rb"
+
+  # Optional: The name of the task. Defaults to "reissue".
+  task.name = "your_name_and_namespace"
+
+  # Optional: The description of the task.
+  task.description = "Prepare the next version of the gem."
+
+  # Optional: The file to update with the new version number.
+  task.changelog_file = "path/to/CHANGELOG.md"
+
+  # Optional: The number of versions to maintain in the changelog.
+  task.version_limit = 5
+
+  # Optional: Whether to commit the changes automatically. Defaults to true.
+  task.commit = false
+
+  # Optional: Whether or not to commit the results of the finalize task. Defaults to true.
+  task.finalize_commit = false
+end
+```
 
 ## Development
 
@@ -35,4 +100,4 @@ After checking out the repo, run `bin/setup` to install dependencies. Then, run
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/[SOFware]/reissue.
+Bug reports and pull requests are welcome on GitHub at https://github.com/SOFware/reissue.

data/Rakefile

@@ -12,17 +12,10 @@ end
 
 task default: :test
 
-desc "Prepare the code for work on a new version."
-task :reissue, [:segment] => ["build:checksum"] do |task, args|
-  require "reissue"
-  segment = args[:segment] || "patch"
-  Reissue.call(segment: segment, version_file: "lib/reissue/version.rb")
-end
+require_relative "lib/reissue/gem"
 
-namespace :reissue do
-  task :finalize, [:date] do |task, args|
-    require "reissue"
-    date = args[:date] || Time.now.strftime("%Y-%m-%d")
-    Reissue.finalize(date, changelog_file: "CHANGELOG.md")
-  end
+Reissue::Task.create :reissue do |task|
+  task.updated_paths << "checksums"
+  task.version_file = "lib/reissue/version.rb"
+  task.commit = false
 end

data/lib/reissue/changelog_updater.rb

@@ -1,4 +1,5 @@
-require "keepachangelog"
+require_relative "parser"
+require_relative "printer"
 
 module Reissue
   # Updates the changelog file with new versions and changes.
@@ -16,23 +17,24 @@ module Reissue
     # @param date [String] The release date (default: "Unreleased").
     # @param changes [Hash] The changes for the version (default: {}).
     # @param changelog_file [String] The path to the changelog file (default: @changelog_file).
-    def call(version, date: "Unreleased", changes: {}, changelog_file: @changelog_file)
-      update(version, date: date, changes: changes)
+    # @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)
+      update(version, date:, changes:, version_limit:)
       write(changelog_file)
       changelog
     end
 
     def finalize(date: Date.today, changelog_file: @changelog_file)
-      @changelog = Keepachangelog::MarkdownParser.parse(File.read(changelog_file))
+      @changelog = Parser.parse(File.read(changelog_file))
       # find the highest version number and if it is unreleased, update the date
-      version = changelog["versions"].keys.max
-      version_date = changelog.dig("versions", version, "date")
+      version = changelog["versions"].max_by { |v| ::Gem::Version.new(v["version"]) }
+      version_date = version["date"]
       if version_date.nil? || version_date == "Unreleased"
-        updated = changelog["versions"].delete(version)
-        new_version = version.sub(/\s-.*/, "")
-        changelog["versions"][new_version] = updated.merge("date" => date)
+        changelog["versions"].find do |v|
+          v["version"] == version["version"]
+        end["date"] = date
       end
-      write(changelog_file)
+      write
       changelog
     end
 
@@ -41,13 +43,24 @@ module Reissue
     # @param version [String] The version number.
     # @param date [String] The release date (default: "Unreleased").
     # @param changes [Hash] The changes for the version (default: {}).
-    def update(version, date: "Unreleased", changes: {})
-      @changelog = Keepachangelog::MarkdownParser.parse(File.read(@changelog_file))
+    # @param version_limit [Integer] The number of versions to keep (default: 2).
+    # @return [Hash] The updated changelog.
+    def update(version, date: "Unreleased", changes: {}, version_limit: 2)
+      @changelog = Parser.parse(File.read(@changelog_file))
 
-      changelog["versions"][version] = { "date" => date, "changes" => changes }
-      changes.each do |section, change|
-        changelog["versions"][version]["changes"][section] = change
-      end
+      changelog["versions"].unshift({"version" => version, "date" => date, "changes" => changes})
+      changelog["versions"] = changelog["versions"].first(version_limit)
+      changelog
+    end
+
+    # Reformats the changelog file to ensure it is correctly formatted.
+    #
+    # @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)
+      @changelog = Parser.parse(File.read(@changelog_file))
+      changelog["versions"] = changelog["versions"].first(version_limit)
+      write(result_file)
       changelog
     end
 
@@ -55,7 +68,7 @@ module Reissue
     #
     # @return [String] The Markdown string representation of the changelog.
     def to_s
-      Keepachangelog::MarkdownPrinter.new(changelog["versions"]).to_s
+      Printer.new(changelog).to_s
     end
 
     # Writes the changelog to the specified file.

data/lib/reissue/gem.rb

@@ -0,0 +1,20 @@
+require_relative "rake"
+require "rubygems"
+
+module Reissue
+  module Gem
+    def initialize(...)
+      super
+      @updated_paths << "checksums"
+    end
+  end
+end
+Reissue::Task.prepend Reissue::Gem
+
+# Run rake reissue:finalize _before_ the build task as a prerequisite.
+Rake::Task[:build].enhance(["reissue:finalize"])
+
+# Run the reissue task after the release task.
+Rake::Task["release"].enhance do
+  Rake::Task["reissue"].invoke
+end

data/lib/reissue/parser.rb

@@ -0,0 +1,99 @@
+require "strscan"
+
+module Reissue
+  class Parser
+    def self.parse(changelog)
+      new(changelog).parse
+    end
+
+    def initialize(changelog)
+      @changelog = changelog
+      @versions = {}
+      @parts = []
+    end
+
+    def parse
+      scanner = StringScanner.new(@changelog)
+      @parts << parse_title(scanner)
+      @parts << parse_preamble(scanner)
+      @parts << parse_versions(scanner)
+      @parts.compact.reduce(&:merge)
+    end
+
+    VERSION_BREAK = "## "
+    CHANGE_BREAK = "### "
+    VERSION_MATCH = /^#{VERSION_BREAK}/
+    VERSION_OR_CHANGE_MATCH = Regexp.union(CHANGE_BREAK, VERSION_BREAK)
+    VERSION_OR_CHANGE_OR_NEWLINE_MATCH = Regexp.union(/\n/, CHANGE_BREAK, VERSION_BREAK)
+
+    private
+
+    def parse_title(scanner)
+      scanner.scan(/# ([\w\s]+)$/)
+      title = scanner[1].strip
+      {"title" => title}
+    end
+
+    def parse_preamble(scanner)
+      preamble = scanner.scan_until(VERSION_MATCH)
+      preamble = preamble.gsub(VERSION_BREAK, "").strip
+      scanner.unscan
+      {"preamble" => preamble.strip}
+    end
+
+    def parse_versions(scanner)
+      until scanner.eos?
+        scanner.skip(/\s+/)
+        next_line = scanner.scan_until(VERSION_OR_CHANGE_OR_NEWLINE_MATCH)
+        break if next_line.nil? || next_line.strip.empty?
+        unless next_line.match?(VERSION_OR_CHANGE_MATCH)
+          parse_versions(scanner)
+        end
+        if next_line.match?(VERSION_MATCH)
+          scanner.scan_until(/(.+)\n/)
+          version, date = scanner[1].split(" - ")
+          date ||= "Unreleased"
+          version = version.gsub(VERSION_BREAK, "").strip.tr("[]", "")
+          changes = parse_changes(scanner)
+          @versions[version] = {"version" => version, "date" => date, "changes" => changes}
+          parse_versions(scanner)
+        end
+      end
+      {"versions" => @versions.values}
+    end
+
+    def parse_changes(scanner, changes: {})
+      return changes if scanner.eos?
+      scanner.skip(/\s+/)
+
+      next_line = scanner.scan_until(/\n/)
+      if next_line.nil? || next_line.strip.empty? || next_line.match?(VERSION_MATCH)
+        scanner.unscan
+        return changes
+      end
+
+      if next_line.match?(CHANGE_BREAK)
+        change_type = next_line.gsub(CHANGE_BREAK, "").strip
+        changes[change_type] = parse_change_list(scanner)
+      end
+      parse_changes(scanner, changes: changes)
+    end
+
+    def parse_change_list(scanner, collection: [])
+      return collection if scanner.eos?
+      scanner.skip(/\s+/)
+      change = scanner.scan_until(/\n/)
+      if change.nil? || change.strip.empty?
+        return collection
+      elsif change.match?(VERSION_OR_CHANGE_MATCH)
+        scanner.unscan
+        return collection
+      else
+        item = change.sub(/^\s?-\s?/, "").strip
+        collection << item
+        parse_change_list(scanner, collection:)
+      end
+      collection.reject(&:empty?).compact
+    end
+  end
+end

data/lib/reissue/printer.rb

@@ -0,0 +1,43 @@
+module Reissue
+  class Printer
+    def initialize(changelog)
+      @changelog = changelog
+      @title = @changelog["title"]
+      @preamble = @changelog["preamble"]
+      @versions = versions
+    end
+
+    def to_s = <<~MARKDOWN
+      # #{@title}
+
+      #{@preamble}
+
+      #{@versions}
+    MARKDOWN
+
+    private
+
+    def versions
+      @changelog["versions"].map do |data|
+        version = data["version"]
+        date = data["date"]
+        changes = data.fetch("changes") do
+          {}
+        end
+        version_string = "## [#{version}] - #{date}"
+        changes_string = changes.map do |section, changes|
+          format_section(section, changes)
+        end.join("\n\n")
+        [version_string, changes_string].filter_map { |str| str unless str.empty? }.join("\n\n")
+      end.join("\n\n")
+    end
+
+    def format_section(section, changes)
+      <<~MARKDOWN.strip
+        ### #{section}
+
+        #{changes.map { |change| "- #{change}" }.join("\n")}
+      MARKDOWN
+    end
+  end
+end

data/lib/reissue/rake.rb

@@ -0,0 +1,92 @@
+# frozen_string_literal: true
+
+require "rake/tasklib"
+require_relative "../reissue"
+
+module Reissue
+  class Task < Rake::TaskLib
+    def self.create name = :reissue, &block
+      task = new name
+      task.instance_eval(&block) if block
+      raise "No Reissue task.version_file specified" unless task.version_file
+      task.define
+      task
+    end
+
+    # The name of the main task and the namespace for the other tasks.
+    attr_accessor :name
+
+    # A description of the main task.
+    attr_accessor :description
+
+    # The path to the version file. Required.
+    attr_accessor :version_file
+
+    # The path to the changelog file.
+    attr_accessor :changelog_file
+
+    # Additional paths to add to the commit.
+    attr_accessor :updated_paths
+
+    # The number of versions to retain in the changelog file. Defaults to 2.
+    attr_accessor :version_limit
+
+    # Whether to commit the changes. Default: true.
+    attr_accessor :commit
+
+    # Whether to commit the finalize change to the changelog. Default: true.
+    attr_accessor :commit_finalize
+
+    def initialize(name = :reissue)
+      @name = name
+      @description = "Prepare the code for work on a new version."
+      @version_file = nil
+      @updated_paths = []
+      @changelog_file = "CHANGELOG.md"
+      @commit = true
+      @commit_finalize = true
+      @version_limit = 2
+    end
+
+    def define
+      desc description
+      task name, [:segment] do |task, args|
+        segment = args[:segment] || "patch"
+        new_version = Reissue.call(segment:, version_file:, version_limit:)
+        if defined?(Bundler)
+          Bundler.with_unbundled_env do
+            system("bundle install")
+          end
+        end
+
+        system("git add -u")
+        if updated_paths.any?
+          system("git add #{updated_paths.join(" ")}")
+        end
+
+        bump_message = "Bump version to #{new_version}"
+        if commit
+          system("git commit -m '#{bump_message}'")
+        else
+          system("echo '#{bump_message}'")
+        end
+      end
+
+      desc "Reformat the changelog file to ensure it is correctly formatted."
+      task "#{name}:reformat", [:version_limit] do |task, args|
+        version_limit = args[:version_limit].to_i || version_limit
+        Reissue.reformat(changelog_file, version_limit:)
+      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")
+        Reissue.finalize(date, changelog_file:)
+        if commit_finalize
+          system("git add -u")
+          system("git commit -m 'Finalize the changelog for version '")
+        end
+      end
+    end
+  end
+end

data/lib/reissue/version.rb

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

data/lib/reissue.rb

@@ -9,17 +9,26 @@ module Reissue
   # Updates the version number and changelog.
   #
   # @param version_file [String] The path to the version file.
-  # @param changelog_file [String] The path to the changelog file.
-  # @param segment [String] The segment of the version number to update.
-  # @param date [String] The release date.
-  # @param changes [Hash] The changes made in this release.
+  # @param changelog_file [String] The path to the changelog file. Default: CHANGELOG.md
+  # @param segment [String] The segment of the version number to update. Default: patch
+  # @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
+  #
   # @return [String] The new version number.
-  def self.call(version_file:, changelog_file: "CHANGELOG.md", segment: "patch", date: "Unreleased", changes: {})
+  def self.call(
+    version_file:,
+    changelog_file: "CHANGELOG.md",
+    segment: "patch",
+    date: "Unreleased",
+    changes: {},
+    version_limit: 2
+  )
     version_updater = VersionUpdater.new(version_file)
     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:)
+      changelog_updater.call(new_version, date:, changes:, changelog_file:, version_limit:)
     end
     new_version
   end
@@ -28,8 +37,20 @@ module Reissue
   #
   # @param date [String] The release date.
   # @param changelog_file [String] The path to the changelog file.
+  #
+  # @return [Array] The version number and release date.
   def self.finalize(date = Date.today, changelog_file: "CHANGELOG.md")
     changelog_updater = ChangelogUpdater.new(changelog_file)
-    changelog_updater.finalize(date:, changelog_file:)
+    changelog = changelog_updater.finalize(date:, changelog_file:)
+    changelog["versions"].first.slice("version", "date")
+  end
+
+  # Reformats the changelog file to ensure it is correctly formatted.
+  #
+  # @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)
+    changelog_updater = ChangelogUpdater.new(file)
+    changelog_updater.reformat(version_limit:)
   end
 end

metadata

@@ -1,17 +1,17 @@
 --- !ruby/object:Gem::Specification
 name: reissue
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Jim Gay
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-04-12 00:00:00.000000000 Z
+date: 2024-06-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: keepachangelog
+  name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -37,6 +37,10 @@ files:
 - Rakefile
 - lib/reissue.rb
 - lib/reissue/changelog_updater.rb
+- lib/reissue/gem.rb
+- lib/reissue/parser.rb
+- lib/reissue/printer.rb
+- lib/reissue/rake.rb
 - lib/reissue/version.rb
 - lib/reissue/version_updater.rb
 homepage: https://github.com/SOFware/reissue
@@ -60,7 +64,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.5
+rubygems_version: 3.5.9
 signing_key:
 specification_version: 4
 summary: Keep your versions and changelogs up to date and prepared for release.