lab42_rgxargs 0.1.3 → 0.1.8

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e7ea5cf52b4dcf047e658abb12af417cbc24a055941f79645eb51f22e0697707
-  data.tar.gz: f5970679785663ca6ea8e831cc26f060824bc6ea8f79c8f00eebd6502b4b5201
+  metadata.gz: 859bcfceec315a00418253c045cb8819276bafd306e52c36a9f3c1f2f0c657aa
+  data.tar.gz: 1cb197a190eada29279019ef914e98af7015589a8aacfd1e16e3a4c728615892
 SHA512:
-  metadata.gz: c4d7c897da552ee32fa69d40fde98a398fbd274337fb64aa5739ebd01533807cc4e5d185512a5af75a561d805e82eacdad603dd9cba3275bb81866ad68bc71bc
-  data.tar.gz: 45854555bb805ea65e797cc3b835f440efa2505107a73e5a6b58d4a1c884b2b8776378061a4ea5e6bc50c1a493a9b230dc9b983e39e480819ca702826b86bb6b
+  metadata.gz: c8c31ee9df616a66e6a0463a3778b227395cee9acabed1203d4ce46d840208d65829d9c4b48218453cd74d8f770e03538a737d5c6946cdb6486872fd964cd320
+  data.tar.gz: d817a9984f1853028979f179f97fd4b421a58deed2b081fa359f35351e73209b7183aabd1cf5466b86e4e0a20383d7f0b9927d369645ceaf0a47731085e5af7b

data/lib/lab42/rgxargs.rb

@@ -4,28 +4,42 @@ require 'lab42/enumerable'
 module Lab42
 
   class Rgxargs
+    require_relative 'rgxargs/checker'
+    require_relative 'rgxargs/constrainer'
     require_relative 'rgxargs/predefined_matchers'
     require_relative 'rgxargs/argument_matcher'
     require_relative 'rgxargs/syntax_definer'
+    include Checker
+    include Constrainer
+
     Predefined = PredefinedMatchers
 
     extend Forwardable
     def_delegators Predefined, :list_matcher
 
-    attr_reader :args, :conversions, :defined_rules, :errors, :options, :syntaxes
+    attr_reader :allowed, :args, :conversions, :defaults, :defined_rules, :errors, :options, :required, :syntaxes
 
 
-    def add_conversion(param, conversion)
+    def add_conversion(param, conversion=nil, required=nil, &block)
       case conversion
       when Symbol
-        conversions[param] = Predefined.fetch(conversion, conversion)
+        _add_symbolic_conversion(param, conversion, required)
+      when NilClass
+        _add_simple_conversion(param, block)
       else
-        conversions[param] = conversion
+        _add_proc_conversion(param, conversion, block, required)
       end
     end
 
     def add_syntax(rgx, parser=nil, as: nil)
-      syntaxes << ArgumentMatcher.new(rgx, parser, arg_name: as) 
+      case rgx
+      when Symbol, Regexp
+        syntaxes << ArgumentMatcher.new(rgx, parser, arg_name: as)
+      when Array
+        rgx.each do |rg1|
+          add_syntax( rg1, parser, as: as)
+        end
+      end
     end
 
     def define_arg name, &blk
@@ -36,6 +50,7 @@ module Lab42
       until argv.empty?
         argv = _parse_next argv
       end
+      _check_required_kwds
       [options, args, errors]
     end
 
@@ -44,16 +59,19 @@ module Lab42
 
     def initialize &blk
       @args          = []
+      @allowed       = nil
       @conversions   = {}
+      @defaults      = {}
       @defined_rules = []
       @errors        = []
-      @options       = OpenStruct.new
+      @required      = Set.new
       @syntaxes      = []
 
       instance_exec(&blk) if blk
+      @options       = OpenStruct.new(defaults)
     end
 
-    def _convert(value, name:) 
+    def _convert(value, name:)
       conv = conversions.fetch(name, nil)
       case conv
       when Symbol
@@ -62,7 +80,7 @@ module Lab42
         conv.(value)
       when Array
         if (match = conv.first.match(value))
-          conv[1].(match.captures) 
+          conv[1].(*match.captures)
         else
           errors << [:syntax_error, name, "#{value} does not match #{conv.first}"]
           nil
@@ -72,6 +90,25 @@ module Lab42
       end
     end
 
+    def _add_proc_conversion(param, conversion, block, required)
+      Array(param).each do |para|
+        @required.add para if required == :required
+        conversions[para] =  block ? [conversion, block] : conversion
+      end
+    end
+
+    def _add_simple_conversion(param, block)
+      Array(param).each do |para|
+        conversions[para] = block
+      end
+    end
+
+    def _add_symbolic_conversion(param, conversion, required)
+      Array(param).each do |para|
+        @required.add para if required == :required
+        conversions[para] = Predefined.fetch(conversion, conversion)
+      end
+    end
 
     def _parse_next argv
       first, *rest = argv
@@ -85,10 +122,17 @@ module Lab42
     def _parse_symbolic first, rest
       case first
       when %r{\A:(.*)}
-        options[$1.gsub('-','_').to_sym]=true
+        switch = $1.gsub('-','_').to_sym
+        _check_switch(switch)
+        options[switch]=true
         rest
       when %r{(.*):\z}
-        _parse_value $1.gsub('-', '_').to_sym, rest
+        kwd = $1.gsub('-', '_').to_sym
+        _check_kwd(kwd)
+        _parse_value kwd, rest
+      when %r{\A\\(.*)}
+        args << $1
+        rest
       else
         _parse_syntax(first)
         rest

data/lib/lab42/rgxargs/argument_matcher.rb

@@ -13,7 +13,7 @@ class Lab42::Rgxargs::ArgumentMatcher
     case matcher
     when Regexp
       match = matcher.match(value)
-      match && [converter.(match.captures), arg_name] 
+      match && [converter.(*match.captures), arg_name] 
     else
       matcher.to_s == value && [converter.(), arg_name]
     end

data/lib/lab42/rgxargs/checker.rb

@@ -0,0 +1,33 @@
+module Lab42
+  class Rgxargs
+    module Checker
+
+      private
+
+      def _check_kwd(kwd)
+        return if allowed.nil?
+        return if allowed.member? kwd
+        return if required.member? kwd
+        errors << [:unauthorized_kwd, kwd]
+      end
+
+      def _check_required_kwds
+        missing = required - options.to_h.keys
+        @errors += missing.map(&_mk_pair(:required_kwd_missing))
+      end
+      
+
+      def _mk_pair(prefix)
+        -> element do
+          [prefix, element]
+        end
+      end
+
+      def _check_switch(_)
+        
+      end
+
+
+    end
+  end
+end

data/lib/lab42/rgxargs/constrainer.rb

@@ -0,0 +1,15 @@
+module Lab42
+  class Rgxargs
+    module Constrainer
+
+      def allow_kwds(*kwds)
+        @allowed = (allowed||Set.new).union(Set.new(kwds.flatten))
+      end
+
+      def require_kwds(*kwds)
+        @required = (required||Set.new).union(Set.new(kwds.flatten))
+      end
+
+    end
+  end
+end

data/lib/lab42/rgxargs/predefined_matchers.rb

@@ -1,9 +1,10 @@
 module Lab42::Rgxargs::PredefinedMatchers extend self
   PREDEFINED = {
-    int_list: [%r{\A(-?\d+(?:,-?\d+)*)\z}, ->(groups){ groups.first.split(",").map(&:to_i)}],
-    int_range: [%r{\A(-?\d+)(?:-|\.\.)(-?\d+)\z}, ->((f, l)){ Range.new(f.to_i, l.to_i) }],
-    list:  [%r{(\w+)(?:,(\w+))*},   ->(groups){ groups.compact }],
-    range: [%r{\A(\d+)\.\.(\d+)\z}, ->(groups){ Range.new(*groups.map(&:to_i)) }]
+    int: [%r{\A([-+]?\d+)\z}, :to_i.to_proc],
+    int_list: [%r{\A(-?\d+(?:,-?\d+)*)\z}, ->(*groups){ groups.first.split(",").map(&:to_i)}],
+    int_range: [%r{\A(-?\d+)(?:-|\.\.)(-?\d+)\z}, ->(f, l){ Range.new(f.to_i, l.to_i) }],
+    list:  [%r{(\w+)(?:,(\w+))*},   ->(*groups){ groups.compact }],
+    range: [%r{\A(\d+)\.\.(\d+)\z}, ->(*groups){ Range.new(*groups.map(&:to_i)) }]
   }
 
   def defined_names
@@ -16,12 +17,11 @@ module Lab42::Rgxargs::PredefinedMatchers extend self
   end
 
   def list_matcher values
-    [%r{\A((?:#{values.join("|")})(?:,(?:#{values.join("|")}))*)\z}, _list_extractor]
+    [%r{\A((?:#{values.join("|")})(?:,(?:#{values.join("|")}))*)\z}, method(:_list_extractor)]
   end
 
 
-  # Memoized
-  def _list_extractor
-    @__list_extractor__ ||= ->(groups){ groups.first.split(",") }
+  def _list_extractor(*groups)
+    groups.first.split(",")
   end
 end

data/lib/lab42/rgxargs/syntax.rb

@@ -0,0 +1,19 @@
+class Lab42::Rgxargs::Syntax
+
+  attr_reader :converter, :matcher
+
+  def matches? value
+    if match = matcher.match(value)
+      yield converter.(*match.captures)
+      true
+    end
+  end
+
+  private
+  
+  def initialize matcher, converter
+    @converter = converter
+    @matcher   = matcher
+  end
+
+end

data/lib/lab42/rgxargs/syntax_definer.rb

@@ -1,5 +1,16 @@
+# Instanciated with an Rgxargs parser it can run a block
+# in its own context so that the block accesses the
+# parser's functionality with syntactic sugar w/o cluttering
+# ther parser itself with too many methods
+# E.g.:
+#
+#     ```ruby
+#         syntax
+#         
+#     ```
 class Lab42::Rgxargs::SyntaxDefiner
 
+
   attr_reader :arg_name, :parser
 
   def run code

data/lib/lab42/rgxargs/version.rb

@@ -0,0 +1,5 @@
+module Lab42
+  class Rgxargs
+    VERSION = "0.1.8"
+  end
+end

metadata

@@ -1,15 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: lab42_rgxargs
 version: !ruby/object:Gem::Version
-  version: 0.1.3
+  version: 0.1.8
 platform: ruby
 authors:
 - Robert Dober
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-01-18 00:00:00.000000000 Z
+date: 2020-01-27 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: speculate_about
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.1.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.1.2
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -38,6 +52,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.7'
+- !ruby/object:Gem::Dependency
+  name: pry-doc
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
 description: Parse CL args according to regexen
 email: robert.dober@gmail.com
 executables: []
@@ -47,14 +75,18 @@ files:
 - lib/lab42/enumerable.rb
 - lib/lab42/rgxargs.rb
 - lib/lab42/rgxargs/argument_matcher.rb
+- lib/lab42/rgxargs/checker.rb
+- lib/lab42/rgxargs/constrainer.rb
 - lib/lab42/rgxargs/error.rb
 - lib/lab42/rgxargs/predefined_matchers.rb
+- lib/lab42/rgxargs/syntax.rb
 - lib/lab42/rgxargs/syntax_definer.rb
+- lib/lab42/rgxargs/version.rb
 homepage: https://github.com/robertdober/lab42_rgxargs
 licenses:
 - Apache-2.0
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -62,15 +94,15 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 2.7.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.6
-signing_key: 
+rubygems_version: 3.1.2
+signing_key:
 specification_version: 4
 summary: Parse CL args according to regexen
 test_files: []