ruby_event_store 2.18.0 → 2.19.0

data/lib/ruby_event_store/mappers/instrumented_mapper.rb

@@ -3,26 +3,63 @@
 module RubyEventStore
   module Mappers
     class InstrumentedMapper
+      DEPRECATION_MESSAGE = <<~EOW
+        Instrumentation event names *.rails_event_store are deprecated and will be removed in the next major release.
+        Use *.ruby_event_store instead.
+      EOW
+      private_constant :DEPRECATION_MESSAGE
+
+      RENAME_DEPRECATION_MESSAGE = <<~EOW
+        Instrumentation event names serialize.mapper.ruby_event_store and deserialize.mapper.ruby_event_store are deprecated and will be removed in the next major release.
+        Use event_to_record.mapper.ruby_event_store and record_to_event.mapper.ruby_event_store instead.
+        The domain_event: payload key in serialize.mapper.ruby_event_store has been renamed to event: in event_to_record.mapper.ruby_event_store.
+      EOW
+      private_constant :RENAME_DEPRECATION_MESSAGE
+
       def initialize(mapper, instrumentation)
         @mapper = mapper
         @instrumentation = instrumentation
       end
 
       def event_to_record(event)
-        instrumentation.instrument("serialize.mapper.rails_event_store", domain_event: event) do
-          mapper.event_to_record(event)
+        instrumentation.instrument("event_to_record.mapper.ruby_event_store", event: event) do
+          deprecated_instrument("serialize.mapper.ruby_event_store", { domain_event: event },
+                                canonical: "event_to_record.mapper.ruby_event_store",
+                                message: RENAME_DEPRECATION_MESSAGE) do
+            deprecated_instrument("serialize.mapper.rails_event_store", { domain_event: event }) do
+              mapper.event_to_record(event)
+            end
+          end
         end
       end
 
       def record_to_event(record)
-        instrumentation.instrument("deserialize.mapper.rails_event_store", record: record) do
-          mapper.record_to_event(record)
+        instrumentation.instrument("record_to_event.mapper.ruby_event_store", record: record) do
+          deprecated_instrument("deserialize.mapper.ruby_event_store", { record: record },
+                                canonical: "record_to_event.mapper.ruby_event_store",
+                                message: RENAME_DEPRECATION_MESSAGE) do
+            deprecated_instrument("deserialize.mapper.rails_event_store", { record: record }) do
+              mapper.record_to_event(record)
+            end
+          end
         end
       end
 
       private
 
       attr_reader :instrumentation, :mapper
+
+      def deprecated_instrument(name, payload, canonical: nil, message: DEPRECATION_MESSAGE, &block)
+        canonical_name = canonical || name.sub("rails_event_store", "ruby_event_store")
+        old_listeners = instrumentation.notifier.all_listeners_for(name)
+        new_listeners = instrumentation.notifier.all_listeners_for(canonical_name)
+        if (old_listeners - new_listeners).any?
+          warn message
+          instrumentation.instrument(name, payload, &block)
+        else
+          yield
+        end
+      end
     end
   end
 end

data/lib/ruby_event_store/mappers/null_mapper.rb

@@ -4,6 +4,10 @@ module RubyEventStore
   module Mappers
     class NullMapper < PipelineMapper
       def initialize
+        warn <<~EOW
+          DEPRECATION WARNING: `RubyEventStore::Mappers::NullMapper` is deprecated and will be removed in the next major release.
+          Use `RubyEventStore::Mappers::Default.new` instead.
+        EOW
         super(Pipeline.new)
       end
     end

data/lib/ruby_event_store/mappers/transformation/event_class_remapper.rb

@@ -5,6 +5,10 @@ module RubyEventStore
     module Transformation
       class EventClassRemapper
         def initialize(class_map)
+          warn <<~EOW
+            DEPRECATION WARNING: `RubyEventStore::Mappers::Transformation::EventClassRemapper` is deprecated and will be removed in the next major release.
+            Use `RubyEventStore::Mappers::Transformation::Upcast` instead.
+          EOW
           @class_map = class_map
         end
 

data/lib/ruby_event_store/projection.rb

@@ -2,94 +2,126 @@
 
 module RubyEventStore
   class Projection
