flex_args 0.1.2 → 0.1.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5700aa1d881f51e7f2f44d30075e68367202e010ec71779193042f7efea70d95
-  data.tar.gz: aa46d04734fed4cf7776c3fe0c18c8fad391f5dc66a446c4fc664b8284deec79
+  metadata.gz: 4e573bedff931ba6d00a805a59c72c1501b454ce2de48efd1787d4e9d3582541
+  data.tar.gz: a33de0609ca8726513b5576f9ce5b9dec7c6ae7a0d9438d3151ce2e03a87c0c3
 SHA512:
-  metadata.gz: bc38f0a24e8d3589adacadabfeac2e1dfa7ce84ec2bd7b9def3fa6d2ef5bc2159ac1856136da273ea8a0f34c072ecfbb7008925544f9c27dec93edbf37206791
-  data.tar.gz: c349ad91b2f10bb6b463d88388cd34c7f48fba0c736de18754545b88f6aa0f02f5ec60e39ea685537046cf6629bae9188b12531935a98f2bd7db37b8902223da
+  metadata.gz: e6a44342146b8d223a593a2982f2930bec00db7c93ee8f604ddfa10fd0380562d0ce8577bd636e8fe54082acaf49a39627e4c1dd969898a79c363e911bcf968b
+  data.tar.gz: 45955b80f48f89a16d0b64caf3fbb6a14fbbf0e39fb84e625a7201678bd656d246c73c6d6bb86930e4b8e8a3d5bd9ab5fa927ea4489723674cc69f19448bcca5

data/.rdoc_options

@@ -8,7 +8,7 @@ autolink_excluded_words: []
 charset: UTF-8
 class_module_path_prefix:
 embed_mixins: false
