rails3_plugin_toolbox 0.1.0

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,78 @@
+# 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.   
+
+## Status
+
+This gem needs to be tested. I 'hope' it works as is... I will soon make sure of it and add an RSpec 2 test suite ;)
+
+## Inspiration
+
+This project was inspired by the Yehuda Katz article at http://www.railsdispatch.com/, titled "How Rails enables more choices".
+
+## Install
+
+<code>gem install rails3_plugin_toolbox</code>
+
+## Usage
+
+<pre>
+# my_plugin/lib/load.rb
+module MyPlugin
+  include Rails::Plugin::Toolbox::Extender
+
+  # do some actions after Application has been initialized using registered initializers
+  after(:initialize) do
+    include MyViewModule
+  end
+
+  # extend action_view with methods from some modules
+  extend_rails(:view) do
+    with UltraFix
+    with PowerTools    
+  end  
+
+  extend_rails(:controller) do
+    extend_from_module Ultra::Power, :util, :logging, :monitor
+    extend_from_module Ultra::Power::More, :extra, :stuff
+  end  
+end  
+</pre>
+
+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>
+
+
+## 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,45 @@
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "rails3_plugin_toolbox"
+    gem.summary = %Q{Toolbox to facilitate Rails 3 plugin development}
+    gem.description = %Q{Toolbox to facilitate Rails 3 plugin development}
+    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.beta.19"
+    gem.add_dependency "rails", ">= 3.0.0.rc"
+    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
+
+# 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|
+#   version = File.exist?('VERSION') ? File.read('VERSION') : ""
+#
+#   rdoc.rdoc_dir = 'rdoc'
+#   rdoc.title = "rails3_plugin_toolbox #{version}"
+#   rdoc.rdoc_files.include('README*')
+#   rdoc.rdoc_files.include('lib/**/*.rb')
+# end
+

data/VERSION

@@ -0,0 +1 @@
+0.1.0

data/lib/plugin_toolbox/extender.rb

@@ -0,0 +1,45 @@
+require 'plugin_toolbox/util'
+
+module Rails::PluginToolbox
+  class Extender
+    include Rails::PluginToolbox::Util
+    
+    attr_reader :loader
+    
+    def initialize
+      @loader = Loader.new
+    end
+    
+    def extend_rails(type, &block)
+      loader.load_after(type, &block)
+    end
+    
+    def extend! module_name, type
+      do_extend! get_module(module_name), get_type(type.to_sym)
+    end
+    
+    def extend_with module_name
+      type = options[:in] || options        
+      extend! module_name, type
+    end
+    alias_method :with, :extend_with
+
+    # convenience method to extend with multiple modules all within the same base module
+    def extend_from_module base_name, *module_names
+      module_names.each do |name|
+        extend_with "#{base_name.camelize}::#{name.to_s.camelize}".constantize
+      end
+      type = options[:in] || options        
+      extend! module_name, type
+    end       
+    
+    protected
+    
+    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,31 @@
+require_all File.dirname(__FILE__) + '/validator'
+
+module Rails::PluginToolbox
+  class Loader
+    include Rails::PluginToolbox::HookValidator
+        
+    def load_before type, &block
+      raise ArgumentError "#{type} is not a valid before hook" if !valid_before_hook?
+      ActiveSupport.on_load(:"before_#{type}") do |loader|
+        do_loader loader, &block
+      end
+    end
+
+    def load_after type, &block
+      type = valid_after_hook? ? type : :"action_#{type}"
+      raise ArgumentError "#{type} is not a valid after hook" if !valid_after_hook? type          
+      ActiveSupport.on_load(type) do |loader|
+        do_loader loader, &block
+      end
+    end
+
+    protected
+
+    def do_loader loader, &block
+      loader.extend(Loader)
+      if block
+        block.arity < 1 ? loader.instance_eval(&block) : block.call(loader)  
+      end
+    end           
+  end
+end

data/lib/plugin_toolbox/util.rb

@@ -0,0 +1,24 @@
+require_all File.dirname(__FILE__) + '/validator'
+
+module Rails::PluginToolbox
+  module Util    
+    include Rails::PluginToolbox::TypeValidator
+    
+    def get_type category
+       return :"action_#{type}" if action_type?(type)
+       return type if valid_type?(type)
+       raise ArgumentError, "The type #{type} was not recognized"
+    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 loaded module"        
+      end
+    end
+  end
+end

