slack_message 1.8.0 → 1.8.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 455886af2c6e775c37db510da7d5003abd131711107e9a18af2e10a714f9c154
-  data.tar.gz: '029d322491f3e63df60cd61eb2c6528132cce722a4ca0fa2db47fd790702fa04'
+  metadata.gz: 94e7433c5374c318cd955ad43f6a02705b62876498253c4e7587a7ba5ae5277f
+  data.tar.gz: 0ca96c1266c9dc55af30c6df7f07e2ea86a64bc5fad99258a10efe10e4127e9b
 SHA512:
-  metadata.gz: dd4bc35189956140e5409d1d2e325e2cb6b9423e23fbcb6f81399281b10e4447b8c1bed8e8447f7dac59b5282e9c39b4907231225f0858abe6116fe9419b9269
-  data.tar.gz: d91718d74c17d0b1c79485de6311a70a579b1f80916c4328afa813800735b12d29e1069cfdc1721f1954839a6b55d25c0fa292ed41d02350ac0c1665a3475aa2
+  metadata.gz: 2f4c15c91c6a7741c1f387b820cc36689cd7530233e9582fb3db73407d9f39eb69656a071b65789cd33ec359d5fa1478efe212336a3834202c30f96269885895
+  data.tar.gz: ed86a645c481c0c91510acedc5b0abd2bf3923f9ea33e9a23671db0e107005c07f64a1dfc52f4f5f47f826630712756bd5ce43ddfd06622a10ed24afa7731465

data/CHANGELOG.md

@@ -2,8 +2,11 @@
 
 ## [Unreleased]
 
+## [1.8.1] - 2021-10-08
+- Cleaned that rspec code a bit, added more matchers for real world use.
+
 ## [1.8.0] - 2021-10-07
-- Added the ability to test in RSpec
+- Added the ability to test in RSpec.
 
 ## [1.7.1] - 2021-10-06
 - Fixed literally a syntax issue.

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    slack_message (1.7.1)
+    slack_message (1.8.0)
 
 GEM
   remote: https://rubygems.org/

data/lib/slack_message/rspec.rb

@@ -4,6 +4,15 @@ require 'rspec/mocks'
 # Honestly, this code is what happens when you do not understand the RSpec
 # custom expectation API really at all, but you really want to create your
 # matcher. This code is soo baaad.
+#
+# We override API calls by entirely replacing the low-level API method. Then we
+# use our overridden version to capture and record calls. When someone creates
+# a new expectation, an object is created, so we allow that object to register
+# itself to receive notification when a slack message _would have_ been posted.
+#
+# Then once the expectation is fulfilled, that class unregisters itself so that
+# it can be cleaned up properly.
+#
 
 module SlackMessage::RSpec
   extend RSpec::Matchers::DSL
@@ -31,6 +40,7 @@ module SlackMessage::RSpec
     end
   end
 
+  # w/ channel
   matcher :post_slack_message_to do |expected|
     match do |actual|
       @instance ||= PostTo.new
@@ -40,9 +50,50 @@ module SlackMessage::RSpec
       @instance.enforce_expectations
     end
 
-    chain :with_content_matching do |content_expectation|
+    chain :with_content_matching do |content|
       @instance ||= PostTo.new
-      @instance.with_content_matching(content_expectation)
+      @instance.with_content_matching(content)
+    end
+
+    failure_message { @instance.failure_message }
+    failure_message_when_negated { @instance.failure_message_when_negated }
+
+    supports_block_expectations
+  end
+
+  # no channel
+  matcher :post_to_slack do |expected|
+    match do |actual|
+      @instance ||= PostTo.new
+
+      actual.call
+      @instance.enforce_expectations
+    end
+
+    chain :with_content_matching do |content|
+      @instance ||= PostTo.new
+      @instance.with_content_matching(content)
+    end
+
+    failure_message { @instance.failure_message }
+    failure_message_when_negated { @instance.failure_message_when_negated }
+
+    supports_block_expectations
+  end
+
+  # name / profile matcher
+  matcher :post_slack_message_as do |expected|
+     match do |actual|
+      @instance ||= PostTo.new
+      @instance.with_profile(expected)
+
+      actual.call
+      @instance.enforce_expectations
+    end
+
+    chain :with_content_matching do |content|
+      @instance ||= PostTo.new
+      @instance.with_content_matching(content)
     end
 
     failure_message { @instance.failure_message }
@@ -54,8 +105,9 @@ module SlackMessage::RSpec
   class PostTo
     def initialize
       @captured_calls = []
-      @content_expectation = nil
+      @content = nil
       @channel = nil
