ruby_event_store 0.32.0 → 0.33.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: bab926d223e59f80a3c302a45cc70f6cfd4d82e5f768294701ca5474c63c03bd
-  data.tar.gz: 8856dbe54742b11daa510d45b9d6b7dd48d19b82593796786c9a4a859b852655
+  metadata.gz: 72b0e4a52d4e09c87ef8b190fd2e310c306469d053b517c3d93facf2fee6a918
+  data.tar.gz: ff0344153ae4e205e709da00b703b3a85605ac0c4c3aafb5b20439adce26a60e
 SHA512:
-  metadata.gz: 528ba2456e22858c87dea1cea275fd97a63404080c2b7143248ccec3b43c2be45781fe20caf3460afb8d01e900cc5db40c99962686d66a84d40c66cee694288f
-  data.tar.gz: 65100e90a4ed432b7ded41bca6f15d30a4acd60b21bdea373ad191900f8f98bb610605481fd4b3f3d9b1bf19718a527114f8f6582b941d4a7f48286fe8f41ec3
+  metadata.gz: 1bd120b03290fa27864af3ab4aa7d07cbda4bf1786beb7523103e67d04d02ec2c3fdeb5af6fea9df304a296a658cff944aefd91790ea21839cbc213a53313b60
+  data.tar.gz: 710cba6e537aa3378ad677d72d6f170a91fb2c617e8bdc583aa35f03ebe78d202f0c4c40b48e6a3c88728bbcefc422a7414335d8205c6813ebd87b86b12fb892

data/Makefile

@@ -9,10 +9,6 @@ IGNORE      = RubyEventStore::InMemoryRepository\#append_with_synchronize \
               RubyEventStore::Client::Within\#add_thread_global_subscribers \
               RubyEventStore::DeprecatedReadAPIRunner* \
               RubyEventStore::DeprecatedReadAPIRewriter* \
-              RubyEventStore::Client\#publish_event \
-              RubyEventStore::Client\#publish_events \
-              RubyEventStore::Client\#link_to_stream \
-              RubyEventStore::Client\#append_to_stream \
               RubyEventStore::AsyncDispatcher* \
               RubyEventStore::AsyncProxyStrategy::Inline* \
               RubyEventStore::SpecificationResult\#count \

data/lib/ruby_event_store/client.rb

@@ -37,36 +37,6 @@ module RubyEventStore
       self
     end
 
-    # @deprecated Use {#publish} instead
-    def publish_events(events, stream_name: GLOBAL_STREAM, expected_version: :any)
-      warn <<~EOW
-        RubyEventStore::Client#publish_events has been deprecated.
-
-        Use RubyEventStore::Client#publish instead
-      EOW
-      publish(events, stream_name: stream_name, expected_version: expected_version)
-    end
-
-    # @deprecated Use {#publish} instead
-    def publish_event(event, stream_name: GLOBAL_STREAM, expected_version: :any)
-      warn <<~EOW
-        RubyEventStore::Client#publish_event has been deprecated.
-
-        Use RubyEventStore::Client#publish instead
-      EOW
-      publish(event, stream_name: stream_name, expected_version: expected_version)
-    end
-
-    # @deprecated Use {#append} instead
-    def append_to_stream(events, stream_name: GLOBAL_STREAM, expected_version: :any)
-      warn <<~EOW
-        RubyEventStore::Client#append_to_stream has been deprecated.
-
-        Use RubyEventStore::Client#append instead
-      EOW
-      append(events, stream_name: stream_name, expected_version: expected_version)
-    end
-
     # Persists new event(s) without notifying any subscribed handlers
     #
     # @param (see #publish)
@@ -89,16 +59,6 @@ module RubyEventStore
       self
     end
 
-    # @deprecated Use {#link} instead
-    def link_to_stream(event_ids, stream_name:, expected_version: :any)
-      warn <<~EOW
-        RubyEventStore::Client#link_to_stream has been deprecated.
-
-        Use RubyEventStore::Client#link instead
-      EOW
-      link(event_ids, stream_name: stream_name, expected_version: expected_version)
-    end
-
     # Deletes a stream.
     # All events from the stream remain intact but they are no
     # longer linked to the stream.
@@ -110,12 +70,14 @@ module RubyEventStore
       self
     end
 
-    # Returns a single, persisted event based on its ID.
-    #
-    # @param event_id [String] event id
-    # @return [Event, Proto]
+    # @deprecated Use {#read.event!(event_id)} instead. {https://github.com/RailsEventStore/rails_event_store/releases/tag/v0.33.0 More info}
     def read_event(event_id)
-      deserialize_event(repository.read_event(event_id))
+      warn <<~EOW
+        RubyEventStore::Client#read_event(event_id) has been deprecated.
+        Use `client.read.event!(event_id)` instead. Also available without
+        bang - return nil when no event is found.
+      EOW
+      read.event!(event_id)
     end
 
     # Starts building a query specification for reading events.
@@ -320,6 +282,10 @@ module RubyEventStore
       self
     end
 
+    def inspect
+      "#<#{self.class}:0x#{__id__.to_s(16)}>"
+    end
+
     EMPTY_HASH = {}.freeze
     private_constant :EMPTY_HASH
 
@@ -331,10 +297,6 @@ module RubyEventStore
       end
     end
 
-    def deserialize_event(sev)
-      mapper.serialized_record_to_event(sev)
-    end
-
     def normalize_to_array(events)
       return *events
     end

data/lib/ruby_event_store/in_memory_repository.rb

@@ -31,12 +31,9 @@ module RubyEventStore
       stream_of(stream.name).last
     end
 
-    def read_event(event_id)
-      global.find {|e| event_id.eql?(e.event_id)} or raise EventNotFound.new(event_id)
-    end
-
     def read(spec)
       events = spec.stream.global? ? global : stream_of(spec.stream.name)
+      events = events.select{|e| spec.with_ids.any?{|x| x.eql?(e.event_id)}} if spec.with_ids?
       events = events.reverse if spec.backward?
       events = events.drop(index_of(events, spec.start) + 1) unless spec.head?
       events = events[0...spec.limit] if spec.limit?
@@ -71,6 +68,10 @@ module RubyEventStore
 
     private
 
+    def read_event(event_id)
+      global.find {|e| event_id.eql?(e.event_id)} or raise EventNotFound.new(event_id)
+    end
+
     def stream_of(name)
       streams.fetch(name, Array.new)
     end

data/lib/ruby_event_store/instrumented_repository.rb

@@ -31,12 +31,6 @@ module RubyEventStore
       repository.last_stream_event(stream)
     end
 
-    def read_event(event_id)
-      instrumentation.instrument("read_event.repository.rails_event_store", event_id: event_id) do
-        repository.read_event(event_id)
-      end
-    end
-
     def read(specification)
       instrumentation.instrument("read.repository.rails_event_store", specification: specification) do
         repository.read(specification)

data/lib/ruby_event_store/spec/event_repository_lint.rb

@@ -953,25 +953,6 @@ module RubyEventStore
       expect(repository.has_event?('9bedf448-e4d0-41a3-a8cd-f94aec7aa763')).to be_falsey
     end
 
-    specify 'reading particular event' do
-      test_event = SRecord.new(event_id: "941cd8f5-b3f9-47af-b4e4-07f8cea37467")
-      repository.
-        append_to_stream(SRecord.new, stream_test, version_none).
-        append_to_stream(test_event, stream_test, version_0)
-
-      expect(repository.read_event("941cd8f5-b3f9-47af-b4e4-07f8cea37467")).to eq(test_event)
-    end
-
-    specify 'reading non-existent event' do
-      expect do
-        repository.read_event('72922e65-1b32-4e97-8023-03ae81dd3a27')
-      end.to raise_error do |err|
-        expect(err).to be_a(EventNotFound)
-        expect(err.event_id).to eq('72922e65-1b32-4e97-8023-03ae81dd3a27')
-        expect(err.message).to eq('Event not found: 72922e65-1b32-4e97-8023-03ae81dd3a27')
-      end
-    end
-
     specify 'linking non-existent event' do
       skip unless test_link_events_to_stream
       expect do
@@ -1192,5 +1173,27 @@ module RubyEventStore
       expect(repository.streams_of(event_3.event_id)).to eq [stream_b]
       expect(repository.streams_of(event_4.event_id)).to eq []
     end