data/lib/plugin_toolbox/validator/hook_validator.rb

@@ -0,0 +1,11 @@
+module Rails::PluginToolbox
+  module HookValidator
+    def valid_before_hook?
+      [:initialize, :configuration, :eager_load].include?(type)          
+    end
+
+    def valid_after_hook?
+      [:initialize, :i18n, :active_record, :action_view, :action_controller, :action_mailer].include?(type)          
+    end
+  end
+end

data/lib/plugin_toolbox/validator/type_validator.rb

@@ -0,0 +1,11 @@
+module Rails::PluginToolbox
+  module TypeValidator
+    def valid_type?
+      [:i18n, :active_record].include?(type)       
+    end
+
+    def action_type? type
+      [:controller, :view, :mailer].include?(type)
+    end
+  end
+end

data/lib/rails3_plugin_toolbox.rb

@@ -0,0 +1,6 @@
+module Rails
+  module PluginToolbox
+  end
+end
+
+require_all File.dirname(__FILE__) + '/plugin_toolbox'

data/rails3_plugin_toolbox.gemspec

@@ -0,0 +1,70 @@
+# 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.1.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Kristian Mandrup"]
+  s.date = %q{2010-08-21}
+  s.description = %q{Toolbox to facilitate Rails 3 plugin development}
+  s.email = %q{kmandrup@gmail.com}
+  s.extra_rdoc_files = [
+    "LICENSE",
+     "README.markdown"
+  ]
+  s.files = [
+    ".document",
+     ".gitignore",
+     ".rspec",
+     "LICENSE",
+     "README.markdown",
+     "Rakefile",
+     "VERSION",
+     "lib/plugin_toolbox/extender.rb",
+     "lib/plugin_toolbox/loader.rb",
+     "lib/plugin_toolbox/util.rb",
+     "lib/plugin_toolbox/validator/hook_validator.rb",
+     "lib/plugin_toolbox/validator/type_validator.rb",
+     "lib/rails3_plugin_toolbox.rb",
+     "rails3_plugin_toolbox.gemspec",
+     "spec/plugin_toolbox/extender_spec.rb",
+     "spec/plugin_toolbox/loader_spec.rb",
+     "spec/plugin_toolbox/util_spec.rb",
+     "spec/spec_helper.rb"
+  ]
+  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/extender_spec.rb",
+     "spec/plugin_toolbox/loader_spec.rb",
+     "spec/plugin_toolbox/util_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/spec_helper.rb

@@ -0,0 +1,7 @@
+require 'rspec'
+require 'rspec/autorun'
+require 'rails3_plugin_toolbox'
+
+RSpec.configure do |config|
+  
+end

metadata

@@ -0,0 +1,132 @@
+--- !ruby/object:Gem::Specification 
+name: rails3_plugin_toolbox
+version: !ruby/object:Gem::Version 
+  prerelease: false
+  segments: 
+  - 0
+  - 1
+  - 0
+  version: 0.1.0
+platform: ruby
+authors: 
+- Kristian Mandrup
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-08-21 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
+        - beta
+        - 19
+        version: 2.0.0.beta.19
+  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
+        - rc
+        version: 3.0.0.rc
+  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: Toolbox to facilitate Rails 3 plugin development
+email: kmandrup@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.markdown
+files: 
+- .document
+- .gitignore
+- .rspec
+- LICENSE
+- README.markdown
+- Rakefile
+- VERSION
+- lib/plugin_toolbox/extender.rb
+- lib/plugin_toolbox/loader.rb
+- lib/plugin_toolbox/util.rb
+- lib/plugin_toolbox/validator/hook_validator.rb
+- lib/plugin_toolbox/validator/type_validator.rb
+- lib/rails3_plugin_toolbox.rb
+- rails3_plugin_toolbox.gemspec
+- spec/plugin_toolbox/extender_spec.rb
+- spec/plugin_toolbox/loader_spec.rb
+- spec/plugin_toolbox/util_spec.rb
+- spec/spec_helper.rb
+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/extender_spec.rb
+- spec/plugin_toolbox/loader_spec.rb
+- spec/plugin_toolbox/util_spec.rb
+- spec/spec_helper.rb