plugins 0.2.4 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 95e5717b6ed8f94cb9b10852dd0ffe859694411c
-  data.tar.gz: 38b115995d982f05f361b66724af2b7b24e4f514
+  metadata.gz: 456787abd50681a78ad147e4a211cb48def2d30f
+  data.tar.gz: 8a4ac2ed935ef744f9848c2d9537edab96f608e3
 SHA512:
-  metadata.gz: 96d3f53560dcb1f37190b5ac7bd093de98b164a7238ea09cdd5cc5eae98bcb3d53aff42d72aa9c4f1f83b35452ae68d1fc8ac604797f40f9b090d5e02e064708
-  data.tar.gz: 14322d806fa42ab7f954b5393eeffc5a6a5fcfaddf3fd7bb256b326051a1d001e926ea149a2b17c49ecea617feea711ba351f5b5c6889c43e74ad798c0096254
+  metadata.gz: 3f9059010da8fb8b9234bf989b40803d236b462ddbddd46453f56190bc5eecb0662d1b007badbb707c70b269aa36123541574125aaf437686ed9f0113e8060bb
+  data.tar.gz: 98621f1f7ca9c6f0565261fd9250a753329d45edd58399a355f82f3967c051ed87b7a0dd6638d27dc40c080d8180a37f8050255f2d447b228ecf63979dfbb1c6

data/lib/plugins.rb

@@ -0,0 +1,95 @@
+require 'plugins/version'
+
+class Plugins
+  autoload(:Errors,         'plugins/errors')
+  autoload(:Plugin,         'plugins/plugin')
+  autoload(:AroundStack,    'plugins/around_stack')
+  autoload(:BlockStack,     'plugins/block_stack')
+  autoload(:ComponentMixin, 'plugins/component_mixin')
+
+  attr_reader :component, :plugin_loader
+
+  def initialize(component=nil, &block)
+    @component = component
+    @plugin_loader = block
+  end
+
+  def add(plugin=nil, *args, &block)
+    plugin = _load(plugin, &block)
+    _add_plugin(plugin.new(self, *args))
+  end
+
+  def clear
+    @_plugins = nil
+    @_around_stack = nil
+  end
+
+  def before(subject, *args)
+    _plugins.reverse_each { |plugin| plugin.before(subject, *args) }
+  end
+
+  def after(subject, *args)
+    _plugins.reverse_each { |plugin| plugin.after(subject, *args) }
+  end
+
+  def around(subject, *args, &block)
+    _around_stack.call(subject, *args) { |subject, *args| block.call(*args) }
+  end
+
+  def perform(subject, *args, &block)
+    before(subject, *args)
+    retval = around(subject, *args, &block)
+    after(subject, *args)
+
+    retval
+  end
+
+  private
+  def _plugins
+    @_plugins ||= []
+  end
+
+  def _around_stack
+    @_around_stack ||= AroundStack.new(:block, self)
+  end
+
+  def _add_plugin(plugin)
+    _plugins.push(plugin)
+
+    _around_stack.push { |subject, *args|
+      plugin.around(subject, *args) { |*args|
+        perform_block(subject, *args)
+      }
+    }
+
+    plugin
+  end
+
+  def _load(plugin, &block)
+    if plugin
+      _load_plugin(plugin)
+    elsif block_given?
+      Plugin.create(&block)
+    else
+      raise Errors::LoadError, 'No plugin information provided'
+    end
+  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 Proc
+      Plugin.create(&plugin)
+    else
+      raise Errors::LoadError, "Invalid plugin identifier: #{plugin.inspect}"
+    end
+  end
+
+  def _call_plugin_loader(plugin)
+    plugin_loader && component.instance_exec(plugin, &plugin_loader)
+  end
+end # Plugins

data/lib/{ribbon/plugins → plugins}/around_stack.rb

@@ -1,4 +1,4 @@
-class Ribbon::Plugins
+class Plugins
   class AroundStack
     attr_reader :subject
     attr_accessor :scope
@@ -102,4 +102,4 @@ class Ribbon::Plugins
       end
     end
   end # AroundStack
-end # Ribbon::Plugins
+end # Plugins

data/lib/{ribbon/plugins → plugins}/block_stack.rb

@@ -1,4 +1,4 @@
-class Ribbon::Plugins
+class Plugins
   class BlockStack
     attr_accessor :scope
 
