wizardwerdna-pluggable 0.0.0

data/.document

@@ -0,0 +1,5 @@
+README.rdoc
+lib/**/*.rb
+bin/*
+features/**/*.feature
+LICENSE

data/.gitignore

@@ -0,0 +1,5 @@
+*.sw?
+.DS_Store
+coverage
+rdoc
+pkg

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 Andrew C. Greenberg
+
+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.rdoc

@@ -0,0 +1,63 @@
+= pluggable
+
+Pluggable is a mixin for classes requiring plugins.  A pluggable class, +Klass+, has a public function, +plugins+, returning an array-like object that holds all subclasses of <tt>Klass::Plugin</tt>.
+
+	require 'pluggable'
+	class Test
+		include Pluggable
+		def process param
+			plugins.each {|plugin| plugin.process param}
+		end
+	end
+
+	class Plugin1 < Test:Plugin
+		def process param; ...; end
+	end
+
+	class Plugin2 < Test:Plugin
+		def process param; ...; end
+	end
+
+It may be convenient to have public methods of plugins delegated to from the +plugins+ object, which may in turn be delgated to by the +Pluggable+ class in various ways.  For example:
+
+	require 'pluggable'
+	class Test
+		include Pluggable
+		def process param
+			plugins.each {|plugin| plugin.process param}
+		end
+		def missing_method symbol, *args
+			plugins.send(symbol, *args)
+		end
+	end
+
+	class Plugin1 < Test:Plugin
+		def foo; "foo"; end
+		def process param; subprocess; end
+		private
+		def subprocess; ...; end
+	end
+
+	class Plugin2 < Test:Plugin
+		def bar; "bar"; end
+		def process param; subprocess; end
+		private
+		def subprocess; ...; end
+	end
+
+	Test.new.plugins.delegate_public_methods_to_plugins_except :process
+	Test.new.foo # => "foo"
+
+== Note on Patches/Pull Requests
+ 
+* Fork the project.
+* Make your feature addition or bug fix.
+* Add tests for it. This is important so I don't break it in a
+  future version unintentionally.
+* Commit, do not mess with rakefile, version, or history.
+  (if you want to have your own version, that is fine but bump version in a commit by itself I can ignore when I pull)
+* Send me a pull request. Bonus points for topic branches.
+
+== Copyright
+
+Copyright (c) 2009 Andrew C. Greenberg. See LICENSE for details.

data/Rakefile

@@ -0,0 +1,48 @@
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "pluggable"
+    gem.summary = %Q{TODO: one-line summary of your gem}
+    gem.description = %Q{TODO: longer description of your gem}
+    gem.email = "wizardwerdna@gmail.com"
+    gem.homepage = "http://github.com/wizardwerdna/pluggable"
+    gem.authors = ["Andrew C. Greenberg"]
+    gem.add_development_dependency "rspec"
+    # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
+  end
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: sudo gem install jeweler"
+end
+
+require 'spec/rake/spectask'
+Spec::Rake::SpecTask.new(:spec) do |spec|
+  spec.libs << 'lib' << 'spec'
+  spec.spec_files = FileList['spec/**/*_spec.rb']
+end
+
+Spec::Rake::SpecTask.new(:rcov) do |spec|
+  spec.libs << 'lib' << 'spec'
+  spec.pattern = 'spec/**/*_spec.rb'
+  spec.rcov = true
+end
+
+task :spec => :check_dependencies
+
+task :default => :spec
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  if File.exist?('VERSION')
+    version = File.read('VERSION')
+  else
+    version = ""
+  end
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "pluggable #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+0.0.0

data/lib/pluggable.rb

@@ -0,0 +1,37 @@
+$:.unshift(File.dirname(__FILE__)) unless
+  $:.include?(File.dirname(__FILE__)) || $:.include?(File.expand_path(File.dirname(__FILE__)))
+
+require 'singleton'
+require 'forwardable'
+module Pluggable
+  VERSION = '0.0.1'
+  
+  def plugins
+    Plugins.instance
+  end
+  
+  class Plugins < Array
+    include Singleton
+    extend Forwardable
+
+    def delegate_public_methods_to_plugins_except *excluded_methods
+      excluded_methods = excluded_methods.map{|each| each.to_s}
+      each do |instance|
+        delegated_methods = instance.public_methods-Plugin.public_instance_methods-excluded_methods
+        variable_name = variable_name_for_plugin_instance instance
+        instance_variable_set variable_name, instance
+        self.class.def_delegators variable_name, *delegated_methods
+      end
+    end
+    private
+    def variable_name_for_plugin_instance instance
+      "@ivar_for_#{instance.class.to_s}".gsub(/::/) {'_colons_'}.to_sym
+    end
+  end
+  
+  class Plugin
+    def self.inherited(klass)
+      Plugins.instance << klass.new
+  	end
+  end
+end