+
+    specify do
+      e1 = SRecord.new(event_id: '8a6f053e-3ce2-4c82-a55b-4d02c66ae6ea')
+      e2 = SRecord.new(event_id: '8cee1139-4f96-483a-a175-2b947283c3c7')
+      e3 = SRecord.new(event_id: 'd345f86d-b903-4d78-803f-38990c078d9e')
+      stream = Stream.new('Stream A')
+      repository.append_to_stream([e1, e2, e3], stream, version_any)
+
+      expect(repository.read(specification.with_id([
+        '8a6f053e-3ce2-4c82-a55b-4d02c66ae6ea'
+      ]).read_first.result)).to eq(e1)
+      expect(repository.read(specification.with_id([
+        'd345f86d-b903-4d78-803f-38990c078d9e'
+      ]).read_first.result)).to eq(e3)
+      expect(repository.read(specification.with_id([
+        'c31b327c-0da1-4178-a3cd-d2f6bb5d0688'
+      ]).read_first.result)).to eq(nil)
+      expect(repository.read(specification.with_id([
+        '8a6f053e-3ce2-4c82-a55b-4d02c66ae6ea',
+        'd345f86d-b903-4d78-803f-38990c078d9e'
+      ]).in_batches.result).to_a[0]).to eq([e1,e3])
+    end
   end
 end

data/lib/ruby_event_store/specification.rb

@@ -143,6 +143,46 @@ module RubyEventStore
       reader.one(read_last.result)
     end
 
+    # Limits the query to certain events by given even ids.
+    # {http://railseventstore.org/docs/read/ Find out more}.
+    #
+    # @param even_ids [Array(String)] ids of event to look for.
+    # @return [Specification]
+    def with_id(event_ids)
+      Specification.new(reader, result.dup{ |r| r.with_ids = event_ids })
+    end
+
+    # Executes the query based on the specification built up to this point.
+    # 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}.
+    #
+    # @return [Event, nil]
+    def event(event_id)
+      reader.one(read_first.with_id([event_id]).result)
+    end
+
+    # Executes the query based on the specification built up to this point.
+    # 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}.
+    #
+    # @return [Event]
+    def event!(event_id)
+      event(event_id) or raise EventNotFound.new(event_id)
+    end
+
+    # Executes the query based on the specification built up to this point.
+    # 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}.
+    #
+    # @yield [Event, Proto] event
+    # @return [Enumerator, nil] Enumerator is returned when block not given
+    def events(event_ids)
+      with_id(event_ids).each
+    end
+
     attr_reader :result
     private
     attr_reader :reader

data/lib/ruby_event_store/specification_result.rb

@@ -5,9 +5,10 @@ module RubyEventStore
                    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)
+                   batch_size: Specification::DEFAULT_BATCH_SIZE,
+                   with_ids: nil)
+      @attributes = Struct.new(:direction, :start, :count, :stream, :read_as, :batch_size, :with_ids)
+        .new(direction, start, count, stream, read_as, batch_size, with_ids)
       freeze
     end
 
@@ -75,6 +76,22 @@ module RubyEventStore
       attributes.batch_size
     end
 
+    # Ids of specified event to be read (if any given)
+    # {http://railseventstore.org/docs/read/ Find out more}.
+    #
+    # @return [Array|nil]
+    def with_ids
+      attributes.with_ids
+    end
+
+    # Read by specified ids. True if event ids have been specified.
+    # {http://railseventstore.org/docs/read/ Find out more}.
+    #
+    # @return [Boolean]
+    def with_ids?
+      !(with_ids || []).empty?
+    end
+
     # Read strategy. True if items will be read in batches
     # {http://railseventstore.org/docs/read/ Find out more}.
     #
@@ -145,6 +162,7 @@ module RubyEventStore
     # * stream
     # * read_as
     # * batch_size
+    # * with_ids
     #
     # @return [Integer]
     def hash
@@ -156,6 +174,7 @@ module RubyEventStore
         stream,
         attributes.read_as,
         batch_size,
+        with_ids,
       ].hash ^ BIG_VALUE
     end
 

data/lib/ruby_event_store/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ruby_event_store
 version: !ruby/object:Gem::Version
-  version: 0.32.0
+  version: 0.33.0
 platform: ruby
 authors:
 - Arkency
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-09-27 00:00:00.000000000 Z
+date: 2018-10-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: concurrent-ruby
@@ -225,7 +225,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.7.6
+rubygems_version: 3.0.0.beta1
 signing_key: 
 specification_version: 4
 summary: Event Store in Ruby