plugg 0.0.1 → 1.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 0988eac668e53bb82c2ddc8038fe404bc45c8c36
-  data.tar.gz: 5637be96140af547726975c0b2368a11e0f08f71
+SHA256:
+  metadata.gz: 7b0bf38d3e6aaddc835e122ca4186a378ed7a02bd32e13317dfa94165f39bd99
+  data.tar.gz: bcea21911dc7bce085bb53788c027f6ac95d7233985dc19626316bfec316931f
 SHA512:
-  metadata.gz: 2739d5375074a4c7df289c99fd6c1a8bfb852d91c0fc1ac728385bf794458ebe610cf81554b748548a8eb8e88cb8a557d2a9c4f99a55a274830c9439269ff1c5
-  data.tar.gz: c332fcc6861d947749393323daec08683634039de8ffd118a0dd12d06b02be069a174e9238946f72abaafc185b3132ffbb83564dbe1935a3c9df9bc9aad76f79
+  metadata.gz: a9052c09eb89ea8314d619d1eb377e11f26ebd533e7bdcbee931caeac7638a54cca6039cbe4a38efe445186ceb249915a34a8a6fd442e02ee4b38be745dd54da
+  data.tar.gz: 6ca5ca8dc2bfb25ab6bdcbc98b0e6efd2570976da0c3912d90ed98b2fb551a7fd5cfc7dbbae3512462b0e05f2e4bb3c09f582f2b04eada3ae6fd27e6dc859d85

data/lib/plugg.rb

@@ -1,12 +1,14 @@
 require 'singleton'
+require 'timeout'
+require 'ostruct'
 
 module Plugg
-
   ##
-  # Set the source directory to load the plugins from
+  # Set the source directory to load the plugins & dependencies from
   #
+  # @param hash params
   # @param mixed path
-  def Plugg.source(path)
+  def Plugg.source(path, params = {})
 
     load_path = []
 
@@ -19,14 +21,22 @@ module Plugg
         File.directory?(p)
       end
 
-      load_path.concat path
+      load_path.concat(path)
     end
 
     if load_path.empty?
-      raise "Plugin load paths contain no valid directories"
+      raise 'Unable to locate plugins in the provided load paths'
     end
 
-    Dispatcher.plugin_path = load_path
+    Dispatcher.instance.start(load_path, params)
+  end
+
+  ##
+  # Set the dispatch plugin timeout value
+  #
+  # @param integer t
+  def Plugg.timeout(t = 30)
+    Dispatcher.instance.set_timeout(t)
   end
 
   ##
@@ -44,33 +54,79 @@ module Plugg
   # @param hash params
   # @return mixed
   def Plugg.send(evt, params = {})
-    Dispatcher.instance.on(evt, params)
+    Dispatcher.instance.on(evt.to_sym, params)
+  end
+
+  private
+
+  class DispatchResponder
+    attr_reader :plugin
+    attr_reader :meta
+    
+    def initialize(plugin = nil)
+      @meta = OpenStruct.new
+
+      @meta.start_time = Time.now
+      @meta.plugin     = plugin
+      @meta.response   = nil
+      @meta.runtime    = nil
+      @meta.error      = nil
+    end
+
+    def trap(timeout = 5)
+      Timeout::timeout(timeout) {
+        begin  
+          @meta.response = yield
+        rescue Exception => e
+          @meta.error = e
+        end
+      }
+
+      @meta.runtime = (Time.now - @start_time) * 1000
+    end
+
+    def finalize
+      if @meta.plugin.respond_to?(:after)
+        @meta.plugin.send(:after) 
+      end
+    end
+
+    def ok? 
+      @meta.error.nil?
+    end
+
+    def error
+      @meta.error
+    end
+
+    def to_h
+      defaults = {
+        plugin:   @meta.plugin.to_s,
+        runtime:  @meta.runtime,
+        response: @meta.error,
+        success:  ok?
+      }
+
+      defaults
+    end
   end
 
   class Dispatcher
     include Singleton
 
     attr_reader :registry
