peplum 0.2.7 → 0.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2c2c58c0b4f8d82bb6376ca24b17b1b07585630e257f0c38717d19a02a71ce76
-  data.tar.gz: 235f665ccb1f8c49d6a991166a55f5871556a483c3b57937d89427cf5694a2f6
+  metadata.gz: a833d561020be57a98a105e264e6acd79ebe1a93b17de86e7bd3bb7f34bb88a4
+  data.tar.gz: f25b64342453bc340139bceea007d2baf8d95115afd5dc890be29413c3210405
 SHA512:
-  metadata.gz: 6625f8916a0cfb646972c700d1f68cd7d97ba5fbc23f9637896190fffdce28f64c2878e2cc0c811ba37702fab63fe1fa65f0e8561203cbad420177e293e82a7c
-  data.tar.gz: 22cf60063e6040de45ba80c3fb5cfa1930898bcd46615b6ce80bf67baa12d4b9eb30ca9d8e79c3cbdc6b635600fb29e14eadac9940cb00a144ac0c6b7cf71f22
+  metadata.gz: 0311c9ba56ad671e05146bdbc5449ce5d8c2c533a07e48a8de55e062813b7865624fc400e4fb9b955a156eabc0b16077bcf7ddca45cbf04e7fd3f002aed4bbdb
+  data.tar.gz: 3d9b8e8cc3a45a5f73a4466ecef138dfdd459b8655aeb679b54724881c64ab7873ffff9843226e5a0e61c6bcf1a4d06b3a95da56c022702795d988487a1fd08b

data/lib/peplum/application/payload.rb

@@ -0,0 +1,67 @@
+require 'peplum/core_ext/array'
+
+module Peplum
+class Application
+module Payload
+
+  class Error < Error
+    class ImplementationMissing < Error
+    end
+  end
+
+  # Run payload against `objects` based on given `options`
+  #
+  # @param  [Array] objects Objects that this worker should process.
+  # @param  [Hash, NilClass]  options Worker options.
+  # @abstract
+  def run( objects, options )
+    fail Error::ImplementationMissing, 'Missing implementation.'
+  end
+
+  # Distribute `objects` into `groups_of` amount of groups, one for each worker.
+  #
+  # @param  [Array] objects All objects that need to be processed.
+  # @param  [Integer] groups_of  Amount of object groups that should be generated.
+  #
+  # @return [Array<Array<Object>>]  `objects` split in `chunks` amount of groups.
+  def split( objects, groups_of )
+    objects.chunk groups_of
+  end
+
+  # Merge result `data` for reporting.
+  #
+  # By default provides a generic implementation that merges the values of `Hash`es and `Array`s.
+  # If `String`s or `Numeric`s are contained, the Array is returned as is.
+  #
+  # @param  [Array] data  Report data from workers.
+  # @return [Object]  Merged results.
+  #
+  # @raise  [Error::ImplementationMissing]  When the data cannot be handled.
+  def merge( data )
+    case data.first
+    when Hash
+        f = data.pop
+        data.each do |d|
+
+          if !f.is_a? Hash
+            fail Error::ImplementationMissing, 'Missing implementation: Item not a Hash!'
+          end
+
+          f.merge! d
+        end
+        f
+
+    when Array
+      data.flatten
+
+    when String, Numeric
+      data
+
+    else
+      fail Error::ImplementationMissing, 'Missing implementation.'
+    end
+  end
+
+end
+end
+end

data/lib/peplum/application.rb

@@ -1,10 +1,11 @@
 require 'cuboid'
 require 'json'
 require 'peplum'
-require 'peplum/core_ext/array'
 
 module Peplum
   class Application < Cuboid::Application
+    require 'peplum/application/payload'
+
     require 'peplum/application/services/shared_hash'
     require 'peplum/application/services/scheduler'
 
@@ -24,7 +25,10 @@ module Peplum
       end
     end
 
+    # @return   [Cuboid::RPC::Server::Instance::Peers]
     attr_reader :peers
+
+    # @return   [Cuboid::RPC::Client::Instance]
     attr_reader :master
 
     def initialize(*)
@@ -34,10 +38,6 @@ module Peplum
     end
 
     def run
-      Raktr.global.on_error do |_, e|
-        $stderr.puts e
-      end
-
       options = @options.dup
       peplum_options = options.delete( 'peplum' )
       payload_options = options.delete( 'payload' )
@@ -52,21 +52,23 @@ module Peplum
       end
     end
 
+    # @return [TrueClass, FalseClass] Are we a worker Instance?
     def worker?
       # Has a master?
       !!@master
     end
 
-    # Implements:
-    #   * `.run` -- Worker; executes its payload against `objects`.
-    #   * `.group` -- Splits given `objects` into groups for each worker.
-    #   * `.merge` -- Merges results from multiple workers.
+    # @return [#run, #split, #merge]
+    #
+    #   * `#run` -- Worker; executes its payload against `objects`.
+    #   * `#split` -- Scheduler; splits given `objects` into groups for each worker.
+    #   * `#merge` -- Scheduler; merges results from multiple workers.
     #
-    # That's all we need to turn any application into a super version of itself.
+    #   That's all we need to turn any application into a super version of itself.
     #
     # @abstract
-    def payload
-      fail Error, 'Missing payload app!'
+   def payload
+      fail Error, 'Missing #payload!'
     end
 
     def report( data )
@@ -89,7 +91,7 @@ module Peplum
     def schedule( peplum_options, payload_options )
       max_workers = peplum_options.delete('max_workers')
       objects     = peplum_options.delete('objects')
-      groups      = payload.group( objects, max_workers )
+      groups      = payload.split( objects, max_workers )
 
       # Workload turned out to be less than our maximum allowed instances.
       # Don't spawn the max if we don't have to.

data/lib/peplum/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Peplum
-  VERSION = "0.2.7"
+  VERSION = "0.3.1"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: peplum
 version: !ruby/object:Gem::Version
-  version: 0.2.7
+  version: 0.3.1
 platform: ruby
 authors:
 - Tasos Laskos
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2023-05-24 00:00:00.000000000 Z
+date: 2023-05-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: cuboid
@@ -34,6 +34,7 @@ files:
 - bin/.gitkeep
 - lib/peplum.rb
 - lib/peplum/application.rb
+- lib/peplum/application/payload.rb
 - lib/peplum/application/services/scheduler.rb
 - lib/peplum/application/services/shared_hash.rb
 - lib/peplum/core_ext/array.rb