git_toolbox 0.7.2 → 0.9.0

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

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

@@ -17,64 +17,44 @@
 
 # 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 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
+    super() do
+      @usage = 'tree -h|(<subcommand> [<subcommand-options])'
+      @description = 'Print the tree of commits. ' \
+                     'If the output is redirected to a pager (i.e. \'less\'), ' \
+                     'you may need to enable the parsing of escape sequences.'
+      @subcommands = {}
     end
   end
 
   def view_tree
-    page_log(transform_log(log))
+    puts 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}"`
+    CommandIssuer.run(
+      'git',
+      'log',
+      '--all',
+      '--graph',
+      '--decorate=short',
+      '--date-order',
+      '--color',
+      "--pretty=format:\"#{TREE_FORMAT}\""
+    ).output
   end
 
   TIME_REGEX = /(\([a-z0-9 ,]+\))/
@@ -90,21 +70,18 @@ class Tree < Command
     # 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 }
+    time_padding = global_fitting_time_padding(split_lines, time_color_length)
 
-    # 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)
+          (!element[1].nil? && 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),
+            date: (element[1].nil? ? '' : element[1]).rjust(left_padding),
             tree_mark: element[0],
             pointers: element[2],
             commit_text: element[3]
@@ -115,8 +92,40 @@ class Tree < Command
   end
   # rubocop:enable Metrics/MethodLength
 
-  def page_log(text)
-    system("less -RfS <(echo -e '#{text}')")
+  def global_fitting_time_padding(lines, time_color_length)
+    time_padding = 0
+    lines
+      # If element[1].nil? then the line refers to a intersection between branch lines
+      # they do not have a time reference
+      .reject { |element| element[1].nil? }
+      .each { |element| time_padding = [time_padding, element[1].length - time_color_length].max }
+    time_padding
+  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
+      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 'tree need to be run inside a git repository' unless Git.in_repo?
+
+      view_tree
+    end
   end
 end
 # rubocop:enable Metrics/ClassLength

data/lib/get/version.rb

@@ -17,6 +17,4 @@
 
 # frozen_string_literal: true
 
-module Get
-  VERSION = '0.7.2'
-end
+GET_VERSION = '0.9.0'

data/lib/get.rb

@@ -28,48 +28,61 @@ require 'get/subcommand/changelog/changelog'
 require 'get/subcommand/tree/tree'
 require 'get/version'
 require 'get/commons/common'
+require 'get/subcommand/command'
 
-# Entrypoint of Get
-module Get
+# Main command of Get.
+class Get < Command
   class Error < StandardError; end
 
-  @@subcommands = {
-    describe: Describe.command,
-    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
-    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)
+  def initialize
+    super() do
+      @usage = '-h|-v|(<subcommand> [<subcommand-options])'
+      @description = ''
+      @subcommands = {
+        describe: Describe.instance,
+        commit: Commit.instance,
+        init: Init.instance,
+        license: License.instance,
+        complete: Complete.instance,
+        changelog: Changelog.instance,
+        tree: Tree.instance,
+      }
+    end
   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}'"
+  def main
+    @action.call
+  end
+
+  protected
+
+  def setup_option_parser
+    @option_parser = Optimist::Parser.new(
+      @usage,
+      full_description,
+      GET_VERSION,
+      stop_condition
+    ) do |usage_header, description, version, stop_condition|
+      usage usage_header
+      synopsis description
+      version "Get version: #{version}"
+      educate_on_error
+      stop_on stop_condition
     end
   end
 
-  def self.error(message)
-    Common.error message do
-      @@option_parser.educate
+  def setup_action
+    @action = lambda do
+      @options = Optimist.with_standard_exception_handling(@option_parser) do
+        @option_parser.parse
+      end
+      educated_error 'No command or option specified' if ARGV.empty?
+      command = ARGV.shift.to_sym
+      if @subcommands.include?(command)
+        @subcommands[command].action.call
+      else
+        educated_error "Unknown subcommand '#{command}'"
+      end
     end
   end
 end

metadata

@@ -1,49 +1,49 @@
 --- !ruby/object:Gem::Specification
 name: git_toolbox
 version: !ruby/object:Gem::Version
-  version: 0.7.2
+  version: 0.9.0
 platform: ruby
 authors:
 - Alex Speranza
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-06-02 00:00:00.000000000 Z
+date: 2023-07-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: optimist
+  name: highline
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.0'
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 3.0.1
+        version: 2.0.3
   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
+        version: 2.0.3
 - !ruby/object:Gem::Dependency
-  name: highline
+  name: optimist
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.0.3
+        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: 2.0.3
+        version: '3.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.0.1
 description:
 email:
 - alex.speranza@studio.unibo.it
@@ -55,8 +55,10 @@ files:
 - bin/get
 - bin/setup
 - lib/get.rb
+- lib/get/commons/command_issuer.rb
 - lib/get/commons/common.rb
 - lib/get/commons/git.rb
+- lib/get/commons/http_client.rb
 - lib/get/subcommand/changelog/changelog.rb
 - lib/get/subcommand/command.rb
 - lib/get/subcommand/commit/commit.rb
@@ -94,7 +96,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 3.1.0
+      version: 3.0.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="