+      @profile = nil
 
       SlackMessage::RSpec.register_expectation_listener(self)
     end
@@ -68,41 +120,49 @@ module SlackMessage::RSpec
       @channel = channel
     end
 
-    def with_content_matching(content_expectation)
-      raise ArgumentError unless content_expectation.is_a? Regexp
-      @content_expectation = content_expectation
+    def with_content_matching(content)
+      raise ArgumentError unless content.is_a? Regexp
+      @content = content
+    end
+
+    def with_profile(profile)
+      @profile = profile
     end
 
     def enforce_expectations
       SlackMessage::RSpec.unregister_expectation_listener(self)
-      matching_messages.any? { |msg| body_matches_expectation?(msg.fetch(:blocks)) }
-    end
 
-    def matching_messages
-      @captured_calls.select { |c| c[:channel] == @channel }
+      @captured_calls
+        .filter { |call| !@channel || call[:channel] == @channel }
+        .filter { |call| !@profile || [call[:profile], call[:username]].include?(@profile) }
+        .filter { |call| !@content || call.fetch(:blocks).to_s =~ @content }
+        .any?
     end
 
-    def body_matches_expectation?(sent)
-      return true unless @content_expectation
+    def failure_message
+      "expected block to #{failure_expression}"
+    end
 
-      sent.to_s =~ @content_expectation
+    def failure_message_when_negated
+      "expected block not to #{failure_expression}"
     end
 
-    def failure_message
-      if @content_expectation
-        "expected block to post slack message to '#{@channel}' with content matching #{@content_expectation.inspect}"
+    def failure_expression
+      concat = []
+
+      if @channel
+        concat << "post a slack message to '#{@channel}'"
+      elsif @profile
+        concat << "post a slack message as '#{@profile}'"
       else
-        "expected block to post slack message to '#{@channel}'"
+        concat << "post a slack message"
       end
-    end
 
-    # TODO: does content_matching even make sense for negated test?
-    def failure_message_when_negated
-      if @content_expectation
-        "expected block not to post slack message to '#{@channel}' with content matching #{@content_expectation.inspect}"
-      else
-        "expected block not to post slack message to '#{@channel}'"
+      if @content
+        concat << "with content matching #{@content.inspect}"
       end
+
+      concat.join " "
     end
   end
 end

data/slack_message.gemspec

@@ -1,6 +1,6 @@
 Gem::Specification.new do |gem|
   gem.name        = 'slack_message'
-  gem.version     = "1.8.0"
+  gem.version     = "1.8.1"
   gem.summary     = "A nice DSL for composing rich messages in Slack"
   gem.authors     = ["Joe Mastey"]
   gem.email       = 'hello@joemastey.com'

data/spec/slack_message_spec.rb

@@ -46,7 +46,7 @@ RSpec.describe SlackMessage do
 
     it "raises errors for missing configuration" do
       SlackMessage.configure do |config|
-        #config.api_token = "abc123"
+        config.api_token = nil
       end
 
       expect {
@@ -87,12 +87,36 @@ RSpec.describe SlackMessage do
       }.to post_slack_message_to('#general').with_content_matching(/foo/)
     end
 
-    it "is not stateful" do
+    it "resets state properly" do
       expect {
         SlackMessage.post_to('#general') { text "foo" }
       }.to post_slack_message_to('#general')
 
       expect { }.not_to post_slack_message_to('#general')
     end
+
+    it "lets you assert by profile name" do
+      SlackMessage.configure do |config|
+        config.add_profile(:schmoebot, name: 'Schmoe', url: 'http://hooks.slack.com/1234/', default_channel: '#schmoes')
+      end
+
+      expect {
+        SlackMessage.post_as(:schmoebot) { text "foo" }
+      }.to post_slack_message_to('#schmoes')
+
+      expect {
+        SlackMessage.post_as(:schmoebot) { text "foo" }
+      }.to post_slack_message_as(:schmoebot)
+
+      expect {
+        SlackMessage.post_as(:schmoebot) { text "foo" }
+      }.to post_slack_message_as('Schmoe').with_content_matching(/foo/)
+    end
+
+    it "can assert more generally too tbh" do
+      expect {
+        SlackMessage.post_to('#general') { text "foo" }
+      }.to post_to_slack.with_content_matching(/foo/)
+    end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: slack_message
 version: !ruby/object:Gem::Version
-  version: 1.8.0
+  version: 1.8.1
 platform: ruby
 authors:
 - Joe Mastey
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-10-07 00:00:00.000000000 Z
+date: 2021-10-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec