Class: RSpec::Rails::Matchers::ActionCable::HaveBroadcastedTo Private

Inherits:
Matchers::BuiltIn::BaseMatcher
  • Object
show all
Defined in:
lib/rspec/rails/matchers/action_cable.rb

Overview

This class is part of a private API. You should avoid using this class if possible, as it may be removed or be changed in the future.

rubocop: disable Style/ClassLength

Instance Method Summary collapse

Constructor Details

#initialize(stream) ⇒ HaveBroadcastedTo

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Returns a new instance of HaveBroadcastedTo.



13
14
15
16
17
 
# File 'lib/rspec/rails/matchers/action_cable.rb', line 13

def initialize(stream)
  @stream = stream
  @block = Proc.new {}
  set_expected_number(:exactly, 1)
end

Instance Method Details

#at_least(count) ⇒ Object

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future. 



31
32
33
34
 
# File 'lib/rspec/rails/matchers/action_cable.rb', line 31

def at_least(count)
  set_expected_number(:at_least, count)
  self
end

#at_most(count) ⇒ Object

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future. 



36
37
38
39
 
# File 'lib/rspec/rails/matchers/action_cable.rb', line 36

def at_most(count)
  set_expected_number(:at_most, count)
  self
end

#exactly(count) ⇒ Object

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future. 



26
27
28
29
 
# File 'lib/rspec/rails/matchers/action_cable.rb', line 26

def exactly(count)
  set_expected_number(:exactly, count)
  self
end

#failure_message ⇒ Object

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future. 



57
58
59
60
61
62
63
64
65
66
 
# File 'lib/rspec/rails/matchers/action_cable.rb', line 57

def failure_message
  "expected to broadcast #{base_message}".tap do |msg|
    if @unmatching_msgs.any?
      msg << "\nBroadcasted messages to #{@stream}:"
      @unmatching_msgs.each do |data|
        msg << "\n  #{data}"
      end
    end
  end
end

#failure_message_when_negated ⇒ Object

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future. 



68
69
70
 
# File 'lib/rspec/rails/matchers/action_cable.rb', line 68

def failure_message_when_negated
  "expected not to broadcast #{base_message}"
end

#matches?(proc) ⇒ Boolean

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Raises:

  • (ArgumentError) 


84
85
86
87
88
89
90
91
92
 
# File 'lib/rspec/rails/matchers/action_cable.rb', line 84

def matches?(proc)
  raise ArgumentError, "have_broadcasted_to and broadcast_to only support block expectations" unless Proc === proc

  original_sent_messages_count = pubsub_adapter.broadcasts(@stream).size
  proc.call
  in_block_messages = pubsub_adapter.broadcasts(@stream).drop(original_sent_messages_count)

  check(in_block_messages)
end

#message_expectation_modifier ⇒ Object

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future. 



72
73
74
75
76
77
78
 
# File 'lib/rspec/rails/matchers/action_cable.rb', line 72

def message_expectation_modifier
  case @expectation_type
  when :exactly then "exactly"
  when :at_most then "at most"
  when :at_least then "at least"
  end
end

#once ⇒ Object

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future. 



45
46
47
 
# File 'lib/rspec/rails/matchers/action_cable.rb', line 45

def once
  exactly(:once)
end

#supports_block_expectations? ⇒ Boolean

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future. 



80
81
82
 
# File 'lib/rspec/rails/matchers/action_cable.rb', line 80

def supports_block_expectations?
  true
end

#thrice ⇒ Object

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future. 



53
54
55
 
# File 'lib/rspec/rails/matchers/action_cable.rb', line 53

def thrice
  exactly(:thrice)
end

#times ⇒ Object

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future. 



41
42
43
 
# File 'lib/rspec/rails/matchers/action_cable.rb', line 41

def times
  self
end

#twice ⇒ Object

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future. 



49
50
51
 
# File 'lib/rspec/rails/matchers/action_cable.rb', line 49

def twice
  exactly(:twice)
end

#with(data = nil) ⇒ Object

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future. 



19
20
21
22
23
24
 
# File 'lib/rspec/rails/matchers/action_cable.rb', line 19

def with(data = nil)
  @data = data
  @data = @data.with_indifferent_access if @data.is_a?(Hash)
  @block = Proc.new if block_given?
  self
end