git_toolbox 0.4.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 3adafc4b788997e3c6f09b238f7638c3fce70099bbf799da197728382ddc7e24
+  data.tar.gz: d35020b9402e19053d3c75eae5b6cdfbbab3aea07b53e46c88851417e5096e34
+SHA512:
+  metadata.gz: 4a419b04905061a0485434c13dd8c480b587419c5683f89a3b548407d87af918070a495c44fdc1be48143fad39a0f7b1399087935c92f8c4ba57a797e9894aaf
+  data.tar.gz: 14cfd956d76eb9eb8717bd561c829756b2ed9b2959d5ddf1187ab5e34ee72a1608a3d41578f6ddd5a4b4028588ed70e82221697b9b28200ee2b5a89d41262d54

data/bin/get

@@ -0,0 +1,8 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require 'rubygems'
+require 'bundler/setup'
+require 'get'
+
+Get.main

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/get/common.rb

@@ -0,0 +1,72 @@
+# Get is a toolbox based on git which simplifies the adoption of conventions and some git commands.
+# Copyright (C) 2023  Alex Speranza
+
+# This program is free software: you can redistribute it and/or modify
+# it under the terms of the GNU Lesser General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+
+# You should have received a copy of the GNU General Public License
+# along with this program and the additional permissions granted by
+# the Lesser GPL.  If not, see <https://www.gnu.org/licenses/>.
+
+# frozen_string_literal: true
+
+# Utility module
+module Common
+  # Groups: 1 = type, 2 = scope with (), 3 = scope, 4 = breaking change
+  CONVENTIONAL_COMMIT_REGEX = /^(\w+)(\((\w+)\))?(!)?:.*/
+
+  # Check if the command is called while in a git repository.
+  # If the command fails, it is assumed to not be in a git repository.
+  def self.in_git_repo?
+    system('git rev-parse --is-inside-work-tree &>/dev/null')
+  end
+
+  # Print an error message and optionally run a block.
+  # Stdout becomes stderr, so every print is performed to stderr.
+  # This behavior is wanted as this method is called on errors.
+  def self.error(message, &block)
+    Common.print_then_do_and_exit("Error: #{message}", 1, block)
+  end
+
+  # Subcommand exception handling for Optimist.
+  # Generally subcommands do not have a version to print.
+  def self.with_subcommand_exception_handling(parser)
+    yield
+  rescue Optimist::CommandlineError => e
+    parser.die(e.message, nil, e.error_code)
+  rescue Optimist::HelpNeeded
+    parser.educate
+    exit
+  rescue Optimist::VersionNeeded
+    # Version is not needed in this command
+  end
+
+  # Run a block of code with the list of commits from the given version as an argument.
+  # If the block is not given, this method is a nop.
+  def self.with_commit_list_from(version = nil, &block)
+    return unless block_given?
+
+    commits_from_version =
+      `git --no-pager log --oneline --pretty=format:%s #{version.nil? ? '' : "^#{version}"} HEAD`
+      .split("\n")
+    block.call(commits_from_version)
+  end
+
+  # Print the given message, execute a block if given,
+  # and exit the program with the given exit status.
+  # If exit_status is not 0, the stdout is redirected to stderr.
+  def self.print_then_do_and_exit(message, exit_code = 0, action = proc {})
+    $stdout = $stderr unless exit_code.zero?
+
+    puts message
+    action.call if action.respond_to?('call')
+    exit(exit_code)
+  end
+end

data/lib/get/subcommand/command.rb

@@ -0,0 +1,31 @@
+# Get is a toolbox based on git which simplifies the adoption of conventions and some git commands.
+# Copyright (C) 2023  Alex Speranza
+
+# This program is free software: you can redistribute it and/or modify
+# it under the terms of the GNU Lesser General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+
+# You should have received a copy of the GNU General Public License
+# along with this program and the additional permissions granted by
+# the Lesser GPL.  If not, see <https://www.gnu.org/licenses/>.
+
+# frozen_string_literal: true
+
+# Base class for (sub)commands. (Sub)Commands should be singletons.
+class Command
+  attr_reader :description, :action
+
+  protected
+
+  def initialize(usage, description, &action)
+    @usage = usage
+    @description = description
+    @action = action
+  end
+end

data/lib/get/subcommand/commit/commit.rb

