toolrack 0.22.1 → 0.23.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2bf5660073953ff0e581655963232f58762e39d46ccd1383885958da071d76e6
-  data.tar.gz: 6f94d5fe9de1c054d386639e192a60a0d075c34daf46c477936a4fccb7c52a56
+  metadata.gz: 7829bd272823dbd7bdf754bca5be1287b074486f99a33ee15bd2607cb391a2f5
+  data.tar.gz: ea82bc8cca37d760813fb276e7540df2d80b11624c8e9760d6936cd4c86bf347
 SHA512:
-  metadata.gz: f218994963cbdf44dc154b02ebdf4fa011c0f4f2819ab96143d8e14e383aa8688cf775a3db67896110020157253a33ee419e56a6be2649e76c169813af3ce1c4
-  data.tar.gz: 6acabb8fd0426fde3acaa42b3e1f55c27402480e6dad210ee21ff0f5a9426e07a377b23aeb005da851788a6bec7a1eb057253947d4db2dec76df3121d58c8896
+  metadata.gz: 2dc8a2048cb53ea6d6ed2bacaf3cbd7e2a1c8ea8a725c9657b5dd69fdcb49d9f4b6e3aeea12a36772ba54449d3b4cd47bf5be376d77e1b1fb6091ad5f68261d2
+  data.tar.gz: 1ceb5fd6b3bdd488b1961bff52c7cce4d4e68f31f842f7029f4eeb73452d52c19a20b772d7ed1a8a11fbb6ffc83dd0474943131d304991e905ac87d97e95a2e1

data/Gemfile.lock

@@ -1,12 +1,12 @@
 PATH
   remote: .
   specs:
-    toolrack (0.22.1)
+    toolrack (0.23.2)
 
 GEM
   remote: https://rubygems.org/
   specs:
-    colorize (0.8.1)
+    colorize (1.1.0)
     devops_assist (0.3.11)
       git_cli
       git_cli_prompt (~> 0.3.3)
@@ -15,8 +15,7 @@ GEM
       toolrack
       tty-prompt
     diff-lcs (1.5.0)
-    git_cli (0.11.2)
-      gvcs
+    git_cli (0.12.0)
       ptools (~> 1.4.0)
       teLogger
       toolrack
@@ -24,13 +23,13 @@ GEM
       teLogger
       toolrack
       tty-prompt
-    gvcs (0.1.1)
-    minitest (5.18.0)
+    gvcs (0.1.2)
+    minitest (5.19.0)
     pastel (0.8.0)
       tty-color (~> 0.5)
     ptools (1.4.3)
     rake (12.3.3)
-    release-gem (0.1.12)
+    release-gem (0.1.25)
       colorize
       git_cli
       gvcs
@@ -42,15 +41,15 @@ GEM
       rspec-core (~> 3.12.0)
       rspec-expectations (~> 3.12.0)
       rspec-mocks (~> 3.12.0)
-    rspec-core (3.12.1)
+    rspec-core (3.12.2)
       rspec-support (~> 3.12.0)
-    rspec-expectations (3.12.2)
+    rspec-expectations (3.12.3)
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.12.0)
-    rspec-mocks (3.12.5)
+    rspec-mocks (3.12.6)
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.12.0)
-    rspec-support (3.12.0)
+    rspec-support (3.12.1)
     teLogger (0.2.2)
     tty-color (0.6.0)
     tty-command (0.10.1)

data/lib/toolrack/arg_utils.rb

