evt-entity_store 0.3.2.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: '09d77f9286b431a0b97ec389c2b2947c15121fd5'
+  data.tar.gz: ca49812c868ff10f425bef7aed92d9c83a24f76a
+SHA512:
+  metadata.gz: ea8c3e111aad9eca62a0be47fea1268dbcaf115daf8c88d25e2f593b2fea094536b37c570ddd31d55763ad2b0250a32728560c540d497362f732c64de2718444
+  data.tar.gz: 926e7cd6460e7240e5877f7d5f3b2d6005643f6c2759455e1dc4bb5200a78dfac213ebe6e98d75af08bc61b75d0633fa0e89e1f1acd5edbfd1f2c7e4082567cc

data/lib/entity_store.rb

@@ -0,0 +1,6 @@
+require 'entity_cache'
+require 'entity_projection'
+
+require 'entity_store/log'
+require 'entity_store/entity_store'
+require 'entity_store/substitute'

data/lib/entity_store/controls.rb

@@ -0,0 +1,14 @@
+require 'entity_projection/controls'
+require 'entity_cache/controls'
+
+require 'entity_store/controls/id'
+require 'entity_store/controls/category'
+require 'entity_store/controls/stream_name'
+require 'entity_store/controls/version'
+require 'entity_store/controls/message'
+require 'entity_store/controls/entity'
+require 'entity_store/controls/projection'
+require 'entity_store/controls/snapshot_interval'
+require 'entity_store/controls/snapshot'
+require 'entity_store/controls/reader'
+require 'entity_store/controls/entity_store'

data/lib/entity_store/controls/category.rb

@@ -0,0 +1,5 @@
+module EntityStore
+  module Controls
+    Category = EventSource::Controls::Category
+  end
+end

data/lib/entity_store/controls/entity.rb

@@ -0,0 +1,54 @@
+module EntityStore
+  module Controls
+    module Entity
+      def self.example
+        Current.example
+      end
+
+      class Example
+        include Schema::DataStructure
+
+        attribute :sum
+
+        module Transformer
+          def self.raw_data(instance)
+            instance.to_h
+          end
+
+          def self.instance(raw_data)
+            Example.build(raw_data)
+          end
+        end
+      end
+
+      module Cached
+        def self.example
+          Example.build :sum => sum
+        end
+
+        def self.add(id, store)
+          entity = self.example
+          version = Version::Cached.example
+
+          store.cache.add(id, entity, version, persisted_version: version)
+
+          return entity, version
+        end
+
+        def self.sum
+          1
+        end
+      end
+
+      module Current
+        def self.example
+          Example.build :sum => sum
+        end
+
+        def self.sum
+          12
+        end
+      end
+    end
+  end
+end

data/lib/entity_store/controls/entity_store.rb

@@ -0,0 +1,60 @@
+module EntityStore
+  module Controls
+    module EntityStore
+      def self.example(category: nil, entity_class: nil, projection_class: nil, reader_class: nil, snapshot_class: nil, snapshot_interval: nil)
+        if category.nil? && entity_class.nil? && projection_class.nil? && reader_class.nil? && snapshot_class.nil? && snapshot_interval.nil?
+          store_class = Example
+        else
+          store_class = example_class(category: category, entity_class: entity_class, projection_class: projection_class, reader_class: reader_class, snapshot_class: snapshot_class, snapshot_interval: snapshot_interval)
+        end
+
+        instance = store_class.build
+        instance
+      end
+
+      def self.example_class(category: nil, entity_class: nil, projection_class: nil, reader_class: nil, snapshot_class: nil, snapshot_interval: nil)
+        if category == :none
+          category = nil
+        else
+          category ||= Controls::Category.example
+        end
+
+        if entity_class == :none
+          entity_class = nil
+        else
+          entity_class ||= Controls::Entity::Example
+        end
+
+        if projection_class == :none
+          projection_class = nil
+        else
+          projection_class ||= Controls::Projection::Example
+        end
+
+        if reader_class == :none
+          reader_class = nil
+        else
+          reader_class ||= Controls::Reader::Example
+        end
+
+        Class.new do
+          include ::EntityStore
+
+          category category
+          entity entity_class
+          projection projection_class
+          reader reader_class
+          snapshot snapshot_class, snapshot_interval
+        end
+      end
+
+      module Category
+        def self.example
+          :some_category
+        end
+      end
+
+      Example = self.example_class
+    end
+  end
+end

data/lib/entity_store/controls/id.rb

@@ -0,0 +1,5 @@
+module EntityStore
+  module Controls
+    ID = EntityCache::Controls::ID
+  end
+end

data/lib/entity_store/controls/message.rb

@@ -0,0 +1,23 @@
+  module EntityStore
+    module Controls
+      module Message
+        def self.example
+          first
+        end
+
+        def self.first
+          Example.build :number => 1
+        end
+
+        def self.second
+          Example.build :number => 11
+        end
+
+        class Example
+          include Messaging::Message
+
+          attribute :number
+        end
+      end
+    end
+  end