@@ -0,0 +1,145 @@
+# Get is a toolbox based on git which simplifies the adoption of conventions and some git commands.
+# Copyright (C) 2023  Alex Speranza
+
+# This program is free software: you can redistribute it and/or modify
+# it under the terms of the GNU Lesser General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+
+# You should have received a copy of the GNU General Public License
+# along with this program and the additional permissions granted by
+# the Lesser GPL.  If not, see <https://www.gnu.org/licenses/>.
+
+# frozen_string_literal: true
+
+require 'English'
+require 'get/common'
+require 'get/subcommand/command'
+require 'get/subcommand/commit/prompt'
+
+# Class length is disabled as most of its length is given by formatting.
+# rubocop:disable Metrics/ClassLength
+# Subcommand, it manages the description of the current git repository using semantic version.
+class Commit < Command
+  def self.command
+    @@command ||= new
+    @@command
+  end
+
+  private_class_method :new
+
+  private
+
+  include PromptHandler
+
+  @@command = nil
+
+  @@usage = 'commit -h|(<subcommand> [<subcommand-options])'
+  @@description = 'Create a new semantic commit'
+  @@subcommands = {}
+  # This block is Optimist configuration. It is as long as the number of options of the command.
+  # rubocop:disable Metrics/BlockLength
+  @@commit_parser = Optimist::Parser.new do
+    subcommand_max_length = @@subcommands.keys.map { |k| k.to_s.length }.max
+    usage @@usage
+    synopsis <<~SUBCOMMANDS unless @@subcommands.empty?
+      Subcommands:
+      #{@@subcommands.keys.map { |k| "  #{k.to_s.ljust(subcommand_max_length)} => #{@@subcommands[k].description}" }.join("\n")}
+    SUBCOMMANDS
+    opt :type,
+        'Define the type of the commit. Enabling this option skips the type selection.',
+        { type: :string }
+    opt :scope,
+        'Define the scope of the commit. Enabling this option skips the scope selection.',
+        { type: :string, short: 'S' }
+    opt :summary,
+        'Define the summary message of the commit. Enabling this option skips the summary message prompt.',
+        { type: :string, short: 's' }
+    opt :message,
+        'Define the message body of the commit. Enabling this option skips the message body prompt.',
+        { type: :string }
+    opt :breaking,
+        'Set the commit to have a breaking change. ' \
+        'Can be negated with "--no-breaking". ' \
+        'Enabling this option skips the breaking change prompt.',
+        { type: :flag, short: :none }
+    educate_on_error
+    stop_on @@subcommands.keys.map(&:to_s)
+  end
+  # rubocop:enable Metrics/BlockLength
+
+  def initialize
+    super(@@usage, @@description) do
+      Common.error 'commit need to be run inside a git repository' unless Common.in_git_repo?
+      @options = Common.with_subcommand_exception_handling @@commit_parser do
+        @@commit_parser.parse
+      end
+
+      message = full_commit_message
+      puts message
+      output = `git commit --no-status -m "#{message.gsub('"', '\"')}"`
+      Common.error "git commit failed: #{output}" if $CHILD_STATUS.exitstatus.positive?
+    rescue Interrupt
+      Common.print_then_do_and_exit "\nCommit cancelled"
+    end
+  end
+
+  def full_commit_message
+    type = commit_type
+    scope = commit_scope
+    breaking = commit_breaking?
+    summary = commit_summary
+    body = commit_body
+    "#{type}" \
+      "#{scope.nil? || scope.empty? ? '' : "(#{scope})"}" \
+      "#{breaking ? '!' : ''}" \
+      ": #{summary}" \
+      "#{body.empty? ? '' : "\n\n#{body}"}"
+  end
+
+  def commit_type
+    if @options[:type_given]
+      @options[:type]
+    else
+      ask_for_type
+    end.to_s.strip
+  end
+
+  def commit_scope
+    if @options[:scope_given]
+      @options[:scope]
+    else
+      ask_for_scope
+    end.to_s.strip
+  end
+
+  def commit_breaking?
+    if @options[:breaking_given]
+      @options[:breaking]
+    else
+      ask_for_breaking
+    end
+  end
+
+  def commit_summary
+    if @options[:summary_given]
+      @options[:summary]
+    else
+      ask_for_summary
+    end.to_s.strip
+  end
+
+  def commit_body
+    if @options[:message_given]
+      @options[:message]
+    else
+      ask_for_message
+    end.to_s.strip
+  end
+end
+# rubocop:enable Metrics/ClassLength

data/lib/get/subcommand/commit/prompt.rb

@@ -0,0 +1,123 @@
+# Get is a toolbox based on git which simplifies the adoption of conventions and some git commands.
+# Copyright (C) 2023  Alex Speranza
+
+# This program is free software: you can redistribute it and/or modify
+# it under the terms of the GNU Lesser General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+
+# You should have received a copy of the GNU General Public License
+# along with this program and the additional permissions granted by
+# the Lesser GPL.  If not, see <https://www.gnu.org/licenses/>.
+
+# frozen_string_literal: true
+
+require 'highline'
+
+# Module for asking to the user informations about a commit message.
+module PromptHandler
+  @@cli = HighLine.new
+
+  @@custom_values_initialized = nil
+  @@custom_types = []
+  @@custom_scopes = []
+
+  STRING_VALUE_VALIDATOR = /\s*\S+\s*/
+  BODY_END_DELIMITER = "\n\n\n"
+
+  DEFAULT_TYPES = %i[
+    feat
+    fix
+    build
+    chore
+    ci
+    docs
+    style
+    refactor
+    perf
+    test
+  ].freeze
+
+  def ask_for_type
+    extract_types_and_scopes
+    @@cli.choose do |menu|
+      menu.flow = :columns_down
+      menu.prompt = 'Choose the type of your commit: '
+      DEFAULT_TYPES.union(@@custom_types).each do |type|
+        menu.choice(type.to_sym)
+      end
+      menu.choice('Create a new type (rarely needed)') do |_|
+        @@cli.ask('Write the new type to use', String) do |question|
+          question.verify_match = true
+          question.validate = STRING_VALUE_VALIDATOR
+        end
+      end
+    end
+  end
+
+  def ask_for_scope
+    extract_types_and_scopes
+    @@cli.choose do |menu|
+      menu.flow = :columns_down
+      menu.prompt = 'Choose the scope of your commit '
+      @@custom_scopes.each do |scope|
+        menu.choice(scope.to_sym)
+      end
+      menu.choice('Create a new scope') do |_|
+        @@cli.ask('Write the new scope to use', String) do |question|
+          question.verify_match = true
+          question.validate = STRING_VALUE_VALIDATOR
+        end
+      end
+      menu.choice('None') { '' }
+    end
+  end
+
+  def ask_for_breaking
+    @@cli.agree('Does the commit contain a breaking change? (yes/no) ') do |question|
+      question.default = false
+    end
+  end
+
+  def ask_for_summary
+    @@cli.ask('The summary of the commit:') do |question|
+      question.verify_match = true
+      question.validate = STRING_VALUE_VALIDATOR
+    end
+  end
+
+  def ask_for_message
+    # This method needs a special implementation as the body message can span multiple lines.
+    @@cli.puts('The body of the commit (ends after 3 new lines):')
+    @@cli.input.gets(BODY_END_DELIMITER)
+  end
+
+  private
+
+  FIRST_COMMIT = nil
+
+  # This method tries to optimize input parsing by performing multiple operations in one go.
+  # So its complexity is a bit higher as it needs to make multiple checks.
+  # rubocop:disable Metrics/CyclomaticComplexity
+  def extract_types_and_scopes
+    return unless @@custom_values_initialized.nil?
+
+    Common.with_commit_list_from(FIRST_COMMIT) do |commit_list|
+      commit_list.map do |element|
+        match = Common::CONVENTIONAL_COMMIT_REGEX.match(element)
+        next if match.nil?
+
+        type_already_added = DEFAULT_TYPES.include?(match[1].to_sym) || @@custom_types.include?(match[1])
+        @@custom_types.append(match[1]) unless type_already_added
+        @@custom_scopes.append(match[3]) unless match[3].nil? || @@custom_scopes.include?(match[3])
+      end
+    end
+    @@custom_values_initialized = true
+  end
+  # rubocop:enable Metrics/CyclomaticComplexity
+end

data/lib/get/subcommand/describe/change.rb

@@ -0,0 +1,71 @@
+# Get is a toolbox based on git which simplifies the adoption of conventions and some git commands.
+# Copyright (C) 2023  Alex Speranza
+
+# This program is free software: you can redistribute it and/or modify
+# it under the terms of the GNU Lesser General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+
+# You should have received a copy of the GNU General Public License
+# along with this program and the additional permissions granted by
+# the Lesser GPL.  If not, see <https://www.gnu.org/licenses/>.
+
+# frozen_string_literal: true
+
+# Module which handles change-related tasks.
+module ChangeHandler
+  # Array with change types in ascending order of importance.
+  CHANGE_TYPE = %i[NONE PATCH MINOR MAJOR].freeze
+
+  @@major_trigger = 'is_breaking'
+  @@minor_trigger = "type == 'feat'"
+  @@patch_trigger = "type == 'fix'"
+
+  module_function
+
+  # In this block method arguments can be used by user.
+  # Also `eval` is needed to allow users to define their custom triggers.
+  # rubocop:disable Lint/UnusedMethodArgument
+  # rubocop:disable Security/Eval
+  def triggers_major?(type, scope, is_breaking)
+    eval(@@major_trigger)
+  end
+
+  def triggers_minor?(type, scope)
+    eval(@@minor_trigger)
+  end
+
+  def triggers_patch?(type, scope)
+    eval(@@patch_trigger)
+  end
+  # rubocop:enable Lint/UnusedMethodArgument
+  # rubocop:enable Security/Eval
+
+  # Open String class to inject method to convert a (commit) string into
+  # a change.
+  class ::String
+    # Convert the string (as a conventional commit string) into a change type.
+    def to_change
+      groups = Common::CONVENTIONAL_COMMIT_REGEX.match(self)
+      return :MAJOR if ChangeHandler.triggers_major?(groups[1], groups[3], !groups[4].nil?)
+      return :MINOR if ChangeHandler.triggers_minor?(groups[1], groups[2])
+      return :PATCH if ChangeHandler.triggers_patch?(groups[1], groups[2])
+
+      :NONE
+    end
+  end
+
+  public
+
+  def greatest_change_in(commit_list)
+    commit_list
+      .grep(Common::CONVENTIONAL_COMMIT_REGEX)
+      .map(&:to_change)
+      .max { |a, b| CHANGE_TYPE.index(a) <=> CHANGE_TYPE.index(b) }
+  end
+end

data/lib/get/subcommand/describe/describe.rb

@@ -0,0 +1,230 @@
+# Get is a toolbox based on git which simplifies the adoption of conventions and some git commands.
+# Copyright (C) 2023  Alex Speranza
+
+# This program is free software: you can redistribute it and/or modify
+# it under the terms of the GNU Lesser General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+
+# You should have received a copy of the GNU General Public License
+# along with this program and the additional permissions granted by
+# the Lesser GPL.  If not, see <https://www.gnu.org/licenses/>.
+
+# frozen_string_literal: true
+
+require 'get/subcommand/command'
+require 'get/subcommand/describe/change'
+require 'get/subcommand/describe/prerelease'
+require 'get/subcommand/describe/metadata'
+require 'get/subcommand/describe/docker/docker'
+
+# Class length is disabled as most of its length is given by formatting.
+# rubocop:disable Metrics/ClassLength
+# Subcommand, it manages the description of the current git repository using semantic version.
+class Describe < Command
+  def self.command
+    @@command ||= new
+    @@command
+  end
+
+  private_class_method :new
+
+  private
+
+  include ChangeHandler
+  include PrereleaseHandler
+  include MetadataHandler
+
+  @@command = nil
+
+  DEFAULT_RELEASE_VERSION = '0.1.0'
+  FULL_SEMANTIC_VERSION_REGEX = /
+      ^((0|[1-9]\d*)\.(0|[1-9]\d*)\.(0|[1-9]\d*)) # Stable version, major, minor, patch
+      (?:-((?:0|[1-9]\d*|\d*[a-zA-Z-][0-9a-zA-Z-]*)(?:\.(?:0|[1-9]\d*|\d*[a-zA-Z-][0-9a-zA-Z-]*))*))? # prerelease
+      (?:\+([0-9a-zA-Z-]+(?:\.[0-9a-zA-Z-]+)*))?$ # metadata
+    /x
+
+  @@usage = 'describe -h|(<subcommand> [<subcommand-options])'
+  @@description = 'Describe the current git repository with semantic version'
+  @@subcommands = {
+    docker: DescribeDocker.command,
+  }
+  # This block is Optimist configuration. It is as long as the number of options of the command.
+  # rubocop:disable Metrics/BlockLength
+  @@describe_parser = Optimist::Parser.new do
+    subcommand_max_length = @@subcommands.keys.map { |k| k.to_s.length }.max
+    usage @@usage
+    synopsis <<~SUBCOMMANDS unless @@subcommands.empty?
+      Subcommands:
+      #{@@subcommands.keys.map { |k| "  #{k.to_s.ljust(subcommand_max_length)} => #{@@subcommands[k].description}" }.join("\n")}
+    SUBCOMMANDS
+    opt :prerelease,
+        'Describe a prerelease rather than a release',
+        short: :none
+    opt :exclude_metadata,
+        'Do not include metadata in version.'
+    opt :metadata,
+        'Set which metadata to include in the string. ' \
+        'Multiple value can be specified by separating the with a comma \',\'.',
+        { type: :string, default: 'sha' }
+    opt :major_trigger,
+        'Set the trigger for a major release. ' \
+        'This must be a valid Ruby expression. ' \
+        'In this expression the string values "type" and "scope" ' \
+        'and the boolean value "is_breaking" can be used.',
+        { short: :none, type: :string, default: 'is_breaking' }
+    opt :minor_trigger,
+        'Set the trigger for a minor release. ' \
+        'This must be a valid Ruby expression. ' \
+        'In this expression the string values "type" and "scope" can be used.',
+        { short: :none, type: :string, default: "type == 'feat'" }
+    opt :patch_trigger,
+        'Set the trigger for a patch release. ' \
+        'This must be a valid Ruby expression. ' \
+        'In this expression the string values "type" and "scope" can be used.',
+        { short: :none, type: :string, default: "type == 'fix'" }
+    opt :prerelease_pattern,
+        'Set the pattern of the prerelease. This must contain the placeholder "(p)".',
+        { short: :none, type: :string, default: 'dev(p)' }
+    opt :old_prerelease_pattern,
+        'Set the pattern of the old prerelease. It is useful for changing prerelease pattern.',
+        { short: :none, type: :string, default: 'prerelease-pattern value' }
+    opt :diff,
+        'Print also the last version.'
+    opt :create_tag,
+        'Create a signed tag with the computed version.',
+        { short: :none }
+    opt :tag_message,
+        'Add the given message to the tag. Requires "--create-tag".',
+        { short: :none, type: :string }
+    educate_on_error
+    stop_on @@subcommands.keys.map(&:to_s)
+  end
+  # rubocop:enable Metrics/BlockLength
+
+  def initialize
+    super(@@usage, @@description) do
+      Common.error 'describe need to be run inside a git repository' unless Common.in_git_repo?
+      @options = Common.with_subcommand_exception_handling @@describe_parser do
+        @@describe_parser.parse
+      end
+      set_options
+
+      if ARGV.length.positive?
+        subcommand = ARGV.shift.to_sym
+        if @@subcommands.include?(subcommand)
+          @@subcommands[subcommand].action.call(describe_current_commit)
+        else
+          # This error should not be disabled by -W0
+          # rubocop:disable Style/StderrPuts
+          $stderr.puts "Error: subcommand '#{subcommand}' unknown."
+          # rubocop:enable Style/StderrPuts
+          exit 1
+        end
+      else
+        puts describe_current_commit
+      end
+    end
+  end
+
+  def set_options
+    @@major_trigger = @options[:major_trigger] if @options[:major_trigger_given]
+    @@minor_trigger = @options[:minor_trigger] if @options[:minor_trigger_given]
+    @@patch_trigger = @options[:patch_trigger] if @options[:patch_trigger_given]
+    @@old_prerelease_pattern = @options[:old_prerelease_pattern] if @options[:old_prerelease_pattern_given]
+    @@prerelease_pattern = @options[:prerelease_pattern] if @options[:prerelease_pattern_given]
+  end
+
+  def describe_current_commit
+    return last_version if Common.with_commit_list_from(last_version, &:empty?)
+
+    puts "Last version: #{last_version}" if @options[:diff]
+
+    current_commit_version = next_release
+    create_signed_tag(current_commit_version) if @options[:create_tag]
+
+    current_commit_version
+  end
+
+  def next_release
+    if @options[:prerelease]
+      prepare_prerelease_tag(last_release, last_version)
+    else
+      prepare_release_tag(last_release)
+    end + metadata
+  end
+
+  def prepare_release_tag(last_release)
+    updated_stable_version(last_release).to_s
+  end
+
+  def prepare_prerelease_tag(last_release, last_version)
+    new_stable_version = updated_stable_version(last_release)
+    base_version_match_data = FULL_SEMANTIC_VERSION_REGEX.match(last_version)
+    no_changes_from_last_release = base_version_match_data[1] == new_stable_version && base_version_match_data[5].nil?
+    Common.error 'No changes from last release' if no_changes_from_last_release
+    new_stable_version +
+      "-#{updated_prerelease(base_version_match_data[5], need_reset: base_version_match_data[1] != new_stable_version)}"
+  end
+
+  # Returns the last version and caches it for the next calls.
+  def last_version
+    @last_version ||= `git describe --tags --abbrev=0`.strip
+  end
+
+  # Returns the last release and caches it for the next calls.
+  def last_release
+    @last_release ||= `git --no-pager tag --list | sed 's/+/_/' | sort -V | sed 's/_/+/' | tail -n 1`.strip
+  end
+
+  def updated_stable_version(stable_version)
+    return DEFAULT_RELEASE_VERSION if stable_version.nil?
+
+    greatest_change_from_stable_version = Common.with_commit_list_from(stable_version) do |commits_from_version|
+      greatest_change_in(commits_from_version)
+    end
+    split_version = stable_version.split('.')
+    case greatest_change_from_stable_version
+    when :MAJOR
+      "#{split_version[0].to_i + 1}.0.0"
+    when :MINOR
+      "#{split_version[0].to_i}.#{split_version[1].to_i + 1}.0"
+    when :PATCH
+      "#{split_version[0].to_i}.#{split_version[1].to_i}.#{split_version[2].to_i + 1}"
+    else
+      "#{split_version[0].to_i}.#{split_version[1].to_i}.#{split_version[2].to_i}"
+    end
+  end
+
+  # Return the updated prerelease number
+  def updated_prerelease(prerelease = nil, need_reset: false)
+    compute_prerelease(prerelease, need_reset: prerelease.nil? || need_reset)
+  end
+
+  # Compute the metadata string
+  def metadata
+    return '' if @options[:exclude_metadata] || @options[:metadata].empty?
+
+    "+#{compute_metadata(@options[:metadata])}"
+  end
+
+  def create_signed_tag(computed_version)
+    system(
+      'git tag -s ' \
+      "#{
+        if @options[:tag_message_given]
+          "-m #{@options[:tag_message]}"
+        else
+          ''
+        end
+      } " \
+      "'#{computed_version}'"
+    )
+  end
+end
+# rubocop:enable Metrics/ClassLength

