git_toolbox 0.5.0 → 0.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 27cbd5cdcfa5aba4e9e23c32e9db785360fbb3e9d044e9a613a2d6249e5131c2
-  data.tar.gz: 6e59f2ad922d63d9ab8a73fb28c4b2f8c61da3d96538664033e0587e75e80085
+  metadata.gz: 0bb05b8ed627b884189e6b9c17eddc7284f20f4e2bce598dd24f154b6f717c99
+  data.tar.gz: bf1d78a1e32c113cb00cb0b0c9150f09359d4743927505d0ea34dd0d9fa48f20
 SHA512:
-  metadata.gz: 52f10e7a912dbda4211dec1ab913d7411ea029dbe27e1ba208f68b427da74c7a9c711e20acbf952c064b52f91713456dbb604384dd5158dc91d059e5ffe9c740
-  data.tar.gz: c642826b2c4a798ce1ce85d15b458d2eff955c0be874e307b18e25056e747d6d044e7ed69dc94093bc03865041a17b7db32c3de456d9b3fc910b4457b68f4f23
+  metadata.gz: 949501f9b215d45757904e2201675539a9601a65e88e5418cb97ced39f3fa343aba3a53d34a45caefe490e46095d43318465634bc70d5b55bdda704676fd5333
+  data.tar.gz: 79f86d45ac90f0be948fd36948314aa0e5b27d1b596bdd8d36b661983660986ca1a91199b9698a5d5bce0947d70e0ffd8665f8506ee19ebaad7c5b99acdbea21

data/lib/get/{common.rb → commons/common.rb}

@@ -21,20 +21,6 @@ require 'English'
 
 # 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')
-    case $CHILD_STATUS.exitstatus
-    when 0 then true
-    when 127 then Common.error '"git" is not installed.'
-    else false
-    end
-  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.
@@ -55,17 +41,6 @@ module Common
     # 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.

data/lib/get/commons/git.rb

@@ -0,0 +1,59 @@
+# 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/commons/common'
+
+# Utility module
+module Git
+  # Groups: 1 = type, 2 = scope with (), 3 = scope, 4 = breaking change, 5 = summary
+  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_repo?
+    system('git rev-parse --is-inside-work-tree &>/dev/null')
+    case $CHILD_STATUS.exitstatus
+    when 0 then true
+    when 127 then Common.error '"git" is not installed.'
+    else false
+    end
+  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
+
+  # Returns the last version and caches it for the next calls.
+  def self.last_version
+    @@last_version ||= `git describe --tags --abbrev=0`.strip
+  end
+
+  # Returns the last release and caches it for the next calls.
+  def self.last_release
+    @@last_release ||= `git --no-pager tag --list | sed 's/+/_/' | sort -V | sed 's/_/+/' | tail -n 1`.strip
+  end
+end

data/lib/get/subcommand/changelog/changelog.rb

