evt-entity_cache 2.0.0.0 → 2.0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 25e74b321dd2f21a4eee738fb03124e987869725c03943c0b94914b564cb9ea7
-  data.tar.gz: d84fab0cf0251910d38a19ac2ca9b336962cee0007dc6058dbbe4fa3c29d146b
+  metadata.gz: 4ccf37e36c243d747764757e86a6552c649f157b1feabb174fd025d4019ecdff
+  data.tar.gz: 41ab27c85c699eacffd6cca4122eb44db0fa537a5ff033f73eca29ace4937f16
 SHA512:
-  metadata.gz: 97c5fe39d6be68ed4238bf84a9c3016ac3dab76a45fb3ca457dd9f34389de248897d5c2f3080f40e49f3668aede6318a94e8e7e2428803cac292439b24a959d6
-  data.tar.gz: 11328e53484c330cb2d66238d1adbcc6018e815bb6f3c47379d479844cafd10d0865b6241ae4adff49ebcc5d0690116ba7c9f4b5cb8098e8ccacc0daefb6914e
+  metadata.gz: 96bfc7773f4e5e34c307315c8de52e2741b933c9f75bc49e7d96f34df3ac5dd5e024b4c8964c12afc019cc1fd8fbd675ca3dae069b220751fee89a215f1a0c4e
+  data.tar.gz: eb9c2b7ace7f89be4c7fd035a8b405b4be8c01b058f22fd694b0de0398a83295d364185c7950ae3b2b194e358100e90179d168c34ce482b10da3bb5bd3ac481b

data/lib/entity_cache/controls/entity_cache.rb

@@ -0,0 +1,11 @@
+class EntityCache
+  module Controls
+    module EntityCache
+      def self.example(subject=nil, entity_class: nil, specifier: nil, random_specifier: nil)
+        subject ||= Subject.example(entity_class: entity_class, specifier: specifier, random: random_specifier)
+
+        ::EntityCache.new(subject)
+      end
+    end
+  end
+end

data/lib/entity_cache/controls/record.rb

@@ -15,7 +15,7 @@ class EntityCache
           persisted_time ||= self.persisted_time
         end
 
-        EntityCache::Record.new(
+        ::EntityCache::Record.new(
           id,
           entity,
           version,

data/lib/entity_cache/controls/specifier.rb

@@ -0,0 +1,16 @@
+class EntityCache
+  module Controls
+    module Specifier
+      def self.example(specifier: nil, random: nil)
+        specifier ||= 'SomeSpecifier'
+        random ||= false
+
+        if random
+          specifier = "#{specifier}#{SecureRandom.hex(8)}"
+        end
+
+        specifier
+      end
+    end
+  end
+end

data/lib/entity_cache/controls/store/external/example.rb

@@ -18,7 +18,15 @@ class EntityCache
 
             text = File.read(path)
 
-            entity, version, time = YAML.load(text)
+            entity_data, version, time_iso8601 = YAML.load(text)
+
+            entity = Entity::Example.new(
+              entity_data[:id],
+              entity_data[:some_attr],
+              entity_data[:other_attr]
+            )
+
+            time = Clock.parse(time_iso8601)
 
             return entity, version, time
           end
@@ -26,7 +34,11 @@ class EntityCache
           def put(id, entity, version, time)
             path = path(id)
 
-            text = YAML.dump([entity, version, time])
+            entity_data = entity.to_h
+
+            time_iso8601 = Clock.iso8601(time)
+
+            text = YAML.dump([entity_data, version, time_iso8601])
 
             File.write(path, text)
           end
@@ -39,7 +51,11 @@ class EntityCache
         def self.path(subject, id=nil)
           id ||= ID.example
 
-          File.join(tmpdir, "#{subject}-#{id}.yaml")
+          filename = "#{subject.to_s.gsub('/', '-')}-#{id}.yaml"
+
+          full_name = File.join(tmpdir, filename)
+
+          full_name
         end
 
         def self.tmpdir

data/lib/entity_cache/controls/store/external/write.rb

@@ -6,10 +6,14 @@ class EntityCache
           def self.call
             subject = Subject.example
 
+            entity_data = Controls::Entity.example.to_h
+
+            persisted_time_iso8601 = Controls::Record.persisted_time.iso8601(5)
+
             text = YAML.dump([
-              Controls::Entity.example,
+              entity_data,
               Controls::Record.persisted_version,
-              Controls::Record.persisted_time
+              persisted_time_iso8601
             ])
 
             path = External.path(subject)

data/lib/entity_cache/controls/store/external.rb

@@ -2,8 +2,10 @@ class EntityCache
   module Controls
     module Store
       module External
-        def self.example(subject=nil)
-          subject ||= Subject.example
+        def self.example(subject=nil, entity_class: nil, specifier: nil, random: nil)
+          random = true if random.nil?
+
+          subject ||= Subject.example(random: random, entity_class: entity_class, specifier: specifier)
 
           Example.build(subject)
         end

data/lib/entity_cache/controls/subject.rb

@@ -1,8 +1,34 @@
 class EntityCache
   module Controls
     module Subject
-      def self.example
-        "some-subject-#{SecureRandom.hex(7)}"
+      def self.example(entity_class: nil, specifier: nil, random: nil)
+        entity_class ||= self.entity_class
+
+        if specifier == :none
+          specifier = nil
+        else
+          specifier = Specifier.example(specifier: specifier, random: random)
+        end
+
+        ::EntityCache::Subject.build({
+          :entity_class => entity_class,
+          :specifier => specifier
+        })
+      end
+
+      def self.entity_class
+        Entity::Example
+      end
+
+      def self.specifier
+        Specifier.example
+      end
+
+      module HashKey
+        def self.example(**args)
+          subject = Subject.example(**args)
+          subject.hash_key
+        end
       end
     end
   end

data/lib/entity_cache/controls.rb

@@ -11,6 +11,8 @@ require 'entity_cache/controls/subject'
 require 'entity_cache/controls/time'
 require 'entity_cache/controls/version'
 
+require 'entity_cache/controls/specifier'
+
 require 'entity_cache/controls/persist_interval'
 
 require 'entity_cache/controls/store/external'
@@ -19,3 +21,5 @@ require 'entity_cache/controls/store/external/not_implemented'
 require 'entity_cache/controls/store/external/write'
 
 require 'entity_cache/controls/store/internal'
+
+require 'entity_cache/controls/entity_cache'

data/lib/entity_cache/entity_cache.rb

@@ -1,6 +1,7 @@
 class EntityCache
   include Configure
   include Dependency
+  include Initializer
   include Log::Dependency
 
   configure :entity_cache
@@ -10,12 +11,27 @@ class EntityCache
     @persist_interval ||= Defaults.persist_interval
   end
 
+  def entity_class
+    subject.entity_class
+  end
+
+  def specifier
+    subject.specifier
+  end
+
   dependency :clock, Clock::UTC
   dependency :internal_store, Store::Internal
   dependency :external_store, Store::External
 
-  def self.build(subject, scope: nil, persist_interval: nil, external_store: nil, external_store_session: nil)
-    instance = new
+  initializer :subject
+
+  def self.build(entity_class, specifier=nil, scope: nil, persist_interval: nil, external_store: nil, external_store_session: nil)
+    subject = Subject.build({
+      :entity_class => entity_class,
+      :specifier => specifier
+    })
+
+    instance = new(subject)
 
     instance.configure(
       subject: subject,

data/lib/entity_cache/store/external.rb

@@ -30,6 +30,14 @@ class EntityCache
         end
       end
 
+      def entity_class
+        subject.entity_class
+      end
+
+      def specifier
+        subject.specifier
+      end
+
       module Configure
         def configure(session: nil)
           ::Telemetry.configure(self)

data/lib/entity_cache/subject.rb

@@ -0,0 +1,29 @@
+class EntityCache
+  class Subject
+    include Schema::DataStructure
+
+    attribute :entity_class, Class
+    attribute :specifier, String
+
+    def hash_key
+      self.class.hash_key(entity_class, specifier)
+    end
+    alias_method :to_s, :hash_key
+
+    def hash
+      hash_key.hash
+    end
+
+    def self.hash_key(entity_class, specifier=nil)
+      if specifier.nil?
+        "#{entity_class}"
+      else
+        "#{entity_class}#{hash_key_separator}#{specifier}"
+      end
+    end
+
+    def self.hash_key_separator
+      '/'
+    end
+  end
+end

data/lib/entity_cache/substitute.rb

@@ -5,6 +5,9 @@ class EntityCache
     end
 
     class EntityCache < EntityCache
+      def initialize
+      end
+
       def self.build
         new
       end

data/lib/entity_cache.rb

@@ -7,6 +7,8 @@ require 'entity_cache/log'
 
 require 'entity_cache/defaults'
 
+require 'entity_cache/subject'
+
 require 'entity_cache/record'
 require 'entity_cache/record/destructure'
 require 'entity_cache/record/log_text'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: evt-entity_cache
 version: !ruby/object:Gem::Version
-  version: 2.0.0.0
+  version: 2.0.1.1
 platform: ruby
 authors:
 - The Eventide Project
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2019-12-10 00:00:00.000000000 Z
+date: 2022-09-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: evt-configure
@@ -89,9 +89,11 @@ files:
 - lib/entity_cache.rb
 - lib/entity_cache/controls.rb
 - lib/entity_cache/controls/entity.rb
+- lib/entity_cache/controls/entity_cache.rb
 - lib/entity_cache/controls/id.rb
 - lib/entity_cache/controls/persist_interval.rb
 - lib/entity_cache/controls/record.rb
+- lib/entity_cache/controls/specifier.rb
 - lib/entity_cache/controls/store/external.rb
 - lib/entity_cache/controls/store/external/example.rb
 - lib/entity_cache/controls/store/external/not_implemented.rb
@@ -118,13 +120,13 @@ files:
 - lib/entity_cache/store/internal/scope/global.rb
 - lib/entity_cache/store/internal/scope/thread.rb
 - lib/entity_cache/store/internal/substitute.rb
+- lib/entity_cache/subject.rb
 - lib/entity_cache/substitute.rb
-- lib/loader.rb
 homepage: https://github.com/eventide-project/entity-cache
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -139,8 +141,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.1
-signing_key: 
+rubygems_version: 3.3.3
+signing_key:
 specification_version: 4
 summary: Cache of entities retrieved by an entity-store, with in-memory temporary
   and on-disk permanent storage options

data/lib/loader.rb

@@ -1 +0,0 @@
-lib/entity_cache.rb