Module: TermUtils::AP

Defined in:
lib/term_utils/ap.rb,
lib/term_utils/ap/flag.rb,
lib/term_utils/ap/parser.rb,
lib/term_utils/ap/result.rb,
lib/term_utils/ap/syntax.rb,
lib/term_utils/ap/article.rb,
lib/term_utils/ap/parameter.rb

Overview

The Argument Parser module provides a way to parse arguments.

Defined Under Namespace

Classes: Article, ArticleResult, Flag, Parameter, ParameterResult, ParameterWalkerHooks, ParseError, Parser, Result, Syntax, SyntaxError, Walker

Class Method Summary collapse

Class Method Details

.create_syntax(&block) ⇒ TermUtils::AP::Syntax

Creates a new Syntax.

Returns:



96
97
98
99
100
 
# File 'lib/term_utils/ap.rb', line 96

def self.create_syntax(&block)
  new_syntax = TermUtils::AP::Syntax.new
  block.call(new_syntax) if block
  new_syntax
end

.parse_arguments(syntax, arguments, opts = {}, &block) ⇒ Result

Parses a given list of arguments.

Parameters:

  • syntax (Syntax)
  • arguments (Array<String>)
  • opts (Hash) (defaults to: {})

Options Hash (opts):

  • :strict (Boolean) —

    Whether the Syntax must be considered as strict.

Returns:

Raises:



110
111
112
 
# File 'lib/term_utils/ap.rb', line 110

def self.parse_arguments(syntax, arguments, opts = {}, &block)
  TermUtils::AP::Parser.new.parse_arguments(syntax, arguments, opts, &block)
end