ruby_event_store 0.31.1 → 0.32.0

data/lib/ruby_event_store/spec/scheduler_lint.rb

@@ -0,0 +1,9 @@
+RSpec.shared_examples :scheduler do |scheduler|
+  specify "#call" do
+    expect(scheduler).to respond_to(:call).with(2).arguments
+  end
+
+  specify "#verify" do
+    expect(scheduler).to respond_to(:verify).with(1).argument
+  end
+end

data/lib/ruby_event_store/specification.rb

@@ -2,54 +2,11 @@ module RubyEventStore
 
   # Used for building and executing the query specification.
   class Specification
-    # @private
-    # @api private
-    NO_LIMIT = Object.new.freeze
-    # @private
-    # @api private
-    NO_BATCH = Object.new.freeze
     DEFAULT_BATCH_SIZE = 100
-
-    class Result < Struct.new(:direction, :start, :count, :stream, :batch_size)
-      def limit?
-        !count.equal?(NO_LIMIT)
-      end
-
-      def global_stream?
-        stream.global?
-      end
-
-      def stream_name
-        stream.name
-      end
-
-      def head?
-        start.equal?(:head)
-      end
-
-      def forward?
-        direction.equal?(:forward)
-      end
-
-      def backward?
-        !forward?
-      end
-
-      def batched?
-        !batch_size.equal?(NO_BATCH)
-      end
-    end
-    private_constant :Result
-
     # @api private
     # @private
-    attr_reader :result
-
-    # @api private
-    # @private
-    def initialize(repository, mapper, result = Result.new(:forward, :head, NO_LIMIT, Stream.new(GLOBAL_STREAM), NO_BATCH))
-      @mapper = mapper
-      @repository  = repository
+    def initialize(reader, result = SpecificationResult.new)
+      @reader = reader
       @result = result
     end
 
@@ -59,7 +16,7 @@ module RubyEventStore
     # @param stream_name [String] name of the stream to get events from
     # @return [Specification]
     def stream(stream_name)
-      Specification.new(repository, mapper, result.dup.tap { |r| r.stream = Stream.new(stream_name) })
+      Specification.new(reader, result.dup { |r| r.stream = Stream.new(stream_name) })
     end
 
     # Limits the query to events before or after another event.
@@ -75,9 +32,9 @@ module RubyEventStore
         raise InvalidPageStart unless [:head].include?(start)
       else
         raise InvalidPageStart if start.nil? || start.empty?
-        raise EventNotFound.new(start) unless repository.has_event?(start)
+        raise EventNotFound.new(start) unless reader.has_event?(start)
       end
-      Specification.new(repository, mapper, result.dup.tap { |r| r.start = start })
+      Specification.new(reader, result.dup { |r| r.start = start })
     end
 
     # Sets the order of reading events to ascending (forward from the start).
@@ -85,7 +42,7 @@ module RubyEventStore
     #
     # @return [Specification]
     def forward
-      Specification.new(repository, mapper, result.dup.tap { |r| r.direction = :forward })
+      Specification.new(reader, result.dup { |r| r.direction = :forward })
     end
 
     # Sets the order of reading events to descending (backward from the start).
@@ -93,7 +50,7 @@ module RubyEventStore
     #
     # @return [Specification]
     def backward
-      Specification.new(repository, mapper, result.dup.tap { |r| r.direction = :backward })
+      Specification.new(reader, result.dup { |r| r.direction = :backward })
     end
 
     # Limits the query to specified number of events.
@@ -103,7 +60,7 @@ module RubyEventStore
     # @return [Specification]
     def limit(count)
       raise InvalidPageSize unless count && count > 0
-      Specification.new(repository, mapper, result.dup.tap { |r| r.count = count })
+      Specification.new(reader, result.dup { |r| r.count = count })
     end
 
     # Executes the query based on the specification built up to this point.
@@ -115,9 +72,8 @@ module RubyEventStore
     def each_batch
       return to_enum(:each_batch) unless block_given?
 