data/lib/get/subcommand/describe/docker/docker.rb

@@ -0,0 +1,116 @@
+# Get is a toolbox based on git which simplifies the adoption of conventions and some git commands.
+# Copyright (C) 2023  Alex Speranza
+
+# This program is free software: you can redistribute it and/or modify
+# it under the terms of the GNU Lesser General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+
+# You should have received a copy of the GNU General Public License
+# along with this program and the additional permissions granted by
+# the Lesser GPL.  If not, see <https://www.gnu.org/licenses/>.
+
+# frozen_string_literal: true
+
+require 'get/subcommand/command'
+
+# Class length is disabled as most of its length is given by formatting.
+# rubocop:disable Metrics/ClassLength
+# Subcommand, it manages the description of the current git repository using semantic version.
+class DescribeDocker < Command
+  def self.command
+    @@command ||= new
+    @@command
+  end
+
+  private_class_method :new
+
+  private
+
+  INCREMENTAL_VERSION_PATTERN = /(((\d+)\.\d+)\.\d+)/
+
+  @@command = nil
+
+  @@usage = 'describe docker -h|(<subcommand> [<subcommand-options])'
+  @@description = 'Describe the current git repository with a list of version for docker'
+  @@subcommands = {}
+  # This block is Optimist configuration. It is as long as the number of options of the command.
+  # rubocop:disable Metrics/BlockLength
+  @@describe_parser = Optimist::Parser.new do
+    subcommand_max_length = @@subcommands.keys.map { |k| k.to_s.length }.max
+    usage @@usage
+    synopsis <<~SUBCOMMANDS unless @@subcommands.empty?
+      Subcommands:
+      #{@@subcommands.keys.map { |k| "  #{k.to_s.ljust(subcommand_max_length)} => #{@@subcommands[k].description}" }.join("\n")}
+    SUBCOMMANDS
+    opt :separator,
+        'Use the given value as separator for versions',
+        { type: :string, default: '\n' }
+    opt :not_latest,
+        'Do not include "latest" in the version list.',
+        short: :none
+    opt :substitute_plus,
+        'Set which character will be used in place of "+".',
+        { type: :string, short: :none }
+    educate_on_error
+    stop_on @@subcommands.keys.map(&:to_s)
+  end
+  # rubocop:enable Metrics/BlockLength
+
+  def initialize
+    super(@@usage, @@description) do |version|
+      Common.error 'describe need to be run inside a git repository' unless Common.in_git_repo?
+      @options = Common.with_subcommand_exception_handling @@describe_parser do
+        @@describe_parser.parse
+      end
+      set_options
+
+      puts version_list_from(version).join(@@separator)
+    end
+  end
+
+  def set_options
+    @@separator = if @options[:separator_given]
+                    @options[:separator]
+                  else
+                    "\n"
+                  end
+    @@not_latest = @options[:not_latest]
+    @@plus_substitution = if @options[:substitute_plus_given]
+                            @options[:substitute_plus]
+                          else
+                            '+'
+                          end
+  end
+
+  def version_list_from(full_version)
+    [
+      full_version.sub('+', @@plus_substitution),
+      reduced_versions(full_version),
+      latest
+    ]
+  end
+
+  def reduced_versions(full_version)
+    base_version = full_version.partition('+')[0]
+    if base_version.include?('-')
+      base_version
+    else
+      INCREMENTAL_VERSION_PATTERN.match(base_version).captures
+    end
+  end
+
+  def latest
+    if @options[:not_latest]
+      []
+    else
+      ['latest']
+    end
+  end
+end
+# rubocop:enable Metrics/ClassLength

