Class: Mustermann::Identity

Inherits:
Pattern
  • Object
show all
Defined in:
mustermann/lib/mustermann/identity.rb

Overview

Matches strings that are identical to the pattern.

Examples:

Mustermann.new('/:foo', type: :identity) === '/bar' # => false

See Also:

Constant Summary

Constants included from Mustermann

CompileError, DEFAULT_TYPE, Error, ExpandError, ParseError

Instance Attribute Summary

Attributes inherited from Pattern

#uri_decode

Instance Method Summary collapse

Methods inherited from Pattern

#+, #==, #=~, #eql?, #hash, #initialize, #match, #named_captures, #names, new, #params, #peek, #peek_match, #peek_params, supported?, supported_options, #to_proc, #to_s, #|

Methods included from Mustermann

[], new

Constructor Details

This class inherits a constructor from Mustermann::Pattern

Instance Method Details

#===(string) ⇒ Boolean

Returns Whether or not the pattern matches the given string

Parameters:

  • string (String)

    The string to match against

Returns:

  • (Boolean)

    Whether or not the pattern matches the given string

See Also:


21
22
23
# File 'mustermann/lib/mustermann/identity.rb', line 21

def ===(string)
  unescape(string) == @string
end

#expand(behavior = nil, values = {}) ⇒ String

Identity patterns support expanding.

This implementation does not use Expander internally to save memory and compilation time.

Examples:

Expanding a pattern

pattern = Mustermann.new('/:name(.:ext)?')
pattern.expand(name: 'hello')             # => "/hello"
pattern.expand(name: 'hello', ext: 'png') # => "/hello.png"

Checking if a pattern supports expanding

if pattern.respond_to? :expand
  pattern.expand(name: "foo")
else
  warn "does not support expanding"
end

Parameters:

  • behavior (Symbol) (defaults to: nil)

    What to do with additional key/value pairs not present in the values hash. Possible options: :raise, :ignore, :append.

  • values (Hash{Symbol: #to_s, Array<#to_s>}) (defaults to: {})

    Values to use for expansion.

Returns:

  • (String)

    expanded string

Raises:

  • (NotImplementedError)

    raised if expand is not supported.

  • (Mustermann::ExpandError)

    raised if a value is missing or unknown

See Also:


68
69
70
71
72
73
74
75
# File 'mustermann/lib/mustermann/identity.rb', line 68

def expand(behavior = nil, values = {})
  return to_s if values.empty? or behavior == :ignore
  raise ExpandError,    "cannot expand with keys %p" % values.keys.sort if behavior == :raise
  raise ArgumentError,  "unknown behavior %p"        % behavior         if behavior != :append
  params    = values.map { |key, value| @@uri.escape(key.to_s) + "=" + @@uri.escape(value.to_s, /[^\w]/) }
  separator = @string.include?(??) ? ?& : ??
  @string + separator + params.join(?&)
end

#peek_size(string) ⇒ Integer?

Returns the number of characters that match

Parameters:

  • string (String)

    The string to match against

Returns:

  • (Integer, nil)

    the number of characters that match


28
29
30
31
32
33
34
35
36
37
# File 'mustermann/lib/mustermann/identity.rb', line 28

def peek_size(string)
  return unless unescape(string).start_with? @string
  return @string.size if string.start_with? @string # optimization
  @string.each_char.with_index.inject(0) do |count, (char, index)|
    char_size = 1
    escaped   = @@uri.escape(char, /./)
    char_size = escaped.size if string[index, escaped.size].downcase == escaped.downcase
    count + char_size
  end
end

#to_templatesArray<String>

URI templates support generating templates (the logic is quite complex, though).

Examples:

generating templates

Mustermann.new("/:name").to_templates                   # => ["/{name}"]
Mustermann.new("/:foo(@:bar)?/*baz").to_templates       # => ["/{foo}@{bar}/{+baz}", "/{foo}/{+baz}"]
Mustermann.new("/{name}", type: :template).to_templates # => ["/{name}"]

generating templates from composite patterns

pattern  = Mustermann.new('/:name')
pattern |= Mustermann.new('/{name}', type: :template)
pattern |= Mustermann.new('/example/*nested')
pattern.to_templates # => ["/{name}", "/example/{+nested}"]

Checking if a pattern supports expanding

if pattern.respond_to? :to_templates
  pattern.to_templates
else
  warn "does not support template generation"
end

Returns:

  • (Array<String>)

    list of URI templates

See Also:


45
46
47
# File 'mustermann/lib/mustermann/identity.rb', line 45

def to_templates
  [@@uri.escape(to_s)]
end