git_toolbox 0.7.1 → 0.8.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a9a83558777ee286d804e64a714388d13b4ac16e15e724580f7957ea422ba8a2
-  data.tar.gz: 8e76c6784c12e03f9cab918099a219e5e823441b90356c68b4cabc8e0bcf13fe
+  metadata.gz: 500f22d2000495865a5671476122c580ea0e5fdb6ebf2804ce42d209828a1841
+  data.tar.gz: 70a3c312974ce5ee382a8c6793325bf676dba7fb40206ed828f56c2019ce9d64
 SHA512:
-  metadata.gz: 89d357ca5cf79577e6a05e3d5aff6dccb227c593565d8c5fe7d634d7a76b2cbe568a3c3db6cc49c58d0edfe4418d5da99f39fb1c944dfd14e2267dcb35d3a5bf
-  data.tar.gz: d5a06e808f81790b745ddf2ca031d6ca9c318e13c563aa78262488ec32ab8b98fca0b5d089b5f97b1ae321e76ca3825cd4018248b791490f85fb4c78dfaf1080
+  metadata.gz: ce3a643b6a110c7b70e7ddc33649548b15f064e61dbe35c13fa5eba3fa70b7c71a5118185ee88b89aab83f74602b605d9175b4633e58c933ae30ebfae97c2dab
+  data.tar.gz: 5125a3a0af8ab4a6590af9166c95d442c1dae5f89648f1d94224ff5a4d3e18fcaf21ec5e9d52b1f50939340d17d60ddd5cd37fa7bd6bd16b4e7ce88f2ac868da

data/bin/get

@@ -5,4 +5,4 @@ require 'rubygems'
 require 'bundler/setup'
 require 'get'
 
-Get.main
+Get.instance.main

data/lib/get/commons/command_issuer.rb

@@ -0,0 +1,60 @@
+# 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 'open3'
+
+# Module for simplify command execution.
+module CommandIssuer
+  # A class containing the result of a command, including the exit status and the command executed.
+  class CommandResult
+    attr_reader :command, :exit_status, :output, :error
+
+    def initialize(command_string, exit_status, standard_output, standard_error)
+      @command = command_string
+      @exit_status = exit_status
+      @output = standard_output
+      @error = standard_error
+    end
+  end
+
+  def self.run(executable, *args)
+    full_path_executable = CommandIssuer.send(:find, executable)
+    command = [full_path_executable, *args].join(' ').strip
+    output, error, status = Open3.capture3(command)
+    CommandResult.new(command, status.exitstatus, output, error)
+  end
+
+  class << self
+    private
+
+    # Checks if the given executable exists. If it does not exists,
+    # an error message will be displayed and the program will exit.
+    # Based on https://stackoverflow.com/a/5471032
+    def find(executable)
+      exts = ENV['PATHEXT'] ? ENV['PATHEXT'].split(';') : ['']
+      ENV['PATH'].split(File::PATH_SEPARATOR).each do |path|
+        exts.each do |ext|
+          exe = File.join(path, "#{executable}#{ext}")
+          return exe if File.executable?(exe) && !File.directory?(exe)
+        end
+      end
+      Common.error("'#{executable}' was not found in PATH.")
+    end
+  end
+end

data/lib/get/commons/common.rb

@@ -51,4 +51,74 @@ module Common
     action.call if action.respond_to?('call')
     exit(exit_code)
   end
