ruby_event_store 0.12.1 → 0.13.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 977449503b7509bf29e5ed508ecd7eee1423cc9f
-  data.tar.gz: 2dc475ea4234c521c9404a2a6468c1c8670289eb
+  metadata.gz: b76da76feedfe6a7a47b7580ae2ef14bb64785a7
+  data.tar.gz: 970d9fa6c06ad47649e1bb5f35db967d76508ba8
 SHA512:
-  metadata.gz: 4c64882d002f71d4608508e26c4310045da83dbf502db615d9bba52810f99ce02fb85c30423d609dab4bdbd0775efc2b6e034a3c15ee3098beca863bf0fc0ff6
-  data.tar.gz: 7f8743b45d31462da6074ca737f33a1dfc4805035e594d2564d9f8f15cb37fce5964afc30e8b9ba221faf9d8e827084eba883e8e009692ff2d2dfa4ccad08efe
+  metadata.gz: 8d952639196c9a5d24b06d985074dbcaf21c494c20c427c3e3af622f6ae096d4bbd36571f203c2eb2c7ed925aea49ea6262f445b50286eafb8ff22bb96366036
+  data.tar.gz: e594bb468b2ea6497c365d5c68709bc0688093331654fe3ef6b41740b331ba21225cdf13ae44c4650446a9d49ae1a2c74998adbf25b71367cccbe9989674a9ac

data/CHANGELOG.md

