r3_plugin_toolbox 0.3.5 → 0.3.6

data/lib/r3_plugin_toolbox/rspec/macro.rb

@@ -0,0 +1,33 @@
+module Rails3
+  class Plugin
+    class Extender
+      module Macro
+        class << self
+          include Rails3::Plugin::Extender::Util
+        end
+
+        MACRO = Rails3::Plugin::Extender::Macro
+            
+        def after_init component, &block
+          type = MACRO.get_load_type component
+          Rails3::Plugin::Extender.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
+end

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

@@ -0,0 +1,66 @@
+module Rails3
+  class Plugin
+    class Extender
+      module Matchers
+        class BeExtendedWith
+          include Rails3::Plugin::Extender::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
+end

data/lib/r3_plugin_toolbox/shortcuts.rb

@@ -0,0 +1,11 @@
+def rails3_extensions &block
+  Rails3::Plugin::Extender.new &block
+end
+
+def rails3_plugin name, &block
+  Rails3::Plugin.new name, &block
+end
+
+def rails3_engine name, &block
+  Rails3::Engine.new name, &block
+end

data/r3_plugin_toolbox.gemspec

@@ -5,7 +5,7 @@
 
 Gem::Specification.new do |s|
   s.name = %q{r3_plugin_toolbox}
-  s.version = "0.3.5"
+  s.version = "0.3.6"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Kristian Mandrup"]
@@ -25,20 +25,27 @@ Gem::Specification.new do |s|
      "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",
+     "lib/r3_plugin_toolbox/engine.rb",
+     "lib/r3_plugin_toolbox/extender.rb",
+     "lib/r3_plugin_toolbox/extender/load_handler.rb",
+     "lib/r3_plugin_toolbox/extender/util.rb",
+     "lib/r3_plugin_toolbox/main.rb",
+     "lib/r3_plugin_toolbox/railtie.rb",
+     "lib/r3_plugin_toolbox/rspec/config.rb",
+     "lib/r3_plugin_toolbox/rspec/macro.rb",
+     "lib/r3_plugin_toolbox/rspec/matchers/be_extended_with.rb",
+     "lib/r3_plugin_toolbox/shortcuts.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/fixtures/extension_modules.rb",
+     "spec/r3_plugin_toolbox/engine_spec.rb",
+     "spec/r3_plugin_toolbox/extender/extend_view_content_spec.rb",
+     "spec/r3_plugin_toolbox/extender/extender_action_spec.rb",
+     "spec/r3_plugin_toolbox/extender/extender_i18n_spec.rb",
+     "spec/r3_plugin_toolbox/extender_spec.rb",
+     "spec/r3_plugin_toolbox/railtie_spec.rb",
+     "spec/r3_plugin_toolbox/shortcuts_spec.rb",
      "spec/spec_helper.rb",
      "wiki/add_rake_tasks.markdown",
      "wiki/engine.markdown",
@@ -50,10 +57,14 @@ 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/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/fixtures/extension_modules.rb",
+     "spec/r3_plugin_toolbox/engine_spec.rb",
+     "spec/r3_plugin_toolbox/extender/extend_view_content_spec.rb",
+     "spec/r3_plugin_toolbox/extender/extender_action_spec.rb",
+     "spec/r3_plugin_toolbox/extender/extender_i18n_spec.rb",
+     "spec/r3_plugin_toolbox/extender_spec.rb",
+     "spec/r3_plugin_toolbox/railtie_spec.rb",
+     "spec/r3_plugin_toolbox/shortcuts_spec.rb",
      "spec/spec_helper.rb"
   ]
 
@@ -63,15 +74,18 @@ Gem::Specification.new do |s|
 
     if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
       s.add_development_dependency(%q<rspec>, ["~> 2.0.0"])
+      s.add_development_dependency(%q<rspec>, [">= 2.0.0.beta.19"])
       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<rspec>, [">= 2.0.0.beta.19"])
       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<rspec>, [">= 2.0.0.beta.19"])
     s.add_dependency(%q<rails>, ["~> 3.0.0"])
     s.add_dependency(%q<require_all>, ["~> 1.1.0"])
   end

data/spec/fixtures/extension_modules.rb

@@ -0,0 +1,29 @@
+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
+

data/spec/r3_plugin_toolbox/engine_spec.rb

@@ -0,0 +1,17 @@
+require 'yaml'
+require 'spec_helper'
+
+describe Rails3::Engine do
+  it "should create an engine" do
+    Rails3::Engine.new :my_engine do |e|
+      e.add_locales_dir 'my_locales'
+      e.set_orm :active_record
+    end
+  
+    # Initialize the rails application
+    init_app_railties :minimal
+    
+    Rails.configuration.generators.options[:rails][:orm].should == :active_record    
+    Minimal::Application.config.generators.options[:rails][:orm].should == :active_record    
+  end     
+end

data/spec/{plugin_toolbox → r3_plugin_toolbox/extender}/extend_view_content_spec.rb

@@ -1,5 +1,8 @@
 require 'spec_helper'
 