data/lib/entity_store/controls/projection.rb

@@ -0,0 +1,14 @@
+module EntityStore
+  module Controls
+    module Projection
+      class Example
+        include EntityProjection
+
+        apply Message::Example do |message|
+          entity.sum ||= 0
+          entity.sum += message.number
+        end
+      end
+    end
+  end
+end

data/lib/entity_store/controls/reader.rb

@@ -0,0 +1,13 @@
+module EntityStore
+  module Controls
+    module Reader
+      def self.example
+        Example.build
+      end
+
+      class Example
+        include EventSource::Read
+      end
+    end
+  end
+end

data/lib/entity_store/controls/snapshot.rb

@@ -0,0 +1,7 @@
+module EntityStore
+  module Controls
+    module Snapshot
+      Example = EntityCache::Controls::Storage::Persistent::Example
+    end
+  end
+end

data/lib/entity_store/controls/snapshot_interval.rb

@@ -0,0 +1,11 @@
+module EntityStore
+  module Controls
+    SnapshotInterval = EntityCache::Controls::PersistInterval
+
+    module SnapshotInterval
+      def self.example
+        11
+      end
+    end
+  end
+end

data/lib/entity_store/controls/stream_name.rb

@@ -0,0 +1,5 @@
+module EntityStore
+  module Controls
+    StreamName = Messaging::Controls::StreamName
+  end
+end

data/lib/entity_store/controls/version.rb

@@ -0,0 +1,27 @@
+module EntityStore
+  module Controls
+    module Version
+      def self.example
+        Current.example
+      end
+
+      module NotCached
+        def self.example
+          nil
+        end
+      end
+
+      module Cached
+        def self.example
+          0
+        end
+      end
+
+      module Current
+        def self.example
+          1
+        end
+      end
+    end
+  end
+end

data/lib/entity_store/entity_store.rb

@@ -0,0 +1,224 @@
+module EntityStore
+  Error = Class.new(RuntimeError)
+
+  def self.included(cls)
+    cls.class_exec do
+      include Log::Dependency
+      include Messaging::StreamName
+
+      substitute_class = Class.new(Substitute)
+
+      substitute_class.send :define_method, :entity_class do
+        cls.entity_class
+      end
+
+      const_set :Substitute, substitute_class
+
+      attr_accessor :session
+      attr_accessor :new_entity_probe
+
+      dependency :cache, EntityCache
+
+      configure :store
+
+      virtual :category
+      virtual :reader_class
+      virtual :projection_class
+      virtual :snapshot_class
+      virtual :snapshot_interval
+
+      extend Build
+      extend EntityMacro
+      extend ProjectionMacro
+      extend ReaderMacro
+      extend SnapshotMacro
+    end
+  end
+
+  module Build
+    def build(snapshot_interval: nil, session: nil)
+      instance = new
+
+      Build.assure(instance)
+
+      instance.session = session
+
+      EntityCache.configure(
+        instance,
+        entity_class,
+        persistent_store: instance.snapshot_class,
+        persist_interval: instance.snapshot_interval,
+        session: session
+      )
+
+      instance
+    end
+
+    def self.assure(instance)
+      if instance.category.nil?
+        raise Error, "Category is not declared"
+      end
+
+      if instance.entity_class.nil?
+        raise Error, "Entity is not declared"
+      end
+
+      if instance.projection_class.nil?
+        raise Error, "Reader is not declared"
+      end
+
+      if instance.reader_class.nil?
+        raise Error, "Reader is not declared"
+      end
+    end
+  end
+
+  def get(id, include: nil, &probe_action)
+    logger.trace { "Getting entity (ID: #{id.inspect}, Entity Class: #{entity_class.name}, Include: #{include.inspect})" }
+
+    record = cache.get id
+
+    if record
+      entity = record.entity
+      version = record.version
+      persisted_version = record.persisted_version
+      persisted_time = record.persisted_time
+    else
+      entity = new_entity
+    end
+
+    current_version = refresh(entity, id, version, &probe_action)
+
+    unless current_version.nil?
+      record = cache.put(
+        id,
+        entity,
+        current_version,
+        persisted_version,
+        persisted_time
+      )
+    end
+
+    logger.info { "Get entity done (ID: #{id.inspect}, Entity Class: #{entity_class.name}, Include: #{include.inspect}, Version: #{record&.version.inspect}, Time: #{record&.time.inspect})" }
+    logger.info(tags: [:data, :entity]) { entity.pretty_inspect }
+
+    if record
+      record.destructure include
+    else
+      EntityCache::Record::NoStream.destructure include
+    end
+  end
+
+  def refresh(entity, id, current_position, &probe_action)
+    logger.trace { "Refreshing (ID: #{id.inspect}, Entity Class: #{entity_class.name}, Current Position #{current_position.inspect})" }
+    logger.trace(tags: [:data, :entity]) { entity.pretty_inspect }
+
+    stream_name = self.stream_name(id)
+
+    start_position = next_position(current_position)
+
+    project = projection_class.build(entity)
+
+    logger.trace { "Reading (Stream Name: #{stream_name}, Position: #{current_position}" }
+    reader_class.(stream_name, position: start_position, session: session) do |event_data|
+      project.(event_data)
+      current_position = event_data.position
+
+      unless probe_action.nil?
+        probe_action.(event_data)
+      end
+    end
+    logger.debug { "Read (Stream Name: #{stream_name}, Position: #{current_position}" }
+
+    logger.debug { "Refreshed (ID: #{id.inspect}, Entity Class: #{entity_class.name}, Current Position: #{current_position.inspect})" }
+    logger.debug(tags: [:data, :entity]) { entity.pretty_inspect }
+
+    current_position
+  end
+
+  def next_position(position)
+    unless position.nil?
+      position + 1
+    else
+      nil
+    end
+  end
+
+  def get_version(id)
+    _, version = get id, include: :version
+    version
+  end
+
+  def fetch(id, include: nil)
+    res = get(id, include: include)
+
+    if res.nil?
+      res = new_entity
+    end
+
+    if res.is_a?(Array) && res[0].nil?
+      res[0] = new_entity
+    end
+
+    res
+  end
+
+  def new_entity
+    entity = nil
+    if entity_class.respond_to? :build
+      entity = entity_class.build
+    else
+      entity = entity_class.new
+    end
+
+    unless new_entity_probe.nil?
+      new_entity_probe.(entity)
+    end
+
+    entity
+  end
+
+  module EntityMacro
+    def entity_macro(cls)
+      define_singleton_method :entity_class do
+        cls
+      end
+
+      define_method :entity_class do
+        self.class.entity_class
+      end
+    end
+    alias_method :entity, :entity_macro
+  end
+
+  module ProjectionMacro
+    def projection_macro(cls)
+      define_method :projection_class do
+        cls
+      end
+    end
+    alias_method :projection, :projection_macro
+  end
+
+  module ReaderMacro
+    def reader_macro(cls)
+      define_method :reader_class do
+        cls
+      end
+    end
+    alias_method :reader, :reader_macro
+  end
+
+  module SnapshotMacro
+    def snapshot_macro(cls, interval)
+      define_method :snapshot_class do
+        cls
+      end
+
+      define_method :snapshot_interval do
+        interval
+      end
+    end
+    alias_method :snapshot, :snapshot_macro
+  end
+end