-exclude: [tmp/*]
+exclude: [tmp/*,coverage/*]
 file_path_prefix:
 hyperlink_all: false
 line_numbers: false

data/README.md

@@ -1,3 +1,3 @@
 # flex_args
 
-Flexible Argument Parse
+Flexible Argument Parser

data/lib/flex_args/constraint.rb

@@ -31,8 +31,44 @@ class FlexArgs
     #     new(:for_some_int, 1..9).("1") => [:ok, 1]
     #     new(:for_some_int, 1..9).("0") => [:error, "range constraint for_some_int: 1..9 violated by value \"0\""]
     #     new(:for_some_int, 1..9).("y") => [:error, "range constraint for_some_int: 1..9 violated by value \"y\""]
+    #
+    #     new(:for_string, "a".."c").("a") => [:ok, "a"]
+    #     new(:for_string, "a".."c").("d") => [:error, 'member constraint for_string: "a".."c" violated by value "d"']
     #     
     # ```
+    #
+    # **N.B.** that ranges not of type integer are treated as `Member` contraints below.
+    #
+    # ### `Member` constraint
+    #
+    # While the `Range` constraint above does int type casting if needed, the `Member` constraint cannot do
+    # that, because it cannot access the type of the container against which membership will be tested.
+    #
+    # `Member` constraints can be triggered by providing a `Set`, `Array` or `Hash` second parameter 
+    #
+    # ```spec # Various membership rdoc specs
+    #     vowels = %w[a e i o u y]
+    #     hashy = Hash[vowels.product([true])]
+    #     set = Set.new(vowels)
+    #     in_array = new(:in_array, vowels)
+    #     in_set   = new(:in_set, set)
+    #     in_hash  = new(:in_hash, hashy)
+    #
+    #     expect(in_array.("a")).to eq([:ok, "a"])
+    #     expect(in_array.("y")).to eq([:ok, "y"])
+    #     expect(in_set.("y")).to eq([:ok, "y"])
+    #     expect(in_hash.("o")).to eq([:ok, "o"])
+    #
+    #     expect(in_array.("b"))
+    #       .to eq([:error, "member constraint in_array: #{vowels.inspect} violated by value \"b\""])
+    #
+    #     expect(in_hash.("ec"))
+    #       .to eq([:error, "member constraint in_hash: #{hashy.inspect} violated by value \"ec\""])
+    #
+    #     expect(in_set.("aa"))
+    #       .to eq([:error, "member constraint in_set: #{set.inspect} violated by value \"aa\""])
+    # ```
+    #
     # ### Custom constraint
     #
     # This is easily implemented by passing a block which will return a pair as described above, but also note
@@ -71,6 +107,12 @@ class FlexArgs
         _init_regexp(name, constraint)
       in [Range => range]
         _init_range(name, range)
+      in [Array | Hash | Set => container]
+        _init_membership(name, container, false)
+      in [Array | Hash | Set => container, :autocast]
+        _init_membership(name, container, true)
+      in [:member, container]
+        _init_membership(name, container)
       else
         raise ArgumentError,
           "illegal constraint spec #{constraints.inspect} for value #{name}" unless block
@@ -102,7 +144,36 @@ class FlexArgs
       end
     end
 
+    def _init_membership(name, container, autocast)
+      @constrainer = -> value do
+        if container.member?(value) 
+          [:ok, value]
+        elsif autocast
+          case _to_int(value)
+          in [:ok, int_val]
+            if container.member(int_val)
+              [:ok, int_val]
+            else
+              _make_error(:member, name, container.inspect, int_value)
+            end
+          else
+            _make_error(:member, name, container.inspect, value)
+          end
+        else
+          _make_error(:member, name, container.inspect, value)
+        end
+      end
+    end
+
     def _init_range(name, range)
+      if Integer === range.first
+        _init_int_range(name, range)
+      else
+        _init_membership(name, range, false)
+      end
+    end
+
+    def _init_int_range(name, range)
       @constrainer = -> value do
         case _to_int(value)
         in [:ok, int_val]

data/lib/flex_args/transform.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+class FlexArgs
+  class Transform
+
+    def call(value) = [:ok, @transformer.(value)]
+
+    private
+    def initialize(*transformers, &transformer)
+      case transformers
+      in [_]
+        raise ArgumentError, "NOT YET IMPLEMENTED"
+      else
+        _init_transformer(&transformer)
+      end 
+    end
+
+    def _init_transformer(&transformer)
+      @transformer = transformer
+    end
+  end
+end
+# SPDX-License-Identifier: AGPL-3.0-or-later

data/lib/flex_args/version.rb

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

data/lib/flex_args.rb

@@ -3,6 +3,7 @@
 require 'ostruct'
 require_relative 'flex_args/constraint'
 require_relative 'flex_args/parser'
+require_relative 'flex_args/transform'
 
 ##
 # ## Abstract
@@ -91,8 +92,8 @@ require_relative 'flex_args/parser'
 #      - required
 #      - domain checks
 #      - format checks
-#   - Custom Transformations
-#   - Semantic Checks (v0.2)
+#   - Transformations
+#   - Semantic Checks - between multiple values (v0.2)
 #
 # and they are documented in the rdocs of the corresponding methods
 #
@@ -225,11 +226,76 @@ class FlexArgs
   #
   # ```
   #
-  # Please find the documentation about more constraints [here](Constraint.html)
+  # #### Combining Constraints
+  #
+  # More than one constraint can be imposed on a value
+  # 
+  # Firstly one can combine any constraint with a custom constraint.
+  #
+  # **N.B.** That in this case the custom constraint is executed last, therefore
+  #
+  # ```spec # Order of constraints
+  #    parser = FlexArgs.new
+  #      .constrain(:n, 1..10) { it == 5 ? [:ok, 100] : [:ok, 2*it] }
+  #
+  #    expect(parser.parse(%w[n:5]).values).to eq(n: 100)
+  #
+  # ```
+  #
+  # However if we had defined the custom constraint (which actually is a transformer
+  # as it _always_ returns an `:ok` value, the range constraint would fail
+  #
+  # ```spec # Bad order
+  #    parser = FlexArgs.new
+  #      .constrain(:n) { it == 5 ? [:ok, 100] : [:ok, 2*it] }
+  #      .constrain(:n, 1..10)
+  #
+  #    expect { parser.parse(%w[n:5]) }
+  #    .to raise_error(ArgumentError)
+  #   
+  # ```
+  # 
+  # As mentioned before, custom constraints that always return `:ok` values are indeed
+  # _transformers_ and can be written more with the `transform` [method below](/FlexArgs.html#method-i-transform-label-Transformers)
+  #
+  #
+  # Please find the documentation about more constraints [here](/FlexArgs/Constraint.html)
   #
   def constrain(value, *constraints, &block)
     @allowed_values << value.to_sym if @allowed_values
-    @constraints[value.to_sym] << Constraint.new(value, *constraints, &block)
+    @constraints[value.to_sym] << Constraint.new(value, *constraints) unless constraints.empty?
+    @constraints[value.to_sym] << Constraint.new(value, &block) if block
+    self
+  end
+
+  ##
+  # ## Transformers
+  #
+  # Transformers and Constraints are executed in the order they are defined
+  #
+  # ```spec # Transformer assures constraint passes
+  #
+  #     parser = FlexArgs.new
+  #                .transform(:word) { it.downcase }
+  #                .constrain(:word, "a".."z")
+  #   
+  #     expect(parser.parse(%w[word:A]).values).to eq(word: "a")
+  # ```
+  # 
+  # And therefore
+  #
+  # ```spec # Transformer called too late to assure constraint passes
+  #
+  #     parser = FlexArgs.new
+  #                .constrain(:word, "a".."z")
+  #                .transform(:word) { it.downcase }
+  #   
+  #     expect { parser.parse(%w[word:A]) }.to raise_error(ArgumentError)
+  # ```
+  def transform(value, *transforms, &transformer)
+    @allowed_values << value.to_sym if @allowed_values
+    @constraints[value.to_sym] << Transform.new(*transforms) unless transforms.empty?
+    @constraints[value.to_sym] << Transform.new(&transformer) if transformer
     self
   end
 
@@ -241,7 +307,7 @@ class FlexArgs
   def values
     default_values.merge(values_from_args)
   end
-
+ 
   private
   def initialize
     @alias_definitions = Hash.new

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: flex_args
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.1.3
 platform: ruby
 authors:
 - Robert Dober
@@ -38,6 +38,7 @@ files:
 - lib/flex_args/constraint.rb
 - lib/flex_args/enumerable.rb
 - lib/flex_args/parser.rb
+- lib/flex_args/transform.rb
 - lib/flex_args/version.rb
 homepage: https://codeberg.org/lab419/flex_args
 licenses: