ghaki-registry 2011.11.30.1

data/LICENSE

@@ -0,0 +1,19 @@
+Copyright (c) 2010 Gerald Kalafut
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README

@@ -0,0 +1,23 @@
+= Ghaki Registry = Register and autoload packages.
+
+Ghaki Registry is a helper library for registering and loading features.
+
+== Download
+
+The latest version of Ghaki Registry can be found at
+
+* git@github.com:ghaki/ghaki-registry.git
+
+== Installation
+
+The preferred method of installing Ghaki Registry is through its GEM file.
+
+  % [sudo] gem install ghaki-registry-1.0.0.gem
+
+== License
+
+Ghaki Registry is released under the MIT license.
+
+== Support
+
+Contact mailto:gerald@kalafut.org

data/VERSION

@@ -0,0 +1 @@
+2011.11.30.1

data/lib/ghaki/registry/app.rb

@@ -0,0 +1,8 @@
+require 'ghaki/app/engine'
+require 'ghaki/registry/engine'
+
+Ghaki::App::Engine.class_eval do
+  def registry
+    Ghaki::Registry::Engine.instance
+  end
+end

data/lib/ghaki/registry/engine.rb

@@ -0,0 +1,99 @@
+############################################################################
+require 'singleton'
+require 'ghaki/registry/errors'
+require 'ghaki/registry/feature'
+
+############################################################################
+module Ghaki module Registry
+  class Engine
+    include Singleton
+
+    ########################################################################
+    attr_reader :features
+
+    ########################################################################
+    def initialize
+      clear_features
+    end
+    def clear_features
+      @features = {}
+    end
+
+    ########################################################################
+    def reserve_feature name
+      @features[name] ||= Ghaki::Registry::Feature.new( name )
+    end
+    def remove_feature name
+      @features.delete(name)
+    end
+    def has_feature? name
+      @features.has_key? name
+    end
+    def assert_feature! name
+      raise FeatureNotFoundError.new(name) unless has_feature? name
+    end
+    def get_feature name
+      assert_feature! name
+      @features[name]
+    end
+
+    ########################################################################
+    def enable_feature name
+      get_feature(name).enable
+    end
+    def disable_feature name
+      get_feature(name).disable
+    end
+    def enabled_feature? name
+      get_feature(name).enabled?
+    end
+
+    ########################################################################
+    def plugins feat
+      get_feature(feat).plugins
+    end
+    def add_plugin feat, plug, klass
+      reserve_feature(feat).add_plugin( plug, klass )
+    end
+    def has_plugin? feat, plug
+      get_feature(feat).has_plugin? plug
+    end
+    def assert_plugin! feat, plug
+      get_feature(feat).assert_plugin!(plug)
+    end
+    def remove_plugin feat, plug
+      get_feature(feat).remove_plugin(plug) if has_feature?(feat)
+    end
+    def clear_plugins feat
+      get_feature(feat).clear_plugins if has_feature?(feat)
+    end
+    def load_plugin feat, plug, lib_path
+      get_feature(feat).load_plugin(plug,lib_path)
+    end
+    def get_plugin feat, plug
+      get_feature(feat).get_plugin(plug)
+    end
+
+    ########################################################################
+    def enable_plugin feat, plug
+      get_plugin(feat,plug).enable
+    end
+    def disable_plugin feat, plug
+      get_plugin(feat,plug).disable
+    end
+    def enabled_plugin? feat, plug
+      get_plugin(feat,plug).enabled?
+    end
+    def factory_create feat, plug, *args
+      get_plugin(feat,plug).create(*args)
+    end
+    def plugin_failure feat, plug
+      get_plugin(feat,plug).failure
+    end
+    def failed_plugin? feat, plug
+      get_plugin(feat,plug).failed?
+    end
+
+  end
+end end
+############################################################################

data/lib/ghaki/registry/errors.rb

@@ -0,0 +1,60 @@
+############################################################################
+module Ghaki
+
+  ##########################################################################
+  class FeatureDisabledError < RuntimeError
+    attr_accessor :feature
+    def initialize _feature, msg=nil
+      @feature = _feature
+      msg ||= 'Feature Disabled: ' + @feature.to_s
+      super( msg )
+    end
+  end
+
+  #-------------------------------------------------------------------------
+  class FeatureNotFoundError < RuntimeError
+    attr_accessor :feature
+    def initialize _feature, msg=nil
+      @feature = _feature
+       msg ||= 'Feature Not Registered: ' + @feature.to_s
+      super(msg)
+    end
+  end
+
+  ##########################################################################
+  class PluginDisabledError < RuntimeError
+    attr_accessor :feature, :plugin
+    def initialize _feature, _plugin, msg=nil
+      @feature = _feature
+      @plugin  = _plugin
+      msg ||= 'Plugin Disabled: ' + @plugin.to_s
+      super(msg)
+    end
+  end
+
+  #-------------------------------------------------------------------------
+  class PluginNotFoundError < RuntimeError
+    attr_accessor :feature, :plugin
+    def initialize _feature, _plugin, msg=nil
+      @feature = _feature
+      @plugin  = _plugin
+      msg ||= 'Plugin Not Registered: ' + @plugin.to_s
+      super(msg)
+    end
+  end
+
+  #-------------------------------------------------------------------------
+  class PluginLoadingError < RuntimeError
+    attr_accessor :feature, :plugin, :lib_path, :reason
+    def initialize _feature, _plugin, _lib_path, _reason
+      @feature  = _feature
+      @plugin   = _plugin
+      @lib_path = _lib_path
+      @reason   = _reason
+      msg ||= 'Plugin Loading Error: ' + @reason.to_s
+      super(msg)
+    end
+  end
+
+end
+############################################################################

data/lib/ghaki/registry/factory.rb

@@ -0,0 +1,65 @@
+############################################################################
+require 'ghaki/registry/engine'
+
+############################################################################
+module Ghaki module Registry
+  module Factory
+
+    ########################################################################
+    def register_feature feat_name, opts={}
+      use_simple = if opts.has_key?(:simple_naming) then opts[:simple_naming] else true end
+      feat_nick  = if opts.has_key?(:nick_name) then opts[:nick_name] else feat_name end
+
+      feat_and_plug_map = {
+        :has_plugin?     =>     :"has_#{feat_nick}_plugin?",
+        :enable_plugin   =>  :"enable_#{feat_nick}_plugin",
+        :enabled_plugin? => :"enabled_#{feat_nick}_plugin?",
+        :disable_plugin  => :"disable_#{feat_nick}_plugin",
+        :remove_plugin   =>  :"remove_#{feat_nick}_plugin",
+      }
+
+      just_feat_map = {
+        :clear_plugins => :"clear_#{feat_nick}_plugins",
+        :plugins       =>       :"#{feat_nick}_plugins",
+      }
+
+      Ghaki::Registry::Engine.instance.reserve_feature(feat_name)
+
+      (class << self; self; end).instance_eval do
+
+        feat_and_plug_map.each_pair do |simple,complex|
+          fac_meth = if use_simple then simple else complex end
+          define_method fac_meth do |plug_name|
+            Ghaki::Registry::Engine.instance.send( simple, feat_name, plug_name )
+          end
+        end
+
+        just_feat_map.each_pair do |simple,complex|
+          fac_meth = if use_simple then simple else complex end
+          define_method fac_meth do
+            Ghaki::Registry::Engine.instance.send( simple, feat_name )
+          end
+        end
+
+        fac_meth = if use_simple then :feature else :"#{feat_nick}_feature" end
+        define_method fac_meth do
+          Ghaki::Registry::Engine.instance.get_feature( feat_name )
+        end
+
+        fac_meth = if use_simple then :create else :"create_#{feat_nick}_plugin" end
+        define_method fac_meth do |plug_name,*args|
+          Ghaki::Registry::Engine.instance.factory_create( feat_name, plug_name, *args )
+        end
+
+        fac_meth = if use_simple then :add_plugin else :"add_#{feat_nick}_plugin" end
+        define_method fac_meth do |plug_name,klass|
+          Ghaki::Registry::Engine.instance.add_plugin( feat_name, plug_name, klass )
+        end
+
+      end # inst eval
+
+    end # def reg
+
+  end # class
+end end # namespace
+############################################################################

data/lib/ghaki/registry/feature.rb