+require 'active_record'
+require 'action_mailer'
+
 module Helper
   module View
     module Panel
@@ -28,11 +31,11 @@ module Helper
   end
 end
 
-describe Rails3::PluginExtender do
+describe Rails3::Plugin::Extender do
   describe '#extend_rails' do        
 
     before :each do 
-      Rails3::PluginExtender.new do
+      Rails3::Plugin::Extender.new do
         extend_rails :view do
           extend_from_module Helper::View, :panel, :window
           extend_with Helper::View::Button, Helper::View::Form          

data/spec/{plugin_toolbox → r3_plugin_toolbox/extender}/extender_action_spec.rb

@@ -1,9 +1,9 @@
 require 'spec_helper'
 
-describe Rails3::PluginExtender do
+describe Rails3::Plugin::Extender do
   describe '#extend_rails' do
     it "should extend Action View" do
-      extender = Rails3::PluginExtender.new
+      extender = Rails3::Plugin::Extender.new
       
       extender.extend_rails :view do
         with MyAddition
@@ -22,7 +22,7 @@ describe Rails3::PluginExtender do
     end    
     
     it "should extend Action Controller" do
-      Rails3::PluginExtender.new do
+      Rails3::Plugin::Extender.new do
         extend_rails :controller do
           with MyAddition
       
@@ -41,7 +41,7 @@ describe Rails3::PluginExtender do
     end    
     
     it "should extend Action Mailer" do
-      Rails3::PluginExtender.new do
+      Rails3::Plugin::Extender.new do
         extend_rails :mailer do
           with MyAddition
       

data/spec/{plugin_toolbox → r3_plugin_toolbox/extender}/extender_i18n_spec.rb

@@ -1,9 +1,9 @@
 require 'spec_helper'
 
-describe Rails3::PluginExtender do
+describe Rails3::Plugin::Extender do
   describe '#extend_rails' do
     it "should extend i18n" do
-      Rails3::PluginExtender.new do
+      Rails3::Plugin::Extender.new do
         extend_rails :i18n do
           with MyAddition
 

data/spec/{plugin_toolbox → r3_plugin_toolbox}/extender_spec.rb

@@ -2,21 +2,21 @@ require 'spec_helper'
 require 'active_record'
 
 def extend_unknown
-  Rails3::PluginExtender.new do
+  Rails3::Plugin::Extender.new do
     extend_rails :unknown do
       with MyAddition
     end
   end     
 end  
 
-describe Rails3::PluginExtender do
+describe Rails3::Plugin::Extender 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
+      Rails3::Plugin::Extender.new do
         extend_rails :AR do
           with MyAddition
       

data/spec/r3_plugin_toolbox/railtie_spec.rb

@@ -0,0 +1,16 @@
+require 'spec_helper'
+
+describe Rails3::Plugin do
+  it "should create a railtie plugin" do
+    Rails3::Plugin.new :my_plugin do |e|
+      e.set_orm :active_record
+    end
+  
+    # Initialize the rails application
+    init_app_railties :minimal
+    
+    Rails.configuration.generators.options[:rails][:orm].should == :active_record    
+    Minimal::Application.config.generators.options[:rails][:orm].should == :active_record    
+  end     
+end
+

data/spec/r3_plugin_toolbox/shortcuts_spec.rb

@@ -0,0 +1,54 @@
+require 'spec_helper'
+require 'r3_plugin_toolbox/shortcuts'
+require 'active_record'
+
+describe 'Plugin shortcuts' do
+  describe '#rails3_extensions' do    
+    it "should extend Active Record" do
+      rails3_extensions do
+        extend_rails :AR do
+          with MyAddition
+      
+          after :initialize do
+            MyAddition.say 'record me!'
+          end      
+        end
+      end
+    
+      # Initialize the rails application
+      init_app_railties :minimal, :active_record
+    
+      ActiveRecord::Base.instance_methods.grep(/zzz/).should_not be_empty
+    
+      MyAddition.heard.should == 'record me!'
+    end     
+  end
+
+  describe '#rails3_plugin' do    
+    it "should create a plugin" do
+      rails3_plugin :my_plug do
+        set_orm :active_record
+      end
+    
+      # Initialize the rails application
+      init_app_railties :minimal
+    
+      Rails.configuration.generators.options[:rails][:orm].should == :active_record    
+      Minimal::Application.config.generators.options[:rails][:orm].should == :active_record
+    end     
+  end
+
+  describe '#rails3_engine' do    
+    it "should create an engine" do
+      rails3_engine :my_engine do
+        set_orm :active_record
+      end
+    
+      # Initialize the rails application
+      init_app_railties :minimal
+    
+      Rails.configuration.generators.options[:rails][:orm].should == :active_record    
+      Minimal::Application.config.generators.options[:rails][:orm].should == :active_record
+    end     
+  end
+end

data/spec/spec_helper.rb

@@ -5,49 +5,20 @@ 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'
 
+require 'fixtures/extension_modules'
+
 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|
+  config.mock_with :mocha
 end