Module: TermUtils::AP

Defined in:
lib/term_utils/ap.rb,
lib/term_utils/ap/flag.rb,
lib/term_utils/ap/level.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/element.rb,
lib/term_utils/ap/parameter.rb,
lib/term_utils/ap/parse_error.rb,
lib/term_utils/ap/syntax_error.rb,
lib/term_utils/ap/no_such_value_error.rb

Overview

The Argument Parser module provides a way to parse command arguments.

Defined Under Namespace

Classes: Article, Element, Flag, Level, NoSuchValueError, Parameter, ParseError, Parser, Result, Syntax, SyntaxError

Class Method Summary collapse

Class Method Details

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

Creates a new Syntax.

Returns:



33
34
35
36
37
 
# File 'lib/term_utils/ap.rb', line 33

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 = {}) ⇒ TermUtils::AP::Result

Parses a given list of arguments.

Parameters:

Returns:

Raises:



55
56
57
 
# File 'lib/term_utils/ap.rb', line 55

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

.parse_command(syntax, command, opts = {}) ⇒ TermUtils::AP::Result

Parses a given command.

Parameters:

Returns:

Raises:



45
46
47
 
# File 'lib/term_utils/ap.rb', line 45

def self.parse_command(syntax, command, opts = {})
  TermUtils::AP::Parser.new.parse_command(syntax, command, opts)
end