rspec-rails 1.3.2 → 6.1.2

data/lib/rspec/rails/matchers/action_cable/have_broadcasted_to.rb

@@ -0,0 +1,173 @@
+module RSpec
+  module Rails
+    module Matchers
+      module ActionCable
+        # rubocop: disable Metrics/ClassLength
+        # @private
+        class HaveBroadcastedTo < RSpec::Matchers::BuiltIn::BaseMatcher
+          def initialize(target, channel:)
+            @target = target
+            @channel = channel
+            @block = proc { }
+            @data = nil
+            set_expected_number(:exactly, 1)
+          end
+
+          def with(data = nil, &block)
+            @data = data
+            @data = @data.with_indifferent_access if @data.is_a?(Hash)
+            @block = block if block
+            self
+          end
+
+          def exactly(count)
+            set_expected_number(:exactly, count)
+            self
+          end
+
+          def at_least(count)
+            set_expected_number(:at_least, count)
+            self
+          end
+
+          def at_most(count)
+            set_expected_number(:at_most, count)
+            self
+          end
+
+          def times
+            self
+          end
+
+          def once
+            exactly(:once)
+          end
+
+          def twice
+            exactly(:twice)
+          end
+
+          def thrice
+            exactly(:thrice)
+          end
+
+          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
+
+          def failure_message_when_negated
+            "expected not to broadcast #{base_message}"
+          end
+
+          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
+
+          def supports_block_expectations?
+            true
+          end
+
+          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
+
+          def from_channel(channel)
+            @channel = channel
+            self
+          end
+
+        private
+
+          def stream
+            @stream ||= case @target
+                        when String
+                          @target
+                        when Symbol
+                          @target.to_s
+                        else
+                          check_channel_presence
+                          @channel.broadcasting_for(@target)
+                        end
+          end
+
+          def check(messages)
+            @matching_msgs, @unmatching_msgs = messages.partition do |msg|
+              decoded = ActiveSupport::JSON.decode(msg)
+              decoded = decoded.with_indifferent_access if decoded.is_a?(Hash)
+
+              if @data.nil? || values_match?(@data, decoded)
+                @block.call(decoded)
+                true
+              else
+                false
+              end
+            end
+
+            @matching_msgs_count = @matching_msgs.size
+
+            case @expectation_type
+            when :exactly then @expected_number == @matching_msgs_count
+            when :at_most then @expected_number >= @matching_msgs_count
+            when :at_least then @expected_number <= @matching_msgs_count
+            end
+          end
+
+          def set_expected_number(relativity, count)
+            @expectation_type = relativity
+            @expected_number =
+              case count
+              when :once then 1
+              when :twice then 2
+              when :thrice then 3
+              else Integer(count)
+              end
+          end
+
+          def base_message
+            "#{message_expectation_modifier} #{@expected_number} messages to #{stream}".tap do |msg|
+              msg << " with #{data_description(@data)}" unless @data.nil?
+              msg << ", but broadcast #{@matching_msgs_count}"
+            end
+          end
+
+          def data_description(data)
+            if data.is_a?(RSpec::Matchers::Composable)
+              data.description
+            else
+              data
+            end
+          end
+
+          def pubsub_adapter
+            ::ActionCable.server.pubsub
+          end
+
+          def check_channel_presence
+            return if @channel.present? && @channel.respond_to?(:channel_name)
+
+            error_msg = "Broadcasting channel can't be inferred. Please, specify it with `from_channel`"
+            raise ArgumentError, error_msg
+          end
+        end
+        # rubocop: enable Metrics/ClassLength
+      end
+    end
+  end
+end

data/lib/rspec/rails/matchers/action_cable/have_streams.rb

@@ -0,0 +1,58 @@
+module RSpec
+  module Rails
+    module Matchers
+      module ActionCable
+        # @api private
+        # Provides the implementation for `have_stream`, `have_stream_for`, and `have_stream_from`.
+        # Not intended to be instantiated directly.
+        class HaveStream < RSpec::Matchers::BuiltIn::BaseMatcher
+          # @api private
+          # @return [String]
+          def failure_message
+            "expected to have #{base_message}"
+          end
+
+          # @api private
+          # @return [String]
+          def failure_message_when_negated
+            "expected not to have #{base_message}"
+          end
+
+          # @api private
+          # @return [Boolean]
+          def matches?(subscription)
+            raise(ArgumentError, "have_streams is used for negated expectations only") if no_expected?
+
+            match(subscription)
+          end
+
+          # @api private
+          # @return [Boolean]
+          def does_not_match?(subscription)
+            !match(subscription)
+          end
+
+        private
+
+          def match(subscription)
+            case subscription
+            when ::ActionCable::Channel::Base
+              @actual = subscription.streams
+              no_expected? ? actual.any? : actual.any? { |i| expected === i }
+            else
+              raise ArgumentError, "have_stream, have_stream_from and have_stream_from support expectations on subscription only"
+            end
+          end
+
+          def base_message
+            no_expected? ? "any stream started" : "stream #{expected_formatted} started, but have #{actual_formatted}"
+          end
+
+          def no_expected?
+            !defined?(@expected)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/rspec/rails/matchers/action_cable.rb

@@ -0,0 +1,65 @@
+require "rspec/rails/matchers/action_cable/have_broadcasted_to"
+
+module RSpec
+  module Rails
+    module Matchers
+      # Namespace for various implementations of ActionCable features
+      #
+      # @api private
+      module ActionCable
+      end
+
+      # @api public
+      # Passes if a message has been sent to a stream/object inside a block.
+      # May chain `at_least`, `at_most` or `exactly` to specify a number of times.
+      # To specify channel from which message has been broadcasted to object use `from_channel`.
+      #
+      #
+      # @example
+      #     expect {
+      #       ActionCable.server.broadcast "messages", text: 'Hi!'
+      #     }.to have_broadcasted_to("messages")
+      #
+      #     expect {
+      #       SomeChannel.broadcast_to(user)
+      #     }.to have_broadcasted_to(user).from_channel(SomeChannel)
+      #
+      #     # Using alias
+      #     expect {
+      #       ActionCable.server.broadcast "messages", text: 'Hi!'
+      #     }.to broadcast_to("messages")
+      #
+      #     expect {
+      #       ActionCable.server.broadcast "messages", text: 'Hi!'
+      #       ActionCable.server.broadcast "all", text: 'Hi!'
+      #     }.to have_broadcasted_to("messages").exactly(:once)
+      #
+      #     expect {
+      #       3.times { ActionCable.server.broadcast "messages", text: 'Hi!' }
+      #     }.to have_broadcasted_to("messages").at_least(2).times
+      #
+      #     expect {
+      #       ActionCable.server.broadcast "messages", text: 'Hi!'
+      #     }.to have_broadcasted_to("messages").at_most(:twice)
+      #
+      #     expect {
+      #       ActionCable.server.broadcast "messages", text: 'Hi!'
+      #     }.to have_broadcasted_to("messages").with(text: 'Hi!')
+      def have_broadcasted_to(target = nil)
+        check_action_cable_adapter
+
+        ActionCable::HaveBroadcastedTo.new(target, channel: described_class)
+      end
+      alias_method :broadcast_to, :have_broadcasted_to
+
+    private
+
+      # @private
+      def check_action_cable_adapter
+        return if ::ActionCable::SubscriptionAdapter::Test === ::ActionCable.server.pubsub
+
+        raise StandardError, "To use ActionCable matchers set `adapter: test` in your cable.yml"
+      end
+    end
+  end
+end

data/lib/rspec/rails/matchers/action_mailbox.rb

@@ -0,0 +1,73 @@
+module RSpec
+  module Rails
+    module Matchers
+      # Namespace for various implementations of ActionMailbox features
+      #
+      # @api private
+      module ActionMailbox
+        # @private
+        class Base < RSpec::Rails::Matchers::BaseMatcher
+          private
+
+          def create_inbound_email(message)
+            RSpec::Rails::MailboxExampleGroup.create_inbound_email(message)
+          end
+        end
+
+        # @private
+        class ReceiveInboundEmail < Base
+          def initialize(message)
+            super()
+
+            @inbound_email = create_inbound_email(message)
+          end
+
+          if defined?(::ApplicationMailbox) && ::ApplicationMailbox.router.respond_to?(:mailbox_for)
+            def matches?(mailbox)
+              @mailbox  = mailbox
+              @receiver = ApplicationMailbox.router.mailbox_for(inbound_email)
+
+              @receiver == @mailbox
+            end
+          else
+            def matches?(mailbox)
+              @mailbox  = mailbox
+              @receiver = ApplicationMailbox.router.send(:match_to_mailbox, inbound_email)
+
+              @receiver == @mailbox
+            end
+          end
+
+          def failure_message
+            "expected #{describe_inbound_email} to route to #{mailbox}".tap do |msg|
+              if receiver
+                msg << ", but routed to #{receiver} instead"
+              end
+            end
+          end
+
+          def failure_message_when_negated
+            "expected #{describe_inbound_email} not to route to #{mailbox}"
+          end
+
+          private
+
+          attr_reader :inbound_email, :mailbox, :receiver
+
+          def describe_inbound_email
+            "mail to #{inbound_email.mail.to.to_sentence}"
+          end
+        end
+      end
+
+      # @api public
+      # Passes if the given inbound email would be routed to the subject inbox.
+      #
+      # @param message [Hash, Mail::Message] a mail message or hash of
+      #   attributes used to build one
+      def receive_inbound_email(message)
+        ActionMailbox::ReceiveInboundEmail.new(message)
+      end
+    end
+  end
+end