lab42_rgxargs 0.1.4 → 0.1.9

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: dfe60f4e05870ad8a1766abbe5b06b0a6925276696285bb19139ef11aeee70a3
-  data.tar.gz: 682386ba4e34b99f53877e0826b0e10f824c3750198c1b6bf66d634de3104d46
+  metadata.gz: 63983b6491bb1ce75a959a0bbf95c22d2146468ed7ea45c5281065d96b0c79ba
+  data.tar.gz: d70cbfbcd144f2d1fe639347592a80d3e3667f62ddb411dc1d3b9eb231492ee1
 SHA512:
-  metadata.gz: 87cba6d04bfe08e2df0b1f90ccb273e2dd37594f4b44b15814a0c6def76466e244ae164f6876a9ad83dceee3ee43ffa815a2e5aa1ad877d929d352febdafab32
-  data.tar.gz: 75744824c57165417049bc8415315efc29de23a3af3c88a94b4cada576652a47e54ae472097a9819020c563bea93ec0e357fa7dfc3672a65b4e7700deaa402ed
+  metadata.gz: 45318701acaf53c2afe7ee571d2a38af1743bedd3554c514c1a06512ad16c0cb7afed0a3cf427ff44e0c67f8bf75e7b21f63703c18ac892dea562b712cbccb7d
+  data.tar.gz: 19d9bf8c3d67f10a6848a368996717418eec67873141edc862d4a4cc1ece1703acddc041fa25393d05eaabc8fca77142d5c3213b99ffce0012d8e2d9d60556ff

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,24 +50,36 @@ module Lab42
       until argv.empty?
         argv = _parse_next argv
       end
+      _check_required_kwds
       [options, args, errors]
     end
 
 
+    def allows name, matcher=nil, &converter
+      add_conversion(name, matcher, &converter)
+    end
+
+    def needs name, matcher=nil, &converter
+      add_conversion(name, matcher, :required, &converter)
+    end
+
     private
 
     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 +88,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 +98,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 +130,14 @@ 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

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,5 +1,6 @@
 module Lab42::Rgxargs::PredefinedMatchers extend self
   PREDEFINED = {
+    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 }],
@@ -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.9"
+  end
+end

metadata

@@ -1,15 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: lab42_rgxargs
 version: !ruby/object:Gem::Version
-  version: 0.1.4
+  version: 0.1.9
 platform: ruby
 authors:
 - Robert Dober
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-01-24 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: 2.6.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: []