l43_xargs 0.1.1 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 37bb58827f148aba9c53fabe6b29ae7d0afb7b702999648ce2bc86fb618c83ba
-  data.tar.gz: 9639a86b754956cbd686fbf5610016698b6a2037e1f2b8f17c0f376760e18442
+  metadata.gz: 9ee664c6727ca6b0f9a4bc2b3ec2d4a8607ae71d4733ef95dc591de462fee198
+  data.tar.gz: a72496383d24e1e5435dab35ad246fd3deb28f9e945f48b220e98a764905e39d
 SHA512:
-  metadata.gz: df5ff18d8604c824844d5485433c9a720f0bfa19c76a5dc901b0bc9475e34cdc2ddc2e6d08bf342b3a9a7c142dbe1846176d93a68f5ca955b17959c88d4c1f79
-  data.tar.gz: 116c6b060e272737b05d753c8ba5a244ade111bba263e1786fba0bf40a2793cbb2a4e5d478f379a2abb79b2a8d652b50b0176d157a36efed18429eb55a2461f6
+  metadata.gz: 01b48f90ba983ded2cd83df68a612bd69cf5001952bc7e1ff1e8553d3b4114a3276a12a13e326e369051ff4bff6925d0251864390ade9260c26128e9101de0fd
+  data.tar.gz: 3da5ad22c49ef316c735d52278aa2630b31a7b0c6e0f097ee981d656ff9e0ebdaee475b781603dbf06cf704e8d5964d991aea5414ee16fcda0202d5d03bb25b3

data/lib/l43/xargs/defined_args.rb

@@ -23,6 +23,15 @@ module L43
         # p(defined_kwds: _defined_kwds)
       end
 
+      def def_flag_alias(alias_name, flag_name)
+        case _check_for_duplicate(alias_name)
+        in nil
+          _add_flag_alias(alias_name, flag_name)
+        in data_name
+          raise DuplicateDefinition, "flag alias #{alias_name.inspect} fails as it is already used in #{data_name}"
+        end
+      end
+
       def def_kwd(name, short=nil, desc:, default: None, &blk)
         kwd = Keyword.new(name, short, desc:, default:, &blk)
         _def_short_kwd(short, kwd) if short
@@ -30,13 +39,22 @@ module L43
         # p(defined_kwds: _defined_kwds, defined_flags: _defined_flags)
       end
 
+      def def_kwd_alias(alias_name, kwd_name)
+        case _check_for_duplicate(alias_name)
+        in nil
+          _add_kwd_alias(alias_name, kwd_name)
+        in data_name
+          raise DuplicateDefinition, "keyword alias #{alias_name.inspect} fails as it is already used in #{data_name}"
+        end
+      end
+
       def get_element(name, &blk)
         _defined_flags[name] ||
           _defined_kwds.fetch(name, &blk)
       end
 
       def get_flag(long)
-        _defined_flags[long]
+        _defined_flags[long] || _flag_aliases[long]
       end
 
       def get_flags(&blk)
@@ -44,7 +62,7 @@ module L43
       end
 
       def get_kwd(long)
-        _defined_kwds[long]
+        _defined_kwds[long] || _kwd_aliases[long]
       end
 
       def get_kwds(&blk)
@@ -63,13 +81,6 @@ module L43
         _defined_short_kwds[short]
       end
 
-      def print_help(indent: 1, newline: true, program_name: nil, sections: true, section_colors: [:bold, :green], usage: false, device: $stderr)
-        lines = help_description(indent:, newline:, program_name:, usage:, sections:, section_colors:)
-        lines.each do |line|
-          Output.putc(line, device:, indent:, colorize: @_colorize)
-        end
-      end
-
       def args = @__args__ ||= []
 
       def kwds =  @__kwds__ ||= OpenStruct.new 
@@ -79,6 +90,35 @@ module L43
         @_colorize = colorize
       end
 
+      def _add_flag_alias(alias_name, flag_name)
+        flag = _defined_flags.fetch(flag_name) do
+          raise BadDefinition, "flag alias from #{alias_name.inspect} to #{flag_name.inspect} fails as the destination is not a defined flag"
+        end
+        _flag_aliases.update(alias_name => flag)
+        flag.add_alias(alias_name)
+      end
+
+      def _add_kwd_alias(alias_name, kwd_name)
+        kwd = _defined_kwds.fetch(kwd_name) do
+          raise BadDefinition, "keyword alias from #{alias_name.inspect} to #{kwd_name.inspect} fails as the destination is not a defined keyword"
+        end
+        _kwd_aliases.update(alias_name => kwd)
+        kwd.add_alias(alias_name)
+      end
+
+      def _check_for_duplicate(name)
+        [[_defined_flags, "defined flags"],
+         [_defined_kwds, "defined keywords"],
+         [_defined_short_flags, "defined short flags"],
+         [_defined_short_kwds, "defined short keywords"],
+         [_flag_aliases, "defined flag aliases"],
+         [_kwd_aliases, "defined keyword aliases"],
+        ].each do |data, data_name|
+          return data_name if data[name]
+        end
+        nil
+      end
+
       def _colorize? = @_colorize
 
       def _def_flag(name, flag)
@@ -108,6 +148,10 @@ module L43
       def _defined_short_flags =  @__defined_short_flags__ ||= OpenStruct.new
 
       def _defined_short_kwds =  @__defined_short_kwds__ ||= OpenStruct.new
+
+      def _flag_aliases =  @___flag_aliases__ ||= Hash.new
+
+      def _kwd_aliases =  @___kwd_aliases__ ||= Hash.new
     end
   end
 end

data/lib/l43/xargs/descriptions.rb

@@ -3,7 +3,7 @@
 module L43
   class Xargs
     module Descriptions
-      def help_description(indent: 1, newline: true, program_name: nil, sections: true, section_colors: [:bold, :green], usage: false)
+      def help_description(lines = [],indent: 1, newline: true, program_name: nil, sections: true, section_colors: [:bold, :green], usage: false)
         flag_section =_section("Flags", indent:, newline:, sections:, section_colors:) unless _defined_flags.empty?
         kwd_section = _section("Keywords", indent:, newline:, sections:, section_colors:) unless _defined_kwds.empty?
         usage_section = [:bold, "usage: ", *_maybe_program_name(program_name), *_options(usage)] if usage
@@ -14,7 +14,14 @@ module L43
           *_flag_descriptions,
           kwd_section,
           *_kwd_descriptions,
-        ].compact
+        ].compact + lines.map { [*it, :reset] }
+      end
+
+      def print_help(lines=[], indent: 1, newline: true, program_name: nil, sections: true, section_colors: [:bold, :green], usage: false, device: $stderr)
+        lines = help_description(lines, indent:, newline:, program_name:, usage:, sections:, section_colors:)
+        lines.each do |line|
+          Output.putc(line, device:, indent:, colorize: @_colorize)
+        end
       end
 
       private

data/lib/l43/xargs/elements/common.rb

@@ -0,0 +1,41 @@
+# frozen_string_literal: true
+
+module L43
+  class Xargs
+
+    module Elements
+      module Common
+        attr_reader :additional_desc, :aliases,
+          :desc,
+          :name,
+          :short,
+          :value
+
+        def add_desc(desc)
+          @additional_desc << desc
+        end
+
+        def add_alias(alias_name) = aliases << alias_name
+
+        private
+
+        def _all_names(element_type)
+          case element_type
+          when :kwd
+            _get_all_names.map { "#{it}:" }.join("|")
+          when :flag
+            _get_all_names.map { ":#{it}" }.join("|")
+          else
+            raise ArgumentError, "element type was #{element_type.inspect} but only :flag and :kwd are supported"
+          end
+        end
+
+        def _get_all_names = [short, name, *aliases].compact
+
+        def aliases =  @__aliases__ ||= []
+
+      end
+    end
+  end
+end
+# SPDX-License-Identifier: AGPL-3.0-or-later

data/lib/l43/xargs/flag.rb

@@ -1,21 +1,17 @@
 # frozen_string_literal: true
 
+require_relative 'elements/common'
 module L43
   class Xargs
     class Flag
+      include Elements::Common
+
       attr_reader \
-        :additional_desc,
-        :desc,
-        :error,
-        :name,
-        :short,
-        :value
-
-      def add_desc(desc)
-        @additional_desc << desc
-      end
+        :error
 
       def defaulted = !value
+      
+      def description_name = _all_names(:flag)
 
       def error? = !!@error
 
@@ -29,9 +25,7 @@ module L43
       end
 
       def name_description(colors: :cyan)
-        formatted_name = ":#{name} "
-        formatted_name = ":#{short}|#{formatted_name}" if short
-        [*Array(colors), formatted_name, :reset] 
+        [*Array(colors), _all_names(:flag) + " ", :reset] 
       end
 
       def set_error!(error) = @error = error
@@ -49,6 +43,7 @@ module L43
         @short = short
         @value = false
       end
+
     end
   end
 end

data/lib/l43/xargs/keyword.rb

@@ -1,29 +1,22 @@
 # frozen_string_literal: true
 
+require_relative 'elements/common'
 module L43
   class Xargs
     class Keyword