-    private_class_method :new
-
-    def self.from_stream(stream_or_streams)
-      streams = Array(stream_or_streams)
-      raise(ArgumentError, "At least one stream must be given") if streams.empty?
-      new(streams: streams)
+    ANONYMOUS_CLASS = "#<Class:".freeze
+    DEPRECATION_MESSAGE = <<~EOW
+      RubyEventStore::Projection from_stream/from_all_streams/init/when/run API is deprecated and will be removed in the next major release.
+      Use Projection.init(initial_state).on(EventClass) { |state, event| new_state }.call(scope) instead.
+    EOW
+    MULTI_SCOPE_DEPRECATION_MESSAGE = <<~EOW
+      Passing multiple scopes to RubyEventStore::Projection#call is deprecated and will be removed in the next major release.
+      Use a single scope instead, e.g. call(event_store.read.stream("stream_name")).
+    EOW
+    NEW_CONSTRUCTOR_DEPRECATION_MESSAGE = <<~EOW
+      RubyEventStore::Projection.new is deprecated and will be removed in the next major release.
+      Use Projection.init(initial_state) instead.
+    EOW
+    private_constant :ANONYMOUS_CLASS, :DEPRECATION_MESSAGE, :MULTI_SCOPE_DEPRECATION_MESSAGE, :NEW_CONSTRUCTOR_DEPRECATION_MESSAGE
+
+    def initialize(initial_state = nil, _internal: false)
+      warn NEW_CONSTRUCTOR_DEPRECATION_MESSAGE unless _internal
+      @handlers = {}
+      @init = -> { initial_state }
+      @streams = []
     end
 
-    def self.from_all_streams
-      new
+    def self.init(initial_state = nil)
+      new(initial_state, _internal: true)
     end
 
-    def initialize(streams: [])
-      @streams = streams
-      @handlers = {}
-      @init = -> { {} }
-    end
+    def on(*event_klasses, &block)
+      raise(ArgumentError, "No handler block given") unless block_given?
 
-    attr_reader :streams, :handlers
+      event_klasses.each do |event_klass|
+        name = event_klass.to_s
+        raise(ArgumentError, "Anonymous class is missing name") if name.start_with? ANONYMOUS_CLASS
 
-    def init(handler)
-      @init = handler
+        @handlers[name] = ->(state, event) { block.call(state, event) }
+      end
       self
     end
 
-    def when(events, handler)
-      Array(events).each { |event| handlers[event.to_s] = handler }
+    def call(*scopes)
+      return initial_state if handled_events.empty?
 
-      self
+      warn MULTI_SCOPE_DEPRECATION_MESSAGE if scopes.size > 1
+
+      scopes.reduce(initial_state) do |state, scope|
+        scope.of_type(handled_events).reduce(state, &method(:transition))
+      end
     end
 
-    def initial_state
-      @init.call
+    def self.from_stream(stream_or_streams)
+      warn DEPRECATION_MESSAGE
+      streams = Array(stream_or_streams)
+      raise(ArgumentError, "At least one stream must be given") if streams.empty?
+      projection = new(_internal: true)
+      projection.instance_variable_set(:@streams, streams)
+      projection
     end
 
-    def current_state
-      @current_state ||= initial_state
+    def self.from_all_streams
+      warn DEPRECATION_MESSAGE
+      new(_internal: true)
     end
 
-    def call(event)
-      handlers.fetch(event.event_type).(current_state, event)
+    def init(handler)
+      warn DEPRECATION_MESSAGE
+      @init = handler
+      self
     end
 
-    def handled_events
-      handlers.keys
+    def when(events, handler)
+      warn DEPRECATION_MESSAGE
+      Array(events).each do |event_klass|
+        name = event_klass.to_s
+        @handlers[name] = ->(state, event) { handler.call(state, event); state }
+      end
+      self
     end
 
     def run(event_store, start: nil, count: PAGE_SIZE)
-      return initial_state if handled_events.empty?
-      streams.any? ? reduce_from_streams(event_store, start, count) : reduce_from_all_streams(event_store, start, count)
+      warn DEPRECATION_MESSAGE
+
+      if @streams.any?
+        raise ArgumentError, "Start must be an array with event ids" unless valid_start_for_streams?(start)
+        scopes =
+          @streams.zip(start || []).map do |stream, start_event_id|
+            scope = event_store.read.stream(stream).in_batches(count)
+            scope = scope.from(start_event_id) if start_event_id
+            scope
+          end
+      else
+        raise ArgumentError, "Start must be valid event id" unless valid_start_for_all_streams?(start)
+        scope = event_store.read.in_batches(count)
+        scope = scope.from(start) if start
+        scopes = [scope]
+      end
+
+      call(*scopes)
     end
 
     private
 
-    def valid_starting_point?(start)
-      return true unless start
-      streams.any? ? (start.instance_of?(Array) && start.size === streams.size) : start.instance_of?(String)
-    end
-
-    def reduce_from_streams(event_store, start, count)
-      raise ArgumentError.new("Start must be an array with event ids") unless valid_starting_point?(start)
-      streams
-        .zip(start_events(start))
-        .reduce(initial_state) do |state, (stream_name, start_event_id)|
-          read_scope(event_store, stream_name, count, start_event_id).reduce(state, &method(:transition))
-        end
+    def initial_state
+      @init.call
     end
 
-    def reduce_from_all_streams(event_store, start, count)
-      raise ArgumentError.new("Start must be valid event id") unless valid_starting_point?(start)
-      read_scope(event_store, nil, count, start).reduce(initial_state, &method(:transition))
+    def handled_events
+      @handlers.keys
     end
 
-    def read_scope(event_store, stream, count, start)
-      scope = event_store.read.in_batches(count)
-      scope = scope.of_type(handled_events)
-      scope = scope.stream(stream) if stream
-      scope = scope.from(start) if start
-      scope
+    def transition(state, event)
+      @handlers.fetch(event.event_type).call(state, event)
     end
 
-    def start_events(start)
-      start ? start : Array.new
+    def valid_start_for_streams?(start)
+      return true unless start
+      start.instance_of?(Array) && start.size == @streams.size
     end
 
-    def transition(state, event)
-      handlers.fetch(event.event_type).call(state, event)
-      state
+    def valid_start_for_all_streams?(start)
+      return true unless start
+      start.instance_of?(String)
     end
   end
 end

data/lib/ruby_event_store/specification.rb

@@ -13,7 +13,7 @@ module RubyEventStore
     end
 
     # Limits the query to certain stream.
-    # {http://railseventstore.org/docs/read/ Find out more}.
+    # {https://railseventstore.org/docs/core-concepts/read Find out more}.
     #
     # @param stream_name [String] name of the stream to get events from
     # @return [Specification]
@@ -22,7 +22,7 @@ module RubyEventStore
     end
 
     # Limits the query to events before or after another event.
-    # {http://railseventstore.org/docs/read/ Find out more}.
+    # {https://railseventstore.org/docs/core-concepts/read Find out more}.
     #
     # @param start [String] id of event to start reading from.
     # @return [Specification]
@@ -32,7 +32,7 @@ module RubyEventStore
     end
 
     # Limits the query to events before or after another event.
-    # {http://railseventstore.org/docs/read/ Find out more}.
+    # {https://railseventstore.org/docs/core-concepts/read Find out more}.
     #
     # @param stop [String] id of event to start reading from.
     # @return [Specification]
@@ -42,7 +42,7 @@ module RubyEventStore
     end
 
     # Limits the query to events that occurred before given time.
-    # {http://railseventstore.org/docs/read/ Find out more}.
+    # {https://railseventstore.org/docs/core-concepts/read Find out more}.
     #
     # @param time [Time]
     # @return [Specification]
@@ -58,7 +58,7 @@ module RubyEventStore
     end
 
     # Limits the query to events that occurred on or before given time.
-    # {http://railseventstore.org/docs/read/ Find out more}.
+    # {https://railseventstore.org/docs/core-concepts/read Find out more}.
     #
     # @param time [Time]
     # @return [Specification]
@@ -74,7 +74,7 @@ module RubyEventStore
     end
 
     # Limits the query to events that occurred after given time.
-    # {http://railseventstore.org/docs/read/ Find out more}.
+    # {https://railseventstore.org/docs/core-concepts/read Find out more}.
     #
     # @param time [Time]
     # @return [Specification]
@@ -90,7 +90,7 @@ module RubyEventStore
     end
 
     # Limits the query to events that occurred on or after given time.
-    # {http://railseventstore.org/docs/read/ Find out more}.
+    # {https://railseventstore.org/docs/core-concepts/read Find out more}.
     #
     # @param time [Time]
     # @return [Specification]
@@ -106,7 +106,7 @@ module RubyEventStore
     end
 
     # Limits the query to events within given time range.
-    # {http://railseventstore.org/docs/read/ Find out more}.
+    # {https://railseventstore.org/docs/core-concepts/read Find out more}.
     #
     # @param time_range [Range]
     # @return [Specification]
@@ -119,7 +119,7 @@ module RubyEventStore
     end
 
     # Sets the order of time sorting using transaction time
-    # {http://railseventstore.org/docs/read/ Find out more}
+    # {https://railseventstore.org/docs/core-concepts/read Find out more}
     #
     # @return [Specification]
     def as_at
@@ -127,7 +127,7 @@ module RubyEventStore
     end
 
     # Sets the order of time sorting using validity time
-    # {http://railseventstore.org/docs/read/ Find out more}
+    # {https://railseventstore.org/docs/core-concepts/read Find out more}
     #
     # @return [Specification]
     def as_of
@@ -135,7 +135,7 @@ module RubyEventStore
     end
 
     # Sets the order of reading events to ascending (forward from the start).
-    # {http://railseventstore.org/docs/read/ Find out more}.
+    # {https://railseventstore.org/docs/core-concepts/read Find out more}.
     #
     # @return [Specification]
     def forward
@@ -143,7 +143,7 @@ module RubyEventStore
     end
 
     # Sets the order of reading events to descending (backward from the start).
-    # {http://railseventstore.org/docs/read/ Find out more}.
+    # {https://railseventstore.org/docs/core-concepts/read Find out more}.
     #
     # @return [Specification]
     def backward
@@ -151,7 +151,7 @@ module RubyEventStore
     end
 
     # Limits the query to specified number of events.
-    # {http://railseventstore.org/docs/read/ Find out more}.
+    # {https://railseventstore.org/docs/core-concepts/read Find out more}.
     #
     # @param count [Integer] maximal number of events to retrieve
     # @return [Specification]
@@ -162,7 +162,7 @@ module RubyEventStore
 
     # Executes the query based on the specification built up to this point.
     # Yields each batch of records that was retrieved from the store.
-    # {http://railseventstore.org/docs/read/ Find out more}.
+    # {https://railseventstore.org/docs/core-concepts/read Find out more}.
     #
     # @yield [Array<Event>] batch of events
     # @return [Enumerator, nil] Enumerator is returned when block not given
@@ -174,7 +174,7 @@ module RubyEventStore
 
     # Executes the query based on the specification built up to this point.
     # Yields events read from the store if block given. Otherwise, returns enumerable collection.
-    # {http://railseventstore.org/docs/read/ Find out more}.
+    # {https://railseventstore.org/docs/core-concepts/read Find out more}.
     #
     # @yield [Event] event
     # @return [Enumerator, nil] Enumerator is returned when block not given
@@ -186,7 +186,7 @@ module RubyEventStore
 
     # Executes the query based on the specification built up to this point
     # and maps the result using provided block.
-    # {http://railseventstore.org/docs/read/ Find out more}.
+    # {https://railseventstore.org/docs/core-concepts/read Find out more}.
     #
     # @return [Array] of mapped result
     def map(&block)
@@ -196,7 +196,7 @@ module RubyEventStore
 
     # Reduces the results of the query based on the specification
     # built up to this point result using provided block.
-    # {http://railseventstore.org/docs/read/ Find out more}.
+    # {https://railseventstore.org/docs/core-concepts/read Find out more}.
     #
     # @param accumulator starting state for reduce operation
     # @return reduce result as defined by block given
@@ -206,7 +206,7 @@ module RubyEventStore
     end
 
     # Calculates the size of result set based on the specification build up to this point.
-    # {http://railseventstore.org/docs/read/ Find out more}.
+    # {https://railseventstore.org/docs/core-concepts/read Find out more}.
     #
     # @return [Integer] Number of events to read
     def count
@@ -215,7 +215,7 @@ module RubyEventStore
 
     # Executes the query based on the specification built up to this point.
     # Returns array of domain events.
-    # {http://railseventstore.org/docs/read/ Find out more}.
+    # {https://railseventstore.org/docs/core-concepts/read Find out more}.
     #
     # @return [Array<Event>]
     def to_a
