rails3_plugin_toolbox 0.2.0 → 0.3.0

data/README.markdown

@@ -1,17 +1,10 @@
 # Rails3 plugin toolbox
 
-A toolbox to facilitate creating Plugins for Rails 3 without having to necessarily know a lot about the Rails 3 internals and Plugin architecture.   
+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!
 
-## RSpec test suite
-
-I have now discovered how to test he validity of Rails extensions in RSpec without having to have a full Rails 3 host app.
-RSpec 2 test suite will soon be added :)
-
-http://gist.github.com/542441
-
-## Inspiration
-
-This project was inspired by the Yehuda Katz article at http://www.railsdispatch.com/, titled "How Rails enables more choices".
+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
 
@@ -20,62 +13,106 @@ This project was inspired by the Yehuda Katz article at http://www.railsdispatch
 ## Usage
 
 <pre>
-# my_plugin/lib/load.rb
-module MyPlugin
-  Rails3::PluginExtender.new do
-  
-    extend_from_module Ultra::View, :stuff, :in => :view 
-    extend_with Ultra::Controller, :in => :controller
-  
-    extend_rails :i18n do
-      with MyAddition
-      extend_from_module Ultra::Power, :util, :logging, :monitor
+# my_plugin/lib/my_plugin/rails/extensions.rb      
 
-      before :initialize do
-        MyOtherAddition.say 'before localized!'
-      end      
+require 'rails/all'
+require 'rails3_plugin_toolbox'
 
-      before :configuration do
-        MyOtherAddition.configured = 'was configured!'      
-      end
+Rails3::PluginExtender.new do
+  extend_from_module Ultra::View, :stuff, :in => :view 
+  extend_with Ultra::Controller, :in => :controller
 
-      before :eager_load do
-        puts "before eager load!"
-      end
+  before :initialize do
+    "Rails not yet initialized!"
+  end      
 
-      after :initialize do
-        MyAddition.say 'localized!'
-      end      
-    end
+  extend_rails :i18n do
+    with MyAddition
+    extend_from_module Ultra::Power, :util, :logging, :monitor
 
-    extend_rails :view do
-      with MyViewAddition
-    end
+    before :initialize do
+      MyOtherAddition.say 'before localized!'
+    end      
 
-    extend_rails :controller do
-      with MyViewAddition
+    before :configuration do
+      MyOtherAddition.configured = 'was configured!'      
     end
 
-    extend_rails :mailer do
-      with MyMailAddition, 'MyOtherMailAddition'
+    before :eager_load do
+      puts "before eager load!"
     end
 
-    extend_rails :AR do
-      with MyActiveRecordAddition
-    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(:controller) do
-      extend_from_module Ultra::Power, :util, :logging, :monitor
-      extend_from_module Ultra::Power::More, :extra, :stuff
-    end  
-    
-    after(:initialize) do
-      include MyCoreModule
-    end    
+  extend_rails :active_record do
+    with MyExtraScopeHelpers
   end
-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 'rails3_plugin_toolbox'
+require 'rails/all'  
+  
+  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
+  
+    # Initialize the rails application
+    Minimal::Application.initialize!    
+  
+    :view.should be_extended_with Helper::View, :panel, :window, :button, :form
+    :view.should_not be_extended_with Helper::View, :unknown
+  end  
+</pre>
 
 ## Note on Patches/Pull Requests
  

data/Rakefile

@@ -8,8 +8,11 @@ begin
     gem.homepage = "http://github.com/kristianmandrup/rails3_plugin_toolbox"
     gem.authors = ["Kristian Mandrup"]
     gem.add_development_dependency "rspec", ">= 2.0.0.beta.19"
+
+    # gem.add_dependency 'active_support', ">= 3.0.0.rc"
     gem.add_dependency "rails", ">= 3.0.0.rc"
-    gem.add_dependency "require_all", ">= 1.1.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

data/VERSION

@@ -1 +1 @@
-0.2.0
+0.3.0

data/lib/plugin_toolbox/extender.rb

@@ -20,7 +20,7 @@ module Rails3
     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 "#{base_name.camelize}::#{name.to_s.camelize}".constantize, options