-
-    @@plugin_path = []
+    attr_accessor :timeout
 
     ##
     # Assign a path where plugins should be loaded from
   	#
-  	# @param string path
+  	# @param mixed path
+    # @param hash params
   	# @return void
-    def self.plugin_path=(path)
-      @@plugin_path = path
-    end
-
-    ##
-    # Initialize the dispatcher and load the plugin instances
-  	#
-  	# @return void
-    def initialize
+    def start(paths, params = {})
       @registry = []
 
-      @@plugin_path.each do |path|
+      paths.each do |path|
         if path[-1] == '/'
           path.chop!
         end
@@ -80,49 +136,81 @@ module Plugg
           require File.expand_path(f)
 
           begin
-      			@registry.push(
-      				Object.const_get(File.basename(f, '.rb')).new
-      			)
+            instance = Object.const_get(File.basename(f, '.rb')).new
+
+            # `before` event callback
+            if instance.respond_to?(:before)
+              instance.send(:before)
+            end
+
+            # `setup` method
+            if instance.respond_to?(:setup)
+              instance.send(:setup, params)
+            end
+
+            @registry.push(instance)
+            
           rescue Exception => e
-            puts "#{f} Initialization Exception."
+            puts "#{f} Plugg Initialization Exception: #{e}"
           end
     		end
       end
     end
 
+    ##
+    # Set the the thread execution timeout
+  	#
+  	# @param integer t
+  	# @return void
+    def set_timeout(t)
+      @timeout = t
+    end
+
+    ##
+    # Initialize the dispatcher instance with a default timeout of 5s
+  	#
+  	# @return void
+    def initialize
+      @timeout = 5
+    end
+
     ##
   	# Loop through all services and fire off the supported messages
   	#
   	# @param string method
   	# @return void
   	def on(method, *args, &block)
-      buffer = []
 
-  		@registry.each do |s|
-  			if s.respond_to?(method.to_sym, include_private = false)
+      if [:initialize, :before, :setup, :after].include? method
+        raise "#{method} should not be called directly"
+      end
 
-          start = Time.now
-          response = nil
+      buffer  = [] # Container for the response buffer  
+      threads = [] # Container for the execution threads
 
-          begin
-            if s.method(method.to_sym).arity == 0
-              response = s.send(method, &block)
-            else
-              response = s.send(method, *args, &block)
+  		@registry.each do |s|
+        if s.respond_to?(method.to_sym, false)
+          threads << Thread.new do 
+            responder = DispatchResponder.new(s)
+          
+            responder.trap(@timeout) do 
+              if s.method(method.to_sym).arity == 0
+                s.send(method, &block)
+              else
+                s.send(method, *args, &block)
+              end
             end
-          rescue Exception => e
-            response = e
-          end
 
-          buffer << {
-            :plugin => s.to_s,
-            :return => response,
-            :timing => (Time.now - start) * 1000
-          }
+            responder.finalize
+
+            buffer << responder.to_h
+          end
   			end
   		end
 
+      threads.map(&:join)
+
       buffer
   	end
   end
-end
+end

metadata

@@ -1,26 +1,60 @@
 --- !ruby/object:Gem::Specification
 name: plugg
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 1.0.1
 platform: ruby
 authors:
 - Sean Nieuwoudt
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-10-03 00:00:00.000000000 Z
-dependencies: []
+date: 2020-07-11 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.7'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 5.7.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.7'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 5.7.0
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
 description: Plugg allows you to easily extend your application by providing you with
-  a bolt-on plugin framework
-email: sean@wixelhq.com
+  a plug and play plugin framework
+email: sean@isean.co.za
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
 - lib/plugg.rb
-homepage: https://wixelhq.com
+homepage: https://github.com/sn/plugg
 licenses:
-- GPL2
+- GPL-2.0
 metadata: {}
 post_install_message: 
 rdoc_options: []
@@ -37,9 +71,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.4.5
+rubygems_version: 3.1.4
 signing_key: 
 specification_version: 4
-summary: Plugg is an independent plugin creation framework and DSL
+summary: Plugg is a an asynchronous DSL for creating performant plugins
 test_files: []