-      result_  = result.batched? ? result : result.tap { |r| r.batch_size = DEFAULT_BATCH_SIZE }
-      repository.read(result_).each do |batch|
-        yield batch.map { |serialized_record| mapper.serialized_record_to_event(serialized_record) }
+      reader.each(in_batches(result.batch_size).result) do |batch|
+        yield batch
       end
     end
 
@@ -149,11 +105,46 @@ module RubyEventStore
     # @param batch_size [Integer] number of events to read in a single batch
     # @return [Specification]
     def in_batches(batch_size = DEFAULT_BATCH_SIZE)
-      Specification.new(repository, mapper, result.dup.tap { |r| r.batch_size = batch_size })
+      Specification.new(reader, result.dup { |r| r.read_as = :batch; r.batch_size = batch_size })
     end
     alias :in_batches_of :in_batches
 
+    # Specifies that only first event should be read.
+    # {http://railseventstore.org/docs/read/ Find out more}.
+    #
+    # @return [Specification]
+    def read_first
+      Specification.new(reader, result.dup { |r| r.read_as = :first })
+    end
+
+    # Specifies that only last event should be read.
+    # {http://railseventstore.org/docs/read/ Find out more}.
+    #
+    # @return [Specification]
+    def read_last
+      Specification.new(reader, result.dup { |r| r.read_as = :last })
+    end
+
+    # 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}.
+    #
+    # @return [Event, nil]
+    def first
+      reader.one(read_first.result)
+    end
+
+    # 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}.
+    #
+    # @return [Event, nil]
+    def last
+      reader.one(read_last.result)
+    end
+
+    attr_reader :result
     private
-    attr_reader :repository, :mapper
+    attr_reader :reader
   end
 end

data/lib/ruby_event_store/specification_reader.rb

@@ -0,0 +1,35 @@
+module RubyEventStore
+  # Used for fetching events based on given query specification.
+  class SpecificationReader
+    # @api private
+    # @private
+    def initialize(repository, mapper)
+      @repository = repository
+      @mapper = mapper
+    end
+
+    # @api private
+    # @private
+    def one(specification_result)
+      record = repository.read(specification_result)
+      mapper.serialized_record_to_event(record) if record
+    end
+
+    # @api private
+    # @private
+    def each(specification_result)
+      repository.read(specification_result).each do |batch|
+        yield batch.map { |serialized_record| mapper.serialized_record_to_event(serialized_record) }
+      end
+    end
+
+    # @api private
+    # @private
+    def has_event?(event_id)
+      repository.has_event?(event_id)
+    end
+
+    private
+    attr_reader :repository, :mapper
+  end
+end

data/lib/ruby_event_store/specification_result.rb

