ruby_event_store-rspec 2.0.0 → 2.3.0

data/lib/ruby_event_store/rspec/step_by_step_failure_message_formatter.rb

@@ -0,0 +1,218 @@
+# frozen_string_literal: true
+
+module RubyEventStore
+  module RSpec
+    class StepByStepFailureMessageFormatter
+      class Lingo
+        def initialize(published)
+          @published = published
+        end
+        attr_reader :published
+      end
+
+      class HavePublished
+        def initialize(differ, lingo)
+          @differ = differ
+          @lingo = lingo
+        end
+
+        def failure_message(expected, events, stream_name = nil)
+          return failure_message_strict(expected, events) if expected.strict?
+          return failure_message_no_events if expected.empty?
+          expected.events.each do |expected_event|
+            correct_event_count = 0
+            events_with_correct_type = []
+            events.each do |actual_event|
+              if expected_event.matches?(actual_event)
+                correct_event_count += 1
+              elsif expected_event.matches_kind?(actual_event)
+                events_with_correct_type << actual_event
+              end
+            end
+
+            expectations = expected_message(expected, expected_event, stream_name)
+
+            if expected.specified_count?
+              if correct_event_count >= 1
+                reality = failure_message_incorrect_count(expected_event, events_with_correct_type, correct_event_count)
+              elsif !events_with_correct_type.empty?
+                reality = failure_message_correct_type_incorrect_payload(expected_event, events_with_correct_type)
+              else
+                reality = failure_message_incorrect_type
+              end
+            else
+              if correct_event_count >= 1
+                next
+              else
+                if !events_with_correct_type.empty?
+                  reality = failure_message_correct_type_incorrect_payload(expected_event, events_with_correct_type)
+                else
+                  reality = failure_message_incorrect_type
+                end
+              end
+            end
+
+            return (expectations + reality)
+          end
+        end
+
+        def failure_message_when_negated(expected, events, _stream_name = nil)
+          return failure_message_when_negated_no_events if expected.empty?
+          if expected.specified_count?
+            <<~EOS
+            expected
+              #{expected.events.first.description}
+            not to be #{lingo.published} exactly #{expected.count} times
+
+            #{actual_events_list(events)}
+            EOS
+          else
+            <<~EOS
+            expected #{expected_events_list(expected.events)} not to #{"exactly " if expected.strict?}be #{lingo.published}
+
+            #{actual_events_list(events)}
+            EOS
+          end
+        end
+
+        private
+        attr_reader :differ, :lingo
+
+        def failure_message_no_events
+          "expected anything to be #{lingo.published}\n"
+        end
+
+        def failure_message_when_negated_no_events
+          "expected something to be #{lingo.published}\n"
+        end
+
+        def failure_message_incorrect_count(expected_event, events_with_correct_type, correct_event_count)
+          [
+            <<~EOS,
+
+            but was #{lingo.published} #{correct_event_count} times
+            EOS
+
+            if !events_with_correct_type.empty?
+              [
+                <<~EOS.strip,
+              There are events of correct type but with incorrect payload:
+                EOS
+                events_with_correct_type.each_with_index.map {|event_with_correct_type, index| event_diff(expected_event, event_with_correct_type, index) },
+                nil
+              ]
+            end
+          ].compact.join("\n")
+        end
+
+        def failure_message_correct_type_incorrect_payload(expected_event, events_with_correct_type)
+          <<~EOS
+          , but it was not #{lingo.published}
+
+          There are events of correct type but with incorrect payload:
+          #{events_with_correct_type.each_with_index.map {|event_with_correct_type, index| event_diff(expected_event, event_with_correct_type, index) }.join("\n")}
+          EOS
+        end
+
+        def event_diff(expected_event, event_with_correct_type, index)
+          [
+            "#{index + 1}) #{event_with_correct_type.inspect}",
+            indent(data_diff(expected_event, event_with_correct_type), 4),
+            indent(metadata_diff(expected_event, event_with_correct_type), 4),
+          ].reject(&:empty?)
+        end
+
+        def indent(str, count)
+          str.to_s.split("\n").map {|l| l.sub(//, " " * count) }
+        end
+
+        def failure_message_incorrect_type
+          <<~EOS
+          , but there is no event with such type
+          EOS
+        end
+
+        def failure_message_strict(expected, events)
+          if expected.specified_count?
+            <<~EOS
+            expected only
+              #{expected.events.first.description}
+            to be #{lingo.published} #{expected.count} times
+
+            #{actual_events_list(events)}
+            EOS
+          else
+            <<~EOS
+            expected only #{expected_events_list(expected.events)} to be #{lingo.published}
+
+            #{actual_events_list(events)}
+            EOS
+          end
+        end
+
+        def data_diff(expected_event, event_with_correct_type)
+          if !expected_event.expected_data.nil?
+            "data diff:#{differ.diff(expected_event.expected_data, event_with_correct_type.data)}"
+          end
+        end
+
+        def metadata_diff(expected_event, event_with_correct_type)
+          if !expected_event.expected_metadata.nil?
+            "metadata diff:#{differ.diff(expected_event.expected_metadata, event_with_correct_type.metadata.to_h)}"
+          end
+        end
+
+        def expected_message(expected, expected_event, stream_name)
+          expected_stream = " in stream #{stream_name}" if stream_name
+          if expected.specified_count?
+            <<~EOS
+            expected event
+              #{expected_event.description}
+            to be #{lingo.published} #{expected.count} times#{expected_stream}
+            EOS
+          else
+            <<~EOS
+            expected #{expected_events_list(expected.events)} to be #{lingo.published}#{expected_stream}
+
+            i.e. expected event
+              #{expected_event.description}
+            to be #{lingo.published}
+            EOS
+          end.strip
+        end
+
+        def expected_events_list(expected)
+          <<~EOS.strip
+          [
+          #{expected.map(&:description).map {|d| indent(d, 2) }.join("\n")}
+          ]
+          EOS
+        end
+
+        def actual_events_list(actual)
+          <<~EOS.strip
+          but the following was #{lingo.published}: [
+          #{actual.map(&:inspect).map {|d| indent(d, 2) }.join("\n")}
+          ]
+          EOS
+        end
+      end
+
+      def have_published(differ)
+        HavePublished.new(differ, Lingo.new("published"))
+      end
+
+      def publish(differ)
+        HavePublished.new(differ, Lingo.new("published"))
+      end
+
+      def have_applied(differ)
+        HavePublished.new(differ, Lingo.new("applied"))
+      end
+
+      def apply(differ)
+        HavePublished.new(differ, Lingo.new("applied"))
+      end
+    end
+  end
+end

data/lib/ruby_event_store/rspec/version.rb

@@ -2,6 +2,6 @@
 
 module RubyEventStore
   module RSpec
-    VERSION = "2.0.0"
+    VERSION = "2.3.0"
   end
 end

data/lib/ruby_event_store/rspec.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-require 'rspec'
+require "rspec"
 
 module RubyEventStore
   module RSpec
@@ -8,14 +8,32 @@ module RubyEventStore
   end
 end
 
-require "ruby_event_store/rspec/version"
-require "ruby_event_store/rspec/be_event"
-require "ruby_event_store/rspec/have_published"
-require "ruby_event_store/rspec/have_applied"
-require "ruby_event_store/rspec/have_subscribed_to_events"
-require "ruby_event_store/rspec/publish"
-require "ruby_event_store/rspec/apply"
-require "ruby_event_store/rspec/matchers"
+require_relative "rspec/version"
+require_relative "rspec/be_event"
+require_relative "rspec/expected_collection"
+require_relative "rspec/fetch_events"
+require_relative "rspec/fetch_unpublished_events"
+require_relative "rspec/match_events"
+require_relative "rspec/have_published"
+require_relative "rspec/have_applied"
+require_relative "rspec/have_subscribed_to_events"
+require_relative "rspec/publish"
+require_relative "rspec/apply"
+require_relative "rspec/crude_failure_message_formatter"
+require_relative "rspec/step_by_step_failure_message_formatter"
+require_relative "rspec/matchers"
+
+module RubyEventStore
+  module RSpec
+    def self.default_formatter=(new_formatter)
+      @@default_formatter = new_formatter
+    end
+
+    def self.default_formatter
+      @@default_formatter ||= CrudeFailureMessageFormatter.new
+    end
+  end
+end
 
 ::RSpec.configure do |config|
   config.include ::RubyEventStore::RSpec::Matchers

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ruby_event_store-rspec
 version: !ruby/object:Gem::Version
-  version: 2.0.0
+  version: 2.3.0
 platform: ruby
 authors:
 - Arkency
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-12-30 00:00:00.000000000 Z
+date: 2021-09-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
@@ -25,34 +25,33 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '3.0'
 description:
-email:
-- dev@arkency.com
+email: dev@arkency.com
 executables: []
 extensions: []
-extra_rdoc_files: []
+extra_rdoc_files:
+- README.md
 files:
-- ".mutant.yml"
-- Gemfile
-- Gemfile.lock
-- Makefile
 - README.md
-- lib/rails_event_store/rspec.rb
 - lib/ruby_event_store/rspec.rb
 - lib/ruby_event_store/rspec/apply.rb
 - lib/ruby_event_store/rspec/be_event.rb
+- lib/ruby_event_store/rspec/crude_failure_message_formatter.rb
+- lib/ruby_event_store/rspec/expected_collection.rb
+- lib/ruby_event_store/rspec/fetch_events.rb
+- lib/ruby_event_store/rspec/fetch_unpublished_events.rb
 - lib/ruby_event_store/rspec/have_applied.rb
 - lib/ruby_event_store/rspec/have_published.rb
 - lib/ruby_event_store/rspec/have_subscribed_to_events.rb
+- lib/ruby_event_store/rspec/match_events.rb
 - lib/ruby_event_store/rspec/matchers.rb
 - lib/ruby_event_store/rspec/publish.rb
+- lib/ruby_event_store/rspec/step_by_step_failure_message_formatter.rb
 - lib/ruby_event_store/rspec/version.rb
-- rails_event_store-rspec.gemspec
-- ruby_event_store-rspec.gemspec
 homepage: https://railseventstore.org
 licenses:
 - MIT
 metadata:
-  homepage_uri: https://railseventstore.org/
+  homepage_uri: https://railseventstore.org
   changelog_uri: https://github.com/RailsEventStore/rails_event_store/releases
   source_code_uri: https://github.com/RailsEventStore/rails_event_store
   bug_tracker_uri: https://github.com/RailsEventStore/rails_event_store/issues
@@ -64,7 +63,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: '2.6'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
@@ -74,5 +73,5 @@ requirements: []
 rubygems_version: 3.1.4
 signing_key:
 specification_version: 4
-summary: RSpec matchers for RailsEventStore
+summary: RSpec matchers for RubyEventStore
 test_files: []

data/.mutant.yml

@@ -1 +0,0 @@
-../.mutant.yml

data/Gemfile

@@ -1,10 +0,0 @@
-source 'https://rubygems.org'
-git_source(:github) { |repo| "https://github.com/#{repo}.git" }
-gemspec name: 'ruby_event_store-rspec'
-
-eval_gemfile '../support/bundler/Gemfile.shared'
-
-gem 'ruby_event_store', path: '../ruby_event_store'
-gem 'aggregate_root', path: '../aggregate_root'
-
-gem 'diff-lcs', '= 1.3.0'

data/Gemfile.lock

@@ -1,113 +0,0 @@
-PATH
-  remote: ../aggregate_root
-  specs:
-    aggregate_root (2.0.0)
-      ruby_event_store (= 2.0.0)
-
-PATH
-  remote: ../ruby_event_store
-  specs:
-    ruby_event_store (2.0.0)
-      concurrent-ruby (~> 1.0, >= 1.1.6)
-
-PATH
-  remote: .
-  specs:
-    ruby_event_store-rspec (2.0.0)
-      rspec (~> 3.0)
-
-GEM
-  remote: https://rubygems.org/
-  remote: https://oss:7AXfeZdAfCqL1PvHm2nvDJO6Zd9UW8IK@gem.mutant.dev/
-  specs:
-    abstract_type (0.0.7)
-    adamantium (0.2.0)
-      ice_nine (~> 0.11.0)
-      memoizable (~> 0.4.0)
-    anima (0.3.2)
-      abstract_type (~> 0.0.7)
-      adamantium (~> 0.2)
-      equalizer (~> 0.0.11)
-    ast (2.4.1)
-    concord (0.1.6)
-      adamantium (~> 0.2.0)
-      equalizer (~> 0.0.9)
-    concurrent-ruby (1.1.7)
-    diff-lcs (1.3)
-    equalizer (0.0.11)
-    ice_nine (0.11.2)
-    memoizable (0.4.2)
-      thread_safe (~> 0.3, >= 0.3.1)
-    mprelude (0.1.0)
-      abstract_type (~> 0.0.7)
-      adamantium (~> 0.2.0)
-      concord (~> 0.1.5)
-      equalizer (~> 0.0.9)
-      ice_nine (~> 0.11.1)
-      procto (~> 0.0.2)
-    mutant (0.10.22)
-      abstract_type (~> 0.0.7)
-      adamantium (~> 0.2.0)
-      anima (~> 0.3.1)
-      ast (~> 2.2)
-      concord (~> 0.1.5)
-      diff-lcs (~> 1.3)
-      equalizer (~> 0.0.9)
-      ice_nine (~> 0.11.1)
-      memoizable (~> 0.4.2)
-      mprelude (~> 0.1.0)
-      parser (~> 3.0.0)
-      procto (~> 0.0.2)
-      unparser (~> 0.5.6)
-      variable (~> 0.0.1)
-    mutant-license (0.1.1.2.1627430819213747598431630701693729869473.0)
-    mutant-rspec (0.10.22)
-      mutant (= 0.10.22)
-      rspec-core (>= 3.8.0, < 4.0.0)
-    parser (3.0.0.0)
-      ast (~> 2.4.1)
-    procto (0.0.3)
-    rake (13.0.3)
-    rspec (3.10.0)
-      rspec-core (~> 3.10.0)
-      rspec-expectations (~> 3.10.0)
-      rspec-mocks (~> 3.10.0)
-    rspec-core (3.10.1)
-      rspec-support (~> 3.10.0)
-    rspec-expectations (3.10.1)
-      diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.10.0)
-    rspec-mocks (3.10.1)
-      diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.10.0)
-    rspec-support (3.10.1)
-    thread_safe (0.3.6)
-    unparser (0.5.6)
-      abstract_type (~> 0.0.7)
-      adamantium (~> 0.2.0)
-      anima (~> 0.3.1)
-      concord (~> 0.1.5)
-      diff-lcs (~> 1.3)
-      equalizer (~> 0.0.9)
-      mprelude (~> 0.1.0)
-      parser (>= 3.0.0)
-      procto (~> 0.0.2)
-    variable (0.0.1)
-      equalizer (~> 0.0.11)
-
-PLATFORMS
-  ruby
-
-DEPENDENCIES
-  aggregate_root!
-  diff-lcs (= 1.3.0)
-  mutant (~> 0.10.21)
-  mutant-license!
-  mutant-rspec (~> 0.10.21)
-  rake (>= 10.0)
-  rspec (~> 3.6)
-  ruby_event_store!
-  ruby_event_store-rspec!
-
-BUNDLED WITH
-   2.1.4