stenotype 0.1.15 → 0.1.16

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a42b44b8b7a3c69fe9bfc179aaef8e274c67ace47d3609edda524358ff59d6ec
-  data.tar.gz: 58b3185d8391de7473da08bc9ffb4de8ca9ca37e8d948b8c7d26b14d3bd1a928
+  metadata.gz: 31a64803c8b2a343a441ce48a26d5b14e5aa55792d718fe2afb236f0589507ca
+  data.tar.gz: 999e4ae1554d49663ac4b8e8cecd94507cde51cfa494c28ebf21fab4240eb41a
 SHA512:
-  metadata.gz: 3578df8a2213ad6bfff4c8be71f902fba440ceed806e7b2cd4a3a7c443194e5abf11cc624f1466768f1a845e6a3696e108879e1524de5be553435b5fc443cc37
-  data.tar.gz: 2550d63b410c460b663562d453b97659dc014fde50cd250949530e210d9dc80cd251964858f90aa331de3303fb3b534f1601444c1208fdd7739ec309bb505e3c
+  metadata.gz: a001057b435a76475cb49deb9a73601c2144a3468578d0a68f188ccad85598678a0b5909cd3f32f31b8b04bda42c284b8cb5d54b7423663a79beefb6afcaaf61
+  data.tar.gz: a3f20a7345504675073ad48b48fd3dfb73018bd3d65d1855a28e0224a61a1a9274aaf39bfa483de465b95a82915a616f7c9987986be28a7c3d1f2f1992f3c6d3

data/CHANGELOG.md

@@ -1,5 +1,8 @@
 # Changelog
 
+### 0.1.16
+* Add rspec matchers to use in client code.
+
 ### 0.1.15
 * Updates readme.
 

data/README.md

@@ -275,6 +275,48 @@ end
 
 You do not have to manually register the context handler since it happens upon inheriting from `Stenotype::ContextHandlers::Base`
 
+## Testing
+
+Stenotype currently supports RSpec integration. To be able to test even emission you can use a predefined matcher by adding the following to spec helper:
+
+```ruby
+RSpec.configure do |config|
+  config.around(:each, type: :stenotype_event) do |example|
+    require 'stenotype/adapters/test_adapter'
+
+    config.include Stenotype::Test::Matchers
+
+    RSpec::Mocks.with_temporary_scope do
+      allow(Stenotype.config).to receive(:targets).and_return(Array.wrap(Stenotype::Adapters::TestAdapter.new))
+      example.run
+      allow(Stenotype.config).to receive(:targets).and_call_original
+    end
+  end
+end
+```
+
+After adding the configuration you can use the matchers:
+```ruby
+class Example
+  include Stenotype::Emitter
+
+  def trigger
+    emit_event(:user_subscription)
+  end
+end
+
+RSpec.describe Stenotype::Emitter do
+  describe "POST #create" do
+    subject(:post) { Example.new.trigger }
+
+    it "emits a user_subscription event", type: :stenotype_event do
+      expect { post }.to emit_an_event(:user_subscription).
+        with_arguments_including({ uuid: "abcd" }).
+        exactly(1).times
+    end
+  end
+end
+```
 
 ## Development
 

data/lib/stenotype/adapters/test_adapter.rb

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+module Stenotype
+  module Adapters
+    class TestAdapter < Base
+      attr_reader :buffer
+
+      def initialize(*_)
+        @buffer = Array.new
+        super()
+      end
+
+      #
+      # @param event_data {Sting} The data to be published
+      # @param additional_attrs {Hash} The list of additional event attributes
+      #
+      def publish(event_data, **additional_attrs)
+        buffer << parse(event_data)
+      end
+
+      #
+      # Clears the buffer
+      #
+      def flush!
+        buffer.clear
+      end
+
+      private
+
+      def parse(event_data)
+        JSON.parse(event_data)
+      end
+    end
+  end
+end

data/lib/stenotype/test/matchers.rb

