ribbon-plugins 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 230fbea0e698049dd095f097a6d977eca0e17359
-  data.tar.gz: 65c29190976d2a231e41493ad9840dbf9bdf90f3
+  metadata.gz: b1203cf7726507ab9760f6ba519ea768fcbf5c19
+  data.tar.gz: 93210e25c99e2d1381c64baff34375e9d41c9f4f
 SHA512:
-  metadata.gz: 6635638f54be4b62c15e4e988f60636d2e37d2bbb0d8686f785e2cba13a11a994d7f7a51dc664085f8cd021de9a2920a66c6a9531276b1c188cd9e7979537e8f
-  data.tar.gz: c70c4dec948b31c09c49e8bf61be462386095da0bce1ae5d3032b7951a46f77ec660932a3fd0a0bc7f6477f432f4c3b8b1bb0b446302477aa62bf5584298064b
+  metadata.gz: a016c927a8a9061452311957494d201bc6ffb220c68582358b048626171baa0042f38d2841e1f46b37c169aa2f28209a502d4b32ad837ffb95e4556b9971a2ee
+  data.tar.gz: 2eaf238f288063cf187e7c6f0454b4a1ce2dddfb6dec76c2d1def45b0acafd3c65a4978beac6704cb317f6f01ce977d693329bdab89c73f413c8ed4e34aafe83

data/lib/ribbon/plugins/component_mixin.rb

@@ -0,0 +1,47 @@
+module Ribbon
+  class Plugins
+    ##
+    # Intended to be mixed into any class utilizing the plugins functionality.
+    module ComponentMixin
+      def self.included(base)
+        base.extend(ClassMethods)
+      end
+
+      module ClassMethods
+        ##
+        # Get or define the plugin loader.
+        #
+        # This block will be used to load a plugin given the value passed to the
+        # +plugin+ instance method. It's the responsibility of this block to
+        # translate the inputted value into either a Class that extends Plugin
+        # or a Proc.
+        #
+        # If for a particular value you wish to not perform any translation,
+        # return falsey.
+        def plugin_loader(&block)
+          if block_given?
+            @_plugin_loader = block
+          else
+            @_plugin_loader
+          end
+        end
+      end
+
+      ###
+      # Instance Methods
+      ###
+
+      ##
+      # Reference to the Plugins instance for the component.
+      def plugins
+        @plugins ||= Plugins.new(self, &self.class.plugin_loader)
+      end
+
+      ##
+      # Add a plugin.
+      def plugin(plugin)
+        plugins.add(plugin)
+      end
+    end
+  end
+end

data/lib/ribbon/plugins/plugin.rb

@@ -33,6 +33,12 @@ class Ribbon::Plugins
       end
     end
 
+    attr_reader :plugins
+
+    def initialize(plugins=nil)
+      @plugins = plugins
+    end
+
     def before(subject, *args)
       _callbacks(:before, subject).call(*args)
     end

data/lib/ribbon/plugins/version.rb

@@ -1,5 +1,5 @@
 module Ribbon
   class Plugins
-    VERSION = "0.1.0"
+    VERSION = "0.2.0"
   end
 end

data/lib/ribbon/plugins.rb

@@ -2,18 +2,22 @@ require 'ribbon/plugins/version'
 
 module Ribbon
   class Plugins
-    autoload(:Errors,      'ribbon/plugins/errors')
-    autoload(:Plugin,      'ribbon/plugins/plugin')
-    autoload(:AroundStack, 'ribbon/plugins/around_stack')
-    autoload(:BlockStack,  'ribbon/plugins/block_stack')
+    autoload(:Errors,         'ribbon/plugins/errors')
+    autoload(:Plugin,         'ribbon/plugins/plugin')
+    autoload(:AroundStack,    'ribbon/plugins/around_stack')
+    autoload(:BlockStack,     'ribbon/plugins/block_stack')
+    autoload(:ComponentMixin, 'ribbon/plugins/component_mixin')
 
-    def initialize(plugin_module=nil)
-      @_plugin_module = plugin_module
+    attr_reader :component, :plugin_loader
+
+    def initialize(component=nil, &block)
+      @component = component
+      @plugin_loader = block
     end
 
     def add(plugin=nil, &block)
       plugin = _load(plugin, &block)
-      _add_plugin(plugin.new)
+      _add_plugin(plugin.new(self))
     end
 
     def clear
@@ -50,11 +54,14 @@ module Ribbon
 
     def _add_plugin(plugin)
       _plugins.push(plugin)
+
       _around_stack.push { |subject, *args|
         plugin.around(subject, *args) {
           perform_block
         }
       }
+
+      plugin
     end
 
     def _load(plugin, &block)
@@ -68,12 +75,12 @@ module Ribbon
     end
 
     def _load_plugin(plugin)
+      _call_plugin_loader(plugin).tap { |p| plugin = p if p }
+
       case plugin
       when Class
         plugin < Plugin && plugin or
           raise Errors::LoadError, "Invalid plugin class: #{plugin.inspect} Must extend Plugin."
-      when Symbol, String
-        _load_plugin_by_name(plugin)
       when Proc
         Plugin.create(&plugin)
       else
@@ -81,9 +88,8 @@ module Ribbon
       end
     end
 
-    def _load_plugin_by_name(name)
-      @_plugin_module && @_plugin_module.const_get("#{name.upcase}Plugin") or
-        raise Errors::LoadError, "Cannot load plugin by name. No plugin module provided."
+    def _call_plugin_loader(plugin)
+      plugin_loader && component.instance_exec(plugin, &plugin_loader)
     end
   end # Plugins
 end # Ribbon

metadata

@@ -1,33 +1,33 @@
 --- !ruby/object:Gem::Specification
 name: ribbon-plugins
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Robert Honer
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-03-02 00:00:00.000000000 Z
+date: 2015-03-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '3.2'
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: 3.2.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '3.2'
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: 3.2.0
 description: A flexible plugins framework.
@@ -40,6 +40,7 @@ files:
 - lib/ribbon/plugins.rb
 - lib/ribbon/plugins/around_stack.rb
 - lib/ribbon/plugins/block_stack.rb
+- lib/ribbon/plugins/component_mixin.rb
 - lib/ribbon/plugins/errors.rb
 - lib/ribbon/plugins/plugin.rb
 - lib/ribbon/plugins/version.rb
@@ -53,17 +54,17 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.2
+rubygems_version: 2.4.5
 signing_key: 
 specification_version: 4
 summary: A flexible plugins framework.