ghaki-registry 2011.11.30.1

data/spec/ghaki/registry/app_spec.rb

@@ -0,0 +1,22 @@
+############################################################################
+require 'ghaki/app/engine'
+require 'ghaki/registry/app'
+
+module Ghaki module Registry module AppTesting
+  APP_MOD = Ghaki::App::Engine
+  ENG_MOD = Ghaki::Registry::Engine
+describe APP_MOD do
+
+  context 'singleton' do
+    subject { APP_MOD.instance }
+    it { should respond_to :registry }
+    context '#registry' do
+      subject { APP_MOD.instance.registry }
+      it { should be_an_instance_of(ENG_MOD) }
+      it { should equal(ENG_MOD.instance) }
+    end
+  end
+
+end
+end end end
+############################################################################

data/spec/ghaki/registry/engine_spec.rb

@@ -0,0 +1,243 @@
+############################################################################
+require 'ghaki/registry/engine'
+
+############################################################################
+module Ghaki module Registry module EngineTesting
+describe Ghaki::Registry::Engine do
+
+  class TestPlugin; end
+
+  #######################################################################
+  subject do Ghaki::Registry::Engine.instance end
+
+  ########################################################################
+  after(:each) do
+    subject.clear_features
+  end
+
+  ########################################################################
+  context 'singleton' do
+    MY_METHODS = [
+      :features, :clear_features,
+      :reserve_feature, :remove_feature,
+      :has_feature?, :assert_feature!, :get_feature,
+      :enable_feature, :disable_feature, :enabled_feature?,
+      :plugins, :clear_plugins,
+      :add_plugin, :remove_plugin,
+      :has_plugin?, :assert_plugin!, :get_plugin,
+      :enable_plugin, :disable_plugin, :enabled_plugin?,
+      :failed_plugin?, :plugin_failure,
+      :factory_create, :load_plugin,
+    ]
+    MY_METHODS.each do |token| it { should respond_to token } end
+    specify { should be_an_instance_of Engine }
+  end
+
+  ########################################################################
+  context 'initial state' do
+    it 'should have no features' do
+      subject.features.empty?.should == true
+    end
+  end
+
+  ########################################################################
+  ########################################################################
+  context 'feature normal methods' do
+
+    describe '#reserve_feature' do
+      it 'should reserve names' do
+        subject.reserve_feature :my_feat
+        subject.features.keys.length.should == 1
+        subject.features.has_key?(:my_feat)
+      end
+    end
+
+    describe '#has_feature?' do
+      it 'should see features' do
+        subject.reserve_feature :my_feat
+        subject.has_feature?(:my_feat).should == true
+      end
+    end
+
+    describe '#assert_feature!' do
+      it 'should raise when missing' do
+        lambda do
+          subject.assert_feature! :mine
+        end.should raise_error(Ghaki::FeatureNotFoundError)
+      end
+      it 'should not raise when present' do
+        lambda do
+          subject.reserve_feature :mine
+          subject.assert_feature! :mine
+        end.should_not raise_error(Ghaki::FeatureNotFoundError)
+      end
+    end
+
+    describe '#get_feature' do
+      it 'should fetch' do
+        subject.reserve_feature :my
+        subject.get_feature(:my).class.should == Ghaki::Registry::Feature
+        subject.get_feature(:my).name.should == :my
+      end
+    end
+
+    describe '#clear_features' do
+      it 'should remove all' do
+        subject.reserve_feature :my_reg_a
+        subject.reserve_feature :my_reg_b
+        subject.clear_features
+        subject.has_feature?( :my_reg_a ).should == false
+        subject.features.empty?.should == true
+      end
+    end
+
+    describe '#remove_feature' do
+      it 'should remove' do
+        subject.reserve_feature :my_reg
+        subject.remove_feature :my_reg
+        subject.has_feature?( :my_reg ).should == false
+      end
+    end
+
+  end # feat norm meths
+
+  ########################################################################
+  ########################################################################
+  context 'feature delegate methods' do
+
+    before(:each) do
+      subject.reserve_feature :duck
+    end
+
+    describe '#disable_feature' do
+      it 'should disable' do
+        subject.disable_feature :duck
+        subject.enabled_feature?(:duck).should == false
+      end
+    end
+
+    describe '#enable_feature' do
+      it 'should enable' do
+        subject.disable_feature :duck
+        subject.enable_feature :duck
+        subject.enabled_feature?(:duck).should == true
+      end
+    end
+
+    describe '#plugins' do
+      it 'should have plugins' do
+        subject.plugins(:duck).class.should == Hash
+        subject.get_feature(:duck).plugins == subject.plugins(:duck)
+      end
+    end
+
+    describe '#get_plugin' do
+      it 'should retrieve plugin' do
+        subject.add_plugin :my_reg, :my_plugin, TestPlugin
+        plug_a = subject.get_feature(:my_reg).get_plugin(:my_plugin)
+        plug_b = subject.get_plugin(:my_reg,:my_plugin)
+        plug_a.should == plug_b
+      end
+    end
+
+    describe '#add_plugin' do
+      it 'should register plugin' do
+        subject.add_plugin :my_reg, :my_plugin, TestPlugin
+        subject.get_feature(:my_reg).has_plugin?(:my_plugin).should == true
+      end
+    end
+
+    describe '#has_plugin?' do
+      it 'should see plugin' do
+        subject.add_plugin :my_reg, :my_plugin, TestPlugin
+        subject.plugins(:my_reg).has_key?(:my_plugin).should == true
+      end
+    end
+
+    describe '#assert_plugin!' do
+      it 'should complain when missing' do
+        lambda do
+          subject.reserve_feature :my_reg
+          subject.assert_plugin! :my_reg, :my_plugin
+        end.should raise_error(Ghaki::PluginNotFoundError)
+      end
+      it 'should not raise when present' do
+        lambda do
+          subject.add_plugin :my_reg, :my_plugin, TestPlugin
+          subject.assert_plugin!  :my_reg, :my_plugin
+        end.should_not raise_error(Ghaki::PluginNotFoundError)
+      end
+    end
+
+    describe '#remove_plugin!' do
+      it 'should remove' do
+        subject.add_plugin :my_reg, :my_plug, TestPlugin
+        subject.remove_plugin :my_reg, :my_plug
+        subject.has_plugin?( :my_reg, :my_plug ).should == false
+      end
+    end
+
+    describe '#clear_plugins' do
+      it 'should remove all plugins' do
+        subject.add_plugin :my_reg, :my_plug_a, TestPlugin
+        subject.add_plugin :my_reg, :my_plug_b, TestPlugin
+        subject.clear_plugins :my_reg
+        subject.has_plugin?( :my_reg, :my_plug_a ).should == false
+        subject.has_plugin?( :my_reg, :my_plug_b ).should == false
+        subject.plugins(:my_reg).empty?
+      end
+    end
+
+  end # feat del meth
+
+  ########################################################################
+  ########################################################################
+  context 'plugin delegate methods' do
+
+    before(:each) do
+      subject.add_plugin :my_reg, :my_plugin, TestPlugin
+    end
+
+    describe '#enabled_plugin?' do
+      it 'should see plugin' do
+        subject.enabled_plugin?(:my_reg,:my_plugin).should == true
+      end
+    end
+
+    describe '#disable_plugin' do
+      it 'should disable' do
+        subject.disable_plugin :my_reg, :my_plugin
+        subject.get_feature(:my_reg).get_plugin(:my_plugin).enabled?.should == false
+      end
+    end
+
+    describe '#enable_plugin' do
+      it 'should enable' do
+        subject.disable_plugin :my_reg, :my_plugin
+        subject.enable_plugin :my_reg, :my_plugin
+        subject.get_feature(:my_reg).get_plugin(:my_plugin).enabled?.should == true
+      end
+    end
+
+    describe '#factory_create' do
+      it 'should create plugin when present' do
+        subject.factory_create( :my_reg, :my_plugin ).class.should == TestPlugin
+      end
+      it 'should complain about missing feature' do
+        lambda do
+          subject.factory_create( :miss_reg, :my_plugin )
+        end.should raise_error(Ghaki::FeatureNotFoundError)
+      end
+      it 'should complain about missing plugin' do
+        lambda do
+          subject.factory_create( :my_reg, :miss_plugin )
+        end.should raise_error(Ghaki::PluginNotFoundError)
+      end
+
+    end
+
+  end # plug del meth
+
+end
+end end end
+############################################################################

