ecko-plugins 0.1.2 → 0.1.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6ea907c7cdf100f9d8604d626f005995e94e53ccd3eff8201a844196df13413a
-  data.tar.gz: 0724d24e0897f4f2d9757fddcf338e7e9c2bd286d9d83de8a7baf6ab62c027b3
+  metadata.gz: dce97dbb50221ff2e328c927ef9f40ed6109d982b249e6d55f1001037eb8e1a7
+  data.tar.gz: '0191d7f6fb03a1d7dff1f354b05de53ed8092951c5735fe8c8c60d02360e312d'
 SHA512:
-  metadata.gz: b6e3385c059320a0c41af91acae210312650c0d66b92bf3c7fd3244fb0b0cb175b87e1730c8c58d5a337ac99ce90ed92f21086ae3dc586d2c8d992223348a3a9
-  data.tar.gz: a3e167e2fcf72764083c6ee94131ffe6595dd9ed85fe1193a15a9e897ed3fed3550ce87c4beefc2583709cc232f79af25738d8be757336e7415aea327035a03d
+  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.2
+  version: 0.1.6
 platform: ruby
 authors:
 - Manish Sharma
@@ -44,10 +44,12 @@ 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/AGPL
+- GPL-3.0+
 metadata:
   allowed_push_host: https://rubygems.org
   homepage_uri: https://github.com/magicstone-dev/ecko-plugins/tree/main/ecko-plugins