git_toolbox 0.7.1 → 0.8.0

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

@@ -17,82 +17,43 @@
 
 # frozen_string_literal: true
 
-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, 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
-  @@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?
-      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 Git.in_repo?
-      @options = Common.with_subcommand_exception_handling @@option_parser do
-        @@option_parser.parse
-      end
-      set_options
-
-      puts version_list_from(version).join(@@separator)
+    super() do
+      @usage = 'describe docker -h|(<subcommand> [<subcommand-options])'
+      @description = 'Describe the current git repository with a list of version for docker'
+      @subcommands = {}
     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
+    @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),
+      full_version.sub('+', @plus_substitution),
       reduced_versions(full_version),
       latest
     ]
@@ -114,5 +75,41 @@ class DescribeDocker < Command
       ['latest']
     end
   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 :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 stop_condition
+    end
+  end
+
+  def setup_action
+    @action = lambda do |version|
+      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
+
+      puts version_list_from(version).join(@separator)
+    end
+  end
 end
 # rubocop:enable Metrics/ClassLength

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

@@ -17,37 +17,34 @@
 
 # frozen_string_literal: true
 
+require_relative '../../commons/command_issuer'
+
 # 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 = {}
+  def compute_metadata(metadata_specs)
+    requested_metadata = metadata_specs.split(',')
+    unless requested_metadata.all? { |element| metadata_computers.include?(element.to_sym) }
+      Common.error('Some of the metadata requested are not supported')
+    end
+    requested_metadata.map { |element| metadata_computers[element.to_sym].call }.join('-')
+  end
 
-  module_function
+  private
 
   def last_commit_sha
-    `git --no-pager log -n 1 --pretty=%h`.strip
+    CommandIssuer.run('git', '--no-pager', 'log', '-n', '1', '--pretty=%h').output.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
+  def metadata_computers
+    @metadata_computers ||= {
+      sha: proc { last_commit_sha },
+      date: proc { current_date },
+    }
   end
 end

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

@@ -22,18 +22,24 @@ module PrereleaseHandler
   FIRST_PRERELEASE = 1
   DEFAULT_PRERELEASE_STRING = 'dev'
   PRERELEASE_PLACEHOLDER = '(p)'
+  DEFAULT_PRERELEASE_PATTERN = "#{DEFAULT_PRERELEASE_STRING}#{PRERELEASE_PLACEHOLDER}".freeze
 
-  @@prerelease_pattern = "#{DEFAULT_PRERELEASE_STRING}#{PRERELEASE_PLACEHOLDER}"
-  @@old_prerelease_pattern = proc { @@prerelease_pattern }
+  Common.module_instance_attr(self, 'prerelease_pattern', :DEFAULT_PRERELEASE_PATTERN)
+  Common.module_instance_attr(self, 'old_prerelease_pattern', 'proc { prerelease_pattern }')
 
-  module_function
+  def compute_prerelease(current_prerelease, need_reset: false)
+    new_prerelease = (need_reset ? FIRST_PRERELEASE : (extract_prerelease_number(current_prerelease) + 1)).to_s
+    PrereleaseHandler.prerelease_pattern.sub(PRERELEASE_PLACEHOLDER, new_prerelease)
+  end
+
+  private
 
   def extract_prerelease_number(current_prerelease)
     actual_old_prerelease_pattern =
-      if @@old_prerelease_pattern.respond_to?('call')
-        @@old_prerelease_pattern.call
+      if PrereleaseHandler.old_prerelease_pattern.respond_to?('call')
+        PrereleaseHandler.old_prerelease_pattern.call
       else
-        @@old_prerelease_pattern
+        PrereleaseHandler.old_prerelease_pattern
       end
     Common.error "The given old pattern does not contains the placeholder '(p)'" unless
       actual_old_prerelease_pattern.include?(PRERELEASE_PLACEHOLDER)
@@ -45,11 +51,4 @@ module PrereleaseHandler
                    "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

@@ -17,60 +17,28 @@
 
 # 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, 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
 
-  @@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
-  @@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 :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 @@option_parser do
-        @@option_parser.parse
-      end
-      Common.error 'The current directory is already a git repository' if Git.in_repo?
-
-      init_repository
+    super() do
+      @usage = 'init -h|(<subcommand> [<subcommand-options])'
+      @description = 'Initialize a new git repository with an initial empty commit.'
+      @subcommands = {}
     end
   end
 
   def init_repository
-    `git init`
-    Common.error 'Failed to init the repository' if $CHILD_STATUS.exitstatus.positive?
+    command_result = CommandIssuer.run('git', 'init')
+
+    Common.error 'Failed to init the repository' if command_result.exit_status.positive?
 
     create_first_commit unless @options[:empty]
 