data/spec/pluggable_spec.rb

@@ -0,0 +1,94 @@
+require 'forwardable'
+require File.dirname(__FILE__) + '/spec_helper.rb'
+
+class Test
+  extend Forwardable
+  include Pluggable
+  def method_missing symbol, *args
+    plugins.send(symbol, *args)
+  end
+end
+
+class Plugin1 < Test::Plugin
+  def foo
+    "foo"
+  end
+  def exception_public
+  end
+  private
+  def exception_private
+  end
+end
+
+class Plugin2 < Test::Plugin
+  def bar
+    "bar"
+  end
+  def exception_public
+  end
+  private
+  def exception_private
+  end
+end
+
+class Plugin3 < Test::Plugin
+  def baz
+    "baz"
+  end
+  def exception_public
+  end
+  private
+  def exception_private
+  end
+end
+
+Test.new.plugins.delegate_public_methods_to_plugins_except :exception_public
+
+describe Pluggable, "when included in a class" do
+  
+  before(:each) do
+    @test_instance = Test.new
+  end
+  
+  it "adds a plugins method to the class instance returning an instance of Plugins" do
+    @test_instance.should respond_to(:plugins)
+    @test_instance.plugins.should be_a_kind_of(Test::Plugins)
+  end
+  
+  it "should include instances of all the plugins" do
+    @test_instance.plugins.should have(3).items
+    @test_instance.plugins.map{|each| each.class}.should include(Plugin1, Plugin2, Plugin3)
+  end
+  
+  it "should delegate public methods of plugins" do
+    @test_instance.plugins.should respond_to(:foo)
+    @test_instance.plugins.should respond_to(:bar)
+    @test_instance.plugins.should respond_to(:baz)
+    @test_instance.plugins.foo.should == "foo"
+    @test_instance.plugins.bar.should == "bar"
+    @test_instance.plugins.baz.should == "baz"
+  end
+  
+  it "should not delegate excepted public methods of plugins" do
+    @test_instance.plugins.should_not respond_to(:exception_public)
+    @test_instance.should_not respond_to(:exception_public)
+  end
+  
+  it "should not delegate private methods of plugins" do
+    @test_instance.plugins.should_not respond_to(:exception_private)
+    @test_instance.should_not respond_to(:exception_private)
+  end
+end
+
+describe Test, "when using message_missing to simulate delegation from the parent" do
+  
+  before(:each) do
+    @test_instance = Test.new
+  end
+
+  it "should delegate public methods of plugins" do
+    @test_instance.foo.should == "foo"
+    @test_instance.bar.should == "bar"
+    @test_instance.baz.should == "baz"
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,9 @@
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+require 'pluggable'
+require 'spec'
+require 'spec/autorun'
+
+Spec::Runner.configure do |config|
+  
+end

metadata

@@ -0,0 +1,73 @@
+--- !ruby/object:Gem::Specification 
+name: wizardwerdna-pluggable
+version: !ruby/object:Gem::Version 
+  version: 0.0.0
+platform: ruby
+authors: 
+- Andrew C. Greenberg
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-08-20 00:00:00 -07:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+    version: 
+description: "TODO: longer description of your gem"
+email: wizardwerdna@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.rdoc
+files: 
+- .document
+- .gitignore
+- LICENSE
+- README.rdoc
+- Rakefile
+- VERSION
+- lib/pluggable.rb
+- spec/pluggable_spec.rb
+- spec/spec_helper.rb
+has_rdoc: false
+homepage: http://github.com/wizardwerdna/pluggable
+licenses: 
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.5
+signing_key: 
+specification_version: 3
+summary: "TODO: one-line summary of your gem"
+test_files: 
+- spec/pluggable_spec.rb
+- spec/spec_helper.rb