data/lib/entity_store/log.rb

@@ -0,0 +1,9 @@
+module EntityStore
+  class Log < ::Log
+    def tag!(tags)
+      tags << :entity_store
+      tags << :library
+      tags << :verbose
+    end
+  end
+end

data/lib/entity_store/substitute.rb

@@ -0,0 +1,37 @@
+module EntityStore
+  class Substitute
+    include EntityStore
+
+    def self.build
+      new
+    end
+
+    def get(id, include: nil)
+      record = records[id]
+
+      if record
+        record.destructure include
+      else
+        EntityCache::Record::NoStream.destructure include
+      end
+    end
+
+    def get_version(id)
+      _, version = get id, include: :version
+      version
+    end
+
+    def add(id, entity, version=nil)
+      version ||= 0
+
+      record = EntityCache::Record.new id, entity, version
+
+      records[id] = record
+    end
+    alias :put :add
+
+    def records
+      @records ||= {}
+    end
+  end
+end

data/lib/loader.rb

@@ -0,0 +1 @@
+entity_store.rb

metadata

@@ -0,0 +1,102 @@
+--- !ruby/object:Gem::Specification
+name: evt-entity_store
+version: !ruby/object:Gem::Version
+  version: 0.3.2.0
+platform: ruby
+authors:
+- The Eventide Project
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-12-20 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: entity_projection
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: entity_cache
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: test_bench
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: " "
+email: opensource@eventide-project.org
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/entity_store.rb
+- lib/entity_store/controls.rb
+- lib/entity_store/controls/category.rb
+- lib/entity_store/controls/entity.rb
+- lib/entity_store/controls/entity_store.rb
+- lib/entity_store/controls/id.rb
+- lib/entity_store/controls/message.rb
+- lib/entity_store/controls/projection.rb
+- lib/entity_store/controls/reader.rb
+- lib/entity_store/controls/snapshot.rb
+- lib/entity_store/controls/snapshot_interval.rb
+- lib/entity_store/controls/stream_name.rb
+- lib/entity_store/controls/version.rb
+- lib/entity_store/entity_store.rb
+- lib/entity_store/log.rb
+- lib/entity_store/substitute.rb
+- lib/loader.rb
+homepage: https://github.com/eventide-project/entity-store
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.3.3
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.5.2
+signing_key: 
+specification_version: 4
+summary: Store of entities that are projected from streams
+test_files: []