data/lib/get/subcommand/describe/metadata.rb

@@ -0,0 +1,53 @@
+# Get is a toolbox based on git which simplifies the adoption of conventions and some git commands.
+# Copyright (C) 2023  Alex Speranza
+
+# This program is free software: you can redistribute it and/or modify
+# it under the terms of the GNU Lesser General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+
+# You should have received a copy of the GNU General Public License
+# along with this program and the additional permissions granted by
+# the Lesser GPL.  If not, see <https://www.gnu.org/licenses/>.
+
+# frozen_string_literal: true
+
+# Module with methods to handle tag metadata.
+#
+# To add a new metadata type, create a new method and link it to a symbol.
+module MetadataHandler
+  @@metadata_computers = {}
+
+  module_function
+
+  def last_commit_sha
+    `git --no-pager log -n 1 --pretty=%h`.strip
+  end
+
+  def current_date
+    Time.now.strftime('%0Y%0m%0d')
+  end
+
+  def init_computers
+    @@metadata_computers[:sha] = proc { last_commit_sha }
+    @@metadata_computers[:date] = proc { current_date }
+  end
+
+  public
+
+  def compute_metadata(metadata_specs)
+    metadata_specs
+      .split(',')
+      .map { |element| @@metadata_computers[element.to_sym].call }
+      .join('-')
+  end
+
+  def self.included(_mod)
+    init_computers
+  end
+end

