flex_args 0.0.1 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e93a15e8addb2cefcdcda7b58faf9cceb148e5775a57f0e21cceb3dd90734260
-  data.tar.gz: 68a45e49acfd7d0f99033140fba26352db551c7e4f9b161c64e9fe231de0b695
+  metadata.gz: c8116ea5ced17c3ede88f189de179d0c79cad45852e04df7ad315e58a36c9604
+  data.tar.gz: 939170153910604499bed507c48bfe3f6d44c0b7909bf716b79471da6e18eb51
 SHA512:
-  metadata.gz: a46f39dd0565e37fb17c52efc6b7e15acd1e10f197574aa779111f48da19142984faf53867b22354193670514a366cd278135021769ac7985dad325ef910f8ca
-  data.tar.gz: 59e4cf51aa46e4119fe7de1cb01639e5cdd12cf911f16a9f473a2a465798543e6ea80178aeaea9cb61fb925bdbc639a2da4732c9bec794e90de26039ce1d3487
+  metadata.gz: be410b8d094de0e4070a7a0fe4b6a49117fb60fb6904f17a488878c0374a4e1556280d5ab1ed3d7c917732e0b85c2d077359a94b6842a29bed5ca49c7a1be3e1
+  data.tar.gz: 93dec0a974b675939584a223eb9e4a551208f942df45bf71bd577f17aa0f6496af27b6a7c381b5cf1cc94958508722cbbddb1570622c9d7fbec6bec1d3842643

data/lib/flex_args/version.rb

@@ -2,8 +2,7 @@
 
 class FlexArgs
   module Version
-    VERSION="0.0.1"
-    
+    VERSION="0.1.1"
   end
 end
 # SPDX-License-Identifier: AGPL-3.0-or-later

data/lib/flex_args.rb

@@ -31,7 +31,7 @@ require 'ostruct'
 # ```spec # Flags and positionals
 #   args = parse(%w[hello --verbose -world 42])
 #   expect(args.positionals).to eq(%w[hello 42])
-#   expect(args.flags).to eq(Set.new(["verbose", "w", "o", "r", "l", "d"]))
+#   expect(args.flags).to eq(Set.new(%i[verbose w o r l d]))
 # ```
 # ### Value arguments
 #
@@ -52,7 +52,7 @@ require 'ostruct'
 #   parsed = parse(input)
 #   expect(parsed.positionals).to eq(["a/b.rb"])
 #   expect(parsed.values).to eq(range: -2..3, offset: 3)
-#   expect(parsed.flags).to eq(Set.new(["V"]))
+#   expect(parsed.flags).to eq(Set.new([:V]))
 # ```
 #
 # #### Lists
@@ -67,6 +67,33 @@ require 'ostruct'
 #   parse(%w[escaped:1,a,,b,c]).values => {escaped: [1, "a,b", "c"]}
 # ```
 #
+# #### Multiple Values
+#
+# This is an _alternative_ way to get a list of values
+#
+# ```spec # Multiple Values => Lists
+#   parse(%w[list:1 list:2 hello list:3]).values => {list: [1, 2, 3]}
+# ```
+#
+# ### Advanced Features
+#
+# More advanced features are set with methods on the the instance
+# before invoking `parse`.
+#
+# These features are
+#
+#   - Aliased flags
+#   - Defaults
+#   - Constraints
+#      - allowed
+#      - required
+#      - domain checks
+#      - format checks
+#   - Custom Transformations
+#   - Semantic Checks (v0.2)
+#
+# and they are documented in the rdocs of the corresponding methods
+#
 class FlexArgs
 
   ESCAPED_COMMA = "a4ey8NGnXIVhsV" 
@@ -76,24 +103,58 @@ class FlexArgs
   SINGLE_FLAG = %r{\A -- (.*) \z}x
   VALUE = %r{\A ([[:alpha:]][[:alnum:]_]+) : (.*) \z}x
 
-  attr_reader :args, :flags, :positionals, :result, :values
+  attr_reader :alias_definitions, :flags, :positionals, :result, :values
 
-  def parse
+  def parse(args)
+    init_values
     args.each { parse_arg it }
     result
   end
 
+  ##
+  #
+  # ## Aliases are defined by passing a hash
+  #
+  # The key of the hash is the alias and it will be defined as an alias
+  # to the value of the hash for **each** grapheme of the key, here is
+  # how that works
+  #
+  # ```spec # Aliases
+  #   parser = FlexArgs
+  #     .new
+  #     .aliases(hu: :help, v: :version)
+  #
+  #   expect(parser.parse(%w[-uv]).flags).to eq(Set.new(%i[help version]))
+  #   expect(parser.parse(%w[-h]).flags).to eq(Set.new(%i[help]))
+  # ```
+  #
+  def aliases(alias_definitions)
+    alias_definitions
+      .each do |key, value|
+        key.to_s.grapheme_clusters.each { define_alias it, value }
+      end
+    self
+  end
+
   private
-  def initialize(args)
-    @args = args
-    @positionals = []
-    @flags = Set.new
-    @values = Hash.new
+  def initialize
+    @alias_definitions = Hash.new
+    init_values
+  end
+
+  def add_flags(shorts)
+    shorts.each do
+      flag = alias_definitions.fetch(it, it)
+      flags << flag.to_sym
+    end
   end
 
   def add_value(matches)
     matches => [key, value]
-    values.update(key.to_sym => cast_all(value))
+    values
+      .update(key.to_sym => cast_all(value)) do |k, o, n|
+        Array(o) << n
+      end
   end
 
   def cast(value)
@@ -116,13 +177,24 @@ class FlexArgs
     values.one? ? values.first : values
   end
 
+  def define_alias(short, long)
+    alias_definitions.update(short => long)
+  end
+
+  def init_values
+    @positionals = []
+    @flags = Set.new
+    @values = Hash.new
+  end
+
+
   def parse_arg(arg)
     # require "debug"; binding.break
     case arg
     when SINGLE_FLAG
-      flags << Regexp.last_match[1]
+      flags << Regexp.last_match[1].to_sym
     when MANY_FLAGS
-      @flags += Regexp.last_match[1].grapheme_clusters
+      add_flags(Regexp.last_match[1].grapheme_clusters)
     when VALUE
       add_value(Regexp.last_match)
     else

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: flex_args
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.1.1
 platform: ruby
 authors:
 - Robert Dober