mongoid-plugins 0.0.1

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--format documentation

data/Gemfile

@@ -0,0 +1,3 @@
+source "http://rubygems.org"
+
+gemspec

data/Gemfile.lock

@@ -0,0 +1,53 @@
+PATH
+  remote: .
+  specs:
+    mongoid-plugins (0.0.1)
+      mongoid (>= 2.0.0.beta.20)
+
+GEM
+  remote: http://rubygems.org/
+  specs:
+    activemodel (3.0.3)
+      activesupport (= 3.0.3)
+      builder (~> 2.1.2)
+      i18n (~> 0.4)
+    activesupport (3.0.3)
+    autotest (4.4.5)
+    bson (1.1.2)
+    builder (2.1.2)
+    diff-lcs (1.1.2)
+    haml (2.2.24)
+    hanna (0.1.12)
+      haml (~> 2.2.8)
+      rake (~> 0.8.2)
+      rdoc (~> 2.3.0)
+    i18n (0.4.2)
+    mongo (1.1.2)
+      bson (>= 1.1.1)
+    mongoid (2.0.0.beta.20)
+      activemodel (~> 3.0)
+      mongo (~> 1.1)
+      tzinfo (~> 0.3.22)
+      will_paginate (~> 3.0.pre)
+    rake (0.8.7)
+    rdoc (2.3.0)
+    rspec (2.1.0)
+      rspec-core (~> 2.1.0)
+      rspec-expectations (~> 2.1.0)
+      rspec-mocks (~> 2.1.0)
+    rspec-core (2.1.0)
+    rspec-expectations (2.1.0)
+      diff-lcs (~> 1.1.2)
+    rspec-mocks (2.1.0)
+    tzinfo (0.3.23)
+    will_paginate (3.0.pre2)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  autotest (>= 4.3.2)
+  hanna (>= 0.1.12)
+  mongoid (>= 2.0.0.beta.20)
+  mongoid-plugins!
+  rspec (~> 2.0)

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2010 Benedikt Deicke
+
+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,70 @@
+= mongoid-plugins
+
+Easily add and configure plugins for Mongoid
+
+== Requirements
+
+* mongoid (>= 2.0.0.beta.20)
+
+== Install
+
+To install mongoid-plugins, simply add it to your Gemfile:
+
+  gem 'mongoid-plugins', :require => 'mongoid/plugins'
+
+In order to get the latest development version of mongoid-plugins:
+
+  gem 'mongoid-plugins', :git => 'git://github.com/benedikt/mongoid-plugins', :require => 'mongoid/plugins'
+
+You might want to remove the <tt>:require => 'mongoid/plugins'</tt> option and explicitly <tt>require 'mongoid/plugins'</tt> where needed and finally run
+
+  bundle install
+
+
+== Usage
+
+  class SomeDocument
+    include Mongoid::Document
+
+    plugin SomePlugin do |c|
+      c.some_setting = false
+    end
+  end
+
+
+== Writing Plugins
+
+It's fairly easy to write plugins compatible with Mongoid::Plugins. In fact they're simply Ruby modules. It's possible to add default options by defining a <tt>default_plugin_options</tt> method on your module returning a hash:
+
+  module SomePlugin
+    def self.default_plugin_options
+      {
+        :some_default_setting => 100
+      }
+    end
+  end
+
+To access the options from within your plugin just call <tt>plugin_options_for(SomePlugin)</tt>:
+
+  module SomePlugin
+    def a_plugin_method
+      if self.plugin_options_for(SomePlugin).do_something
+        # Do something :-)
+      end
+    end
+  end
+
+
+== Known issues
+
+See http://github.com/benedikt/mongoid-plugins/issues
+
+
+== Repository
+
+See http://github.com/benedikt/mongoid-plugins and feel free to fork it!
+
+
+== Copyright
+
+Copyright (c) 2010 Benedikt Deicke. See LICENSE for details.

data/Rakefile

@@ -0,0 +1,18 @@
+require 'rspec/core/rake_task'
+require 'hanna/rdoctask'
+require 'bundler'
+Bundler::GemHelper.install_tasks
+
+spec = Gem::Specification.load('mongoid-plugins.gemspec')
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec
+
+Rake::RDocTask.new do |rdoc|
+  rdoc.rdoc_dir = 'doc'
+  rdoc.title = '#{spec.name} #{spec.version}'
+  rdoc.options += spec.rdoc_options
+  rdoc.rdoc_files.include(spec.extra_rdoc_files)
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/lib/mongoid/plugins.rb

@@ -0,0 +1,32 @@
+module Mongoid
+  module Plugins
+    extend ActiveSupport::Concern
+
+    included do
+      cattr_accessor :_plugin_options
+      self._plugin_options = {}
+    end
+
+    module ClassMethods
+      def plugin(mod, &block)
+        _plugin_options[mod] = ActiveSupport::OrderedOptions.new.tap do |options|
+          options.merge!(mod.default_plugin_options) if mod.respond_to? :default_plugin_options
+          yield(options) if block_given?
+        end
+
+        include(mod)
+      end
+
+      def plugin_options_for(mod)
+        raise "#{mod} is not loaded as a plugin" unless _plugin_options.include?(mod)
+        _plugin_options[mod]
+      end
+    end
+  end
+end
+
+module Mongoid
+  module Document
+    include Mongoid::Plugins
+  end
+end

