Class: Matchi::Match

Inherits:
Object
  • Object
show all
Defined in:
lib/matchi/match.rb

Overview

*Regular expressions* matcher.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(expected) ⇒ Match

Initialize the matcher with an instance of Regexp.

Examples:

require "matchi/match"

Matchi::Match.new(/^foo$/)

Parameters:

  • expected (#match)

    A regular expression.


17
18
19
# File 'lib/matchi/match.rb', line 17

def initialize(expected)
  @expected = expected
end

Instance Attribute Details

#expected#match (readonly)

Returns A regular expression.

Returns:

  • (#match)

    A regular expression.


7
8
9
# File 'lib/matchi/match.rb', line 7

def expected
  @expected
end

Instance Method Details

#inspectObject

A string containing a human-readable representation of the matcher.


40
41
42
# File 'lib/matchi/match.rb', line 40

def inspect
  "#{self.class}(#{expected.inspect})"
end

#matches?Boolean

Boolean comparison between the actual value and the expected value.

Examples:

require "matchi/match"

matcher = Matchi::Match.new(/^foo$/)

matcher.expected           # => /^foo$/
matcher.matches? { "foo" } # => true

Yield Returns:

  • (#object_id)

    The actual value to compare to the expected one.

Returns:

  • (Boolean)

    Comparison between actual and expected values.


35
36
37
# File 'lib/matchi/match.rb', line 35

def matches?
  expected.match?(yield)
end

#to_sObject

Returns a string representing the matcher.


45
46
47
# File 'lib/matchi/match.rb', line 45

def to_s
  "match #{expected.inspect}"
end