r3_plugin_toolbox 0.3.5

data/.document

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

data/.gitignore

@@ -0,0 +1,21 @@
+## MAC OS
+.DS_Store
+
+## TEXTMATE
+*.tmproj
+tmtags
+
+## EMACS
+*~
+\#*
+.\#*
+
+## VIM
+*.swp
+
+## PROJECT::GENERAL
+coverage
+rdoc
+pkg
+
+## PROJECT::SPECIFIC

data/.rspec

@@ -0,0 +1 @@
+--format nested --color

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 Kristian Mandrup
+
+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.markdown

@@ -0,0 +1,158 @@
+# Rails 3 Plugin Toolbox
+
+This is a small toolbox that greatly facilitates creating Plugins for Rails 3 without having to know a lot about the Rails 3 internals and Plugin architecture.
+The toolbox provides a convenient DSL that abstracts away the internal Rails 3 plugin wiring to an even greater extent, making the DSL dead simple to use!
+
+I also provide a specialized RSpec 2 matcher *be_extended_with* which makes it easy to spec your plugin extension functionality, to make sure Rails is extended with
+the functionality (modules) that you expect and desire ;)
+
+## Install
+
+<code>gem install r3_plugin_toolbox</code>
+
+## Usage
+
+<pre>
+# my_plugin/lib/my_plugin/rails/extensions.rb      
+
+require 'rails/all'
+require 'r3_plugin_toolbox'
+
+Rails3::PluginExtender.new do
+  extend_from_module Ultra::View, :stuff, :in => :view 
+  extend_with Ultra::Controller, :in => :controller
+
+  before :initialize do
+    "Rails not yet initialized!"
+  end      
+
+  extend_rails :i18n do
+    with MyAddition
+    extend_from_module Ultra::Power, :util, :logging, :monitor
+
+    before :initialize do
+      MyOtherAddition.say 'before localized!'
+    end      
+
+    before :configuration do
+      MyOtherAddition.configured = 'was configured!'      
+    end
+
+    before :eager_load do
+      puts "before eager load!"
+    end
+
+    after :initialize do
+      MyAddition.say 'localized!'
+    end      
+  end
+end
+</pre>
+
+More API examples
+
+<pre>                        
+Rails3::PluginExtender.new do  
+  extend_rails :view do # or use :action_view
+    with MyViewAddition
+  end
+
+  extend_rails :controller do # or use :action_mailer
+    with MyViewAddition
+  end
+
+  extend_rails :mailer do # or use :action_mailer
+    with MyMailAddition, 'MyOtherMailAddition'
+  end
+
+  extend_rails :AR do # active record
+    with MyActiveRecordAddition
+  end
+
+  extend_rails :active_record do
+    with MyExtraScopeHelpers
+  end
+
+  extend_rails(:controller) do
+    extend_from_module Ultra::Power, :util, :logging, :monitor
+    extend_from_module Ultra::Power::More, :extra, :stuff
+  end  
+  
+  after(:initialize) do
+    puts "Rails initialized!"
+  end    
+end
+</pre>
+
+## RSpec 2 matchers
+
+The library comes with a special Matcher to facilitate making Rails 3 extension specs
+
+* be_extended_with module_name, *submodules
+
+_Usage example:_
+
+<pre>   
+                   
+require 'rspec'
+require 'r3_plugin_toolbox'
+require 'rails/all'  
+
+describe "My Plugin rails extensions" do
+  it "should extend Action View with View Helpers" do
+    Rails3::PluginExtender.new do
+      extend_rails :view do          
+        extend_from_module Helper::View, :panel, :window
+        extend_with Helper::View::Button, Helper::View::Form
+      end
+    end
+
+    after_init :view do
+      :view.should be_extended_with Helper::View, :panel, :window, :button, :form
+      :view.should_not be_extended_with Helper::View, :unknown
+    end
+
+    after_init :controller do
+      :controller.should be_extended_with Helper::Controller, :stuff
+      :controller.should_not be_extended_with My::Paginator
+    end
+
+    # first arg is the App name, the remaining symbols are 
+    # the identifiers for which railties to initialize
+    init_app_railties :minimal, :view, :controller
+  end  
+end
+
+# alternative RSpec configuration using macros
+
+describe "My other Plugin rails extensions" do
+  before :each do
+    Rails3::PluginExtender.new do
+      extend_rails :view do          
+        extend_from_module Helper::View, :grid, :tree      
+      end        
+    end
+  end
+
+  after_init :view do
+    :view.should be_extended_with Helper::View, :panel, :window, :button, :form
+  end
+
+  it "should extend Action View" do      
+    init_app_railties :minimal, :view
+  end
+</pre>
+
+## 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) 2010 Kristian Mandrup. See LICENSE for details.

data/Rakefile

@@ -0,0 +1,20 @@
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "r3_plugin_toolbox"
+    gem.summary = %Q{Toolbox to facilitate Rails 3 plugin development}
+    gem.description = %Q{Provides a more intuitive DSL for Rails 3 plugin configuration and a specialized RSpec 2 matcher. Makes it much easier to develop Rails 3 plugins!}
+    gem.email = "kmandrup@gmail.com"
+    gem.homepage = "http://github.com/kristianmandrup/rails3_plugin_toolbox"
+    gem.authors = ["Kristian Mandrup"]
+    gem.add_development_dependency "rspec", "~> 2.0.0"
+
+    gem.add_dependency "rails",       "~> 3.0.0"
+    gem.add_dependency "require_all", "~> 1.1.0"  
+
+    # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
+  end
+  Jeweler::GemcutterTasks.new
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: gem install jeweler"
+end

data/VERSION

@@ -0,0 +1 @@
+0.3.5

data/config/database.yml

@@ -0,0 +1,22 @@
+# SQLite version 3.x
+#   gem install sqlite3-ruby (not necessary on OS X Leopard)
+development:
+  adapter: sqlite3
+  database: db/development.sqlite3
+  pool: 5
+  timeout: 5000
+
+# Warning: The database defined as "test" will be erased and
+# re-generated from your development database when you run "rake".
+# Do not set this db to the same as development or production.
+test:
+  adapter: sqlite3
+  database: db/test.sqlite3
+  pool: 5
+  timeout: 5000
+
+production:
+  adapter: sqlite3
+  database: db/production.sqlite3
+  pool: 5
+  timeout: 5000

data/lib/plugin_toolbox/extender.rb

@@ -0,0 +1,65 @@
+require 'plugin_toolbox/util'
+
+module Rails3
+  class PluginExtender
+    include LoadHandler
+     
+    def initialize &block
+      if block
+        block.arity < 1 ? self.instance_eval(&block) : block.call(self)  
+      end      
+    end
+
+    # load after: [:initialize, :configuration, :eager_load]
+    def extend_rails(type, &block)
+      on_load(type, &block)
+    end
+
+    
+    # convenience method to extend with multiple modules all within the same base module
+    def extend_from_module base_name, *module_names, options
+      raise ArgumentError, "You must specify an options Hash as the last argument for #extend_from_module" if !options.kind_of? Hash      
+      module_names.each do |name|
+        extend_with get_constant(base_name, name), options
+      end
+    end
+
+    def extend_with *module_names, options
+      raise ArgumentError, "You must specify an options Hash as the last argument for #extend_with" if !options.kind_of? Hash      
+      type = options[:in]
+      raise ArgumentError, "You must specify an :in option to indicate which Rails 3 component base class to extend with #{module_names}" if !type
+      module_names.each do |name|      
+        extend! name, type
+      end
+    end
+    
+    module DSL         
+      include Rails3::PluginExtender::LoadHandler      
+      
+      def extend_from_module base_name, *module_names
+        module_names.each do |name|
+          include get_constant(base_name, name)
+        end
+      end
+
+      def extend_with *module_names
+        module_names.each do |name|         
+          include name
+        end
+      end
+      alias_method :with, :extend_with
+    end
+
+    protected
+
+    def extend! module_name, type
+      do_extend! get_module(module_name), get_load_type(type.to_sym)
+    end
+
+    def do_extend! module_name, type
+      ActiveSupport.on_load(type) do
+        include module_name
+      end        
+    end
+  end
+end

data/lib/plugin_toolbox/loader.rb

@@ -0,0 +1,32 @@
+module Rails3
+  class PluginExtender
+    module LoadHandler
+      include Rails3::PluginExtender::Util
+
+      def before type, &block
+        type = type.to_sym
+        raise ArgumentError, "#{type} is not a valid before hook" if !valid_before_hook? type
+        load_handling :"before_#{type}", &block
+      end
+
+      def after type, &block
+        type = type.to_sym
+        raise ArgumentError, "#{type} is not a valid after hook" if !valid_after_hook? type
+        load_handling :"after_#{type}", &block
+      end
+
+      def on_load type, &block    
+        type = get_load_type type
+        raise ArgumentError, "#{type} is not a valid load hook" if !valid_load_hook? type
+        load_handling type, &block
+      end
+      
+      def load_handling type, &block
+        ActiveSupport.on_load type do
+          extend Rails3::PluginExtender::DSL
+          instance_eval(&block)        
+        end
+      end
+    end
+  end
+end

data/lib/plugin_toolbox/rspec/config.rb

@@ -0,0 +1,12 @@
+require 'rspec'
+
+RSpec.configure do |config|
+  config.include Rails3::PluginExtender::Matchers
+  config.extend Rails3::PluginExtender::Macro
+end
+
+module RSpec::Core
+  class ExampleGroup
+    include Rails3::PluginExtender::Macro
+  end
+end

data/lib/plugin_toolbox/rspec/macro.rb

@@ -0,0 +1,32 @@
+module Rails3
+  class PluginExtender
+    module Macro
+      class << self
+        include Rails3::PluginExtender::Util
+      end
+
+      MACRO = Rails3::PluginExtender::Macro
+            
+      def after_init component, &block
+        type = MACRO.get_load_type component
+        Rails3::PluginExtender.new do
+          extend_rails type do          
+            after :initialize do
+              yield self
+            end
+          end
+        end        
+      end # def
+
+      def init_app_railties app_name, *railties
+        app = "#{app_name.to_s.camelize}::Application".constantize 
+        app.initialize!                        
+        railties.each do |railtie|
+          MACRO.get_base_class(railtie).constantize
+        end
+      end
+               
+    end
+  end
+end
+

data/lib/plugin_toolbox/rspec/matchers/be_extended_with.rb

@@ -0,0 +1,64 @@
+module Rails3
+  class PluginExtender
+    module Matchers
+      class BeExtendedWith
+        include Rails3::PluginExtender::Util
+      
+        attr_reader :methods, :module_const, :rails_const, :submodules, :cause, :rails_const_name, :bad_const
+      
+        def initialize(module_const, submodules=nil)
+          @module_const = module_const     
+          raise ArgumentError, "List of submodules must be given as a collection of Symbols or Strings" if submodules && !submodules.respond_to?(:flatten)
+          @submodules = submodules.flatten if submodules
+        end
+
+        def matches? type
+          begin  
+            @rails_const_name = get_base_class(type)
+            @bad_const = module_const
+            @rails_const = rails_const_name.constantize            
+            
+            return match_submodules? if submodules            
+
+            methods_included? module_const.instance_methods 
+          rescue
+            @cause = ", but the extension module wasn't found"
+            false
+          end
+        end
+
+        def base_class_methods 
+          (rails_const == I18n) ? rails_const.methods : rails_const.instance_methods
+        end
+
+        def match_submodules? 
+          submodules.each do |name|
+            @bad_const = make_constant(module_const, name)
+            return false if !methods_included? get_methods(name)                          
+          end
+          true
+        end
+
+        def methods_included? methods
+          (base_class_methods & methods) == methods
+        end
+
+        def get_methods name
+          get_constant(module_const, name).instance_methods
+        end
+  
+        def failure_message   
+          "Expected the rails class #{rails_const_name} to be extended with the methods in #{bad_const}#{cause}"
+        end 
+  
+        def negative_failure_message  
+          "Did not expect the rails class #{rails_const_name} to be extended with the methods in #{bad_const}"
+        end                   
+      end
+    
+      def be_extended_with(module_const, *submodules)
+        BeExtendedWith.new module_const, submodules
+      end
+    end
+  end
+end

data/lib/plugin_toolbox/util.rb

@@ -0,0 +1,62 @@
+module Rails3
+  class PluginExtender
+    module Util    
+      INIT = :initialize    
+      ACTIVE_MODULES = {:AR => :active_record, :view => :action_view, :controller => :action_controller, :mailer => :action_mailer}    
+
+      def get_base_class type
+        type = get_load_type(type).to_s
+        const = act_type?(type) ? rails_const_base(type) : "#{type.to_s.camelize}"                            
+      end
+
+      def act_type? type
+        type =~/action/ || type =~/active/        
+      end
+
+      def get_constant base_name, name   
+        make_constant(base_name, name).constantize
+      end
+
+      def rails_const_base type
+        "#{type.to_s.camelize}::Base"
+      end
+
+      def make_constant base_name, name
+        "#{base_name.to_s.camelize}::#{name.to_s.camelize}"
+      end
+
+      def get_load_type type
+         return ACTIVE_MODULES[type] if ACTIVE_MODULES[type]
+         return type if ACTIVE_MODULES.values.include? type                
+         return type if type == :i18n
+         logger.warn "WARNING: The Rails 3 load handler for the component #{type} is not part of the default load process."
+      end
+
+      def get_module module_name
+        case module_name
+        when Constant        
+          module_name
+        when String
+          module_name.to_s.constantize
+        else          
+          raise ArgumentError, "#{module_name} could not be converted into a module constant"        
+        end
+      end
+
+      protected
+    
+      def valid_before_hook? type
+        [INIT, :configuration, :eager_load].include?(type)          
+      end
+
+      def valid_after_hook? type
+        INIT == type
+      end
+
+      def valid_load_hook? type
+        @valid_load_hooks ||= [ACTIVE_MODULES.keys, ACTIVE_MODULES.values, :i18n].flatten
+        @valid_load_hooks.include?(type)          
+      end    
+    end
+  end
+end

data/lib/r3_plugin_toolbox.rb

@@ -0,0 +1,7 @@
+module Rails3
+end
+
+require 'active_support/inflector'
+require 'require_all'             
+
+require_all File.dirname(__FILE__) + '/plugin_toolbox'

data/r3_plugin_toolbox.gemspec

@@ -0,0 +1,79 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run the gemspec command
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{r3_plugin_toolbox}
+  s.version = "0.3.5"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Kristian Mandrup"]
+  s.date = %q{2010-09-13}
+  s.description = %q{Provides a more intuitive DSL for Rails 3 plugin configuration and a specialized RSpec 2 matcher. Makes it much easier to develop Rails 3 plugins!}
+  s.email = %q{kmandrup@gmail.com}
+  s.extra_rdoc_files = [
+    "LICENSE",
+     "README.markdown"
+  ]
+  s.files = [
+    ".document",
+     ".gitignore",
+     ".rspec",
+     "LICENSE",
+     "README.markdown",
+     "Rakefile",
+     "VERSION",
+     "config/database.yml",
+     "lib/plugin_toolbox/extender.rb",
+     "lib/plugin_toolbox/loader.rb",
+     "lib/plugin_toolbox/rspec/config.rb",
+     "lib/plugin_toolbox/rspec/macro.rb",
+     "lib/plugin_toolbox/rspec/matchers/be_extended_with.rb",
+     "lib/plugin_toolbox/util.rb",
+     "lib/r3_plugin_toolbox.rb",
+     "log/development.log",
+     "r3_plugin_toolbox.gemspec",
+     "rails3_plugin_toolbox.gemspec",
+     "spec/plugin_toolbox/extend_view_content_spec.rb",
+     "spec/plugin_toolbox/extender_action_spec.rb",
+     "spec/plugin_toolbox/extender_i18n_spec.rb",
+     "spec/plugin_toolbox/extender_spec.rb",
+     "spec/spec_helper.rb",
+     "wiki/add_rake_tasks.markdown",
+     "wiki/engine.markdown",
+     "wiki/how_to_guide.markdown"
+  ]
+  s.homepage = %q{http://github.com/kristianmandrup/rails3_plugin_toolbox}
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.7}
+  s.summary = %q{Toolbox to facilitate Rails 3 plugin development}
+  s.test_files = [
+    "spec/plugin_toolbox/extend_view_content_spec.rb",
+     "spec/plugin_toolbox/extender_action_spec.rb",
+     "spec/plugin_toolbox/extender_i18n_spec.rb",
+     "spec/plugin_toolbox/extender_spec.rb",
+     "spec/spec_helper.rb"
+  ]
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+      s.add_development_dependency(%q<rspec>, ["~> 2.0.0"])
+      s.add_runtime_dependency(%q<rails>, ["~> 3.0.0"])
+      s.add_runtime_dependency(%q<require_all>, ["~> 1.1.0"])
+    else
+      s.add_dependency(%q<rspec>, ["~> 2.0.0"])
+      s.add_dependency(%q<rails>, ["~> 3.0.0"])
+      s.add_dependency(%q<require_all>, ["~> 1.1.0"])
+    end
+  else
+    s.add_dependency(%q<rspec>, ["~> 2.0.0"])
+    s.add_dependency(%q<rails>, ["~> 3.0.0"])
+    s.add_dependency(%q<require_all>, ["~> 1.1.0"])
+  end
+end
+

data/rails3_plugin_toolbox.gemspec

@@ -0,0 +1,78 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run the gemspec command
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{rails3_plugin_toolbox}
+  s.version = "0.3.4"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Kristian Mandrup"]
+  s.date = %q{2010-09-13}
+  s.description = %q{Provides a more intuitive DSL for Rails 3 plugin configuration and a specialized RSpec 2 matcher. Makes it much easier to develop Rails 3 plugins!}
+  s.email = %q{kmandrup@gmail.com}
+  s.extra_rdoc_files = [
+    "LICENSE",
+     "README.markdown"
+  ]
+  s.files = [
+    ".document",
+     ".gitignore",
+     ".rspec",
+     "LICENSE",
+     "README.markdown",
+     "Rakefile",
+     "VERSION",
+     "config/database.yml",
+     "lib/plugin_toolbox/extender.rb",
+     "lib/plugin_toolbox/loader.rb",
+     "lib/plugin_toolbox/rspec/config.rb",
+     "lib/plugin_toolbox/rspec/macro.rb",
+     "lib/plugin_toolbox/rspec/matchers/be_extended_with.rb",
+     "lib/plugin_toolbox/util.rb",
+     "lib/rails3_plugin_toolbox.rb",
+     "log/development.log",
+     "rails3_plugin_toolbox.gemspec",
+     "spec/plugin_toolbox/extend_view_content_spec.rb",
+     "spec/plugin_toolbox/extender_action_spec.rb",
+     "spec/plugin_toolbox/extender_i18n_spec.rb",
+     "spec/plugin_toolbox/extender_spec.rb",
+     "spec/spec_helper.rb",
+     "wiki/add_rake_tasks.markdown",
+     "wiki/engine.markdown",
+     "wiki/how_to_guide.markdown"
+  ]
+  s.homepage = %q{http://github.com/kristianmandrup/rails3_plugin_toolbox}
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.7}
+  s.summary = %q{Toolbox to facilitate Rails 3 plugin development}
+  s.test_files = [
+    "spec/plugin_toolbox/extend_view_content_spec.rb",
+     "spec/plugin_toolbox/extender_action_spec.rb",
+     "spec/plugin_toolbox/extender_i18n_spec.rb",
+     "spec/plugin_toolbox/extender_spec.rb",
+     "spec/spec_helper.rb"
+  ]
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+      s.add_development_dependency(%q<rspec>, [">= 2.0.0.beta.19"])
+      s.add_runtime_dependency(%q<rails>, [">= 3.0.0.rc"])
+      s.add_runtime_dependency(%q<require_all>, [">= 1.1.0"])
+    else
+      s.add_dependency(%q<rspec>, [">= 2.0.0.beta.19"])
+      s.add_dependency(%q<rails>, [">= 3.0.0.rc"])
+      s.add_dependency(%q<require_all>, [">= 1.1.0"])
+    end
+  else
+    s.add_dependency(%q<rspec>, [">= 2.0.0.beta.19"])
+    s.add_dependency(%q<rails>, [">= 3.0.0.rc"])
+    s.add_dependency(%q<require_all>, [">= 1.1.0"])
+  end
+end
+

data/spec/plugin_toolbox/extend_view_content_spec.rb

@@ -0,0 +1,62 @@
+require 'spec_helper'
+
+module Helper
+  module View
+    module Panel
+      def draw_panel
+        'panel'
+      end
+    end
+    
+    module Window
+      def draw_window
+        'panel'
+      end
+    end
+
+    module Button
+      def draw_button
+        'button'
+      end
+    end    
+
+    module Form
+      def draw_form
+        'form'
+      end
+    end        
+  end
+end
+
+describe Rails3::PluginExtender do
+  describe '#extend_rails' do        
+
+    before :each do 
+      Rails3::PluginExtender.new do
+        extend_rails :view do
+          extend_from_module Helper::View, :panel, :window
+          extend_with Helper::View::Button, Helper::View::Form          
+        end        
+      end
+    end
+
+    # after_init :view do |view|
+    #   view.should be_extended_with Helper::View, :panel, :window, :button, :form
+    # end
+
+    
+    it "should extend Action View" do
+      after_init :view do
+        puts "View initialized!"
+        
+        :view.should be_extended_with Helper::View, :panel, :window, :button, :form
+        :view.should_not be_extended_with Helper::View, :unknown
+        lambda { :view.should be_extended_with Helper::View, :unknown }.should raise_error
+        
+        # :view.should be_extended_with Helper::View, :unknown
+      end
+
+      init_app_railties :minimal, :view
+    end
+  end
+end

data/spec/plugin_toolbox/extender_action_spec.rb

@@ -0,0 +1,62 @@
+require 'spec_helper'
+
+describe Rails3::PluginExtender do
+  describe '#extend_rails' do
+    it "should extend Action View" do
+      extender = Rails3::PluginExtender.new
+      
+      extender.extend_rails :view do
+        with MyAddition
+      
+        after :initialize do
+          MyAddition.say 'view it!'
+        end      
+      end
+    
+      # Initialize the rails application
+      Minimal::Application.initialize!    
+    
+      ActionView::Base.instance_methods.grep(/zzz/).should_not be_empty
+    
+      MyAddition.heard.should == 'view it!'
+    end    
+    
+    it "should extend Action Controller" do
+      Rails3::PluginExtender.new do
+        extend_rails :controller do
+          with MyAddition
+      
+          after :initialize do
+            MyAddition.say 'control it!'
+          end      
+        end
+      end
+    
+      # Initialize the rails application
+      Minimal::Application.initialize!    
+    
+      ActionController::Base.instance_methods.grep(/zzz/).should_not be_empty
+    
+      MyAddition.heard.should == 'control it!'
+    end    
+    
+    it "should extend Action Mailer" do
+      Rails3::PluginExtender.new do
+        extend_rails :mailer do
+          with MyAddition
+      
+          after :initialize do
+            MyAddition.say 'mail me!'
+          end      
+        end
+      end
+    
+      # Initialize the rails application
+      Minimal::Application.initialize!    
+    
+      ActionMailer::Base.instance_methods.grep(/zzz/).should_not be_empty
+    
+      MyAddition.heard.should == 'mail me!'
+    end  
+  end
+end

data/spec/plugin_toolbox/extender_i18n_spec.rb

@@ -0,0 +1,37 @@
+require 'spec_helper'
+
+describe Rails3::PluginExtender do
+  describe '#extend_rails' do
+    it "should extend i18n" do
+      Rails3::PluginExtender.new do
+        extend_rails :i18n do
+          with MyAddition
+
+          before :initialize do
+            MyOtherAddition.say 'before localized!'
+          end      
+
+          before :configuration do
+            MyOtherAddition.configured = 'was configured!'      
+          end
+
+          before :eager_load do
+            puts "before eager load!"
+          end
+      
+          after :initialize do
+            MyAddition.say 'localized!'
+          end      
+        end
+      end
+    
+      # Initialize the rails application
+      Minimal::Application.initialize!        
+      I18n.methods.grep(/zzz/).should_not be_empty
+
+      MyAddition.heard.should == 'localized!'
+      MyOtherAddition.heard.should == 'before localized!'
+      MyOtherAddition.configured.should == 'was configured!'      
+    end    
+  end
+end

data/spec/plugin_toolbox/extender_spec.rb

@@ -0,0 +1,37 @@
+require 'spec_helper'
+require 'active_record'
+
+def extend_unknown
+  Rails3::PluginExtender.new do
+    extend_rails :unknown do
+      with MyAddition
+    end
+  end     
+end  
+
+describe Rails3::PluginExtender do
+  describe '#extend_rails' do
+    it "should NOT extend Unknown" do
+      lambda { extend_unknown }.should raise_error    
+    end
+    
+    it "should extend Active Record" do
+      Rails3::PluginExtender.new do
+        extend_rails :AR do
+          with MyAddition
+      
+          after :initialize do
+            MyAddition.say 'record me!'
+          end      
+        end
+      end
+    
+      # Initialize the rails application
+      Minimal::Application.initialize!    
+    
+      ActiveRecord::Base.instance_methods.grep(/zzz/).should_not be_empty
+    
+      MyAddition.heard.should == 'record me!'
+    end     
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,53 @@
+require 'rspec'
+require 'rspec/autorun'
+require 'r3_plugin_toolbox'
+
+# See http://www.igvita.com/2010/08/04/rails-3-internals-railtie-creating-plugins/
+
+
+# require 'active_record'
+# require 'action_mailer'
+# require 'active_support'
+require 'action_controller'
+require 'action_view'
+require 'active_support/railtie'
+# require 'rails/all'
+
+module Minimal
+  class Application < Rails::Application
+    config.active_support.deprecation = :log
+  end
+end
+
+module MyAddition
+  def zzz
+    'zzz'
+  end
+
+  class << self
+    attr_accessor :heard
+    
+    def say message
+      @heard = message
+    end
+  end
+end
+
+module MyOtherAddition
+  def yyy
+    'yyy'
+  end
+
+  class << self
+    attr_accessor :heard
+    attr_accessor :configured
+    
+    def say message
+      @heard = message
+    end
+  end
+end
+
+
+RSpec.configure do |config|
+end

data/wiki/add_rake_tasks.markdown

@@ -0,0 +1,22 @@
+The following are some general tips for adding custom rake tasks and generators to your Rails 3 plugin.
+
+## Custom rake tasks
+
+<pre>
+# my_plugin/lib/railtie.rb
+module MyPlugin
+  class Railtie < ::Rails::Railtie
+    rake_tasks do
+      load "my_plugin/railties/tasks.rake"    
+    end
+  end    
+end
+</pre>
+
+<pre>
+# my_plugin/lib/railties/tasks.rake
+desc "Talk about being in my_gem"
+task :my_gem do
+  puts "You're in my_gem"
+end     
+</pre>

data/wiki/engine.markdown

@@ -0,0 +1,52 @@
+Any Rails::Engine is also a Rails::Railtie, so the same methods (like rake_tasks and generators) and configuration available in the latter can also be used in the former. 
+
+<pre>
+  class MyEngine < Rails::Engine
+    # Add a load path for this specific Engine
+    config.autoload_paths << File.expand_path("../lib/some/path", __FILE__)
+
+    initializer "my_engine.add_middleware" do |app|
+      app.middleware.use MyEngine::Middleware
+    end
+  end  
+</pre>
+            
+h2.Paths
+
+Since Rails 3.0, both your Application and Engines do not have hardcoded paths. This means that you are not required to place your controllers at “app/controllers“, but in any place which you find convenient.
+
+For example, let’s suppose you want to lay your controllers at lib/controllers, all you need to do is:
+
+<pre>
+  class MyEngine < Rails::Engine
+    paths.app.controllers = "lib/controllers"
+  end
+  
+</pre>
+
+You can also have your controllers being loaded from both “app/controllers“ and “lib/controllers“:
+
+<pre>
+  class MyEngine < Rails::Engine
+    paths.app.controllers << "lib/controllers"
+  end  
+</pre>  
+
+The available paths in an Engine are:
+
+<pre>
+  class MyEngine < Rails::Engine
+    paths.app                 = "app"
+    paths.app.controllers     = "app/controllers"
+    paths.app.helpers         = "app/helpers"
+    paths.app.models          = "app/models"
+    paths.app.views           = "app/views"
+    paths.lib                 = "lib"
+    paths.lib.tasks           = "lib/tasks"
+    paths.config              = "config"
+    paths.config.initializers = "config/initializers"
+    paths.config.locales      = "config/locales"
+    paths.config.routes       = "config/routes.rb"
+  end
+  
+</pre>

data/wiki/how_to_guide.markdown

@@ -0,0 +1,153 @@
+http://www.igvita.com/2010/08/04/rails-3-internals-railtie-creating-plugins/
+
+The documentation for Railtie  is a great place to get started, but the interesting observation is that each of the major Rails components (Action Mailer/Controller/View/Record) is itself a Railtie, and Rails as you know it is simply pieced together  by requiring all of the independent components. Even better, if your plugin or gem needs to hook into the Rails initialization process, all you need to do is inherit from Railtie and you are ready to go!
+
+So how does Railtie know to call your classes and initializers? Railtie defines a self.inherited method, which is called anytime a subclass of Railtie is created, and stashes a reference to this class in a @subclasses variable. From there, the framework can simply call Railtie.subclasses and perform all the initialization as usual - a clever use of the Ruby object model.
+
+module NewPlugin
+  # namespace our plugin and inherit from Rails::Railtie
+  # to get our plugin into the initialization process
+  class Railtie < Rails::Railtie
+ 
+    # configure our plugin on boot. other extension points such
+    # as configuration, rake tasks, etc, are also available
+    initializer "newplugin.initialize" do |app|
+ 
+      # subscribe to all rails notifications: controllers, AR, etc.
+      ActiveSupport::Notifications.subscribe do |*args|
+        event = ActiveSupport::Notifications::Event.new(*args)
+        puts "Got notification: #{event.inspect}"
+      end
+ 
+    end
+  end
+end
+                             
+---
+
+Railtie is the core of the Rails Framework and provides several hooks to extend Rails and/or modify the initialization process.
+
+Every major component of Rails (Action Mailer, Action Controller, Action View, Active Record and Active Resource) are all Railties, so each of them is responsible to set their own initialization. This makes, for example, Rails absent of any Active Record hook, allowing any other ORM framework to hook in.
+
+Developing a Rails extension does not require any implementation of Railtie, but if you need to interact with the Rails framework during or after boot, then Railtie is what you need to do that interaction.
+
+For example, the following would need you to implement Railtie in your plugin:
+
+* creating initializers
+* configuring a Rails framework or the Application, like setting a generator
+* adding Rails config.* keys to the environment
+* setting up a subscriber to the Rails +ActiveSupport::Notifications+
+* adding rake tasks into rails
+
+h2. Creating your Railtie
+
+Implementing Railtie in your Rails extension is done by creating a class Railtie that has your extension name and making sure that this gets loaded during boot time of the Rails stack.
+
+You can do this however you wish, but here is an example if you want to provide it for a gem that can be used with or without Rails:
+
+* Create a file (say, lib/my_gem/railtie.rb) which contains class Railtie inheriting from Rails::Railtie and is namespaced to your gem:
+                                                                                                                                       
+<pre>
+  # lib/my_gem/railtie.rb
+  module MyGem
+    class Railtie < Rails::Railtie
+    end
+  end  
+</pre>
+
+* Require your own gem as well as rails in this file:
+
+<pre>
+  # lib/my_gem/railtie.rb
+  require 'my_gem'
+  require 'rails'
+
+  module MyGem
+    class Railtie < Rails::Railtie
+    end
+  end  
+</pre>
+
+h2. Initializers
+
+To add an initialization step from your Railtie to Rails boot process, you just need to create an initializer block:
+
+<pre>
+  class MyRailtie < Rails::Railtie
+    initializer "my_railtie.configure_rails_initialization" do
+      # some initialization behavior
+    end
+  end  
+</pre>
+
+If specified, the block can also receive the application object, in case you need to access some application specific configuration, like middleware:
+
+<pre>
+  class MyRailtie < Rails::Railtie
+    initializer "my_railtie.configure_rails_initialization" do |app|
+      app.middleware.use MyRailtie::Middleware
+    end
+  end  
+</pre>
+
+Finally, you can also pass :before and :after as option to initializer, in case you want to couple it with a specific step in the initialization process.
+Configuration
+
+Inside the Railtie class, you can access a config object which contains configuration shared by all railties and the application:
+
+<pre>
+  class MyRailtie < Rails::Railtie
+    # Customize the ORM
+    config.generators.orm :my_railtie_orm
+
+    # Add a to_prepare block which is executed once in production
+    # and before each request in development
+    config.to_prepare do
+      MyRailtie.setup!
+    end
+  end  
+</pre>
+
+Loading rake tasks and generators
+
+If your railtie has rake tasks, you can tell Rails to load them through the method rake tasks:
+
+<pre>
+  class MyRailtie < Railtie
+    rake_tasks do
+      load "path/to/my_railtie.tasks"
+    end
+  end  
+</pre>
+
+By default, Rails load generators from your load path. However, if you want to place your generators at a different location, you can specify in your Railtie a block which will load them during normal generators lookup:
+
+<pre>
+  class MyRailtie < Railtie
+    generators do
+      require "path/to/my_railtie_generator"
+    end
+  end  
+</pre>
+
+Application, Plugin and Engine
+
+A Rails::Engine is nothing more than a Railtie with some initializers already set. And since Rails::Application and Rails::Plugin are engines, the same configuration described here can be used in all three.
+
+Be sure to look at the documentation of those specific classes for more information.
+
+Methods:
+
+    * abstract_railtie?
+    * console
+    * eager_load!
+    * generators
+    * inherited
+    * load_console
+    * load_generators
+    * load_tasks
+    * log_subscriber
+    * railtie_name
+    * rake_tasks
+    * subclasses
+

metadata

@@ -0,0 +1,138 @@
+--- !ruby/object:Gem::Specification 
+name: r3_plugin_toolbox
+version: !ruby/object:Gem::Version 
+  prerelease: false
+  segments: 
+  - 0
+  - 3
+  - 5
+  version: 0.3.5
+platform: ruby
+authors: 
+- Kristian Mandrup
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-09-13 00:00:00 +02:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 2
+        - 0
+        - 0
+        version: 2.0.0
+  type: :development
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: rails
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 3
+        - 0
+        - 0
+        version: 3.0.0
+  type: :runtime
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: require_all
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 1
+        - 1
+        - 0
+        version: 1.1.0
+  type: :runtime
+  version_requirements: *id003
+description: Provides a more intuitive DSL for Rails 3 plugin configuration and a specialized RSpec 2 matcher. Makes it much easier to develop Rails 3 plugins!
+email: kmandrup@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.markdown
+files: 
+- .document
+- .gitignore
+- .rspec
+- LICENSE
+- README.markdown
+- Rakefile
+- VERSION
+- config/database.yml
+- lib/plugin_toolbox/extender.rb
+- lib/plugin_toolbox/loader.rb
+- lib/plugin_toolbox/rspec/config.rb
+- lib/plugin_toolbox/rspec/macro.rb
+- lib/plugin_toolbox/rspec/matchers/be_extended_with.rb
+- lib/plugin_toolbox/util.rb
+- lib/r3_plugin_toolbox.rb
+- log/development.log
+- r3_plugin_toolbox.gemspec
+- rails3_plugin_toolbox.gemspec
+- spec/plugin_toolbox/extend_view_content_spec.rb
+- spec/plugin_toolbox/extender_action_spec.rb
+- spec/plugin_toolbox/extender_i18n_spec.rb
+- spec/plugin_toolbox/extender_spec.rb
+- spec/spec_helper.rb
+- wiki/add_rake_tasks.markdown
+- wiki/engine.markdown
+- wiki/how_to_guide.markdown
+has_rdoc: true
+homepage: http://github.com/kristianmandrup/rails3_plugin_toolbox
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: Toolbox to facilitate Rails 3 plugin development
+test_files: 
+- spec/plugin_toolbox/extend_view_content_spec.rb
+- spec/plugin_toolbox/extender_action_spec.rb
+- spec/plugin_toolbox/extender_i18n_spec.rb
+- spec/plugin_toolbox/extender_spec.rb
+- spec/spec_helper.rb