stimulus_reflex_testing 0.2.2 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b56ef411f6fb1022d9bdf542269eef6b3126e97366c5fbdea25105768a32718b
-  data.tar.gz: 41fe7e27a5c7278b14180780d436a490493dd856862804e5973cd187c39d60fa
+  metadata.gz: ced61b97b3236cd9b8a700e22d4e2dd4f10d2f73dc22fdc2caa330b28ea3902e
+  data.tar.gz: 7a76197b1367354a4ebe5744845617102f4250269a7949f01909a9551340a1b6
 SHA512:
-  metadata.gz: 2067450d8b6acdfa738b52254f0d68af93c4beffba9cbf43f4696500b1dd1491432a91af13f5fb2abf01b0d36849253f704113e3287871c59e7e256d97b5656d
-  data.tar.gz: a047b2f4ba93d0c34584eafba3f68bb11bf8b1608665a6d40e444c02253eb7b77f41a240a06f3758809e8691d36dc9063d234a117f17724d31666e02940d9b30
+  metadata.gz: e6843170c7b98f8164971420c40e2b02cda726811e3eb268bcb29570aa597cbf3951a0c56a0b44453ba40ba3bf6fdaf9167fd738afebc63b55d4d78dadbca160
+  data.tar.gz: 435de1ea895aebc7e8cc7a859a2023c61aa26cb1a932b98e2bced24c418546c6db0ff2cfa7e29e35002ec52e2e1c18d57e7ee3af83e6e3f472dc3556324bb030

data/README.md

@@ -18,7 +18,7 @@ Things we'd like to add/improve on:
 Add this line to your application's Gemfile:
 
 ```ruby
-gem 'stimulus_reflex_testing', require: false
+gem 'stimulus_reflex_testing'
 ```
 
 ### Using 5.2 or below? Or using a version of RSpec Rails lower than 4?
@@ -26,7 +26,7 @@ gem 'stimulus_reflex_testing', require: false
 Both Rails 6 and RSpec Rails 4 introduce the `action-cable-testing` library. If you're using Rails 5.2 and a version of RSpec Rails lower than 4, include the `action-cable-testing` gem in your Gemfile.
 
 ```ruby
-gem 'stimulus_reflex_testing', require: false
+gem 'stimulus_reflex_testing'
 gem 'action-cable-testing'
 ```
 
@@ -36,12 +36,6 @@ And then execute:
 
 ### RSpec instructions
 
-Require the library into your `rails_helper`:
-
-```ruby
-require 'stimulus_reflex_testing/rspec'
-```
-
 Rspec tests include the reflex testing functionality when `type: :reflex` is provided. If this type is not provided, your Reflex tests won't work.
 
 ## Usage
@@ -98,6 +92,108 @@ reflex.run(:find_post)
 reflex.get(:post) #=> returns the @post instance variable
 ```
 
+## Matchers
+
+### `morph(selector)`
+
+You can assert that a "run" reflex morphed as you expected:
+
+```ruby
+# app/reflexes/post_reflex.rb
+class PostReflex < ApplicationReflex
+  def delete
+    @post = Post.find(params[:id])
+    @post.destroy
+    morph dom_id(@post), ""
+  end
+end
+
+# spec/reflexes/post_reflex_spec.rb
+require 'rails_helper'
+
+RSpec.describe PostReflex, type: :reflex do
+  let(:post) { create(:post) }
+  let(:reflex) { build_reflex }
+
+  describe '#delete' do
+    it 'morphs the post' do
+      subject = reflex.run(:delete)
+      expect(subject).to morph("#post_#{post.id}")
+    end
+  end
+end
+```
+
+You can also assert the content you provided to morph:
+
+```ruby
+# spec/reflexes/post_reflex_spec.rb
+require 'rails_helper'
+
+RSpec.describe PostReflex, type: :reflex do
+  let(:post) { create(:post) }
+  let(:reflex) { build_reflex }
+
+  describe '#delete' do
+    it 'morphs the post with an empty string' do
+      subject = reflex.run(:delete)
+      expect(subject).to morph("#post_#{post.id}").with("")
+    end
+  end
+end
+```
+
+You can also run the expecation as a block:
+
+```ruby
+# spec/reflexes/post_reflex_spec.rb
+require 'rails_helper'
+
+RSpec.describe PostReflex, type: :reflex do
+  let(:post) { create(:post) }
+  let(:reflex) { build_reflex }
+
+  describe '#delete' do
+    it 'morphs the post with an empty string' do
+      expect { reflex.run(:delete) }.to morph("#post_#{post.id}").with("")
+    end
+  end
+end
+```
+
+### `broadcast(operations)` (Experimental)
+
+You can assert that a reflex will perform the CableReady operations you anticipate:
+
+```ruby
+# app/reflexes/post_reflex.rb
+class PostReflex < ApplicationReflex
+  def delete
+    @post = Post.find(params[:id])
+    @post.destroy
+    cable_ready[PostsChannel].remove(selector: dom_id(@post)).broadcast
+  end
+end
+
+# spec/reflexes/post_reflex_spec.rb
+require 'rails_helper'
+
+RSpec.describe PostReflex, type: :reflex do
+  let(:post) { create(:post) }
+  let(:reflex) { build_reflex }
+
+  describe '#delete' do
+    it 'broadcasts the CableReady operations' do
+      expect { reflex.run(:delete) }.to broadcast(:remove, :broadcast)
+    end
+
+    it 'removes the post' do
+      expect { reflex.run(:delete) }.to broadcast(remove: { selector: "#post_#{post.id}" }, broadcast: nil)
+    end
+  end
+end
+```
+
 ## RSpec example
 
 ```ruby
