peplum 0.3.1 → 0.3.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a833d561020be57a98a105e264e6acd79ebe1a93b17de86e7bd3bb7f34bb88a4
-  data.tar.gz: f25b64342453bc340139bceea007d2baf8d95115afd5dc890be29413c3210405
+  metadata.gz: 3568df5f67778e52d60fdadfc43365b8a73560ee2a7a432d7f00f911d1b54c74
+  data.tar.gz: 4b72178fc2b3b948a76e04fe86b039b3cd545b3c857b21fdfbe8698d8e8ee094
 SHA512:
-  metadata.gz: 0311c9ba56ad671e05146bdbc5449ce5d8c2c533a07e48a8de55e062813b7865624fc400e4fb9b955a156eabc0b16077bcf7ddca45cbf04e7fd3f002aed4bbdb
-  data.tar.gz: 3d9b8e8cc3a45a5f73a4466ecef138dfdd459b8655aeb679b54724881c64ab7873ffff9843226e5a0e61c6bcf1a4d06b3a95da56c022702795d988487a1fd08b
+  metadata.gz: 65f7fe80859499e249207f9d88d3d68701959b4511b0d8c0470c4d61a78b25dc5734fcf7b63e45001bbfe9323ed2b657dc2bea934a597d19a25833e5fd71b67e
+  data.tar.gz: 1c74b1a6cf7df7b9db5daf1fc76190f55bc0c45f6acc242667cf2a29a769d00b209369c36dd105996b150148ea6fe5aa65e8b38fd24dd16f337a0610cde3554d

data/lib/peplum/application/worker.rb

@@ -0,0 +1,19 @@
+module Peplum
+class Application
+
+module Worker
+
+  # @return   [Cuboid::RPC::Server::Instance::Peers]
+  attr_reader :peers
+
+  # @return   [Cuboid::RPC::Client::Instance, NilClass]
+  attr_reader :scheduler
+
+  def peers
+    @peers ||= Cuboid::RPC::Server::Instance::Peers.new
+  end
+
+end
+
+end
+end

data/lib/peplum/application.rb

@@ -4,60 +4,53 @@ require 'peplum'
 
 module Peplum
   class Application < Cuboid::Application
+    require 'peplum/application/worker'
     require 'peplum/application/payload'
 
     require 'peplum/application/services/shared_hash'
     require 'peplum/application/services/scheduler'
 
-    class Error < Peplum::Error; end
+    class Error < Peplum::Error
+      class PayloadMissing < Error
+      end
+    end
 
+    # Hijack Cuboid to set ourselves up.
     class <<self
       def inherited( application )
         super
 
+        # Don't trust Cuboid's auto-detection for this, make sure the inheriting class is the Cuboid application.
         Cuboid::Application.application = application
 
         application.validate_options_with :validate_options
-        application.serialize_with JSON
 
         application.instance_service_for :scheduler,   Services::Scheduler
+
+        # Shared, in-memory key-value store for the workers, the scheduler will not be participate.
         application.instance_service_for :shared_hash, Services::SharedHash
       end
     end
 
-    # @return   [Cuboid::RPC::Server::Instance::Peers]
-    attr_reader :peers
-
-    # @return   [Cuboid::RPC::Client::Instance]
-    attr_reader :master
-
-    def initialize(*)
-      super
-
-      @peers = Cuboid::RPC::Server::Instance::Peers.new
-    end
-
     def run
       options = @options.dup
+
+      # System options.
       peplum_options = options.delete( 'peplum' )
+
+      # Payload options.
       payload_options = options.delete( 'payload' )
 
-      # We have a master so we're not the scheduler, run the payload.
+      # We have a master so we're a worker, run the payload.
       if peplum_options['master']
-        execute( peplum_options, payload_options )
+        work( peplum_options, payload_options )
 
-      # We're the scheduler Instance, get to grouping and spawning.
+      # We're the scheduler Instance, get to grouping objects and spawning workers.
       else
         schedule( peplum_options, payload_options )
       end
     end
 
-    # @return [TrueClass, FalseClass] Are we a worker Instance?
-    def worker?
-      # Has a master?
-      !!@master
-    end
-
     # @return [#run, #split, #merge]
     #
     #   * `#run` -- Worker; executes its payload against `objects`.
@@ -68,23 +61,32 @@ module Peplum
     #
     # @abstract
    def payload
-      fail Error, 'Missing #payload!'
+      fail Error::PayloadMissing, 'Missing #payload implementation!'
     end
 
+    # Overload {Cuboid#report} and delegate to the {Payload.merge} prior passing it on to {Cuboid}.
+    # @private
     def report( data )
       super payload.merge( data )
     end
 
     private
 
-    def execute( peplum_options, payload_options )
+    def work( peplum_options, payload_options )
+      # We're now a worker class!
+      self.class.include Worker
+
       master_info = peplum_options.delete( 'master' )
       @master = Processes::Instances.connect( master_info['url'], master_info['token'] )
 
+      # Configure us to know the rest of our worker peers.
+      # Required for the SharedHash service.
       self.peers.set( peplum_options.delete( 'peers' ) || {} )
 
+      # Deliver the payload.
       report_data = payload.run( peplum_options['objects'], payload_options )
 
+      # Signal that we're done by passing our report to the scheduler.
       @master.scheduler.report report_data, Cuboid::Options.rpc.url
     end
 
@@ -153,9 +155,20 @@ module Peplum
         fail Error, 'Options: Missing :max_workers'
       end
 
+      validate_payload
+
       @options = options
       true
     end
 
+    def validate_payload
+      p = self.payload
+
+      %w(run merge split).each do |m|
+        next if p.respond_to? m
+        fail Payload::Error::ImplementationMissing, "#{payload} missing implementation for: ##{m}"
+      end
+    end
+
   end
 end

data/lib/peplum/version.rb

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

data/peplum.gemspec

@@ -9,8 +9,10 @@ Gem::Specification.new do |spec|
   spec.email = ["tasos.laskos@gmail.com"]
 
   spec.summary = "Distributed parallel computing made easy."
-  spec.description = "Distributed parallel computing made easy."
-  spec.homepage = "http://ecsypno.com/"
+  spec.description = <<EOTXT
+Peplum allows you to easily combine the resources of multiple machines and build a Beowulf (or otherwise) cluster/super-computer.
+EOTXT
+  spec.homepage = "https://github.com/peplum/peplum"
   spec.required_ruby_version = ">= 2.6.0"
 
   spec.files  = Dir.glob( 'bin/*')

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: peplum
 version: !ruby/object:Gem::Version
-  version: 0.3.1
+  version: 0.3.3
 platform: ruby
 authors:
 - Tasos Laskos
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2023-05-25 00:00:00.000000000 Z
+date: 2023-05-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: cuboid
@@ -24,7 +24,10 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-description: Distributed parallel computing made easy.
+description: 'Peplum allows you to easily combine the resources of multiple machines
+  and build a Beowulf (or otherwise) cluster/super-computer.
+
+'
 email:
 - tasos.laskos@gmail.com
 executables: []
@@ -37,10 +40,11 @@ files:
 - lib/peplum/application/payload.rb
 - lib/peplum/application/services/scheduler.rb
 - lib/peplum/application/services/shared_hash.rb
+- lib/peplum/application/worker.rb
 - lib/peplum/core_ext/array.rb
 - lib/peplum/version.rb
 - peplum.gemspec
-homepage: http://ecsypno.com/
+homepage: https://github.com/peplum/peplum
 licenses: []
 metadata: {}
 post_install_message: