1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
|
# re2 (https://github.com/mudge/re2)
# Ruby bindings to RE2, a "fast, safe, thread-friendly alternative to
# backtracking regular expression engines like those used in PCRE, Perl, and
# Python".
#
# Copyright (c) 2010, Paul Mucur (https://mudge.name)
# Released under the BSD Licence, please see LICENSE.txt
module RE2
class Regexp
# Match the pattern against any substring of the given `text` and return a
# {RE2::MatchData} instance with the specified number of submatches
# (defaults to the total number of capturing groups) or a boolean (if no
# submatches are required).
#
# The number of submatches has a significant impact on performance: requesting
# one submatch is much faster than requesting more than one and requesting
# zero submatches is faster still.
#
# @param [String] text the text to search
# @param [Hash] options the options with which to perform the match
# @option options [Integer] :submatches how many submatches to extract (0
# is fastest), defaults to the total number of capturing groups
# @return [RE2::MatchData, nil] if extracting any submatches
# @return [Boolean] if not extracting any submatches
# @raise [ArgumentError] if given a negative number of submatches
# @raise [NoMemoryError] if there was not enough memory to allocate the
# matches
# @raise [TypeError] if given non-numeric submatches or non-hash options
# @example
# r = RE2::Regexp.new('w(o)(o)')
# r.partial_match('woot') #=> #<RE2::MatchData "woo" 1:"o" 2:"o">
# r.partial_match('nope') #=> nil
# r.partial_match('woot', submatches: 1) #=> #<RE2::MatchData "woo" 1:"o">
# r.partial_match('woot', submatches: 0) #=> true
def partial_match(text, options = {})
match(text, Hash(options).merge(anchor: :unanchored))
end
# Match the pattern against the given `text` exactly and return a
# {RE2::MatchData} instance with the specified number of submatches
# (defaults to the total number of capturing groups) or a boolean (if no
# submatches are required).
#
# The number of submatches has a significant impact on performance: requesting
# one submatch is much faster than requesting more than one and requesting
# zero submatches is faster still.
#
# @param [String] text the text to search
# @param [Hash] options the options with which to perform the match
# @option options [Integer] :submatches how many submatches to extract (0
# is fastest), defaults to the total number of capturing groups
# @return [RE2::MatchData, nil] if extracting any submatches
# @return [Boolean] if not extracting any submatches
# @raise [ArgumentError] if given a negative number of submatches
# @raise [NoMemoryError] if there was not enough memory to allocate the
# matches
# @raise [TypeError] if given non-numeric submatches or non-hash options
# @example
# r = RE2::Regexp.new('w(o)(o)')
# r.full_match('woo') #=> #<RE2::MatchData "woo" 1:"o" 2:"o">
# r.full_match('woot') #=> nil
# r.full_match('woo', submatches: 1) #=> #<RE2::MatchData "woo" 1:"o">
# r.full_match('woo', submatches: 0) #=> true
def full_match(text, options = {})
match(text, Hash(options).merge(anchor: :anchor_both))
end
end
end
|