@@ -0,0 +1,254 @@
+
+
+module Antrapol
+  module ToolRack
+    
+    module ArgUtils
+      include Antrapol::ToolRack::ConditionUtils
+
+      class ArgParsingException < StandardError; end
+      class RequiredFieldEmpty < ArgParsingException; end
+      class DuplicatedField < ArgParsingException; end
+      class InvalidKey < ArgParsingException; end
+     
+      module ClassMethods
+        include Antrapol::ToolRack::ConditionUtils
+       
+        def arg_spec(&block)
+          class_eval(&block) 
+        end
+
+        def opt(key, desc, opts = {}, &block)
+          raise RequiredFieldEmpty, "Key field cannot be empty" if is_empty?(key)
+          raise DuplicatedField, "Given key '#{key}' already exist" if options.keys.include?(key)
+          raise RequiredFieldEmpty, "Block is require" if not block
+
+          options[key] = { key: key, desc: desc, options: opts, callback: block }
+          required << key if opts[:required] == true
+        end
+
+        def opt_alias(existing, new)
+          raise InvalidKey, "Existing key '#{existing}'to map to new key '#{new}' not found" if not options.keys.include?(existing)
+          aliases[new] = existing 
+        end
+
+        def is_all_required_satisfy?(arr)
+          if arr.is_a?(Array)
+            res = true
+            required.each do |f|
+              res = arr.include?(f) 
+              if not res
+                al = aliases.invert[f]
+                res = arr.include?(al)
+                raise RequiredFieldEmpty, "Required parameter '#{f}' is not given" if not res
+              end
+            end
+            res
+
+          else
+            raise ArgParsingException, "Given array to check for required fields is not an array. Got #{arr}"
+            if arr.is_a?(ArgParsingException)
+              STDERR.puts "Error throwing into the method was : #{arr.message}"
+            end
+
+          end
+        end
+
+        def callback(evt, opts = {}, &block)
+          raise ArgParsingException, "Event should not be nil" if evt.nil? 
+          callbacks[evt] = { opts: opts, cb: block }
+        end
+
+        def required
+          if @_req.nil?
+            @_req = []
+          end
+          @_req
+        end
+
+        def options
+          if @_options.nil?
+            @_options = {}
+          end
+          @_options
+        end
+
+        def aliases
+          if @_aliases.nil?
+            @_aliases = {}
+          end
+          @_aliases
+        end
+
+        def callbacks
+          if @_cb.nil?
+            @_cb = {}
+          end
+          @_cb
+        end
+
+        #def value_separator=(val)
+        #  logger.debug "Setting value separator #{val}"
+        #  @_valSep = val
+        #end
+        def set_value_separator(val)
+          @_valSep = val
+        end
+
+        def value_separator
+          if @_valSep.nil?
+            @_valSep = " "
+          end
+          @_valSep
+        end
+
+        def logger
+          Antrapol::ToolRack.logger(:c_arg_utils)
+        end
+
+      end # module ClassMethods
+      def self.included(klass)
+        klass.extend(ClassMethods)
+      end
+
+      def parse_argv(argv, &block)
+        cb = self.class.callbacks[:pre_processing]
+        if not_empty?(cb) and cb[:cb]
+          #logger.debug "Calling pre-processing for class #{self}"
+          @parse_argv_block = block
+          # here will engage the DSL method of the included class
+          update_argv, val = instance_exec(argv, &cb[:cb])
+          #logger.debug "Preprocessing return update flag : #{update_argv} and list #{val} for class #{self}"
+          argv = val if update_argv
+        end
+
+        # split the key and value if given
+        # > app -n:john
+        if self.class.value_separator == " " and argv.length > 0
+          parse_argv_space(argv)
+        else
+          parse_argv_key_value_mixed(argv)
+        end
+
+        cbp = self.class.callbacks[:post_processing]
+        if not_empty?(cbp) and cbp[:cb]
+          #logger.debug "Post processing got #{argv}"
+          instance_exec(argv, &cbp[:cb]) 
+        end
+      end 
+
+      private
+      def parse_argv_space(argv)
+        logger.debug "got argv (space) : #{argv}"
+        cls = self.class
+        clear = cls.is_all_required_satisfy?(argv)
+        logger.debug "All required fields are there? : #{clear}"
+        if clear
+
+          go = true
+          i = 0
+          while i < argv.length
+            a = argv[i]
+            logger.debug "Processing : #{a}"
+
+            key = a
+            conf = cls.options[key]
+            if is_empty?(conf)
+              al = cls.aliases[key]
+              conf = cls.options[al] if not_empty?(al)
+            end
+
+            if is_empty?(conf)
+              logger.warn "Given key to select ('#{key}') has not defined before"
+              # ignore if the given parameter not recognized
+              i += 1
+              next
+            end
+
+            if not conf[:callback].nil? 
+              # expecting parameter
+              paramsCount = conf[:callback].arity
+              if paramsCount > 0
+                # look ahead token to load the parameters
+                val = []
+                (0...paramsCount).each do |ii|
+                  val << argv[i+1+ii]
+                end
+                val.delete_if { |e| e.nil? }
+                logger.debug "Parameter for callback : #{val}"
+                raise RequiredFieldEmpty, "Key '#{a}' requires #{paramsCount} parameter(s) but got #{val.length}" if paramsCount != val.length 
+                instance_exec(*val, &conf[:callback])
+                i += paramsCount+1
+              else
+                instance_eval(&conf[:callback])
+                i += 1
+              end
+
+            else
+              i += 1
+
+            end
+
+          end # argv.each
+
+        end # if all required satisfy
+        
+      end
+
+      def parse_argv_key_value_mixed(argv)
+        logger.debug "got argv : #{argv}"
+        cls = self.class
+        if cls.is_all_required_satisfy?(argv)
+
+          argv.each do |a|
+            logger.debug "Processing : #{a}"
+
+            key = a
+            val = []
+            #p a 
+            #p cls.value_separator
+            #p a =~ /#{cls.value_separator}/
+            if (a =~ /#{cls.value_separator}/) != nil
+              keys = a.split(cls.value_separator)
+              key = keys.first
+              val = keys[1..-1]
+            end
+
+            logger.debug "After separation : #{key}"
+
+            conf = cls.options[key]
+            if is_empty?(conf)
+              al = cls.aliases[key]
+              conf = cls.options[al] if not_empty?(al)
+            end
+
+            if is_empty?(conf)
+              logger.warn "Given key to select ('#{key}') has not defined before"
+              # ignore if the given parameter not recognized
+              next
+            end
+
+            if not conf[:callback].nil? 
+              # expecting parameter
+              paramsCount = conf[:callback].arity
+              if paramsCount > 0
+                raise RequiredFieldEmpty, "Key '#{conf[:key]}' requires #{paramsCount} value(s) to be given but got #{val.length}." if val.length != paramsCount
+                instance_exec(*val, &conf[:callback])
+              else
+                instance_eval(&conf[:callback])
+              end
+            end
+
+          end # argv.each
+
+        end # if all required satisfy
+      end
+
+      def logger
+        Antrapol::ToolRack.logger(:arg_utils) 
+      end
+
+    end
+
+  end
+end

data/lib/toolrack/version.rb

@@ -1,6 +1,6 @@
 module Antrapol
   module ToolRack
-    VERSION = "0.22.1"
+    VERSION = "0.23.2"
   end
 end
 

data/lib/toolrack.rb

@@ -19,11 +19,40 @@ require_relative 'toolrack/version_utils'
 require_relative 'toolrack/file_utils'
 require_relative 'toolrack/block_params_utils'
 require_relative 'toolrack/terminal_utils'
+require_relative 'toolrack/arg_utils'
+
 
 module Antrapol
   module ToolRack
+    include ConditionUtils
+
     class Error < StandardError; end
     # Your code goes here...
+    #
+    def self.logger(tag = nil, &block)
+      if @_logger.nil?
+        @_logger = TeLogger::Tlogger.new
+      end
+
+      if block
+        if not_empty?(tag)
+          @_logger.with_tag(tag, &block)
+        else
+          @_logger.with_tag(@_logger.tag, &block)
+        end
+      else
+        if is_empty?(tag)
+          @_logger.tag = :tr
+          @_logger
+        else
+          # no block but tag is given? hmm
+          @_logger.tag = tag
+          @_logger
+        end
+      end
+
+    end
+
   end
 end
 
@@ -68,3 +97,5 @@ TR::BlockParamsUtils = ToolRack::BlockParamsUtils
 
 TR::TerminalUtils = ToolRack::TerminalUtils
 
+TR::ArgUtils = ToolRack::ArgUtils
+

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: toolrack
 version: !ruby/object:Gem::Version
-  version: 0.22.1
+  version: 0.23.2
 platform: ruby
 authors:
 - Chris
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2023-04-06 00:00:00.000000000 Z
+date: 2023-08-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: devops_assist
@@ -72,6 +72,7 @@ files:
 - bin/console
 - bin/setup
 - lib/toolrack.rb
+- lib/toolrack/arg_utils.rb
 - lib/toolrack/block_params_utils.rb
 - lib/toolrack/cli_utils.rb
 - lib/toolrack/condition_utils.rb
@@ -113,7 +114,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.10
+rubygems_version: 3.4.18
 signing_key: 
 specification_version: 4
 summary: Collection of simple utilities but I find it increase clarity