@@ -0,0 +1,165 @@
+# 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/commons/common'
+require 'get/commons/git'
+require 'get/subcommand/command'
+
+# Class length is disabled as most of its length is given by formatting.
+# rubocop:disable Metrics/ClassLength
+# Subcommand, generates a changelog.
+class Changelog < Command
+  def self.command
+    @@command ||= new
+    @@command
+  end
+
+  private_class_method :new
+
+  private
+
+  UNDEFINED_SCOPE = 'other'
+  MARKDOWN_FORMAT = {
+    title: '# %s',
+    type: '## %s',
+    scope: '### %s',
+    list: '%s',
+    item: '- %s'
+  }.freeze
+
+  @@command = nil
+
+  @@usage = 'changelog -h|(<subcommand> [<subcommand-options])'
+  @@description = 'Generate a changelog. Format options require a "%s" where the content must be.'
+  @@subcommands = {}
+  # This block is Optimist configuration. It is as long as the number of options of the command.
+  # rubocop:disable Metrics/BlockLength
+  @@option_parser = Optimist::Parser.new do
+    subcommand_max_length = @@subcommands.keys.map { |k| k.to_s.length }.max
+    subcommand_section = <<~SUBCOMMANDS unless @@subcommands.empty?
+      Subcommands:
+      #{@@subcommands.keys.map { |k| "  #{k.to_s.ljust(subcommand_max_length)} => #{@@subcommands[k].description}" }.join("\n")}
+    SUBCOMMANDS
+    usage @@usage
+    synopsis @@description + (subcommand_section.nil? ? '' : "\n") + subcommand_section.to_s
+    opt :latest,
+        'Generate the changelog from the latest version rather than the latest release'
+    opt :title_format,
+        'Set the symbol for the title.',
+        { type: :string, short: 'T', default: '# %s' }
+    opt :type_format,
+        'Set the symbol for the commit types.',
+        { type: :string, short: 't', default: '= %s' }
+    opt :scope_format,
+        'Set the symbol for the commit scopes.',
+        { type: :string, short: 's', default: '- %s' }
+    opt :list_format,
+        'Set the symbol for lists.',
+        { type: :string, short: 'l', default: '%s' }
+    opt :item_format,
+        'Set the symbol for list items.',
+        { type: :string, short: 'i', default: '* %s' }
+    opt :markdown,
+        'Shortcut for `-T "# %s" -t "## %s" -s "### %s" -l "%s" -i "- %s"`. ' \
+        'Can be overwritten by the single options.'
+    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 @@option_parser do
+        @@option_parser.parse
+      end
+      Common.error 'changelog need to be run inside a git repository' unless Git.in_repo?
+      @format = {}
+      set_format
+
+      puts changelog_from(@options[:latest] ? Git.last_version : Git.last_release)
+    end
+  end
+
+  def set_format
+    %w[title type scope list item].each do |element|
+      @format[element.to_sym] = if @options[:markdown] && !@options["#{element}_given".to_sym]
+                                  MARKDOWN_FORMAT[element.to_sym]
+                                else
+                                  unless @options["#{element}_format".to_sym].include? '%s'
+                                    Common.error "The given format for '#{element}' must contain '%s'."
+                                  end
+                                  @options["#{element}_format".to_sym]
+                                end
+    end
+  end
+
+  def changelog_from(version)
+    commit_map = {}
+
+    Git.with_commit_list_from(version) do |list|
+      list.each do |element|
+        match_result = Git::CONVENTIONAL_COMMIT_REGEX.match(element)
+        temp_hash = {
+          match_result[1] => {
+            (match_result[3] || UNDEFINED_SCOPE) => [match_result[5].strip.capitalize]
+          }
+        }
+        commit_map.merge!(temp_hash) do |_key, old_value, new_value|
+          old_value.merge(new_value) do |_inner_key, old_array, new_array|
+            old_array + new_array
+          end
+        end
+      end
+    end
+
+    format_changelog(version, commit_map)
+  end
+
+  def format_changelog(from_version, changelog)
+    formatted_features = changelog.key?('feat') ? [format_type('feat', changelog['feat'])] : []
+    formatted_fixes = changelog.key?('fix') ? [format_type('fix', changelog['fix'])] : []
+
+    formatted_types = []
+    changelog.except('feat', 'fix').each { |key, value| formatted_types.push(format_type(key, value)) }
+    <<~CHANGELOG
+      #{@format[:title].sub('%s', "Changelog from version #{from_version}")}
+      #{(formatted_features + formatted_fixes + formatted_types).join("\n").strip}
+    CHANGELOG
+  end
+
+  def format_type(type, scopes)
+    formatted_scopes = []
+    scopes.each { |key, value| formatted_scopes.push(format_scope(key, value)) }
+    <<~TYPE
+      #{@format[:type].sub('%s', type.to_s)}
+      #{formatted_scopes.join("\n").strip}
+    TYPE
+  end
+
+  def format_scope(scope, commits)
+    formatted_commits = []
+    commits.each { |element| formatted_commits.push(@format[:item].sub('%s', element)) }
+    <<~SCOPE
+      #{@format[:scope].sub('%s', scope.to_s)}
+      #{@format[:list].sub('%s', formatted_commits.join("\n"))}
+    SCOPE
+  end
+end
+# rubocop:enable Metrics/ClassLength

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

