ribbon-plugins 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 230fbea0e698049dd095f097a6d977eca0e17359
+  data.tar.gz: 65c29190976d2a231e41493ad9840dbf9bdf90f3
+SHA512:
+  metadata.gz: 6635638f54be4b62c15e4e988f60636d2e37d2bbb0d8686f785e2cba13a11a994d7f7a51dc664085f8cd021de9a2920a66c6a9531276b1c188cd9e7979537e8f
+  data.tar.gz: c70c4dec948b31c09c49e8bf61be462386095da0bce1ae5d3032b7951a46f77ec660932a3fd0a0bc7f6477f432f4c3b8b1bb0b446302477aa62bf5584298064b

data/lib/ribbon/plugins/around_stack.rb

@@ -0,0 +1,63 @@
+class Ribbon::Plugins
+  class AroundStack
+    attr_reader :subject
+
+    def initialize(subject)
+      @subject = subject.to_sym
+      @_stack = []
+    end
+
+    def push(&block)
+      raise Errors::Error, "Must pass block" unless block_given?
+
+      AroundWrapper.new(subject, &block).tap { |wrapper|
+        @_stack.push(wrapper)
+      }
+    end
+
+    def call(*args, &block)
+      raise Errors::Error, "Must pass block" unless block_given?
+      call_stack = @_stack.dup
+
+      inner_most = WrappedBlock.new(&block)
+      call_stack.unshift(inner_most)
+
+      outer_most = call_stack.pop
+      outer_most.call(call_stack, *args)
+    end
+
+    class AroundWrapper
+      attr_reader :subject, :block
+
+      def initialize(subject, &block)
+        @subject = subject
+        @block = block
+      end
+
+      def call(call_stack, *args)
+        wrapped = call_stack.pop
+        raise Errors::Error, 'call stack too short' unless wrapped
+
+        define_singleton_method("perform_#{subject}") { |*new_args|
+          args = new_args unless new_args.empty?
+          wrapped.call(call_stack, *args)
+        }
+
+        instance_exec(*args, &block)
+      end
+    end
+
+    class WrappedBlock
+      attr_reader :block
+
+      def initialize(&block)
+        @block = block
+      end
+
+      def call(call_stack, *args)
+        raise Errors::Error, 'receiving non-empty call stack' unless call_stack.empty?
+        block.call(*args)
+      end
+    end
+  end # AroundStack
+end # Ribbon::Plugins

data/lib/ribbon/plugins/block_stack.rb

@@ -0,0 +1,15 @@
+class Ribbon::Plugins
+  class BlockStack
+    def initialize
+      @_stack = []
+    end
+
+    def push(&block)
+      @_stack.push(block)
+    end
+
+    def call(*args)
+      @_stack.reverse_each { |block| block.call(*args) }
+    end
+  end
+end

data/lib/ribbon/plugins/errors.rb

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

data/lib/ribbon/plugins/plugin.rb

@@ -0,0 +1,53 @@
+class Ribbon::Plugins
+  class Plugin
+    class << self
+      def create(&block)
+        Class.new(Plugin).tap { |k| k.class_eval(&block) if block }
+      end
+
+      def method_missing(meth, *args, &block)
+        if /^(before|after|around)_(\w+)$/.match(meth.to_s)
+          _define_callback($1, $2, &block)
+        else
+          super
+        end
+      end
+
+      def _define_callback(type, subject, &block)
+        _callbacks(type, subject).push(&block)
+      end
+
+      def _callbacks(type, subject)
+        ((@__callbacks ||= {})[type.to_sym] ||= {})[subject.to_sym] ||= _empty_stack_for(type, subject)
+      end
+
+      def _empty_stack_for(type, subject)
+        case type.to_sym
+        when :before, :after
+          BlockStack.new
+        when :around
+          AroundStack.new(subject)
+        else
+          raise Errors::Error, "Invalid type: #{type}"
+        end
+      end
+    end
+
+    def before(subject, *args)
+      _callbacks(:before, subject).call(*args)
+    end
+
+    def after(subject, *args)
+      _callbacks(:after, subject).call(*args)
+    end
+
+    def around(subject, *args, &block)
+      _callbacks(:around, subject).call(*args, &block)
+    end
+
+    private
+    def _callbacks(type, subject)
+      self.class._callbacks(type, subject)
+    end
+  end # Plugin
+end # Ribbon::Plugins

data/lib/ribbon/plugins/version.rb

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

data/lib/ribbon/plugins.rb

@@ -0,0 +1,89 @@
+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')
+
+    def initialize(plugin_module=nil)
+      @_plugin_module = plugin_module
+    end
+
+    def add(plugin=nil, &block)
+      plugin = _load(plugin, &block)
+      _add_plugin(plugin.new)
+    end
+
+    def clear
+      @_plugins = []
+      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)
+      around(subject, *args, &block)
+      after(subject, *args)
+    end
+
+    private
+    def _plugins
+      @_plugins ||= []
+    end
+
+    def _around_stack
+      @__around_stack ||= AroundStack.new(:block)
+    end
+
+    def _add_plugin(plugin)
+      _plugins.push(plugin)
+      _around_stack.push { |subject, *args|
+        plugin.around(subject, *args) {
+          perform_block
+        }
+      }
+    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)
+      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
+        raise Errors::LoadError, "Invalid plugin identifier: #{plugin.inspect}"
+      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."
+    end
+  end # Plugins
+end # Ribbon

metadata

@@ -0,0 +1,70 @@
+--- !ruby/object:Gem::Specification
+name: ribbon-plugins
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Robert Honer
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-03-02 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.
+email:
+- robert@ribbonpayments.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/errors.rb
+- lib/ribbon/plugins/plugin.rb
+- lib/ribbon/plugins/version.rb
+homepage: http://github.com/ribbon/plugins
+licenses:
+- BSD
+metadata: {}
+post_install_message: 
+rdoc_options: []
+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
+signing_key: 
+specification_version: 4
+summary: A flexible plugins framework.
+test_files: []