Class: Spec::Matchers::Have

Inherits:
Object show all
Defined in:
lib/vendor/plugins/rspec/lib/spec/matchers/have.rb,
lib/vendor/plugins/rspec-rails/lib/spec/rails/extensions/spec/matchers/have.rb

Overview

:nodoc:

Instance Method Summary collapse

Constructor Details

#initialize(expected, relativity = :exactly) ⇒ Have

Returns a new instance of Have.



4
5
6
7
8
 
# File 'lib/vendor/plugins/rspec/lib/spec/matchers/have.rb', line 4

def initialize(expected, relativity=:exactly)
  @expected = (expected == :no ? 0 : expected)
  @relativity = relativity
  @actual = nil
end

Dynamic Method Handling

This class handles dynamic methods through the method_missing method

#method_missing(sym, *args, &block) ⇒ Object (private) 



76
77
78
79
80
81
82
83
84
 
# File 'lib/vendor/plugins/rspec/lib/spec/matchers/have.rb', line 76

def method_missing(sym, *args, &block)
  @collection_name = sym
  if inflector = (defined?(ActiveSupport::Inflector) ? ActiveSupport::Inflector : (defined?(Inflector) ? Inflector : nil))
    @plural_collection_name = inflector.pluralize(sym.to_s)
  end
  @args = args
  @block = block
  self
end

Instance Method Details

#description ⇒ Object 



66
67
68
 
# File 'lib/vendor/plugins/rspec/lib/spec/matchers/have.rb', line 66

def description
  "have #{relative_expectation} #{@collection_name}"
end

#description_with_errors_on_extensions ⇒ Object 



14
15
16
17
18
 
# File 'lib/vendor/plugins/rspec-rails/lib/spec/rails/extensions/spec/matchers/have.rb', line 14

def description_with_errors_on_extensions
  return "have #{relativities[@relativity]}#{@expected} errors on :#{@args[0]}" if @collection_name == :errors_on
  return "have #{relativities[@relativity]}#{@expected} error on :#{@args[0]}"  if @collection_name == :error_on
  return description_without_errors_on_extensions
end

#failure_message_for_should ⇒ Object 



40
41
42
 
# File 'lib/vendor/plugins/rspec/lib/spec/matchers/have.rb', line 40

def failure_message_for_should
  "expected #{relative_expectation} #{@collection_name}, got #{@actual}"
end

#failure_message_for_should_not ⇒ Object 



44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
 
# File 'lib/vendor/plugins/rspec/lib/spec/matchers/have.rb', line 44

def failure_message_for_should_not
  if @relativity == :exactly
    return "expected target not to have #{@expected} #{@collection_name}, got #{@actual}"
  elsif @relativity == :at_most
    return <<-EOF
Isn't life confusing enough?
Instead of having to figure out the meaning of this:
  should_not have_at_most(#{@expected}).#{@collection_name}
We recommend that you use this instead:
  should have_at_least(#{@expected + 1}).#{@collection_name}
EOF
  elsif @relativity == :at_least
    return <<-EOF
Isn't life confusing enough?
Instead of having to figure out the meaning of this:
  should_not have_at_least(#{@expected}).#{@collection_name}
We recommend that you use this instead:
  should have_at_most(#{@expected - 1}).#{@collection_name}
EOF
  end
end

#failure_message_for_should_with_errors_on_extensions ⇒ Object 



7
8
9
10
11
 
# File 'lib/vendor/plugins/rspec-rails/lib/spec/rails/extensions/spec/matchers/have.rb', line 7

def failure_message_for_should_with_errors_on_extensions
  return "expected #{relativities[@relativity]}#{@expected} errors on :#{@args[0]}, got #{@actual}" if @collection_name == :errors_on
  return "expected #{relativities[@relativity]}#{@expected} error on :#{@args[0]}, got #{@actual}"  if @collection_name == :error_on
  return failure_message_for_should_without_errors_on_extensions
end

#matches?(collection_owner) ⇒ Boolean

Returns:

  • (Boolean) 


18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
 
# File 'lib/vendor/plugins/rspec/lib/spec/matchers/have.rb', line 18

def matches?(collection_owner)
  if collection_owner.respond_to?(@collection_name)
    collection = collection_owner.__send__(@collection_name, *@args, &@block)
  elsif (@plural_collection_name && collection_owner.respond_to?(@plural_collection_name))
    collection = collection_owner.__send__(@plural_collection_name, *@args, &@block)
  elsif (collection_owner.respond_to?(:length) || collection_owner.respond_to?(:size))
    collection = collection_owner
  else
    collection_owner.__send__(@collection_name, *@args, &@block)
  end
  @actual = collection.size if collection.respond_to?(:size)
  @actual = collection.length if collection.respond_to?(:length)
  raise not_a_collection if @actual.nil?
  return @actual >= @expected if @relativity == :at_least
  return @actual <= @expected if @relativity == :at_most
  return @actual == @expected
end

#not_a_collection ⇒ Object 



36
37
38
 
# File 'lib/vendor/plugins/rspec/lib/spec/matchers/have.rb', line 36

def not_a_collection
  "expected #{@collection_name} to be a collection but it does not respond to #length or #size"
end

#relativities ⇒ Object 



10
11
12
13
14
15
16
 
# File 'lib/vendor/plugins/rspec/lib/spec/matchers/have.rb', line 10

def relativities
  @relativities ||= {
    :exactly => "",
    :at_least => "at least ",
    :at_most => "at most "
  }
end

#respond_to?(sym) ⇒ Boolean

Returns:

  • (Boolean) 


70
71
72
 
# File 'lib/vendor/plugins/rspec/lib/spec/matchers/have.rb', line 70

def respond_to?(sym)
  @expected.respond_to?(sym) || super
end