rspec-rails 4.0.0.beta2 → 4.0.0.beta3
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- checksums.yaml.gz.sig +0 -0
- data.tar.gz.sig +0 -0
- data/Changelog.md +105 -83
- data/README.md +1 -1
- data/lib/generators/rspec/channel/channel_generator.rb +12 -0
- data/lib/generators/rspec/channel/templates/channel_spec.rb.erb +7 -0
- data/lib/generators/rspec/controller/controller_generator.rb +11 -2
- data/lib/generators/rspec/controller/templates/routing_spec.rb +13 -0
- data/lib/generators/rspec/mailbox/mailbox_generator.rb +14 -0
- data/lib/generators/rspec/mailbox/templates/mailbox_spec.rb.erb +7 -0
- data/lib/generators/rspec/model/templates/fixtures.yml +1 -1
- data/lib/rspec/rails/configuration.rb +15 -5
- data/lib/rspec/rails/example.rb +2 -0
- data/lib/rspec/rails/example/channel_example_group.rb +93 -0
- data/lib/rspec/rails/example/feature_example_group.rb +1 -1
- data/lib/rspec/rails/example/mailbox_example_group.rb +80 -0
- data/lib/rspec/rails/example/mailer_example_group.rb +1 -1
- data/lib/rspec/rails/example/system_example_group.rb +14 -2
- data/lib/rspec/rails/example/view_example_group.rb +29 -8
- data/lib/rspec/rails/feature_check.rb +16 -0
- data/lib/rspec/rails/matchers.rb +10 -0
- data/lib/rspec/rails/matchers/action_cable.rb +65 -0
- data/lib/rspec/rails/matchers/action_cable/have_broadcasted_to.rb +170 -0
- data/lib/rspec/rails/matchers/action_cable/have_streams.rb +58 -0
- data/lib/rspec/rails/matchers/action_mailbox.rb +64 -0
- data/lib/rspec/rails/matchers/active_job.rb +16 -5
- data/lib/rspec/rails/matchers/have_enqueued_mail.rb +44 -22
- data/lib/rspec/rails/matchers/routing_matchers.rb +1 -1
- data/lib/rspec/rails/version.rb +1 -1
- metadata +15 -4
- metadata.gz.sig +0 -0
@@ -33,11 +33,27 @@ module RSpec
|
|
33
33
|
has_action_mailer? && defined?(::ActionMailer::Preview)
|
34
34
|
end
|
35
35
|
|
36
|
+
def has_action_cable_testing?
|
37
|
+
defined?(::ActionCable) && ActionCable::VERSION::MAJOR >= 6
|
38
|
+
end
|
39
|
+
|
36
40
|
def has_action_mailer_show_preview?
|
37
41
|
has_action_mailer_preview? &&
|
38
42
|
::ActionMailer::Base.respond_to?(:show_previews=)
|
39
43
|
end
|
40
44
|
|
45
|
+
def has_action_mailer_parameterized?
|
46
|
+
has_action_mailer? && defined?(::ActionMailer::Parameterized)
|
47
|
+
end
|
48
|
+
|
49
|
+
def has_action_mailer_unified_delivery?
|
50
|
+
has_action_mailer? && defined?(::ActionMailer::MailDeliveryJob)
|
51
|
+
end
|
52
|
+
|
53
|
+
def has_action_mailbox?
|
54
|
+
defined?(::ActionMailbox)
|
55
|
+
end
|
56
|
+
|
41
57
|
def has_1_9_hash_syntax?
|
42
58
|
::Rails::VERSION::STRING > '4.0'
|
43
59
|
end
|
data/lib/rspec/rails/matchers.rb
CHANGED
@@ -20,6 +20,16 @@ require 'rspec/rails/matchers/be_a_new'
|
|
20
20
|
require 'rspec/rails/matchers/relation_match_array'
|
21
21
|
require 'rspec/rails/matchers/be_valid'
|
22
22
|
require 'rspec/rails/matchers/have_http_status'
|
23
|
+
|
23
24
|
if RSpec::Rails::FeatureCheck.has_active_job?
|
24
25
|
require 'rspec/rails/matchers/active_job'
|
26
|
+
require 'rspec/rails/matchers/have_enqueued_mail'
|
27
|
+
end
|
28
|
+
|
29
|
+
if RSpec::Rails::FeatureCheck.has_action_cable_testing?
|
30
|
+
require 'rspec/rails/matchers/action_cable'
|
31
|
+
end
|
32
|
+
|
33
|
+
if RSpec::Rails::FeatureCheck.has_action_mailbox?
|
34
|
+
require 'rspec/rails/matchers/action_mailbox'
|
25
35
|
end
|
@@ -0,0 +1,65 @@
|
|
1
|
+
require "rspec/rails/matchers/action_cable/have_broadcasted_to"
|
2
|
+
|
3
|
+
module RSpec
|
4
|
+
module Rails
|
5
|
+
module Matchers
|
6
|
+
# Namespace for various implementations of ActionCable features
|
7
|
+
#
|
8
|
+
# @api private
|
9
|
+
module ActionCable
|
10
|
+
end
|
11
|
+
|
12
|
+
# @api public
|
13
|
+
# Passes if a message has been sent to a stream/object inside a block.
|
14
|
+
# May chain `at_least`, `at_most` or `exactly` to specify a number of times.
|
15
|
+
# To specify channel from which message has been broadcasted to object use `from_channel`.
|
16
|
+
#
|
17
|
+
#
|
18
|
+
# @example
|
19
|
+
# expect {
|
20
|
+
# ActionCable.server.broadcast "messages", text: 'Hi!'
|
21
|
+
# }.to have_broadcasted_to("messages")
|
22
|
+
#
|
23
|
+
# expect {
|
24
|
+
# SomeChannel.broadcast_to(user)
|
25
|
+
# }.to have_broadcasted_to(user).from_channel(SomeChannel)
|
26
|
+
#
|
27
|
+
# # Using alias
|
28
|
+
# expect {
|
29
|
+
# ActionCable.server.broadcast "messages", text: 'Hi!'
|
30
|
+
# }.to broadcast_to("messages")
|
31
|
+
#
|
32
|
+
# expect {
|
33
|
+
# ActionCable.server.broadcast "messages", text: 'Hi!'
|
34
|
+
# ActionCable.server.broadcast "all", text: 'Hi!'
|
35
|
+
# }.to have_broadcasted_to("messages").exactly(:once)
|
36
|
+
#
|
37
|
+
# expect {
|
38
|
+
# 3.times { ActionCable.server.broadcast "messages", text: 'Hi!' }
|
39
|
+
# }.to have_broadcasted_to("messages").at_least(2).times
|
40
|
+
#
|
41
|
+
# expect {
|
42
|
+
# ActionCable.server.broadcast "messages", text: 'Hi!'
|
43
|
+
# }.to have_broadcasted_to("messages").at_most(:twice)
|
44
|
+
#
|
45
|
+
# expect {
|
46
|
+
# ActionCable.server.broadcast "messages", text: 'Hi!'
|
47
|
+
# }.to have_broadcasted_to("messages").with(text: 'Hi!')
|
48
|
+
def have_broadcasted_to(target = nil)
|
49
|
+
check_action_cable_adapter
|
50
|
+
|
51
|
+
ActionCable::HaveBroadcastedTo.new(target, :channel => described_class)
|
52
|
+
end
|
53
|
+
alias_method :broadcast_to, :have_broadcasted_to
|
54
|
+
|
55
|
+
private
|
56
|
+
|
57
|
+
# @private
|
58
|
+
def check_action_cable_adapter
|
59
|
+
return if ::ActionCable::SubscriptionAdapter::Test === ::ActionCable.server.pubsub
|
60
|
+
|
61
|
+
raise StandardError, "To use ActionCable matchers set `adapter: test` in your cable.yml"
|
62
|
+
end
|
63
|
+
end
|
64
|
+
end
|
65
|
+
end
|
@@ -0,0 +1,170 @@
|
|
1
|
+
module RSpec
|
2
|
+
module Rails
|
3
|
+
module Matchers
|
4
|
+
module ActionCable
|
5
|
+
# rubocop: disable Metrics/ClassLength
|
6
|
+
# @private
|
7
|
+
class HaveBroadcastedTo < RSpec::Matchers::BuiltIn::BaseMatcher
|
8
|
+
def initialize(target, channel:)
|
9
|
+
@target = target
|
10
|
+
@channel = channel
|
11
|
+
@block = Proc.new {}
|
12
|
+
@data = nil
|
13
|
+
set_expected_number(:exactly, 1)
|
14
|
+
end
|
15
|
+
|
16
|
+
def with(data = nil)
|
17
|
+
@data = data
|
18
|
+
@data = @data.with_indifferent_access if @data.is_a?(Hash)
|
19
|
+
@block = Proc.new if block_given?
|
20
|
+
self
|
21
|
+
end
|
22
|
+
|
23
|
+
def exactly(count)
|
24
|
+
set_expected_number(:exactly, count)
|
25
|
+
self
|
26
|
+
end
|
27
|
+
|
28
|
+
def at_least(count)
|
29
|
+
set_expected_number(:at_least, count)
|
30
|
+
self
|
31
|
+
end
|
32
|
+
|
33
|
+
def at_most(count)
|
34
|
+
set_expected_number(:at_most, count)
|
35
|
+
self
|
36
|
+
end
|
37
|
+
|
38
|
+
def times
|
39
|
+
self
|
40
|
+
end
|
41
|
+
|
42
|
+
def once
|
43
|
+
exactly(:once)
|
44
|
+
end
|
45
|
+
|
46
|
+
def twice
|
47
|
+
exactly(:twice)
|
48
|
+
end
|
49
|
+
|
50
|
+
def thrice
|
51
|
+
exactly(:thrice)
|
52
|
+
end
|
53
|
+
|
54
|
+
def failure_message
|
55
|
+
"expected to broadcast #{base_message}".tap do |msg|
|
56
|
+
if @unmatching_msgs.any?
|
57
|
+
msg << "\nBroadcasted messages to #{stream}:"
|
58
|
+
@unmatching_msgs.each do |data|
|
59
|
+
msg << "\n #{data}"
|
60
|
+
end
|
61
|
+
end
|
62
|
+
end
|
63
|
+
end
|
64
|
+
|
65
|
+
def failure_message_when_negated
|
66
|
+
"expected not to broadcast #{base_message}"
|
67
|
+
end
|
68
|
+
|
69
|
+
def message_expectation_modifier
|
70
|
+
case @expectation_type
|
71
|
+
when :exactly then "exactly"
|
72
|
+
when :at_most then "at most"
|
73
|
+
when :at_least then "at least"
|
74
|
+
end
|
75
|
+
end
|
76
|
+
|
77
|
+
def supports_block_expectations?
|
78
|
+
true
|
79
|
+
end
|
80
|
+
|
81
|
+
def matches?(proc)
|
82
|
+
raise ArgumentError, "have_broadcasted_to and broadcast_to only support block expectations" unless Proc === proc
|
83
|
+
|
84
|
+
original_sent_messages_count = pubsub_adapter.broadcasts(stream).size
|
85
|
+
proc.call
|
86
|
+
in_block_messages = pubsub_adapter.broadcasts(stream).drop(original_sent_messages_count)
|
87
|
+
|
88
|
+
check(in_block_messages)
|
89
|
+
end
|
90
|
+
|
91
|
+
def from_channel(channel)
|
92
|
+
@channel = channel
|
93
|
+
self
|
94
|
+
end
|
95
|
+
|
96
|
+
private
|
97
|
+
|
98
|
+
def stream
|
99
|
+
@stream ||= if @target.is_a?(String)
|
100
|
+
@target
|
101
|
+
else
|
102
|
+
check_channel_presence
|
103
|
+
@channel.broadcasting_for(@target)
|
104
|
+
end
|
105
|
+
end
|
106
|
+
|
107
|
+
def check(messages)
|
108
|
+
@matching_msgs, @unmatching_msgs = messages.partition do |msg|
|
109
|
+
decoded = ActiveSupport::JSON.decode(msg)
|
110
|
+
decoded = decoded.with_indifferent_access if decoded.is_a?(Hash)
|
111
|
+
|
112
|
+
if @data.nil? || @data === decoded
|
113
|
+
@block.call(decoded)
|
114
|
+
true
|
115
|
+
else
|
116
|
+
false
|
117
|
+
end
|
118
|
+
end
|
119
|
+
|
120
|
+
@matching_msgs_count = @matching_msgs.size
|
121
|
+
|
122
|
+
case @expectation_type
|
123
|
+
when :exactly then @expected_number == @matching_msgs_count
|
124
|
+
when :at_most then @expected_number >= @matching_msgs_count
|
125
|
+
when :at_least then @expected_number <= @matching_msgs_count
|
126
|
+
end
|
127
|
+
end
|
128
|
+
|
129
|
+
def set_expected_number(relativity, count)
|
130
|
+
@expectation_type = relativity
|
131
|
+
@expected_number =
|
132
|
+
case count
|
133
|
+
when :once then 1
|
134
|
+
when :twice then 2
|
135
|
+
when :thrice then 3
|
136
|
+
else Integer(count)
|
137
|
+
end
|
138
|
+
end
|
139
|
+
|
140
|
+
def base_message
|
141
|
+
"#{message_expectation_modifier} #{@expected_number} messages to #{stream}".tap do |msg|
|
142
|
+
msg << " with #{data_description(@data)}" unless @data.nil?
|
143
|
+
msg << ", but broadcast #{@matching_msgs_count}"
|
144
|
+
end
|
145
|
+
end
|
146
|
+
|
147
|
+
def data_description(data)
|
148
|
+
if data.is_a?(RSpec::Matchers::Composable)
|
149
|
+
data.description
|
150
|
+
else
|
151
|
+
data
|
152
|
+
end
|
153
|
+
end
|
154
|
+
|
155
|
+
def pubsub_adapter
|
156
|
+
::ActionCable.server.pubsub
|
157
|
+
end
|
158
|
+
|
159
|
+
def check_channel_presence
|
160
|
+
return if @channel.present? && @channel.respond_to?(:channel_name)
|
161
|
+
|
162
|
+
error_msg = "Broadcasting channel can't be infered. Please, specify it with `from_channel`"
|
163
|
+
raise ArgumentError, error_msg
|
164
|
+
end
|
165
|
+
end
|
166
|
+
# rubocop: enable Metrics/ClassLength
|
167
|
+
end
|
168
|
+
end
|
169
|
+
end
|
170
|
+
end
|
@@ -0,0 +1,58 @@
|
|
1
|
+
module RSpec
|
2
|
+
module Rails
|
3
|
+
module Matchers
|
4
|
+
module ActionCable
|
5
|
+
# @api private
|
6
|
+
# Provides the implementation for `have_stream`, `have_stream_for`, and `have_stream_from`.
|
7
|
+
# Not intended to be instantiated directly.
|
8
|
+
class HaveStream < RSpec::Matchers::BuiltIn::BaseMatcher
|
9
|
+
# @api private
|
10
|
+
# @return [String]
|
11
|
+
def failure_message
|
12
|
+
"expected to have #{base_message}"
|
13
|
+
end
|
14
|
+
|
15
|
+
# @api private
|
16
|
+
# @return [String]
|
17
|
+
def failure_message_when_negated
|
18
|
+
"expected not to have #{base_message}"
|
19
|
+
end
|
20
|
+
|
21
|
+
# @api private
|
22
|
+
# @return [Boolean]
|
23
|
+
def matches?(subscription)
|
24
|
+
raise(ArgumentError, "have_streams is used for negated expectations only") if no_expected?
|
25
|
+
|
26
|
+
match(subscription)
|
27
|
+
end
|
28
|
+
|
29
|
+
# @api private
|
30
|
+
# @return [Boolean]
|
31
|
+
def does_not_match?(subscription)
|
32
|
+
!match(subscription)
|
33
|
+
end
|
34
|
+
|
35
|
+
private
|
36
|
+
|
37
|
+
def match(subscription)
|
38
|
+
case subscription
|
39
|
+
when ::ActionCable::Channel::Base
|
40
|
+
@actual = subscription.streams
|
41
|
+
no_expected? ? actual.any? : actual.any? { |i| expected === i }
|
42
|
+
else
|
43
|
+
raise ArgumentError, "have_stream, have_stream_from and have_stream_from support expectations on subscription only"
|
44
|
+
end
|
45
|
+
end
|
46
|
+
|
47
|
+
def base_message
|
48
|
+
no_expected? ? "any stream started" : "stream #{expected_formatted} started, but have #{actual_formatted}"
|
49
|
+
end
|
50
|
+
|
51
|
+
def no_expected?
|
52
|
+
!defined?(@expected)
|
53
|
+
end
|
54
|
+
end
|
55
|
+
end
|
56
|
+
end
|
57
|
+
end
|
58
|
+
end
|
@@ -0,0 +1,64 @@
|
|
1
|
+
module RSpec
|
2
|
+
module Rails
|
3
|
+
module Matchers
|
4
|
+
# Namespace for various implementations of ActionMailbox features
|
5
|
+
#
|
6
|
+
# @api private
|
7
|
+
module ActionMailbox
|
8
|
+
# @private
|
9
|
+
class Base < RSpec::Rails::Matchers::BaseMatcher
|
10
|
+
private
|
11
|
+
|
12
|
+
def create_inbound_email(message)
|
13
|
+
RSpec::Rails::MailboxExampleGroup.create_inbound_email(message)
|
14
|
+
end
|
15
|
+
end
|
16
|
+
|
17
|
+
# @private
|
18
|
+
class ReceiveInboundEmail < Base
|
19
|
+
def initialize(message)
|
20
|
+
super()
|
21
|
+
|
22
|
+
@inbound_email = create_inbound_email(message)
|
23
|
+
end
|
24
|
+
|
25
|
+
def matches?(mailbox)
|
26
|
+
@mailbox = mailbox
|
27
|
+
@receiver = ApplicationMailbox.router.send(:match_to_mailbox, inbound_email)
|
28
|
+
|
29
|
+
@receiver == @mailbox
|
30
|
+
end
|
31
|
+
|
32
|
+
def failure_message
|
33
|
+
"expected #{describe_inbound_email} to route to #{mailbox}".tap do |msg|
|
34
|
+
if receiver
|
35
|
+
msg << ", but routed to #{receiver} instead"
|
36
|
+
end
|
37
|
+
end
|
38
|
+
end
|
39
|
+
|
40
|
+
def failure_message_when_negated
|
41
|
+
"expected #{describe_inbound_email} not to route to #{mailbox}"
|
42
|
+
end
|
43
|
+
|
44
|
+
private
|
45
|
+
|
46
|
+
attr_reader :inbound_email, :mailbox, :receiver
|
47
|
+
|
48
|
+
def describe_inbound_email
|
49
|
+
"mail to #{inbound_email.mail.to.to_sentence}"
|
50
|
+
end
|
51
|
+
end
|
52
|
+
end
|
53
|
+
|
54
|
+
# @api public
|
55
|
+
# Passes if the given inbound email would be routed to the subject inbox.
|
56
|
+
#
|
57
|
+
# @param message [Hash, Mail::Message] a mail message or hash of
|
58
|
+
# attributes used to build one
|
59
|
+
def receive_inbound_email(message)
|
60
|
+
ActionMailbox::ReceiveInboundEmail.new(message)
|
61
|
+
end
|
62
|
+
end
|
63
|
+
end
|
64
|
+
end
|
@@ -8,7 +8,7 @@ module RSpec
|
|
8
8
|
#
|
9
9
|
# @api private
|
10
10
|
module ActiveJob
|
11
|
-
# rubocop: disable
|
11
|
+
# rubocop: disable Metrics/ClassLength
|
12
12
|
# @private
|
13
13
|
class Base < RSpec::Rails::Matchers::BaseMatcher
|
14
14
|
def initialize
|
@@ -97,7 +97,7 @@ module RSpec
|
|
97
97
|
|
98
98
|
def check(jobs)
|
99
99
|
@matching_jobs, @unmatching_jobs = jobs.partition do |job|
|
100
|
-
if arguments_match?(job) && other_attributes_match?(job)
|
100
|
+
if job_match?(job) && arguments_match?(job) && other_attributes_match?(job)
|
101
101
|
args = deserialize_arguments(job)
|
102
102
|
@block.call(*args)
|
103
103
|
true
|
@@ -134,10 +134,15 @@ module RSpec
|
|
134
134
|
end
|
135
135
|
end
|
136
136
|
|
137
|
+
def job_match?(job)
|
138
|
+
@job ? @job == job[:job] : true
|
139
|
+
end
|
140
|
+
|
137
141
|
def arguments_match?(job)
|
138
142
|
if @args.any?
|
143
|
+
args = serialize_and_deserialize_arguments(@args)
|
139
144
|
deserialized_args = deserialize_arguments(job)
|
140
|
-
RSpec::Mocks::ArgumentListMatcher.new(
|
145
|
+
RSpec::Mocks::ArgumentListMatcher.new(*args).args_match?(*deserialized_args)
|
141
146
|
else
|
142
147
|
true
|
143
148
|
end
|
@@ -151,7 +156,6 @@ module RSpec
|
|
151
156
|
{}.tap do |attributes|
|
152
157
|
attributes[:at] = serialized_at if @at
|
153
158
|
attributes[:queue] = @queue if @queue
|
154
|
-
attributes[:job] = @job if @job
|
155
159
|
end
|
156
160
|
end
|
157
161
|
|
@@ -169,6 +173,13 @@ module RSpec
|
|
169
173
|
end
|
170
174
|
end
|
171
175
|
|
176
|
+
def serialize_and_deserialize_arguments(args)
|
177
|
+
serialized = ::ActiveJob::Arguments.serialize(args)
|
178
|
+
::ActiveJob::Arguments.deserialize(serialized)
|
179
|
+
rescue ::ActiveJob::SerializationError
|
180
|
+
args
|
181
|
+
end
|
182
|
+
|
172
183
|
def deserialize_arguments(job)
|
173
184
|
::ActiveJob::Arguments.deserialize(job[:args])
|
174
185
|
rescue ::ActiveJob::DeserializationError
|
@@ -179,7 +190,7 @@ module RSpec
|
|
179
190
|
::ActiveJob::Base.queue_adapter
|
180
191
|
end
|
181
192
|
end
|
182
|
-
# rubocop: enable
|
193
|
+
# rubocop: enable Metrics/ClassLength
|
183
194
|
|
184
195
|
# @private
|
185
196
|
class HaveEnqueuedJob < Base
|