@@ -18,7 +18,8 @@
 # frozen_string_literal: true
 
 require 'English'
-require 'get/common'
+require 'get/commons/common'
+require 'get/commons/git'
 require 'get/subcommand/command'
 require 'get/subcommand/commit/prompt'
 
@@ -40,17 +41,18 @@ class Commit < Command
   @@command = nil
 
   @@usage = 'commit -h|(<subcommand> [<subcommand-options])'
-  @@description = 'Create a new semantic commit'
+  @@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
+  @@option_parser = Optimist::Parser.new do
     subcommand_max_length = @@subcommands.keys.map { |k| k.to_s.length }.max
-    usage @@usage
-    synopsis <<~SUBCOMMANDS unless @@subcommands.empty?
+    subcommand_section = <<~SUBCOMMANDS unless @@subcommands.empty?
       Subcommands:
       #{@@subcommands.keys.map { |k| "  #{k.to_s.ljust(subcommand_max_length)} => #{@@subcommands[k].description}" }.join("\n")}
     SUBCOMMANDS
+    usage @@usage
+    synopsis @@description + (subcommand_section.nil? ? '' : "\n") + subcommand_section.to_s
     opt :type,
         'Define the type of the commit. Enabling this option skips the type selection.',
         { type: :string }
@@ -75,10 +77,10 @@ class Commit < Command
 
   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
+      @options = Common.with_subcommand_exception_handling @@option_parser do
+        @@option_parser.parse
       end
+      Common.error 'commit need to be run inside a git repository' unless Git.in_repo?
 
       message = full_commit_message
       puts message

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

@@ -18,6 +18,7 @@
 # frozen_string_literal: true
 
 require 'highline'
+require 'get/commons/git'
 
 # Module for asking to the user informations about a commit message.
 module PromptHandler
@@ -107,9 +108,9 @@ module PromptHandler
   def extract_types_and_scopes
     return unless @@custom_values_initialized.nil?
 
-    Common.with_commit_list_from(FIRST_COMMIT) do |commit_list|
+    Git.with_commit_list_from(FIRST_COMMIT) do |commit_list|
       commit_list.map do |element|
-        match = Common::CONVENTIONAL_COMMIT_REGEX.match(element)
+        match = Git::CONVENTIONAL_COMMIT_REGEX.match(element)
         next if match.nil?
 
         type_already_added = DEFAULT_TYPES.include?(match[1].to_sym) || @@custom_types.include?(match[1])

data/lib/get/subcommand/complete/bash_completion.rb

@@ -0,0 +1,92 @@
+# 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 bash completion generation functions
+module BashCompletion
+  def bash_completion(main_module, command_name)
+    generate_functions(main_module, command_name, INITIAL_LEVEL)
+
+    "#{HEADER}\n#{@@function_stack.reverse.join("\n")}"
+  end
+
+  private
+
+  INITIAL_LEVEL = 1
+
+  HEADER = <<~HEADER
+    #!/usr/bin/env bash
+    #
+    # This file has been generated by `get complete`.
+    # The script structure was inspired by https://opensource.com/article/18/3/creating-bash-completion-script
+    #
+  HEADER
+
+  @@function_stack = []
+
+  def full_subcommand_name(base, name)
+    "#{base}_#{name}"
+  end
+
+  def completion_function_definition(name, level, long_options, short_options, subcommands)
+    <<~FUNCTION
+      _#{name}_completion()
+      {
+        if [ "${COMP_CWORD}" -eq "#{level}" ] ; then
+          COMPREPLY=($(compgen -W "#{(long_options | short_options | subcommands).join(' ')}" -- "${COMP_WORDS[#{level}]}"))
+        else
+          case "${COMP_WORDS[#{level}]}" in
+          #{subcommands.map { |element| subcommand_case_completion(name, element) }.join("\n")}
+          *)
+            COMPREPLY=()
+            ;;
+          esac
+        fi
+      }
+    FUNCTION
+  end
+
+  def subcommand_case_completion(base, name)
+    <<~CASE
+      "#{name}")
+        _#{full_subcommand_name(base, name)}_completion
+        ;;
+    CASE
+  end
+
+  def generate_functions(command_class, name, level)
+    long_options = []
+    short_options = []
+    subcommands = []
+
+    command_class.class_variable_get(:@@option_parser).specs.each_value do |option|
+      long_options.push("--#{option.long}")
+      short_options.push("-#{option.short.nil? ? option.long[0] : option.short}") if option.short != :none
+    end
+
+    command_class.class_variable_get(:@@subcommands).each_key do |subcommand|
+      subcommands.push(subcommand.to_s)
+    end
+
+    @@function_stack.push(completion_function_definition(name, level, long_options, short_options, subcommands))
+
+    command_class.class_variable_get(:@@subcommands).each do |element|
+      generate_functions(element[1].class, full_subcommand_name(name, element[0].to_s), level + 1)
+    end
+  end
+end