data/spec/ghaki/registry/factory_spec.rb

@@ -0,0 +1,174 @@
+############################################################################
+require 'ghaki/registry/engine'
+require 'ghaki/registry/factory'
+
+############################################################################
+module Ghaki module Registry module FactoryTesting
+  describe Ghaki::Registry::Factory do
+
+    before(:all) do @reg = Ghaki::Registry::Engine.instance end
+    after(:each) do @reg.clear_features end
+
+    ##########################################################################
+    ##########################################################################
+    context 'with simple naming' do
+
+      ########################################################################
+      class DogPlugin; end
+      class DogFactory
+        extend Ghaki::Registry::Factory
+        register_feature :dog
+        private_class_method :new
+      end
+
+      ########################################################################
+      before(:each) do @reg.add_plugin(:dog,:rover,DogPlugin) end
+
+      ########################################################################
+      context 'objects extended by' do
+        subject do DogFactory end
+        DOG_METHODS = [
+          :create, :has_plugin?, :add_plugin,
+          :enabled_plugin?, :enable_plugin, :disable_plugin,
+          :remove_plugin, :clear_plugins, :plugins, :feature,
+        ]
+        DOG_METHODS.each do |token| it { should respond_to token } end
+      end
+
+      ########################################################################
+      context 'methods' do
+
+        describe '#create' do
+          it 'should make object' do
+            DogFactory.create(:rover).class.should == DogPlugin
+          end
+        end
+
+        describe '#has_plugin?' do
+          it 'should see' do
+            DogFactory.has_plugin?(:rover).should == true
+          end
+        end
+
+        describe '#plugins' do
+          it 'should have plugins' do
+            DogFactory.plugins.class.should == Hash
+            DogFactory.plugins.keys.length.should == 1
+          end
+        end
+
+        describe '#disable_plugins' do
+          it 'should disable' do
+            DogFactory.disable_plugin(:rover)
+            DogFactory.enabled_plugin?(:rover)
+          end
+        end
+
+        describe '#enable_plugins' do
+          it 'should disable' do
+            DogFactory.disable_plugin(:rover)
+            DogFactory.enable_plugin(:rover)
+            DogFactory.enabled_plugin?(:rover)
+          end
+        end
+
+        describe '#remove_plugin' do
+          it 'should remove' do
+            DogFactory.remove_plugin(:rover)
+            DogFactory.has_plugin?(:rover).should == false
+          end
+        end
+
+        describe '#feature' do
+          it 'should expose feature' do
+            DogFactory.feature.class.should == Ghaki::Registry::Feature
+          end
+        end
+
+      end # simple methods
+
+    end # simple
+
+    ##########################################################################
+    ##########################################################################
+    context 'complex' do
+
+      ########################################################################
+      class CatPlugin; end
+      class CatFactory
+        extend Ghaki::Registry::Factory
+        register_feature :cat, :simple_naming => false
+        private_class_method :new
+      end
+
+      ########################################################################
+      before(:each) do @reg.add_plugin(:cat,:felix,CatPlugin) end
+
+      ########################################################################
+      context 'objects extended by' do
+        subject do CatFactory end
+        CAT_METHODS = [
+          :create_cat_plugin, :has_cat_plugin?, :add_cat_plugin,
+          :enabled_cat_plugin?, :enable_cat_plugin, :disable_cat_plugin,
+          :remove_cat_plugin, :clear_cat_plugins, :cat_plugins, :cat_feature,
+        ]
+        CAT_METHODS.each do |token| it { should respond_to token } end
+      end
+      
+      ########################################################################
+      context 'methods' do
+
+        describe '#create_<name>' do
+          it 'should create' do
+            CatFactory.create_cat_plugin(:felix).class.should == CatPlugin
+          end
+        end
+
+        describe '#has_plugin_<name>?' do
+          it 'should see' do
+            CatFactory.has_cat_plugin?(:felix).should == true
+          end
+        end
+
+        describe '#<name>_plugins' do
+          it 'should have plugins' do
+            CatFactory.cat_plugins.class.should == Hash
+            CatFactory.cat_plugins.keys.length.should == 1
+          end
+        end
+
+        describe '#disable_<name>_plugin' do
+          it 'should disable' do
+            CatFactory.disable_cat_plugin(:felix)
+            CatFactory.enabled_cat_plugin?(:felix).should == false
+          end
+        end
+
+        describe '#enable_<name>_plugin' do
+          it 'should enable' do
+            CatFactory.disable_cat_plugin(:felix)
+            CatFactory.enable_cat_plugin(:felix)
+            CatFactory.enabled_cat_plugin?(:felix).should == true
+          end
+        end
+
+        describe '#remove_<name>_plugin' do
+          it 'should remove' do
+            CatFactory.remove_cat_plugin(:felix)
+            CatFactory.has_cat_plugin?(:felix).should == false
+          end
+        end
+
+        describe '#<name>_feature' do
+          it 'should expose feature' do
+            CatFactory.cat_feature.class.should == Ghaki::Registry::Feature
+          end
+        end
+
+      end # complex methods
+
+    end # complex
+
+  end
+end end end
+############################################################################

