reissue 0.1.0

checksums.yaml

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

data/CHANGELOG.md

@@ -0,0 +1,9 @@
+# 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
+### Added:
+- Initial release

data/LICENSE.txt

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 SOFware LLC
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

data/README.md

@@ -0,0 +1,38 @@
+# Reissue
+
+Prepare the releases of your Ruby gems with ease.
+
+When creating versioned software, it is important to keep track of the changes and the versions that are released.
+
+After each release of a gem, you should immediatly bump the version with a new number and update the changelog with a place
+to capture the information about new changes.
+
+Reissue helps you to prepare the next version of your project by providing tools which will update version numbers and
+update the changelog with a new version and a date.
+
+Use Reissue to prepare your first commit going into the new version.
+
+## Installation
+
+Install the gem and add to the application's Gemfile by executing:
+
+    $ bundle add reissue
+
+If bundler is not being used to manage dependencies, install the gem by executing:
+
+    $ gem install reissue
+
+## Usage
+
+Build your own release with rake tasks provided by the gem. The following tasks are available:
+
+- `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.
+
+## 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 that will allow you to experiment.
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/[SOFware]/reissue.

data/Rakefile

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.warning = true
+  t.test_files = FileList["test/**/test_*.rb"]
+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
+
+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
+end

data/lib/reissue/changelog_updater.rb

@@ -0,0 +1,68 @@
+require "keepachangelog"
+
+module Reissue
+  # Updates the changelog file with new versions and changes.
+  class ChangelogUpdater
+    def initialize(changelog_file)
+      @changelog_file = changelog_file
+      @changelog = {}
+    end
+
+    attr_reader :changelog
+
+    # Updates the changelog with a new version and its changes.
+    #
+    # @param version [String] The version number.
+    # @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)
+      write(changelog_file)
+      changelog
+    end
+
+    def finalize(date: Date.today, changelog_file: @changelog_file)
+      @changelog = Keepachangelog::MarkdownParser.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")
+      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)
+      end
+      write(changelog_file)
+      changelog
+    end
+
+    # Updates the changelog with a new version and its changes.
+    #
+    # @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))
+
+      changelog["versions"][version] = { "date" => date, "changes" => changes }
+      changes.each do |section, change|
+        changelog["versions"][version]["changes"][section] = change
+      end
+      changelog
+    end
+
+    # Returns the string representation of the changelog.
+    #
+    # @return [String] The Markdown string representation of the changelog.
+    def to_s
+      Keepachangelog::MarkdownPrinter.new(changelog["versions"]).to_s
+    end
+
+    # 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)
+      File.write(changelog_file, to_s)
+    end
+  end
+end

data/lib/reissue/version.rb

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

data/lib/reissue/version_updater.rb

@@ -0,0 +1,74 @@
+module Reissue
+  # Provides versioning functionality for the application.
+  module Versioning
+    # Provides versioning functionality for the application.
+    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.
+      # @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")
+        else
+          Gem::Version.new("#{segments[0]}.#{segments[1]}.#{segments[2].to_i + 1}")
+        end
+      end
+    end
+  end
+
+  class VersionUpdater
+    using Versioning
+
+    # Initializes a new instance of the VersionUpdater class.
+    #
+    # @param version_file [String] The path to the version file.
+    def initialize(version_file)
+      @version_file = version_file
+      @original_version = nil
+      @new_version = nil
+      @updated_body = ""
+    end
+
+    # Updates the version segment and writes the updated version to the file.
+    #
+    # This allows you to read from one file and write to another.
+    #
+    # @param segment [Symbol] The segment to update (:major, :minor, or :patch).
+    # @param version_file [String] The version_file to the version file (optional, defaults to @version_file).
+    # @return [String] The updated version string.
+    def call(segment, version_file: @version_file)
+      update(segment)
+      write(version_file)
+      @new_version
+    end
+
+    # Updates the specified segment of the version string.
+    #
+    # @param segment [Symbol] The segment to update (:major, :minor, or :patch).
+    # @return [String] The updated version string.
+    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
+      end
+      @new_version
+    end
+
+    # Regular expression pattern for matching the version string.
+    #
+    # @return [Regexp] The version regex pattern.
+    def version_regex = /(?<major>\d+)\.(?<minor>\d+)\.(?<patch>\d+)/
+
+    # Writes the updated version to the specified file.
+    #
+    # @param version_file [String] The version_file to the version file (optional, defaults to @version_file).
+    def write(version_file = @version_file)
+      File.write(version_file, @updated_body)
+    end
+  end
+end

data/lib/reissue.rb

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+require_relative "reissue/version"
+require_relative "reissue/version_updater"
+require_relative "reissue/changelog_updater"
+
+# Reissue is a module that provides functionality for updating version numbers and changelogs.
+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.
+  # @return [String] The new version number.
+  def self.call(version_file:, changelog_file: "CHANGELOG.md", segment: "patch", date: "Unreleased", changes: {})
+    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:)
+    end
+    new_version
+  end
+
+  # Finalizes the changelog for an unreleased version to set the release date.
+  #
+  # @param date [String] The release date.
+  # @param changelog_file [String] The path to the changelog file.
+  def self.finalize(date = Date.today, changelog_file: "CHANGELOG.md")
+    changelog_updater = ChangelogUpdater.new(changelog_file)
+    changelog_updater.finalize(date:, changelog_file:)
+  end
+end

metadata

@@ -0,0 +1,67 @@
+--- !ruby/object:Gem::Specification
+name: reissue
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Jim Gay
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2024-04-12 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: keepachangelog
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: This gem helps you to prepare for releases of new versions of your code.
+email:
+- jim@saturnflyer.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- CHANGELOG.md
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/reissue.rb
+- lib/reissue/changelog_updater.rb
+- lib/reissue/version.rb
+- lib/reissue/version_updater.rb
+homepage: https://github.com/SOFware/reissue
+licenses: []
+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
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.0.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.5.5
+signing_key:
+specification_version: 4
+summary: Keep your versions and changelogs up to date and prepared for release.
+test_files: []