data/lib/get/subcommand/complete/complete.rb

@@ -0,0 +1,82 @@
+# 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/commons/common'
+require 'get/subcommand/command'
+require 'get/subcommand/complete/bash_completion'
+require 'get'
+
+# Class length is disabled as most of its length is given by formatting.
+# rubocop:disable Metrics/ClassLength
+# Subcommand, prints the bash completion script.
+class Complete < Command
+  def self.command
+    @@command ||= new
+    @@command
+  end
+
+  private_class_method :new
+
+  private
+
+  include BashCompletion
+
+  @@command = nil
+
+  @@usage = 'complete -h|(<subcommand> [<subcommand-options])'
+  @@description = 'Print the shell completion script.'
+  @@subcommands = {}
+  # This block is Optimist configuration. It is as long as the number of options of the command.
+  # rubocop:disable Metrics/BlockLength
+  @@option_parser = Optimist::Parser.new do
+    subcommand_max_length = @@subcommands.keys.map { |k| k.to_s.length }.max
+    subcommand_section = <<~SUBCOMMANDS unless @@subcommands.empty?
+      Subcommands:
+      #{@@subcommands.keys.map { |k| "  #{k.to_s.ljust(subcommand_max_length)} => #{@@subcommands[k].description}" }.join("\n")}
+    SUBCOMMANDS
+    usage @@usage
+    synopsis @@description + (subcommand_section.nil? ? '' : "\n") + subcommand_section.to_s
+    opt :shell,
+        'Select the type of shell of which the completion will be generated.',
+        { type: :string, default: 'bash' }
+    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 @@option_parser do
+        @@option_parser.parse
+      end
+
+      @completions = {
+        bash: proc { bash_completion(Get, 'get') }
+      }
+
+      selected_shell = @options[:shell].to_sym
+
+      Common.error "Completion for shell '#{selected_shell}' not available." unless @completions.key?(selected_shell)
+
+      puts @completions[selected_shell].call
+    end
+  end
+end
+# rubocop:enable Metrics/ClassLength

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

@@ -51,7 +51,7 @@ module ChangeHandler
   class ::String
     # Convert the string (as a conventional commit string) into a change type.
     def to_change
-      groups = Common::CONVENTIONAL_COMMIT_REGEX.match(self)
+      groups = Git::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])
@@ -64,7 +64,7 @@ module ChangeHandler
 
   def greatest_change_in(commit_list)
     commit_list
-      .grep(Common::CONVENTIONAL_COMMIT_REGEX)
+      .grep(Git::CONVENTIONAL_COMMIT_REGEX)
       .map(&:to_change)
       .max { |a, b| CHANGE_TYPE.index(a) <=> CHANGE_TYPE.index(b) }
   end

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

@@ -17,6 +17,8 @@
 
 # frozen_string_literal: true
 
+require 'get/commons/common'
+require 'get/commons/git'
 require 'get/subcommand/command'
 require 'get/subcommand/describe/change'
 require 'get/subcommand/describe/prerelease'
