evt-entity_cache 0.6.1.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: aca46d5e864296ec667aad6a7ed0f679aee8463f
+  data.tar.gz: 8e13a338781b0a8e32d27206b455a49a99b43fbf
+SHA512:
+  metadata.gz: eebfd2ca59a34e6be8df6862fa2a76c8146ed9ce270c644e3a05ad4d7a144712900fede5c9dd7f42dc86978c0b5081c5a44e7cfb7e1bca0f6e61ad29b1298b86
+  data.tar.gz: e2ac284094bfc16c56787fb6958730f23f8e79926b4b644f95fe525069a36ebef71a82a440fd650c0cb287fd4a463aa1aabcc7eda821879c7bf0dff1ca920e3a

data/lib/entity_cache.rb

@@ -0,0 +1,22 @@
+require 'configure'; Configure.activate
+require 'settings'; Settings.activate
+require 'telemetry'
+require 'telemetry/logger'
+require 'virtual'; Virtual.activate
+
+require 'entity_cache/record'
+
+require 'entity_cache/storage/persistent'
+require 'entity_cache/storage/persistent/none'
+require 'entity_cache/storage/persistent/substitute'
+require 'entity_cache/storage/persistent/telemetry'
+
+require 'entity_cache/storage/temporary'
+require 'entity_cache/storage/temporary/factory'
+require 'entity_cache/storage/temporary/scope'
+require 'entity_cache/storage/temporary/scope/exclusive'
+require 'entity_cache/storage/temporary/scope/shared'
+
+require 'entity_cache/defaults'
+require 'entity_cache/entity_cache'
+require 'entity_cache/substitute'

data/lib/entity_cache/controls.rb

@@ -0,0 +1,11 @@
+require 'clock/controls'
+require 'identifier/uuid/controls'
+
+require 'entity_cache/controls/entity'
+require 'entity_cache/controls/id'
+require 'entity_cache/controls/record'
+require 'entity_cache/controls/storage/persistent'
+require 'entity_cache/controls/storage/temporary'
+require 'entity_cache/controls/time'
+require 'entity_cache/controls/version'
+require 'entity_cache/controls/write_behind_delay'

data/lib/entity_cache/controls/entity.rb

@@ -0,0 +1,9 @@
+class EntityCache
+  module Controls
+    module Entity
+      def self.example
+        Object.new
+      end
+    end
+  end
+end

data/lib/entity_cache/controls/id.rb

@@ -0,0 +1,5 @@
+class EntityCache
+  module Controls
+    ID = Identifier::UUID::Controls::Incrementing
+  end
+end

data/lib/entity_cache/controls/record.rb

@@ -0,0 +1,25 @@
+class EntityCache
+  module Controls
+    module Record
+      def self.example(id=nil, version: nil, persisted_version: nil)
+        id ||= ID.example
+        entity = Entity.example
+        version ||= Version.example
+        persisted_version ||= Version::Persistent.example
+
+        time = Time.example
+        persisted_time = time
+
+        EntityCache::Record.new id, entity, version, time, persisted_version, persisted_time
+      end
+
+      module Persisted
+        def self.example(id=nil)
+          version = Version::Persistent.example
+
+          Record.example id, version: version
+        end
+      end
+    end
+  end
+end

data/lib/entity_cache/controls/storage/persistent.rb

@@ -0,0 +1,39 @@
+class EntityCache
+  module Controls
+    module Storage
+      module Persistent
+        class Example
+          include EntityCache::Storage::Persistent
+
+          def get(id)
+            entity, version, time = records[id]
+
+            return entity, version, time
+          end
+
+          def put(id, entity, version, time)
+            records[id] = [entity, version, time]
+          end
+
+          def records
+            @records ||= {}
+          end
+
+          module Assertions
+            def stored?(id, entity, version, time)
+              records[id] == [entity, version, time]
+            end
+          end
+        end
+
+        def self.example
+          Example.build :some_subject
+        end
+
+        def self.substitute
+          SubstAttr::Substitute.build Example
+        end
+      end
+    end
+  end
+end

data/lib/entity_cache/controls/storage/temporary.rb

@@ -0,0 +1,11 @@
+class EntityCache
+  module Controls
+    module Storage
+      module Temporary
+        def self.example
+          EntityCache::Storage::Temporary::Scope::Exclusive.build :some_subject
+        end
+      end
+    end
+  end
+end

data/lib/entity_cache/controls/time.rb

@@ -0,0 +1,5 @@
+class EntityCache
+  module Controls
+    Time = Clock::Controls::Time
+  end
+end

data/lib/entity_cache/controls/version.rb

@@ -0,0 +1,27 @@
+class EntityCache
+  module Controls
+    module Version
+      def self.example
+        11
+      end
+
+      module Age
+        def self.example
+          Version.example - Persistent.example
+        end
+      end
+
+      module NoStream
+        def self.example
+          EntityCache::Record::NoStream.version
+        end
+      end
+
+      module Persistent
+        def self.example
+          1
+        end
+      end
+    end
+  end
+end

data/lib/entity_cache/controls/write_behind_delay.rb

@@ -0,0 +1,29 @@
+class EntityCache
+  module Controls
+    module WriteBehindDelay
+      module Exceeds
+        def self.example
+          Version.example - Version::Persistent.example
+        end
+
+        module NoStream
+          def self.example
+            Version.example
+          end
+        end
+      end
+
+      module Within
+        def self.example
+          Exceeds.example + 1
+        end
+
+        module NoStream
+          def self.example
+            Exceeds::NoStream.example + 1
+          end
+        end
+      end
+    end
+  end
+end

data/lib/entity_cache/defaults.rb

@@ -0,0 +1,11 @@
+class EntityCache
+  module Defaults
+    def self.persistent_store
+      Storage::Persistent::None
+    end
+
+    def self.write_behind_delay
+      10
+    end
+  end
+end

data/lib/entity_cache/entity_cache.rb

@@ -0,0 +1,83 @@
+class EntityCache
+  configure :entity_cache
+
+  attr_reader :write_behind_delay
+
+  dependency :clock, Clock::UTC
+  dependency :logger, Telemetry::Logger
+  dependency :persistent_store, Storage::Persistent
+  dependency :temporary_store, Storage::Temporary
+
+  def initialize(write_behind_delay=nil)
+    @write_behind_delay = write_behind_delay
+  end
+
+  def self.build(subject, persistent_store: nil, write_behind_delay: nil)
+    persistent_store ||= Defaults.persistent_store
+    write_behind_delay ||= Defaults.write_behind_delay
+
+    instance = new write_behind_delay
+
+    Clock::UTC.configure instance
+    Telemetry::Logger.configure instance
+    Storage::Temporary.configure instance, subject
+
+    persistent_store.configure instance, subject
+
+    instance
+  end
+
+  def get(id)
+    logger.opt_trace "Reading cache (ID: #{id.inspect})"
+
+    record = temporary_store.get id
+    record ||= restore id
+
+    if record.nil?
+      logger.opt_debug "Cache miss (ID: #{id.inspect})"
+      return nil
+    end
+
+    logger.opt_debug "Cache hit (ID: #{id.inspect}, Entity Class: #{record.entity.class.name}, Version: #{record.version.inspect}, Time: #{record.time})"
+
+    record
+  end
+
+  def put(id, entity, version, persisted_version=nil, persisted_time=nil, time: nil)
+    time ||= clock.iso8601
+
+    logger.opt_trace "Writing cache (ID: #{id}, Entity Class: #{entity.class.name}, Version: #{version.inspect}, Time: #{time}, Persistent Version: #{persisted_version.inspect}, Persistent Time: #{persisted_time.inspect})"
+
+    record = Record.new id, entity, version, time, persisted_version, persisted_time
+
+    put_record record
+
+    logger.opt_debug "Cache written (ID: #{id}, Entity Class: #{record.entity.class.name}, Version: #{record.version.inspect}, Time: #{record.time}, Persistent Version: #{persisted_version.inspect}, Persistent Time: #{persisted_time.inspect})"
+
+    record
+  end
+
+  def put_record(record)
+    if write_behind_delay && record.age >= write_behind_delay
+      persisted_time = clock.iso8601
+
+      persistent_store.put record.id, record.entity, record.version, persisted_time
+
+      record.persisted_version = record.version
+      record.persisted_time = persisted_time
+    end
+
+    temporary_store.put record
+  end
+
+  def restore(id)
+    entity, persisted_version, persisted_time = persistent_store.get id
+
+    return nil if entity.nil?
+
+    version = persisted_version
+    time = persisted_time
+
+    put id, entity, version, persisted_version, persisted_time, time: time
+  end
+end

data/lib/entity_cache/record.rb

@@ -0,0 +1,39 @@
+class EntityCache
+  class Record < Struct.new :id, :entity, :version, :time, :persisted_version, :persisted_time
+    def age
+      persisted_version = self.persisted_version
+      persisted_version ||= -1
+
+      version - persisted_version.to_i
+    end
+
+    def destructure(includes=nil)
+      return entity if includes.nil?
+
+      responses = [entity]
+
+      includes = Array(includes)
+
+      includes.each do |attribute|
+        value = public_send attribute
+
+        value = NoStream.version if value.nil? && attribute == :version
+
+        responses << value
+      end
+
+      responses
+    end
+
+    module NoStream
+      def self.destructure(includes=nil)
+        record = Record.new
+        record.destructure includes
+      end
+
+      def self.version
+        :no_stream
+      end
+    end
+  end
+end

data/lib/entity_cache/storage/persistent.rb

@@ -0,0 +1,80 @@
+class EntityCache
+  module Storage
+    module Persistent
+      extend Configure::Macro
+
+      def self.included(cls)
+        cls.class_exec do
+          configure :persistent_store
+
+          dependency :logger, ::Telemetry::Logger
+          dependency :telemetry, ::Telemetry
+
+          extend Build
+          extend RegisterTelemetrySink
+
+          prepend Get
+          prepend Put
+
+          virtual :configure_dependencies unless instance_methods.include?(:configure_dependencies)
+          abstract :get unless instance_methods.include?(:get)
+          abstract :put unless instance_methods.include?(:put)
+        end
+      end
+
+      attr_reader :subject
+
+      def initialize(subject)
+        @subject = subject
+      end
+
+      module Get
+        def get(id)
+          logger.opt_trace "Getting entity (ID: #{id.inspect})"
+
+          entity, version, time = super
+
+          telemetry.record :get, Telemetry::Data.new(id, entity, version, time)
+
+          logger.opt_debug "Got entity (ID: #{id.inspect}, Entity Class: #{entity.class.name}, Version: #{version.inspect}, Time: #{time.inspect})"
+
+          return entity, version, time
+        end
+      end
+
+      module Put
+        def put(id, entity, version, time)
+          logger.opt_trace "Putting entity (ID: #{id.inspect}, Entity Class: #{entity.class.name}, Version: #{version.inspect}, Time: #{time.inspect})"
+
+          super
+
+          telemetry.record :put, Telemetry::Data.new(id, entity, version, time)
+
+          logger.opt_debug "Put entity (ID: #{id.inspect}, Entity Class: #{entity.class.name}, Version: #{version.inspect}, Time: #{time.inspect})"
+
+          time
+        end
+      end
+
+      module Build
+        def build(subject)
+          instance = new subject
+          ::Telemetry::Logger.configure instance
+          ::Telemetry.configure instance
+          instance.configure_dependencies
+          instance
+        end
+      end
+
+      module RegisterTelemetrySink
+        def register_telemetry_sink(storage)
+          sink = Telemetry.sink
+          storage.telemetry.register sink
+          sink
+        end
+      end
+
+      Error = Class.new StandardError
+    end
+  end
+end

data/lib/entity_cache/storage/persistent/none.rb

@@ -0,0 +1,15 @@
+class EntityCache
+  module Storage
+    module Persistent
+      class None
+        include Persistent
+
+        def get(*)
+        end
+
+        def put(*)
+        end
+      end
+    end
+  end
+end