@@ -1,3 +1,11 @@
+### 0.13.0 (15.10.2016)
+
+* Change: Dropped ClosedStruct event (meta)data wrapping PR #34
+          Fix for Issue with ClosedStruct and object_id #33
+* Change: Refactor RubyEventStore::Client to have the same methods signatures as RailsEventStore::Client (PR #35),
+          this will allow to remove most of the code form RailsEventStore::Client without breaking current
+          applications that use RailsEventStore::Client. This change is however a breaking one for RubyEventStore.
+
 ### 0.12.1 (11.08.2016)
 
 * Fix: improve EventRepository specification tests (mutation tests)

data/README.md

@@ -16,6 +16,16 @@ All documentation and sample codes are available at [http://railseventstore.arke
 
 Check the contribution guide on [CONTRIBUTING.md](https://github.com/arkency/ruby_event_store/blob/master/CONTRIBUTING.md)
 
+We're aiming for 100% mutation coverage in this project.
+Read the reasoning:
+
+[Why I want to introduce mutation testing to the rails_event_store gem](http://blog.arkency.com/2015/04/why-i-want-to-introduce-mutation-testing-to-the-rails-event-store-gem/)
+
+[Mutation testing and continuous integration](http://blog.arkency.com/2015/05/mutation-testing-and-continuous-integration/)
+
+In practice, it means that we run `make mutate` as part of the CI process.
+Whenever you fix a bug or add a new feature, we require that the coverage doesn't go down.
+
 ## About
 
 <img src="http://arkency.com/images/arkency.png" alt="Arkency" width="20%" align="left" />

data/lib/ruby_event_store/client.rb

@@ -1,21 +1,22 @@
 module RubyEventStore
   class Client
-    def initialize(repository,
+    def initialize(repository:,
                    event_broker:  PubSub::Broker.new,
+                   page_size: PAGE_SIZE,
                    metadata_proc: nil)
       @repository     = repository
       @event_broker   = event_broker
+      @page_size      = page_size
       @metadata_proc  = metadata_proc
     end
-    attr_reader :repository, :event_broker
 
     def publish_event(event, stream_name: GLOBAL_STREAM, expected_version: :any)
-      append_to_stream(stream_name, event, expected_version: expected_version)
+      append_to_stream(event, stream_name: stream_name, expected_version: expected_version)
       event_broker.notify_subscribers(event)
       :ok
     end
 
-    def append_to_stream(stream_name, event, expected_version: :any)
+    def append_to_stream(event, stream_name: GLOBAL_STREAM, expected_version: :any)
       validate_expected_version(stream_name, expected_version)
       enriched_event = enrich_event_metadata(event)
       repository.create(enriched_event, stream_name)
@@ -28,13 +29,13 @@ module RubyEventStore
       :ok
     end
 
-    def read_events_forward(stream_name, start, count)
+    def read_events_forward(stream_name, start: :head, count: page_size)
       raise IncorrectStreamData if stream_name.nil? || stream_name.empty?
       page = Page.new(repository, start, count)
       repository.read_events_forward(stream_name, page.start, page.count)
     end
 
-    def read_events_backward(stream_name, start, count)
+    def read_events_backward(stream_name, start: :head, count: page_size)
       raise IncorrectStreamData if stream_name.nil? || stream_name.empty?
       page = Page.new(repository, start, count)
       repository.read_events_backward(stream_name, page.start, page.count)
@@ -50,12 +51,12 @@ module RubyEventStore
       repository.read_stream_events_backward(stream_name)
     end
 
-    def read_all_streams_forward(start, count)
+    def read_all_streams_forward(start: :head, count: page_size)
       page = Page.new(repository, start, count)
       repository.read_all_streams_forward(page.start, page.count)
     end
 
-    def read_all_streams_backward(start, count)
+    def read_all_streams_backward(start: :head, count: page_size)
       page = Page.new(repository, start, count)
       repository.read_all_streams_backward(page.start, page.count)
     end
@@ -73,14 +74,14 @@ module RubyEventStore
     end
 
     private
-    attr_reader :metadata_proc
+    attr_reader :repository, :page_size, :event_broker, :metadata_proc
 
     def enrich_event_metadata(event)
-      metadata = event.metadata.to_h
+      metadata = event.metadata
       metadata[:timestamp] ||= Time.now.utc
       metadata.merge!(metadata_proc.call || {}) if metadata_proc
 
-      event.class.new(event_id: event.event_id, metadata: metadata, data: event.data.to_h)
+      event.class.new(event_id: event.event_id, metadata: metadata, data: event.data)
     end
 
     def handle_subscribe(unsub)

data/lib/ruby_event_store/event.rb

@@ -1,25 +1,24 @@
 require 'securerandom'
-require 'closed_struct'
 
 module RubyEventStore
   class Event
-    def initialize(event_id: SecureRandom.uuid, metadata: {}, data: {})
+    def initialize(event_id: SecureRandom.uuid, metadata: nil, data: nil)
       @event_id = event_id.to_s
-      @metadata = ClosedStruct.new(metadata)
-      @data     = ClosedStruct.new(data)
+      @metadata = metadata.to_h
+      @data     = data.to_h
     end
     attr_reader :event_id, :metadata, :data
 
     def to_h
       {
           event_id:   event_id,
-          metadata:   metadata.to_h,
-          data:       data.to_h
+          metadata:   metadata,
+          data:       data
       }
     end
 
     def timestamp
-      metadata.timestamp rescue nil
+      metadata[:timestamp]
     end
 
     def ==(other_event)

data/lib/ruby_event_store/projection.rb

@@ -39,7 +39,7 @@ module RubyEventStore
     end
 
     def call(event)
-      handlers[event.class].(current_state, event)
+      handlers.fetch(event.class).(current_state, event)
     end
 
     def handled_events
@@ -58,13 +58,13 @@ module RubyEventStore
     def reduce_from_streams(event_store, start, count)
       raise ArgumentError.new('Start must be an array with event ids or :head') unless (start.instance_of?(Array) && start.size === streams.size) || start === :head
       streams.zip(start_events(start)).reduce(initial_state) do |state, (stream_name, start_event_id)|
-        event_store.read_events_forward(stream_name, start_event_id, count).reduce(state, &method(:transition))
+        event_store.read_events_forward(stream_name, start: start_event_id, count: count).reduce(state, &method(:transition))
       end
     end
 
     def reduce_from_all_streams(event_store, start, count)
       raise ArgumentError.new('Start must be valid event id or :head') unless start.instance_of?(String) || start === :head
-      event_store.read_all_streams_forward(start, count).reduce(initial_state, &method(:transition))
+      event_store.read_all_streams_forward(start: start, count: count).reduce(initial_state, &method(:transition))
     end
 
     def start_events(start)

data/lib/ruby_event_store/pub_sub/broker.rb

@@ -54,12 +54,12 @@ module RubyEventStore
       end
 
       def subscribe(subscriber, event_types)
-        event_types.each{ |type| subscribers[type] << subscriber }
-        ->() {event_types.each{ |type| subscribers[type].delete(subscriber) } }
+        event_types.each{ |type| subscribers[type.name] << subscriber }
+        ->() {event_types.each{ |type| subscribers.fetch(type.name).delete(subscriber) } }
       end
 
       def all_subscribers_for(event_type)
-        subscribers[event_type] + @global_subscribers
+        subscribers[event_type.name] + @global_subscribers
       end
     end
   end

data/lib/ruby_event_store/spec/event_repository_lint.rb

@@ -1,6 +1,6 @@
 RSpec.shared_examples :event_repository do |repository_class|
   TestDomainEvent = Class.new(RubyEventStore::Event)
-  subject(:repository)  { repository_class.new }
+  let(:repository) { subject || repository_class.new }
 
   it 'just created is empty' do
     expect(repository.read_all_streams_forward(:head, 1)).to be_empty
@@ -24,14 +24,14 @@ RSpec.shared_examples :event_repository do |repository_class|
     event = TestDomainEvent.new(data: { order_id: 3 })
     repository.create(event, 'stream')
     retrieved_event = repository.read_all_streams_forward(:head, 1).first
-    expect(retrieved_event.data.order_id).to eq(3)
+    expect(retrieved_event.data[:order_id]).to eq(3)
   end
 
   it 'metadata attributes are retrieved' do
     event = TestDomainEvent.new(metadata: { request_id: 3 })
     repository.create(event, 'stream')
     retrieved_event = repository.read_all_streams_forward(:head, 1).first
-    expect(retrieved_event.metadata.request_id).to eq(3)
+    expect(retrieved_event.metadata[:request_id]).to eq(3)
   end
 
   it 'does not have deleted streams' do

data/lib/ruby_event_store/version.rb

@@ -1,3 +1,3 @@
 module RubyEventStore
-  VERSION = '0.12.1'
+  VERSION = '0.13.0'
 end

data/ruby_event_store.gemspec

@@ -4,7 +4,7 @@ $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require 'ruby_event_store/version'
 
 Gem::Specification.new do |spec|
-  spec.name          = "ruby_event_store"
+  spec.name          = 'ruby_event_store'
   spec.version       = RubyEventStore::VERSION
   spec.licenses      = ['MIT']
   spec.authors       = ['Arkency']
@@ -15,14 +15,13 @@ Gem::Specification.new do |spec|
   spec.homepage      = 'https://github.com/arkency/ruby_event_store'
 
   spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
-  spec.bindir        = "exe"
+  spec.bindir        = 'exe'
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
-  spec.require_paths = ["lib"]
+  spec.require_paths = ['lib']
 
-  spec.add_dependency "closed_struct", "~> 0.1"
-  spec.add_development_dependency "bundler", "~> 1.8"
-  spec.add_development_dependency "rake", "~> 10.0"
-  spec.add_development_dependency 'rspec', "~> 3.2"
-  spec.add_development_dependency 'pry', "~> 0"
-  spec.add_development_dependency 'mutant-rspec', '~> 0.7.9'
+  spec.add_development_dependency 'bundler', '~> 1.8'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec', '~> 3.4'
+  spec.add_development_dependency 'pry', '~> 0'
+  spec.add_development_dependency 'mutant-rspec', '~> 0.8.11'
 end

metadata

@@ -1,29 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: ruby_event_store
 version: !ruby/object:Gem::Version
-  version: 0.12.1
+  version: 0.13.0
 platform: ruby
 authors:
 - Arkency
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-08-11 00:00:00.000000000 Z
+date: 2016-10-15 00:00:00.000000000 Z
 dependencies:
-- !ruby/object:Gem::Dependency
-  name: closed_struct
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.1'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.1'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -58,14 +44,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.2'
+        version: '3.4'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.2'
+        version: '3.4'
 - !ruby/object:Gem::Dependency
   name: pry
   requirement: !ruby/object:Gem::Requirement
@@ -86,14 +72,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.7.9
+        version: 0.8.11
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.7.9
+        version: 0.8.11
 description: Implementation of Event Store in Ruby
 email:
 - dev@arkency.com
@@ -142,7 +128,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.5.1
+rubygems_version: 2.6.7
 signing_key: 
 specification_version: 4
 summary: Event Store in Ruby