data/lib/get/subcommand/describe/prerelease.rb

@@ -0,0 +1,55 @@
+# Get is a toolbox based on git which simplifies the adoption of conventions and some git commands.
+# Copyright (C) 2023  Alex Speranza
+
+# This program is free software: you can redistribute it and/or modify
+# it under the terms of the GNU Lesser General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+
+# You should have received a copy of the GNU General Public License
+# along with this program and the additional permissions granted by
+# the Lesser GPL.  If not, see <https://www.gnu.org/licenses/>.
+
+# frozen_string_literal: true
+
+# Module with methods for managing prerelease updates.
+module PrereleaseHandler
+  FIRST_PRERELEASE = 1
+  DEFAULT_PRERELEASE_STRING = 'dev'
+  PRERELEASE_PLACEHOLDER = '(p)'
+
+  @@prerelease_pattern = "#{DEFAULT_PRERELEASE_STRING}#{PRERELEASE_PLACEHOLDER}"
+  @@old_prerelease_pattern = proc { @@prerelease_pattern }
+
+  module_function
+
+  def extract_prerelease_number(current_prerelease)
+    actual_old_prerelease_pattern =
+      if @@old_prerelease_pattern.respond_to?('call')
+        @@old_prerelease_pattern.call
+      else
+        @@old_prerelease_pattern
+      end
+    Common.error "The given old pattern does not contains the placeholder '(p)'" unless
+      actual_old_prerelease_pattern.include?(PRERELEASE_PLACEHOLDER)
+    old_prerelease_regex = actual_old_prerelease_pattern.sub(PRERELEASE_PLACEHOLDER, '(\\d+)')
+    begin
+      Regexp.new(old_prerelease_regex).match(current_prerelease)[1].to_i
+    rescue NoMethodError
+      Common.error "The given old prerelease pattern '#{actual_old_prerelease_pattern}' " \
+                   "does not match the analyzed prerelease: '#{current_prerelease}'."
+    end
+  end
+
+  public
+
+  def compute_prerelease(current_prerelease, need_reset: false)
+    new_prerelease = (need_reset ? FIRST_PRERELEASE : (extract_prerelease_number(current_prerelease) + 1)).to_s
+    @@prerelease_pattern.sub(PRERELEASE_PLACEHOLDER, new_prerelease)
+  end
+end

data/lib/get/subcommand/init/init.rb

@@ -0,0 +1,85 @@
+# Get is a toolbox based on git which simplifies the adoption of conventions and some git commands.
+# Copyright (C) 2023  Alex Speranza
+
+# This program is free software: you can redistribute it and/or modify
+# it under the terms of the GNU Lesser General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+
+# You should have received a copy of the GNU General Public License
+# along with this program and the additional permissions granted by
+# the Lesser GPL.  If not, see <https://www.gnu.org/licenses/>.
+
+# frozen_string_literal: true
+
+require 'English'
+require 'get/common'
+require 'get/subcommand/command'
+
+# Class length is disabled as most of its length is given by formatting.
+# rubocop:disable Metrics/ClassLength
+# Subcommand, it allow to create a new repository and add an initial, empty commit to it.
+class Init < Command
+  def self.command
+    @@command ||= new
+    @@command
+  end
+
+  private_class_method :new
+
+  private
+
+  include PromptHandler
+
+  @@command = nil
+
+  @@usage = 'init -h|(<subcommand> [<subcommand-options])'
+  @@description = 'Initialize a new git repository with an initial empty commit'
+  @@subcommands = {}
+  # This block is Optimist configuration. It is as long as the number of options of the command.
+  # rubocop:disable Metrics/BlockLength
+  @@commit_parser = Optimist::Parser.new do
+    subcommand_max_length = @@subcommands.keys.map { |k| k.to_s.length }.max
+    usage @@usage
+    synopsis <<~SUBCOMMANDS unless @@subcommands.empty?
+      Subcommands:
+      #{@@subcommands.keys.map { |k| "  #{k.to_s.ljust(subcommand_max_length)} => #{@@subcommands[k].description}" }.join("\n")}
+    SUBCOMMANDS
+    opt :empty,
+        'Do not create the first, empty commit.'
+    educate_on_error
+    stop_on @@subcommands.keys.map(&:to_s)
+  end
+  # rubocop:enable Metrics/BlockLength
+
+  def initialize
+    super(@@usage, @@description) do
+      @options = Common.with_subcommand_exception_handling @@commit_parser do
+        @@commit_parser.parse
+      end
+      Common.error 'The current directory is already a git repository' if Common.in_git_repo?
+
+      init_repository
+    end
+  end
+
+  def init_repository
+    `git init`
+    Common.error 'Failed to init the repository' if $CHILD_STATUS.exitstatus.positive?
+
+    create_first_commit unless @options[:empty]
+
+    puts 'Git repository initialized'
+  end
+
+  def create_first_commit
+    `git commit --allow-empty -m "chore: initialize repository"`
+    Common.error 'Failed to create first commit' if $CHILD_STATUS.exitstatus.positive?
+  end
+end
+# rubocop:enable Metrics/ClassLength

data/lib/get/version.rb

@@ -0,0 +1,22 @@
+# Get is a toolbox based on git which simplifies the adoption of conventions and some git commands.
+# Copyright (C) 2023  Alex Speranza
+
+# This program is free software: you can redistribute it and/or modify
+# it under the terms of the GNU Lesser General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+
+# You should have received a copy of the GNU General Public License
+# along with this program and the additional permissions granted by
+# the Lesser GPL.  If not, see <https://www.gnu.org/licenses/>.
+
+# frozen_string_literal: true
+
+module Get
+  VERSION = '0.4.1'
+end

data/lib/get.rb

@@ -0,0 +1,67 @@
+# Get is a toolbox based on git which simplifies the adoption of conventions and some git commands.
+# Copyright (C) 2023  Alex Speranza
+
+# This program is free software: you can redistribute it and/or modify
+# it under the terms of the GNU Lesser General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+
+# You should have received a copy of the GNU General Public License
+# along with this program and the additional permissions granted by
+# the Lesser GPL.  If not, see <https://www.gnu.org/licenses/>.
+
+# frozen_string_literal: true
+
+require 'optimist'
+
+require 'get/subcommand/describe/describe'
+require 'get/subcommand/commit/commit'
+require 'get/subcommand/init/init'
+require 'get/version'
+require 'get/common'
+
+# Entrypoint of Get
+module Get
+  class Error < StandardError; end
+
+  @@subcommands = {
+    describe: Describe.command,
+    commit: Commit.command,
+    init: Init.command,
+  }
+  @@option_parser = Optimist::Parser.new do
+    subcommand_max_length = @@subcommands.keys.map { |k| k.to_s.length }.max
+    usage '-h|-v|(<subcommand> [<subcommand-options])'
+    synopsis <<~SUBCOMMANDS unless @@subcommands.empty?
+      Subcommands:
+      #{@@subcommands.keys.map { |k| "  #{k.to_s.ljust(subcommand_max_length)} => #{@@subcommands[k].description}" }.join("\n")}
+    SUBCOMMANDS
+    version "Get version: #{Get::VERSION}"
+    educate_on_error
+    stop_on @@subcommands.keys.map(&:to_s)
+  end
+
+  def self.main
+    @options = Optimist.with_standard_exception_handling(@@option_parser) do
+      @@option_parser.parse
+    end
+    error 'No command or option specified' if ARGV.empty?
+    command = ARGV.shift.to_sym
+    if @@subcommands.include?(command)
+      @@subcommands[command].action.call
+    else
+      error "Unknown subcommand '#{command}'"
+    end
+  end
+
+  def self.error(message)
+    Common.error message do
+      @@option_parser.educate
+    end
+  end
+end