@@ -50,19 +52,20 @@ class Describe < Command
     /x
 
   @@usage = 'describe -h|(<subcommand> [<subcommand-options])'
-  @@description = 'Describe the current git repository with semantic version'
+  @@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
+  @@option_parser = Optimist::Parser.new do
     subcommand_max_length = @@subcommands.keys.map { |k| k.to_s.length }.max
-    usage @@usage
-    synopsis <<~SUBCOMMANDS unless @@subcommands.empty?
+    subcommand_section = <<~SUBCOMMANDS unless @@subcommands.empty?
       Subcommands:
       #{@@subcommands.keys.map { |k| "  #{k.to_s.ljust(subcommand_max_length)} => #{@@subcommands[k].description}" }.join("\n")}
     SUBCOMMANDS
+    usage @@usage
+    synopsis @@description + (subcommand_section.nil? ? '' : "\n") + subcommand_section.to_s
     opt :prerelease,
         'Describe a prerelease rather than a release',
         short: :none
@@ -109,10 +112,10 @@ class Describe < Command
 
   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
+      @options = Common.with_subcommand_exception_handling @@option_parser do
+        @@option_parser.parse
       end
+      Common.error 'describe need to be run inside a git repository' unless Git.in_repo?
       set_options
 
       if ARGV.length.positive?
@@ -141,9 +144,9 @@ class Describe < Command
   end
 
   def describe_current_commit
-    return last_version if Common.with_commit_list_from(last_version, &:empty?)
+    return Git.last_version if Git.with_commit_list_from(Git.last_version, &:empty?)
 
-    puts "Last version: #{last_version}" if @options[:diff]
+    puts "Last version: #{Git.last_version}" if @options[:diff]
 
     current_commit_version = next_release
     create_signed_tag(current_commit_version) if @options[:create_tag]
@@ -153,9 +156,9 @@ class Describe < Command
 
   def next_release
     if @options[:prerelease]
-      prepare_prerelease_tag(last_release, last_version)
+      prepare_prerelease_tag(Git.last_release, Git.last_version)
     else
-      prepare_release_tag(last_release)
+      prepare_release_tag(Git.last_release)
     end + metadata
   end
 
@@ -172,20 +175,10 @@ class Describe < Command
       "-#{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_from_stable_version = Git.with_commit_list_from(stable_version) do |commits_from_version|
       greatest_change_in(commits_from_version)
     end
     split_version = stable_version.split('.')

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

@@ -17,6 +17,8 @@
 
 # frozen_string_literal: true
 
+require 'get/commons/common'
+require 'get/commons/git'
 require 'get/subcommand/command'
 
 # Class length is disabled as most of its length is given by formatting.
@@ -41,7 +43,7 @@ class DescribeDocker < Command
   @@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
+  @@option_parser = Optimist::Parser.new do
     subcommand_max_length = @@subcommands.keys.map { |k| k.to_s.length }.max
     usage @@usage
     synopsis <<~SUBCOMMANDS unless @@subcommands.empty?
@@ -64,9 +66,9 @@ class DescribeDocker < Command
 
   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
+      Common.error 'describe need to be run inside a git repository' unless Git.in_repo?
+      @options = Common.with_subcommand_exception_handling @@option_parser do
+        @@option_parser.parse
       end
       set_options
 

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

@@ -18,7 +18,8 @@
 # frozen_string_literal: true
 
 require 'English'
-require 'get/common'
+require 'get/commons/common'
+require 'get/commons/git'
 require 'get/subcommand/command'
 
 # Class length is disabled as most of its length is given by formatting.
@@ -37,17 +38,18 @@ class Init < Command
   @@command = nil
 
   @@usage = 'init -h|(<subcommand> [<subcommand-options])'
-  @@description = 'Initialize a new git repository with an initial empty commit'
+  @@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
+  @@option_parser = Optimist::Parser.new do
     subcommand_max_length = @@subcommands.keys.map { |k| k.to_s.length }.max