@@ -223,7 +223,7 @@ module RubyEventStore
     end
 
     # Specifies that events should be obtained in batches.
-    # {http://railseventstore.org/docs/read/ Find out more}.
+    # {https://railseventstore.org/docs/core-concepts/read Find out more}.
     #
     # Looping through a collection of events from the store
     # can be inefficient since it will try to instantiate all
@@ -244,10 +244,18 @@ module RubyEventStore
         end,
       )
     end
-    alias in_batches_of in_batches
+
+    def in_batches_of(batch_size = DEFAULT_BATCH_SIZE)
+      warn <<~EOW
+        RubyEventStore::Specification#in_batches_of is deprecated and will be removed in the next major release.
+
+        Use #in_batches instead.
+      EOW
+      in_batches(batch_size)
+    end
 
     # Specifies that only first event should be read.
-    # {http://railseventstore.org/docs/read/ Find out more}.
+    # {https://railseventstore.org/docs/core-concepts/read Find out more}.
     #
     # @return [Specification]
     def read_first
@@ -255,7 +263,7 @@ module RubyEventStore
     end
 
     # Specifies that only last event should be read.
-    # {http://railseventstore.org/docs/read/ Find out more}.
+    # {https://railseventstore.org/docs/core-concepts/read Find out more}.
     #
     # @return [Specification]
     def read_last
@@ -264,7 +272,7 @@ module RubyEventStore
 
     # Executes the query based on the specification built up to this point.
     # Returns the first event in specified collection of events.
-    # {http://railseventstore.org/docs/read/ Find out more}.
+    # {https://railseventstore.org/docs/core-concepts/read Find out more}.
     #
     # @return [Event, nil]
     def first
@@ -273,7 +281,7 @@ module RubyEventStore
 
     # Executes the query based on the specification built up to this point.
     # Returns the last event in specified collection of events.
-    # {http://railseventstore.org/docs/read/ Find out more}.
+    # {https://railseventstore.org/docs/core-concepts/read Find out more}.
     #
     # @return [Event, nil]
     def last
@@ -281,17 +289,25 @@ module RubyEventStore
     end
 
     # Limits the query to certain event type(s).
-    # {http://railseventstore.org/docs/read/ Find out more}.
+    # {https://railseventstore.org/docs/core-concepts/read Find out more}.
     #
     # @types [Class, Array(Class)] types of event to look for.
     # @return [Specification]
     def of_type(*types)
       Specification.new(reader, result.dup { |r| r.with_types = types.flatten })
     end
-    alias_method :of_types, :of_type
+
+    def of_types(*types)
+      warn <<~EOW
+        RubyEventStore::Specification#of_types is deprecated and will be removed in the next major release.
+
+        Use #of_type instead.
+      EOW
+      of_type(*types)
+    end
 
     # Limits the query to certain events by given even ids.
-    # {http://railseventstore.org/docs/read/ Find out more}.
+    # {https://railseventstore.org/docs/core-concepts/read Find out more}.
     #
     # @param event_ids [Array(String)] ids of event to look for.
     # @return [Specification]
@@ -302,7 +318,7 @@ module RubyEventStore
     # Reads single event from repository.
     # Returns the event with specified id or nil if event is not found
     # in specified collection of events.
-    # {http://railseventstore.org/docs/read/ Find out more}.
+    # {https://railseventstore.org/docs/core-concepts/read Find out more}.
     #
     # @return [Event, nil]
     def event(event_id)
@@ -312,7 +328,7 @@ module RubyEventStore
     # Reads single existing event from repository.
     # Returns the event with specified id or raises [EventNotFound] error if
     # event is not found in specified collection of events.
-    # {http://railseventstore.org/docs/read/ Find out more}.
+    # {https://railseventstore.org/docs/core-concepts/read Find out more}.
     #
     # @return [Event]
     def event!(event_id)
@@ -322,7 +338,7 @@ module RubyEventStore
     # Reads all events of given ids from repository.
     # Yields each event (found by id in specified collection of events)
     # read from the store if block given. Otherwise, returns enumerable collection.
-    # {http://railseventstore.org/docs/read/ Find out more}.
+    # {https://railseventstore.org/docs/core-concepts/read Find out more}.
     #
     # @yield [Event] event
     # @return [Enumerator] Enumerator is returned when block not given