ecko-plugins 0.1.5 → 0.1.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 883fbcf6ef0b1c7e0caf9fd5ba07beed59fa4af7a33b8fd3c137ac1a4421a984
-  data.tar.gz: 0c8a25cee099f3ffc5a3bf692da8ffbaf0b7e51004b85ea4d51969fb772af538
+  metadata.gz: dce97dbb50221ff2e328c927ef9f40ed6109d982b249e6d55f1001037eb8e1a7
+  data.tar.gz: '0191d7f6fb03a1d7dff1f354b05de53ed8092951c5735fe8c8c60d02360e312d'
 SHA512:
-  metadata.gz: 84dae5fac3fb58997cf336fb99abbb1013073468fd85692a7a9aaadd242e7db7d8880274e493bba6785797cea8b86e82afbc5fb2faa0617364cb3d8fc63b1581
-  data.tar.gz: f2616cad5bee83e2dfbb6ea95849fac811154bbfe3933919244468ea48d785f49f1ee00284aab81022a7e12379b528c26518787f951be92e6e692d34e638fc6c
+  metadata.gz: 88f0dcde5f58e3a160763d6f384476db9e99f598149f4cf5ecc4190b0fb726af66d6286bd4f424498dcc0564fc60f9038d66fcf6c939fe0d4de817fdd908f467
+  data.tar.gz: c1268a19a779fe9da8feeafcd5cb1d0c5b0f252c95e464b4bb0a72aa2859d34fc45c930cc8af963dc6694f8c11dc5634195b41d9da36f83aa9ba5bf8f8ab5099

data/lib/ecko/plugins/version.rb

@@ -0,0 +1,5 @@
+module Ecko
+  module Plugins
+    VERSION = '0.1.6'
+  end
+end

data/lib/ecko/plugins.rb

@@ -0,0 +1,49 @@
+require "ecko/plugins/version"
+
+module Ecko
+  module Plugins
+    # Set a registry variable to help cache all the registries
+    @@registry = {}
+
+    class Error < StandardError; end
+
+    class PluginPresentError < StandardError; end
+
+    class Registry; end
+
+    class << self
+      def registry
+        @@registry
+      end
+
+      # Registers a new plugin, A plugin with the same name cannot be registered twice
+      # That will raise Ecko::Plugins::PluginPresentError if a plugin is already registered.
+      # name: Name of the plugin in snail case
+      # schema: hash/object or any data structure which defines the plugin
+      # engine: It is a class which exposes a configure class definition(method)
+      def register(name:, schema:, engine:)
+        raise Ecko::Plugins::PluginPresentError unless Ecko::Plugins.registry[name].nil?
+
+        # This helps set a new reference class which will be used as a pristine class. It doesnt have a big
+        # role currently but will serve a great deal of purpose in the future.
+        registered_plugin = Ecko::Plugins::Registry.const_set(name.capitalize, Class.new(engine))
+        Ecko::Plugins.registry[name] = { schema: schema, engine: engine, engine_stub: registered_plugin }
+        register_method(name, registered_plugin)
+        execute_pipeline(registered_plugin, schema)
+      end
+
+      # Pipeline just includes configuration currently, It will help us run a validation pipeline in the future.
+      # TODO: Update the comment on the method when upgraded.
+      def execute_pipeline(registered_plugin, schema)
+        registered_plugin.configure(schema)
+      end
+
+      # Creates a singleton class to help devs use the plugin engine and run methods accordingly.
+      def register_method(name, engine)
+        define_singleton_method name do
+          engine
+        end
+      end
+    end
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: ecko-plugins
 version: !ruby/object:Gem::Version
-  version: 0.1.5
+  version: 0.1.6
 platform: ruby
 authors:
 - Manish Sharma
@@ -44,7 +44,9 @@ email:
 executables: []
 extensions: []
 extra_rdoc_files: []
-files: []
+files:
+- lib/ecko/plugins.rb
+- lib/ecko/plugins/version.rb
 homepage: https://github.com/magicstone-dev/ecko-plugins/tree/main/ecko-plugins
 licenses:
 - GPL-3.0+