event_source 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: f482b09497aecd4c9d777e9044129236d63492e4
-  data.tar.gz: cd32bd6e04351a71e77aaf1c22e51e14f437dca1
+  metadata.gz: c19116c721153204680c617cdc457f7a25f6a2f2
+  data.tar.gz: e98c273e30762a3f39837da4acc5fa90aa3f8c04
 SHA512:
-  metadata.gz: bef50c5d9b5fa8e3691da030a59cc002f1c3ea62794a5510b5c8318252d7704c6a07893077902073b02312f6ace48e2078b351dab3e009ed447847da72be7625
-  data.tar.gz: 09fb34fd611b0a9146e913f3a512cac0afb31334d744bb31024db007889debc1c72382c8f53e5729c957006428ac76751b19d2fadfbcb25bb65221b90c7d7c0e
+  metadata.gz: 01fbce1dd57be53843a795d7af98dcb4eff52d685e9d80658bc266ab50730af8cd939fd2478cc87a77b485c20b62ca316e33d56a108cbf843e073d487e29e186
+  data.tar.gz: 9f0bc832b4cf6188110bd9e018be52c4120b1d67fa006698f90b161db09655213f897852aebb171f465971ed4913b4f0472bbb6fff5a20f774927539b8184853

data/README.md

@@ -10,6 +10,12 @@ An event store must be initialized. Currently, only the in_memory SQLlite3 type
 EventSource::EventRepository.create(in_memory: true)
 ```
 
+Once initialized, the event repository is memoized and can be retrieved with:
+
+```ruby
+EventSource::EventRepository.current
+```
+
 ## Your entities
 
 An entity is an object that you intend to persist. You must extend and include some class methods and instance methods. Let's create an entity called BankAccount.
@@ -77,6 +83,8 @@ account = BankAccount.create
 
 This repository is used to store and load entities. It is also used to monitor changes to entities. When a transaction is created, all changes to all entities and all events created will be saved in the event repository.
 
+The entity repository needs an instance of an event repository to work. If you decide to create your own instance of the entity repository, be sure to pass one as a parameter to the initialize method. Thankfully, however, since the event repository is memoize, the entity repository will simply call use it if you don't specify your own.
+
 ### Transactions
 
 ```ruby
@@ -93,9 +101,25 @@ To load an entity, you must create an entity repository and pass it an instance
 
 The 'find' method expects an entity type and the entity's unique identifier. The type, by convention, is simply a lowercase undescored string of the entity class name.
 
+The following will use the default event and entity repositories. No need to create your own:
+
 ```ruby
-event_repo = EventSource::EventRepository.current
-entity_repo = EventSource::EntityRepository.new(event_repo)
+entity_repo = EventSource::EntityRepository.current
 entity = entity_repo.find(:bank_account, uid)
 ```
 
+Since the entity repository will automatically grab a memoize event repository, simply creating one ahead of time will ensure that it is picked up by the entity repository:
+
+```ruby
+event_repo = EventSource::EventRepository.create(:in_memory => true)
+entity_repo = EventSource::EntityRepository.current
+entity = entity_repo.find(:bank_account, uid)
+```
+
+Alternatively, you can instantiate everything yourself
+
+```ruby
+event_repo = EventSource::EventRepository.create(:in_memory => true)
+entity_repo = EventSource::EntityRepository.new(event_repo)
+entity = entity_repo.find(:bank_account, uid)
+```

data/lib/event_source/entity_repository.rb

@@ -7,20 +7,15 @@ require 'active_support/inflector'
 
 module EventSource
     class EntityRepository
+        extend EventSource::MemoizeInstance
+
         attr_reader :entities
 
         class << self
-            @@current = nil
-
             def transaction
-                @@current = self.new
+                self.current.clear
                 yield
-                @@current.commit
-                @@current = nil
-            end
-
-            def current
-                @@current
+                self.current.commit
             end
         end
 
@@ -29,6 +24,10 @@ module EventSource
             @event_repo = event_repo
         end
 
+        def clear
+            @entities.clear
+        end
+
         def add(entity)
             @entities << entity
         end
@@ -36,6 +35,7 @@ module EventSource
         def commit
             # TODO: gather all events of all entities, maintain order and save in batch
             @entities.each {|e| e.save}
+            clear
         end
 
         def find(type, uid)
@@ -53,5 +53,11 @@ module EventSource
 
             entity
         end
+
+        private
+
+        def self.default_args
+            [EventSource::EventRepository.current]
+        end
     end
 end

data/lib/event_source/event_repository.rb

@@ -2,15 +2,13 @@ require 'sequel'
 
 module EventSource
     class EventRepository
+        extend EventSource::MemoizeInstance
+
         attr_reader :db
 
         class << self
-            def current
-                @@instance ||= self.new(in_memory: true)
-            end
-
             def create(options)
-                @@instance = self.new(options)
+                @instance = self.new(options)
             end
         end
 
@@ -31,6 +29,10 @@ module EventSource
 
         private
 
+        def self.default_args
+            [in_memory: true]
+        end
+
         def initialize(options)
             if options[:in_memory] 
                 @db = Sequel.sqlite

data/lib/event_source/memoize_instance.rb

@@ -0,0 +1,11 @@
+module EventSource
+    module MemoizeInstance
+        def current
+            @instance ||= self.send(:new, *default_args())
+        end
+
+        def default_args
+            []
+        end
+    end
+end

data/lib/event_source/version.rb

@@ -1,3 +1,3 @@
 module EventSource
-    Version = '0.1.0'
+    Version = '0.1.1'
 end

data/lib/event_source.rb

@@ -2,6 +2,7 @@ require './lib/event_source/exceptions'
 require './lib/event_source/uid_generator'
 require './lib/event_source/event'
 require './lib/event_source/entity'
+require './lib/event_source/memoize_instance'
 require './lib/event_source/entity_repository'
 require './lib/event_source/event_repository'
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: event_source
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Louis Salin
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-06-06 00:00:00.000000000 Z
+date: 2013-06-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
@@ -82,6 +82,7 @@ files:
 - lib/event_source/entity_repository.rb
 - lib/event_source/version.rb
 - lib/event_source/exceptions.rb
+- lib/event_source/memoize_instance.rb
 - LICENSE
 - README.md
 - CHANGELOG.md