@@ -0,0 +1,206 @@
+module RubyEventStore
+  class SpecificationResult
+    def initialize(direction: :forward,
+                   start: :head,
+                   count: nil,
+                   stream: Stream.new(GLOBAL_STREAM),
+                   read_as: :all,
+                   batch_size: Specification::DEFAULT_BATCH_SIZE)
+      @attributes = Struct.new(:direction, :start, :count, :stream, :read_as, :batch_size)
+        .new(direction, start, count, stream, read_as, batch_size)
+      freeze
+    end
+
+    # Limited results. True if number of read elements are limited
+    # {http://railseventstore.org/docs/read/ Find out more}.
+    #
+    # @return [Boolean]
+    def limit?
+      !attributes.count.nil?
+    end
+
+    # Results limit or infinity if limit not defined
+    # {http://railseventstore.org/docs/read/ Find out more}.
+    #
+    # @return [Integer|Infinity]
+    def limit
+      attributes.count || Float::INFINITY
+    end
+
+    # Stream definition. Stream to be read or nil
+    # {http://railseventstore.org/docs/read/ Find out more}.
+    #
+    # @return [Stream|nil]
+    def stream
+      attributes.stream
+    end
+
+    # Starting position. True is starting from head
+    # {http://railseventstore.org/docs/read/ Find out more}.
+    #
+    # @return [Boolean]
+    def head?
+      start.equal?(:head)
+    end
+
+    # Starting position. Event id of starting event or :head
+    # {http://railseventstore.org/docs/read/ Find out more}.
+    #
+    # @return [String|Symbol]
+    def start
+      attributes.start
+    end
+
+    # Read direction. True is reading forward
+    # {http://railseventstore.org/docs/read/ Find out more}.
+    #
+    # @return [Boolean]
+    def forward?
+      get_direction.equal?(:forward)
+    end
+
+    # Read direction. True is reading backward
+    # {http://railseventstore.org/docs/read/ Find out more}.
+    #
+    # @return [Boolean]
+    def backward?
+      get_direction.equal?(:backward)
+    end
+
+    # Size of batch to read (only for :batch read strategy)
+    # {http://railseventstore.org/docs/read/ Find out more}.
+    #
+    # @return [Integer]
+    def batch_size
+      attributes.batch_size
+    end
+
+    # Read strategy. True if items will be read in batches
+    # {http://railseventstore.org/docs/read/ Find out more}.
+    #
+    # @return [Boolean]
+    def batched?
+      attributes.read_as.equal?(:batch)
+    end
+
+    # Read strategy. True if first item will be read
+    # {http://railseventstore.org/docs/read/ Find out more}.
+    #
+    # @return [Boolean]
+    def first?
+      attributes.read_as.equal?(:first)
+    end
+
+    # Read strategy. True if last item will be read
+    # {http://railseventstore.org/docs/read/ Find out more}.
+    #
+    # @return [Boolean]
+    def last?
+      attributes.read_as.equal?(:last)
+    end
+
+    # Read strategy. True if all items will be read
+    # {http://railseventstore.org/docs/read/ Find out more}.
+    #
+    # @return [Boolean]
+    def all?
+      attributes.read_as.equal?(:all)
+    end
+
+    # Clone [SpecificationResult]
+    # If block is given cloned attributes might be modified.
+    #
+    # @return [SpecificationResult]
+    def dup
+      new_attributes = attributes.dup
+      yield new_attributes if block_given?
+      SpecificationResult.new(new_attributes.to_h)
+    end
+
+    # Two specification attributess are equal if:
+    # * they are of the same class
+    # * have identical data (verified with eql? method)
+    #
+    # @param other_spec [SpecificationResult, Object] object to compare
+    #
+    # @return [TrueClass, FalseClass]
+    def ==(other_spec)
+      other_spec.hash.eql?(hash)
+    end
+
+    # @private
+    BIG_VALUE = 0b100010010100011110111101100001011111100101001010111110101000000
+
+    # Generates a Fixnum hash value for this object. This function
+    # have the property that a.eql?(b) implies a.hash == b.hash.
+    #
+    # The hash value is used along with eql? by the Hash class to
+    # determine if two objects reference the same hash key.
+    #
+    # This hash is based on
+    # * class
+    # * direction
+    # * start
+    # * count
+    # * stream
+    # * read_as
+    # * batch_size
+    #
+    # @return [Integer]
+    def hash
+      [
+        self.class,
+        get_direction,
+        start,
+        limit,
+        stream,
+        attributes.read_as,
+        batch_size,
+      ].hash ^ BIG_VALUE
+    end
+
+    # @deprecated Use {#limit} instead. {https://github.com/RailsEventStore/rails_event_store/releases/tag/v0.32.0 More info}
+    def count
+      warn <<~EOW
+        RubyEventStore::SpecificationResult#count has been deprecated.
+        Use RubyEventStore::SpecificationResult#limit instead.
+      EOW
+      limit
+    end
+
+    # @deprecated Use {#forward?} or {#backward?} instead. {https://github.com/RailsEventStore/rails_event_store/releases/tag/v0.32.0 More info}
+    def direction
+      warn <<~EOW
+        RubyEventStore::SpecificationResult#direction has been deprecated.
+        Use RubyEventStore::SpecificationResult#forward? or
+        RubyEventStore::SpecificationResult#backward? instead.
+      EOW
+      get_direction
+    end
+
+    # @deprecated Use {#stream.name} instead. {https://github.com/RailsEventStore/rails_event_store/releases/tag/v0.32.0 More info}
+    def stream_name
+      warn <<~EOW
+        RubyEventStore::SpecificationResult#stream_name has been deprecated.
+        Use RubyEventStore::SpecificationResult#stream.name instead.
+      EOW
+      stream.name
+    end
+
+    # @deprecated Use {#stream.global?} instead. {https://github.com/RailsEventStore/rails_event_store/releases/tag/v0.32.0 More info}
+    def global_stream?
+      warn <<~EOW
+        RubyEventStore::SpecificationResult#global_stream? has been deprecated.
+        Use RubyEventStore::SpecificationResult#stream.global? instead.
+      EOW
+      stream.global?
+    end
+
+    private
+    attr_reader :attributes
+
+    def get_direction
+      attributes.direction
+    end
+  end
+end