@@ -0,0 +1,145 @@
+# frozen_string_literal: true
+
+require "spec_helper"
+module Stenotype
+  module Test
+    module Matchers
+      extend RSpec::Matchers::DSL
+
+      class DiffSizeMatchesExpectation
+        attr_reader :matching_events, :expected_count
+
+        def initialize(matching_events, expected_count)
+          @matching_events = matching_events
+          @expected_count = expected_count
+        end
+
+        def failure_message
+          "expected to see #{expected_count} event(s) but got #{matching_events.count} event(s)."
+        end
+
+        def matches?
+          matching_events.count == expected_count
+        end
+      end
+
+      class EventHasExpectedArguments
+        attr_reader :matching_events, :expected_arguments
+
+        def initialize(matching_events, expected_arguments)
+          @matching_events = matching_events
+          @expected_arguments = stringify_keys(expected_arguments)
+        end
+
+        def matches?
+          return false if multiple_events?
+
+          (expected_arguments.to_a - matching_event.to_a).empty?
+        end
+
+        def failure_message
+          if multiple_events?
+            "more than one event with given event name has been emitted. Can not match event arguments"
+          else
+            "expected to see all attributes from #{expected_arguments} to be included in event attributes but got #{matching_event}"
+          end
+        end
+
+        private
+
+        def multiple_events?
+          matching_events.size > 1
+        end
+
+        def matching_event
+          matching_events.first
+        end
+
+        def stringify_keys(hash)
+          hash.transform_keys(&:to_s)
+        end
+      end
+
+      class EventEmitted
+        attr_reader :matching_events, :expected_event_name
+
+        def initialize(matching_events, expected_event_name)
+          @matching_events = matching_events
+          @expected_event_name = expected_event_name
+        end
+
+        def matches?
+          matching_events.any?
+        end
+
+        def failure_message
+          "expected to see a '#{expected_event_name}' event but got nothing"
+        end
+      end
+
+      matcher :emit_an_event do |expected_event_name, *_|
+        supports_block_expectations
+
+        match do |emitting_event_block|
+          @emitting_event_block = emitting_event_block
+
+          partial_matchers << EventEmitted.new(matching_events, expected_event_name)
+          partial_matchers << EventHasExpectedArguments.new(matching_events, @arguments_should_include) if should_validate_events_count?
+          partial_matchers << DiffSizeMatchesExpectation.new(matching_events, @matching_events_count) if should_validate_attributes?
+
+          return first_failure.nil?
+        end
+
+        chain(:with_arguments_including) { |**args| @arguments_should_include = args }
+        chain(:exactly) { |times| @matching_events_count = times }
+
+        # noop for syntatic sugar
+        chain(:times) {}
+        chain(:time) {}
+
+        def matching_events
+          @matching_events ||= begin
+            buffer_before_emit = stenotype_event_buffer.dup
+            @emitting_event_block.call
+            buffer_after_emit = stenotype_event_buffer.dup
+
+            diff = buffer_after_emit - buffer_before_emit
+            diff.select { |event| event["name"] == expected_event_name.to_s }
+          end
+        end
+
+        def partial_matchers
+          @partial_matchers ||= []
+        end
+
+        def first_failure
+          @first_failure ||= partial_matchers.detect { |matcher| !matcher.matches? }
+        end
+
+        failure_message do
+          return super() unless first_failure
+
+          first_failure.failure_message
+        end
+
+        private
+
+        def should_validate_events_count?
+          @matching_events_count.present?
+        end
+
+        def should_validate_attributes?
+          @arguments_should_include.present?
+        end
+
+        def stenotype_event_buffer
+          stenotype_event_target.buffer
+        end
+
+        def stenotype_event_target
+          Stenotype.config.targets.first
+        end
+      end
+    end
+  end
+end

data/lib/stenotype/version.rb

@@ -2,6 +2,6 @@
 
 module Stenotype
   # :nodoc:
-  VERSION = "0.1.15"
+  VERSION = "0.1.16"
   # :nodoc:
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: stenotype
 version: !ruby/object:Gem::Version
-  version: 0.1.15
+  version: 0.1.16
 platform: ruby
 authors:
 - Roman Kapitonov
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-03-20 00:00:00.000000000 Z
+date: 2020-09-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -268,6 +268,7 @@ files:
 - lib/stenotype/adapters/base.rb
 - lib/stenotype/adapters/google_cloud.rb
 - lib/stenotype/adapters/stdout_adapter.rb
+- lib/stenotype/adapters/test_adapter.rb
 - lib/stenotype/at_exit.rb
 - lib/stenotype/configuration.rb
 - lib/stenotype/context_handlers.rb
@@ -283,6 +284,7 @@ files:
 - lib/stenotype/frameworks/rails/action_controller.rb
 - lib/stenotype/frameworks/rails/active_job.rb
 - lib/stenotype/railtie.rb
+- lib/stenotype/test/matchers.rb
 - lib/stenotype/version.rb
 - stenotype.gemspec
 homepage: https://github.com/Freshly/stenotype