@@ -78,8 +46,39 @@ class Init < Command
   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?
+    command_result = CommandIssuer.run('git', 'commit', '--allow-empty', '-m', '"chore: initialize repository"')
+    Common.error 'Failed to create first commit' if command_result.exit_status.positive?
+  end
+
+  protected
+
+  def setup_option_parser
+    # 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(
+      @usage,
+      full_description,
+      stop_condition
+    ) do |usage_header, description, stop_condition|
+      usage usage_header
+      synopsis description
+      opt :empty,
+          'Do not create the first, empty commit.'
+      educate_on_error
+      stop_on stop_condition
+    end
+    # rubocop:enable Metrics/BlockLength
+  end
+
+  def setup_action
+    @action = lambda do
+      @options = Common.with_subcommand_exception_handling @option_parser do
+        @option_parser.parse
+      end
+      Common.error 'The current directory is already a git repository' if Git.in_repo?
+
+      init_repository
+    end
   end
 end
 # rubocop:enable Metrics/ClassLength

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

@@ -17,60 +17,86 @@
 
 # frozen_string_literal: true
 
-require 'get/commons/common'
-require 'get/commons/git'
-require 'get/subcommand/command'
-require 'get/subcommand/license/license_retriever'
+require_relative '../../commons/common'
+require_relative '../../commons/git'
+require_relative '../command'
+require_relative './license_retriever'
 
 # Class length is disabled as most of its length is given by formatting.
 # rubocop:disable Metrics/ClassLength
 # Subcommand, it allow to choose a license.
 class License < Command
-  def self.command
-    @@command ||= new
-    @@command
-  end
-
-  private_class_method :new
-
   private
 
   include Retriever
 
-  @@command = nil
-
-  @@usage = 'license -h|(<subcommand> [<subcommand-options])'
-  @@description = 'Create a new LICENSE file with the chosen license. ' \
-                  'Online licenses are retrieved from https://choosealicense.com/appendix/ . ' \
-                  'Head there for more information about the licences.'
-  @@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 :offline,
-        'Force the application to use the offline licenses.'
-    opt :create_commit,
-        'Create a commit which adds the LICENSE file to the repository history.',
-        short: :none
-    opt :commit_type,
-        'Select the type of the commit. No effect if "--create-commit" is not given.',
-        default: 'chore'
-    educate_on_error
-    stop_on @@subcommands.keys.map(&:to_s)
+  def initialize
+    super() do
+      @usage = 'license -h|(<subcommand> [<subcommand-options])'
+      @description = 'Create a new LICENSE file with the chosen license. ' \
+                     'Online licenses are retrieved from https://choosealicense.com/appendix/ . ' \
+                     'Head there for more information about the licences.'
+      @subcommands = {}
+    end
   end
-  # rubocop:enable Metrics/BlockLength
 
-  def initialize
-    super(@@usage, @@description) do
-      @options = Common.with_subcommand_exception_handling @@option_parser do
-        @@option_parser.parse
+  def create_license_file
+    license_text = ask_for_license(@options[:offline])
+    File.write(File.expand_path(@filename), license_text)
+    puts 'License file created. You may need to modify it with the year and your name.'
+  end
+
+  def create_license_commit
+    CommandIssuer.run('git', 'stash', 'push', '--staged')
+
+    setup_at_exit_hook
+    CommandIssuer.run('git', 'add', "'#{@filename}'").then do |add_result|
+      if add_result.exit_status.zero?
+        CommandIssuer.run(
+          'git',
+          'commit',
+          '-m',
+          "'#{@options[:commit_type]}: add license file'"
+        ).then do |commit_result|
+          if commit_result.exit_status.positive?
+            Common.error 'Failed to create license commit'
+          else
+            puts 'License file committed.'
+          end
+        end
+      else
+        Common.error "Failed to add license file '#{@filename}' to stage."
+      end
+    end
+  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 :offline,
+          'Force the application to use the offline licenses.'
+      opt :create_commit,
+          'Create a commit which adds the LICENSE file to the repository history.',
+          short: :none
+      opt :commit_type,
+          'Select the type of the commit. No effect if "--create-commit" is not given.',
+          default: 'chore'
+      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
 
       @filename = 'LICENSE'
@@ -84,24 +110,20 @@ class License < Command
 
         create_license_commit
       end
+    rescue Interrupt
+      Common.print_then_do_and_exit "\nLicense creation cancelled"
     end
   end
 
-  def create_license_file
-    license_text = ask_for_license(@options[:offline])
-    File.write(File.expand_path(@filename), license_text)
-    puts 'License file created. You may need to modify it with the year and your name.'
-  end
-
-  def create_license_commit
-    `git stash push --staged`
+  private
 
+  def setup_at_exit_hook
     # This block is given to at_exit to execute it in any case.
-    at_exit { `[ "$(git stash list | wc -l)" -gt "0" ] && git stash pop > /dev/null` }
-    `git add "#{@filename}" && git commit -m "chore: add license file"`
-    Common.error 'Failed to create license commit' if $CHILD_STATUS.exitstatus.positive?
-
-    puts 'License file committed.'
+    at_exit do
+      if CommandIssuer.run('git', 'stash', 'list').output.lines.length.positive?
+        CommandIssuer.run('git', 'stash', 'pop')
+      end
+    end
   end
 end
 # rubocop:enable Metrics/ClassLength

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

@@ -18,6 +18,7 @@
 # frozen_string_literal: true
 
 require 'highline'
+require_relative '../../commons/http_client'
 
 # The retrieving module for licenses. It can gather licenses online (from https://choosealicense.com/appendix/)
 # or offline (from a predefined subset of licenses).
@@ -25,24 +26,25 @@ module Retriever
   BASE_OFFLINE_LICENSE_PATH = "#{File.dirname(File.expand_path(__FILE__))}/offline_licenses".freeze
   BASE_ONLINE_LICENSE_URI = 'https://choosealicense.com'
 
-  @@cli = HighLine.new
+  Common.module_instance_value(self, 'cli', 'HighLine.new')
+  Common.add_module_self_reference(self)
 
   def ask_for_license(offline)
-    @@offline = offline
-    list = if @@offline
+    @offline = offline
+    list = if @offline
              offline_license_list
            else
              online_license_list
            end
 
-    @@cli.puts 'Choose which license you want to use:'
-    choice = @@cli.choose do |menu|
+    MOD_REF.cli.puts 'Choose which license you want to use:'
+    choice = MOD_REF.cli.choose do |menu|
       menu.flow = :column_down
       menu.prompt = ''
       list.each { |element| menu.choice(element) }
     end
 
-    if @@offline
+    if @offline
       offline_license_text(choice)
     else
       online_license_text(choice)
@@ -56,18 +58,25 @@ module Retriever
   end
 
   def online_license_list
-    @@online_licenses = {}
-    text = `curl -fsL "#{BASE_ONLINE_LICENSE_URI}/appendix/" | grep '<th scope="row">'`.strip
-    if $CHILD_STATUS.exitstatus.positive?
-      puts 'WARNING: Unable to retrieve list of online licenses, falling back to offline ones.'
-      @@offline = true
-      offline_license_list
-    else
-      text.split("\n").each do |element|
+    @online_licenses = {}
+    response = HTTPClient.instance.http_get_request("#{BASE_ONLINE_LICENSE_URI}/appendix/")
+    if response.is_a?(Net::HTTPSuccess)
+      response.body
+              .strip
+              .lines
+              .select { |line| line.include?('<th scope="row">') }
+              .each do |element|
         match_result = element.match(%r{<a href="(.*)">(.*)</a>})
-        @@online_licenses[match_result[2]] = match_result[1]
+        @online_licenses[match_result[2]] = match_result[1]
       end
-      @@online_licenses.keys
+      @online_licenses.keys
+    else
+      warning_message = 'WARNING: Unable to retrieve list of online licenses ' \
+                        "(cause: #{HTTPClient.instance.response_error_message(response)}), " \
+                        'falling back to offline ones.'
+      puts warning_message
+      @offline = true
+      offline_license_list
     end
   end
 
@@ -76,12 +85,18 @@ module Retriever
   end
 
   def online_license_text(license)
-    page = `curl -fsL "#{BASE_ONLINE_LICENSE_URI}#{@@online_licenses[license]}"`
-    Common.error 'Failed to retrieve the license text.' if $CHILD_STATUS.exitstatus.positive?
-
-    match_result = page.match(%r{<pre id="license-text">(.*)</pre>}m)
-    Common.error 'Invalid license text' if match_result[1].nil?
-
-    match_result[1]
+    response = HTTPClient.instance.http_get_request("#{BASE_ONLINE_LICENSE_URI}#{@online_licenses[license]}")
+    if response.is_a?(Net::HTTPSuccess)
+      match_result = response.body.match(%r{<pre id="license-text">(.*)</pre>}m)
+      if match_result[1].nil?
+        Common.error 'Invalid license text'
+      else
+        match_result[1]
+      end
+    else
+      error_message = 'Failed to retrieve the license text ' \
+                      "(cause: #{HTTPClient.instance.response_error_message(response)})."
+      Common.error error_message
+    end
   end
 end