Class: Matchi::Match

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

Overview

*Regular expressions* matcher.

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.



14
15
16
 
# File 'lib/matchi/match.rb', line 14

def initialize(expected)
  @expected = expected
end

Instance Method Details

#inspect ⇒ Object

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



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

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.matches? { "foo" } # => true

Yield Returns:

  • (#object_id) —

    The actual value to compare to the expected one.

Returns:

  • (Boolean) —

    Comparison between actual and expected values.



30
31
32
 
# File 'lib/matchi/match.rb', line 30

def matches?(*, **)
  @expected.match?(yield)
end

#to_s ⇒ Object

Returns a string representing the matcher.



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

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