-    usage @@usage
-    synopsis <<~SUBCOMMANDS unless @@subcommands.empty?
+    subcommand_section = <<~SUBCOMMANDS unless @@subcommands.empty?
       Subcommands:
       #{@@subcommands.keys.map { |k| "  #{k.to_s.ljust(subcommand_max_length)} => #{@@subcommands[k].description}" }.join("\n")}
     SUBCOMMANDS
+    usage @@usage
+    synopsis @@description + (subcommand_section.nil? ? '' : "\n") + subcommand_section.to_s
     opt :empty,
         'Do not create the first, empty commit.'
     educate_on_error
@@ -57,10 +59,10 @@ class Init < Command
 
   def initialize
     super(@@usage, @@description) do
-      @options = Common.with_subcommand_exception_handling @@commit_parser do
-        @@commit_parser.parse
+      @options = Common.with_subcommand_exception_handling @@option_parser do
+        @@option_parser.parse
       end
-      Common.error 'The current directory is already a git repository' if Common.in_git_repo?
+      Common.error 'The current directory is already a git repository' if Git.in_repo?
 
       init_repository
     end

data/lib/get/subcommand/license/license.rb

@@ -17,7 +17,8 @@
 
 # frozen_string_literal: true
 
-require 'get/common'
+require 'get/commons/common'
+require 'get/commons/git'
 require 'get/subcommand/command'
 require 'get/subcommand/license/license_retriever'
 
@@ -45,7 +46,7 @@ class License < Command
   @@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
+  @@option_parser = Optimist::Parser.new do
     subcommand_max_length = @@subcommands.keys.map { |k| k.to_s.length }.max
     subcommand_section = <<~SUBCOMMANDS unless @@subcommands.empty?
       Subcommands:
@@ -68,8 +69,8 @@ class License < Command
 
   def initialize
     super(@@usage, @@description) do
-      @options = Common.with_subcommand_exception_handling @@commit_parser do
-        @@commit_parser.parse
+      @options = Common.with_subcommand_exception_handling @@option_parser do
+        @@option_parser.parse
       end
 
       @filename = 'LICENSE'
@@ -79,7 +80,7 @@ class License < Command
       create_license_file
 
       if @options[:create_commit]
-        Common.error 'Not in a git repository: a commit cannot be created.' unless Common.in_git_repo?
+        Common.error 'Not in a git repository: a commit cannot be created.' unless Git.in_repo?
 
         create_license_commit
       end

data/lib/get/subcommand/tree/tree.rb

@@ -0,0 +1,118 @@
+# 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/commons/common'
+require 'get/commons/git'
+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 Tree < Command
+  def self.command
+    @@command ||= new
+    @@command
+  end
+
+  private_class_method :new
+
+  private
+
+  @@command = nil
+
+  @@usage = 'tree -h|(<subcommand> [<subcommand-options])'
+  @@description = 'Print the tree of commits.'
+  @@subcommands = {}
+  # This block is Optimist configuration. It is as long as the number of options of the command.
+  # rubocop:disable Metrics/BlockLength
+  @@option_parser = Optimist::Parser.new do
+    subcommand_max_length = @@subcommands.keys.map { |k| k.to_s.length }.max
+    subcommand_section = <<~SUBCOMMANDS unless @@subcommands.empty?
+      Subcommands:
+      #{@@subcommands.keys.map { |k| "  #{k.to_s.ljust(subcommand_max_length)} => #{@@subcommands[k].description}" }.join("\n")}
+    SUBCOMMANDS
+    usage @@usage
+    synopsis @@description + (subcommand_section.nil? ? '' : "\n") + subcommand_section.to_s
+    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 @@option_parser do
+        @@option_parser.parse
+      end
+      Common.error 'tree need to be run inside a git repository' unless Git.in_repo?
+
+      view_tree
+    end
+  end
+
+  def view_tree
+    page_log(transform_log(log))
+  end
+
+  TREE_FORMAT = '%C(bold blue)%h%C(reset)§%C(dim normal)(%cr)%C(reset)§%C(auto)%d%C(reset)§§%n' \
+                '§§§       %C(normal)%an%C(reset)%C(dim normal): %s%C(reset)'
+
+  def log
+    `git log --all --graph --decorate=short --date-order --color --pretty=format:"#{TREE_FORMAT}"`
+  end
+
+  TIME_REGEX = /(\([a-z0-9 ,]+\))/
+  TIME_MINIMUM_PADDING = 2
+
+  def transform_log(text)
+    split_lines = text.split("\n").map { |element| element.split('§') }
+    # The first line is always a commit line, so it always have a time reference
+    first_line_time = split_lines.first[1]
+    # calc color escape codes length
+    time_color_length = first_line_time.length - first_line_time.match(TIME_REGEX)[1].length
+
+    # calc max length of time references
+    time_padding = 0
+    split_lines.each { |element| time_padding = [time_padding, element[1].length - time_color_length].max }
+
+    # format strings
+    split_lines
+      .map do |element|
+        # Only lines with the date reference have the color escape codes,
+        # the other lines do not need the additional padding
+        left_padding = TIME_MINIMUM_PADDING + time_padding +
+                       (element[1].match?(TIME_REGEX) ? time_color_length : 0)
+        format(
+          '%<date>s %<tree_mark>s %<pointers>s %<commit_text>s',
+          {
+            date: element[1].rjust(left_padding),
+            tree_mark: element[0],
+            pointers: element[2],
+            commit_text: element[3]
+          }
+        )
+      end
+      .join("\n")
+  end
+
+  def page_log(text)
+    system("less -RfS <(echo -e '#{text}')")
+  end
+end
+# rubocop:enable Metrics/ClassLength