data/spec/ghaki/registry/feature_spec.rb

@@ -0,0 +1,209 @@
+############################################################################
+require 'ghaki/registry/feature'
+
+############################################################################
+module Ghaki module Registry module FeatureTesting
+  describe Ghaki::Registry::Feature do
+
+    class TestPlugin
+    end
+
+    ########################################################################
+    before (:each) do
+      @feature = Ghaki::Registry::Feature.new(:my_feature)
+    end
+
+    ########################################################################
+    subject do @feature end
+
+    ########################################################################
+    context 'object' do
+      MY_METHODS = [
+        :enabled?, :enable, :disable, :assert_enabled!,
+        :add_plugin, :remove_plugin, :has_plugin?, :assert_plugin!,
+        :plugins, :clear_plugins, :to_s,
+        :get_plugin, :factory_create,
+        :enable_plugin, :disable_plugin, :enabled_plugin?,
+        :load_plugin, :failed_plugin?, :plugin_failure,
+      ]
+      MY_METHODS.each do |token| it { should respond_to token } end
+    end
+
+    ########################################################################
+    ########################################################################
+    context 'initial state' do
+      it 'should be enabled' do
+        subject.enabled?.should be_true
+      end
+      it 'should be empty' do
+        subject.plugins.empty?.should be_true
+      end
+      it '#plugins should be hash' do
+        subject.plugins.should be_an_instance_of(::Hash)
+      end
+    end
+
+    ########################################################################
+    ########################################################################
+    context 'methods' do
+
+      ######################################################################
+      describe '#disable' do
+        it 'should disable' do
+          subject.disable
+          subject.enabled?.should be_false
+        end
+      end
+
+      ######################################################################
+      describe '#enable' do
+        it 'should enable' do
+          subject.disable
+          subject.enable
+          subject.enabled?.should be_true
+        end
+      end
+
+      ######################################################################
+      describe '#assert_enabled!' do
+        it 'should not complain when enabled' do
+          lambda do
+            subject.assert_enabled!
+          end.should_not raise_error(Ghaki::FeatureDisabledError)
+        end
+        it 'should complain when disabled' do
+          lambda do
+            subject.disable
+            subject.assert_enabled!
+          end.should raise_error(Ghaki::FeatureDisabledError)
+        end
+      end
+
+      ######################################################################
+      describe '#add_plugin' do
+        it 'should register plugin' do
+          subject.add_plugin :my_plugin, TestPlugin
+          subject.has_plugin?( :my_plugin ).should be_true
+          subject.get_plugin(:my_plugin).should_not be_nil
+        end
+      end
+
+      ######################################################################
+      describe '#assert_plugin!' do
+        it 'should complain when missing' do
+          lambda do
+            subject.assert_plugin! :my_plugin
+          end.should raise_error(Ghaki::PluginNotFoundError)
+        end
+        it 'should not complain when present' do
+          lambda do
+            subject.add_plugin :my_plugin
+            subject.assert_plugin!  :my_plugin
+          end.should_not raise_error(Ghaki::PluginNotFoundError)
+        end
+      end
+
+      ######################################################################
+      describe '#remove_plugin' do
+        it 'should remove' do
+          subject.add_plugin :my_plug_a, TestPlugin
+          subject.add_plugin :my_plug_b, TestPlugin
+          subject.remove_plugin :my_plug_a
+          subject.has_plugin?( :my_plug_a ).should be_false
+          subject.has_plugin?( :my_plug_b ).should be_true
+          subject.plugins.keys.length.should == 1
+        end
+      end
+
+      ######################################################################
+      describe '#clear_plugins' do
+        it 'should remove all plugins' do
+          subject.add_plugin :my_plug_a, TestPlugin
+          subject.add_plugin :my_plug_b, TestPlugin
+          subject.clear_plugins
+          subject.has_plugin?( :my_plug_a ).should be_false
+          subject.has_plugin?( :my_plug_b ).should be_false
+          subject.plugins.keys.empty?.should be_true
+        end
+      end
+
+      ######################################################################
+      describe '#load_plugin' do
+        it 'should return nil when library load fails' do
+          subject.load_plugin( :my_plugin, 'bogus/missing' ).should be_nil
+        end
+      end
+
+      ######################################################################
+      describe '#plugin_failure' do
+        it 'should have error when library load fails' do
+          subject.load_plugin( :my_plugin, 'crap/missing' )
+          subject.plugin_failure(:my_plugin).should be_an_instance_of(Ghaki::PluginLoadingError)
+        end
+      end
+      describe '#failed_plugin?' do
+        it 'should detect library load failure' do
+          subject.load_plugin( :my_plug_bad, 'crap/missing' )
+          subject.failed_plugin?(:my_plug_bad).should be_true
+        end
+        it 'should not have a failure if successful' do
+          subject.add_plugin( :my_plug_good, TestPlugin )
+          subject.failed_plugin?(:my_plug_good).should be_false
+        end
+      end
+
+      ######################################################################
+      describe '#factory_create' do
+        it 'should create when plugin is present' do
+          subject.add_plugin :my_plugin, TestPlugin
+          subject.factory_create( :my_plugin ).should be_an_instance_of(TestPlugin)
+        end
+        it 'should complain when plugin is not specified' do
+          lambda do
+              subject.factory_create( :my_plugin )
+          end.should raise_error(Ghaki::PluginNotFoundError)
+        end
+        it 'should complain when plugin is invalid' do
+          subject.load_plugin( :my_plugin, 'junk/missing' )
+          lambda do
+                subject.factory_create :my_plugin
+          end.should raise_error(Ghaki::PluginLoadingError)
+        end
+      end
+
+    end # meths
+
+    ########################################################################
+    ########################################################################
+    context 'quasi delegated methods' do
+
+      ######################################################################
+      describe '#enabled_plugin?' do
+        it 'should see status' do
+          subject.add_plugin :my_plugin, TestPlugin
+          subject.enabled_plugin?(:my_plugin).should be_true
+        end
+      end
+      ######################################################################
+      describe '#disable_plugin' do
+        it 'should disable' do
+          subject.add_plugin :my_plugin, TestPlugin
+          subject.disable_plugin :my_plugin
+          subject.enabled_plugin?(:my_plugin).should be_false
+        end
+      end
+      ######################################################################
+      describe '#enable_plugin' do
+        it 'should enable' do
+          subject.add_plugin :my_plugin, TestPlugin
+          subject.disable_plugin :my_plugin
+          subject.enable_plugin :my_plugin
+          subject.enabled_plugin?(:my_plugin).should be_true
+        end
+      end
+
+    end # quasi-delegated meths
+
+  end
+end end end
+############################################################################