Class: URITemplate::RFC6570

Inherits:

Object

• Object
• URITemplate::RFC6570

show all

Extended by:

Forwardable, ClassMethods

Includes:

URITemplate

Defined in:

lib/uri_template/rfc6570.rb,
lib/uri_template/rfc6570/expression.rb,
lib/uri_template/rfc6570/regex_builder.rb

Overview

Defined Under Namespace

Modules: ClassMethods Classes: Invalid, InvalidValue, RegexBuilder

Constant Summary

TYPE =

:rfc6570

NO_PROCESSING =

Specifies that no processing should be done upon extraction.

See Also:

• #extract

[]

CONVERT_VALUES =

Specifies that the extracted values should be processed.

See Also:

• #extract

[:convert_values]

CONVERT_RESULT =

Specifies that the extracted variable list should be processed.

See Also:

• #extract

[:convert_result]

DEFAULT_PROCESSING =

Default processing. Means: convert values and the list itself.

See Also:

• #extract

CONVERT_VALUES + CONVERT_RESULT

Constants included from URITemplate

HOST_REGEX, SCHEME_REGEX, URI_SPLIT, VERSIONS

Instance Attribute Summary (collapse)

• - (Object) options readonly

  Returns the value of attribute options.

Instance Method Summary (collapse)

• - (Object) ===(uri)

  Alias for to_r.=== .

• - (Object) expand(variables = {})

  Expands the template with the given variables.