data/lib/get/version.rb

@@ -18,5 +18,5 @@
 # frozen_string_literal: true
 
 module Get
-  VERSION = '0.5.0'
+  VERSION = '0.7.0'
 end

data/lib/get.rb

@@ -23,8 +23,11 @@ require 'get/subcommand/describe/describe'
 require 'get/subcommand/commit/commit'
 require 'get/subcommand/init/init'
 require 'get/subcommand/license/license'
+require 'get/subcommand/complete/complete'
+require 'get/subcommand/changelog/changelog'
+require 'get/subcommand/tree/tree'
 require 'get/version'
-require 'get/common'
+require 'get/commons/common'
 
 # Entrypoint of Get
 module Get
@@ -35,6 +38,9 @@ module Get
     commit: Commit.command,
     init: Init.command,
     license: License.command,
+    complete: Complete.command,
+    changelog: Changelog.command,
+    tree: Tree.command,
   }
   @@option_parser = Optimist::Parser.new do
     subcommand_max_length = @@subcommands.keys.map { |k| k.to_s.length }.max

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: git_toolbox
 version: !ruby/object:Gem::Version
-  version: 0.5.0
+  version: 0.7.0
 platform: ruby
 authors:
 - Alex Speranza
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-03-03 00:00:00.000000000 Z
+date: 2023-04-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: optimist
@@ -55,10 +55,14 @@ files:
 - bin/get
 - bin/setup
 - lib/get.rb
-- lib/get/common.rb
+- lib/get/commons/common.rb
+- lib/get/commons/git.rb
+- lib/get/subcommand/changelog/changelog.rb
 - lib/get/subcommand/command.rb
 - lib/get/subcommand/commit/commit.rb
 - lib/get/subcommand/commit/prompt.rb
+- lib/get/subcommand/complete/bash_completion.rb
+- lib/get/subcommand/complete/complete.rb
 - lib/get/subcommand/describe/change.rb
 - lib/get/subcommand/describe/describe.rb
 - lib/get/subcommand/describe/docker/docker.rb
@@ -72,6 +76,7 @@ files:
 - lib/get/subcommand/license/offline_licenses/GNU General Public License v3.0/LICENSE
 - lib/get/subcommand/license/offline_licenses/MIT License/LICENSE
 - lib/get/subcommand/license/offline_licenses/Mozilla Public License 2.0/LICENSE
+- lib/get/subcommand/tree/tree.rb
 - lib/get/version.rb
 homepage: https://github.com/asperan/get
 licenses: