cable-ready-testing 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b752cd35388baa27b97647d9620422a89aa96ef8785617f2b3e33e5d0cd40c94
-  data.tar.gz: 86654e8f6cc38912d7d2b9d6153c55cf45c321a2512902af981986ee14028eb2
+  metadata.gz: a02948deb7ad8a23d9cfd305f1828a3761b2610f20dcffe399b2b298a0a40d38
+  data.tar.gz: 78cfe150e631d5813da6443e49745dd094de05588310200d3c62d53e2da35634
 SHA512:
-  metadata.gz: 93786abac4782aa9bd4b9ce5b1920a18b60eedddbddc97cb32ad304d72c9971d9211cd057323f7c743c1370b914dedc8b31c43b6211bb4be302292ace3ed53ca
-  data.tar.gz: 056b2f6bb38f0204354ffaef64d46d1d73440a6ea14b76ca6e70e0c4bd49026f541d4664215648a1e62b09bdad4bbbe54f07c6c1207645d9a41304f9482e981d
+  metadata.gz: 8c1da3ea6327f12a27d724b5487c0e861cfe5761a4d66ea86f7e277750ec18d699bf4f02202fae3063fd089c7653ea2db9d8cd37cbdcf62ead5f0c4d5231c9db
+  data.tar.gz: 8048d3554eb6f2f00001daf251948375c066fe0f5ed8b7894f8b75631ebd764705fcf3a056e65c80edbe152c2d8b822c0dfd05fa3950ff3c9ff593648d626c3a

data/lib/cable-ready-testing.rb

@@ -0,0 +1,3 @@
+# frozen_string_literal: true
+
+require 'cable_ready/testing'

data/lib/cable_ready/testing.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+require 'cable_ready/testing/version'
+
+require 'cable_ready'

data/lib/cable_ready/testing/rspec.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+require 'cable-ready-testing'
+require 'rspec/rails'
+require 'rspec/rails/matchers/cable_ready'

data/lib/cable_ready/testing/version.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module CableReady
+  module Testing
+    VERSION = '0.0.2'
+  end
+end

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

@@ -0,0 +1,42 @@
+# frozen_string_literal: true
+
+require 'rspec/rails/matchers/cable_ready/mutated_element'
+
+module RSpec
+  module Rails
+    module Matchers
+      # Namespace for various implementations of CableReady features
+      #
+      # @api private
+      module CableReady
+      end
+
+      # @api public
+      # Passes if a message has been sent to a stream/object inside a block.
+      # To specify channel from which message has been broadcasted to object use `on_channel`.
+      #
+      #
+      # @example
+      #     expect {
+      #       cable_ready['channel'].outer_html(
+      #         selector: '#content',
+      #         html: 'some html'
+      #       )
+      #
+      #       cable_ready.broadcast
+      #     }.to mutated_element('#content')
+      #      .on_channel('channel')
+      #      .with(:outer_html, { 'html' => 'some html' })
+      #
+      #
+
+      def mutated_element(target = nil)
+        CableReady::MutatedElement.new(target)
+      end
+
+      %i[mutated_attribute mutated_css_class mutated_dataset mutated_style].each do |alt_method|
+        alias_method alt_method, :mutated_element
+      end
+    end
+  end
+end

data/lib/rspec/rails/matchers/cable_ready/mutated_element.rb

@@ -0,0 +1,115 @@
+# frozen_string_literal: true
+
+module RSpec
+  module Rails
+    module Matchers
+      module CableReady
+        # @private
+        class MutatedElement < RSpec::Matchers::BuiltIn::BaseMatcher
+          def initialize(target)
+            @target = target
+            @channel_not_found = false
+            @mutation_not_found = false
+            @element_not_found = false
+          end
+
+          def with(action, data = {}, &block)
+            @data = data
+            @action = action.to_s.camelize(:lower)
+            @data = @data.with_indifferent_access if @data.is_a?(Hash)
+            @data = @data.transform_keys { |key| key.camelize(:lower) }
+            @block = block if block_given?
+            self
+          end
+
+          def on_channel(channel_name)
+            @channel_name = channel_name
+            self
+          end
+
+          def matches?(proc)
+            verify_channel_name_presence
+            verify_action_presence
+
+            proc.call
+
+            if (options = mutation_options)
+              @message_data = mutated_element_options(options)
+
+              if @message_data.present?
+                @message_data.except('selector') == @data
+              else
+                @element_not_found = true
+                false
+              end
+            elsif broadcasted_message.blank?
+              @channel_not_found = true
+              false
+            else
+              @mutation_not_found = true
+              false
+            end
+          end
+
+          def supports_block_expectations?
+            true
+          end
+
+          def failure_message
+            if @channel_not_found
+              "#{base_failure_message} but no broadcasted messages were found"
+            elsif @mutation_not_found
+              "#{base_failure_message} but no broadcasted messages with this mutation were found"
+            elsif @element_not_found
+              "#{base_failure_message} but message for given element was not found"
+            else
+              "#{base_failure_message} with #{@data} but mutated element with #{@message_data.except('selector')}"
+            end
+          end
+
+          private
+
+          def mutation_options
+            return unless broadcasted_message
+
+            broadcasted_message.dig('operations', @action)
+          end
+
+          def broadcasted_message
+            message = pubsub_adapter.broadcasts(@channel_name).first
+            return unless message
+
+            decoded = ActiveSupport::JSON.decode(message)
+            decoded.with_indifferent_access if decoded.is_a?(Hash)
+          end
+
+          def verify_action_presence
+            return if @action.present?
+
+            message = 'Please specify the type of element mutation using .with(type_of_mutation, options)'
+            raise ArgumentError, message
+          end
+
+          def verify_channel_name_presence
+            return if @channel_name.present?
+
+            message = 'Please specify the channel using .on_channel'
+            raise ArgumentError, message
+          end
+
+          def base_failure_message
+            "expected to mutate element `#{@target}` on channel #{@channel_name}"
+          end
+
+          def pubsub_adapter
+            ::ActionCable.server.pubsub
+          end
+
+          def mutated_element_options(values)
+            values.flatten.find { |el| el['selector'] == @target }
+          end
+        end
+      end
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: cable-ready-testing
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - Paweł Dąbrowski
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-07-23 00:00:00.000000000 Z
+date: 2020-07-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: actioncable
@@ -72,12 +72,18 @@ email:
 executables: []
 extensions: []
 extra_rdoc_files: []
-files: []
+files:
+- lib/cable-ready-testing.rb
+- lib/cable_ready/testing.rb
+- lib/cable_ready/testing/rspec.rb
+- lib/cable_ready/testing/version.rb
+- lib/rspec/rails/matchers/cable_ready.rb
+- lib/rspec/rails/matchers/cable_ready/mutated_element.rb
 homepage: http://github.com/pdabrowski6/cable-ready-testing
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -93,7 +99,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubygems_version: 3.0.8
-signing_key: 
+signing_key:
 specification_version: 4
 summary: Testing utils for Cable Ready
 test_files: []