git_toolbox 0.6.0 → 0.7.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 15a670824481b1eacf235aeb9fefced3bc5f6febb2674ff11d272013aad665d5
-  data.tar.gz: 54be78886d9fa0ec1a2650cbcfbcc6028c7cc0b2f54f85398aa8649d2061d22b
+  metadata.gz: a9a83558777ee286d804e64a714388d13b4ac16e15e724580f7957ea422ba8a2
+  data.tar.gz: 8e76c6784c12e03f9cab918099a219e5e823441b90356c68b4cabc8e0bcf13fe
 SHA512:
-  metadata.gz: 3ac823eedff5a76c6808ff2615a2a1f1fce8ed1508a868e0f73fdb66616ac23dc2344412d842c775700850a2290d075a495a304beea99ceccc0e74236102d52b
-  data.tar.gz: bd690477114dbf9ccf127ebb89531ca8204ccca483a2fe2fa87a97ff841cac9ae99dbd78b6793f46b68a3bd384de5b51e7baec1b3ed7a54d14c7f67fffc4fc90
+  metadata.gz: 89d357ca5cf79577e6a05e3d5aff6dccb227c593565d8c5fe7d634d7a76b2cbe568a3c3db6cc49c58d0edfe4418d5da99f39fb1c944dfd14e2267dcb35d3a5bf
+  data.tar.gz: d5a06e808f81790b745ddf2ca031d6ca9c318e13c563aa78262488ec32ab8b98fca0b5d089b5f97b1ae321e76ca3825cd4018248b791490f85fb4c78dfaf1080

data/lib/get/commons/git.rb

@@ -23,7 +23,7 @@ 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+)\))?(!)?:(.*)/
+  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.

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

@@ -77,10 +77,10 @@ class Commit < Command
 
   def initialize
     super(@@usage, @@description) do
-      Common.error 'commit 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
+      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

@@ -65,7 +65,7 @@ module PromptHandler
     extract_types_and_scopes
     @@cli.choose do |menu|
       menu.flow = :columns_down
-      menu.prompt = 'Choose the scope of your commit '
+      menu.prompt = 'Choose the scope of your commit: '
       @@custom_scopes.each do |scope|
         menu.choice(scope.to_sym)
       end

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

@@ -112,10 +112,10 @@ class Describe < Command
 
   def initialize
     super(@@usage, @@description) do
-      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
+      Common.error 'describe need to be run inside a git repository' unless Git.in_repo?
       set_options
 
       if ARGV.length.positive?

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.6.0'
+  VERSION = '0.7.1'
 end

data/lib/get.rb

@@ -25,6 +25,7 @@ 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/commons/common'
 
@@ -39,6 +40,7 @@ module Get
     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.6.0
+  version: 0.7.1
 platform: ruby
 authors:
 - Alex Speranza
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-03-20 00:00:00.000000000 Z
+date: 2023-05-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: optimist
@@ -76,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: