aquasync_deltas_aggregator 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: fa2a209bddc8f0790bd9660b5b7da9ffa4d651ef
-  data.tar.gz: 98e34b59632148f8c43fb7369f222f6dc684bfef
+  metadata.gz: f34d448bd0a4b0bc443b50e52f5ed4a7e22b7ab1
+  data.tar.gz: 681f923df0c5d4f25174f8b5623b45c255c5637a
 SHA512:
-  metadata.gz: 29205325c68b2ba1f2b6136e802f6a0edf976e9022ba343fc429e6ce668deb1a0365b8c71f39e00a3a158c66fc3b754eece2850fa50163fbabfa3a10e52f21fc
-  data.tar.gz: 367de1340d8b774824e1fa1ffb0d03e861765840d32f6a3f6cdda45c830c614f4d2dfbc498d830aa5c92f121a09d7fd147d26605ae650cd771d1e175ac1b6e3d
+  metadata.gz: cb225e95dc1c9082d43418adcaed4fe93610ccc08c99c7847e631d3b2458aaa0521bf8cfa5311d48677187c9c4cfac2d9d75abb105790af3122ad194820238d0
+  data.tar.gz: 1aa12134a5bbe5fa15095e685c87555c5dba66297e702ffee0d0be2018f074aef270b74540f3627334c5f8013a739343578bff9ba1e7112ee1ca4dd1f5d5c1fa

data/lib/aggregators/deltas_aggregator.rb

@@ -0,0 +1,60 @@
+require_relative '../delta_pack/delta_pack_builder'
+
+# Has responsibility to
+# 1. Commit a DeltaPack to registered models.
+# 2. Pack a DeltaPack from registered models.
+# @author kaiinui
+# @example Initialization
+#   aggregator = DeltasAggregator.new
+#   aggregator.regist_model_manager(Book, Author)
+# @example Obtain a DeltaPack from registered models.
+#   aggregator.pack_deltas
+# @example Commit a DeltaPack to registered models.
+#   aggregator.unpack_and_commit_delta_pack(delta_pack)
+# @note Please implement #aq_deltas and #aq_commit_deltas to models. (DeltasAggregator requirement.)
+class DeltasAggregator
+  attr_accessor :model_managers
+
+  def initialize
+    self.model_managers = {}
+  end
+
+  # Adds target models to aggregate.
+  # @param klass [Aquasync::Base]
+  # @return [NilClass]
+  def regist_model_manager(*klasses)
+    klasses.each do |klass|
+      name = klass.name
+      model_managers[name] = klass
+    end
+  end
+
+  # Returns registered model manager from name.
+  # @param [String] name
+  # @return [Aquasync::Base]
+  def model_manager_class(name)
+    model_managers[name]
+  end
+
+  # Unpacks a DeltaPack and delegates #aq_commit_deltas to registered model managers.
+  # @param [Hash] A DeltaPack (https://github.com/AQAquamarine/aquasync-protocol/blob/master/deltapack.md)
+  # @return [NilClass]
+  def commit_delta_pack(delta_pack)
+    unpacked_deltas = DeltaPackUnpacker.new.unpack(delta_pack).deltas
+    unpacked_deltas.each do |model_name, deltas|
+      manager = model_manager_class(model_name)
+      manager.aq_commit_deltas deltas
+    end # [TODO] raise error if any commit failed.
+  end
+
+  # Packs deltas collected from registered model managers via #aq_deltas to DeltaPack.
+  # @param [Integer] from_ust latestUST
+  # @return [Hash] A DeltaPack (https://github.com/AQAquamarine/aquasync-protocol/blob/master/deltapack.md)
+  def pack_deltas(from_ust)
+    builder = DeltaPackBuilder.new
+    model_managers.each do |model_name, model_manager|
+      builder.push_documents model_manager.aq_deltas(from_ust)
+    end
+    builder.delta_pack
+  end
+end

