lab42_rgxargs 0.1.2 → 0.1.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9d995928882bad168df974b923ccb5d725eb86bbd56a694cedd9059ef568e6ad
-  data.tar.gz: 4e4194883792088934889ebd8f7a6fdcd6126ad55cf1fa3a0eb30249ad938d0a
+  metadata.gz: 3879a325fa817a79a35ca494b7d7550aac9d6d6a25702d7ab07efbbf51d2c3d1
+  data.tar.gz: 7446e1f864db187211f4327222eb3fad7d6f6e20abd5ebaecdd7a6185039600f
 SHA512:
-  metadata.gz: fb3138610aa1d243ed7bc5d7b7b782901b788d5b75b50e227f7cc0d5ba3ca0f524f8f501139bb67ac808a4b697f915afe89312a0c2f3ec4bf4396cce81d75908
-  data.tar.gz: f662d35d67de38063f978716ca85a9e68548c71dd428867e4354d3706b6d070a3c5efd4fd18e3e55ac375aba9a7b218f5fe5fefe04e63a33e407646fbfd54671
+  metadata.gz: 9ac9b5cf9ed52197f16c647c5d5202e0a47efbcc98a5ed5ba89b8bebaa81eb4966f06f9b681ad5b0186939c715c45f1e1c3c14cdb03658724778ab55b614192e
+  data.tar.gz: 373b64cf35bd6949585afbbd8123ff309f09239d1ad2090156c211862f8b2159ff07fed9478bb43eabf63a12f978145c1ef064e27c34572a637de2139c0cbaa8

data/lib/lab42/rgxargs.rb

@@ -4,121 +4,151 @@ 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, required=nil, &block)
       case conversion
       when Symbol
-        conversions[param] = Predefined.fetch(conversion, conversion)
+        _add_symbolic_conversion(param, conversion, required)
       else
-        conversions[param] = conversion
+        _add_proc_conversion(param, conversion, block, required)
       end
     end
 
     def add_syntax(rgx, parser=nil, as: nil)
-      if parser
-        syntaxes << [rgx, parser, as]
-      else
-        if predef = Predefined.fetch(rgx, as: as)
-          syntaxes << predef
-          else
-            raise ArgumentError, "#{rgx} is not a predefined syntax, use one of the following:\n\t#{Predefined.defined_names}"
-          end
+      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 parse argv
-        until argv.empty?
-          argv = _parse_next argv
-        end
-        [options, args, errors]
+    def define_arg name, &blk
+      SyntaxDefiner.new(self, name).run(blk)
+    end
+
+    def parse argv
+      until argv.empty?
+        argv = _parse_next argv
       end
+      _check_required_kwds
+      [options, args, errors]
+    end
 
 
-      private
+    private
 
-      def initialize &blk
-        @args          = []
-        @conversions   = {}
-        @defined_rules = []
-        @errors        = []
-        @options       = OpenStruct.new
-        @syntaxes      = []
+    def initialize &blk
+      @args          = []
+      @allowed       = nil
+      @conversions   = {}
+      @defaults      = {}
+      @defined_rules = []
+      @errors        = []
+      @required      = Set.new
+      @syntaxes      = []
 
-        instance_exec(&blk) if blk
-      end
+      instance_exec(&blk) if blk
+      @options       = OpenStruct.new(defaults)
+    end
 
-      def _convert(value, name:) 
-        conv = conversions.fetch(name, nil)
-        case conv
-        when Symbol
-          value.send conv
-        when Proc
-          conv.(value)
-        when Array
-          if (match = conv.first.match(value))
-            conv[1].(match.captures) 
-          else
-            errors << [:syntax_error, name, "#{value} does not match #{conv.first}"]
-            nil
-          end
+    def _convert(value, name:)
+      conv = conversions.fetch(name, nil)
+      case conv
+      when Symbol
+        value.send conv
+      when Proc
+        conv.(value)
+      when Array
+        if (match = conv.first.match(value))
+          conv[1].(*match.captures)
         else
-          value
+          errors << [:syntax_error, name, "#{value} does not match #{conv.first}"]
+          nil
         end
+      else
+        value
       end
+    end
 
-      def _defined_rules(_arg)
-        false
+    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 _parse_next argv
-        first, *rest = argv
-        if _defined_rules(first)
-          return rest
-        end
-        _parse_symbolic first, rest
+    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_symbolic first, rest
-        case first
-        when %r{\A:(.*)}
-          options[$1.gsub('-','_').to_sym]=true
-          rest
-        when %r{(.*):\z}
-          _parse_value $1.gsub('-', '_').to_sym, rest
-        else
-          _parse_syntax(first)
-          rest
-        end
+    def _parse_next argv
+      first, *rest = argv
+      if first == '--'
+        @args += rest
+        return []
       end
+      _parse_symbolic first, rest
+    end
 
-      def _parse_syntax first
-        value, as = syntaxes.find_value(first) do |(rgx, converter, as)|
-          (match = rgx.match(first)) && [converter.(match.captures), as] 
-        end
-        if as
-          options[as] = value
-        else
-          args << value
-        end
+    def _parse_symbolic first, rest
+      case first
+      when %r{\A:(.*)}
+        switch = $1.gsub('-','_').to_sym
+        _check_switch(switch)
+        options[switch]=true
+        rest
+      when %r{(.*):\z}
+        kwd = $1.gsub('-', '_').to_sym
+        _check_kwd(kwd)
+        _parse_value kwd, rest
+      when %r{\A\\(.*)}
+        args << $1
+        rest
+      else
+        _parse_syntax(first)
+        rest
       end
+    end
 
-      def _parse_value name, rest
-        value, *rest1 = rest
-        if value
-          options[name] = _convert(value, name: name)
-          return rest1
-        end
-        errors << [:missing_required_value, name]
-        []
+    def _parse_syntax first
+      value, as = syntaxes.find_value(first){ |matcher| matcher.match(first) }
+      if as
+        options[as] = value
+      else
+        args << value
       end
+    end
 
+    def _parse_value name, rest
+      value, *rest1 = rest
+      if value
+        options[name] = _convert(value, name: name)
+        return rest1
+      end
+      errors << [:missing_required_value, name]
+      []
     end
+
   end
+end

data/lib/lab42/rgxargs/argument_matcher.rb

@@ -0,0 +1,35 @@
+class Lab42::Rgxargs::ArgumentMatcher
+  require_relative './error'
+  require_relative './predefined_matchers'
+
+  Predefined = Lab42::Rgxargs::PredefinedMatchers 
+  Error      = Lab42::Rgxargs::Error
+
+  attr_reader :arg_name, :converter, :matcher
+
+
+
+  def match value
+    case matcher
+    when Regexp
+      match = matcher.match(value)
+      match && [converter.(*match.captures), arg_name] 
+    else
+      matcher.to_s == value && [converter.(), arg_name]
+    end
+  end
+
+  private
+
+  def initialize(matcher, converter, arg_name: nil)
+    @arg_name  = arg_name
+    @matcher   = matcher
+    @converter = converter || _get_predefined
+  end
+
+  def _get_predefined
+    @matcher, converter = Predefined.fetch(matcher) { raise Error, "undefined syntax #{matcher}" }
+    converter
+  end
+
+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/error.rb

@@ -0,0 +1,2 @@
+class Lab42::Rgxargs::Error < RuntimeError
+end

data/lib/lab42/rgxargs/predefined_matchers.rb

@@ -1,27 +1,27 @@
 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
      @__defined_names__ ||= PREDEFINED.keys.join("\n\t")
   end
 
-  def fetch(key, default=nil, as: nil, &blk)
-    return PREDEFINED[key] + [as] if PREDEFINED.has_key?(key)
+  def fetch(key, default=nil, &blk)
+    return PREDEFINED[key] if PREDEFINED.has_key?(key)
     blk ? blk.(key) : default
   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

@@ -0,0 +1,34 @@
+# 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
+    instance_exec(&code)
+  end
+
+  def syntax(matcher, value=nil, &blk)
+    if value
+      parser.add_syntax(matcher, ->(){value}, as: arg_name )
+    else
+      parser.add_syntax(matcher, blk, as: arg_name)
+    end
+  end
+
+  private
+
+  def initialize(parser, arg_name)
+    @arg_name = arg_name
+    @parser   = parser
+  end
+end

data/lib/lab42/rgxargs/version.rb

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

metadata

@@ -1,15 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: lab42_rgxargs
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.1.7
 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: []
@@ -46,12 +74,19 @@ extra_rdoc_files: []
 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
@@ -59,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: []