• - (Object) extract(uri_or_match, post_processing = DEFAULT_PROCESSING)

  Extracts variables from a uri ( given as string ) or an instance of MatchData ( which was matched by the regexp of this template. The actual result depends on the value of post_processing. This argument specifies whether pair arrays should be converted to hashes..

• - (Object) extract_simple(uri_or_match)

  Extracts variables without any proccessing.

• - (RFC6570) initialize(pattern_or_tokens, options = {}) constructor

  A new instance of RFC6570.

• - (Object) level

  Returns the level of this template according to the rfc 6570 ( tools.ietf.org/html/rfc6570#section-1.2 ).

• - (Object) match(uri) { ... }

  Alias for to_r.match .

• - (Object) to_r

  Compiles this template into a regular expression which can be used to test whether a given uri matches this template.

• - (Object) tokens

  Returns an array containing a the template tokens.

• - (Object) type

  The type of this template.

Methods included from ClassMethods

try_convert, valid?

Methods included from URITemplate

apply, coerce, coerce_first_arg, #concat, convert, #eq, #host?, new, #path_concat, #pattern, #relative?, resolve_class, #scheme?, #static_characters, try_convert, #variables

265
266
267
268
269
270
271
272
273
274
275
276
277
278
279

# File 'lib/uri_template/rfc6570.rb', line 265

def initialize(pattern_or_tokens,options={})
  @options = options.dup.freeze
  if pattern_or_tokens.kind_of? String
    @pattern = pattern_or_tokens.dup
    @pattern.freeze
    unless @options[:lazy]
      self.tokens
    end
  elsif pattern_or_tokens.kind_of? Array
    @tokens = pattern_or_tokens.dup
    @tokens.freeze
  else
    raise ArgumentError, "Expected to receive a pattern string, but got #{pattern_or_tokens.inspect}"
  end
end

260
261
262

# File 'lib/uri_template/rfc6570.rb', line 260

def options
  @options
end

384

# File 'lib/uri_template/rfc6570.rb', line 384

def_delegators :to_r, :===

URITemplate::RFC6570.new('{foo}').expand('foo'=>'bar') #=> 'bar'
URITemplate::RFC6570.new('{?args*}').expand('args'=>{'key'=>'value'}) #=> '?key=value'
URITemplate::RFC6570.new('{undef}').expand() #=> ''

# File 'lib/uri_template/rfc6570.rb', line 281

a_tpl.expand( a_tpl.extract( an_uri ) ) == an_uri

URITemplate::RFC6570.new('{var}').extract('value') #=> {'var'=>'value'}
URITemplate::RFC6570.new('{&args*}').extract('&a=1&b=2') #=> {'args'=>{'a'=>'1','b'=>'2'}}
URITemplate::RFC6570.new('{&arg,arg}').extract('&arg=1&arg=2') #=> {'arg'=>'2'}

URITemplate::RFC6570.new('{var}').extract('value', URITemplate::RFC6570::NO_PROCESSING) #=> [['var','value']]
URITemplate::RFC6570.new('{&args*}').extract('&a=1&b=2', URITemplate::RFC6570::NO_PROCESSING) #=> [['args',[['a','1'],['b','2']]]]
URITemplate::RFC6570.new('{&arg,arg}').extract('&arg=1&arg=2', URITemplate::RFC6570::NO_PROCESSING) #=> [['arg','1'],['arg','2']]

two_lists = URITemplate::RFC6570.new('{listA*,listB*}')
uri = two_lists.expand('listA'=>[1,2],'listB'=>[3,4]) #=> "1,2,3,4"
variables = two_lists.extract( uri ) #=> {'listA'=>["1","2","3"],'listB'=>["4"]}
# However, like said in the note:
two_lists.expand( variables ) == uri #=> true

349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372

# File 'lib/uri_template/rfc6570.rb', line 349

def extract(uri_or_match, post_processing = DEFAULT_PROCESSING )
  if uri_or_match.kind_of? String
    m = self.to_r.match(uri_or_match)
  elsif uri_or_match.kind_of?(MatchData)
    if uri_or_match.respond_to?(:regexp) and uri_or_match.regexp != self.to_r
      raise ArgumentError, "Trying to extract variables from MatchData which was not generated by this template."
    end
    m = uri_or_match
  elsif uri_or_match.nil?
    return nil
  else
    raise ArgumentError, "Expected to receive a String or a MatchData, but got #{uri_or_match.inspect}."
  end
  if m.nil?
    return nil
  else
    result = extract_matchdata(m, post_processing)
    if block_given?
      return yield result
    end

    return result
  end
end

377
378
379

# File 'lib/uri_template/rfc6570.rb', line 377

def extract_simple(uri_or_match)
  extract( uri_or_match, NO_PROCESSING )
end

URITemplate::RFC6570.new('/foo/').level #=> 1
URITemplate::RFC6570.new('/foo{bar}').level #=> 1
URITemplate::RFC6570.new('/foo{#bar}').level #=> 2
URITemplate::RFC6570.new('/foo{.bar}').level #=> 3
URITemplate::RFC6570.new('/foo{bar,baz}').level #=> 3
URITemplate::RFC6570.new('/foo{bar:20}').level #=> 4
URITemplate::RFC6570.new('/foo{bar*}').level #=> 4

423
424
425

# File 'lib/uri_template/rfc6570.rb', line 423

def level
  tokens.map(&:level).max
end

390

# File 'lib/uri_template/rfc6570.rb', line 390

def_delegators :to_r, :match

tpl = URITemplate::RFC6570.new('/foo/{bar}/')
regex = tpl.to_r
regex === '/foo/baz/' #=> true
regex === '/foz/baz/' #=> false

305
306
307
308
309
310
311
312

# File 'lib/uri_template/rfc6570.rb', line 305

def to_r
  @regexp ||= begin
    source = tokens.map(&:to_r_source)
    source.unshift('\A')
    source.push('\z')
    Regexp.new( source.join, Utils::KCODE_UTF8)
  end
end

428
429
430

# File 'lib/uri_template/rfc6570.rb', line 428

def tokens
  @tokens ||= tokenize!
end

tpl1 = URITemplate::RFC6570.new('/foo')
tpl2 = URITemplate.new( tpl1.pattern, tpl1.type )
tpl1 == tpl2 #=> true

400
401
402

# File 'lib/uri_template/rfc6570.rb', line 400

def type
  self.class::TYPE
end