data/lib/aquasync_deltas_aggregator.rb

@@ -0,0 +1,3 @@
+require_relative 'aggregators/deltas_aggregator'
+require_relative 'delta_pack/delta_pack_builder'
+require_relative 'delta_pack/delta_pack_unpacker'

data/lib/delta_pack/delta_pack_builder.rb

@@ -0,0 +1,74 @@
+require 'simple_uuid'
+require 'json'
+
+# Has a responsibility to build a DeltaPack hash.
+# @author kaiinui
+# @example
+#   builder = DeltaPackBuilder.new
+#   builder.push_documents(Book.all)
+#   builder.push_documents(Author.all)
+#   builder.delta_pack
+# @note Please implement #_name and #to_h to Models. (DeltaPackBuilder requirements.)
+class DeltaPackBuilder
+  # delta_pack [Hash]
+  attr_accessor :delta_pack
+
+  def initialize
+    self.delta_pack = {}
+    self.delta_pack["_id"] = uuid
+    self.delta_pack["latestUST"] = 0
+  end
+
+  # pushes a document into a DeltaPack.
+  # @param document [Aquasync::Base] a resource which inherits Aquasync::Base
+  def push(document)
+    name = document._name
+    initialize_array(name)
+    self.delta_pack[name].push document.to_h
+    update_ust(document)
+  end
+
+  # pushes documents into a DeltaPack.
+  # @param documents [Array] resources which inherits Aquasync::Base
+  def push_documents(documents)
+    documents.each {|d| push(d)}
+  end
+
+  # updates latestUST
+  # @param document [Aquasync::Base]
+  def update_ust(document)
+    if document.ust > latest_ust
+      self.delta_pack["latestUST"] = document.ust
+    end
+  end
+
+  # returns latestUST of current DeltaPack
+  # @return [Integer]
+  def latest_ust
+    self.delta_pack["latestUST"]
+  end
+
+  # returns built DeltaPack represented in JSON
+  # @return [String] JSON string
+  def json
+    delta_pack.to_json
+  end
+
+  # returns built DeltaPack represented in pretty printed JSON
+  # @return [String] pretty printed JSON
+  def pretty_json
+    JSON.pretty_generate(delta_pack)
+  end
+
+  private
+
+  # @param [String] name model name
+  def initialize_array(name)
+    self.delta_pack[name] = [] unless self.delta_pack[name]
+  end
+
+  # @return [String] UUIDv1
+  def uuid
+    SimpleUUID::UUID.new.to_guid
+  end
+end

data/lib/delta_pack/delta_pack_unpacker.rb

@@ -0,0 +1,24 @@
+# Has a responsibility to unpack a DeltaPack hash.
+# @author kaiinui
+class DeltaPackUnpacker
+  # id [String] UUID
+  attr_accessor :id
+  # deltas [Array] An array of deltas.
+  attr_accessor :deltas
+
+  def initialize
+    self.deltas = {}
+  end
+
+  # unpacks a DeltaPack. You can extract data from #id, #deltas
+  # @param delta_pack [Hash] A DeltaPack
+  # @return [DeltaPackUnpacker]
+  def unpack(delta_pack)
+    self.id = delta_pack["_id"].downcase
+    delta_pack.each do |key, value|
+      next if key == "_id"
+      deltas[key] = value
+    end
+    self
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: aquasync_deltas_aggregator
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - kaiinui
@@ -99,7 +99,11 @@ email: me@kaiinui.com
 executables: []
 extensions: []
 extra_rdoc_files: []
-files: []
+files:
+- lib/aggregators/deltas_aggregator.rb
+- lib/aquasync_deltas_aggregator.rb
+- lib/delta_pack/delta_pack_builder.rb
+- lib/delta_pack/delta_pack_unpacker.rb
 homepage: https://github.com/AQAquamarine/aquasync_deltas_aggregator
 licenses:
 - MIT