+
+  # Add an instance attribute (with a default value) to a module.
+  # It is intended to be called in the body of a module definition:
+  #    module MyModule
+  #       DEFAULT_VALUE = 1
+  #       Common.module_instance_attr(self, my_variable, DEFAULT_VALUE)
+  #    end
+  # produces the code:
+  #    module MyModule
+  #       instance_variable_set(:@my_variable, 1)
+  #       def self.my_variable
+  #         instance_variable_get(:@my_variable)
+  #       end
+  #
+  #       def self.my_variable=(value)
+  #         instance_variable_set(:@my_variable, value)
+  #       end
+  #    end
+  def self.module_instance_attr(mod, name, default_value = nil)
+    mod.module_eval(<<~CODE, __FILE__, __LINE__ + 1)
+      # module MyModule
+      #       instance_variable_set(:@my_variable, 1)
+      #       def self.my_variable
+      #         instance_variable_get(:@my_variable)
+      #       end
+      #
+      #       def self.my_variable=(value)
+      #         instance_variable_set(:@my_variable, value)
+      #       end
+      #    end
+
+      instance_variable_set(:@#{name}, #{default_value})
+
+      def self.#{name}
+        instance_variable_get(:@#{name})
+      end
+
+      def self.#{name}=(value)
+        instance_variable_set(:@#{name}, value)
+      end
+    CODE
+  end
+
+  def self.module_instance_value(mod, name, value)
+    mod.module_eval(<<~CODE, __FILE__, __LINE__ + 1)
+      # module MyModule
+      #   instance_variable_set(:@my_variable, 1)
+      #   def self.my_variable
+      #     instance_variable_get(:@my_variable)
+      #   end
+      # end
+
+      instance_variable_set(:@#{name}, #{value})
+
+      def self.#{name}
+        instance_variable_get(:@#{name})
+      end
+    CODE
+  end
+
+  # Add a new 'MOD_REF' constant with the module symbol for a shorter variable name.
+  def self.add_module_self_reference(mod)
+    mod.module_eval(<<~CODE, __FILE__, __LINE__ + 1)
+      # module MyModule
+      #   MOD_REF = MyModule
+      # end
+
+      MOD_REF = #{mod.name}
+    CODE
+  end
 end

data/lib/get/commons/git.rb

@@ -17,23 +17,17 @@
 
 # frozen_string_literal: true
 
-require 'English'
-require 'get/commons/common'
+require_relative './command_issuer'
 
 # Utility module
 module Git
   # Groups: 1 = type, 2 = scope with (), 3 = scope, 4 = breaking change, 5 = summary
-  CONVENTIONAL_COMMIT_REGEX = /^(\w+)(\(([\w-]+)\))?(!)?:(.*)/
+  CONVENTIONAL_COMMIT_REGEX = %r{^(\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
+    CommandIssuer.run('git', 'rev-parse', '--is-inside-work-tree').exit_status.zero?
   end
 
   # Run a block of code with the list of commits from the given version as an argument.
@@ -41,19 +35,42 @@ module Git
   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")
+    command_result = CommandIssuer.run(
+      'git',
+      '--no-pager',
+      'log',
+      '--oneline',
+      '--pretty=format:%s',
+      version.nil? ? '' : "^#{version} HEAD"
+    )
+    commits_from_version = if command_result.exit_status.zero?
+                             command_result.output.split("\n")
+                           else
+                             []
+                           end
     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
+    @last_version ||=
+      CommandIssuer.run('git', 'describe', '--tags', '--abbrev=0')
+                   .then { |result| result.output.strip if result.exit_status.zero? }
   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
+    @last_release ||=
+      CommandIssuer.run('git', '--no-pager', 'tag', '--list')
+                   .then do |value|
+        unless value.output.empty?
+          value.output
+               .split("\n")
+               .map { |str| str.sub('+', '_') }
+               .sort
+               .map { |str| str.sub('_', '+') }
+               .last
+        end
+      end
   end
 end

data/lib/get/commons/http_client.rb

@@ -0,0 +1,79 @@
+# 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 'net/http'
+require 'uri'
+
+# Client HTTP which allows to perform GET request and follow redirections.
+class HTTPClient
+  include Singleton
+
+  # Number of attempts to try when following a redirection link.
+  MAX_ATTEMPTS = 10
+
+  # Perform a get request to an address, following the redirections at most MAX_ATTEMPTS times.
+  def http_get_request(address)
+    uri = URI.parse(address)
+
+    # Code based on https://shadow-file.blogspot.com/2009/03/handling-http-redirection-in-ruby.html
+    attempts = 0
+    until attempts >= MAX_ATTEMPTS
+      attempts += 1
+
+      resp = build_http(uri)
+             .request(Net::HTTP::Get.new(uri.path == '' ? '/' : uri.path))
+      return resp if resp.is_a?(Net::HTTPSuccess) || resp.header['location'].nil?
+
+      uri = updated_uri(uri, resp.header['location'])
+    end
+    nil
+  end
+
+  def response_error_message(response)
+    if response.nil?
+      'too many redirections'
+    else
+      "#{response.code} #{response.message}"
+    end
+  end
+
+  private
+
+  def build_http(uri)
+    Net::HTTP.new(uri.host, uri.port)
+             .tap { |http| http.open_timeout = 10 }
+             .tap { |http| http.read_timeout = 10 }
+             .tap do |http|
+      if uri.instance_of? URI::HTTPS
+        http.use_ssl = true
+        http.verify_mode = OpenSSL::SSL::VERIFY_NONE
+      end
+    end
+  end
+
+  def updated_uri(old_uri, location)
+    URI.parse(location).then do |value|
+      if value.relative?
+        old_uri + location
+      else
+        value
+      end
+    end
+  end
+end

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

@@ -17,22 +17,14 @@
 
 # frozen_string_literal: true
 
-require 'English'
-require 'get/commons/common'
-require 'get/commons/git'
-require 'get/subcommand/command'
+require_relative '../../commons/common'
+require_relative '../../commons/git'
+require_relative '../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'
@@ -44,56 +36,11 @@ class Changelog < Command
     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)
+    super() do
+      @usage = 'changelog -h|(<subcommand> [<subcommand-options])'
+      @description = 'Generate a changelog. Format options require a "%s" where the content must be.'
+      @subcommands = {}
     end
   end
 
@@ -139,7 +86,7 @@ class Changelog < Command
     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}")}
+      #{@format[:title].sub('%s', "Changelog from #{from_version.nil? ? 'first commit' : "version #{from_version}"}")}
       #{(formatted_features + formatted_fixes + formatted_types).join("\n").strip}
     CHANGELOG
   end
@@ -161,5 +108,53 @@ class Changelog < Command
       #{@format[:list].sub('%s', formatted_commits.join("\n"))}
     SCOPE
   end
+
+  protected
+
+  def setup_option_parser
+    @option_parser = Optimist::Parser.new(
+      @usage,
+      full_description,
+      stop_condition
+    ) do |usage_header, description, stop_condition|
+      usage usage_header
+      synopsis description
+      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 stop_condition
+    end
+  end
+
+  def setup_action
+    @action = lambda 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
 end
 # rubocop:enable Metrics/ClassLength

data/lib/get/subcommand/command.rb

@@ -17,15 +17,67 @@
 
 # frozen_string_literal: true
 
-# Base class for (sub)commands. (Sub)Commands should be singletons.
+require 'singleton'
+
+# Base class for (sub)commands.
 class Command
-  attr_reader :description, :action
+  include Singleton
+
+  attr_reader :usage, :description, :action, :subcommands, :option_parser
 
   protected
 
-  def initialize(usage, description, &action)
-    @usage = usage
-    @description = description
-    @action = action
+  attr_writer :usage, :description, :action, :subcommands, :option_parser
+
+  def initialize
+    super
+    yield self if block_given?
+    setup_option_parser
+    if @option_parser.nil?
+      raise("No variable '@option_parser' has been created in the option_parser setup of command #{self.class.name}.")
+    end
+
+    setup_action
+    return unless @action.nil?
+
+    raise("No variable '@action' has been created in the action setup of the command #{self.class.name}")
+  end
+
+  @description = ''
+  @subcommands = {}
+
+  # This method must be overridden by subclasses to create a new option parser in a '@option_parser' variable.
+  # Do not call 'super' in the new implementation.
+  def setup_option_parser
+    raise("Error: command #{self.class.name} do not have a defined option parser.")
+  end
+
+  # This method must be overridden by subclasses to create a new option parser in a '@action' variable.
+  # Do not call 'super' in the new implementation.
+  def setup_action
+    raise("Error: command #{self.class.name} do not have a defined action.")
+  end
+
+  def full_description
+    description + if subcommands.empty?
+                    ''
+                  else
+                    subcommand_max_length = subcommands.keys.map { |k| k.to_s.length }.max || 0
+                    <<~SUBCOMMANDS.chomp
+                      \n
+                      Subcommands:
+                      #{subcommands.keys.map { |k| "  #{k.to_s.ljust(subcommand_max_length)} => #{subcommands[k].description}" }.join("\n")}
+                    SUBCOMMANDS
+                  end
+  end
+
+  def stop_condition
+    subcommands.keys.map(&:to_s)
+  end
+
+  def educated_error(message)
+    Common.error message do
+      @option_parser.educate
+    end
   end
 end

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

@@ -17,77 +17,24 @@
 
 # frozen_string_literal: true
 
-require 'English'
-require 'get/commons/common'
-require 'get/commons/git'
-require 'get/subcommand/command'
-require 'get/subcommand/commit/prompt'
+require_relative '../../commons/common'
+require_relative '../../commons/git'
+require_relative '../command'
+require_relative './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
-  @@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 :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
-      @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
-      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"
+    super() do
+      @usage = 'commit -h|(<subcommand> [<subcommand-options])'
+      @description = 'Create a new semantic commit.'
+      @subcommands = {}
     end
   end
 
@@ -143,5 +90,55 @@ class Commit < Command
       ask_for_message
     end.to_s.strip
   end
+
+  protected
+
+  def setup_option_parser
+    @option_parser = Optimist::Parser.new(
+      @usage,
+      full_description,
+      stop_condition
+    ) do |usage_header, description, stop_condition|
+      usage usage_header
+      synopsis description
+      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 }
+      opt :quiet,
+          'Disable the print of the complete message.'
+      educate_on_error
+      stop_on stop_condition
+    end
+  end
+
+  def setup_action
+    @action = lambda do
+      @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 unless @options[:quiet]
+      command_result = CommandIssuer.run('git', 'commit', '--no-status', '-m', "\"#{message.gsub('"', '\"')}\"")
+      Common.error "git commit failed: #{command_result.output}" if command_result.exit_status.positive?
+    rescue Interrupt
+      Common.print_then_do_and_exit "\nCommit cancelled"
+    end
+  end
 end
 # rubocop:enable Metrics/ClassLength