reissue 0.1.7 → 0.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c277981b6bc7dc46a2ae0d84bddd6b8f04a7328d2bd0949d380bb948cb3acbff
-  data.tar.gz: d9078fed64c4fc984e150a6c03bcdcd912663e3f8c9d550b571b8ba77b55a644
+  metadata.gz: 2b4d0a53280207aedc9381894922ca1efb28e0acb20d5bd97bbcb7fe2cd6a7cc
+  data.tar.gz: d649658ae57c53e5d3e78c5096d9248ddf941f85c074e1e3543e0eeda12678d2
 SHA512:
-  metadata.gz: 3d1677cb2633cc8b3b19c5842fb7edbc7ef46e6f8299b5a8886385822ad07f2657f2f3ff44c77a0bb68027c3227a4ce8ec298bd00b8d585f765368f2a64f4673
-  data.tar.gz: 27d09c82326c667a357cd77c8f1536dbb163e72445ff6b1d02f97738a1bcc0ba28080e74f2ab2e21d6cf42fbf3c43c0e6b54607b9c4052e7791603f47c14e046
+  metadata.gz: 9b7adacabff52f5c82e2a0f703d2f808174caf2af29fd244200ea9f0f9ff91887a31336d69ed0d8e37ff52084128fc01677e70d0fc5d3c12b738ada62f916ede
+  data.tar.gz: 330d439a724f349bc7b1f18ee1a47ca7fecf913749452d460894d5e659a8a7fcc80e13140f6b78d3c36d66ec7d28caa6110877e0cf742a191b6203676ee7bd67

data/CHANGELOG.md

@@ -5,18 +5,26 @@ 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.7] - 2024-06-10
+## [0.2.1] - 2024-07-29
 
-### Fixed
+### Added
+
+- Release notes and the checksum for the 0.2.0 version
 
-- Pass the version_redo_proc to the Reissue.call in the reissue task.
+### Changed
 
-## [0.1.6] - 2024-06-10
+- Return the new version from the reissue task
+
+## [0.2.0] - 2024-07-02
 
 ### Added
 
-- The ability to specify the version_redo_proc to customize the version number update process.
+- Reissue::Markdown class to implement the Reissue::Parser.parse behavior
+
+### Removed
+
+- Reissue::Parser implementation
 
 ### Fixed
 
-- Incorrect testing of Reissue.reformat
+- Handle multiline changes

data/README.md

@@ -89,7 +89,7 @@ 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 number of versions to maintain in the changelog.
+  # Optional: The number of versions to maintain in the changelog. Defaults to 2.
   task.version_limit = 5
 
   # Optional: A Proc to format the version number. Receives a Gem::Version object, and segment.
@@ -97,7 +97,7 @@ Reissue::Task.create :your_name_and_namespace do |task|
     # your special versioning logic
   end
 
-  # Optional: The file to update with the new version number.
+  # Optional: The file to update with the new version number. Defaults to "CHANGELOG.md".
   task.changelog_file = "path/to/CHANGELOG.md"
 
   # Optional: Whether to commit the changes automatically. Defaults to true.
@@ -112,6 +112,15 @@ end
 
 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 that will allow you to experiment.
 
+## Releasing
+
+Run `rake build:checksum` to build the gem and generate the checksum. This will also update the version number in the gemspec file.
+
+Run `rake release` to create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+This will leave a new commit with the version number incremented in the version file and the changelog updated with the new version.
+Push the changes to the repository.
+
 ## Contributing
 
 Bug reports and pull requests are welcome on GitHub at https://github.com/SOFware/reissue.

data/lib/reissue/markdown.rb

