reissue 0.1.1 → 0.1.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a1a62997c7d2c3f990658a361c9db7e9c197b13acacf8ed25f600f862aca6eda
-  data.tar.gz: a427559b697af802e3048ac24e96fffb783bbbd8ee9e970e28075f39580f3ae0
+  metadata.gz: f27889f6d76a5e88ff44237fff80ff0364d9659bc8d656d23a508a6c5950dd44
+  data.tar.gz: 102c22650f1cc0e74775efe6b79646bc4f4aec3063aef2a9b8c6c0492849725e
 SHA512:
-  metadata.gz: b83c26346790a184c193d577428eb5ed32419f9a68ed9c7e0a60e8a97bf5d4aad654cfdd591fe4e277cace7050bd3b77282967386df58a8e65e878b37fa2863e
-  data.tar.gz: bd7fdc98ce401fd1012bacb7d123a131163c666d8061f5996b2ef312371b807c87b81cab48c5e8ccbf9b49c2c656b21b1ce61745fac05c72a5e07ff24923e7ea
+  metadata.gz: ef4281eae4ac476c5373b3980df1a5680664fa5a29eef206ff11649363e032d50d877dda2c6fb0d568fcd431de8a00653b8f13383f73cd7dbc4054ecfe0c8456
+  data.tar.gz: 56581361691afd94738f157cf7b0d85d0fdfe9e449575ca95ea61d5f8c1de0a9c3d329e2a12162c0165082e41425016cb78482a088018128f06ac0a6ab7ecb4c

data/CHANGELOG.md

@@ -1,35 +1,26 @@
-# Change log
+# Changelog
 
 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.1] - 2024-06-08
+## [0.1.3] - 2024-06-09
 
-### Added:
+### 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
+- Support for alhpa characters in version numbers
+- Support for English names for Greek alphabet letters in version numbers
 
-### Fixed:
-
-- bug in tests loading the changelog fixture
-- format of the changelog file
+### Fixed
 
-### Removed:
+- Reissue.finalize returns the version and value as an array
+- Documentation on the refined redo method in Gem::Version
+- Limit major numbers to Integers
+- Handle empty changelog files
 
-- dependency on the keepachangelog gem
+## [0.1.2] - 2024-06-08
 
-## [0.1.0] - 2024-04-11
-
-### Added:
+### Fixed:
 
-- Initial release
+- Fix references to Gem::Version from the top level

data/README.md

@@ -12,6 +12,15 @@ update the changelog with a new version and a date.
 
 Use Reissue to prepare your first commit going into the new version.
 
+Standard procedure for releasing projects with Reissue:
+
+1. Create a version with some number like 0.1.0.
+2. Add commits to the project. These will be associated with the version 0.1.0.
+3. When you are releasing your project, finalize it by running
+  `rake reissue:finalize` to update the Unreleased version in your changelog.
+4. Bump the version to 0.1.1 with `rake reissue[patch]` and commit those changes.
+   Future commits will be associated with the version 0.1.1 until your next release.
+
 ## Installation
 
 Install the gem and add to the application's Gemfile by executing:

data/lib/reissue/parser.rb

@@ -30,14 +30,14 @@ module Reissue
 
     def parse_title(scanner)
       scanner.scan(/# ([\w\s]+)$/)
-      title = scanner[1].strip
+      title = scanner[1].to_s.strip
       {"title" => title}
     end
 
     def parse_preamble(scanner)
       preamble = scanner.scan_until(VERSION_MATCH)
-      preamble = preamble.gsub(VERSION_BREAK, "").strip
-      scanner.unscan
+      preamble = preamble.to_s.gsub(VERSION_BREAK, "").strip
+      scanner.unscan unless preamble.empty?
       {"preamble" => preamble.strip}
     end
 

data/lib/reissue/printer.rb

@@ -2,8 +2,8 @@ module Reissue
   class Printer
     def initialize(changelog)
       @changelog = changelog
-      @title = @changelog["title"]
-      @preamble = @changelog["preamble"]
+      @title = @changelog["title"] || "Changelog"
+      @preamble = @changelog["preamble"] || "All project changes are documented in this file."
       @versions = versions
     end
 
@@ -29,7 +29,13 @@ module Reissue
           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.then do |data|
+        if data.empty?
+          "## [0.0.0] - Unreleased"
+        else
+          data.join("\n\n")
+        end
+      end
     end
 
     def format_section(section, changes)

data/lib/reissue/rake.rb

@@ -81,10 +81,13 @@ module Reissue
       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:)