@@ -27,4 +27,4 @@ class Ribbon::Plugins
       }
     end
   end
-end
+end

data/lib/plugins/component_mixin.rb

@@ -0,0 +1,45 @@
+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(*args, &block)
+      plugins.add(*args, &block)
+    end
+  end
+end

data/lib/{ribbon/plugins → plugins}/errors.rb

@@ -1,6 +1,6 @@
-class Ribbon::Plugins
+class Plugins
   module Errors
     class Error < StandardError; end
     class LoadError < Error; end
   end
-end
+end

data/lib/{ribbon/plugins → plugins}/plugin.rb

@@ -1,4 +1,4 @@
-class Ribbon::Plugins
+class Plugins
   class Plugin
     class << self
       def create(&block)
@@ -59,4 +59,4 @@ class Ribbon::Plugins
         }
     end
   end # Plugin
-end # Ribbon::Plugins
+end # Plugins

data/lib/plugins/version.rb

@@ -0,0 +1,3 @@
+class Plugins
+  VERSION = "0.3.0"
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: plugins
 version: !ruby/object:Gem::Version
-  version: 0.2.4
+  version: 0.3.0
 platform: ruby
 authors:
 - Robert Honer
@@ -32,19 +32,19 @@ dependencies:
         version: 3.2.0
 description: A flexible plugins framework.
 email:
-- robert@ribbonpayments.com
+- robert@payout.com
 executables: []
 extensions: []
 extra_rdoc_files: []
 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
-homepage: http://github.com/ribbon/plugins
+- lib/plugins.rb
+- lib/plugins/around_stack.rb
+- lib/plugins/block_stack.rb
+- lib/plugins/component_mixin.rb
+- lib/plugins/errors.rb
+- lib/plugins/plugin.rb
+- lib/plugins/version.rb
+homepage: http://github.com/payout/plugins
 licenses:
 - BSD
 metadata: {}

data/lib/ribbon/plugins.rb

@@ -1,97 +0,0 @@
-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(:ComponentMixin, 'ribbon/plugins/component_mixin')
-
-    attr_reader :component, :plugin_loader
-
-    def initialize(component=nil, &block)
-      @component = component
-      @plugin_loader = block
-    end
-
-    def add(plugin=nil, *args, &block)
-      plugin = _load(plugin, &block)
-      _add_plugin(plugin.new(self, *args))
-    end
-
-    def clear
-      @_plugins = nil
-      @_around_stack = nil
-    end
-
-    def before(subject, *args)
-      _plugins.reverse_each { |plugin| plugin.before(subject, *args) }
-    end
-
-    def after(subject, *args)
-      _plugins.reverse_each { |plugin| plugin.after(subject, *args) }
-    end
-
-    def around(subject, *args, &block)
-      _around_stack.call(subject, *args) { |subject, *args| block.call(*args) }
-    end
-
-    def perform(subject, *args, &block)
-      before(subject, *args)
-      retval = around(subject, *args, &block)
-      after(subject, *args)
-
-      retval
-    end
-
-    private
-    def _plugins
-      @_plugins ||= []
-    end
-
-    def _around_stack
-      @_around_stack ||= AroundStack.new(:block, self)
-    end
-
-    def _add_plugin(plugin)
-      _plugins.push(plugin)
-
-      _around_stack.push { |subject, *args|
-        plugin.around(subject, *args) { |*args|
-          perform_block(subject, *args)
-        }
-      }
-
-      plugin
-    end
-
-    def _load(plugin, &block)
-      if plugin
-        _load_plugin(plugin)
-      elsif block_given?
-        Plugin.create(&block)
-      else
-        raise Errors::LoadError, 'No plugin information provided'
-      end
-    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 Proc
-        Plugin.create(&plugin)
-      else
-        raise Errors::LoadError, "Invalid plugin identifier: #{plugin.inspect}"
-      end
-    end
-
-    def _call_plugin_loader(plugin)
-      plugin_loader && component.instance_exec(plugin, &plugin_loader)
-    end
-  end # Plugins
-end # Ribbon

data/lib/ribbon/plugins/component_mixin.rb

@@ -1,47 +0,0 @@
-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(*args, &block)
-        plugins.add(*args, &block)
-      end
-    end
-  end
-end

data/lib/ribbon/plugins/version.rb

@@ -1,5 +0,0 @@
-module Ribbon
-  class Plugins
-    VERSION = "0.2.4"
-  end
-end