@@ -124,11 +220,11 @@ RSpec.describe PostReflex, type: :reflex do
       subject
     end
 
-    it 'should find the post' do
+    it 'finds the post' do
       expect(reflex.get(:post)).to eq(post)
     end
 
-    it 'should validate the post' do
+    it 'validates the post' do
       expect(reflex.get(:post).errors).to be_present
     end
   end

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

@@ -9,3 +9,82 @@ RSpec::Matchers.define :have_set do |instance_variable, expected_value|
     "set #{instance_variable} to #{expected_value}, got #{actual.get(instance_variable)}"
   end
 end
+
+RSpec::Matchers.define :broadcast do |**broadcasts|
+  match do |block|
+    fable_ready = StimulusReflex::TestReflexPatches::FableReady.new
+
+    allow_any_instance_of(StimulusReflex::CableReadyChannels).to(
+      receive(:[]).and_return(fable_ready)
+    )
+
+    broadcasts.each do |broadcast|
+      if broadcast.is_a?(Array)
+        if broadcast[1].present?
+          expect(fable_ready).to receive(broadcast[0]).with(broadcast[1]).and_return(fable_ready)
+        else
+          expect(fable_ready).to receive(broadcast[0]).and_return(fable_ready)
+        end
+      else
+        expect(fable_ready).to receive(broadcast).and_return(fable_ready)
+      end
+    end
+
+    block.call
+
+    RSpec::Mocks.verify
+  end
+
+  def supports_block_expectations?
+    true
+  end
+end
+
+RSpec::Matchers.define :morph do |selector|
+  match do |morphs|
+    if morphs.is_a?(StimulusReflex::NothingBroadcaster)
+      return selector.to_s == "nothing"
+    end
+
+    morph = matching_morph(morphs, selector)
+
+    if morph.present? && @with_chain_called
+      @content == morph[1]
+    else
+      morph
+    end
+  end
+
+  description do |morphs|
+    morph = matching_morph(morphs, selector)
+
+    if @with_chain_called
+      if !morph
+        "morph #{selector} but a morph for that selector was not run"
+      else
+        "morph #{selector} with #{@content} but the value was: #{morph[1]}"
+      end
+    else
+      "morph #{selector} but a morph for that selector was not run"
+    end
+  end
+
+  chain :with do |content|
+    @with_chain_called = true
+    @content = content
+  end
+
+  def supports_block_expectations?
+    true
+  end
+
+  def matching_morph(morphs, selector)
+    if morphs.respond_to?(:call)
+      morphs.call.find { |morph| morph[0] == selector }
+    else
+      morphs.find { |morph| morph[0] == selector }
+    end
+  end
+
+  diffable
+end

data/lib/stimulus_reflex/test_reflex_patches.rb

@@ -17,7 +17,7 @@ module StimulusReflex::TestReflexPatches
     end
 
     def method_missing(*)
-      true || super
+      self
     end
 
     def respond_to_missing?(*)

data/lib/stimulus_reflex_testing/version.rb

@@ -1,3 +1,3 @@
 module StimulusReflexTesting
-  VERSION = "0.2.2"
+  VERSION = "0.3.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: stimulus_reflex_testing
 version: !ruby/object:Gem::Version
-  version: 0.2.2
+  version: 0.3.0
 platform: ruby
 authors:
 - Jason Charnes
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2021-02-01 00:00:00.000000000 Z
+date: 2021-02-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: stimulus_reflex