+        version, date = Reissue.finalize(date, changelog_file:)
+        finalize_message = "Finalize the changelog for version #{version} on #{date}"
         if commit_finalize
           system("git add -u")
-          system("git commit -m 'Finalize the changelog for version '")
+          system("git commit -m '#{finalize_message}'")
+        else
+          system("echo '#{finalize_message}'")
         end
       end
     end

data/lib/reissue/version.rb

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

data/lib/reissue/version_updater.rb

@@ -1,20 +1,50 @@
 module Reissue
+  module_function def greeks
+    %w[alpha beta gamma delta epsilon zeta eta theta kappa lambda mu nu xi omicron pi rho sigma tau upsilon phi chi psi omega]
+  end
+
   # Provides versioning functionality for the application.
   module Versioning
     # Provides versioning functionality for the application.
-    refine Gem::Version do
+    refine ::Gem::Version do
       # Redoes the version based on the specified segment_name.
       #
       # @param segment_name [Symbol] The segment_name to redo the version.
-      #   Possible values are :major, :minor, or any other symbol.
+      #   Possible values are :major, :minor, :patch, or :pre.
       # @return [Gem::Version] The updated version.
       def redo(segment_name)
-        if segment_name.to_s == "major"
-          Gem::Version.new("#{segments[0].to_i + 1}.0.0")
-        elsif segment_name.to_s == "minor"
-          Gem::Version.new("#{segments[0]}.#{segments[1].to_i + 1}.0")
+        new_segments = case segment_name.to_sym
+        when :major
+          [segments[0].next, 0, 0]
+        when :minor
+          [segments[0], segments[1].next, 0]
+        when :patch
+          segments.slice(0, 2) + segments.slice(2..-1).then { |array|
+            array[-1] = array[-1].next
+            [array.map(&:to_s).join]
+          }
+        when :pre
+          segments.slice(0, 3) + segments.slice(3..-1).then { |array|
+            array[-1] = array[-1].next
+            [array.map(&:to_s).join]
+          }
+        else
+          raise ArgumentError, "Invalid segment name: #{segment_name}"
+        end
+        ::Gem::Version.create(new_segments.join("."))
+      end
+    end
+
+    refine ::String do
+      def greek?
+        Reissue.greeks.include?(downcase)
+      end
+
+      def next
+        if greek?
+          Reissue.greeks[Reissue.greeks.index(downcase).next]
         else
-          Gem::Version.new("#{segments[0]}.#{segments[1]}.#{segments[2].to_i + 1}")
+          succ
         end
       end
     end
@@ -53,8 +83,8 @@ module Reissue
     def update(segment)
       version_file = File.read(@version_file)
       @updated_body = version_file.gsub(version_regex) do |string|
-        @original_version = Gem::Version.new(string)
-        @new_version = Gem::Version.new(string).redo(segment).to_s
+        @original_version = ::Gem::Version.new(string)
+        @new_version = ::Gem::Version.new(string).redo(segment).to_s
       end
       @new_version
     end
@@ -62,7 +92,8 @@ module Reissue
     # Regular expression pattern for matching the version string.
     #
     # @return [Regexp] The version regex pattern.
-    def version_regex = /(?<major>\d+)\.(?<minor>\d+)\.(?<patch>\d+)/
+    VERSION_MATCH = /(?<major>\d+)\.(?<minor>[a-zA-Z\d]+)\.(?<patch>[a-zA-Z\d]+)(?<add>\.(?<pre>[a-zA-Z\d]+))?/
+    def version_regex = VERSION_MATCH
 
     # Writes the updated version to the specified file.
     #

data/lib/reissue.rb

@@ -42,7 +42,7 @@ module Reissue
   def self.finalize(date = Date.today, changelog_file: "CHANGELOG.md")
     changelog_updater = ChangelogUpdater.new(changelog_file)
     changelog = changelog_updater.finalize(date:, changelog_file:)
-    changelog["versions"].first.slice("version", "date")
+    changelog["versions"].first.slice("version", "date").values
   end
 
   # Reformats the changelog file to ensure it is correctly formatted.

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: reissue
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.3
 platform: ruby
 authors:
 - Jim Gay