data/lib/ruby_event_store/version.rb

@@ -1,3 +1,3 @@
 module RubyEventStore
-  VERSION = "0.31.1"
+  VERSION = "0.32.0"
 end

data/ruby_event_store.gemspec

@@ -30,9 +30,10 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency 'bundler', '~> 1.15'
   spec.add_development_dependency 'rake', '~> 10.0'
   spec.add_development_dependency 'rspec', '~> 3.6'
-  spec.add_development_dependency 'mutant-rspec', '~> 0.8.14'
+  spec.add_development_dependency 'mutant-rspec', '~> 0.8.17'
   spec.add_development_dependency 'parser'
   spec.add_development_dependency 'unparser'
   spec.add_development_dependency 'astrolabe'
   spec.add_development_dependency 'google-protobuf', '~> 3.5.1.2'
+  spec.add_development_dependency 'activesupport', '~> 5.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ruby_event_store
 version: !ruby/object:Gem::Version
-  version: 0.31.1
+  version: 0.32.0
 platform: ruby
 authors:
 - Arkency
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-07-17 00:00:00.000000000 Z
+date: 2018-09-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: concurrent-ruby
@@ -72,14 +72,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.8.14
+        version: 0.8.17
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.8.14
+        version: 0.8.17
 - !ruby/object:Gem::Dependency
   name: parser
   requirement: !ruby/object:Gem::Requirement
@@ -136,6 +136,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 3.5.1.2
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
 description: Implementation of Event Store in Ruby
 email:
 - dev@arkency.com
@@ -154,15 +168,18 @@ files:
 - lib/ruby_event_store/async_proxy_strategy.rb
 - lib/ruby_event_store/batch_enumerator.rb
 - lib/ruby_event_store/client.rb
+- lib/ruby_event_store/composed_dispatcher.rb
 - lib/ruby_event_store/constants.rb
 - lib/ruby_event_store/correlated_commands.rb
 - lib/ruby_event_store/deprecated_read_api_rewriter.rb
 - lib/ruby_event_store/deprecated_read_api_runner.rb
-- lib/ruby_event_store/deprecations.rb
 - lib/ruby_event_store/errors.rb
 - lib/ruby_event_store/event.rb
 - lib/ruby_event_store/expected_version.rb
+- lib/ruby_event_store/immediate_async_dispatcher.rb
 - lib/ruby_event_store/in_memory_repository.rb
+- lib/ruby_event_store/instrumented_dispatcher.rb
+- lib/ruby_event_store/instrumented_repository.rb
 - lib/ruby_event_store/link_by_metadata.rb
 - lib/ruby_event_store/mappers/default.rb
 - lib/ruby_event_store/mappers/null_mapper.rb
@@ -176,8 +193,11 @@ files:
 - lib/ruby_event_store/spec/broker_lint.rb
 - lib/ruby_event_store/spec/dispatcher_lint.rb
 - lib/ruby_event_store/spec/event_repository_lint.rb
+- lib/ruby_event_store/spec/scheduler_lint.rb
 - lib/ruby_event_store/spec/subscriptions_lint.rb
 - lib/ruby_event_store/specification.rb
+- lib/ruby_event_store/specification_reader.rb
+- lib/ruby_event_store/specification_result.rb
 - lib/ruby_event_store/stream.rb
 - lib/ruby_event_store/version.rb
 - ruby_event_store.gemspec