data/spec/mongoid/plugins_spec.rb

@@ -0,0 +1,90 @@
+require 'spec_helper'
+
+describe Mongoid::Plugins do
+
+  let(:klass) { Class.new }
+  let(:plugin) { Module.new }
+
+  before(:each) do
+    klass.send(:include, Mongoid::Document)
+  end
+
+  it 'should be auto included into Mongoid::Document' do
+    klass.should include Mongoid::Plugins
+  end
+
+  it 'should add a .plugin method' do
+    klass.should respond_to :plugin
+  end
+
+  it 'should add a .plugin_options_for method' do
+    klass.should respond_to :plugin_options_for
+  end
+
+  describe '.plugin' do
+    it 'should include the given module' do
+      klass.plugin(plugin)
+      klass.should include plugin
+    end
+
+    it 'should store plugin options for the given module' do
+      klass.plugin(plugin)
+      klass.plugin_options_for(plugin).should be_kind_of ActiveSupport::OrderedOptions
+    end
+
+    it 'should call .default_plugin_options on the given module' do
+      plugin.should_receive(:respond_to?).with(:default_plugin_options).and_return(true)
+      plugin.should_receive(:default_plugin_options).and_return({})
+      klass.plugin(plugin)
+    end
+
+    it 'should not call .default_plugin_options on the given module if it is not defined' do
+      plugin.should_receive(:respond_to?).with(:default_plugin_options).and_return(false)
+      plugin.should_not_receive(:default_plugin_options).and_return({})
+      klass.plugin(plugin)
+    end
+
+    it 'should use the hash returned by default_plugin_options to populate the plugin options hash' do
+      plugin.should_receive(:respond_to?).with(:default_plugin_options).and_return(true)
+      plugin.should_receive(:default_plugin_options).and_return({ :default => true })
+      klass.plugin(plugin)
+      klass.plugin_options_for(plugin).should eql({ :default => true })
+    end
+
+    it 'should pass the options hash into the block' do
+      klass.plugin(plugin) do |c|
+        c.should be_kind_of ActiveSupport::OrderedOptions
+      end
+    end
+  end
+
+  describe '.plugin_options_for' do
+    before(:each) do
+      plugin.stub!(:default_plugin_options).and_return({
+        :active => true,
+        :other => 'Option',
+        :setting => 10
+      })
+
+      klass.plugin(plugin) do |c|
+        c.active = false
+        c.other = 'Awesome'
+      end
+    end
+
+    it 'should return the options for the given module' do
+      klass.plugin_options_for(plugin).should be_kind_of ActiveSupport::OrderedOptions
+    end
+
+    it 'should include the given options' do
+      options = klass.plugin_options_for(plugin)
+      options.active.should be_false
+      options.other.should eql('Awesome')
+      options.setting.should eql(10)
+    end
+
+    it 'should raise an exception when given plugin is not available' do
+      expect { klass.plugin_options_for(Module.new) }.to raise_error /is not loaded/
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,13 @@
+require 'rubygems'
+require 'bundler/setup'
+
+require 'mongoid'
+require 'mongoid/plugins'
+
+require 'rspec'
+
+Dir["#{File.dirname(__FILE__)}/support/**/*.rb"].each { |f| require f }
+
+RSpec.configure do |config|
+  config.mock_with :rspec
+end

metadata

@@ -0,0 +1,142 @@
+--- !ruby/object:Gem::Specification 
+name: mongoid-plugins
+version: !ruby/object:Gem::Version 
+  hash: 29
+  prerelease: false
+  segments: 
+  - 0
+  - 0
+  - 1
+  version: 0.0.1
+platform: ruby
+authors: 
+- Benedikt Deicke
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-11-20 00:00:00 +01:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: mongoid
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 62196427
+        segments: 
+        - 2
+        - 0
+        - 0
+        - beta
+        - 20
+        version: 2.0.0.beta.20
+  type: :runtime
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 2
+        - 0
+        version: "2.0"
+  type: :development
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: autotest
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 55
+        segments: 
+        - 4
+        - 3
+        - 2
+        version: 4.3.2
+  type: :development
+  version_requirements: *id003
+- !ruby/object:Gem::Dependency 
+  name: hanna
+  prerelease: false
+  requirement: &id004 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        - 1
+        - 12
+        version: 0.1.12
+  type: :development
+  version_requirements: *id004
+description: Easily add and configure plugins for Mongoid
+email: benedikt@synatic.net
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- README.rdoc
+- LICENSE
+files: 
+- lib/mongoid/plugins.rb
+- spec/mongoid/plugins_spec.rb
+- spec/spec_helper.rb
+- LICENSE
+- README.rdoc
+- Rakefile
+- Gemfile
+- Gemfile.lock
+- .rspec
+has_rdoc: true
+homepage: http://github.com/benedikt/mongoid-plugins
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --main
+- README.rdoc
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: Easily add and configure plugins for Mongoid
+test_files: []
+