@@ -0,0 +1,95 @@
+############################################################################
+require 'ghaki/registry/service'
+
+############################################################################
+module Ghaki module Registry
+  class Feature
+
+    ########################################################################
+    attr_accessor :name, :plugins
+
+    ########################################################################
+    def initialize _name
+      @name = _name
+      @enabled = true
+      @plugins = {}
+    end
+
+    ########################################################################
+    def to_s; self.name.to_s end
+
+    ########################################################################
+    def clear_plugins
+      @plugins = {}
+    end
+
+    ########################################################################
+    def enabled?
+      @enabled
+    end
+    def enable val=true
+      @enabled = val
+    end
+    def disable val=true
+      self.enable !val
+    end
+    def assert_enabled!
+      raise FeatureDisabledError.new( self.name ) unless self.enabled?
+    end
+
+    ########################################################################
+    def add_plugin plugin_name, plugin_class
+      @plugins[plugin_name] = Ghaki::Registry::Service.new( self, plugin_name, plugin_class )
+    end
+
+    ########################################################################
+    def load_plugin plugin_name, lib_path
+      begin
+        require lib_path
+      rescue Exception => e
+        @plugins[plugin_name]  = Ghaki::Registry::Service.new( self, plugin_name, nil )
+        @plugins[plugin_name].failure = Ghaki::PluginLoadingError.new( self.name, plugin_name, lib_path, e)
+        nil
+      end
+    end
+
+    ########################################################################
+    def assert_plugin! plugin_name
+      raise PluginNotFoundError.new( self.name, plugin_name ) unless has_plugin? plugin_name
+    end
+    def get_plugin plugin_name
+      assert_plugin! plugin_name
+      @plugins[plugin_name]
+    end
+    def remove_plugin plugin_name
+      @plugins.delete plugin_name
+    end
+    def has_plugin? plugin_name
+      @plugins.has_key? plugin_name
+    end
+
+    ########################################################################
+    def factory_create plugin_name, *args
+      get_plugin(plugin_name).create(*args)
+    end
+    def enabled_plugin? plugin_name
+      get_plugin(plugin_name).enabled?
+    end
+    def disable_plugin plugin_name
+      get_plugin(plugin_name).disable
+    end
+    def enable_plugin plugin_name
+      get_plugin(plugin_name).enable
+    end
+
+    ########################################################################
+    def failed_plugin? plugin_name
+      get_plugin(plugin_name).failed?
+    end
+    def plugin_failure plugin_name
+      get_plugin(plugin_name).failure
+    end
+
+  end
+end end
+############################################################################

data/lib/ghaki/registry/plugin.rb

@@ -0,0 +1,23 @@
+############################################################################
+require 'ghaki/registry/engine'
+
+############################################################################
+module Ghaki module Registry
+  module Plugin
+
+    ########################################################################
+    def set_plugin_registry feat_name, opts={}
+      use_simple = if opts.has_key?(:simple_naming) then opts[:simple_naming] else true end
+      feat_nick  = if opts.has_key?(:nick_name)     then opts[:nick_name] else feat_name end
+      reg_meth   = if use_simple then :register_plugin else :"register_#{feat_nick}_plugin" end
+      Ghaki::Registry::Engine.instance.reserve_feature( feat_name )
+      (class << self; self; end).instance_eval do
+        define_method reg_meth do |reg_item|
+          Ghaki::Registry::Engine.instance.add_plugin( feat_name, reg_item, self )
+        end
+      end
+    end
+
+  end
+end end
+############################################################################

data/lib/ghaki/registry/service.rb

@@ -0,0 +1,57 @@
+############################################################################
+require 'ghaki/registry/errors'
+
+############################################################################
+module Ghaki module Registry
+  class Service
+
+    ########################################################################
+    attr_accessor :name, :feature, :klass, :failure
+
+    ########################################################################
+    def initialize _feature, _name, _klass
+      @feature = _feature
+      @name = _name
+      @klass = _klass
+      @enabled = true
+      @failure = nil
+    end
+
+    ########################################################################
+    def to_s; @name.to_s end
+
+    ########################################################################
+    def enabled?
+      @enabled
+    end
+    def enable val=true
+      @enabled = val
+    end
+    def disable val=true
+      self.enable !val
+    end
+    def assert_enabled!
+      raise PluginDisabledError.new( @feature, @name ) unless enabled?
+    end
+
+    ########################################################################
+    def failed?
+      !@failure.nil?
+    end
+    def assert_not_failed!
+      raise @failure if failed?
+    end
+
+    ########################################################################
+    def assert_can_create!
+      assert_not_failed!
+      assert_enabled!
+    end
+    def create *args
+      assert_can_create!
+      return @klass.new( *args )
+    end
+    
+  end
+end end
+############################################################################