data/lib/entity_cache/storage/persistent/substitute.rb

@@ -0,0 +1,51 @@
+class EntityCache
+  module Storage
+    module Persistent
+      module Substitute
+        def self.build
+          substitute = Persistent.build :substitute
+          sink = Persistent.register_telemetry_sink substitute
+          substitute.sink = sink
+          substitute
+        end
+
+        class Persistent
+          attr_accessor :sink
+
+          include Storage::Persistent
+
+          def get(id)
+            entity, version, time = records[id]
+            return entity, version,time
+          end
+
+          def put(*)
+          end
+
+          def add(id, entity, version, time=nil)
+            time ||= Clock::UTC.iso8601
+            records[id] ||= [entity, version, time]
+          end
+
+          def records
+            @records ||= {}
+          end
+
+          module Assertions
+            def retrieved?(&blk)
+              sink.retrieved? &blk
+            end
+
+            def stored?(&blk)
+              sink.stored? &blk
+            end
+
+            def stored_nothing?
+              sink.put_records.empty?
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/entity_cache/storage/persistent/telemetry.rb

@@ -0,0 +1,38 @@
+class EntityCache
+  module Storage
+    module Persistent
+      module Telemetry
+        def self.sink
+          Sink.new
+        end
+
+        Data = Struct.new :id, :entity, :version, :time
+
+        class Sink
+          include ::Telemetry::Sink
+
+          record :get
+          record :put
+
+          def retrieved?(&blk)
+            return get_records if blk.nil?
+
+            recorded_get? do |record|
+              data = record.data
+              blk.call(data.id, data.entity, data.version, data.time)
+            end
+          end
+
+          def stored?(&blk)
+            return put_records if blk.nil?
+
+            recorded_put? do |record|
+              data = record.data
+              blk.call(data.id, data.entity, data.version, data.time)
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/entity_cache/storage/temporary.rb

@@ -0,0 +1,57 @@
+class EntityCache
+  module Storage
+    class Temporary
+      attr_reader :subject
+
+      dependency :logger, Telemetry::Logger
+
+      def initialize(subject)
+        @subject = subject
+      end
+
+      def self.build(subject)
+        instance = new subject
+        Telemetry::Logger.configure instance
+        instance
+      end
+
+      def self.configure(receiver, subject, scope: nil, attr_name: nil)
+        attr_name ||= :temporary_store
+
+        instance = Factory.(subject, scope: scope)
+        receiver.public_send "#{attr_name}=", instance
+        instance
+      end
+
+      def get(id)
+        records[id]
+      end
+
+      def put(record)
+        records[record.id] = record
+      end
+
+      abstract :records
+
+      module Assertions
+        def empty?
+          records.empty?
+        end
+
+        def put?(&block)
+          block ||= proc { true }
+
+          records.any? do |_, record|
+            block.(record)
+          end
+        end
+      end
+
+      module Substitute
+        def self.build
+          Scope::Exclusive.build :substitute
+        end
+      end
+    end
+  end
+end

data/lib/entity_cache/storage/temporary/factory.rb