+        extend_with get_constant(base_name, name), options
       end
     end
 
@@ -38,7 +38,7 @@ module Rails3
       
       def extend_from_module base_name, *module_names
         module_names.each do |name|
-          include "#{base_name.camelize}::#{name.to_s.camelize}".constantize
+          include get_constant(base_name, name)
         end
       end
 

data/lib/plugin_toolbox/rspec/config.rb

@@ -0,0 +1,8 @@
+require 'rspec'
+
+RSpec.configure do |config|
+  config.include Rails3::PluginExtender::Matchers
+end
+
+
+

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

@@ -0,0 +1,58 @@
+module Rails3
+  class PluginExtender
+    module Matchers
+      class BeExtendedWith
+        include Rails3::PluginExtender::Util          
+      
+        attr_reader :methods, :module_const, :rails_const, :submodules
+      
+        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 = get_base_class(type)                  
+            return match_submodules? if submodules
+            methods_included? module_const.instance_methods 
+          rescue
+            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|
+            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} to be extended with all the methods in #{module_const}"
+        end 
+  
+        def negative_failure_message  
+          "Din not expect the rails class #{rails_const} to be extended with all the methods in #{module_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

@@ -3,7 +3,17 @@ module Rails3
     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
+        return "#{type.to_s.camelize}::Base".constantize if type =~/action/ || type =~/active/
+        "#{type.to_s.camelize}".constantize        
+      end
+
+      def get_constant base_name, name   
+        "#{base_name.to_s.camelize}::#{name.to_s.camelize}".constantize
+      end
+
       def get_load_type type
          return ACTIVE_MODULES[type] if ACTIVE_MODULES[type]
          return type if ACTIVE_MODULES.values.include? type                

data/lib/rails3_plugin_toolbox.rb

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

data/rails3_plugin_toolbox.gemspec

@@ -5,7 +5,7 @@
 
 Gem::Specification.new do |s|
   s.name = %q{rails3_plugin_toolbox}
-  s.version = "0.2.0"
+  s.version = "0.3.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Kristian Mandrup"]
@@ -27,10 +27,13 @@ Gem::Specification.new do |s|
      "config/database.yml",
      "lib/plugin_toolbox/extender.rb",
      "lib/plugin_toolbox/loader.rb",
+     "lib/plugin_toolbox/rspec/config.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",
@@ -45,7 +48,8 @@ Gem::Specification.new do |s|
   s.rubygems_version = %q{1.3.7}
   s.summary = %q{Toolbox to facilitate Rails 3 plugin development}
   s.test_files = [
-    "spec/plugin_toolbox/extender_action_spec.rb",
+    "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"

data/spec/plugin_toolbox/extend_view_content_spec.rb

@@ -0,0 +1,48 @@
+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_button
+        'button'
+      end
+    end        
+  end
+end
+
+describe Rails3::PluginExtender do
+  describe '#extend_rails' do
+    it "should extend Action View" 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
+    
+      # Initialize the rails application
+      Minimal::Application.initialize!    
+    
+      :view.should be_extended_with Helper::View, :panel, :window, :button, :form
+      :view.should_not be_extended_with Helper::View, :unknown
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -1,13 +1,14 @@
 require 'rspec'
 require 'rspec/autorun'
-require 'active_support'
-require 'active_record'
-require 'action_controller'
-require 'action_view'
 require 'rails3_plugin_toolbox'
 
 # See http://www.igvita.com/2010/08/04/rails-3-internals-railtie-creating-plugins/
 
+# require 'active_support'
+# require 'active_record'
+# require 'action_controller'
+# require 'action_view'
+# require 'action_mailer'
 # require 'active_support/railtie'
 require 'rails/all'
 

metadata

@@ -4,9 +4,9 @@ version: !ruby/object:Gem::Version
   prerelease: false
   segments: 
   - 0
-  - 2
+  - 3
   - 0
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors: 
 - Kristian Mandrup
@@ -85,10 +85,13 @@ files:
 - config/database.yml
 - lib/plugin_toolbox/extender.rb
 - lib/plugin_toolbox/loader.rb
+- lib/plugin_toolbox/rspec/config.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
@@ -129,6 +132,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