metadata

@@ -0,0 +1,96 @@
+--- !ruby/object:Gem::Specification
+name: git_toolbox
+version: !ruby/object:Gem::Version
+  version: 0.4.1
+platform: ruby
+authors:
+- Alex Speranza
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2023-01-31 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: optimist
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.0.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.0.1
+- !ruby/object:Gem::Dependency
+  name: highline
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.0.3
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.0.3
+description:
+email:
+- alex.speranza@studio.unibo.it
+executables:
+- get
+extensions: []
+extra_rdoc_files: []
+files:
+- bin/get
+- bin/setup
+- lib/get.rb
+- lib/get/common.rb
+- lib/get/subcommand/command.rb
+- lib/get/subcommand/commit/commit.rb
+- lib/get/subcommand/commit/prompt.rb
+- lib/get/subcommand/describe/change.rb
+- lib/get/subcommand/describe/describe.rb
+- lib/get/subcommand/describe/docker/docker.rb
+- lib/get/subcommand/describe/metadata.rb
+- lib/get/subcommand/describe/prerelease.rb
+- lib/get/subcommand/init/init.rb
+- lib/get/version.rb
+homepage: https://github.com/asperan/get
+licenses:
+- LGPL-3.0-or-later
+metadata:
+  homepage_uri: https://github.com/asperan/get
+  source_code_uri: https://github.com/asperan/get
+  allowed_push_host: https://rubygems.org
+  rubygems_mfa_required: 'true'
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.1.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.3.7
+signing_key:
+specification_version: 4
+summary: Git Enhancement Toolbox
+test_files: []