@@ -0,0 +1,42 @@
+class EntityCache
+  module Storage
+    class Temporary
+      module Factory
+        def self.call(subject, scope: nil)
+          scope ||= Scope::Defaults::Name.get
+
+          scope_class = self.scope_class scope
+
+          scope_class.build subject
+        end
+
+        def self.scope_class(scope_name)
+          scope_class = scopes[scope_name]
+
+          if scope_class.nil?
+            *scopes, final_scope = self.scopes.keys
+            scopes = "#{scopes * ', '} or #{scope_name}"
+
+            error_message = %{Scope "#{scope_name}" is unknown. It must be one of: #{scopes}}
+
+            logger.error error_message
+            raise Scope::Error, error_message
+          end
+
+          scope_class
+        end
+
+        def self.scopes
+          @scopes ||= {
+            :exclusive => Scope::Exclusive,
+            :shared => Scope::Shared
+          }
+        end
+
+        def self.logger
+          @logger ||= Telemetry::Logger.get self
+        end
+      end
+    end
+  end
+end

data/lib/entity_cache/storage/temporary/scope.rb

@@ -0,0 +1,30 @@
+class EntityCache
+  module Storage
+    class Temporary
+      module Scope
+        Error = Class.new StandardError
+
+        module Defaults
+          module Name
+            def self.get
+              value = env_var_value || self.value
+              value.to_sym
+            end
+
+            def self.env_var_value
+              ENV[env_var_name]
+            end
+
+            def self.env_var_name
+              'ENTITY_CACHE_SCOPE'
+            end
+
+            def self.value
+              'shared'
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/entity_cache/storage/temporary/scope/exclusive.rb

@@ -0,0 +1,13 @@
+class EntityCache
+  module Storage
+    class Temporary
+      module Scope
+        class Exclusive < Temporary
+          def records
+            @records ||= {}
+          end
+        end
+      end
+    end
+  end
+end

data/lib/entity_cache/storage/temporary/scope/shared.rb

@@ -0,0 +1,17 @@
+class EntityCache
+  module Storage
+    class Temporary
+      module Scope
+        class Shared < Temporary
+          def records
+            records_registry[subject] ||= {}
+          end
+
+          def records_registry
+            @@records_registry ||= {}
+          end
+        end
+      end
+    end
+  end
+end

data/lib/entity_cache/substitute.rb

@@ -0,0 +1,44 @@
+class EntityCache
+  module Substitute
+    def self.build
+      EntityCache.build
+    end
+
+    class EntityCache < EntityCache
+      def self.build
+        instance = new
+        Telemetry::Logger.configure instance
+        instance
+      end
+
+      def add(id, entity, version=nil, persisted_version: nil)
+        version ||= 0
+        persisted_version ||= version
+
+        time = clock.iso8601
+
+        record = Record.new id, entity, version, time, persisted_version, time
+
+        temporary_store.put record
+      end
+
+      def put_record(record)
+        put_records << record
+      end
+
+      def put_records
+        @put_records ||= []
+      end
+
+      module Assertions
+        def put?(&blk)
+          return put_records.any? if blk.nil?
+
+          put_records.any? do |record|
+            blk.(record)
+          end
+        end
+      end
+    end
+  end
+end

metadata

@@ -0,0 +1,164 @@
+--- !ruby/object:Gem::Specification
+name: evt-entity_cache
+version: !ruby/object:Gem::Version
+  version: 0.6.1.1
+platform: ruby
+authors:
+- The Eventide Project
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-12-22 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: evt-configure
+  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: evt-clock
+  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: evt-identifier-uuid
+  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: evt-settings
+  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: evt-telemetry-logger
+  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: evt-virtual
+  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_cache.rb
+- lib/entity_cache/controls.rb
+- lib/entity_cache/controls/entity.rb
+- lib/entity_cache/controls/id.rb
+- lib/entity_cache/controls/record.rb
+- lib/entity_cache/controls/storage/persistent.rb
+- lib/entity_cache/controls/storage/temporary.rb
+- lib/entity_cache/controls/time.rb
+- lib/entity_cache/controls/version.rb
+- lib/entity_cache/controls/write_behind_delay.rb
+- lib/entity_cache/defaults.rb
+- lib/entity_cache/entity_cache.rb
+- lib/entity_cache/record.rb
+- lib/entity_cache/storage/persistent.rb
+- lib/entity_cache/storage/persistent/none.rb
+- lib/entity_cache/storage/persistent/substitute.rb
+- lib/entity_cache/storage/persistent/telemetry.rb
+- lib/entity_cache/storage/temporary.rb
+- lib/entity_cache/storage/temporary/factory.rb
+- lib/entity_cache/storage/temporary/scope.rb
+- lib/entity_cache/storage/temporary/scope/exclusive.rb
+- lib/entity_cache/storage/temporary/scope/shared.rb
+- lib/entity_cache/substitute.rb
+homepage: https://github.com/eventide-project/entity-cache
+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.2.3
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.6.8
+signing_key: 
+specification_version: 4
+summary: Entity cache
+test_files: []