@@ -0,0 +1,115 @@
+module Reissue
+  class Markdown
+    def self.parse(changelog)
+      new(changelog).to_h
+    end
+
+    def initialize(changelog)
+      @changelog = changelog
+      @versions = {}
+      @header = nil
+      @parts = []
+    end
+
+    def parse
+      return unless @header.nil? && @versions.empty?
+
+      header, *chunks = @changelog.split(/^## /)
+
+      @header = Header.new(header)
+      @versions = Array(chunks).map { |part| Version.new(part) }
+    end
+
+    def to_h
+      parse
+      @header.to_h.merge("versions" => @versions.map(&:to_h))
+    end
+
+    class Header
+      def initialize(chunk)
+        @chunk = chunk.to_s
+        @title = nil
+        @preamble = nil
+      end
+
+      def parse
+        return unless @title.nil? && @preamble.nil?
+
+        scanner = StringScanner.new(@chunk.dup << "\n")
+        scanner.scan(/# ([\w\s]+)$/)
+        @title = scanner[1].to_s.strip
+        # the rest of the text is the preamble
+        @preamble = scanner.rest.strip
+      end
+
+      def to_h
+        parse
+        {
+          "title" => @title,
+          "preamble" => @preamble
+        }
+      end
+    end
+
+    class Version
+      def initialize(chunk)
+        @chunk = chunk
+        @version = nil
+        @date = nil
+        @changes = []
+      end
+
+      def parse
+        return unless @version.nil? && @date.nil? && @changes.empty?
+        # the first line contains the version and date
+        scanner = StringScanner.new(@chunk) << "\n"
+        scanner.scan(/\[?(.[^\]]+)\]? - (.+)$/)
+        @version = scanner[1].to_s.strip
+        @date = scanner[2].to_s.strip || "Unreleased"
+
+        # the rest of the text is the changes
+        @changes = scanner.rest.strip.split("### ").reject(&:empty?).map { |change| Change.new(change) }
+      end
+
+      def to_h
+        parse
+        {
+          "version" => @version,
+          "date" => @date,
+          "changes" => @changes.inject({}) { |h, change| h.merge(change.to_h) }
+        }
+      end
+    end
+
+    class Change
+      def initialize(chunk)
+        @chunk = chunk
+        @type = nil
+        @changes = []
+      end
+
+      def parse
+        return unless @type.nil? && @changes.empty?
+        scanner = StringScanner.new(@chunk) << "\n"
+        scanner.scan(/([\w\s]+)$/)
+
+        @type = scanner[1].to_s.strip
+
+        # the rest of the text are the changes
+        @changes = scanner
+          .rest
+          .strip
+          .split(/^-/m)
+          .map { |change| change.strip.gsub(/^- /m, "") }
+          .reject(&:empty?)
+      end
+
+      def to_h
+        parse
+        {
+          @type => @changes.map { |change| change.split("\n").map(&:strip).join("\n  ") }
+        }
+      end
+    end
+  end
+end

data/lib/reissue/parser.rb

@@ -1,4 +1,5 @@
 require "strscan"
+require_relative "markdown"
 
 module Reissue
   class Parser
@@ -8,94 +9,10 @@ module Reissue
 
     def initialize(changelog)
       @changelog = changelog
-      @versions = {}
-      @parts = []
     end
 
     def parse
-      scanner = StringScanner.new(@changelog) << "\n"
-      @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].to_s.strip
-      {"title" => title}
-    end
-
-    def parse_preamble(scanner)
-      preamble = scanner.scan_until(VERSION_MATCH)
-      preamble = preamble.to_s.gsub(VERSION_BREAK, "").strip
-      scanner.unscan unless preamble.empty?
-      {"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?
-        return changes
-      elsif 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
+      Markdown.parse(@changelog).to_h
     end
   end
 end

data/lib/reissue/printer.rb

@@ -25,8 +25,8 @@ module Reissue
           {}
         end
         version_string = "## [#{version}] - #{date}"
-        changes_string = changes.map do |section, changes|
-          format_section(section, changes)
+        changes_string = changes.map do |section, section_changes|
+          format_section(section, section_changes)
         end.join("\n\n")
         [version_string, changes_string].filter_map { |str| str unless str.empty? }.join("\n\n")
       end.then do |data|

data/lib/reissue/rake.rb

@@ -74,6 +74,8 @@ module Reissue
         else
           system("echo '#{bump_message}'")
         end
+
+        new_version
       end
 
       desc "Reformat the changelog file to ensure it is correctly formatted."

data/lib/reissue/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: reissue
 version: !ruby/object:Gem::Version
-  version: 0.1.7
+  version: 0.2.1
 platform: ruby
 authors:
 - Jim Gay
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-06-10 00:00:00.000000000 Z
+date: 2024-07-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -38,6 +38,7 @@ files:
 - lib/reissue.rb
 - lib/reissue/changelog_updater.rb
 - lib/reissue/gem.rb
+- lib/reissue/markdown.rb
 - lib/reissue/parser.rb
 - lib/reissue/printer.rb
 - lib/reissue/rake.rb