+      include Elements::Common
+
       CallbackError = Class.new(RuntimeError)
 
       attr_reader \
-        :additional_desc,
         :callback,
-        :default, :defaulted, :desc,
-        :name,
-        :short,
-        :value
+        :default, :defaulted
 
-      def add_desc(desc)
-        @additional_desc << desc
-      end
-
-      def description_name
-        prefix = short ? "#{short}:|" : ""
-        "#{prefix}#{name}:"
-      end
 
       def default? =  @__default_p__ ||= default != None
 
+      def description_name = _all_names(:kwd)
+
       def full_description(indent: 3, colors: :cyan, important: :bold, default_colors: :dim)
         [
           [
@@ -34,9 +27,7 @@ module L43
       end
 
       def name_description(colors: :cyan)
-        formatted_name = "#{name}: "
-        formatted_name = "#{short}:|#{formatted_name}" if short
-        [*Array(colors), formatted_name, :bold, :blue, "<value> ", :reset] 
+        [*Array(colors), _all_names(:kwd) + " ", :bold, :blue, "<value> ", :reset] 
       end
 
       def required? = default == None

data/lib/l43/xargs/parse.rb

@@ -23,7 +23,7 @@ module L43
         if flag_def
           _check_multiple_occurence(flag_def, name: flag_def.name)
           flag_def.set_true!
-          _kwds.set!(flag, flag_def)
+          _kwds.set!(flag_def.name, flag_def)
         else
           _kwds.set!(flag, AnonFlag.new(flag))
         end

data/lib/l43/xargs/version.rb

@@ -2,7 +2,7 @@
 
 module L43
   class Xargs
-    VERSION = "0.1.1"
+    VERSION = "0.1.2"
   end
 end
 # SPDX-License-Identifier: AGPL-3.0-or-later

data/lib/l43/xargs.rb

@@ -33,6 +33,7 @@ module L43
 
     attr_reader :argv, :autohelp, :defined_args, :last_added, :program_name, :usage
 
+    # extend Core::Forwarder
     def add_desc(*desc, indent: nil, name: nil)
       if name
         element = defined_args.get_element(name) do
@@ -55,6 +56,20 @@ module L43
       self
     end
 
+    def def_alias(name, for_kwd: nil, for_flag: nil)
+      case [for_kwd, for_flag]
+      in nil, nil
+        raise ArgumentError, "exactly one of the two keyword arguments for_kwd:, for_flag: has to be set, none was"
+      in nil, _
+        defined_args.def_flag_alias(name, for_flag)
+      in _, nil
+        defined_args.def_kwd_alias(name, for_kwd)
+      else
+        raise ArgumentError, "exactly one of the two keyword arguments for_kwd:, for_flag: has to be set, both were"
+      end
+      self
+    end
+
     def def_check(name=nil, desc:, &blk)
       checks << Check.new(name:, desc:, &blk)
       self
@@ -72,8 +87,8 @@ module L43
 
     def errors = result.errors
 
-    def help_description(indent: 1, newline: true, sections: true, section_colors: [:bold, :green])
-      defined_args.help_description(indent:, newline:, program_name:, sections:, section_colors:, usage:)
+    def help_description(lines=[], indent: 1, newline: true, sections: true, section_colors: [:bold, :green])
+      defined_args.help_description(lines, indent:, newline:, program_name:, sections:, section_colors:, usage:)
     end
 
     def forward_to_kwds!(subject, *args, private: true, without: [])
@@ -106,8 +121,8 @@ module L43
       end
     end
 
-    def print_help(indent: 1, newline: true, program_name: nil, sections: true, section_colors: [:bold, :green], usage: false, device: $stderr)
-     defined_args.print_help(indent:, newline:, program_name:, sections:, section_colors:, usage:, device:)
+    def print_help(lines=[], indent: 1, newline: true, program_name: nil, sections: true, section_colors: [:bold, :green], usage: false, device: $stderr)
+     defined_args.print_help(lines, indent:, newline:, program_name:, sections:, section_colors:, usage:, device:)
     end
 
     def result 

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: l43_xargs
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.2
 platform: ruby
 authors:
 - Robert Dober
 bindir: bin
 cert_chain: []
-date: 2026-09-04 00:00:00.000000000 Z
+date: 2026-09-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: ostruct
@@ -67,6 +67,7 @@ files:
 - lib/l43/xargs/deconstruct.rb
 - lib/l43/xargs/defined_args.rb
 - lib/l43/xargs/descriptions.rb
+- lib/l43/xargs/elements/common.rb
 - lib/l43/xargs/flag.rb
 - lib/l43/xargs/forwarder.rb
 - lib/l43/xargs/keyword.rb